PDF Toolbox
Loading...
Searching...
No Matches
PdfTools_Toolbox_PtxPdfForms.h
Go to the documentation of this file.
1/******************************************************************************
2 *
3 * File: PdfTools_Toolbox_PtxPdfForms.h
4 *
5 * Description: Sub Header file for Toolbox SDK
6 *
7 * Author: PDF Tools AG
8 *
9 * Copyright: Copyright (C) 2024 - 2024 PDF Tools AG, Switzerland
10 * All rights reserved.
11 *
12 * Notice: By downloading and using this artifact, you accept PDF Tools AG's
13 * [license agreement](https://www.pdf-tools.com/license-agreement/),
14 * [privacy policy](https://www.pdf-tools.com/privacy-policy/),
15 * and allow PDF Tools AG to track your usage data.
16 *
17 *****************************************************************************/
18
19#ifndef PDFTOOLS_TOOLBOX_PTXPDFFORMS_H__
20#define PDFTOOLS_TOOLBOX_PTXPDFFORMS_H__
21
22#ifndef PDFTOOLS_TOOLBOX_CALL
23#if defined(WIN32)
24#define PDFTOOLS_TOOLBOX_CALL __stdcall
25#else
26#define PDFTOOLS_TOOLBOX_CALL
27#endif
28#endif
29
32
33#ifdef __cplusplus
34extern "C"
35{
36#endif
37
38#ifdef _UNICODE
39#define PtxPdfForms_FieldNodeMap_Lookup PtxPdfForms_FieldNodeMap_LookupW
40#define PtxPdfForms_FieldNodeMap_Get PtxPdfForms_FieldNodeMap_GetW
41#define PtxPdfForms_FieldNodeMap_GetKey PtxPdfForms_FieldNodeMap_GetKeyW
42#define PtxPdfForms_FieldNodeMap_Set PtxPdfForms_FieldNodeMap_SetW
43
44#define PtxPdfForms_FieldNode_GetDisplayName PtxPdfForms_FieldNode_GetDisplayNameW
45#define PtxPdfForms_FieldNode_SetDisplayName PtxPdfForms_FieldNode_SetDisplayNameW
46#define PtxPdfForms_FieldNode_GetExportName PtxPdfForms_FieldNode_GetExportNameW
47#define PtxPdfForms_FieldNode_SetExportName PtxPdfForms_FieldNode_SetExportNameW
48
49#define PtxPdfForms_TextField_GetText PtxPdfForms_TextField_GetTextW
50#define PtxPdfForms_TextField_SetText PtxPdfForms_TextField_SetTextW
51
52#define PtxPdfForms_CheckBox_GetCheckedExportName PtxPdfForms_CheckBox_GetCheckedExportNameW
53
54#define PtxPdfForms_RadioButton_GetExportName PtxPdfForms_RadioButton_GetExportNameW
55
56#define PtxPdfForms_RadioButtonGroup_AddNewButton PtxPdfForms_RadioButtonGroup_AddNewButtonW
57
58#define PtxPdfForms_ChoiceItem_GetDisplayName PtxPdfForms_ChoiceItem_GetDisplayNameW
59#define PtxPdfForms_ChoiceItem_SetDisplayName PtxPdfForms_ChoiceItem_SetDisplayNameW
60#define PtxPdfForms_ChoiceItem_GetExportName PtxPdfForms_ChoiceItem_GetExportNameW
61#define PtxPdfForms_ChoiceItem_SetExportName PtxPdfForms_ChoiceItem_SetExportNameW
62
63#define PtxPdfForms_ChoiceField_AddNewItem PtxPdfForms_ChoiceField_AddNewItemW
64
65#define PtxPdfForms_ComboBox_GetEditableItemName PtxPdfForms_ComboBox_GetEditableItemNameW
66#define PtxPdfForms_ComboBox_SetEditableItemName PtxPdfForms_ComboBox_SetEditableItemNameW
67
68#define PtxPdfForms_SignedSignatureField_GetName PtxPdfForms_SignedSignatureField_GetNameW
69
70#define PtxPdfForms_Signature_GetLocation PtxPdfForms_Signature_GetLocationW
71
72#define PtxPdfForms_Signature_GetReason PtxPdfForms_Signature_GetReasonW
73
74#define PtxPdfForms_Signature_GetContactInfo PtxPdfForms_Signature_GetContactInfoW
75
76#else
77#define PtxPdfForms_FieldNodeMap_Lookup PtxPdfForms_FieldNodeMap_LookupA
78#define PtxPdfForms_FieldNodeMap_Get PtxPdfForms_FieldNodeMap_GetA
79#define PtxPdfForms_FieldNodeMap_GetKey PtxPdfForms_FieldNodeMap_GetKeyA
80#define PtxPdfForms_FieldNodeMap_Set PtxPdfForms_FieldNodeMap_SetA
81
82#define PtxPdfForms_FieldNode_GetDisplayName PtxPdfForms_FieldNode_GetDisplayNameA
83#define PtxPdfForms_FieldNode_SetDisplayName PtxPdfForms_FieldNode_SetDisplayNameA
84#define PtxPdfForms_FieldNode_GetExportName PtxPdfForms_FieldNode_GetExportNameA
85#define PtxPdfForms_FieldNode_SetExportName PtxPdfForms_FieldNode_SetExportNameA
86
87#define PtxPdfForms_TextField_GetText PtxPdfForms_TextField_GetTextA
88#define PtxPdfForms_TextField_SetText PtxPdfForms_TextField_SetTextA
89
90#define PtxPdfForms_CheckBox_GetCheckedExportName PtxPdfForms_CheckBox_GetCheckedExportNameA
91
92#define PtxPdfForms_RadioButton_GetExportName PtxPdfForms_RadioButton_GetExportNameA
93
94#define PtxPdfForms_RadioButtonGroup_AddNewButton PtxPdfForms_RadioButtonGroup_AddNewButtonA
95
96#define PtxPdfForms_ChoiceItem_GetDisplayName PtxPdfForms_ChoiceItem_GetDisplayNameA
97#define PtxPdfForms_ChoiceItem_SetDisplayName PtxPdfForms_ChoiceItem_SetDisplayNameA
98#define PtxPdfForms_ChoiceItem_GetExportName PtxPdfForms_ChoiceItem_GetExportNameA
99#define PtxPdfForms_ChoiceItem_SetExportName PtxPdfForms_ChoiceItem_SetExportNameA
100
101#define PtxPdfForms_ChoiceField_AddNewItem PtxPdfForms_ChoiceField_AddNewItemA
102
103#define PtxPdfForms_ComboBox_GetEditableItemName PtxPdfForms_ComboBox_GetEditableItemNameA
104#define PtxPdfForms_ComboBox_SetEditableItemName PtxPdfForms_ComboBox_SetEditableItemNameA
105
106#define PtxPdfForms_SignedSignatureField_GetName PtxPdfForms_SignedSignatureField_GetNameA
107
108#define PtxPdfForms_Signature_GetLocation PtxPdfForms_Signature_GetLocationA
109
110#define PtxPdfForms_Signature_GetReason PtxPdfForms_Signature_GetReasonA
111
112#define PtxPdfForms_Signature_GetContactInfo PtxPdfForms_Signature_GetContactInfoA
113
114#endif
115
116/******************************************************************************
117 * FieldNodeMap
118 *****************************************************************************/
141PtxPdfForms_FieldNodeMap_LookupA(TPtxPdfForms_FieldNodeMap* pFieldNodeMap, const char* szIdentifierPath);
164PtxPdfForms_FieldNodeMap_LookupW(TPtxPdfForms_FieldNodeMap* pFieldNodeMap, const WCHAR* szIdentifierPath);
324PtxPdfForms_FieldNodeMap_GetKeyA(TPtxPdfForms_FieldNodeMap* pFieldNodeMap, int it, char* pBuffer, size_t nBufferSize);
347PtxPdfForms_FieldNodeMap_GetKeyW(TPtxPdfForms_FieldNodeMap* pFieldNodeMap, int it, WCHAR* pBuffer, size_t nBufferSize);
385 TPtxPdfForms_FieldNodeMap* pFieldNodeMap, const char* szKey, TPtxPdfForms_FieldNode* pValue);
406 TPtxPdfForms_FieldNodeMap* pFieldNodeMap, const WCHAR* szKey, TPtxPdfForms_FieldNode* pValue);
425
426/******************************************************************************
427 * WidgetList
428 *****************************************************************************/
476 TPtxPdfForms_Widget* pWidget);
477
478/******************************************************************************
479 * SignatureFieldList
480 *****************************************************************************/
512
513/******************************************************************************
514 * Widget
515 *****************************************************************************/
574
575/******************************************************************************
576 * FieldNode
577 *****************************************************************************/
619
647PtxPdfForms_FieldNode_GetDisplayNameA(TPtxPdfForms_FieldNode* pFieldNode, char* pBuffer, size_t nBufferSize);
675PtxPdfForms_FieldNode_GetDisplayNameW(TPtxPdfForms_FieldNode* pFieldNode, WCHAR* pBuffer, size_t nBufferSize);
696PtxPdfForms_FieldNode_SetDisplayNameA(TPtxPdfForms_FieldNode* pFieldNode, const char* szDisplayName);
743PtxPdfForms_FieldNode_GetExportNameA(TPtxPdfForms_FieldNode* pFieldNode, char* pBuffer, size_t nBufferSize);
769PtxPdfForms_FieldNode_GetExportNameW(TPtxPdfForms_FieldNode* pFieldNode, WCHAR* pBuffer, size_t nBufferSize);
808
824/******************************************************************************
825 * SubForm
826 *****************************************************************************/
856
885
886/******************************************************************************
887 * Field
888 *****************************************************************************/
917
972 BOOL bReadOnly);
1010 BOOL bRequired);
1048 BOOL bDoNotExport);
1049
1065/******************************************************************************
1066 * TextField
1067 *****************************************************************************/
1100 char* pBuffer, size_t nBufferSize);
1133 WCHAR* pBuffer, size_t nBufferSize);
1159 const char* szText);
1185 const WCHAR* szText);
1254 double* pFontSize);
1279 const double* pFontSize);
1280
1296/******************************************************************************
1297 * GeneralTextField
1298 *****************************************************************************/
1328
1505 TPtxPdfForms_GeneralTextField* pGeneralTextField, BOOL bDoNotSpellCheck);
1545
1546/******************************************************************************
1547 * CombTextField
1548 *****************************************************************************/
1581PtxPdfForms_CombTextField_Create(TPtxPdf_Document* pTargetDocument, int iMaxLength);
1582
1633
1634/******************************************************************************
1635 * CheckBox
1636 *****************************************************************************/
1666
1690PtxPdfForms_CheckBox_GetCheckedExportNameA(TPtxPdfForms_CheckBox* pCheckBox, char* pBuffer, size_t nBufferSize);
1756 BOOL bChecked);
1757
1758/******************************************************************************
1759 * RadioButton
1760 *****************************************************************************/
1785 TPtxPdfForms_RadioButton* pRadioButton, const TPtxGeomReal_Rectangle* pBoundingBox);
1786
1810PtxPdfForms_RadioButton_GetExportNameA(TPtxPdfForms_RadioButton* pRadioButton, char* pBuffer, size_t nBufferSize);
1834PtxPdfForms_RadioButton_GetExportNameW(TPtxPdfForms_RadioButton* pRadioButton, WCHAR* pBuffer, size_t nBufferSize);
1852
1853/******************************************************************************
1854 * RadioButtonList
1855 *****************************************************************************/
1887
1888/******************************************************************************
1889 * RadioButtonGroup
1890 *****************************************************************************/
1968
2043 TPtxPdfForms_RadioButtonGroup* pRadioButtonGroup, TPtxPdfForms_RadioButton* pChosenButton);
2044
2045/******************************************************************************
2046 * ChoiceItem
2047 *****************************************************************************/
2077PtxPdfForms_ChoiceItem_GetDisplayNameA(TPtxPdfForms_ChoiceItem* pChoiceItem, char* pBuffer, size_t nBufferSize);
2181PtxPdfForms_ChoiceItem_GetExportNameA(TPtxPdfForms_ChoiceItem* pChoiceItem, char* pBuffer, size_t nBufferSize);
2209PtxPdfForms_ChoiceItem_GetExportNameW(TPtxPdfForms_ChoiceItem* pChoiceItem, WCHAR* pBuffer, size_t nBufferSize);
2252
2253/******************************************************************************
2254 * ChoiceItemList
2255 *****************************************************************************/
2336
2337/******************************************************************************
2338 * ChoiceField
2339 *****************************************************************************/
2364PtxPdfForms_ChoiceField_AddNewItemA(TPtxPdfForms_ChoiceField* pChoiceField, const char* szDisplayName);
2390
2410
2426/******************************************************************************
2427 * ListBox
2428 *****************************************************************************/
2458
2532
2533/******************************************************************************
2534 * ComboBox
2535 *****************************************************************************/
2565
2603 BOOL bCanEdit);
2697PtxPdfForms_ComboBox_GetEditableItemNameA(TPtxPdfForms_ComboBox* pComboBox, char* pBuffer, size_t nBufferSize);
2762PtxPdfForms_ComboBox_SetEditableItemNameA(TPtxPdfForms_ComboBox* pComboBox, const char* szEditableItemName);
2792
2793/******************************************************************************
2794 * SignatureField
2795 *****************************************************************************/
2816
2832/******************************************************************************
2833 * SignedSignatureField
2834 *****************************************************************************/
2866 TPtxPdfForms_SignedSignatureField* pSignedSignatureField, char* pBuffer, size_t nBufferSize);
2898 TPtxPdfForms_SignedSignatureField* pSignedSignatureField, WCHAR* pBuffer, size_t nBufferSize);
2927
2943/******************************************************************************
2944 * Signature
2945 *****************************************************************************/
2971PtxPdfForms_Signature_GetLocationA(TPtxPdfForms_Signature* pSignature, char* pBuffer, size_t nBufferSize);
2997PtxPdfForms_Signature_GetLocationW(TPtxPdfForms_Signature* pSignature, WCHAR* pBuffer, size_t nBufferSize);
3021PtxPdfForms_Signature_GetReasonA(TPtxPdfForms_Signature* pSignature, char* pBuffer, size_t nBufferSize);
3045PtxPdfForms_Signature_GetReasonW(TPtxPdfForms_Signature* pSignature, WCHAR* pBuffer, size_t nBufferSize);
3072PtxPdfForms_Signature_GetContactInfoA(TPtxPdfForms_Signature* pSignature, char* pBuffer, size_t nBufferSize);
3099PtxPdfForms_Signature_GetContactInfoW(TPtxPdfForms_Signature* pSignature, WCHAR* pBuffer, size_t nBufferSize);
3100
3116/******************************************************************************
3117 * DocMdpSignature
3118 *****************************************************************************/
3139
3140#ifdef __cplusplus
3141}
3142#endif
3143
3144#endif /* PDFTOOLS_TOOLBOX_PTXPDFFORMS_H__ */
#define PDFTOOLS_TOOLBOX_EXPORT
Definition PdfTools_Toolbox_Platform.h:143
unsigned short WCHAR
Definition PdfTools_Toolbox_Platform.h:95
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 TPtxPdfForms_MdpPermissions PDFTOOLS_TOOLBOX_CALL PtxPdfForms_DocMdpSignature_GetPermissions(TPtxPdfForms_DocMdpSignature *pDocMdpSignature)
The access permissions granted for this document Note that for encrypted PDF documents,...
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 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_TextField_GetTextA(TPtxPdfForms_TextField *pTextField, char *pBuffer, size_t nBufferSize)
This field's text.
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 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 con...
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 int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetSize(TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
The number of key-value pairs in the map.
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 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 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 int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_WidgetList_GetCount(TPtxPdfForms_WidgetList *pWidgetList)
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 TPtxGeom_HorizontalAlignment PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_GetAlignment(TPtxPdfForms_TextField *pTextField)
The text alignment.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceField_AddNewItemW(TPtxPdfForms_ChoiceField *pChoiceField, const WCHAR *szDisplayName)
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 BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetReadOnly(TPtxPdfForms_Field *pField)
Flags this field as read-only.
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_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,...
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 int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonList_GetCount(TPtxPdfForms_RadioButtonList *pRadioButtonList)
Get the number of elements in the list.
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 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 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_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 TPtxPdfForms_ChoiceItem *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceField_AddNewItemA(TPtxPdfForms_ChoiceField *pChoiceField, const char *szDisplayName)
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 wi...
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 return...
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,...
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_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_GeneralTextField_SetPassword(TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bPassword)
Flags this text field as a password entry field.
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_ComboBox_SetChosenItem(TPtxPdfForms_ComboBox *pComboBox, TPtxPdfForms_ChoiceItem *pChosenItem)
The selected combo box item If this property is NULL then the PtxPdfForms_ComboBox_GetEditableItemNam...
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_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 wi...
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetEnd(TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
Get the end position of the map.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_RadioButtonList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetButtons(TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup)
This field's buttons.
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 int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetCount(TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
The number of key-value pairs in the map.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotScroll(TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bDoNotScroll)
Flags this text field non scrollable.
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_Field_GetDoNotExport(TPtxPdfForms_Field *pField)
Tells whether this field is exported.
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 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 return...
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 automatic...
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_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 Pt...
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_SetReadOnly(TPtxPdfForms_Field *pField, BOOL bReadOnly)
Flags this field as read-only.
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 Pt...
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 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_TextField_SetTextW(TPtxPdfForms_TextField *pTextField, const WCHAR *szText)
This field's text.
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 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.
#define PDFTOOLS_TOOLBOX_CALL
Definition PdfTools_Toolbox_PtxPdfForms.h:26
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_GeneralTextField_SetMultiline(TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bMultiline)
Flags this text field as multi-line.
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 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_FieldNode_GetExportNameW(TPtxPdfForms_FieldNode *pFieldNode, WCHAR *pBuffer, size_t nBufferSize)
The name used when exporting.
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...
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 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 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 pTargetDocum...
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 ...
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 us...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameW(TPtxPdfForms_FieldNode *pFieldNode, const WCHAR *szExportName)
The name used when exporting.
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,...
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 BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_SetDoNotExport(TPtxPdfForms_Field *pField, BOOL bDoNotExport)
Tells whether this field is exported.
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 t...
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 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....
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ComboBox_SetCanEdit(TPtxPdfForms_ComboBox *pComboBox, BOOL bCanEdit)
Has an editable item.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Field_GetWidgets(TPtxPdfForms_Field *pField)
This form field's widget annotations.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_RadioButton_GetWidgets(TPtxPdfForms_RadioButton *pRadioButton)
The button's widget annotations.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_TextField_SetAlignment(TPtxPdfForms_TextField *pTextField, TPtxGeom_HorizontalAlignment iAlignment)
The text alignment.
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 con...
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 wit...
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,...
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 te...
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 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 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 te...
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 BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotSpellCheck(TPtxPdfForms_GeneralTextField *pGeneralTextField)
Flags this text field for prevention from spell checking.
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 int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_SignatureFieldList_GetCount(TPtxPdfForms_SignatureFieldList *pSignatureFieldList)
Get the number of elements in the list.
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 int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetBegin(TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
Get the position of the first entry in the map.
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,...
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 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 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 size_t PDFTOOLS_TOOLBOX_CALL PtxPdfForms_Signature_GetReasonW(TPtxPdfForms_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
The reason for signing.
PDFTOOLS_TOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ListBox_GetChosenItems(TPtxPdfForms_ListBox *pListBox)
The selected choice items.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Remove(TPtxPdfForms_ChoiceItemList *pChoiceItemList, int iIndex)
Remove certain element from list.
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_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 t...
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...
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 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_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_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 TPtxPdfForms_ChoiceFieldType PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceField_GetType(TPtxPdfForms_ChoiceField *pChoiceField)
Get actual derived type of base type TPtxPdfForms_ChoiceField.
PDFTOOLS_TOOLBOX_EXPORT int PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_GetCount(TPtxPdfForms_ChoiceItemList *pChoiceItemList)
Get the number of elements in the list.
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,...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ListBox_SetAllowMultiSelect(TPtxPdfForms_ListBox *pListBox, BOOL bAllowMultiSelect)
Allow multiple items to be selected.
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_ChoiceItemList_Clear(TPtxPdfForms_ChoiceItemList *pChoiceItemList)
Clear 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...
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,...
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_SignatureField_IsVisible(TPtxPdfForms_SignatureField *pSignatureField)
The visibility of the signature field If TRUE, the signature field has a visual appearance on the pag...
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_ListBox_GetAllowMultiSelect(TPtxPdfForms_ListBox *pListBox)
Allow multiple items to be selected.
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 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,...
PDFTOOLS_TOOLBOX_EXPORT BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_GeneralTextField_GetMultiline(TPtxPdfForms_GeneralTextField *pGeneralTextField)
Flags this text field as multi-line.
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 BOOL PDFTOOLS_TOOLBOX_CALL PtxPdfForms_CheckBox_GetChecked(TPtxPdfForms_CheckBox *pCheckBox)
The state of the check box.
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 wi...
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 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_GetEditableItemNam...
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 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 t...
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 ...
TPtxPdfForms_SignedSignatureFieldType
Type and subtype enumeration of TPtxPdfForms_SignedSignatureField.
Definition PdfTools_Toolbox_Types.h:1081
TPtxPdfForms_ChoiceFieldType
Type and subtype enumeration of TPtxPdfForms_ChoiceField.
Definition PdfTools_Toolbox_Types.h:1032
TPtxPdfForms_FieldNodeType
Type and subtype enumeration of TPtxPdfForms_FieldNode.
Definition PdfTools_Toolbox_Types.h:950
TPtxPdfForms_TextFieldType
Type and subtype enumeration of TPtxPdfForms_TextField.
Definition PdfTools_Toolbox_Types.h:1010
TPtxPdfForms_SignatureFieldType
Type and subtype enumeration of TPtxPdfForms_SignatureField.
Definition PdfTools_Toolbox_Types.h:1055
TPtxPdfForms_MdpPermissions
Definition PdfTools_Toolbox_Types.h:676
TPtxGeom_HorizontalAlignment
Definition PdfTools_Toolbox_Types.h:83
TPtxPdfForms_FieldType
Type and subtype enumeration of TPtxPdfForms_Field.
Definition PdfTools_Toolbox_Types.h:981
TPtxPdfForms_SignatureType
Type and subtype enumeration of TPtxPdfForms_Signature.
Definition PdfTools_Toolbox_Types.h:1105
#define BOOL
Definition PdfTools_Toolbox_Types.h:23
A check box field.
An item in a list box field or combo box field.
A fixed pitch text field In a comb text field, the PtxPdfForms_GeneralTextField_GetMaxLength must be ...
A combo box field.
A Document Modification Detection and Prevention (MDP) signature that certifies the document This typ...
A form field.
Base class for form fields and sub forms.
A general text field.
A list box field.
A radio button field.
A button in a radio button group.
A digital signature field.
A base class for certain signature types.
A base class for signature fields that have been signed The existence of a signed signature field doe...
A form field that contains other fields.
A form field widget.
Definition PdfTools_Toolbox_Types.h:2039
Definition PdfTools_Toolbox_Types.h:2178