PdfToolbox_PtxPdfForms.h File Reference

#include "PdfToolbox_Types.h"
#include "PdfToolbox_PtxSys.h"

Go to the source code of this file.

Macros
#define	PDFTOOLBOX_CALL
#define	PtxPdfForms_FieldNodeMap_Lookup   PtxPdfForms_FieldNodeMap_LookupA
#define	PtxPdfForms_FieldNodeMap_Get   PtxPdfForms_FieldNodeMap_GetA
#define	PtxPdfForms_FieldNodeMap_GetKey   PtxPdfForms_FieldNodeMap_GetKeyA
#define	PtxPdfForms_FieldNodeMap_Set   PtxPdfForms_FieldNodeMap_SetA
#define	PtxPdfForms_FieldNode_GetDisplayName   PtxPdfForms_FieldNode_GetDisplayNameA
#define	PtxPdfForms_FieldNode_SetDisplayName   PtxPdfForms_FieldNode_SetDisplayNameA
#define	PtxPdfForms_FieldNode_GetExportName   PtxPdfForms_FieldNode_GetExportNameA
#define	PtxPdfForms_FieldNode_SetExportName   PtxPdfForms_FieldNode_SetExportNameA
#define	PtxPdfForms_TextField_GetText   PtxPdfForms_TextField_GetTextA
#define	PtxPdfForms_TextField_SetText   PtxPdfForms_TextField_SetTextA
#define	PtxPdfForms_CheckBox_GetCheckedExportName   PtxPdfForms_CheckBox_GetCheckedExportNameA
#define	PtxPdfForms_RadioButton_GetExportName   PtxPdfForms_RadioButton_GetExportNameA
#define	PtxPdfForms_RadioButtonGroup_AddNewButton   PtxPdfForms_RadioButtonGroup_AddNewButtonA
#define	PtxPdfForms_ChoiceItem_GetDisplayName   PtxPdfForms_ChoiceItem_GetDisplayNameA
#define	PtxPdfForms_ChoiceItem_SetDisplayName   PtxPdfForms_ChoiceItem_SetDisplayNameA
#define	PtxPdfForms_ChoiceItem_GetExportName   PtxPdfForms_ChoiceItem_GetExportNameA
#define	PtxPdfForms_ChoiceItem_SetExportName   PtxPdfForms_ChoiceItem_SetExportNameA
#define	PtxPdfForms_ChoiceField_AddNewItem   PtxPdfForms_ChoiceField_AddNewItemA
#define	PtxPdfForms_ComboBox_GetEditableItemName   PtxPdfForms_ComboBox_GetEditableItemNameA
#define	PtxPdfForms_ComboBox_SetEditableItemName   PtxPdfForms_ComboBox_SetEditableItemNameA
#define	PtxPdfForms_SignedSignatureField_GetName   PtxPdfForms_SignedSignatureField_GetNameA
#define	PtxPdfForms_Signature_GetLocation   PtxPdfForms_Signature_GetLocationA
#define	PtxPdfForms_Signature_GetReason   PtxPdfForms_Signature_GetReasonA
#define	PtxPdfForms_Signature_GetContactInfo   PtxPdfForms_Signature_GetContactInfoA

