PDF Toolbox
Loading...
Searching...
No Matches
Macros | Functions
PdfTools_Toolbox_PtxPdfForms.h File Reference
#include "PdfTools_Toolbox_Types.h"
#include "PdfTools_Toolbox_PtxSys.h"

Go to the source code of this file.

Macros

#define PDFTOOLS_TOOLBOX_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

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetCount (TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
 The number of key-value pairs in the map.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetSize (TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
 The number of key-value pairs in the map.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetBegin (TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
 Get the position of the first entry in the map.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetEnd (TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
 Get the end position of the map.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetNext (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it)
 Get the position of the next entry in the map.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetKeyA (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, char *pBuffer, size_t nBufferSize)
 Get the key of the entry given a position.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetKeyW (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, WCHAR *pBuffer, size_t nBufferSize)
 Get the key of the entry given a position.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetValue (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it)
 Get the value of the entry given a position.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetValue (TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, TPtxPdfForms_FieldNode *pValue)
 Set the value of the entry at a position in the map.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_WidgetList_GetCount (TPtxPdfForms_WidgetList *pWidgetList)
 Get the number of elements in the list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_WidgetList_Get (TPtxPdfForms_WidgetList *pWidgetList, int iIndex)
 Returns the element at the specified position in the given list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_WidgetList_Add (TPtxPdfForms_WidgetList *pWidgetList, TPtxPdfForms_Widget *pWidget)
 Add an element to the end of the list.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignatureFieldList_GetCount (TPtxPdfForms_SignatureFieldList *pSignatureFieldList)
 Get the number of elements in the list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SignatureField *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignatureFieldList_Get (TPtxPdfForms_SignatureFieldList *pSignatureFieldList, int iIndex)
 Returns the element at the specified position in the given list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Widget_GetBoundingBox (TPtxPdfForms_Widget *pWidget, TPtxGeomReal_Rectangle *pBoundingBox)
 The location on the page.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameA (TPtxPdfForms_FieldNode *pFieldNode, char *pBuffer, size_t nBufferSize)
 The name used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameW (TPtxPdfForms_FieldNode *pFieldNode, WCHAR *pBuffer, size_t nBufferSize)
 The name used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameA (TPtxPdfForms_FieldNode *pFieldNode, const char *szExportName)
 The name used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameW (TPtxPdfForms_FieldNode *pFieldNode, const WCHAR *szExportName)
 The name used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNodeType PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_GetType (TPtxPdfForms_FieldNode *pFieldNode)
 Get actual derived type of base type TPtxPdfForms_FieldNode.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SubForm *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNodeMap *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SubForm_GetChildren (TPtxPdfForms_SubForm *pSubForm)
 The child form fields Adding to this list results in an error:
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetWidgets (TPtxPdfForms_Field *pField)
 This form field's widget annotations.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetReadOnly (TPtxPdfForms_Field *pField)
 Flags this field as read-only.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_SetReadOnly (TPtxPdfForms_Field *pField, BOOL bReadOnly)
 Flags this field as read-only.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetRequired (TPtxPdfForms_Field *pField)
 Flags this field as mandatory.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_SetRequired (TPtxPdfForms_Field *pField, BOOL bRequired)
 Flags this field as mandatory.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetDoNotExport (TPtxPdfForms_Field *pField)
 Tells whether this field is exported.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_SetDoNotExport (TPtxPdfForms_Field *pField, BOOL bDoNotExport)
 Tells whether this field is exported.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldType PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetType (TPtxPdfForms_Field *pField)
 Get actual derived type of base type TPtxPdfForms_Field.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_GetTextA (TPtxPdfForms_TextField *pTextField, char *pBuffer, size_t nBufferSize)
 This field's text.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_GetTextW (TPtxPdfForms_TextField *pTextField, WCHAR *pBuffer, size_t nBufferSize)
 This field's text.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_SetTextA (TPtxPdfForms_TextField *pTextField, const char *szText)
 This field's text.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_SetTextW (TPtxPdfForms_TextField *pTextField, const WCHAR *szText)
 This field's text.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_GetAlignment (TPtxPdfForms_TextField *pTextField)
 The text alignment.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_SetAlignment (TPtxPdfForms_TextField *pTextField, TPtxGeom_HorizontalAlignment iAlignment)
 The text alignment.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_TextFieldType PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_GetType (TPtxPdfForms_TextField *pTextField)
 Get actual derived type of base type TPtxPdfForms_TextField.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_GeneralTextField *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetMultiline (TPtxPdfForms_GeneralTextField *pGeneralTextField)
 Flags this text field as multi-line.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetMultiline (TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bMultiline)
 Flags this text field as multi-line.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetPassword (TPtxPdfForms_GeneralTextField *pGeneralTextField)
 Flags this text field as a password entry field.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetPassword (TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bPassword)
 Flags this text field as a password entry field.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotSpellCheck (TPtxPdfForms_GeneralTextField *pGeneralTextField)
 Flags this text field for prevention from spell checking.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotSpellCheck (TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bDoNotSpellCheck)
 Flags this text field for prevention from spell checking.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotScroll (TPtxPdfForms_GeneralTextField *pGeneralTextField)
 Flags this text field non scrollable.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotScroll (TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bDoNotScroll)
 Flags this text field non scrollable.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_CombTextField *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_CheckBox *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_CheckBox_GetCheckedExportNameA (TPtxPdfForms_CheckBox *pCheckBox, char *pBuffer, size_t nBufferSize)
 The name of the checked ('on') state used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_CheckBox_GetCheckedExportNameW (TPtxPdfForms_CheckBox *pCheckBox, WCHAR *pBuffer, size_t nBufferSize)
 The name of the checked ('on') state used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_CheckBox_GetChecked (TPtxPdfForms_CheckBox *pCheckBox)
 The state of the check box.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_CheckBox_SetChecked (TPtxPdfForms_CheckBox *pCheckBox, BOOL bChecked)
 The state of the check box.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameA (TPtxPdfForms_RadioButton *pRadioButton, char *pBuffer, size_t nBufferSize)
 The button's name used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameW (TPtxPdfForms_RadioButton *pRadioButton, WCHAR *pBuffer, size_t nBufferSize)
 The button's name used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButton_GetWidgets (TPtxPdfForms_RadioButton *pRadioButton)
 The button's widget annotations.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonList_GetCount (TPtxPdfForms_RadioButtonList *pRadioButtonList)
 Get the number of elements in the list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonList_Get (TPtxPdfForms_RadioButtonList *pRadioButtonList, int iIndex)
 Returns the element at the specified position in the given list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButtonGroup *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButtonList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetButtons (TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup)
 This field's buttons.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetChosenButton (TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup)
 This field's selected button if NULL is set, then no button is chosen.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonGroup_SetChosenButton (TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup, TPtxPdfForms_RadioButton *pChosenButton)
 This field's selected button if NULL is set, then no button is chosen.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItem_GetExportNameA (TPtxPdfForms_ChoiceItem *pChoiceItem, char *pBuffer, size_t nBufferSize)
 Export name This is the name of the item used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItem_GetExportNameW (TPtxPdfForms_ChoiceItem *pChoiceItem, WCHAR *pBuffer, size_t nBufferSize)
 Export name This is the name of the item used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItem_SetExportNameA (TPtxPdfForms_ChoiceItem *pChoiceItem, const char *szExportName)
 Export name This is the name of the item used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItem_SetExportNameW (TPtxPdfForms_ChoiceItem *pChoiceItem, const WCHAR *szExportName)
 Export name This is the name of the item used when exporting.
 
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_GetCount (TPtxPdfForms_ChoiceItemList *pChoiceItemList)
 Get the number of elements in the list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Get (TPtxPdfForms_ChoiceItemList *pChoiceItemList, int iIndex)
 Returns the element at the specified position in the given list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Add (TPtxPdfForms_ChoiceItemList *pChoiceItemList, TPtxPdfForms_ChoiceItem *pChoiceItem)
 Add an element to the end of the list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Clear (TPtxPdfForms_ChoiceItemList *pChoiceItemList)
 Clear list.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Remove (TPtxPdfForms_ChoiceItemList *pChoiceItemList, int iIndex)
 Remove certain element from list.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceField_AddNewItemA (TPtxPdfForms_ChoiceField *pChoiceField, const char *szDisplayName)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceField_AddNewItemW (TPtxPdfForms_ChoiceField *pChoiceField, const WCHAR *szDisplayName)
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceField_GetItems (TPtxPdfForms_ChoiceField *pChoiceField)
 The list of choice items Adding or removing items or clearing the list is not supported.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceFieldType PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceField_GetType (TPtxPdfForms_ChoiceField *pChoiceField)
 Get actual derived type of base type TPtxPdfForms_ChoiceField.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ListBox *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ListBox_GetAllowMultiSelect (TPtxPdfForms_ListBox *pListBox)
 Allow multiple items to be selected.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ListBox_SetAllowMultiSelect (TPtxPdfForms_ListBox *pListBox, BOOL bAllowMultiSelect)
 Allow multiple items to be selected.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ListBox_GetChosenItems (TPtxPdfForms_ListBox *pListBox)
 The selected choice items.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ComboBox *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ComboBox_GetCanEdit (TPtxPdfForms_ComboBox *pComboBox)
 Has an editable item.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ComboBox_SetCanEdit (TPtxPdfForms_ComboBox *pComboBox, BOOL bCanEdit)
 Has an editable item.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SignatureFieldType PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignatureField_GetType (TPtxPdfForms_SignatureField *pSignatureField)
 Get actual derived type of base type TPtxPdfForms_SignatureField.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetNameA (TPtxPdfForms_SignedSignatureField *pSignedSignatureField, char *pBuffer, size_t nBufferSize)
 The name of the person or authority that signed the document.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetNameW (TPtxPdfForms_SignedSignatureField *pSignedSignatureField, WCHAR *pBuffer, size_t nBufferSize)
 The name of the person or authority that signed the document.
 
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetDate (TPtxPdfForms_SignedSignatureField *pSignedSignatureField, TPtxSys_Date *pDate)
 The date and time of signing.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SignedSignatureFieldType PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetType (TPtxPdfForms_SignedSignatureField *pSignedSignatureField)
 Get actual derived type of base type TPtxPdfForms_SignedSignatureField.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Signature_GetReasonA (TPtxPdfForms_Signature *pSignature, char *pBuffer, size_t nBufferSize)
 The reason for signing.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Signature_GetReasonW (TPtxPdfForms_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
 The reason for signing.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SignatureType PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Signature_GetType (TPtxPdfForms_Signature *pSignature)
 Get actual derived type of base type TPtxPdfForms_Signature.
 
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_MdpPermissions PDFTOOLS_TOOLBOX_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

◆ PDFTOOLS_TOOLBOX_CALL

#define PDFTOOLS_TOOLBOX_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()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_CheckBox *PDFTOOLS_TOOLBOX_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]pTargetDocumentthe 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:

◆ PtxPdfForms_CheckBox_GetChecked()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_CheckBox_GetChecked ( TPtxPdfForms_CheckBox * pCheckBox)

The state of the check box.

Parameters
[in,out]pCheckBoxActs 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:

◆ PtxPdfForms_CheckBox_GetCheckedExportNameA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pCheckBoxActs as a handle to the native object of type TPtxPdfForms_CheckBox.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_CheckBox_GetCheckedExportNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pCheckBoxActs as a handle to the native object of type TPtxPdfForms_CheckBox.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_CheckBox_SetChecked()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_CheckBox_SetChecked ( TPtxPdfForms_CheckBox * pCheckBox,
BOOL bChecked )

The state of the check box.

Parameters
[in,out]pCheckBoxActs as a handle to the native object of type TPtxPdfForms_CheckBox.
[in]bCheckedSet 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:

◆ PtxPdfForms_ChoiceField_AddNewItemA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_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]pChoiceFieldActs as a handle to the native object of type TPtxPdfForms_ChoiceField.
[in]szDisplayNamethis 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:

◆ PtxPdfForms_ChoiceField_AddNewItemW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_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]pChoiceFieldActs as a handle to the native object of type TPtxPdfForms_ChoiceField.
[in]szDisplayNamethis 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:

◆ PtxPdfForms_ChoiceField_GetItems()

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

Parameters
[in,out]pChoiceFieldActs 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:

◆ PtxPdfForms_ChoiceField_GetType()

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]pChoiceFieldActs 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()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pChoiceItemActs as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_ChoiceItem_GetDisplayNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pChoiceItemActs as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_ChoiceItem_GetExportNameA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pChoiceItemActs as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_ChoiceItem_GetExportNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pChoiceItemActs as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_ChoiceItem_SetDisplayNameA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pChoiceItemActs as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[in]szDisplayNameSet 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:

◆ PtxPdfForms_ChoiceItem_SetDisplayNameW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pChoiceItemActs as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[in]szDisplayNameSet 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:

◆ PtxPdfForms_ChoiceItem_SetExportNameA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pChoiceItemActs as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[in]szExportNameSet 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:

◆ PtxPdfForms_ChoiceItem_SetExportNameW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pChoiceItemActs as a handle to the native object of type TPtxPdfForms_ChoiceItem.
[in]szExportNameSet 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:

◆ PtxPdfForms_ChoiceItemList_Add()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Add ( TPtxPdfForms_ChoiceItemList * pChoiceItemList,
TPtxPdfForms_ChoiceItem * pChoiceItem )

Add an element to the end of the list.

Parameters
[in,out]pChoiceItemListActs 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:

◆ PtxPdfForms_ChoiceItemList_Clear()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Clear ( TPtxPdfForms_ChoiceItemList * pChoiceItemList)

Clear list.

Parameters
[in,out]pChoiceItemListActs 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:

◆ PtxPdfForms_ChoiceItemList_Get()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Get ( TPtxPdfForms_ChoiceItemList * pChoiceItemList,
int iIndex )

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

Parameters
[in,out]pChoiceItemListActs 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:

◆ PtxPdfForms_ChoiceItemList_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_GetCount ( TPtxPdfForms_ChoiceItemList * pChoiceItemList)

Get the number of elements in the list.

Parameters
[in,out]pChoiceItemListActs 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:

◆ PtxPdfForms_ChoiceItemList_Remove()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Remove ( TPtxPdfForms_ChoiceItemList * pChoiceItemList,
int iIndex )

Remove certain element from list.

Parameters
[in,out]pChoiceItemListActs 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:

◆ PtxPdfForms_ComboBox_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ComboBox *PDFTOOLS_TOOLBOX_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]pTargetDocumentthe 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:

◆ PtxPdfForms_ComboBox_GetCanEdit()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ComboBox_GetCanEdit ( TPtxPdfForms_ComboBox * pComboBox)

Has an editable item.

Parameters
[in,out]pComboBoxActs 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:

◆ PtxPdfForms_ComboBox_GetChosenItem()

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]pComboBoxActs 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:

