Interface for CPageBookmark wrapper. More...

Functions
CPageBookmark	CPageBookmark_Create (const idrs_string strTitle, idrs_exception *pargException)
	Creates a new instance.

CPageBookmarkArray	CPageBookmark_GetChildren (const CPageBookmark argCPageBookmark, idrs_exception *pargException)
	Returns the bookmark's children.

void	CPageBookmark_SetChildren (CPageBookmark argCPageBookmark, const CPageBookmarkArray xChildren, idrs_exception *pargException)
	Set the bookmark's children.

const idrs_string	CPageBookmark_GetTitle (const CPageBookmark argCPageBookmark, idrs_exception *pargException)
	Get the title of the bookmark.

void	CPageBookmark_SetTitle (CPageBookmark argCPageBookmark, const idrs_string strTitle, idrs_exception *pargException)
	Set the title of the bookmark.

enum BookmarkDisplayMode	CPageBookmark_GetDisplayMode (const CPageBookmark argCPageBookmark, idrs_exception *pargException)
	Get the display mode of the bookmark.

void	CPageBookmark_SetDisplayMode (CPageBookmark argCPageBookmark, const enum BookmarkDisplayMode const evDisplayMode, idrs_exception pargException)
	Set the display mode of the bookmark.

IDRS_UINT	CPageBookmark_GetDestinationPage (const CPageBookmark argCPageBookmark, idrs_exception *pargException)
	Gets the bookmark destination page index.

void	CPageBookmark_SetDestinationPage (CPageBookmark argCPageBookmark, IDRS_UINT const uiDestinationPageIndex, idrs_exception *pargException)
	Sets the bookmark destination page index.

IDRS_RECT	CPageBookmark_GetDestination (const CPageBookmark argCPageBookmark, idrs_exception *pargException)
	Get the bookmark destination (positioning on the page).

void	CPageBookmark_SetDestination (CPageBookmark argCPageBookmark, const IDRS_RECT stDestination, idrs_exception pargException)
	Set the bookmark destination (positioning on the page).

IDRS_UINT	CPageBookmark_GetZoomFactor (const CPageBookmark argCPageBookmark, idrs_exception *pargException)
	Get the bookmark zoom factor.

void	CPageBookmark_SetZoomFactor (CPageBookmark argCPageBookmark, const IDRS_UINT const uiZoomFactor, idrs_exception pargException)
	Set the bookmark zoom factor.

void	CPageBookmark_Destroy (CPageBookmark argCPageBookmark, idrs_exception *pargException)
	Destroys a CPageBookmark handle.

CPageBookmarkArray	ArrayInterface_Create_CPageBookmarkArray (idrs_exception *pargException)
	Creates a new CPageBookmarkArray object.

Detailed Description

Interface for CPageBookmark wrapper.

Function Documentation

◆ ArrayInterface_Create_CPageBookmarkArray()

CPageBookmarkArray ArrayInterface_Create_CPageBookmarkArray ( idrs_exception * pargException )

Creates a new CPageBookmarkArray object.

Parameters

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

Returns: The newly created CPageBookmarkArray

◆ CPageBookmark_Create()

CPageBookmark CPageBookmark_Create	(	const idrs_string	strTitle,
		idrs_exception *	pargException
	)

Creates a new instance.

Parameters

strTitle	The bookmark's title.
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks: Instances created by this method can also be provided to CPageCustomData methods

◆ CPageBookmark_Destroy()

void CPageBookmark_Destroy	(	CPageBookmark	argCPageBookmark,
		idrs_exception *	pargException
	)

Destroys a CPageBookmark handle.

Parameters

argCPageBookmark	CPageBookmark handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_GetChildren()

CPageBookmarkArray CPageBookmark_GetChildren	(	const CPageBookmark	argCPageBookmark,
		idrs_exception *	pargException
	)

Returns the bookmark's children.

Parameters

argCPageBookmark	CPageBookmark handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_GetDestination()

IDRS_RECT CPageBookmark_GetDestination	(	const CPageBookmark	argCPageBookmark,
		idrs_exception *	pargException
	)

Get the bookmark destination (positioning on the page).

Returns: The bookmark's destination, with coordinates expressed in pixels.

Parameters

argCPageBookmark	CPageBookmark handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_GetDestinationPage()

IDRS_UINT CPageBookmark_GetDestinationPage	(	const CPageBookmark	argCPageBookmark,
		idrs_exception *	pargException
	)

Gets the bookmark destination page index.

Returns: The bookmark's destination page number, starting at zero.

Parameters

argCPageBookmark	CPageBookmark handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_GetDisplayMode()