Functions
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_LookupA (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const char *szIdentifierPath)
	Access a form field by path Lookup the form field node given by the identifier path.
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_LookupW (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const WCHAR *szIdentifierPath)
	Access a form field by path Lookup the form field node given by the identifier path.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetCount (TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
	The number of key-value pairs in the map.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetSize (TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
	The number of key-value pairs in the map.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetBegin (TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
	Get the position of the first entry in the map.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetEnd (TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
	Get the end position of the map.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetNext (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it)
	Get the position of the next entry in the map.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetA (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const char *szKey)
	Get the position of a key in the map. If no error occurred, then the position can be used to get the corresponding value with PtxPdfForms_FieldNodeMap_GetValue.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetW (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const WCHAR *szKey)
	Get the position of a key in the map. If no error occurred, then the position can be used to get the corresponding value with PtxPdfForms_FieldNodeMap_GetValue.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetKeyA (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, char *pBuffer, size_t nBufferSize)
	Get the key of the entry given a position.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetKeyW (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, WCHAR *pBuffer, size_t nBufferSize)
	Get the key of the entry given a position.
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_GetValue (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it)
	Get the value of the entry given a position.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_SetA (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const char *szKey, TPtxPdfForms_FieldNode *pValue)
	Set the value of an entry for a given key. This operation invalidates all positions previously returned by‹pre›_‹map›_GetBegin, PtxPdfForms_FieldNodeMap_GetEnd, PtxPdfForms_FieldNodeMap_GetNext, and PtxPdfForms_FieldNodeMap_Get.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_SetW (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const WCHAR *szKey, TPtxPdfForms_FieldNode *pValue)
	Set the value of an entry for a given key. This operation invalidates all positions previously returned by‹pre›_‹map›_GetBegin, PtxPdfForms_FieldNodeMap_GetEnd, PtxPdfForms_FieldNodeMap_GetNext, and PtxPdfForms_FieldNodeMap_Get.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_FieldNodeMap_SetValue (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, TPtxPdfForms_FieldNode *pValue)
	Set the value of the entry at a position in the map.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_WidgetList_GetCount (TPtxPdfForms_WidgetList *pWidgetList)
	Get the number of elements in the list.
PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL	PtxPdfForms_WidgetList_Get (TPtxPdfForms_WidgetList *pWidgetList, int iIndex)
	Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_WidgetList_Add (TPtxPdfForms_WidgetList *pWidgetList, TPtxPdfForms_Widget *pWidget)
	Add an element to the end of the list.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_SignatureFieldList_GetCount (TPtxPdfForms_SignatureFieldList *pSignatureFieldList)
	Get the number of elements in the list.
PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureField *PDFTOOLBOX_CALL	PtxPdfForms_SignatureFieldList_Get (TPtxPdfForms_SignatureFieldList *pSignatureFieldList, int iIndex)
	Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Widget_GetBoundingBox (TPtxPdfForms_Widget *pWidget, TPtxGeomReal_Rectangle *pBoundingBox)
	The location on the page.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Widget_GetHidden (TPtxPdfForms_Widget *pWidget)
	The widget's visibility If TRUE then the widget is present, but is invisible and not available for user interaction. Depending on the PtxPdfForms_Widget_GetNoPrint property it will, however, still be visible when printing.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Widget_SetHidden (TPtxPdfForms_Widget *pWidget, BOOL bHidden)
	The widget's visibility If TRUE then the widget is present, but is invisible and not available for user interaction. Depending on the PtxPdfForms_Widget_GetNoPrint property it will, however, still be visible when printing.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Widget_GetLocked (TPtxPdfForms_Widget *pWidget)
	Whether the widget can be modified This does not restrict modification of the widget's content.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Widget_SetLocked (TPtxPdfForms_Widget *pWidget, BOOL bLocked)
	Whether the widget can be modified This does not restrict modification of the widget's content.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Widget_GetNoPrint (TPtxPdfForms_Widget *pWidget)
	The widget's visibility when printing If TRUE then the widget is not present in a print output of the document.
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_Copy (TPtxPdf_Document *pTargetDocument, TPtxPdfForms_FieldNode *pFieldNode)
	Copy a form field node Copy a form field node object from an input document to the given pTargetDocument. The returned object is associated with the given target document but not yet part of it.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_GetDisplayNameA (TPtxPdfForms_FieldNode *pFieldNode, char *pBuffer, size_t nBufferSize)
	User interface name The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_GetDisplayNameW (TPtxPdfForms_FieldNode *pFieldNode, WCHAR *pBuffer, size_t nBufferSize)
	User interface name The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_SetDisplayNameA (TPtxPdfForms_FieldNode *pFieldNode, const char *szDisplayName)
	User interface name The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_SetDisplayNameW (TPtxPdfForms_FieldNode *pFieldNode, const WCHAR *szDisplayName)
	User interface name The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_GetExportNameA (TPtxPdfForms_FieldNode *pFieldNode, char *pBuffer, size_t nBufferSize)
	The name used when exporting.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_GetExportNameW (TPtxPdfForms_FieldNode *pFieldNode, WCHAR *pBuffer, size_t nBufferSize)
	The name used when exporting.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_SetExportNameA (TPtxPdfForms_FieldNode *pFieldNode, const char *szExportName)
	The name used when exporting.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_SetExportNameW (TPtxPdfForms_FieldNode *pFieldNode, const WCHAR *szExportName)
	The name used when exporting.
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeType PDFTOOLBOX_CALL	PtxPdfForms_FieldNode_GetType (TPtxPdfForms_FieldNode *pFieldNode)
	Get actual derived type of base type TPtxPdfForms_FieldNode.
PDFTOOLBOX_EXPORT TPtxPdfForms_SubForm *PDFTOOLBOX_CALL	PtxPdfForms_SubForm_Create (TPtxPdf_Document *pTargetDocument)
	Create a sub form The returned sub form object is not yet used, but it is associated with the given target document.
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeMap *PDFTOOLBOX_CALL	PtxPdfForms_SubForm_GetChildren (TPtxPdfForms_SubForm *pSubForm)
	The child form fields Adding to this list results in an error:
PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL	PtxPdfForms_Field_AddNewWidget (TPtxPdfForms_Field *pField, const TPtxGeomReal_Rectangle *pBoundingBox)
	Create a new widget and add to the form field This method creates a widget for the form field. The widget is automatically added to the field's widgets, but not to any page. This method does not work for radio button form fields; Use PtxPdfForms_RadioButton_AddNewWidget.
PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLBOX_CALL	PtxPdfForms_Field_GetWidgets (TPtxPdfForms_Field *pField)
	This form field's widget annotations.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Field_GetReadOnly (TPtxPdfForms_Field *pField)
	Flags this field as read-only.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Field_SetReadOnly (TPtxPdfForms_Field *pField, BOOL bReadOnly)
	Flags this field as read-only.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Field_GetRequired (TPtxPdfForms_Field *pField)
	Flags this field as mandatory.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Field_SetRequired (TPtxPdfForms_Field *pField, BOOL bRequired)
	Flags this field as mandatory.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Field_GetDoNotExport (TPtxPdfForms_Field *pField)
	Tells whether this field is exported.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_Field_SetDoNotExport (TPtxPdfForms_Field *pField, BOOL bDoNotExport)
	Tells whether this field is exported.
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldType PDFTOOLBOX_CALL	PtxPdfForms_Field_GetType (TPtxPdfForms_Field *pField)
	Get actual derived type of base type TPtxPdfForms_Field.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_TextField_GetTextA (TPtxPdfForms_TextField *pTextField, char *pBuffer, size_t nBufferSize)
	This field's text.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_TextField_GetTextW (TPtxPdfForms_TextField *pTextField, WCHAR *pBuffer, size_t nBufferSize)
	This field's text.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_TextField_SetTextA (TPtxPdfForms_TextField *pTextField, const char *szText)
	This field's text.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_TextField_SetTextW (TPtxPdfForms_TextField *pTextField, const WCHAR *szText)
	This field's text.
PDFTOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLBOX_CALL	PtxPdfForms_TextField_GetAlignment (TPtxPdfForms_TextField *pTextField)
	The text alignment.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_TextField_SetAlignment (TPtxPdfForms_TextField *pTextField, TPtxGeom_HorizontalAlignment iAlignment)
	The text alignment.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_TextField_GetFontSize (TPtxPdfForms_TextField *pTextField, double *pFontSize)
	The font size If NULL then the font size is chosen automatically by the PDF viewer.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_TextField_SetFontSize (TPtxPdfForms_TextField *pTextField, const double *pFontSize)
	The font size If NULL then the font size is chosen automatically by the PDF viewer.
PDFTOOLBOX_EXPORT TPtxPdfForms_TextFieldType PDFTOOLBOX_CALL	PtxPdfForms_TextField_GetType (TPtxPdfForms_TextField *pTextField)
	Get actual derived type of base type TPtxPdfForms_TextField.
PDFTOOLBOX_EXPORT TPtxPdfForms_GeneralTextField *PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_Create (TPtxPdf_Document *pTargetDocument)
	Create a general text form field The returned form field object is not yet used, but it is associated with the given target document.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_GetMaxLength (TPtxPdfForms_GeneralTextField *pGeneralTextField, int *pMaxLength)
	The maximal text length When setting this property to a non-null value, the length of this field's text is truncated.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_SetMaxLength (TPtxPdfForms_GeneralTextField *pGeneralTextField, const int *pMaxLength)
	The maximal text length When setting this property to a non-null value, the length of this field's text is truncated.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_GetMultiline (TPtxPdfForms_GeneralTextField *pGeneralTextField)
	Flags this text field as multi-line.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_SetMultiline (TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bMultiline)
	Flags this text field as multi-line.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_GetPassword (TPtxPdfForms_GeneralTextField *pGeneralTextField)
	Flags this text field as a password entry field.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_SetPassword (TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bPassword)
	Flags this text field as a password entry field.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_GetDoNotSpellCheck (TPtxPdfForms_GeneralTextField *pGeneralTextField)
	Flags this text field for prevention from spell checking.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_SetDoNotSpellCheck (TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bDoNotSpellCheck)
	Flags this text field for prevention from spell checking.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_GetDoNotScroll (TPtxPdfForms_GeneralTextField *pGeneralTextField)
	Flags this text field non scrollable.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_GeneralTextField_SetDoNotScroll (TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bDoNotScroll)
	Flags this text field non scrollable.
PDFTOOLBOX_EXPORT TPtxPdfForms_CombTextField *PDFTOOLBOX_CALL	PtxPdfForms_CombTextField_Create (TPtxPdf_Document *pTargetDocument, int iMaxLength)
	Create a comb text form field The returned form field object is not yet used, but it is associated with the given target document.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_CombTextField_GetMaxLength (TPtxPdfForms_CombTextField *pCombTextField)
	The maximal text length When setting this property, the length of this field's text is truncated to the given value.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_CombTextField_SetMaxLength (TPtxPdfForms_CombTextField *pCombTextField, int iMaxLength)
	The maximal text length When setting this property, the length of this field's text is truncated to the given value.
PDFTOOLBOX_EXPORT TPtxPdfForms_CheckBox *PDFTOOLBOX_CALL	PtxPdfForms_CheckBox_Create (TPtxPdf_Document *pTargetDocument)
	Create a check box form field The returned form field object is not yet used, but it is associated with the given target document.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_CheckBox_GetCheckedExportNameA (TPtxPdfForms_CheckBox *pCheckBox, char *pBuffer, size_t nBufferSize)
	The name of the checked ('on') state used when exporting.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_CheckBox_GetCheckedExportNameW (TPtxPdfForms_CheckBox *pCheckBox, WCHAR *pBuffer, size_t nBufferSize)
	The name of the checked ('on') state used when exporting.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_CheckBox_GetChecked (TPtxPdfForms_CheckBox *pCheckBox)
	The state of the check box.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_CheckBox_SetChecked (TPtxPdfForms_CheckBox *pCheckBox, BOOL bChecked)
	The state of the check box.
PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL	PtxPdfForms_RadioButton_AddNewWidget (TPtxPdfForms_RadioButton *pRadioButton, const TPtxGeomReal_Rectangle *pBoundingBox)
	Create radio button widget This method creates a widget for the radio button. The widget is automatically added to the button's widgets and to the radio button form field's widgets, but not to any page.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_RadioButton_GetExportNameA (TPtxPdfForms_RadioButton *pRadioButton, char *pBuffer, size_t nBufferSize)
	The button's name used when exporting.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_RadioButton_GetExportNameW (TPtxPdfForms_RadioButton *pRadioButton, WCHAR *pBuffer, size_t nBufferSize)
	The button's name used when exporting.
PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLBOX_CALL	PtxPdfForms_RadioButton_GetWidgets (TPtxPdfForms_RadioButton *pRadioButton)
	The button's widget annotations.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_RadioButtonList_GetCount (TPtxPdfForms_RadioButtonList *pRadioButtonList)
	Get the number of elements in the list.
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL	PtxPdfForms_RadioButtonList_Get (TPtxPdfForms_RadioButtonList *pRadioButtonList, int iIndex)
	Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButtonGroup *PDFTOOLBOX_CALL	PtxPdfForms_RadioButtonGroup_Create (TPtxPdf_Document *pTargetDocument)
	Create a radio button form field The returned form field object is not yet used, but it is associated with the given target document.
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL	PtxPdfForms_RadioButtonGroup_AddNewButtonA (TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup, const char *szExportName)
	Create a radio button The created radio button is automatically added to this radio button field's PtxPdfForms_RadioButtonGroup_GetButtons.
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL	PtxPdfForms_RadioButtonGroup_AddNewButtonW (TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup, const WCHAR *szExportName)
	Create a radio button The created radio button is automatically added to this radio button field's PtxPdfForms_RadioButtonGroup_GetButtons.
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButtonList *PDFTOOLBOX_CALL	PtxPdfForms_RadioButtonGroup_GetButtons (TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup)
	This field's buttons.
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL	PtxPdfForms_RadioButtonGroup_GetChosenButton (TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup)
	This field's selected button if NULL is set, then no button is chosen.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_RadioButtonGroup_SetChosenButton (TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup, TPtxPdfForms_RadioButton *pChosenButton)
	This field's selected button if NULL is set, then no button is chosen.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItem_GetDisplayNameA (TPtxPdfForms_ChoiceItem *pChoiceItem, char *pBuffer, size_t nBufferSize)
	Displayed name This is the name of the item as displayed in a PDF viewer.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItem_GetDisplayNameW (TPtxPdfForms_ChoiceItem *pChoiceItem, WCHAR *pBuffer, size_t nBufferSize)
	Displayed name This is the name of the item as displayed in a PDF viewer.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItem_SetDisplayNameA (TPtxPdfForms_ChoiceItem *pChoiceItem, const char *szDisplayName)
	Displayed name This is the name of the item as displayed in a PDF viewer.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItem_SetDisplayNameW (TPtxPdfForms_ChoiceItem *pChoiceItem, const WCHAR *szDisplayName)
	Displayed name This is the name of the item as displayed in a PDF viewer.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItem_GetExportNameA (TPtxPdfForms_ChoiceItem *pChoiceItem, char *pBuffer, size_t nBufferSize)
	Export name This is the name of the item used when exporting.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItem_GetExportNameW (TPtxPdfForms_ChoiceItem *pChoiceItem, WCHAR *pBuffer, size_t nBufferSize)
	Export name This is the name of the item used when exporting.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItem_SetExportNameA (TPtxPdfForms_ChoiceItem *pChoiceItem, const char *szExportName)
	Export name This is the name of the item used when exporting.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItem_SetExportNameW (TPtxPdfForms_ChoiceItem *pChoiceItem, const WCHAR *szExportName)
	Export name This is the name of the item used when exporting.
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItemList_GetCount (TPtxPdfForms_ChoiceItemList *pChoiceItemList)
	Get the number of elements in the list.
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItemList_Get (TPtxPdfForms_ChoiceItemList *pChoiceItemList, int iIndex)
	Returns the element at the specified position in the given list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItemList_Add (TPtxPdfForms_ChoiceItemList *pChoiceItemList, TPtxPdfForms_ChoiceItem *pChoiceItem)
	Add an element to the end of the list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItemList_Clear (TPtxPdfForms_ChoiceItemList *pChoiceItemList)
	Clear list.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ChoiceItemList_Remove (TPtxPdfForms_ChoiceItemList *pChoiceItemList, int iIndex)
	Remove certain element from list.
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL	PtxPdfForms_ChoiceField_AddNewItemA (TPtxPdfForms_ChoiceField *pChoiceField, const char *szDisplayName)
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL	PtxPdfForms_ChoiceField_AddNewItemW (TPtxPdfForms_ChoiceField *pChoiceField, const WCHAR *szDisplayName)
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLBOX_CALL	PtxPdfForms_ChoiceField_GetItems (TPtxPdfForms_ChoiceField *pChoiceField)
	The list of choice items Adding or removing items or clearing the list is not supported.
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceFieldType PDFTOOLBOX_CALL	PtxPdfForms_ChoiceField_GetType (TPtxPdfForms_ChoiceField *pChoiceField)
	Get actual derived type of base type TPtxPdfForms_ChoiceField.
PDFTOOLBOX_EXPORT TPtxPdfForms_ListBox *PDFTOOLBOX_CALL	PtxPdfForms_ListBox_Create (TPtxPdf_Document *pTargetDocument)
	Create a list box form field The returned form field object is not yet used, but it is associated with the given target document.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ListBox_GetAllowMultiSelect (TPtxPdfForms_ListBox *pListBox)
	Allow multiple items to be selected.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ListBox_SetAllowMultiSelect (TPtxPdfForms_ListBox *pListBox, BOOL bAllowMultiSelect)
	Allow multiple items to be selected.
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLBOX_CALL	PtxPdfForms_ListBox_GetChosenItems (TPtxPdfForms_ListBox *pListBox)
	The selected choice items.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ListBox_GetFontSize (TPtxPdfForms_ListBox *pListBox, double *pFontSize)
	The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ListBox_SetFontSize (TPtxPdfForms_ListBox *pListBox, const double *pFontSize)
	The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.
PDFTOOLBOX_EXPORT TPtxPdfForms_ComboBox *PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_Create (TPtxPdf_Document *pTargetDocument)
	Create a combo box form field The returned form field object is not yet used, but it is associated with the given target document.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_GetCanEdit (TPtxPdfForms_ComboBox *pComboBox)
	Has an editable item.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_SetCanEdit (TPtxPdfForms_ComboBox *pComboBox, BOOL bCanEdit)
	Has an editable item.
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_GetChosenItem (TPtxPdfForms_ComboBox *pComboBox)
	The selected combo box item If this property is NULL then the PtxPdfForms_ComboBox_GetEditableItemName is the selected value. Setting this property automatically sets PtxPdfForms_ComboBox_GetEditableItemName to NULL.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_SetChosenItem (TPtxPdfForms_ComboBox *pComboBox, TPtxPdfForms_ChoiceItem *pChosenItem)
	The selected combo box item If this property is NULL then the PtxPdfForms_ComboBox_GetEditableItemName is the selected value. Setting this property automatically sets PtxPdfForms_ComboBox_GetEditableItemName to NULL.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_GetEditableItemNameA (TPtxPdfForms_ComboBox *pComboBox, char *pBuffer, size_t nBufferSize)
	The name of the editable item This property is NULL if any of the combo box items is selected, i.e., if PtxPdfForms_ComboBox_GetChosenItem is not NULL. Setting this property automatically sets PtxPdfForms_ComboBox_GetChosenItem to NULL.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_GetEditableItemNameW (TPtxPdfForms_ComboBox *pComboBox, WCHAR *pBuffer, size_t nBufferSize)
	The name of the editable item This property is NULL if any of the combo box items is selected, i.e., if PtxPdfForms_ComboBox_GetChosenItem is not NULL. Setting this property automatically sets PtxPdfForms_ComboBox_GetChosenItem to NULL.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_SetEditableItemNameA (TPtxPdfForms_ComboBox *pComboBox, const char *szEditableItemName)
	The name of the editable item This property is NULL if any of the combo box items is selected, i.e., if PtxPdfForms_ComboBox_GetChosenItem is not NULL. Setting this property automatically sets PtxPdfForms_ComboBox_GetChosenItem to NULL.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_SetEditableItemNameW (TPtxPdfForms_ComboBox *pComboBox, const WCHAR *szEditableItemName)
	The name of the editable item This property is NULL if any of the combo box items is selected, i.e., if PtxPdfForms_ComboBox_GetChosenItem is not NULL. Setting this property automatically sets PtxPdfForms_ComboBox_GetChosenItem to NULL.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_GetFontSize (TPtxPdfForms_ComboBox *pComboBox, double *pFontSize)
	The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_ComboBox_SetFontSize (TPtxPdfForms_ComboBox *pComboBox, const double *pFontSize)
	The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_SignatureField_IsVisible (TPtxPdfForms_SignatureField *pSignatureField)
	The visibility of the signature field If TRUE, the signature field has a visual appearance on the page.
PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureFieldType PDFTOOLBOX_CALL	PtxPdfForms_SignatureField_GetType (TPtxPdfForms_SignatureField *pSignatureField)
	Get actual derived type of base type TPtxPdfForms_SignatureField.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_SignedSignatureField_GetNameA (TPtxPdfForms_SignedSignatureField *pSignedSignatureField, char *pBuffer, size_t nBufferSize)
	The name of the person or authority that signed the document.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_SignedSignatureField_GetNameW (TPtxPdfForms_SignedSignatureField *pSignedSignatureField, WCHAR *pBuffer, size_t nBufferSize)
	The name of the person or authority that signed the document.
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL	PtxPdfForms_SignedSignatureField_GetDate (TPtxPdfForms_SignedSignatureField *pSignedSignatureField, TPtxSys_Date *pDate)
	The date and time of signing.
PDFTOOLBOX_EXPORT TPtxPdfForms_SignedSignatureFieldType PDFTOOLBOX_CALL	PtxPdfForms_SignedSignatureField_GetType (TPtxPdfForms_SignedSignatureField *pSignedSignatureField)
	Get actual derived type of base type TPtxPdfForms_SignedSignatureField.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_Signature_GetLocationA (TPtxPdfForms_Signature *pSignature, char *pBuffer, size_t nBufferSize)
	The location of signing The CPU host name or physical location of the signing.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_Signature_GetLocationW (TPtxPdfForms_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
	The location of signing The CPU host name or physical location of the signing.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_Signature_GetReasonA (TPtxPdfForms_Signature *pSignature, char *pBuffer, size_t nBufferSize)
	The reason for signing.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_Signature_GetReasonW (TPtxPdfForms_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
	The reason for signing.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_Signature_GetContactInfoA (TPtxPdfForms_Signature *pSignature, char *pBuffer, size_t nBufferSize)
	The contact information of the signer Information provided by the signer to enable a recipient to contact the signer to verify the signature; for example, a phone number.
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL	PtxPdfForms_Signature_GetContactInfoW (TPtxPdfForms_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
	The contact information of the signer Information provided by the signer to enable a recipient to contact the signer to verify the signature; for example, a phone number.
PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureType PDFTOOLBOX_CALL	PtxPdfForms_Signature_GetType (TPtxPdfForms_Signature *pSignature)
	Get actual derived type of base type TPtxPdfForms_Signature.
PDFTOOLBOX_EXPORT TPtxPdfForms_MdpPermissions PDFTOOLBOX_CALL	PtxPdfForms_DocMdpSignature_GetPermissions (TPtxPdfForms_DocMdpSignature *pDocMdpSignature)
	The access permissions granted for this document Note that for encrypted PDF documents, the restrictions defined by this DocMDPSignature are in addition to the document PtxPdf_Document_GetPermissions.

Macro Definition Documentation

PDFTOOLBOX_CALL

#define PDFTOOLBOX_CALL

PtxPdfForms_CheckBox_GetCheckedExportName

#define PtxPdfForms_CheckBox_GetCheckedExportName   PtxPdfForms_CheckBox_GetCheckedExportNameA

PtxPdfForms_ChoiceField_AddNewItem

#define PtxPdfForms_ChoiceField_AddNewItem   PtxPdfForms_ChoiceField_AddNewItemA

PtxPdfForms_ChoiceItem_GetDisplayName

#define PtxPdfForms_ChoiceItem_GetDisplayName   PtxPdfForms_ChoiceItem_GetDisplayNameA

PtxPdfForms_ChoiceItem_GetExportName

#define PtxPdfForms_ChoiceItem_GetExportName   PtxPdfForms_ChoiceItem_GetExportNameA

PtxPdfForms_ChoiceItem_SetDisplayName

#define PtxPdfForms_ChoiceItem_SetDisplayName   PtxPdfForms_ChoiceItem_SetDisplayNameA

PtxPdfForms_ChoiceItem_SetExportName

#define PtxPdfForms_ChoiceItem_SetExportName   PtxPdfForms_ChoiceItem_SetExportNameA

PtxPdfForms_ComboBox_GetEditableItemName

#define PtxPdfForms_ComboBox_GetEditableItemName   PtxPdfForms_ComboBox_GetEditableItemNameA

PtxPdfForms_ComboBox_SetEditableItemName

#define PtxPdfForms_ComboBox_SetEditableItemName   PtxPdfForms_ComboBox_SetEditableItemNameA

PtxPdfForms_FieldNode_GetDisplayName

#define PtxPdfForms_FieldNode_GetDisplayName   PtxPdfForms_FieldNode_GetDisplayNameA

PtxPdfForms_FieldNode_GetExportName

#define PtxPdfForms_FieldNode_GetExportName   PtxPdfForms_FieldNode_GetExportNameA

PtxPdfForms_FieldNode_SetDisplayName

#define PtxPdfForms_FieldNode_SetDisplayName   PtxPdfForms_FieldNode_SetDisplayNameA

PtxPdfForms_FieldNode_SetExportName

#define PtxPdfForms_FieldNode_SetExportName   PtxPdfForms_FieldNode_SetExportNameA

PtxPdfForms_FieldNodeMap_Get

#define PtxPdfForms_FieldNodeMap_Get   PtxPdfForms_FieldNodeMap_GetA

PtxPdfForms_FieldNodeMap_GetKey

#define PtxPdfForms_FieldNodeMap_GetKey   PtxPdfForms_FieldNodeMap_GetKeyA

PtxPdfForms_FieldNodeMap_Lookup

#define PtxPdfForms_FieldNodeMap_Lookup   PtxPdfForms_FieldNodeMap_LookupA

PtxPdfForms_FieldNodeMap_Set

#define PtxPdfForms_FieldNodeMap_Set   PtxPdfForms_FieldNodeMap_SetA

PtxPdfForms_RadioButton_GetExportName

#define PtxPdfForms_RadioButton_GetExportName   PtxPdfForms_RadioButton_GetExportNameA

PtxPdfForms_RadioButtonGroup_AddNewButton

#define PtxPdfForms_RadioButtonGroup_AddNewButton   PtxPdfForms_RadioButtonGroup_AddNewButtonA

PtxPdfForms_Signature_GetContactInfo

#define PtxPdfForms_Signature_GetContactInfo   PtxPdfForms_Signature_GetContactInfoA

PtxPdfForms_Signature_GetLocation

#define PtxPdfForms_Signature_GetLocation   PtxPdfForms_Signature_GetLocationA

PtxPdfForms_Signature_GetReason

#define PtxPdfForms_Signature_GetReason   PtxPdfForms_Signature_GetReasonA

PtxPdfForms_SignedSignatureField_GetName

#define PtxPdfForms_SignedSignatureField_GetName   PtxPdfForms_SignedSignatureField_GetNameA

PtxPdfForms_TextField_GetText

#define PtxPdfForms_TextField_GetText   PtxPdfForms_TextField_GetTextA

PtxPdfForms_TextField_SetText

#define PtxPdfForms_TextField_SetText   PtxPdfForms_TextField_SetTextA

Function Documentation

PtxPdfForms_CheckBox_Create()

PDFTOOLBOX_EXPORT TPtxPdfForms_CheckBox *PDFTOOLBOX_CALL PtxPdfForms_CheckBox_Create

(

TPtxPdf_Document *

pTargetDocument

)

Create a check box form field The returned form field object is not yet used, but it is associated with the given target document.

Parameters

[in,out]

pTargetDocument

the output document with which the returned object is associated

Returns

the newly created check box field

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument the target document contains form fields that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetFormFields was set to ePtxPdfForms_FormFieldCopyStrategy_Copy
• ePtx_Error_IllegalArgument the target document contains unsigned signatures that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetUnsignedSignatures was set to ePtxPdf_CopyStrategy_Copy.

PtxPdfForms_CheckBox_GetChecked()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetChecked

(

TPtxPdfForms_CheckBox *

pCheckBox

)

The state of the check box.

Parameters

[in,out]

pCheckBox

Acts as a handle to the native object of type TPtxPdfForms_CheckBox.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field is marked as read-only

PtxPdfForms_CheckBox_GetCheckedExportNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetCheckedExportNameA	(	TPtxPdfForms_CheckBox *	pCheckBox,
		char *	pBuffer,
		size_t	nBufferSize )

The name of the checked ('on') state used when exporting.

Parameters

[in,out]	pCheckBox	Acts as a handle to the native object of type TPtxPdfForms_CheckBox.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_CheckBox_GetCheckedExportNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetCheckedExportNameW	(	TPtxPdfForms_CheckBox *	pCheckBox,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name of the checked ('on') state used when exporting.

Parameters

[in,out]	pCheckBox	Acts as a handle to the native object of type TPtxPdfForms_CheckBox.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_CheckBox_SetChecked()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_CheckBox_SetChecked	(	TPtxPdfForms_CheckBox *	pCheckBox,
		BOOL	bChecked )

The state of the check box.

Parameters

[in,out]	pCheckBox	Acts as a handle to the native object of type TPtxPdfForms_CheckBox.
[in]	bChecked	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field is marked as read-only

PtxPdfForms_ChoiceField_AddNewItemA()

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL PtxPdfForms_ChoiceField_AddNewItemA	(	TPtxPdfForms_ChoiceField *	pChoiceField,
		const char *	szDisplayName )

Creates a new choice item. The item is automatically added to the choice field's PtxPdfForms_ChoiceField_GetItems.

Parameters

[in,out]	pChoiceField	Acts as a handle to the native object of type TPtxPdfForms_ChoiceField.
[in]	szDisplayName	this item's display name

Returns

the newly created choice item

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_UnsupportedOperation the document is read-only

PtxPdfForms_ChoiceField_AddNewItemW()

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL PtxPdfForms_ChoiceField_AddNewItemW	(	TPtxPdfForms_ChoiceField *	pChoiceField,
		const WCHAR *	szDisplayName )

Creates a new choice item. The item is automatically added to the choice field's PtxPdfForms_ChoiceField_GetItems.

Parameters

[in,out]	pChoiceField	Acts as a handle to the native object of type TPtxPdfForms_ChoiceField.
[in]	szDisplayName	this item's display name

Returns

the newly created choice item

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_UnsupportedOperation the document is read-only

PtxPdfForms_ChoiceField_GetItems()

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLBOX_CALL PtxPdfForms_ChoiceField_GetItems

(

TPtxPdfForms_ChoiceField *

pChoiceField

)

The list of choice items Adding or removing items or clearing the list is not supported.

Parameters

[in,out]

pChoiceField

Acts as a handle to the native object of type TPtxPdfForms_ChoiceField.

Returns

Retrieved value.

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_ChoiceField_GetType()

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceFieldType PDFTOOLBOX_CALL PtxPdfForms_ChoiceField_GetType

(

TPtxPdfForms_ChoiceField *

pChoiceField

)

Get actual derived type of base type TPtxPdfForms_ChoiceField.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out]

pChoiceField

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfForms_ChoiceFieldType that refers to the actual derived type. 0 in case of an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

PtxPdfForms_ChoiceItem_GetDisplayNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetDisplayNameA	(	TPtxPdfForms_ChoiceItem *	pChoiceItem,
		char *	pBuffer,
		size_t	nBufferSize )

Displayed name This is the name of the item as displayed in a PDF viewer.

Parameters

[in,out]	pChoiceItem	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the owning choice field's document is read-only
• ePtx_Error_IllegalState if the owning choice field has widgets

PtxPdfForms_ChoiceItem_GetDisplayNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetDisplayNameW	(	TPtxPdfForms_ChoiceItem *	pChoiceItem,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

Displayed name This is the name of the item as displayed in a PDF viewer.

Parameters

[in,out]	pChoiceItem	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the owning choice field's document is read-only
• ePtx_Error_IllegalState if the owning choice field has widgets

PtxPdfForms_ChoiceItem_GetExportNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetExportNameA	(	TPtxPdfForms_ChoiceItem *	pChoiceItem,
		char *	pBuffer,
		size_t	nBufferSize )

Export name This is the name of the item used when exporting.

Parameters

[in,out]	pChoiceItem	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the owning choice field's document is read-only

PtxPdfForms_ChoiceItem_GetExportNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetExportNameW	(	TPtxPdfForms_ChoiceItem *	pChoiceItem,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

Export name This is the name of the item used when exporting.

Parameters

[in,out]	pChoiceItem	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the owning choice field's document is read-only

PtxPdfForms_ChoiceItem_SetDisplayNameA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetDisplayNameA	(	TPtxPdfForms_ChoiceItem *	pChoiceItem,
		const char *	szDisplayName )

Displayed name This is the name of the item as displayed in a PDF viewer.

Parameters

[in,out]	pChoiceItem	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[in]	szDisplayName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the owning choice field's document is read-only
• ePtx_Error_IllegalState if the owning choice field has widgets

PtxPdfForms_ChoiceItem_SetDisplayNameW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetDisplayNameW	(	TPtxPdfForms_ChoiceItem *	pChoiceItem,
		const WCHAR *	szDisplayName )

Displayed name This is the name of the item as displayed in a PDF viewer.

Parameters

[in,out]	pChoiceItem	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[in]	szDisplayName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the owning choice field's document is read-only
• ePtx_Error_IllegalState if the owning choice field has widgets

PtxPdfForms_ChoiceItem_SetExportNameA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetExportNameA	(	TPtxPdfForms_ChoiceItem *	pChoiceItem,
		const char *	szExportName )

Export name This is the name of the item used when exporting.

Parameters

[in,out]	pChoiceItem	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[in]	szExportName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the owning choice field's document is read-only

PtxPdfForms_ChoiceItem_SetExportNameW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetExportNameW	(	TPtxPdfForms_ChoiceItem *	pChoiceItem,
		const WCHAR *	szExportName )

Export name This is the name of the item used when exporting.

Parameters

[in,out]	pChoiceItem	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[in]	szExportName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the owning choice field's document is read-only

PtxPdfForms_ChoiceItemList_Add()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Add	(	TPtxPdfForms_ChoiceItemList *	pChoiceItemList,
		TPtxPdfForms_ChoiceItem *	pChoiceItem )

Add an element to the end of the list.

Parameters

[in,out]	pChoiceItemList	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItemList.
[in,out]	pChoiceItem

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_ChoiceItemList_Clear()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Clear

(

TPtxPdfForms_ChoiceItemList *

pChoiceItemList

)

Clear list.

Parameters

[in,out]

pChoiceItemList

Acts as a handle to the native object of type TPtxPdfForms_ChoiceItemList.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState

PtxPdfForms_ChoiceItemList_Get()

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Get	(	TPtxPdfForms_ChoiceItemList *	pChoiceItemList,
		int	iIndex )

Returns the element at the specified position in the given list.

Parameters

[in,out]	pChoiceItemList	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItemList.
[in]	iIndex

Returns

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_ChoiceItemList_GetCount()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_GetCount

(

TPtxPdfForms_ChoiceItemList *

pChoiceItemList

)

Get the number of elements in the list.

Parameters

[in,out]

pChoiceItemList

Acts as a handle to the native object of type TPtxPdfForms_ChoiceItemList.

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState

PtxPdfForms_ChoiceItemList_Remove()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Remove	(	TPtxPdfForms_ChoiceItemList *	pChoiceItemList,
		int	iIndex )

Remove certain element from list.

Parameters

[in,out]	pChoiceItemList	Acts as a handle to the native object of type TPtxPdfForms_ChoiceItemList.
[in]	iIndex

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_ComboBox_Create()

PDFTOOLBOX_EXPORT TPtxPdfForms_ComboBox *PDFTOOLBOX_CALL PtxPdfForms_ComboBox_Create

(

TPtxPdf_Document *

pTargetDocument

)

Create a combo box form field The returned form field object is not yet used, but it is associated with the given target document.

Parameters

[in,out]

pTargetDocument

the output document with which the returned object is associated

Returns

the newly created combo box field

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument the target document contains form fields that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetFormFields was set to ePtxPdfForms_FormFieldCopyStrategy_Copy
• ePtx_Error_IllegalArgument the target document contains unsigned signatures that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetUnsignedSignatures was set to ePtxPdf_CopyStrategy_Copy.

PtxPdfForms_ComboBox_GetCanEdit()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetCanEdit

(

TPtxPdfForms_ComboBox *

pComboBox

)

Has an editable item.

Parameters

[in,out]

pComboBox

Acts as a handle to the native object of type TPtxPdfForms_ComboBox.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_ComboBox_GetChosenItem()

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetChosenItem

(

TPtxPdfForms_ComboBox *

pComboBox

)

The selected combo box item If this property is NULL then the PtxPdfForms_ComboBox_GetEditableItemName is the selected value. Setting this property automatically sets PtxPdfForms_ComboBox_GetEditableItemName to NULL.

Parameters

[in,out]

pComboBox

Acts as a handle to the native object of type TPtxPdfForms_ComboBox.

Returns

Retrieved value.

NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when NULL was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the provided choice item object does not belong to the combo box field
• ePtx_Error_IllegalState if the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_ComboBox_GetEditableItemNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetEditableItemNameA	(	TPtxPdfForms_ComboBox *	pComboBox,
		char *	pBuffer,
		size_t	nBufferSize )

The name of the editable item This property is NULL if any of the combo box items is selected, i.e., if PtxPdfForms_ComboBox_GetChosenItem is not NULL. Setting this property automatically sets PtxPdfForms_ComboBox_GetChosenItem to NULL.

Parameters

[in,out]	pComboBox	Acts as a handle to the native object of type TPtxPdfForms_ComboBox.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has no editable item (PtxPdfForms_ComboBox_GetCanEdit property is FALSE)
• ePtx_Error_IllegalState if the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_ComboBox_GetEditableItemNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetEditableItemNameW	(	TPtxPdfForms_ComboBox *	pComboBox,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name of the editable item This property is NULL if any of the combo box items is selected, i.e., if PtxPdfForms_ComboBox_GetChosenItem is not NULL. Setting this property automatically sets PtxPdfForms_ComboBox_GetChosenItem to NULL.

Parameters

[in,out]	pComboBox	Acts as a handle to the native object of type TPtxPdfForms_ComboBox.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has no editable item (PtxPdfForms_ComboBox_GetCanEdit property is FALSE)
• ePtx_Error_IllegalState if the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_ComboBox_GetFontSize()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetFontSize	(	TPtxPdfForms_ComboBox *	pComboBox,
		double *	pFontSize )

The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.

Parameters

[in,out]	pComboBox	Acts as a handle to the native object of type TPtxPdfForms_ComboBox.
[out]	pFontSize	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the given value is smaller than 0.0

PtxPdfForms_ComboBox_SetCanEdit()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetCanEdit	(	TPtxPdfForms_ComboBox *	pComboBox,
		BOOL	bCanEdit )

Has an editable item.

Parameters

[in,out]	pComboBox	Acts as a handle to the native object of type TPtxPdfForms_ComboBox.
[in]	bCanEdit	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_ComboBox_SetChosenItem()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetChosenItem	(	TPtxPdfForms_ComboBox *	pComboBox,
		TPtxPdfForms_ChoiceItem *	pChosenItem )

The selected combo box item If this property is NULL then the PtxPdfForms_ComboBox_GetEditableItemName is the selected value. Setting this property automatically sets PtxPdfForms_ComboBox_GetEditableItemName to NULL.

Parameters

[in,out]	pComboBox	Acts as a handle to the native object of type TPtxPdfForms_ComboBox.
[in,out]	pChosenItem	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the provided choice item object does not belong to the combo box field
• ePtx_Error_IllegalState if the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_ComboBox_SetEditableItemNameA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetEditableItemNameA	(	TPtxPdfForms_ComboBox *	pComboBox,
		const char *	szEditableItemName )

The name of the editable item This property is NULL if any of the combo box items is selected, i.e., if PtxPdfForms_ComboBox_GetChosenItem is not NULL. Setting this property automatically sets PtxPdfForms_ComboBox_GetChosenItem to NULL.

Parameters

[in,out]	pComboBox	Acts as a handle to the native object of type TPtxPdfForms_ComboBox.
[in]	szEditableItemName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has no editable item (PtxPdfForms_ComboBox_GetCanEdit property is FALSE)
• ePtx_Error_IllegalState if the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_ComboBox_SetEditableItemNameW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetEditableItemNameW	(	TPtxPdfForms_ComboBox *	pComboBox,
		const WCHAR *	szEditableItemName )

The name of the editable item This property is NULL if any of the combo box items is selected, i.e., if PtxPdfForms_ComboBox_GetChosenItem is not NULL. Setting this property automatically sets PtxPdfForms_ComboBox_GetChosenItem to NULL.

Parameters

[in,out]	pComboBox	Acts as a handle to the native object of type TPtxPdfForms_ComboBox.
[in]	szEditableItemName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has no editable item (PtxPdfForms_ComboBox_GetCanEdit property is FALSE)
• ePtx_Error_IllegalState if the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_ComboBox_SetFontSize()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetFontSize	(	TPtxPdfForms_ComboBox *	pComboBox,
		const double *	pFontSize )

The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.

Parameters

[in,out]	pComboBox	Acts as a handle to the native object of type TPtxPdfForms_ComboBox.
[in]	pFontSize	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the given value is smaller than 0.0

PtxPdfForms_CombTextField_Create()

PDFTOOLBOX_EXPORT TPtxPdfForms_CombTextField *PDFTOOLBOX_CALL PtxPdfForms_CombTextField_Create	(	TPtxPdf_Document *	pTargetDocument,
		int	iMaxLength )

Create a comb text form field The returned form field object is not yet used, but it is associated with the given target document.

Parameters

[in,out]	pTargetDocument	the output document with which the returned object is associated
[in]	iMaxLength	the maximal character length for this field

Returns

the newly created comb text field

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument the target document contains form fields that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetFormFields was set to ePtxPdfForms_FormFieldCopyStrategy_Copy
• ePtx_Error_IllegalArgument the target document contains unsigned signatures that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetUnsignedSignatures was set to ePtxPdf_CopyStrategy_Copy.
• ePtx_Error_IllegalArgument if iMaxLength is smaller than 0

PtxPdfForms_CombTextField_GetMaxLength()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_CombTextField_GetMaxLength

(

TPtxPdfForms_CombTextField *

pCombTextField

)

The maximal text length When setting this property, the length of this field's text is truncated to the given value.

Parameters

[in,out]

pCombTextField

Acts as a handle to the native object of type TPtxPdfForms_CombTextField.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument if the given value is smaller than 0

PtxPdfForms_CombTextField_SetMaxLength()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_CombTextField_SetMaxLength	(	TPtxPdfForms_CombTextField *	pCombTextField,
		int	iMaxLength )

The maximal text length When setting this property, the length of this field's text is truncated to the given value.

Parameters

[in,out]	pCombTextField	Acts as a handle to the native object of type TPtxPdfForms_CombTextField.
[in]	iMaxLength	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument if the given value is smaller than 0

PtxPdfForms_DocMdpSignature_GetPermissions()

PDFTOOLBOX_EXPORT TPtxPdfForms_MdpPermissions PDFTOOLBOX_CALL PtxPdfForms_DocMdpSignature_GetPermissions

(

TPtxPdfForms_DocMdpSignature *

pDocMdpSignature

)

The access permissions granted for this document Note that for encrypted PDF documents, the restrictions defined by this DocMDPSignature are in addition to the document PtxPdf_Document_GetPermissions.

Parameters

[in,out]

pDocMdpSignature

Acts as a handle to the native object of type TPtxPdfForms_DocMdpSignature.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Field_AddNewWidget()

PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL PtxPdfForms_Field_AddNewWidget	(	TPtxPdfForms_Field *	pField,
		const TPtxGeomReal_Rectangle *	pBoundingBox )

Create a new widget and add to the form field This method creates a widget for the form field. The widget is automatically added to the field's widgets, but not to any page. This method does not work for radio button form fields; Use PtxPdfForms_RadioButton_AddNewWidget.

Parameters

[in,out]	pField	Acts as a handle to the native object of type TPtxPdfForms_Field.
[in]	pBoundingBox	The widget's target rectangle on the page

Returns

the newly created form field widget

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_UnsupportedOperation if the form field is of type TPtxPdfForms_RadioButtonGroup

PtxPdfForms_Field_GetDoNotExport()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetDoNotExport

(

TPtxPdfForms_Field *

pField

)

Tells whether this field is exported.

Parameters

[in,out]

pField

Acts as a handle to the native object of type TPtxPdfForms_Field.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_Field_GetReadOnly()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetReadOnly

(

TPtxPdfForms_Field *

pField

)

Flags this field as read-only.

Parameters

[in,out]

pField

Acts as a handle to the native object of type TPtxPdfForms_Field.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_Field_GetRequired()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetRequired

(

TPtxPdfForms_Field *

pField

)

Flags this field as mandatory.

Parameters

[in,out]

pField

Acts as a handle to the native object of type TPtxPdfForms_Field.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_Field_GetType()

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldType PDFTOOLBOX_CALL PtxPdfForms_Field_GetType

(

TPtxPdfForms_Field *

pField

)

Get actual derived type of base type TPtxPdfForms_Field.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out]

pField

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfForms_FieldType that refers to the actual derived type. 0 in case of an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

PtxPdfForms_Field_GetWidgets()

PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLBOX_CALL PtxPdfForms_Field_GetWidgets

(

TPtxPdfForms_Field *

pField

)

This form field's widget annotations.

Parameters

[in,out]

pField

Acts as a handle to the native object of type TPtxPdfForms_Field.

Returns

Retrieved value.

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Field_SetDoNotExport()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_SetDoNotExport	(	TPtxPdfForms_Field *	pField,
		BOOL	bDoNotExport )

Tells whether this field is exported.

Parameters

[in,out]	pField	Acts as a handle to the native object of type TPtxPdfForms_Field.
[in]	bDoNotExport	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_Field_SetReadOnly()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_SetReadOnly	(	TPtxPdfForms_Field *	pField,
		BOOL	bReadOnly )

Flags this field as read-only.

Parameters

[in,out]	pField	Acts as a handle to the native object of type TPtxPdfForms_Field.
[in]	bReadOnly	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_Field_SetRequired()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_SetRequired	(	TPtxPdfForms_Field *	pField,
		BOOL	bRequired )

Flags this field as mandatory.

Parameters

[in,out]	pField	Acts as a handle to the native object of type TPtxPdfForms_Field.
[in]	bRequired	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNode_Copy()

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL PtxPdfForms_FieldNode_Copy	(	TPtxPdf_Document *	pTargetDocument,
		TPtxPdfForms_FieldNode *	pFieldNode )

Copy a form field node Copy a form field node object from an input document to the given pTargetDocument. The returned object is associated with the given target document but not yet part of it.

Parameters

[in,out]	pTargetDocument	the output document with which the returned object is associated
[in,out]	pFieldNode	a form field of a different document

Returns

the copied form field, associated with the current document

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IO Error reading from the source document or writing to the target document
• ePtx_Error_Conformance The conformance level of the source document is not compatible with the conformance level of the target document.
• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument the pFieldNode object is not associated with an input document
• ePtx_Error_IllegalArgument the target document contains form fields that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetFormFields was set to ePtxPdfForms_FormFieldCopyStrategy_Copy
• ePtx_Error_IllegalArgument the target document contains unsigned signatures that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetUnsignedSignatures was set to ePtxPdf_CopyStrategy_Copy.
• ePtx_Error_IllegalArgument the document associated with the pFieldNode object has been closed

PtxPdfForms_FieldNode_GetDisplayNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetDisplayNameA	(	TPtxPdfForms_FieldNode *	pFieldNode,
		char *	pBuffer,
		size_t	nBufferSize )

User interface name The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.

Parameters

[in,out]	pFieldNode	Acts as a handle to the native object of type TPtxPdfForms_FieldNode.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNode_GetDisplayNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetDisplayNameW	(	TPtxPdfForms_FieldNode *	pFieldNode,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

User interface name The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.

Parameters

[in,out]	pFieldNode	Acts as a handle to the native object of type TPtxPdfForms_FieldNode.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNode_GetExportNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameA	(	TPtxPdfForms_FieldNode *	pFieldNode,
		char *	pBuffer,
		size_t	nBufferSize )

The name used when exporting.

Parameters

[in,out]	pFieldNode	Acts as a handle to the native object of type TPtxPdfForms_FieldNode.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNode_GetExportNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameW	(	TPtxPdfForms_FieldNode *	pFieldNode,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name used when exporting.

Parameters

[in,out]	pFieldNode	Acts as a handle to the native object of type TPtxPdfForms_FieldNode.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNode_GetType()

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeType PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetType

(

TPtxPdfForms_FieldNode *

pFieldNode

)

Get actual derived type of base type TPtxPdfForms_FieldNode.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out]

pFieldNode

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfForms_FieldNodeType that refers to the actual derived type. 0 in case of an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

PtxPdfForms_FieldNode_SetDisplayNameA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetDisplayNameA	(	TPtxPdfForms_FieldNode *	pFieldNode,
		const char *	szDisplayName )

User interface name The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.

Parameters

[in,out]	pFieldNode	Acts as a handle to the native object of type TPtxPdfForms_FieldNode.
[in]	szDisplayName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNode_SetDisplayNameW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetDisplayNameW	(	TPtxPdfForms_FieldNode *	pFieldNode,
		const WCHAR *	szDisplayName )

User interface name The display name is not directly visible, but a PDF viewer can display this name, e.g., in a tool tip.

Parameters

[in,out]	pFieldNode	Acts as a handle to the native object of type TPtxPdfForms_FieldNode.
[in]	szDisplayName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNode_SetExportNameA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameA	(	TPtxPdfForms_FieldNode *	pFieldNode,
		const char *	szExportName )

The name used when exporting.

Parameters

[in,out]	pFieldNode	Acts as a handle to the native object of type TPtxPdfForms_FieldNode.
[in]	szExportName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNode_SetExportNameW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameW	(	TPtxPdfForms_FieldNode *	pFieldNode,
		const WCHAR *	szExportName )

The name used when exporting.

Parameters

[in,out]	pFieldNode	Acts as a handle to the native object of type TPtxPdfForms_FieldNode.
[in]	szExportName	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_FieldNodeMap_GetA()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetA	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		const char *	szKey )

Get the position of a key in the map. If no error occurred, then the position can be used to get the corresponding value with PtxPdfForms_FieldNodeMap_GetValue.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	szKey

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_NotFound
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_GetBegin()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetBegin

(

TPtxPdfForms_FieldNodeMap *

pFieldNodeMap

)

Get the position of the first entry in the map.

The order of the entries is arbitrary and not significant.

If the returned position differs from PtxPdfForms_FieldNodeMap_GetEnd,then the position can be used to retrieve the map entry with PtxPdfForms_FieldNodeMap_GetKey, PtxPdfForms_FieldNodeMap_GetValue.

Use PtxPdfForms_FieldNodeMap_GetNext to get the position of the next entry.

Parameters

[in,out]

pFieldNodeMap

Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_GetCount()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetCount

(

TPtxPdfForms_FieldNodeMap *

pFieldNodeMap

)

The number of key-value pairs in the map.

Parameters

[in,out]

pFieldNodeMap

Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState

PtxPdfForms_FieldNodeMap_GetEnd()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetEnd

(

TPtxPdfForms_FieldNodeMap *

pFieldNodeMap

)

Get the end position of the map.

This position does not correspond to an actual entry in the map.

It must be used to determine whether the end of the map has been reached when using PtxPdfForms_FieldNodeMap_GetBegin and PtxPdfForms_FieldNodeMap_GetNext.

Parameters

[in,out]

pFieldNodeMap

Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_GetKeyA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetKeyA	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		int	it,
		char *	pBuffer,
		size_t	nBufferSize )

Get the key of the entry given a position.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	it
[out]	pBuffer	To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if there is an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_GetKeyW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetKeyW	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		int	it,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

Get the key of the entry given a position.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	it
[out]	pBuffer	To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if there is an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_GetNext()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetNext	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		int	it )

Get the position of the next entry in the map.

The order of the entries is arbitrary and not significant.

If the returned position differs from PtxPdfForms_FieldNodeMap_GetEnd, then the position can be used to retrieve the map entry with PtxPdfForms_FieldNodeMap_GetKey and PtxPdfForms_FieldNodeMap_GetValue.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	it

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_GetSize()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetSize

(

TPtxPdfForms_FieldNodeMap *

pFieldNodeMap

)

The number of key-value pairs in the map.

Parameters

[in,out]

pFieldNodeMap

Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState

Deprecated

Deprecated in Version 1.1.0.

PtxPdfForms_FieldNodeMap_GetValue()

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetValue	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		int	it )

Get the value of the entry given a position.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	it

Returns

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_GetW()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetW	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		const WCHAR *	szKey )

Get the position of a key in the map. If no error occurred, then the position can be used to get the corresponding value with PtxPdfForms_FieldNodeMap_GetValue.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	szKey

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_NotFound
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_LookupA()

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_LookupA	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		const char *	szIdentifierPath )

Access a form field by path Lookup the form field node given by the identifier path.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	szIdentifierPath	the identifier path in which sub forms must be delimited by full stops '.'

Returns

the resulting form field node.

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_NotFound if no form field with this identifier exists

PtxPdfForms_FieldNodeMap_LookupW()

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_LookupW	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		const WCHAR *	szIdentifierPath )

Access a form field by path Lookup the form field node given by the identifier path.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	szIdentifierPath	the identifier path in which sub forms must be delimited by full stops '.'

Returns

the resulting form field node.

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_NotFound if no form field with this identifier exists

PtxPdfForms_FieldNodeMap_SetA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetA	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		const char *	szKey,
		TPtxPdfForms_FieldNode *	pValue )

Set the value of an entry for a given key. This operation invalidates all positions previously returned by‹pre›_‹map›_GetBegin, PtxPdfForms_FieldNodeMap_GetEnd, PtxPdfForms_FieldNodeMap_GetNext, and PtxPdfForms_FieldNodeMap_Get.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	szKey
[in,out]	pValue

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_SetValue()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetValue	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		int	it,
		TPtxPdfForms_FieldNode *	pValue )

Set the value of the entry at a position in the map.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	it
[in,out]	pValue

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_FieldNodeMap_SetW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetW	(	TPtxPdfForms_FieldNodeMap *	pFieldNodeMap,
		const WCHAR *	szKey,
		TPtxPdfForms_FieldNode *	pValue )

Set the value of an entry for a given key. This operation invalidates all positions previously returned by‹pre›_‹map›_GetBegin, PtxPdfForms_FieldNodeMap_GetEnd, PtxPdfForms_FieldNodeMap_GetNext, and PtxPdfForms_FieldNodeMap_Get.

Parameters

[in,out]	pFieldNodeMap	Acts as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]	szKey
[in,out]	pValue

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_GeneralTextField_Create()

