Interface for CPageTextElement wrapper. More...

Functions
CPageTextElement	CPageTextElement_Create (idrs_exception *pargException)
	Creates a new instance of a CPageTextElement.

CPolygon	CPageTextElement_GetBoundingPolygon (const CPageTextElement argCPageTextElement, idrs_exception *pargException)
	Gets the polygon where the text element is located.

void	CPageTextElement_SetBoundingPolygon (CPageTextElement argCPageTextElement, const CPolygon argBoundingPolygon, idrs_exception *pargException)
	Sets the polygon where the text element is located.

const idrs_string	CPageTextElement_GetTextValue (const CPageTextElement argCPageTextElement, idrs_exception *pargException)
	Retrieves the text value.

void	CPageTextElement_SetTextValue (CPageTextElement argCPageTextElement, const idrs_string strTextValue, idrs_exception *pargException)
	Sets the text value.

enum Language	CPageTextElement_GetLanguage (const CPageTextElement argCPageTextElement, idrs_exception *pargException)
	Retrieves the language for the text value.

CPageStyleTextElement	CPageTextElement_GetStyle (const CPageTextElement argCPageTextElement, idrs_exception *pargException)
	Retrieves the text element style.

IDRS_UINT	CPageTextElement_GetOcrConfidence (const CPageTextElement argCPageTextElement, idrs_exception *pargException)
	Retrieves the confidence value for the text element.

void	CPageTextElement_SetOcrConfidence (CPageTextElement argCPageTextElement, IDRS_UINT const uiOcrConfidence, idrs_exception *pargException)
	Sets the confidence value for the text element.

IDRS_UINT	CPageTextElement_GetOcrLocalScore (const CPageTextElement argCPageTextElement, idrs_exception *pargException)
	Retrieves the OCR local score of the text element.

void	CPageTextElement_SetOcrLocalScore (CPageTextElement argCPageTextElement, IDRS_UINT const uiOcrLocalScore, idrs_exception *pargException)
	Sets the OCR local score of the text element.

CPageTextElementAlternativeArray	CPageTextElement_GetAlternatives (const CPageTextElement argCPageTextElement, idrs_exception *pargException)
	Retrieves an array of alternative solutions for the text value.

void	CPageTextElement_SetLanguage (CPageTextElement argCPageTextElement, enum Language const evLanguage, idrs_exception *pargException)
	Sets the language for the text value.

void	CPageTextElement_SetStyle (CPageTextElement argCPageTextElement, const CPageStyleTextElement argStyle, idrs_exception *pargException)
	Sets the text element style.

void	CPageTextElement_SetAlternatives (CPageTextElement argCPageTextElement, const CPageTextElementAlternativeArray xAlternatives, idrs_exception *pargException)
	Sets the array of alternative text values.

void	CPageTextElement_Destroy (CPageTextElement argCPageTextElement, idrs_exception *pargException)
	Destroys a CPageTextElement handle.

CPageTextElementArray	ArrayInterface_Create_CPageTextElementArray (idrs_exception *pargException)
	Creates a new CPageTextElementArray object.

Detailed Description

Interface for CPageTextElement wrapper.

Function Documentation

◆ ArrayInterface_Create_CPageTextElementArray()

CPageTextElementArray ArrayInterface_Create_CPageTextElementArray ( idrs_exception * pargException )

Creates a new CPageTextElementArray object.

Parameters

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

Returns: The newly created CPageTextElementArray

◆ CPageTextElement_Create()

CPageTextElement CPageTextElement_Create ( idrs_exception * pargException )

Creates a new instance of a CPageTextElement.

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

◆ CPageTextElement_Destroy()

void CPageTextElement_Destroy	(	CPageTextElement	argCPageTextElement,
		idrs_exception *	pargException
	)

Destroys a CPageTextElement handle.

Parameters

argCPageTextElement	CPageTextElement handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageTextElement_GetAlternatives()

CPageTextElementAlternativeArray CPageTextElement_GetAlternatives	(	const CPageTextElement	argCPageTextElement,
		idrs_exception *	pargException
	)

Retrieves an array of alternative solutions for the text value.

Parameters

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

◆ CPageTextElement_GetBoundingPolygon()

CPolygon CPageTextElement_GetBoundingPolygon	(	const CPageTextElement	argCPageTextElement,
		idrs_exception *	pargException
	)

Gets the polygon where the text element is located.

Parameters

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

◆ CPageTextElement_GetLanguage()

enum Language CPageTextElement_GetLanguage	(	const CPageTextElement	argCPageTextElement,
		idrs_exception *	pargException
	)

Retrieves the language for the text value.

Parameters

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

◆ CPageTextElement_GetOcrConfidence()

IDRS_UINT CPageTextElement_GetOcrConfidence	(	const CPageTextElement	argCPageTextElement,
		idrs_exception *	pargException
	)

Retrieves the confidence value for the text element.

The confidence value ranges from 0 (lowest confidence) to 100 (highest confidence).

This value corresponds to the likeliness that the provided result is correct, and is computed by the OCR engine based on the OCR local score as well as contextual information like surrounding characters, typographical analysis, or presence of the word it belongs to in a lexicon.

Returns: Confidence value for the text element.

Remarks: In most cases, an integrator who wishes to assess the quality of a text element's recognition should rely on the OCR confidence value instead of on the OCR local score.

Parameters

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

◆ CPageTextElement_GetOcrLocalScore()

