FieldHandle Class Reference

Base class for all fields. More...

Inheritance diagram for 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.
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.

Additional Inherited Members
Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.
Related Symbols inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter.

Detailed Description

Base class for all fields.

Examples

verify.c.

Friends And Related Symbol Documentation

Field_GetName()

error_type CALLING_CONVENTION Field_GetName ( FieldHandle *  handle, StringObjectHandle **  result  )

related

Get the partial field name (/T entry).

Returns

VANILLAPDF_ERROR_OBJECT_MISSING if the entry is not present.

Field_GetAlternateName()

error_type CALLING_CONVENTION Field_GetAlternateName ( FieldHandle *  handle, StringObjectHandle **  result  )

related

Get the alternate field name (/TU entry), used as tooltip text.

Returns

VANILLAPDF_ERROR_OBJECT_MISSING if the entry is not present.

Field_GetFieldFlags()

error_type CALLING_CONVENTION Field_GetFieldFlags ( FieldHandle *  handle, FieldFlags *  result  )

related

Get the field flags (/Ff entry).

Returns

VANILLAPDF_ERROR_OBJECT_MISSING if the entry is not present.

See also

FieldFlags

Field_SetFieldFlags()

error_type CALLING_CONVENTION Field_SetFieldFlags ( FieldHandle *  handle, FieldFlags  value  )

related

Set the field flags (/Ff entry).

See also

FieldFlags

Field_ToButton()

VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION Field_ToButton ( FieldHandle *  handle, ButtonFieldHandle **  result  )

related

Reinterpret current object as ButtonFieldHandle.

Deprecated:

Use ButtonField_FromField instead

Field_ToText()

VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION Field_ToText ( FieldHandle *  handle, TextFieldHandle **  result  )

related

Reinterpret current object as TextFieldHandle.

Deprecated:

Use TextField_FromField instead

Field_ToChoice()

VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION Field_ToChoice ( FieldHandle *  handle, ChoiceFieldHandle **  result  )

related

Reinterpret current object as ChoiceFieldHandle.

Deprecated:

Use ChoiceField_FromField instead

Field_ToSignature()

VANILLAPDF_DEPRECATED error_type CALLING_CONVENTION Field_ToSignature ( FieldHandle *  handle, SignatureFieldHandle **  result  )

related

Reinterpret current object as SignatureFieldHandle.

Deprecated:

Use SignatureField_FromField instead

Field_Release()

error_type CALLING_CONVENTION Field_Release ( FieldHandle *  handle )

related

Decrement the internal reference counter.

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