PDFTOOLBOX_EXPORT TPtxPdfForms_GeneralTextField *PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_Create

(

TPtxPdf_Document *

pTargetDocument

)

Create a general text form field The returned form field object is not yet used, but it is associated with the given target document.

Parameters

[in,out]

pTargetDocument

the output document with which the returned object is associated

Returns

the newly created general text field

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument the target document contains form fields that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetFormFields was set to ePtxPdfForms_FormFieldCopyStrategy_Copy
• ePtx_Error_IllegalArgument the target document contains unsigned signatures that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetUnsignedSignatures was set to ePtxPdf_CopyStrategy_Copy.

PtxPdfForms_GeneralTextField_GetDoNotScroll()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotScroll

(

TPtxPdfForms_GeneralTextField *

pGeneralTextField

)

Flags this text field non scrollable.

Parameters

[in,out]

pGeneralTextField

Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_GeneralTextField_GetDoNotSpellCheck()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotSpellCheck

(

TPtxPdfForms_GeneralTextField *

pGeneralTextField

)

Flags this text field for prevention from spell checking.

Parameters

[in,out]

pGeneralTextField

Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_GeneralTextField_GetMaxLength()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetMaxLength	(	TPtxPdfForms_GeneralTextField *	pGeneralTextField,
		int *	pMaxLength )