IDRS_UINT CPageTextElement_GetOcrLocalScore	(	const CPageTextElement	argCPageTextElement,
		idrs_exception *	pargException
	)

Retrieves the OCR local score of the text element.

The OCR score ranges from 0 (lowest score) to 100 (highest score).

This value corresponds to the recognition score of the text element, without taking into account information from surrounding elements. The score corresponds to the result of looking only at the shape of the current character.

Returns: OCR local score for the text element.

Remarks: In most cases, an integrator who wishes to assess the quality of a text element's recognition should rely on the OCR confidence value instead of on the OCR local score.

Parameters

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

◆ CPageTextElement_GetStyle()

CPageStyleTextElement CPageTextElement_GetStyle	(	const CPageTextElement	argCPageTextElement,
		idrs_exception *	pargException
	)

Retrieves the text element style.

Parameters

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

◆ CPageTextElement_GetTextValue()

const idrs_string CPageTextElement_GetTextValue	(	const CPageTextElement	argCPageTextElement,
		idrs_exception *	pargException
	)

Retrieves the text value.

Parameters

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

◆ CPageTextElement_SetAlternatives()

void CPageTextElement_SetAlternatives	(	CPageTextElement	argCPageTextElement,
		const CPageTextElementAlternativeArray	xAlternatives,
		idrs_exception *	pargException
	)

Sets the array of alternative text values.

Parameters

argCPageTextElement	CPageTextElement handle
xAlternatives	Array of alternative text values
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageTextElement_SetBoundingPolygon()

void CPageTextElement_SetBoundingPolygon	(	CPageTextElement	argCPageTextElement,
		const CPolygon	argBoundingPolygon,
		idrs_exception *	pargException
	)

Sets the polygon where the text element is located.

Parameters

argCPageTextElement	CPageTextElement handle
argBoundingPolygon	Polygon containing the text element
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageTextElement_SetLanguage()

void CPageTextElement_SetLanguage	(	CPageTextElement	argCPageTextElement,
		enum Language const	evLanguage,
		idrs_exception *	pargException
	)

Sets the language for the text value.

Parameters

argCPageTextElement	CPageTextElement handle
evLanguage	Language value
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageTextElement_SetOcrConfidence()

void CPageTextElement_SetOcrConfidence	(	CPageTextElement	argCPageTextElement,
		IDRS_UINT const	uiOcrConfidence,
		idrs_exception *	pargException
	)

Sets the confidence value for the text element.

The confidence value ranges from 0 (lowest confidence) to 100 (highest confidence).

This value corresponds to the likeliness that the provided result is correct, and is computed by the OCR engine based on the OCR local score as well as contextual information like surrounding characters, typographical analysis, or presence of the word it belongs to in a lexicon.

Parameters

argCPageTextElement	CPageTextElement handle
uiOcrConfidence	Confidence value for the text element.
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks: In most cases, an integrator who wishes to assess the quality of a text element's recognition should rely on the OCR confidence value instead of on the OCR local score.

◆ CPageTextElement_SetOcrLocalScore()

void CPageTextElement_SetOcrLocalScore	(	CPageTextElement	argCPageTextElement,
		IDRS_UINT const	uiOcrLocalScore,
		idrs_exception *	pargException
	)

Sets the OCR local score of the text element.

The OCR score ranges from 0 (lowest score) to 100 (highest score).

This value corresponds to the recognition score of the text element, without taking into account information from surrounding elements. The score corresponds to the result of looking only at the shape of the current character.

Parameters

argCPageTextElement	CPageTextElement handle
uiOcrLocalScore	OCR local score for the text element.
pargException	Pointer to exception structure that will be filled if an exception occurs

Remarks: In most cases, an integrator who wishes to assess the quality of a text element's recognition should rely on the OCR confidence value instead of on the OCR local score.

◆ CPageTextElement_SetStyle()

void CPageTextElement_SetStyle	(	CPageTextElement	argCPageTextElement,
		const CPageStyleTextElement	argStyle,
		idrs_exception *	pargException
	)

Sets the text element style.

Parameters

argCPageTextElement	CPageTextElement handle
argStyle	Text element style
pargException	Pointer to exception structure that will be filled if an exception occurs

◆ CPageTextElement_SetTextValue()

void CPageTextElement_SetTextValue	(	CPageTextElement	argCPageTextElement,
		const idrs_string	strTextValue,
		idrs_exception *	pargException
	)

Sets the text value.

Parameters

argCPageTextElement	CPageTextElement handle
strTextValue	The text value to set
pargException	Pointer to exception structure that will be filled if an exception occurs

Functions

Detailed Description

Function Documentation

◆ ArrayInterface_Create_CPageTextElementArray()

◆ CPageTextElement_Create()

◆ CPageTextElement_Destroy()

◆ CPageTextElement_GetAlternatives()

◆ CPageTextElement_GetBoundingPolygon()

◆ CPageTextElement_GetLanguage()

◆ CPageTextElement_GetOcrConfidence()

◆ CPageTextElement_GetOcrLocalScore()

◆ CPageTextElement_GetStyle()

◆ CPageTextElement_GetTextValue()

◆ CPageTextElement_SetAlternatives()

◆ CPageTextElement_SetBoundingPolygon()

◆ CPageTextElement_SetLanguage()

◆ CPageTextElement_SetOcrConfidence()

◆ CPageTextElement_SetOcrLocalScore()

◆ CPageTextElement_SetStyle()

◆ CPageTextElement_SetTextValue()