Interface for CPageParagraph wrapper. More...

Functions
CPageParagraph	CPageParagraph_Create (idrs_exception *pargException)
	Creates a new instance of a paragraph object.

CPolygon	CPageParagraph_GetBoundingPolygon (const CPageParagraph argCPageParagraph, idrs_exception *pargException)
	GetBoundingPolygon retrieves the bounding polygon.

void	CPageParagraph_SetBoundingPolygon (CPageParagraph argCPageParagraph, const CPolygon argBoundingPolygon, idrs_exception *pargException)
	Sets the polygon containing all paragraph content.

CPageStyleParagraph	CPageParagraph_GetStyle (const CPageParagraph argCPageParagraph, idrs_exception *pargException)
	Returns the paragraph style.

CPageTextLineArray	CPageParagraph_GetTextLines (const CPageParagraph argCPageParagraph, idrs_exception *pargException)
	Returns an array containing the lines of text in the paragraph.

void	CPageParagraph_SetStyle (CPageParagraph argCPageParagraph, const CPageStyleParagraph argStyle, idrs_exception *pargException)
	SetStyle sets the paragraph style.

void	CPageParagraph_SetTextLines (CPageParagraph argCPageParagraph, const CPageTextLineArray argTextLines, idrs_exception *pargException)
	SetTextLines sets the text lines in the paragraph.

enum ParagraphType	CPageParagraph_GetParagraphType (const CPageParagraph argCPageParagraph, idrs_exception *pargException)
	Returns the paragraph type.

CPageStyleParagraphList	CPageParagraph_GetParagraphListStyle (const CPageParagraph argCPageParagraph, idrs_exception *pargException)
	Returns the paragraph list style.

void	CPageParagraph_SetParagraphType (CPageParagraph argCPageParagraph, enum ParagraphType const evParagraphType, idrs_exception *pargException)
	Sets the paragraph type.

void	CPageParagraph_SetParagraphListStyle (CPageParagraph argCPageParagraph, const CPageStyleParagraphList argPageParagraphListStyle, idrs_exception *pargException)
	Sets the list style.

void	CPageParagraph_Destroy (CPageParagraph argCPageParagraph, idrs_exception *pargException)
	Destroys a CPageParagraph handle.

CPageParagraphArray	ArrayInterface_Create_CPageParagraphArray (idrs_exception *pargException)
	Creates a new CPageParagraphArray object.

Detailed Description

Interface for CPageParagraph wrapper.

Function Documentation

◆ ArrayInterface_Create_CPageParagraphArray()

CPageParagraphArray ArrayInterface_Create_CPageParagraphArray ( idrs_exception * pargException )

Creates a new CPageParagraphArray object.

Parameters

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

Returns: The newly created CPageParagraphArray

◆ CPageParagraph_Create()

CPageParagraph CPageParagraph_Create ( idrs_exception * pargException )

Creates a new instance of a paragraph object.

Parameters

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

◆ CPageParagraph_Destroy()

void CPageParagraph_Destroy	(	CPageParagraph	argCPageParagraph,
		idrs_exception *	pargException
	)

Destroys a CPageParagraph handle.

Parameters

argCPageParagraph	CPageParagraph handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageParagraph_GetBoundingPolygon()

CPolygon CPageParagraph_GetBoundingPolygon	(	const CPageParagraph	argCPageParagraph,
		idrs_exception *	pargException
	)

GetBoundingPolygon retrieves the bounding polygon.

Parameters

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

◆ CPageParagraph_GetParagraphListStyle()

CPageStyleParagraphList CPageParagraph_GetParagraphListStyle	(	const CPageParagraph	argCPageParagraph,
		idrs_exception *	pargException
	)

Returns the paragraph list style.

A paragraph can be part of a list spanning multiple paragraphs. Details about the type can be found in CPageStyleParagraphList The list style is expected to be set if the paragraph type is set to ParagraphType::List (see

See also: GetParagraphType)

Parameters

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

◆ CPageParagraph_GetParagraphType()

enum ParagraphType CPageParagraph_GetParagraphType	(	const CPageParagraph	argCPageParagraph,
		idrs_exception *	pargException
	)

Returns the paragraph type.

Parameters

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

◆ CPageParagraph_GetStyle()

CPageStyleParagraph CPageParagraph_GetStyle	(	const CPageParagraph	argCPageParagraph,
		idrs_exception *	pargException
	)

Returns the paragraph style.

Parameters

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

◆ CPageParagraph_GetTextLines()

CPageTextLineArray CPageParagraph_GetTextLines	(	const CPageParagraph	argCPageParagraph,
		idrs_exception *	pargException
	)

Returns an array containing the lines of text in the paragraph.

Parameters

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

◆ CPageParagraph_SetBoundingPolygon()

void CPageParagraph_SetBoundingPolygon	(	CPageParagraph	argCPageParagraph,
		const CPolygon	argBoundingPolygon,
		idrs_exception *	pargException
	)

Sets the polygon containing all paragraph content.

Parameters

argCPageParagraph	CPageParagraph handle
argBoundingPolygon	Polygon object
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageParagraph_SetParagraphListStyle()

void CPageParagraph_SetParagraphListStyle	(	CPageParagraph	argCPageParagraph,
		const CPageStyleParagraphList	argPageParagraphListStyle,
		idrs_exception *	pargException
	)

Sets the list style.

The list style is expected to be set if the paragraph type is set to ParagraphType::List (see

See also: GetParagraphType)

Parameters

argCPageParagraph	CPageParagraph handle
argPageParagraphListStyle	Object containing the list style
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageParagraph_SetParagraphType()

void CPageParagraph_SetParagraphType	(	CPageParagraph	argCPageParagraph,
		enum ParagraphType const	evParagraphType,
		idrs_exception *	pargException
	)

Sets the paragraph type.

Please note that if the paragraph type is set to ParagraphType::List, the paragraph list style needs to be set as well. (see

See also: SetParagraphListStyle)

Parameters

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

◆ CPageParagraph_SetStyle()

void CPageParagraph_SetStyle	(	CPageParagraph	argCPageParagraph,
		const CPageStyleParagraph	argStyle,
		idrs_exception *	pargException
	)

SetStyle sets the paragraph style.

Parameters

argCPageParagraph	CPageParagraph handle
argStyle	Paragraph style
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageParagraph_SetTextLines()

void CPageParagraph_SetTextLines	(	CPageParagraph	argCPageParagraph,
		const CPageTextLineArray	argTextLines,
		idrs_exception *	pargException
	)

SetTextLines sets the text lines in the paragraph.

Parameters

argCPageParagraph	CPageParagraph handle
argTextLines	Array containing the lines of text
pargException	Pointer to exception structure that will be filled if an exception occurs

Functions

Detailed Description

Function Documentation

◆ ArrayInterface_Create_CPageParagraphArray()

◆ CPageParagraph_Create()

◆ CPageParagraph_Destroy()

◆ CPageParagraph_GetBoundingPolygon()

◆ CPageParagraph_GetParagraphListStyle()

◆ CPageParagraph_GetParagraphType()

◆ CPageParagraph_GetStyle()

◆ CPageParagraph_GetTextLines()

◆ CPageParagraph_SetBoundingPolygon()

◆ CPageParagraph_SetParagraphListStyle()

◆ CPageParagraph_SetParagraphType()

◆ CPageParagraph_SetStyle()

◆ CPageParagraph_SetTextLines()