The maximal text length When setting this property to a non-null value, the length of this field's text is truncated.

Parameters

[in,out]	pGeneralTextField	Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[out]	pMaxLength	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument if the given value is not NULL and is smaller than 0

PtxPdfForms_GeneralTextField_GetMultiline()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetMultiline

(

TPtxPdfForms_GeneralTextField *

pGeneralTextField

)

Flags this text field as multi-line.

Parameters

[in,out]

pGeneralTextField

Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_GeneralTextField_GetPassword()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetPassword

(

TPtxPdfForms_GeneralTextField *

pGeneralTextField

)

Flags this text field as a password entry field.

Parameters

[in,out]

pGeneralTextField

Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_GeneralTextField_SetDoNotScroll()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotScroll	(	TPtxPdfForms_GeneralTextField *	pGeneralTextField,
		BOOL	bDoNotScroll )

Flags this text field non scrollable.

Parameters

[in,out]	pGeneralTextField	Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]	bDoNotScroll	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_GeneralTextField_SetDoNotSpellCheck()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotSpellCheck	(	TPtxPdfForms_GeneralTextField *	pGeneralTextField,
		BOOL	bDoNotSpellCheck )

Flags this text field for prevention from spell checking.

Parameters

[in,out]	pGeneralTextField	Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]	bDoNotSpellCheck	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_GeneralTextField_SetMaxLength()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetMaxLength	(	TPtxPdfForms_GeneralTextField *	pGeneralTextField,
		const int *	pMaxLength )

