CFormField_interface.h File Reference

Interface for CFormField wrapper. More...

Go to the source code of this file.

Functions
CFormField	CFormField_Create (enum FormFieldType const argFormFieldType, idrs_exception *pargException)
	Creates a new Form Field element of the given type.
CFormField	CFormField_Create2 (enum FormFieldType const argFormFieldType, const IDRS_RECT *argBoundingBox, idrs_exception *pargException)
	Creates a new Form Field element of the given type with the given bounding box.
enum FormFieldType	CFormField_GetFormFieldType (const CFormField argCFormField, idrs_exception *pargException)
	GetFormFieldType returns the form field type.
CFormField	CFormField_GetParent (const CFormField argCFormField, idrs_exception *pargException)
	Get the parent group.
const idrs_string	CFormField_GetName (const CFormField argCFormField, idrs_exception *pargException)
	GetName returns the field partial name.
IDRS_INT	CFormField_GetCalculationPriority (const CFormField argCFormField, idrs_exception *pargException)
	GetCalculationPriority retrieves the priority for ordering the calculated fields.
CFormFieldStyle	CFormField_GetStyle (const CFormField argCFormField, idrs_exception *pargException)
	GetStyle returns the style associated with this field.
CFormAction	CFormField_GetFormAction (const CFormField argCFormField, enum FormFieldEventType const argEvent, idrs_exception *pargException)
	GetFormAction returs the action bound to the specified event.
void	CFormField_SetName (CFormField argCFormField, const idrs_string strName, idrs_exception *pargException)
	SetName sets the field partial name.
void	CFormField_SetCalculationPriority (CFormField argCFormField, IDRS_INT const argPriority, idrs_exception *pargException)
	SetCalculationPriority sets the priority for ordering the evaluation of calculated fields.
void	CFormField_SetStyle (CFormField argCFormField, const CFormFieldStyle argStyle, idrs_exception *pargException)
	GetStyle returns the style associated with this field.
void	CFormField_SetFormAction (CFormField argCFormField, enum FormFieldEventType const argEvent, const CFormAction argAction, idrs_exception *pargException)
	SetFormAction binds an action to the field for the specified event.
void	CFormField_UnbindFormAction (CFormField argCFormField, enum FormFieldEventType const argEvent, idrs_exception *pargException)
	UnbindFormAction unbinds the action associated with the specified event.
void	CFormField_Destroy (CFormField argCFormField, idrs_exception *pargException)
	Destroys a CFormField handle.
CFormFieldArray	ArrayInterface_Create_CFormFieldArray (idrs_exception *pargException)
	Creates a new CFormFieldArray object.

Detailed Description

Interface for CFormField wrapper.

Function Documentation

ArrayInterface_Create_CFormFieldArray()

CFormFieldArray ArrayInterface_Create_CFormFieldArray

(

idrs_exception *

pargException

)

Creates a new CFormFieldArray object.

Parameters

pargException

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

Returns

The newly created CFormFieldArray

CFormField_Create()

CFormField CFormField_Create	(	enum FormFieldType const	argFormFieldType,
		idrs_exception *	pargException
	)

Creates a new Form Field element of the given type.

Parameters

argFormFieldType	Type of the form field to be created
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

New form field instance.

Remarks

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

CFormField_Create2()

CFormField CFormField_Create2	(	enum FormFieldType const	argFormFieldType,
		const IDRS_RECT *	argBoundingBox,
		idrs_exception *	pargException
	)

Creates a new Form Field element of the given type with the given bounding box.

Parameters

argFormFieldType	Type of the form field to be created
argBoundingBox	The bounding box of the field element
pargException	Pointer to exception structure that will be filled if an exception occurs

Note

This method only supports types that allow specifying a bounding box, that is: [ Text, CombedText, RichText, Password, Checkbox, Dropdown, ListBox ]

Returns

New form field instance.

Remarks

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

CFormField_Destroy()

void CFormField_Destroy	(	CFormField	argCFormField,
		idrs_exception *	pargException
	)

Destroys a CFormField handle.

Parameters

argCFormField	CFormField handle to destroy
pargException	Pointer to exception structure that will be filled if an exception occurs