◆ PtxPdfForms_ComboBox_GetEditableItemNameA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pComboBoxActs as a handle to the native object of type TPtxPdfForms_ComboBox.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_ComboBox_GetEditableItemNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pComboBoxActs as a handle to the native object of type TPtxPdfForms_ComboBox.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_ComboBox_SetCanEdit()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ComboBox_SetCanEdit ( TPtxPdfForms_ComboBox * pComboBox,
BOOL bCanEdit )

Has an editable item.

Parameters
[in,out]pComboBoxActs as a handle to the native object of type TPtxPdfForms_ComboBox.
[in]bCanEditSet 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:

◆ PtxPdfForms_ComboBox_SetChosenItem()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pComboBoxActs as a handle to the native object of type TPtxPdfForms_ComboBox.
[in,out]pChosenItemSet 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:

◆ PtxPdfForms_ComboBox_SetEditableItemNameA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pComboBoxActs as a handle to the native object of type TPtxPdfForms_ComboBox.
[in]szEditableItemNameSet 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:

◆ PtxPdfForms_ComboBox_SetEditableItemNameW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pComboBoxActs as a handle to the native object of type TPtxPdfForms_ComboBox.
[in]szEditableItemNameSet 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:

◆ PtxPdfForms_CombTextField_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_CombTextField *PDFTOOLS_TOOLBOX_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]pTargetDocumentthe output document with which the returned object is associated
[in]iMaxLengththe 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:

◆ PtxPdfForms_CombTextField_GetMaxLength()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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]pCombTextFieldActs 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:

◆ PtxPdfForms_CombTextField_SetMaxLength()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pCombTextFieldActs as a handle to the native object of type TPtxPdfForms_CombTextField.
[in]iMaxLengthSet 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:

◆ PtxPdfForms_DocMdpSignature_GetPermissions()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_MdpPermissions PDFTOOLS_TOOLBOX_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]pDocMdpSignatureActs 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:

◆ PtxPdfForms_Field_AddNewWidget()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLS_TOOLBOX_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]pFieldActs as a handle to the native object of type TPtxPdfForms_Field.
[in]pBoundingBoxThe 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:

◆ PtxPdfForms_Field_GetDoNotExport()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetDoNotExport ( TPtxPdfForms_Field * pField)

Tells whether this field is exported.

Parameters
[in,out]pFieldActs 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:

◆ PtxPdfForms_Field_GetReadOnly()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetReadOnly ( TPtxPdfForms_Field * pField)

Flags this field as read-only.

Parameters
[in,out]pFieldActs 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:

◆ PtxPdfForms_Field_GetRequired()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetRequired ( TPtxPdfForms_Field * pField)

Flags this field as mandatory.

Parameters
[in,out]pFieldActs 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:

◆ PtxPdfForms_Field_GetType()

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]pFieldActs 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()

This form field's widget annotations.

Parameters
[in,out]pFieldActs 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:

◆ PtxPdfForms_Field_SetDoNotExport()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_SetDoNotExport ( TPtxPdfForms_Field * pField,
BOOL bDoNotExport )

Tells whether this field is exported.

Parameters
[in,out]pFieldActs as a handle to the native object of type TPtxPdfForms_Field.
[in]bDoNotExportSet 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:

◆ PtxPdfForms_Field_SetReadOnly()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_SetReadOnly ( TPtxPdfForms_Field * pField,
BOOL bReadOnly )

Flags this field as read-only.

Parameters
[in,out]pFieldActs as a handle to the native object of type TPtxPdfForms_Field.
[in]bReadOnlySet 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:

◆ PtxPdfForms_Field_SetRequired()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_SetRequired ( TPtxPdfForms_Field * pField,
BOOL bRequired )

Flags this field as mandatory.

Parameters
[in,out]pFieldActs as a handle to the native object of type TPtxPdfForms_Field.
[in]bRequiredSet 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:

◆ PtxPdfForms_FieldNode_Copy()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLS_TOOLBOX_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]pTargetDocumentthe output document with which the returned object is associated
[in,out]pFieldNodea 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:

◆ PtxPdfForms_FieldNode_GetDisplayNameA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pFieldNodeActs as a handle to the native object of type TPtxPdfForms_FieldNode.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_FieldNode_GetDisplayNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pFieldNodeActs as a handle to the native object of type TPtxPdfForms_FieldNode.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_FieldNode_GetExportNameA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameA ( TPtxPdfForms_FieldNode * pFieldNode,
char * pBuffer,
size_t nBufferSize )

The name used when exporting.

Parameters
[in,out]pFieldNodeActs as a handle to the native object of type TPtxPdfForms_FieldNode.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_FieldNode_GetExportNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameW ( TPtxPdfForms_FieldNode * pFieldNode,
WCHAR * pBuffer,
size_t nBufferSize )

The name used when exporting.

Parameters
[in,out]pFieldNodeActs as a handle to the native object of type TPtxPdfForms_FieldNode.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_FieldNode_GetType()

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]pFieldNodeActs 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()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pFieldNodeActs as a handle to the native object of type TPtxPdfForms_FieldNode.
[in]szDisplayNameSet 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:

◆ PtxPdfForms_FieldNode_SetDisplayNameW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pFieldNodeActs as a handle to the native object of type TPtxPdfForms_FieldNode.
[in]szDisplayNameSet 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:

◆ PtxPdfForms_FieldNode_SetExportNameA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameA ( TPtxPdfForms_FieldNode * pFieldNode,
const char * szExportName )

The name used when exporting.

Parameters
[in,out]pFieldNodeActs as a handle to the native object of type TPtxPdfForms_FieldNode.
[in]szExportNameSet 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:

◆ PtxPdfForms_FieldNode_SetExportNameW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameW ( TPtxPdfForms_FieldNode * pFieldNode,
const WCHAR * szExportName )

The name used when exporting.

Parameters
[in,out]pFieldNodeActs as a handle to the native object of type TPtxPdfForms_FieldNode.
[in]szExportNameSet 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:

◆ PtxPdfForms_FieldNodeMap_GetA()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_GetBegin()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetCount ( TPtxPdfForms_FieldNodeMap * pFieldNodeMap)

The number of key-value pairs in the map.

Parameters
[in,out]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_GetEnd()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_GetKeyA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]it
[out]pBufferTo determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]nBufferSizeThe 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:

◆ PtxPdfForms_FieldNodeMap_GetKeyW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]it
[out]pBufferTo determine the required buffer size, the function has to be called with NULL. The return value of this function specifies the buffer size.
[in]nBufferSizeThe 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:

◆ PtxPdfForms_FieldNodeMap_GetNext()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_GetSize()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetSize ( TPtxPdfForms_FieldNodeMap * pFieldNodeMap)

The number of key-value pairs in the map.

Parameters
[in,out]pFieldNodeMapActs 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:
Deprecated
Deprecated in Version 1.1.0.

◆ PtxPdfForms_FieldNodeMap_GetValue()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetValue ( TPtxPdfForms_FieldNodeMap * pFieldNodeMap,
int it )