The maximal text length When setting this property to a non-null value, the length of this field's text is truncated.

Parameters

[in,out]	pGeneralTextField	Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]	pMaxLength	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument if the given value is not NULL and is smaller than 0

PtxPdfForms_GeneralTextField_SetMultiline()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetMultiline	(	TPtxPdfForms_GeneralTextField *	pGeneralTextField,
		BOOL	bMultiline )

Flags this text field as multi-line.

Parameters

[in,out]	pGeneralTextField	Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]	bMultiline	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_GeneralTextField_SetPassword()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetPassword	(	TPtxPdfForms_GeneralTextField *	pGeneralTextField,
		BOOL	bPassword )

Flags this text field as a password entry field.

Parameters

[in,out]	pGeneralTextField	Acts as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]	bPassword	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_ListBox_Create()

PDFTOOLBOX_EXPORT TPtxPdfForms_ListBox *PDFTOOLBOX_CALL PtxPdfForms_ListBox_Create

(

TPtxPdf_Document *

pTargetDocument

)

Create a list box form field The returned form field object is not yet used, but it is associated with the given target document.

Parameters

[in,out]

pTargetDocument

the output document with which the returned object is associated

Returns

the newly created list box field

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument the target document contains form fields that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetFormFields was set to ePtxPdfForms_FormFieldCopyStrategy_Copy
• ePtx_Error_IllegalArgument the target document contains unsigned signatures that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetUnsignedSignatures was set to ePtxPdf_CopyStrategy_Copy.

