CDocxOutputParams_interface.h File Reference

Interface for CDocxOutputParams wrapper. More...

Go to the source code of this file.

Functions
CDocxOutputParams	CDocxOutputParams_Create (enum PageLayout const evPageLayout, idrs_exception *pargException)
	Create is instantiating a new instance of CDocxOutputParams and associated data object.
enum PageLayout	CDocxOutputParams_GetPageLayout (const CDocxOutputParams argCDocxOutputParams, idrs_exception *pargException)
	Gets the page layout type.
CJpegCompressionOptions	CDocxOutputParams_GetJpegCompressionOptions (const CDocxOutputParams argCDocxOutputParams, idrs_exception *pargException)
	Gets the Jpeg Compression Options.
void	CDocxOutputParams_SetJpegCompressionOptions (CDocxOutputParams argCDocxOutputParams, const CJpegCompressionOptions argJpegCompressionOptions, idrs_exception *pargException)
	Sets the Jpeg Compression Options property.
CPageSizeOptions	CDocxOutputParams_GetPageSizeOptions (const CDocxOutputParams argCDocxOutputParams, idrs_exception *pargException)
	Gets the page size options.
void	CDocxOutputParams_SetPageSizeOptions (CDocxOutputParams argCDocxOutputParams, const CPageSizeOptions argPageSizeOptions, idrs_exception *pargException)
	Sets the page size options.
IDRS_BOOL	CDocxOutputParams_GetFitPagesToSpecs (const CDocxOutputParams argCDocxOutputParams, idrs_exception *pargException)
	Gets the flag indicating if document pages exceeding the maximum dimensions allowed by DOCX standard should be automatically downsized.
void	CDocxOutputParams_SetFitPagesToSpecs (CDocxOutputParams argCDocxOutputParams, IDRS_BOOL const bFitPagesToSpecs, idrs_exception *pargException)
	Sets the flag indicating if document pages exceeding the maximum dimensions allowed by DOCX standard should be automatically downsized.
void	CDocxOutputParams_Destroy (CDocxOutputParams argCDocxOutputParams, idrs_exception *pargException)
	Destroys a CDocxOutputParams handle.

Detailed Description

Interface for CDocxOutputParams wrapper.

Function Documentation

CDocxOutputParams_Create()

CDocxOutputParams CDocxOutputParams_Create	(	enum PageLayout const	evPageLayout,
		idrs_exception *	pargException
	)

Create is instantiating a new instance of CDocxOutputParams and associated data object.

Parameters

evPageLayout	the page layout type
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

New instance of CDocxOutputParams

Remarks

Instances created by this method can also be provided to COutputParams methods

CDocxOutputParams_Destroy()

void CDocxOutputParams_Destroy	(	CDocxOutputParams	argCDocxOutputParams,
		idrs_exception *	pargException
	)

Destroys a CDocxOutputParams handle.

Parameters

argCDocxOutputParams	CDocxOutputParams handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocxOutputParams_GetFitPagesToSpecs()

IDRS_BOOL CDocxOutputParams_GetFitPagesToSpecs	(	const CDocxOutputParams	argCDocxOutputParams,
		idrs_exception *	pargException
	)

Gets the flag indicating if document pages exceeding the maximum dimensions allowed by DOCX standard should be automatically downsized.

If set to true, pages deemed too large for DOCX will be automatically downscaled If set to false, in such cases document creation will fail and an exception will be thrown. This is the default behavior.

Returns

the value of the flag (default: false)

Parameters

argCDocxOutputParams	CDocxOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocxOutputParams_GetJpegCompressionOptions()

CJpegCompressionOptions CDocxOutputParams_GetJpegCompressionOptions	(	const CDocxOutputParams	argCDocxOutputParams,
		idrs_exception *	pargException
	)

Gets the Jpeg Compression Options.

Returns

the Jpeg compression options object

Parameters

argCDocxOutputParams	CDocxOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocxOutputParams_GetPageLayout()

enum PageLayout CDocxOutputParams_GetPageLayout	(	const CDocxOutputParams	argCDocxOutputParams,
		idrs_exception *	pargException
	)

Gets the page layout type.

Returns

the page layout type

Parameters

argCDocxOutputParams	CDocxOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocxOutputParams_GetPageSizeOptions()

CPageSizeOptions CDocxOutputParams_GetPageSizeOptions	(	const CDocxOutputParams	argCDocxOutputParams,
		idrs_exception *	pargException
	)

Gets the page size options.

Returns

the page size options

Parameters

argCDocxOutputParams	CDocxOutputParams handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocxOutputParams_SetFitPagesToSpecs()

void CDocxOutputParams_SetFitPagesToSpecs	(	CDocxOutputParams	argCDocxOutputParams,
		IDRS_BOOL const	bFitPagesToSpecs,
		idrs_exception *	pargException
	)

Sets the flag indicating if document pages exceeding the maximum dimensions allowed by DOCX standard should be automatically downsized.

If set to true, pages deemed too large for DOCX will be automatically downscaled If set to false, in such cases document creation will fail and an exception will be thrown. This is the default behavior.

Parameters

argCDocxOutputParams	CDocxOutputParams handle
bFitPagesToSpecs	the new value of the flag
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocxOutputParams_SetJpegCompressionOptions()

void CDocxOutputParams_SetJpegCompressionOptions	(	CDocxOutputParams	argCDocxOutputParams,
		const CJpegCompressionOptions	argJpegCompressionOptions,
		idrs_exception *	pargException
	)

Sets the Jpeg Compression Options property.

Parameters

argCDocxOutputParams	CDocxOutputParams handle
argJpegCompressionOptions	a Jpeg compression options object
pargException	Pointer to exception structure that will be filled if an exception occurs

CDocxOutputParams_SetPageSizeOptions()

void CDocxOutputParams_SetPageSizeOptions	(	CDocxOutputParams	argCDocxOutputParams,
		const CPageSizeOptions	argPageSizeOptions,
		idrs_exception *	pargException
	)

Sets the page size options.

Parameters

argCDocxOutputParams	CDocxOutputParams handle
argPageSizeOptions	the page size options
pargException	Pointer to exception structure that will be filled if an exception occurs