Get the value of the entry given a position.

Parameters
[in,out]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_GetW()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_LookupA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]szIdentifierPaththe 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:

◆ PtxPdfForms_FieldNodeMap_LookupW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs as a handle to the native object of type TPtxPdfForms_FieldNodeMap.
[in]szIdentifierPaththe 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:

◆ PtxPdfForms_FieldNodeMap_SetA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_SetValue()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs 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:

◆ PtxPdfForms_FieldNodeMap_SetW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pFieldNodeMapActs 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:

◆ PtxPdfForms_GeneralTextField_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_GeneralTextField *PDFTOOLS_TOOLBOX_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]pTargetDocumentthe 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:

◆ PtxPdfForms_GeneralTextField_GetDoNotScroll()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotScroll ( TPtxPdfForms_GeneralTextField * pGeneralTextField)

Flags this text field non scrollable.

Parameters
[in,out]pGeneralTextFieldActs 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:

◆ PtxPdfForms_GeneralTextField_GetDoNotSpellCheck()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotSpellCheck ( TPtxPdfForms_GeneralTextField * pGeneralTextField)

Flags this text field for prevention from spell checking.

Parameters
[in,out]pGeneralTextFieldActs 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:

◆ PtxPdfForms_GeneralTextField_GetMaxLength()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pGeneralTextFieldActs as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[out]pMaxLengthRetrieved 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:

◆ PtxPdfForms_GeneralTextField_GetMultiline()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetMultiline ( TPtxPdfForms_GeneralTextField * pGeneralTextField)

Flags this text field as multi-line.

Parameters
[in,out]pGeneralTextFieldActs 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:

◆ PtxPdfForms_GeneralTextField_GetPassword()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetPassword ( TPtxPdfForms_GeneralTextField * pGeneralTextField)

Flags this text field as a password entry field.

Parameters
[in,out]pGeneralTextFieldActs 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:

◆ PtxPdfForms_GeneralTextField_SetDoNotScroll()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotScroll ( TPtxPdfForms_GeneralTextField * pGeneralTextField,
BOOL bDoNotScroll )

Flags this text field non scrollable.

Parameters
[in,out]pGeneralTextFieldActs as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]bDoNotScrollSet 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:

◆ PtxPdfForms_GeneralTextField_SetDoNotSpellCheck()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotSpellCheck ( TPtxPdfForms_GeneralTextField * pGeneralTextField,
BOOL bDoNotSpellCheck )

Flags this text field for prevention from spell checking.

Parameters
[in,out]pGeneralTextFieldActs as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]bDoNotSpellCheckSet 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:

◆ PtxPdfForms_GeneralTextField_SetMaxLength()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pGeneralTextFieldActs as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]pMaxLengthSet 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:

◆ PtxPdfForms_GeneralTextField_SetMultiline()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetMultiline ( TPtxPdfForms_GeneralTextField * pGeneralTextField,
BOOL bMultiline )

Flags this text field as multi-line.

Parameters
[in,out]pGeneralTextFieldActs as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]bMultilineSet 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:

◆ PtxPdfForms_GeneralTextField_SetPassword()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetPassword ( TPtxPdfForms_GeneralTextField * pGeneralTextField,
BOOL bPassword )

Flags this text field as a password entry field.

Parameters
[in,out]pGeneralTextFieldActs as a handle to the native object of type TPtxPdfForms_GeneralTextField.
[in]bPasswordSet 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:

◆ PtxPdfForms_ListBox_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ListBox *PDFTOOLS_TOOLBOX_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]pTargetDocumentthe 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:

◆ PtxPdfForms_ListBox_GetAllowMultiSelect()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ListBox_GetAllowMultiSelect ( TPtxPdfForms_ListBox * pListBox)

Allow multiple items to be selected.

Parameters
[in,out]pListBoxActs 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:

◆ PtxPdfForms_ListBox_GetChosenItems()

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]pListBoxActs 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:

◆ PtxPdfForms_ListBox_SetAllowMultiSelect()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ListBox_SetAllowMultiSelect ( TPtxPdfForms_ListBox * pListBox,
BOOL bAllowMultiSelect )

Allow multiple items to be selected.

Parameters
[in,out]pListBoxActs as a handle to the native object of type TPtxPdfForms_ListBox.
[in]bAllowMultiSelectSet 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:

◆ PtxPdfForms_RadioButton_AddNewWidget()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLS_TOOLBOX_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]pRadioButtonActs as a handle to the native object of type TPtxPdfForms_RadioButton.
[in]pBoundingBoxThe 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:

◆ PtxPdfForms_RadioButton_GetExportNameA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameA ( TPtxPdfForms_RadioButton * pRadioButton,
char * pBuffer,
size_t nBufferSize )

The button's name used when exporting.

Parameters
[in,out]pRadioButtonActs as a handle to the native object of type TPtxPdfForms_RadioButton.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_RadioButton_GetExportNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameW ( TPtxPdfForms_RadioButton * pRadioButton,
WCHAR * pBuffer,
size_t nBufferSize )

The button's name used when exporting.

Parameters
[in,out]pRadioButtonActs as a handle to the native object of type TPtxPdfForms_RadioButton.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_RadioButton_GetWidgets()

The button's widget annotations.

Parameters
[in,out]pRadioButtonActs 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:

◆ PtxPdfForms_RadioButtonGroup_AddNewButtonA()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLS_TOOLBOX_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]pRadioButtonGroupActs as a handle to the native object of type TPtxPdfForms_RadioButtonGroup.
[in]szExportNamethe 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:

◆ PtxPdfForms_RadioButtonGroup_AddNewButtonW()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLS_TOOLBOX_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]pRadioButtonGroupActs as a handle to the native object of type TPtxPdfForms_RadioButtonGroup.
[in]szExportNamethe 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:

◆ PtxPdfForms_RadioButtonGroup_Create()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButtonGroup *PDFTOOLS_TOOLBOX_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]pTargetDocumentthe 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:

◆ PtxPdfForms_RadioButtonGroup_GetButtons()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButtonList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetButtons ( TPtxPdfForms_RadioButtonGroup * pRadioButtonGroup)

This field's buttons.

Parameters
[in,out]pRadioButtonGroupActs 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:

◆ PtxPdfForms_RadioButtonGroup_GetChosenButton()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetChosenButton ( TPtxPdfForms_RadioButtonGroup * pRadioButtonGroup)

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

Parameters
[in,out]pRadioButtonGroupActs 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:

◆ PtxPdfForms_RadioButtonGroup_SetChosenButton()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pRadioButtonGroupActs as a handle to the native object of type TPtxPdfForms_RadioButtonGroup.
[in,out]pChosenButtonSet 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:

◆ PtxPdfForms_RadioButtonList_Get()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonList_Get ( TPtxPdfForms_RadioButtonList * pRadioButtonList,
int iIndex )

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

Parameters
[in,out]pRadioButtonListActs 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:

◆ PtxPdfForms_RadioButtonList_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonList_GetCount ( TPtxPdfForms_RadioButtonList * pRadioButtonList)

Get the number of elements in the list.

Parameters
[in,out]pRadioButtonListActs 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:

◆ PtxPdfForms_Signature_GetContactInfoA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pSignatureActs as a handle to the native object of type TPtxPdfForms_Signature.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_Signature_GetContactInfoW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pSignatureActs as a handle to the native object of type TPtxPdfForms_Signature.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_Signature_GetLocationA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pSignatureActs as a handle to the native object of type TPtxPdfForms_Signature.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_Signature_GetLocationW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pSignatureActs as a handle to the native object of type TPtxPdfForms_Signature.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_Signature_GetReasonA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Signature_GetReasonA ( TPtxPdfForms_Signature * pSignature,
char * pBuffer,
size_t nBufferSize )

The reason for signing.

Parameters
[in,out]pSignatureActs as a handle to the native object of type TPtxPdfForms_Signature.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_Signature_GetReasonW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Signature_GetReasonW ( TPtxPdfForms_Signature * pSignature,
WCHAR * pBuffer,
size_t nBufferSize )

The reason for signing.

Parameters
[in,out]pSignatureActs as a handle to the native object of type TPtxPdfForms_Signature.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_Signature_GetType()

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]pSignatureActs 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()

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]pSignatureFieldActs 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()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pSignatureFieldActs 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:

◆ PtxPdfForms_SignatureFieldList_Get()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SignatureField *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignatureFieldList_Get ( TPtxPdfForms_SignatureFieldList * pSignatureFieldList,
int iIndex )

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

Parameters
[in,out]pSignatureFieldListActs 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:

◆ PtxPdfForms_SignatureFieldList_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignatureFieldList_GetCount ( TPtxPdfForms_SignatureFieldList * pSignatureFieldList)