PtxPdfForms_ListBox_GetAllowMultiSelect()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_GetAllowMultiSelect

(

TPtxPdfForms_ListBox *

pListBox

)

Allow multiple items to be selected.

Parameters

[in,out]

pListBox

Acts as a handle to the native object of type TPtxPdfForms_ListBox.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_ListBox_GetChosenItems()

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLBOX_CALL PtxPdfForms_ListBox_GetChosenItems

(

TPtxPdfForms_ListBox *

pListBox

)

The selected choice items.

Adding to this list results in an error:

• IllegalState
  • if the list has already been closed
  • if the choice field is marked a read-only
  • if this list is not empty and the list box field is not marked as multi-select
  • if the choice field has widgets
• UnsupportedOperation if the document is read-only
• IllegalArgument
  • if the given choice item is NULL
  • if the given choice item has already been closed
  • if the given choice item is already present in this list
  • if the given choice item does not belong to the list box field's choice items

Removing items or clearing the list results in an IllegalState error if the form field is marked as read-only, or if it has widgets.

Parameters

[in,out]

pListBox

Acts as a handle to the native object of type TPtxPdfForms_ListBox.

Returns

Retrieved value.

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_ListBox_GetFontSize()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_GetFontSize	(	TPtxPdfForms_ListBox *	pListBox,
		double *	pFontSize )

The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.

Parameters

[in,out]	pListBox	Acts as a handle to the native object of type TPtxPdfForms_ListBox.
[out]	pFontSize	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the given value is smaller than 0.0

