CSignatureContent_interface.h File Reference

Interface for CSignatureContent wrapper. More...

Go to the source code of this file.

Functions
CSignatureContent	CSignatureContent_Create (idrs_exception *pargException)
	Creates a new CSignatureContent object.
void	CSignatureContent_SetSignatureArea (CSignatureContent argCSignatureContent, const IDRS_RECT *rcSignatureArea, idrs_exception *pargException)
	Sets the area where the signature will be placed on pdf page.
IDRS_RECT	CSignatureContent_GetSignatureArea (const CSignatureContent argCSignatureContent, idrs_exception *pargException)
	Gets the area where the signature will be inserted in the pdf page.
CPageZoneArray	CSignatureContent_GetZones (const CSignatureContent argCSignatureContent, idrs_exception *pargException)
	Gets an array containing the zones in the signature.
void	CSignatureContent_SetZones (CSignatureContent argCSignatureContent, const CPageZoneArray xZones, idrs_exception *pargException)
	Sets the zones in the signature.
void	CSignatureContent_Destroy (CSignatureContent argCSignatureContent, idrs_exception *pargException)
	Destroys a CSignatureContent handle.

Detailed Description

Interface for CSignatureContent wrapper.

Function Documentation

CSignatureContent_Create()

CSignatureContent CSignatureContent_Create

(

idrs_exception *

pargException

)

Creates a new CSignatureContent object.

Returns

The newly created CPdfOutputParameters object.

Parameters

pargException

Pointer to exception structure that will be filled if an exception occurs

CSignatureContent_Destroy()

void CSignatureContent_Destroy	(	CSignatureContent	argCSignatureContent,
		idrs_exception *	pargException
	)

Destroys a CSignatureContent handle.

Parameters

argCSignatureContent	CSignatureContent handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CSignatureContent_GetSignatureArea()

IDRS_RECT CSignatureContent_GetSignatureArea	(	const CSignatureContent	argCSignatureContent,
		idrs_exception *	pargException
	)

Gets the area where the signature will be inserted in the pdf page.

Returns

Rectangle representing the area where the signature will be inserted in the pdf page.

Parameters

argCSignatureContent	CSignatureContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CSignatureContent_GetZones()

CPageZoneArray CSignatureContent_GetZones	(	const CSignatureContent	argCSignatureContent,
		idrs_exception *	pargException
	)

Gets an array containing the zones in the signature.

Parameters

argCSignatureContent	CSignatureContent handle
pargException	Pointer to exception structure that will be filled if an exception occurs

CSignatureContent_SetSignatureArea()

void CSignatureContent_SetSignatureArea	(	CSignatureContent	argCSignatureContent,
		const IDRS_RECT *	rcSignatureArea,
		idrs_exception *	pargException
	)

Sets the area where the signature will be placed on pdf page.

The coordinates are expressed in pixels. While the coordinates are expected to be in the page bounding box, there is no strict enforcement on this rule. In case the coordinates are partially in the page area, only that part of the signature will appear on the pdf document.

Parameters

argCSignatureContent	CSignatureContent handle
rcSignatureArea	Rectangle where the signature will be displayed
pargException	Pointer to exception structure that will be filled if an exception occurs

CSignatureContent_SetZones()

void CSignatureContent_SetZones	(	CSignatureContent	argCSignatureContent,
		const CPageZoneArray	xZones,
		idrs_exception *	pargException
	)

Sets the zones in the signature.

Important:

The zone coordinates need to be included in the signature bounding box. All graphic zones must use the

See also

CPageZoneGraphicExternalImage class override.

Parameters

argCSignatureContent	CSignatureContent handle
xZones	List of zones
pargException	Pointer to exception structure that will be filled if an exception occurs