CFormField_GetCalculationPriority()

IDRS_INT CFormField_GetCalculationPriority	(	const CFormField	argCFormField,
		idrs_exception *	pargException
	)

GetCalculationPriority retrieves the priority for ordering the calculated fields.

Returns

The calculation priority property value.

Parameters

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

CFormField_GetFormAction()

CFormAction CFormField_GetFormAction	(	const CFormField	argCFormField,
		enum FormFieldEventType const	argEvent,
		idrs_exception *	pargException
	)

GetFormAction returs the action bound to the specified event.

Parameters

argCFormField	CFormField handle
argEvent	Event that triggers the action
pargException	Pointer to exception structure that will be filled if an exception occurs

Returns

The CFormAction smart pointer. Contains a NULL pointer if no action was set.

CFormField_GetFormFieldType()

enum FormFieldType CFormField_GetFormFieldType	(	const CFormField	argCFormField,
		idrs_exception *	pargException
	)

GetFormFieldType returns the form field type.

Returns

The FormFieldType value

Parameters

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

CFormField_GetName()

const idrs_string CFormField_GetName	(	const CFormField	argCFormField,
		idrs_exception *	pargException
	)

GetName returns the field partial name.

Note

The full name is represented by the combined names from all parent CFormFieldGroup elements starting at the topmost one in the hierarchy.

Returns

String containing the partial name

Parameters

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

CFormField_GetParent()

CFormField CFormField_GetParent	(	const CFormField	argCFormField,
		idrs_exception *	pargException
	)

Get the parent group.

Returns

The parent form field if this field is not a root element. A null object otherwise.

Parameters

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

CFormField_GetStyle()

CFormFieldStyle CFormField_GetStyle	(	const CFormField	argCFormField,
		idrs_exception *	pargException
	)

GetStyle returns the style associated with this field.

Returns

The field style object.

Parameters

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

CFormField_SetCalculationPriority()

void CFormField_SetCalculationPriority	(	CFormField	argCFormField,
		IDRS_INT const	argPriority,
		idrs_exception *	pargException
	)

SetCalculationPriority sets the priority for ordering the evaluation of calculated fields.

Parameters

argCFormField	CFormField handle
argPriority	The priority value. Any arbitrary integer value is allowed, where an higher
pargException	Pointer to exception structure that will be filled if an exception occurs value is considered as higher priority (default: 0).

CFormField_SetFormAction()

void CFormField_SetFormAction	(	CFormField	argCFormField,
		enum FormFieldEventType const	argEvent,
		const CFormAction	argAction,
		idrs_exception *	pargException
	)

SetFormAction binds an action to the field for the specified event.

Parameters

argCFormField	CFormField handle
argEvent	Event that triggers the action
argAction	Form action to execute for the specified event.
pargException	Pointer to exception structure that will be filled if an exception occurs

CFormField_SetName()

void CFormField_SetName	(	CFormField	argCFormField,
		const idrs_string	strName,
		idrs_exception *	pargException
	)

SetName sets the field partial name.

Note

The full name is represented by the combined names from all parent CFormFieldGroup elements starting at the topmost one in the hierarchy.

Parameters

argCFormField	CFormField handle
strName	String containing the partial name
pargException	Pointer to exception structure that will be filled if an exception occurs

CFormField_SetStyle()

void CFormField_SetStyle	(	CFormField	argCFormField,
		const CFormFieldStyle	argStyle,
		idrs_exception *	pargException
	)

GetStyle returns the style associated with this field.

Parameters

argCFormField	CFormField handle
argStyle	The field style object.
pargException	Pointer to exception structure that will be filled if an exception occurs

CFormField_UnbindFormAction()

void CFormField_UnbindFormAction	(	CFormField	argCFormField,
		enum FormFieldEventType const	argEvent,
		idrs_exception *	pargException
	)

UnbindFormAction unbinds the action associated with the specified event.

Note

The method has no effect if no action was set for the given event.

Parameters

argCFormField	CFormField handle
argEvent	Event that triggers the action
pargException	Pointer to exception structure that will be filled if an exception occurs