PtxPdfForms_ListBox_SetAllowMultiSelect()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_SetAllowMultiSelect	(	TPtxPdfForms_ListBox *	pListBox,
		BOOL	bAllowMultiSelect )

Allow multiple items to be selected.

Parameters

[in,out]	pListBox	Acts as a handle to the native object of type TPtxPdfForms_ListBox.
[in]	bAllowMultiSelect	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_ListBox_SetFontSize()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_SetFontSize	(	TPtxPdfForms_ListBox *	pListBox,
		const double *	pFontSize )

The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.

Parameters

[in,out]	pListBox	Acts as a handle to the native object of type TPtxPdfForms_ListBox.
[in]	pFontSize	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the given value is smaller than 0.0

PtxPdfForms_RadioButton_AddNewWidget()

PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL PtxPdfForms_RadioButton_AddNewWidget	(	TPtxPdfForms_RadioButton *	pRadioButton,
		const TPtxGeomReal_Rectangle *	pBoundingBox )

Create radio button widget This method creates a widget for the radio button. The widget is automatically added to the button's widgets and to the radio button form field's widgets, but not to any page.

Parameters

[in,out]	pRadioButton	Acts as a handle to the native object of type TPtxPdfForms_RadioButton.
[in]	pBoundingBox	The widget's target rectangle on the page

Returns

the newly created form field widget

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_RadioButton_GetExportNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameA	(	TPtxPdfForms_RadioButton *	pRadioButton,
		char *	pBuffer,
		size_t	nBufferSize )

The button's name used when exporting.

Parameters