enum BookmarkDisplayMode CPageBookmark_GetDisplayMode	(	const CPageBookmark	argCPageBookmark,
		idrs_exception *	pargException
	)

Get the display mode of the bookmark.

Returns: The bookmark's display mode.

Parameters

argCPageBookmark	CPageBookmark handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_GetTitle()

const idrs_string CPageBookmark_GetTitle	(	const CPageBookmark	argCPageBookmark,
		idrs_exception *	pargException
	)

Get the title of the bookmark.

Returns: The bookmark's title.

Parameters

argCPageBookmark	CPageBookmark handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_GetZoomFactor()

IDRS_UINT CPageBookmark_GetZoomFactor	(	const CPageBookmark	argCPageBookmark,
		idrs_exception *	pargException
	)

Get the bookmark zoom factor.

Returns: The bookmark zoom factor, expressed as a percentage.

Parameters

argCPageBookmark	CPageBookmark handle
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_SetChildren()

void CPageBookmark_SetChildren	(	CPageBookmark	argCPageBookmark,
		const CPageBookmarkArray	xChildren,
		idrs_exception *	pargException
	)

Set the bookmark's children.

Parameters

argCPageBookmark	CPageBookmark handle
xChildren	The bookmark's children
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_SetDestination()

void CPageBookmark_SetDestination	(	CPageBookmark	argCPageBookmark,
		const IDRS_RECT *	stDestination,
		idrs_exception *	pargException
	)

Set the bookmark destination (positioning on the page).

Parameters

argCPageBookmark	CPageBookmark handle
stDestination	The destination to set
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks

The destination's coordinates actually used to write the bookmark depend on the display mode set:

iTop: used by modes PageWidth, ContentWidth, Rectangle, Zoom
iLeft: used by modes PageHeight, ContentHeight, Rectangle, Zoom
iBottom and iRight: used by mode Rectangle only

◆ CPageBookmark_SetDestinationPage()

void CPageBookmark_SetDestinationPage	(	CPageBookmark	argCPageBookmark,
		IDRS_UINT const	uiDestinationPageIndex,
		idrs_exception *	pargException
	)

Sets the bookmark destination page index.

Parameters

argCPageBookmark	CPageBookmark handle
uiDestinationPageIndex	The index of the page referenced by the bookmark
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_SetDisplayMode()

void CPageBookmark_SetDisplayMode	(	CPageBookmark	argCPageBookmark,
		const enum BookmarkDisplayMode *const	evDisplayMode,
		idrs_exception *	pargException
	)

Set the display mode of the bookmark.

Parameters

argCPageBookmark	CPageBookmark handle
evDisplayMode	The display mode to set.
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks: This setting allows to specify how a bookmark's destination should be displayed, when the created document is opened in a viewer and the bookmark is selected there. It has no effet on the content of the output document itself; only the intended behavior of the bookmark's selection in a viewer is concerned.

◆ CPageBookmark_SetTitle()

void CPageBookmark_SetTitle	(	CPageBookmark	argCPageBookmark,
		const idrs_string	strTitle,
		idrs_exception *	pargException
	)

Set the title of the bookmark.

Parameters

argCPageBookmark	CPageBookmark handle
strTitle	The new title.
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageBookmark_SetZoomFactor()

void CPageBookmark_SetZoomFactor	(	CPageBookmark	argCPageBookmark,
		const IDRS_UINT *const	uiZoomFactor,
		idrs_exception *	pargException
	)

Set the bookmark zoom factor.

Parameters

argCPageBookmark	CPageBookmark handle
uiZoomFactor	The zoom factor to set
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks: The zoom factor is used only if the display mode is set to Zoom. The magnification level of the page will then be set to the zoom factor. A zoom factor of 100 (i.e. 100%) means the page will be displayed with its actual size.

Functions

Detailed Description

Function Documentation

◆ ArrayInterface_Create_CPageBookmarkArray()

◆ CPageBookmark_Create()

◆ CPageBookmark_Destroy()

◆ CPageBookmark_GetChildren()

◆ CPageBookmark_GetDestination()

◆ CPageBookmark_GetDestinationPage()

◆ CPageBookmark_GetDisplayMode()

◆ CPageBookmark_GetTitle()

◆ CPageBookmark_GetZoomFactor()

◆ CPageBookmark_SetChildren()

◆ CPageBookmark_SetDestination()

◆ CPageBookmark_SetDestinationPage()

◆ CPageBookmark_SetDisplayMode()

◆ CPageBookmark_SetTitle()

◆ CPageBookmark_SetZoomFactor()