ButtonFieldHandle Class Reference

A button field represents an interactive control on the screen that the user can manipulate with the mouse. More...

Inheritance diagram for ButtonFieldHandle:

error_type CALLING_CONVENTION	ButtonField_GetValue (ButtonFieldHandle *handle, NameObjectHandle **result)
	Get the button field value (/V entry) as a name object. For checkboxes, typically /Yes or /Off. For radio buttons, the selected option name.
error_type CALLING_CONVENTION	ButtonField_SetValue (ButtonFieldHandle *handle, NameObjectHandle *value)
	Set the button field value (/V entry).
error_type CALLING_CONVENTION	ButtonField_ToField (ButtonFieldHandle *handle, FieldHandle **result)
	Reinterpret current object as FieldHandle.
error_type CALLING_CONVENTION	ButtonField_FromField (FieldHandle *handle, ButtonFieldHandle **result)
	Convert FieldHandle to ButtonFieldHandle.
error_type CALLING_CONVENTION	ButtonField_Release (ButtonFieldHandle *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 button field represents an interactive control on the screen that the user can manipulate with the mouse.

Friends And Related Symbol Documentation

ButtonField_Release()

error_type CALLING_CONVENTION ButtonField_Release ( ButtonFieldHandle *  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