[in,out]	pRadioButton	Acts as a handle to the native object of type TPtxPdfForms_RadioButton.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_RadioButton_GetExportNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameW	(	TPtxPdfForms_RadioButton *	pRadioButton,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The button's name used when exporting.

Parameters

[in,out]	pRadioButton	Acts as a handle to the native object of type TPtxPdfForms_RadioButton.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_RadioButton_GetWidgets()

PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLBOX_CALL PtxPdfForms_RadioButton_GetWidgets

(

TPtxPdfForms_RadioButton *

pRadioButton

)

The button's widget annotations.

Parameters

[in,out]

pRadioButton

Acts as a handle to the native object of type TPtxPdfForms_RadioButton.

Returns

Retrieved value.

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_RadioButtonGroup_AddNewButtonA()

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_AddNewButtonA	(	TPtxPdfForms_RadioButtonGroup *	pRadioButtonGroup,
		const char *	szExportName )

Create a radio button The created radio button is automatically added to this radio button field's PtxPdfForms_RadioButtonGroup_GetButtons.

Parameters

[in,out]	pRadioButtonGroup	Acts as a handle to the native object of type TPtxPdfForms_RadioButtonGroup.
[in]	szExportName	the radio button's export name

Returns

the newly created radio button

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_RadioButtonGroup_AddNewButtonW()

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_AddNewButtonW	(	TPtxPdfForms_RadioButtonGroup *	pRadioButtonGroup,
		const WCHAR *	szExportName )

Create a radio button The created radio button is automatically added to this radio button field's PtxPdfForms_RadioButtonGroup_GetButtons.

Parameters

[in,out]	pRadioButtonGroup	Acts as a handle to the native object of type TPtxPdfForms_RadioButtonGroup.
[in]	szExportName	the radio button's export name

Returns

the newly created radio button

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the document has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only

PtxPdfForms_RadioButtonGroup_Create()

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButtonGroup *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_Create

(

TPtxPdf_Document *

pTargetDocument

)

Create a radio button form field The returned form field object is not yet used, but it is associated with the given target document.

Parameters

[in,out]

pTargetDocument

the output document with which the returned object is associated

Returns

the newly created radio button field

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument the target document contains form fields that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetFormFields was set to ePtxPdfForms_FormFieldCopyStrategy_Copy
• ePtx_Error_IllegalArgument the target document contains unsigned signatures that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetUnsignedSignatures was set to ePtxPdf_CopyStrategy_Copy.

PtxPdfForms_RadioButtonGroup_GetButtons()

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButtonList *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetButtons

(

TPtxPdfForms_RadioButtonGroup *

pRadioButtonGroup

)

This field's buttons.

Parameters

[in,out]

pRadioButtonGroup

Acts as a handle to the native object of type TPtxPdfForms_RadioButtonGroup.

Returns

Retrieved value.

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_RadioButtonGroup_GetChosenButton()

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetChosenButton

(

TPtxPdfForms_RadioButtonGroup *

pRadioButtonGroup

)

This field's selected button if NULL is set, then no button is chosen.

Parameters

[in,out]

pRadioButtonGroup

Acts as a handle to the native object of type TPtxPdfForms_RadioButtonGroup.

Returns

Retrieved value.

NULL if either an error occurred or the returned object is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when NULL was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the provided radio button object does not belong to the radio button field
• ePtx_Error_IllegalState if the given TPtxPdfForms_RadioButton object is NULL and the radio button group does not support toggling to off
• ePtx_Error_IllegalState if the form field is marked as read-only

PtxPdfForms_RadioButtonGroup_SetChosenButton()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_SetChosenButton	(	TPtxPdfForms_RadioButtonGroup *	pRadioButtonGroup,
		TPtxPdfForms_RadioButton *	pChosenButton )

This field's selected button if NULL is set, then no button is chosen.

Parameters

[in,out]	pRadioButtonGroup	Acts as a handle to the native object of type TPtxPdfForms_RadioButtonGroup.
[in,out]	pChosenButton	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalArgument if the provided radio button object does not belong to the radio button field
• ePtx_Error_IllegalState if the given TPtxPdfForms_RadioButton object is NULL and the radio button group does not support toggling to off
• ePtx_Error_IllegalState if the form field is marked as read-only

PtxPdfForms_RadioButtonList_Get()

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonList_Get	(	TPtxPdfForms_RadioButtonList *	pRadioButtonList,
		int	iIndex )

Returns the element at the specified position in the given list.

Parameters

[in,out]	pRadioButtonList	Acts as a handle to the native object of type TPtxPdfForms_RadioButtonList.
[in]	iIndex

Returns

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_RadioButtonList_GetCount()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_RadioButtonList_GetCount

(

TPtxPdfForms_RadioButtonList *

pRadioButtonList

)

Get the number of elements in the list.

Parameters

[in,out]

pRadioButtonList

Acts as a handle to the native object of type TPtxPdfForms_RadioButtonList.

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState

PtxPdfForms_Signature_GetContactInfoA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetContactInfoA	(	TPtxPdfForms_Signature *	pSignature,
		char *	pBuffer,
		size_t	nBufferSize )

The contact information of the signer Information provided by the signer to enable a recipient to contact the signer to verify the signature; for example, a phone number.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPtxPdfForms_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Signature_GetContactInfoW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetContactInfoW	(	TPtxPdfForms_Signature *	pSignature,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The contact information of the signer Information provided by the signer to enable a recipient to contact the signer to verify the signature; for example, a phone number.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPtxPdfForms_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Signature_GetLocationA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetLocationA	(	TPtxPdfForms_Signature *	pSignature,
		char *	pBuffer,
		size_t	nBufferSize )

The location of signing The CPU host name or physical location of the signing.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPtxPdfForms_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Signature_GetLocationW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetLocationW	(	TPtxPdfForms_Signature *	pSignature,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The location of signing The CPU host name or physical location of the signing.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPtxPdfForms_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Signature_GetReasonA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetReasonA	(	TPtxPdfForms_Signature *	pSignature,
		char *	pBuffer,
		size_t	nBufferSize )

The reason for signing.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPtxPdfForms_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Signature_GetReasonW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetReasonW	(	TPtxPdfForms_Signature *	pSignature,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The reason for signing.

Parameters

[in,out]	pSignature	Acts as a handle to the native object of type TPtxPdfForms_Signature.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Signature_GetType()

PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureType PDFTOOLBOX_CALL PtxPdfForms_Signature_GetType

(

TPtxPdfForms_Signature *

pSignature

)

Get actual derived type of base type TPtxPdfForms_Signature.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out]

pSignature

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfForms_SignatureType that refers to the actual derived type. 0 in case of an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

PtxPdfForms_SignatureField_GetType()

PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureFieldType PDFTOOLBOX_CALL PtxPdfForms_SignatureField_GetType

(

TPtxPdfForms_SignatureField *

pSignatureField

)

Get actual derived type of base type TPtxPdfForms_SignatureField.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out]

pSignatureField

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfForms_SignatureFieldType that refers to the actual derived type. 0 in case of an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

PtxPdfForms_SignatureField_IsVisible()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_SignatureField_IsVisible

(

TPtxPdfForms_SignatureField *

pSignatureField

)

The visibility of the signature field If TRUE, the signature field has a visual appearance on the page.

Parameters

[in,out]

pSignatureField

Acts as a handle to the native object of type TPtxPdfForms_SignatureField.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_SignatureFieldList_Get()

PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureField *PDFTOOLBOX_CALL PtxPdfForms_SignatureFieldList_Get	(	TPtxPdfForms_SignatureFieldList *	pSignatureFieldList,
		int	iIndex )

Returns the element at the specified position in the given list.

Parameters

[in,out]	pSignatureFieldList	Acts as a handle to the native object of type TPtxPdfForms_SignatureFieldList.
[in]	iIndex

Returns

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_SignatureFieldList_GetCount()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_SignatureFieldList_GetCount

(

TPtxPdfForms_SignatureFieldList *

pSignatureFieldList

)

Get the number of elements in the list.

Parameters

[in,out]

pSignatureFieldList

Acts as a handle to the native object of type TPtxPdfForms_SignatureFieldList.

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState

PtxPdfForms_SignedSignatureField_GetDate()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetDate	(	TPtxPdfForms_SignedSignatureField *	pSignedSignatureField,
		TPtxSys_Date *	pDate )

The date and time of signing.

This represents the date and time of signing as specified in the signature. For signatures that contain a time-stamp, the trusted time-stamp time is returned.

Note: The value can only be extracted for signatures conforming to the PAdES or PDF standard and not for proprietary/non-standard signature formats. For non-standard signature formats the date as stored in the PDF is returned.

Parameters

[in,out]	pSignedSignatureField	Acts as a handle to the native object of type TPtxPdfForms_SignedSignatureField.
[out]	pDate	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_SignedSignatureField_GetNameA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetNameA	(	TPtxPdfForms_SignedSignatureField *	pSignedSignatureField,
		char *	pBuffer,
		size_t	nBufferSize )

The name of the person or authority that signed the document.

This is the name of the signing certificate.

Note: The name of the signing certificate can only be extracted for signatures conforming to the PAdES or PDF standard and not for proprietary/non-standard signature formats. For non-standard signature formats the name as stored in the PDF is returned.

Parameters

[in,out]	pSignedSignatureField	Acts as a handle to the native object of type TPtxPdfForms_SignedSignatureField.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_SignedSignatureField_GetNameW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetNameW	(	TPtxPdfForms_SignedSignatureField *	pSignedSignatureField,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

The name of the person or authority that signed the document.

This is the name of the signing certificate.

Note: The name of the signing certificate can only be extracted for signatures conforming to the PAdES or PDF standard and not for proprietary/non-standard signature formats. For non-standard signature formats the name as stored in the PDF is returned.

Parameters

[in,out]	pSignedSignatureField	Acts as a handle to the native object of type TPtxPdfForms_SignedSignatureField.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_SignedSignatureField_GetType()

PDFTOOLBOX_EXPORT TPtxPdfForms_SignedSignatureFieldType PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetType

(

TPtxPdfForms_SignedSignatureField *

pSignedSignatureField

)

Get actual derived type of base type TPtxPdfForms_SignedSignatureField.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out]

pSignedSignatureField

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfForms_SignedSignatureFieldType that refers to the actual derived type. 0 in case of an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

PtxPdfForms_SubForm_Create()

PDFTOOLBOX_EXPORT TPtxPdfForms_SubForm *PDFTOOLBOX_CALL PtxPdfForms_SubForm_Create

(

TPtxPdf_Document *

pTargetDocument

)

Create a sub form The returned sub form object is not yet used, but it is associated with the given target document.

Parameters

[in,out]

pTargetDocument

the output document with which the returned object is associated

Returns

the newly created sub form

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalArgument if the pTargetDocument argument has already been closed
• ePtx_Error_IllegalArgument if the pTargetDocument argument is read-only
• ePtx_Error_IllegalArgument the target document contains form fields that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetFormFields was set to ePtxPdfForms_FormFieldCopyStrategy_Copy
• ePtx_Error_IllegalArgument the target document contains unsigned signatures that have been implicitly copied by a call to PtxPdf_Page_Copy with an argument pOptions in which PtxPdf_PageCopyOptions_SetUnsignedSignatures was set to ePtxPdf_CopyStrategy_Copy.

PtxPdfForms_SubForm_GetChildren()

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeMap *PDFTOOLBOX_CALL PtxPdfForms_SubForm_GetChildren

(

TPtxPdfForms_SubForm *

pSubForm

)

The child form fields Adding to this list results in an error:

• IllegalState if the list has already been closed
• UnsupportedOperation if the document is read-only
• IllegalArgument
  • if the given form field node is NULL
  • if the given form field node has already been closed
  • if the given form field node does not belong to the same document as the list
  • if the given form field node has already been added to a form field node list
  • if the given form field node's identifier equals an identifier of one of the form field nodes in this list This list does not support removing or setting elements or clearing.

Parameters

[in,out]

pSubForm

Acts as a handle to the native object of type TPtxPdfForms_SubForm.

Returns

Retrieved value.

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_TextField_GetAlignment()

PDFTOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLBOX_CALL PtxPdfForms_TextField_GetAlignment

(

TPtxPdfForms_TextField *

pTextField

)

The text alignment.

Parameters

[in,out]

pTextField

Acts as a handle to the native object of type TPtxPdfForms_TextField.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_TextField_GetFontSize()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_GetFontSize	(	TPtxPdfForms_TextField *	pTextField,
		double *	pFontSize )

The font size If NULL then the font size is chosen automatically by the PDF viewer.

Parameters

[in,out]	pTextField	Acts as a handle to the native object of type TPtxPdfForms_TextField.
[out]	pFontSize	Retrieved value.

Returns

FALSE if either an error occurred or the [out] argument returns NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument if the given value is smaller than 0.0

PtxPdfForms_TextField_GetTextA()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_TextField_GetTextA	(	TPtxPdfForms_TextField *	pTextField,
		char *	pBuffer,
		size_t	nBufferSize )

This field's text.

Parameters

[in,out]	pTextField	Acts as a handle to the native object of type TPtxPdfForms_TextField.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument the string length of the given value exceeds the text field's PtxPdfForms_GeneralTextField_GetMaxLength

PtxPdfForms_TextField_GetTextW()

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_TextField_GetTextW	(	TPtxPdfForms_TextField *	pTextField,
		WCHAR *	pBuffer,
		size_t	nBufferSize )

This field's text.

Parameters

[in,out]	pTextField	Acts as a handle to the native object of type TPtxPdfForms_TextField.
[out]	pBuffer	Retrieved value. To determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]	nBufferSize	The buffer size of the retrieved string pBuffer.

Returns

The amount of data written to the buffer pBuffer. 0 if either an error occurred or the returned buffer is actually NULL. To determine if an error has occurred, check the error code as described in the note section below.

Note

An error occurred when 0 was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument the string length of the given value exceeds the text field's PtxPdfForms_GeneralTextField_GetMaxLength

PtxPdfForms_TextField_GetType()

PDFTOOLBOX_EXPORT TPtxPdfForms_TextFieldType PDFTOOLBOX_CALL PtxPdfForms_TextField_GetType

(

TPtxPdfForms_TextField *

pTextField

)

Get actual derived type of base type TPtxPdfForms_TextField.

This function is invoked prior to downcasting to ascertain the derived object type.

Parameters

[in,out]

pTextField

Acts as a handle to a native object.

Returns

The item of the enumeration TPtxPdfForms_TextFieldType that refers to the actual derived type. 0 in case of an error.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage.

PtxPdfForms_TextField_SetAlignment()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetAlignment	(	TPtxPdfForms_TextField *	pTextField,
		TPtxGeom_HorizontalAlignment	iAlignment )

The text alignment.

Parameters

[in,out]	pTextField	Acts as a handle to the native object of type TPtxPdfForms_TextField.
[in]	iAlignment	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets

PtxPdfForms_TextField_SetFontSize()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetFontSize	(	TPtxPdfForms_TextField *	pTextField,
		const double *	pFontSize )

The font size If NULL then the font size is chosen automatically by the PDF viewer.

Parameters

[in,out]	pTextField	Acts as a handle to the native object of type TPtxPdfForms_TextField.
[in]	pFontSize	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument if the given value is smaller than 0.0

PtxPdfForms_TextField_SetTextA()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetTextA	(	TPtxPdfForms_TextField *	pTextField,
		const char *	szText )

This field's text.

Parameters

[in,out]	pTextField	Acts as a handle to the native object of type TPtxPdfForms_TextField.
[in]	szText	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument the string length of the given value exceeds the text field's PtxPdfForms_GeneralTextField_GetMaxLength

PtxPdfForms_TextField_SetTextW()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetTextW	(	TPtxPdfForms_TextField *	pTextField,
		const WCHAR *	szText )

This field's text.

Parameters

[in,out]	pTextField	Acts as a handle to the native object of type TPtxPdfForms_TextField.
[in]	szText	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_UnsupportedOperation if the document is read-only
• ePtx_Error_IllegalState the form field is marked as read-only
• ePtx_Error_IllegalState if the form field has widgets
• ePtx_Error_IllegalArgument the string length of the given value exceeds the text field's PtxPdfForms_GeneralTextField_GetMaxLength

PtxPdfForms_Widget_GetBoundingBox()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetBoundingBox	(	TPtxPdfForms_Widget *	pWidget,
		TPtxGeomReal_Rectangle *	pBoundingBox )

The location on the page.

Parameters

[in,out]	pWidget	Acts as a handle to the native object of type TPtxPdfForms_Widget.
[out]	pBoundingBox	Retrieved value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed
• ePtx_Error_Corrupt if the PDF is corrupt

PtxPdfForms_Widget_GetHidden()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetHidden

(

TPtxPdfForms_Widget *

pWidget

)

The widget's visibility If TRUE then the widget is present, but is invisible and not available for user interaction. Depending on the PtxPdfForms_Widget_GetNoPrint property it will, however, still be visible when printing.

Parameters

[in,out]

pWidget

Acts as a handle to the native object of type TPtxPdfForms_Widget.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Widget_GetLocked()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetLocked

(

TPtxPdfForms_Widget *

pWidget

)

Whether the widget can be modified This does not restrict modification of the widget's content.

Parameters

[in,out]

pWidget

Acts as a handle to the native object of type TPtxPdfForms_Widget.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Widget_GetNoPrint()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetNoPrint

(

TPtxPdfForms_Widget *

pWidget

)

The widget's visibility when printing If TRUE then the widget is not present in a print output of the document.

Parameters

[in,out]

pWidget

Acts as a handle to the native object of type TPtxPdfForms_Widget.

Returns

Retrieved value.

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Widget_SetHidden()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_SetHidden	(	TPtxPdfForms_Widget *	pWidget,
		BOOL	bHidden )

The widget's visibility If TRUE then the widget is present, but is invisible and not available for user interaction. Depending on the PtxPdfForms_Widget_GetNoPrint property it will, however, still be visible when printing.

Parameters

[in,out]	pWidget	Acts as a handle to the native object of type TPtxPdfForms_Widget.
[in]	bHidden	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_Widget_SetLocked()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_SetLocked	(	TPtxPdfForms_Widget *	pWidget,
		BOOL	bLocked )

Whether the widget can be modified This does not restrict modification of the widget's content.

Parameters

[in,out]	pWidget	Acts as a handle to the native object of type TPtxPdfForms_Widget.
[in]	bLocked	Set value.

Returns

TRUE if the operation is successful; FALSE if there is an error.

Note

An error occurred when FALSE was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState if the object has already been closed

PtxPdfForms_WidgetList_Add()

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_WidgetList_Add	(	TPtxPdfForms_WidgetList *	pWidgetList,
		TPtxPdfForms_Widget *	pWidget )

Add an element to the end of the list.

Parameters

[in,out]	pWidgetList	Acts as a handle to the native object of type TPtxPdfForms_WidgetList.
[in,out]	pWidget

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when FALSE was returned and the error code returned by Ptx_GetLastError is different from ePtx_Error_Success. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_WidgetList_Get()

PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL PtxPdfForms_WidgetList_Get	(	TPtxPdfForms_WidgetList *	pWidgetList,
		int	iIndex )

Returns the element at the specified position in the given list.

Parameters

[in,out]	pWidgetList	Acts as a handle to the native object of type TPtxPdfForms_WidgetList.
[in]	iIndex

Returns

NULL if there is an error.

Note

An error occurred when NULL was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState
• ePtx_Error_IllegalArgument
• ePtx_Error_UnsupportedOperation

PtxPdfForms_WidgetList_GetCount()

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_WidgetList_GetCount

(

TPtxPdfForms_WidgetList *

pWidgetList

)

Get the number of elements in the list.

Parameters

[in,out]

pWidgetList

Acts as a handle to the native object of type TPtxPdfForms_WidgetList.

Returns

May indicate an error in certain scenarios. For further information see the note section below.

Note

An error occurred when 0 was returned. Retrieve specific error code by calling Ptx_GetLastError. Get the error message with Ptx_GetLastErrorMessage. Possible error codes:

• ePtx_Error_IllegalState