A choice field contains several text items, one or more of which shall be selected as the field value. More...

Inheritance diagram for ChoiceFieldHandle:

error_type CALLING_CONVENTION	ChoiceField_GetValue (ChoiceFieldHandle handle, StringObjectHandle *result)
	Get the selected value (/V entry).

error_type CALLING_CONVENTION	ChoiceField_SetValue (ChoiceFieldHandle handle, StringObjectHandle value)
	Set the selected value (/V entry).

error_type CALLING_CONVENTION	ChoiceField_GetOptionCount (ChoiceFieldHandle handle, size_type result)
	Get the number of available options (/Opt entry).

error_type CALLING_CONVENTION	ChoiceField_GetOptionAt (ChoiceFieldHandle handle, size_type index, ObjectHandle *result)
	Get the option at the given index.

error_type CALLING_CONVENTION	ChoiceField_ToField (ChoiceFieldHandle handle, FieldHandle *result)
	Reinterpret current object as FieldHandle.

error_type CALLING_CONVENTION	ChoiceField_FromField (FieldHandle handle, ChoiceFieldHandle *result)
	Convert FieldHandle to ChoiceFieldHandle.

error_type CALLING_CONVENTION	ChoiceField_Release (ChoiceFieldHandle *handle)
	Decrement the internal reference counter.

Additional Inherited Members
Public Member Functions inherited from FieldHandle
error_type CALLING_CONVENTION	Field_CreateFromDictionary (DictionaryObjectHandle dictionary, FieldHandle *result)
	Create a field from a dictionary object. The field type is determined by the /FT entry in the dictionary.

Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.

Related Symbols inherited from FieldHandle
error_type CALLING_CONVENTION	Field_GetType (FieldHandle handle, FieldType result)
	Return type of field. Result can be used to convert to derived type.

error_type CALLING_CONVENTION	Field_GetName (FieldHandle handle, StringObjectHandle *result)
	Get the partial field name (/T entry).

error_type CALLING_CONVENTION	Field_GetAlternateName (FieldHandle handle, StringObjectHandle *result)
	Get the alternate field name (/TU entry), used as tooltip text.

error_type CALLING_CONVENTION	Field_GetFieldFlags (FieldHandle handle, FieldFlags result)
	Get the field flags (/Ff entry).

error_type CALLING_CONVENTION	Field_SetFieldFlags (FieldHandle *handle, FieldFlags value)
	Set the field flags (/Ff entry).

VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION	Field_ToButton (FieldHandle handle, ButtonFieldHandle *result)
	Reinterpret current object as ButtonFieldHandle.

VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION	Field_ToText (FieldHandle handle, TextFieldHandle *result)
	Reinterpret current object as TextFieldHandle.

VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION	Field_ToChoice (FieldHandle handle, ChoiceFieldHandle *result)
	Reinterpret current object as ChoiceFieldHandle.

VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION	Field_ToSignature (FieldHandle handle, SignatureFieldHandle *result)
	Reinterpret current object as SignatureFieldHandle.

error_type CALLING_CONVENTION	Field_ToUnknown (FieldHandle handle, IUnknownHandle *result)
	Reinterpret current object as IUnknownHandle.

error_type CALLING_CONVENTION	Field_FromUnknown (IUnknownHandle handle, FieldHandle *result)
	Convert IUnknownHandle to FieldHandle.

error_type CALLING_CONVENTION	Field_Release (FieldHandle *handle)
	Decrement the internal reference counter.

Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

A choice field contains several text items, one or more of which shall be selected as the field value.

Friends And Related Symbol Documentation

◆ ChoiceField_GetOptionAt()

error_type CALLING_CONVENTION ChoiceField_GetOptionAt	(	ChoiceFieldHandle *	handle,
		size_type	index,
		ObjectHandle **	result
	)

Each element is either a text string (serving as both export value and display text) or a two-element array where the first element is the export value and the second element is the display text (Table 231).

◆ ChoiceField_Release()

error_type CALLING_CONVENTION ChoiceField_Release ( ChoiceFieldHandle * handle )

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also: IUnknown_Release

The documentation for this class was generated from the following file:

c_fields.h

Additional Inherited Members

Detailed Description

Friends And Related Symbol Documentation

◆ ChoiceField_GetOptionAt()

◆ ChoiceField_Release()