Get the number of elements in the list.

Parameters
[in,out]pSignatureFieldListActs 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:

◆ PtxPdfForms_SignedSignatureField_GetDate()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pSignedSignatureFieldActs as a handle to the native object of type TPtxPdfForms_SignedSignatureField.
[out]pDateRetrieved 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:

◆ PtxPdfForms_SignedSignatureField_GetNameA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pSignedSignatureFieldActs as a handle to the native object of type TPtxPdfForms_SignedSignatureField.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_SignedSignatureField_GetNameW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_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]pSignedSignatureFieldActs as a handle to the native object of type TPtxPdfForms_SignedSignatureField.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_SignedSignatureField_GetType()

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]pSignedSignatureFieldActs 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()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_SubForm *PDFTOOLS_TOOLBOX_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]pTargetDocumentthe 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:

◆ PtxPdfForms_SubForm_GetChildren()

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]pSubFormActs 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:

◆ PtxPdfForms_TextField_GetAlignment()

The text alignment.

Parameters
[in,out]pTextFieldActs 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:

◆ PtxPdfForms_TextField_GetFontSize()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pTextFieldActs as a handle to the native object of type TPtxPdfForms_TextField.
[out]pFontSizeRetrieved 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:

◆ PtxPdfForms_TextField_GetTextA()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_GetTextA ( TPtxPdfForms_TextField * pTextField,
char * pBuffer,
size_t nBufferSize )

This field's text.

Parameters
[in,out]pTextFieldActs as a handle to the native object of type TPtxPdfForms_TextField.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_TextField_GetTextW()

PDFTOOLS_TOOLBOX_EXPORT size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_GetTextW ( TPtxPdfForms_TextField * pTextField,
WCHAR * pBuffer,
size_t nBufferSize )

This field's text.

Parameters
[in,out]pTextFieldActs as a handle to the native object of type TPtxPdfForms_TextField.
[out]pBufferRetrieved 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]nBufferSizeThe 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:

◆ PtxPdfForms_TextField_GetType()

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]pTextFieldActs 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()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_SetAlignment ( TPtxPdfForms_TextField * pTextField,
TPtxGeom_HorizontalAlignment iAlignment )

The text alignment.

Parameters
[in,out]pTextFieldActs as a handle to the native object of type TPtxPdfForms_TextField.
[in]iAlignmentSet 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:

◆ PtxPdfForms_TextField_SetFontSize()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pTextFieldActs as a handle to the native object of type TPtxPdfForms_TextField.
[in]pFontSizeSet 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:

◆ PtxPdfForms_TextField_SetTextA()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_SetTextA ( TPtxPdfForms_TextField * pTextField,
const char * szText )

This field's text.

Parameters
[in,out]pTextFieldActs as a handle to the native object of type TPtxPdfForms_TextField.
[in]szTextSet 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:

◆ PtxPdfForms_TextField_SetTextW()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_SetTextW ( TPtxPdfForms_TextField * pTextField,
const WCHAR * szText )

This field's text.

Parameters
[in,out]pTextFieldActs as a handle to the native object of type TPtxPdfForms_TextField.
[in]szTextSet 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:

◆ PtxPdfForms_Widget_GetBoundingBox()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Widget_GetBoundingBox ( TPtxPdfForms_Widget * pWidget,
TPtxGeomReal_Rectangle * pBoundingBox )

The location on the page.

Parameters
[in,out]pWidgetActs as a handle to the native object of type TPtxPdfForms_Widget.
[out]pBoundingBoxRetrieved 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:

◆ PtxPdfForms_Widget_GetHidden()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pWidgetActs 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:

◆ PtxPdfForms_Widget_GetNoPrint()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_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]pWidgetActs 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:

◆ PtxPdfForms_WidgetList_Add()

PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_WidgetList_Add ( TPtxPdfForms_WidgetList * pWidgetList,
TPtxPdfForms_Widget * pWidget )

Add an element to the end of the list.

Parameters
[in,out]pWidgetListActs 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:

◆ PtxPdfForms_WidgetList_Get()

PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_WidgetList_Get ( TPtxPdfForms_WidgetList * pWidgetList,
int iIndex )

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

Parameters
[in,out]pWidgetListActs 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:

◆ PtxPdfForms_WidgetList_GetCount()

PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_WidgetList_GetCount ( TPtxPdfForms_WidgetList * pWidgetList)

Get the number of elements in the list.

Parameters
[in,out]pWidgetListActs 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: