4.4/cdoc/_pdf_toolbox___ptx_pdf_forms_8h_source.html

/******************************************************************************

 *

 * File:            PdfToolbox_PtxPdfForms.h

 *

 * Description:     Sub Header file for PDF Toolbox API

 *

 * Author:          PDF Tools AG

 *

 * Copyright:       Copyright (C) 2015 - 2025 PDF Tools AG, Switzerland

 *                  All rights reserved.

 *

 * Notice:          By downloading and using this artifact, you accept PDF Tools AG's

 *                  [license agreement](https://www.pdf-tools.com/license-agreement/),

 *                  [privacy policy](https://www.pdf-tools.com/privacy-policy/),

 *                  and allow PDF Tools AG to track your usage data.

 *

 *****************************************************************************/


#ifndef PDFTOOLBOX_PTXPDFFORMS_H__

#define PDFTOOLBOX_PTXPDFFORMS_H__


#ifndef PDFTOOLBOX_CALL

#if defined(WIN32)

#define PDFTOOLBOX_CALL __stdcall

#else

#define PDFTOOLBOX_CALL

#endif

#endif


#include "PdfToolbox_Types.h"

#include "PdfToolbox_PtxSys.h"


#ifdef __cplusplus

extern "C"

{

#endif


#ifdef _UNICODE

#define PtxPdfForms_FieldNodeMap_Lookup PtxPdfForms_FieldNodeMap_LookupW

#define PtxPdfForms_FieldNodeMap_Get    PtxPdfForms_FieldNodeMap_GetW

#define PtxPdfForms_FieldNodeMap_GetKey PtxPdfForms_FieldNodeMap_GetKeyW

#define PtxPdfForms_FieldNodeMap_Set    PtxPdfForms_FieldNodeMap_SetW


#define PtxPdfForms_FieldNode_GetDisplayName PtxPdfForms_FieldNode_GetDisplayNameW

#define PtxPdfForms_FieldNode_SetDisplayName PtxPdfForms_FieldNode_SetDisplayNameW

#define PtxPdfForms_FieldNode_GetExportName  PtxPdfForms_FieldNode_GetExportNameW

#define PtxPdfForms_FieldNode_SetExportName  PtxPdfForms_FieldNode_SetExportNameW


#define PtxPdfForms_TextField_GetText PtxPdfForms_TextField_GetTextW

#define PtxPdfForms_TextField_SetText PtxPdfForms_TextField_SetTextW


#define PtxPdfForms_CheckBox_GetCheckedExportName PtxPdfForms_CheckBox_GetCheckedExportNameW


#define PtxPdfForms_RadioButton_GetExportName PtxPdfForms_RadioButton_GetExportNameW


#define PtxPdfForms_RadioButtonGroup_AddNewButton PtxPdfForms_RadioButtonGroup_AddNewButtonW


#define PtxPdfForms_ChoiceItem_GetDisplayName PtxPdfForms_ChoiceItem_GetDisplayNameW

#define PtxPdfForms_ChoiceItem_SetDisplayName PtxPdfForms_ChoiceItem_SetDisplayNameW

#define PtxPdfForms_ChoiceItem_GetExportName  PtxPdfForms_ChoiceItem_GetExportNameW

#define PtxPdfForms_ChoiceItem_SetExportName  PtxPdfForms_ChoiceItem_SetExportNameW


#define PtxPdfForms_ChoiceField_AddNewItem PtxPdfForms_ChoiceField_AddNewItemW


#define PtxPdfForms_ComboBox_GetEditableItemName PtxPdfForms_ComboBox_GetEditableItemNameW

#define PtxPdfForms_ComboBox_SetEditableItemName PtxPdfForms_ComboBox_SetEditableItemNameW


#define PtxPdfForms_SignedSignatureField_GetName PtxPdfForms_SignedSignatureField_GetNameW


#define PtxPdfForms_Signature_GetLocation PtxPdfForms_Signature_GetLocationW


#define PtxPdfForms_Signature_GetReason PtxPdfForms_Signature_GetReasonW


#define PtxPdfForms_Signature_GetContactInfo PtxPdfForms_Signature_GetContactInfoW


#else

#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


#endif


/******************************************************************************

 * FieldNodeMap

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode* PDFTOOLBOX_CALL

PtxPdfForms_FieldNodeMap_LookupA(TPtxPdfForms_FieldNodeMap* pFieldNodeMap, const char* szIdentifierPath);

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode* PDFTOOLBOX_CALL

PtxPdfForms_FieldNodeMap_LookupW(TPtxPdfForms_FieldNodeMap* pFieldNodeMap, const WCHAR* szIdentifierPath);

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetCount(TPtxPdfForms_FieldNodeMap* pFieldNodeMap);

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetSize(TPtxPdfForms_FieldNodeMap* pFieldNodeMap);

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetBegin(TPtxPdfForms_FieldNodeMap* pFieldNodeMap);

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetEnd(TPtxPdfForms_FieldNodeMap* pFieldNodeMap);

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetNext(TPtxPdfForms_FieldNodeMap* pFieldNodeMap,

                                                                       int                        it);

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetA(TPtxPdfForms_FieldNodeMap* pFieldNodeMap,

                                                                    const char*                szKey);

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetW(TPtxPdfForms_FieldNodeMap* pFieldNodeMap,

                                                                    const WCHAR*               szKey);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetKeyA(TPtxPdfForms_FieldNodeMap* pFieldNodeMap,

                                                                          int it, char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetKeyW(TPtxPdfForms_FieldNodeMap* pFieldNodeMap,

                                                                          int it, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode* PDFTOOLBOX_CALL

PtxPdfForms_FieldNodeMap_GetValue(TPtxPdfForms_FieldNodeMap* pFieldNodeMap, int it);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetA(TPtxPdfForms_FieldNodeMap* pFieldNodeMap,

                                                                     const char* szKey, TPtxPdfForms_FieldNode* pValue);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetW(TPtxPdfForms_FieldNodeMap* pFieldNodeMap,

                                                                     const WCHAR*               szKey,

                                                                     TPtxPdfForms_FieldNode*    pValue);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetValue(TPtxPdfForms_FieldNodeMap* pFieldNodeMap,

                                                                         int it, TPtxPdfForms_FieldNode* pValue);


/******************************************************************************

 * WidgetList

 *****************************************************************************/

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_WidgetList_GetCount(TPtxPdfForms_WidgetList* pWidgetList);

PDFTOOLBOX_EXPORT TPtxPdfForms_Widget* PDFTOOLBOX_CALL PtxPdfForms_WidgetList_Get(TPtxPdfForms_WidgetList* pWidgetList,

                                                                                  int                      iIndex);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_WidgetList_Add(TPtxPdfForms_WidgetList* pWidgetList,

                                                                  TPtxPdfForms_Widget*     pWidget);


/******************************************************************************

 * SignatureFieldList

 *****************************************************************************/

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL

PtxPdfForms_SignatureFieldList_GetCount(TPtxPdfForms_SignatureFieldList* pSignatureFieldList);

PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureField* PDFTOOLBOX_CALL

PtxPdfForms_SignatureFieldList_Get(TPtxPdfForms_SignatureFieldList* pSignatureFieldList, int iIndex);


/******************************************************************************

 * Widget

 *****************************************************************************/

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetBoundingBox(TPtxPdfForms_Widget*    pWidget,

                                                                         TPtxGeomReal_Rectangle* pBoundingBox);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetHidden(TPtxPdfForms_Widget* pWidget);

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

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetLocked(TPtxPdfForms_Widget* pWidget);

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

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetNoPrint(TPtxPdfForms_Widget* pWidget);


/******************************************************************************

 * FieldNode

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode* PDFTOOLBOX_CALL

PtxPdfForms_FieldNode_Copy(TPtxPdf_Document* pTargetDocument, TPtxPdfForms_FieldNode* pFieldNode);


PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetDisplayNameA(TPtxPdfForms_FieldNode* pFieldNode,

                                                                               char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetDisplayNameW(TPtxPdfForms_FieldNode* pFieldNode,

                                                                               WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetDisplayNameA(TPtxPdfForms_FieldNode* pFieldNode,

                                                                             const char*             szDisplayName);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetDisplayNameW(TPtxPdfForms_FieldNode* pFieldNode,

                                                                             const WCHAR*            szDisplayName);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameA(TPtxPdfForms_FieldNode* pFieldNode,

                                                                              char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameW(TPtxPdfForms_FieldNode* pFieldNode,

                                                                              WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameA(TPtxPdfForms_FieldNode* pFieldNode,

                                                                            const char*             szExportName);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameW(TPtxPdfForms_FieldNode* pFieldNode,

                                                                            const WCHAR*            szExportName);


PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeType PDFTOOLBOX_CALL

PtxPdfForms_FieldNode_GetType(TPtxPdfForms_FieldNode* pFieldNode);

/******************************************************************************

 * SubForm

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_SubForm* PDFTOOLBOX_CALL PtxPdfForms_SubForm_Create(TPtxPdf_Document* pTargetDocument);


PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeMap* PDFTOOLBOX_CALL

PtxPdfForms_SubForm_GetChildren(TPtxPdfForms_SubForm* pSubForm);


/******************************************************************************

 * Field

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_Widget* PDFTOOLBOX_CALL

PtxPdfForms_Field_AddNewWidget(TPtxPdfForms_Field* pField, const TPtxGeomReal_Rectangle* pBoundingBox);


PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList* PDFTOOLBOX_CALL PtxPdfForms_Field_GetWidgets(TPtxPdfForms_Field* pField);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetReadOnly(TPtxPdfForms_Field* pField);

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

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetRequired(TPtxPdfForms_Field* pField);

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

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetDoNotExport(TPtxPdfForms_Field* pField);

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


PDFTOOLBOX_EXPORT TPtxPdfForms_FieldType PDFTOOLBOX_CALL PtxPdfForms_Field_GetType(TPtxPdfForms_Field* pField);

/******************************************************************************

 * TextField

 *****************************************************************************/

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_TextField_GetTextA(TPtxPdfForms_TextField* pTextField,

                                                                        char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_TextField_GetTextW(TPtxPdfForms_TextField* pTextField,

                                                                        WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetTextA(TPtxPdfForms_TextField* pTextField,

                                                                      const char*             szText);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetTextW(TPtxPdfForms_TextField* pTextField,

                                                                      const WCHAR*            szText);

PDFTOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLBOX_CALL

PtxPdfForms_TextField_GetAlignment(TPtxPdfForms_TextField* pTextField);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetAlignment(TPtxPdfForms_TextField*      pTextField,

                                                                          TPtxGeom_HorizontalAlignment iAlignment);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_GetFontSize(TPtxPdfForms_TextField* pTextField,

                                                                         double*                 pFontSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetFontSize(TPtxPdfForms_TextField* pTextField,

                                                                         const double*           pFontSize);


PDFTOOLBOX_EXPORT TPtxPdfForms_TextFieldType PDFTOOLBOX_CALL

PtxPdfForms_TextField_GetType(TPtxPdfForms_TextField* pTextField);

/******************************************************************************

 * GeneralTextField

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_GeneralTextField* PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_Create(TPtxPdf_Document* pTargetDocument);


PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_GetMaxLength(TPtxPdfForms_GeneralTextField* pGeneralTextField, int* pMaxLength);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_SetMaxLength(TPtxPdfForms_GeneralTextField* pGeneralTextField, const int* pMaxLength);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_GetMultiline(TPtxPdfForms_GeneralTextField* pGeneralTextField);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_SetMultiline(TPtxPdfForms_GeneralTextField* pGeneralTextField, BOOL bMultiline);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_GetPassword(TPtxPdfForms_GeneralTextField* pGeneralTextField);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_SetPassword(TPtxPdfForms_GeneralTextField* pGeneralTextField, BOOL bPassword);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_GetDoNotSpellCheck(TPtxPdfForms_GeneralTextField* pGeneralTextField);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotSpellCheck(

    TPtxPdfForms_GeneralTextField* pGeneralTextField, BOOL bDoNotSpellCheck);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_GetDoNotScroll(TPtxPdfForms_GeneralTextField* pGeneralTextField);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_GeneralTextField_SetDoNotScroll(TPtxPdfForms_GeneralTextField* pGeneralTextField, BOOL bDoNotScroll);


/******************************************************************************

 * CombTextField

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_CombTextField* PDFTOOLBOX_CALL

PtxPdfForms_CombTextField_Create(TPtxPdf_Document* pTargetDocument, int iMaxLength);


PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL

PtxPdfForms_CombTextField_GetMaxLength(TPtxPdfForms_CombTextField* pCombTextField);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_CombTextField_SetMaxLength(TPtxPdfForms_CombTextField* pCombTextField, int iMaxLength);


/******************************************************************************

 * CheckBox

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_CheckBox* PDFTOOLBOX_CALL PtxPdfForms_CheckBox_Create(TPtxPdf_Document* pTargetDocument);


PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetCheckedExportNameA(TPtxPdfForms_CheckBox* pCheckBox,

                                                                                    char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetCheckedExportNameW(TPtxPdfForms_CheckBox* pCheckBox,

                                                                                    WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetChecked(TPtxPdfForms_CheckBox* pCheckBox);

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


/******************************************************************************

 * RadioButton

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_Widget* PDFTOOLBOX_CALL PtxPdfForms_RadioButton_AddNewWidget(

    TPtxPdfForms_RadioButton* pRadioButton, const TPtxGeomReal_Rectangle* pBoundingBox);


PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameA(TPtxPdfForms_RadioButton* pRadioButton,

                                                                                char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameW(TPtxPdfForms_RadioButton* pRadioButton,

                                                                                WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList* PDFTOOLBOX_CALL

PtxPdfForms_RadioButton_GetWidgets(TPtxPdfForms_RadioButton* pRadioButton);


/******************************************************************************

 * RadioButtonList

 *****************************************************************************/

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL

PtxPdfForms_RadioButtonList_GetCount(TPtxPdfForms_RadioButtonList* pRadioButtonList);

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton* PDFTOOLBOX_CALL

PtxPdfForms_RadioButtonList_Get(TPtxPdfForms_RadioButtonList* pRadioButtonList, int iIndex);


/******************************************************************************

 * RadioButtonGroup

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButtonGroup* PDFTOOLBOX_CALL

PtxPdfForms_RadioButtonGroup_Create(TPtxPdf_Document* pTargetDocument);

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton* PDFTOOLBOX_CALL

PtxPdfForms_RadioButtonGroup_AddNewButtonA(TPtxPdfForms_RadioButtonGroup* pRadioButtonGroup, const char* szExportName);

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton* PDFTOOLBOX_CALL

PtxPdfForms_RadioButtonGroup_AddNewButtonW(TPtxPdfForms_RadioButtonGroup* pRadioButtonGroup, const WCHAR* szExportName);


PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButtonList* PDFTOOLBOX_CALL

PtxPdfForms_RadioButtonGroup_GetButtons(TPtxPdfForms_RadioButtonGroup* pRadioButtonGroup);

PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton* PDFTOOLBOX_CALL

PtxPdfForms_RadioButtonGroup_GetChosenButton(TPtxPdfForms_RadioButtonGroup* pRadioButtonGroup);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_SetChosenButton(

    TPtxPdfForms_RadioButtonGroup* pRadioButtonGroup, TPtxPdfForms_RadioButton* pChosenButton);


/******************************************************************************

 * ChoiceItem

 *****************************************************************************/

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetDisplayNameA(TPtxPdfForms_ChoiceItem* pChoiceItem,

                                                                                char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetDisplayNameW(TPtxPdfForms_ChoiceItem* pChoiceItem,

                                                                                WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetDisplayNameA(TPtxPdfForms_ChoiceItem* pChoiceItem,

                                                                              const char*              szDisplayName);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetDisplayNameW(TPtxPdfForms_ChoiceItem* pChoiceItem,

                                                                              const WCHAR*             szDisplayName);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetExportNameA(TPtxPdfForms_ChoiceItem* pChoiceItem,

                                                                               char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetExportNameW(TPtxPdfForms_ChoiceItem* pChoiceItem,

                                                                               WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetExportNameA(TPtxPdfForms_ChoiceItem* pChoiceItem,

                                                                             const char*              szExportName);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetExportNameW(TPtxPdfForms_ChoiceItem* pChoiceItem,

                                                                             const WCHAR*             szExportName);


/******************************************************************************

 * ChoiceItemList

 *****************************************************************************/

PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_GetCount(TPtxPdfForms_ChoiceItemList* pChoiceItemList);

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem* PDFTOOLBOX_CALL

PtxPdfForms_ChoiceItemList_Get(TPtxPdfForms_ChoiceItemList* pChoiceItemList, int iIndex);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Add(TPtxPdfForms_ChoiceItemList* pChoiceItemList,

                                                                      TPtxPdfForms_ChoiceItem*     pChoiceItem);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Clear(TPtxPdfForms_ChoiceItemList* pChoiceItemList);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Remove(TPtxPdfForms_ChoiceItemList* pChoiceItemList,

                                                                         int                          iIndex);


/******************************************************************************

 * ChoiceField

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem* PDFTOOLBOX_CALL

PtxPdfForms_ChoiceField_AddNewItemA(TPtxPdfForms_ChoiceField* pChoiceField, const char* szDisplayName);

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem* PDFTOOLBOX_CALL

PtxPdfForms_ChoiceField_AddNewItemW(TPtxPdfForms_ChoiceField* pChoiceField, const WCHAR* szDisplayName);


PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList* PDFTOOLBOX_CALL

PtxPdfForms_ChoiceField_GetItems(TPtxPdfForms_ChoiceField* pChoiceField);


PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceFieldType PDFTOOLBOX_CALL

PtxPdfForms_ChoiceField_GetType(TPtxPdfForms_ChoiceField* pChoiceField);

/******************************************************************************

 * ListBox

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_ListBox* PDFTOOLBOX_CALL PtxPdfForms_ListBox_Create(TPtxPdf_Document* pTargetDocument);


PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_GetAllowMultiSelect(TPtxPdfForms_ListBox* pListBox);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_SetAllowMultiSelect(TPtxPdfForms_ListBox* pListBox,

                                                                               BOOL                  bAllowMultiSelect);

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList* PDFTOOLBOX_CALL

PtxPdfForms_ListBox_GetChosenItems(TPtxPdfForms_ListBox* pListBox);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_GetFontSize(TPtxPdfForms_ListBox* pListBox,

                                                                       double*               pFontSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_SetFontSize(TPtxPdfForms_ListBox* pListBox,

                                                                       const double*         pFontSize);


/******************************************************************************

 * ComboBox

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_ComboBox* PDFTOOLBOX_CALL PtxPdfForms_ComboBox_Create(TPtxPdf_Document* pTargetDocument);


PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetCanEdit(TPtxPdfForms_ComboBox* pComboBox);

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

PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem* PDFTOOLBOX_CALL

PtxPdfForms_ComboBox_GetChosenItem(TPtxPdfForms_ComboBox* pComboBox);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetChosenItem(TPtxPdfForms_ComboBox*   pComboBox,

                                                                          TPtxPdfForms_ChoiceItem* pChosenItem);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetEditableItemNameA(TPtxPdfForms_ComboBox* pComboBox,

                                                                                   char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetEditableItemNameW(TPtxPdfForms_ComboBox* pComboBox,

                                                                                   WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetEditableItemNameA(TPtxPdfForms_ComboBox* pComboBox,

                                                                                 const char* szEditableItemName);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetEditableItemNameW(TPtxPdfForms_ComboBox* pComboBox,

                                                                                 const WCHAR* szEditableItemName);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetFontSize(TPtxPdfForms_ComboBox* pComboBox,

                                                                        double*                pFontSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetFontSize(TPtxPdfForms_ComboBox* pComboBox,

                                                                        const double*          pFontSize);


/******************************************************************************

 * SignatureField

 *****************************************************************************/

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_SignatureField_IsVisible(TPtxPdfForms_SignatureField* pSignatureField);


PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureFieldType PDFTOOLBOX_CALL

PtxPdfForms_SignatureField_GetType(TPtxPdfForms_SignatureField* pSignatureField);

/******************************************************************************

 * SignedSignatureField

 *****************************************************************************/

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetNameA(

    TPtxPdfForms_SignedSignatureField* pSignedSignatureField, char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetNameW(

    TPtxPdfForms_SignedSignatureField* pSignedSignatureField, WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL

PtxPdfForms_SignedSignatureField_GetDate(TPtxPdfForms_SignedSignatureField* pSignedSignatureField, TPtxSys_Date* pDate);


PDFTOOLBOX_EXPORT TPtxPdfForms_SignedSignatureFieldType PDFTOOLBOX_CALL

PtxPdfForms_SignedSignatureField_GetType(TPtxPdfForms_SignedSignatureField* pSignedSignatureField);

/******************************************************************************

 * Signature

 *****************************************************************************/

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetLocationA(TPtxPdfForms_Signature* pSignature,

                                                                            char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetLocationW(TPtxPdfForms_Signature* pSignature,

                                                                            WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetReasonA(TPtxPdfForms_Signature* pSignature,

                                                                          char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetReasonW(TPtxPdfForms_Signature* pSignature,

                                                                          WCHAR* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetContactInfoA(TPtxPdfForms_Signature* pSignature,

                                                                               char* pBuffer, size_t nBufferSize);

PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetContactInfoW(TPtxPdfForms_Signature* pSignature,

                                                                               WCHAR* pBuffer, size_t nBufferSize);


PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureType PDFTOOLBOX_CALL

PtxPdfForms_Signature_GetType(TPtxPdfForms_Signature* pSignature);

/******************************************************************************

 * DocMdpSignature

 *****************************************************************************/

PDFTOOLBOX_EXPORT TPtxPdfForms_MdpPermissions PDFTOOLBOX_CALL

PtxPdfForms_DocMdpSignature_GetPermissions(TPtxPdfForms_DocMdpSignature* pDocMdpSignature);


#ifdef __cplusplus

}

#endif


#endif /* PDFTOOLBOX_PTXPDFFORMS_H__ */

WCHAR
unsigned short WCHAR
Definition PdfToolbox_Platform.h:95

PDFTOOLBOX_EXPORT
#define PDFTOOLBOX_EXPORT
Definition PdfToolbox_Platform.h:143

PtxPdfForms_RadioButtonList_GetCount
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_RadioButtonList_GetCount(TPtxPdfForms_RadioButtonList *pRadioButtonList)
Get the number of elements in the list.

PtxPdfForms_Signature_GetReasonA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetReasonA(TPtxPdfForms_Signature *pSignature, char *pBuffer, size_t nBufferSize)
The reason for signing.

PtxPdfForms_FieldNodeMap_LookupW
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_LookupW(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const WCHAR *szIdentifierPath)
Access a form field by path Lookup the form field node given by the identifier path.

PtxPdfForms_ComboBox_GetFontSize
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetFontSize(TPtxPdfForms_ComboBox *pComboBox, double *pFontSize)
The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.

PDFTOOLBOX_CALL
#define PDFTOOLBOX_CALL
Definition PdfToolbox_PtxPdfForms.h:26

PtxPdfForms_FieldNode_GetExportNameW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameW(TPtxPdfForms_FieldNode *pFieldNode, WCHAR *pBuffer, size_t nBufferSize)
The name used when exporting.

PtxPdfForms_CheckBox_GetCheckedExportNameW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetCheckedExportNameW(TPtxPdfForms_CheckBox *pCheckBox, WCHAR *pBuffer, size_t nBufferSize)
The name of the checked ('on') state used when exporting.

PtxPdfForms_FieldNodeMap_GetCount
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetCount(TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
The number of key-value pairs in the map.

PtxPdfForms_GeneralTextField_SetDoNotScroll
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotScroll(TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bDoNotScroll)
Flags this text field non scrollable.

PtxPdfForms_CombTextField_Create
PDFTOOLBOX_EXPORT TPtxPdfForms_CombTextField *PDFTOOLBOX_CALL PtxPdfForms_CombTextField_Create(TPtxPdf_Document *pTargetDocument, int iMaxLength)
Create a comb text form field The returned form field object is not yet used, but it is associated wi...

PtxPdfForms_GeneralTextField_GetPassword
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetPassword(TPtxPdfForms_GeneralTextField *pGeneralTextField)
Flags this text field as a password entry field.

PtxPdfForms_RadioButtonGroup_GetChosenButton
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetChosenButton(TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup)
This field's selected button if NULL is set, then no button is chosen.

PtxPdfForms_ComboBox_SetCanEdit
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetCanEdit(TPtxPdfForms_ComboBox *pComboBox, BOOL bCanEdit)
Has an editable item.

PtxPdfForms_ComboBox_GetEditableItemNameA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetEditableItemNameA(TPtxPdfForms_ComboBox *pComboBox, char *pBuffer, size_t nBufferSize)
The name of the editable item This property is NULL if any of the combo box items is selected,...

PtxPdfForms_RadioButton_GetWidgets
PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLBOX_CALL PtxPdfForms_RadioButton_GetWidgets(TPtxPdfForms_RadioButton *pRadioButton)
The button's widget annotations.

PtxPdfForms_FieldNodeMap_GetKeyW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetKeyW(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, WCHAR *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.

PtxPdfForms_Widget_SetLocked
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_SetLocked(TPtxPdfForms_Widget *pWidget, BOOL bLocked)
Whether the widget can be modified This does not restrict modification of the widget's content.

PtxPdfForms_ChoiceItem_GetDisplayNameA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetDisplayNameA(TPtxPdfForms_ChoiceItem *pChoiceItem, char *pBuffer, size_t nBufferSize)
Displayed name This is the name of the item as displayed in a PDF viewer.

PtxPdfForms_FieldNodeMap_GetA
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetA(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const char *szKey)
Get the position of a key in the map. If no error occurred, then the position can be used to get the ...

PtxPdfForms_Field_GetType
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldType PDFTOOLBOX_CALL PtxPdfForms_Field_GetType(TPtxPdfForms_Field *pField)
Get actual derived type of base type TPtxPdfForms_Field.

PtxPdfForms_ComboBox_GetCanEdit
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetCanEdit(TPtxPdfForms_ComboBox *pComboBox)
Has an editable item.

PtxPdfForms_Field_GetRequired
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetRequired(TPtxPdfForms_Field *pField)
Flags this field as mandatory.

PtxPdfForms_ListBox_Create
PDFTOOLBOX_EXPORT TPtxPdfForms_ListBox *PDFTOOLBOX_CALL PtxPdfForms_ListBox_Create(TPtxPdf_Document *pTargetDocument)
Create a list box form field The returned form field object is not yet used, but it is associated wit...

PtxPdfForms_ChoiceItemList_Get
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Get(TPtxPdfForms_ChoiceItemList *pChoiceItemList, int iIndex)
Returns the element at the specified position in the given list.

PtxPdfForms_RadioButton_AddNewWidget
PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL PtxPdfForms_RadioButton_AddNewWidget(TPtxPdfForms_RadioButton *pRadioButton, const TPtxGeomReal_Rectangle *pBoundingBox)
Create radio button widget This method creates a widget for the radio button. The widget is automatic...

PtxPdfForms_SignatureFieldList_Get
PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureField *PDFTOOLBOX_CALL PtxPdfForms_SignatureFieldList_Get(TPtxPdfForms_SignatureFieldList *pSignatureFieldList, int iIndex)
Returns the element at the specified position in the given list.

PtxPdfForms_Signature_GetLocationW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetLocationW(TPtxPdfForms_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
The location of signing The CPU host name or physical location of the signing.

PtxPdfForms_CheckBox_GetChecked
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetChecked(TPtxPdfForms_CheckBox *pCheckBox)
The state of the check box.

PtxPdfForms_SubForm_Create
PDFTOOLBOX_EXPORT TPtxPdfForms_SubForm *PDFTOOLBOX_CALL PtxPdfForms_SubForm_Create(TPtxPdf_Document *pTargetDocument)
Create a sub form The returned sub form object is not yet used, but it is associated with the given t...

PtxPdfForms_ListBox_SetAllowMultiSelect
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_SetAllowMultiSelect(TPtxPdfForms_ListBox *pListBox, BOOL bAllowMultiSelect)
Allow multiple items to be selected.

PtxPdfForms_TextField_GetFontSize
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_GetFontSize(TPtxPdfForms_TextField *pTextField, double *pFontSize)
The font size If NULL then the font size is chosen automatically by the PDF viewer.

PtxPdfForms_GeneralTextField_GetMaxLength
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetMaxLength(TPtxPdfForms_GeneralTextField *pGeneralTextField, int *pMaxLength)
The maximal text length When setting this property to a non-null value, the length of this field's te...

PtxPdfForms_TextField_SetAlignment
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetAlignment(TPtxPdfForms_TextField *pTextField, TPtxGeom_HorizontalAlignment iAlignment)
The text alignment.

PtxPdfForms_CombTextField_GetMaxLength
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_CombTextField_GetMaxLength(TPtxPdfForms_CombTextField *pCombTextField)
The maximal text length When setting this property, the length of this field's text is truncated to t...

PtxPdfForms_ChoiceItem_SetExportNameA
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetExportNameA(TPtxPdfForms_ChoiceItem *pChoiceItem, const char *szExportName)
Export name This is the name of the item used when exporting.

PtxPdfForms_TextField_SetFontSize
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetFontSize(TPtxPdfForms_TextField *pTextField, const double *pFontSize)
The font size If NULL then the font size is chosen automatically by the PDF viewer.

PtxPdfForms_FieldNodeMap_GetBegin
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetBegin(TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
Get the position of the first entry in the map.

PtxPdfForms_FieldNode_SetDisplayNameW
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetDisplayNameW(TPtxPdfForms_FieldNode *pFieldNode, const WCHAR *szDisplayName)
User interface name The display name is not directly visible, but a PDF viewer can display this name,...

PtxPdfForms_FieldNode_GetExportNameA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetExportNameA(TPtxPdfForms_FieldNode *pFieldNode, char *pBuffer, size_t nBufferSize)
The name used when exporting.

PtxPdfForms_RadioButton_GetExportNameA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameA(TPtxPdfForms_RadioButton *pRadioButton, char *pBuffer, size_t nBufferSize)
The button's name used when exporting.

PtxPdfForms_RadioButtonGroup_Create
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButtonGroup *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_Create(TPtxPdf_Document *pTargetDocument)
Create a radio button form field The returned form field object is not yet used, but it is associated...

PtxPdfForms_Signature_GetType
PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureType PDFTOOLBOX_CALL PtxPdfForms_Signature_GetType(TPtxPdfForms_Signature *pSignature)
Get actual derived type of base type TPtxPdfForms_Signature.

PtxPdfForms_SignatureField_IsVisible
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_SignatureField_IsVisible(TPtxPdfForms_SignatureField *pSignatureField)
The visibility of the signature field If TRUE, the signature field has a visual appearance on the pag...

PtxPdfForms_ChoiceItem_GetDisplayNameW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetDisplayNameW(TPtxPdfForms_ChoiceItem *pChoiceItem, WCHAR *pBuffer, size_t nBufferSize)
Displayed name This is the name of the item as displayed in a PDF viewer.

PtxPdfForms_GeneralTextField_SetMaxLength
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetMaxLength(TPtxPdfForms_GeneralTextField *pGeneralTextField, const int *pMaxLength)
The maximal text length When setting this property to a non-null value, the length of this field's te...

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

PtxPdfForms_SignatureField_GetType
PDFTOOLBOX_EXPORT TPtxPdfForms_SignatureFieldType PDFTOOLBOX_CALL PtxPdfForms_SignatureField_GetType(TPtxPdfForms_SignatureField *pSignatureField)
Get actual derived type of base type TPtxPdfForms_SignatureField.

PtxPdfForms_FieldNode_SetExportNameA
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameA(TPtxPdfForms_FieldNode *pFieldNode, const char *szExportName)
The name used when exporting.

PtxPdfForms_Field_SetReadOnly
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_SetReadOnly(TPtxPdfForms_Field *pField, BOOL bReadOnly)
Flags this field as read-only.

PtxPdfForms_ChoiceItemList_Add
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Add(TPtxPdfForms_ChoiceItemList *pChoiceItemList, TPtxPdfForms_ChoiceItem *pChoiceItem)
Add an element to the end of the list.

PtxPdfForms_ListBox_SetFontSize
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_SetFontSize(TPtxPdfForms_ListBox *pListBox, const double *pFontSize)
The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.

PtxPdfForms_Field_GetReadOnly
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetReadOnly(TPtxPdfForms_Field *pField)
Flags this field as read-only.

PtxPdfForms_FieldNode_GetDisplayNameW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetDisplayNameW(TPtxPdfForms_FieldNode *pFieldNode, WCHAR *pBuffer, size_t nBufferSize)
User interface name The display name is not directly visible, but a PDF viewer can display this name,...

PtxPdfForms_GeneralTextField_GetDoNotScroll
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotScroll(TPtxPdfForms_GeneralTextField *pGeneralTextField)
Flags this text field non scrollable.

PtxPdfForms_Widget_SetHidden
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_SetHidden(TPtxPdfForms_Widget *pWidget, BOOL bHidden)
The widget's visibility If TRUE then the widget is present, but is invisible and not available for us...

PtxPdfForms_FieldNode_SetDisplayNameA
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetDisplayNameA(TPtxPdfForms_FieldNode *pFieldNode, const char *szDisplayName)
User interface name The display name is not directly visible, but a PDF viewer can display this name,...

PtxPdfForms_CheckBox_GetCheckedExportNameA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_CheckBox_GetCheckedExportNameA(TPtxPdfForms_CheckBox *pCheckBox, char *pBuffer, size_t nBufferSize)
The name of the checked ('on') state used when exporting.

PtxPdfForms_WidgetList_Add
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_WidgetList_Add(TPtxPdfForms_WidgetList *pWidgetList, TPtxPdfForms_Widget *pWidget)
Add an element to the end of the list.

PtxPdfForms_ComboBox_SetFontSize
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetFontSize(TPtxPdfForms_ComboBox *pComboBox, const double *pFontSize)
The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.

PtxPdfForms_TextField_SetTextA
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetTextA(TPtxPdfForms_TextField *pTextField, const char *szText)
This field's text.

PtxPdfForms_ChoiceItem_SetDisplayNameA
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetDisplayNameA(TPtxPdfForms_ChoiceItem *pChoiceItem, const char *szDisplayName)
Displayed name This is the name of the item as displayed in a PDF viewer.

PtxPdfForms_FieldNodeMap_GetSize
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetSize(TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
The number of key-value pairs in the map.

PtxPdfForms_ChoiceItem_GetExportNameA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetExportNameA(TPtxPdfForms_ChoiceItem *pChoiceItem, char *pBuffer, size_t nBufferSize)
Export name This is the name of the item used when exporting.

PtxPdfForms_SignedSignatureField_GetNameW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetNameW(TPtxPdfForms_SignedSignatureField *pSignedSignatureField, WCHAR *pBuffer, size_t nBufferSize)
The name of the person or authority that signed the document.

PtxPdfForms_Widget_GetNoPrint
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetNoPrint(TPtxPdfForms_Widget *pWidget)
The widget's visibility when printing If TRUE then the widget is not present in a print output of the...

PtxPdfForms_FieldNodeMap_GetNext
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetNext(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it)
Get the position of the next entry in the map.

PtxPdfForms_FieldNodeMap_GetEnd
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetEnd(TPtxPdfForms_FieldNodeMap *pFieldNodeMap)
Get the end position of the map.

PtxPdfForms_TextField_GetTextA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_TextField_GetTextA(TPtxPdfForms_TextField *pTextField, char *pBuffer, size_t nBufferSize)
This field's text.

PtxPdfForms_ComboBox_SetEditableItemNameW
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetEditableItemNameW(TPtxPdfForms_ComboBox *pComboBox, const WCHAR *szEditableItemName)
The name of the editable item This property is NULL if any of the combo box items is selected,...

PtxPdfForms_Widget_GetBoundingBox
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetBoundingBox(TPtxPdfForms_Widget *pWidget, TPtxGeomReal_Rectangle *pBoundingBox)
The location on the page.

PtxPdfForms_ComboBox_GetChosenItem
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItem *PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetChosenItem(TPtxPdfForms_ComboBox *pComboBox)
The selected combo box item If this property is NULL then the PtxPdfForms_ComboBox_GetEditableItemNam...

PtxPdfForms_FieldNodeMap_GetKeyA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetKeyA(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, char *pBuffer, size_t nBufferSize)
Get the key of the entry given a position.

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

PtxPdfForms_CombTextField_SetMaxLength
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_CombTextField_SetMaxLength(TPtxPdfForms_CombTextField *pCombTextField, int iMaxLength)
The maximal text length When setting this property, the length of this field's text is truncated to t...

PtxPdfForms_FieldNode_SetExportNameW
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNode_SetExportNameW(TPtxPdfForms_FieldNode *pFieldNode, const WCHAR *szExportName)
The name used when exporting.

PtxPdfForms_FieldNode_Copy
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL PtxPdfForms_FieldNode_Copy(TPtxPdf_Document *pTargetDocument, TPtxPdfForms_FieldNode *pFieldNode)
Copy a form field node Copy a form field node object from an input document to the given pTargetDocum...

PtxPdfForms_WidgetList_Get
PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL PtxPdfForms_WidgetList_Get(TPtxPdfForms_WidgetList *pWidgetList, int iIndex)
Returns the element at the specified position in the given list.

PtxPdfForms_ChoiceItemList_Clear
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Clear(TPtxPdfForms_ChoiceItemList *pChoiceItemList)
Clear list.

PtxPdfForms_GeneralTextField_Create
PDFTOOLBOX_EXPORT TPtxPdfForms_GeneralTextField *PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_Create(TPtxPdf_Document *pTargetDocument)
Create a general text form field The returned form field object is not yet used, but it is associated...

PtxPdfForms_Field_GetWidgets
PDFTOOLBOX_EXPORT TPtxPdfForms_WidgetList *PDFTOOLBOX_CALL PtxPdfForms_Field_GetWidgets(TPtxPdfForms_Field *pField)
This form field's widget annotations.

PtxPdfForms_ChoiceField_GetType
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceFieldType PDFTOOLBOX_CALL PtxPdfForms_ChoiceField_GetType(TPtxPdfForms_ChoiceField *pChoiceField)
Get actual derived type of base type TPtxPdfForms_ChoiceField.

PtxPdfForms_ListBox_GetAllowMultiSelect
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_GetAllowMultiSelect(TPtxPdfForms_ListBox *pListBox)
Allow multiple items to be selected.

PtxPdfForms_ListBox_GetChosenItems
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLBOX_CALL PtxPdfForms_ListBox_GetChosenItems(TPtxPdfForms_ListBox *pListBox)
The selected choice items.

PtxPdfForms_Field_AddNewWidget
PDFTOOLBOX_EXPORT TPtxPdfForms_Widget *PDFTOOLBOX_CALL PtxPdfForms_Field_AddNewWidget(TPtxPdfForms_Field *pField, const TPtxGeomReal_Rectangle *pBoundingBox)
Create a new widget and add to the form field This method creates a widget for the form field....

PtxPdfForms_ComboBox_GetEditableItemNameW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ComboBox_GetEditableItemNameW(TPtxPdfForms_ComboBox *pComboBox, WCHAR *pBuffer, size_t nBufferSize)
The name of the editable item This property is NULL if any of the combo box items is selected,...

PtxPdfForms_SignedSignatureField_GetDate
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetDate(TPtxPdfForms_SignedSignatureField *pSignedSignatureField, TPtxSys_Date *pDate)
The date and time of signing.

PtxPdfForms_FieldNodeMap_SetA
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetA(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const char *szKey, TPtxPdfForms_FieldNode *pValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...

PtxPdfForms_TextField_GetAlignment
PDFTOOLBOX_EXPORT TPtxGeom_HorizontalAlignment PDFTOOLBOX_CALL PtxPdfForms_TextField_GetAlignment(TPtxPdfForms_TextField *pTextField)
The text alignment.

PtxPdfForms_ComboBox_SetEditableItemNameA
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetEditableItemNameA(TPtxPdfForms_ComboBox *pComboBox, const char *szEditableItemName)
The name of the editable item This property is NULL if any of the combo box items is selected,...

PtxPdfForms_GeneralTextField_GetMultiline
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetMultiline(TPtxPdfForms_GeneralTextField *pGeneralTextField)
Flags this text field as multi-line.

PtxPdfForms_ChoiceItem_SetExportNameW
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetExportNameW(TPtxPdfForms_ChoiceItem *pChoiceItem, const WCHAR *szExportName)
Export name This is the name of the item used when exporting.

PtxPdfForms_SignatureFieldList_GetCount
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_SignatureFieldList_GetCount(TPtxPdfForms_SignatureFieldList *pSignatureFieldList)
Get the number of elements in the list.

PtxPdfForms_SignedSignatureField_GetNameA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetNameA(TPtxPdfForms_SignedSignatureField *pSignedSignatureField, char *pBuffer, size_t nBufferSize)
The name of the person or authority that signed the document.

PtxPdfForms_FieldNodeMap_LookupA
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_LookupA(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const char *szIdentifierPath)
Access a form field by path Lookup the form field node given by the identifier path.

PtxPdfForms_TextField_GetTextW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_TextField_GetTextW(TPtxPdfForms_TextField *pTextField, WCHAR *pBuffer, size_t nBufferSize)
This field's text.

PtxPdfForms_ListBox_GetFontSize
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ListBox_GetFontSize(TPtxPdfForms_ListBox *pListBox, double *pFontSize)
The font size If NULL or 0, then the font size is chosen automatically by the PDF processor.

PtxPdfForms_Field_GetDoNotExport
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_GetDoNotExport(TPtxPdfForms_Field *pField)
Tells whether this field is exported.

PtxPdfForms_Signature_GetReasonW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetReasonW(TPtxPdfForms_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
The reason for signing.

PtxPdfForms_RadioButtonGroup_GetButtons
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButtonList *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_GetButtons(TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup)
This field's buttons.

PtxPdfForms_FieldNode_GetType
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeType PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetType(TPtxPdfForms_FieldNode *pFieldNode)
Get actual derived type of base type TPtxPdfForms_FieldNode.

PtxPdfForms_CheckBox_Create
PDFTOOLBOX_EXPORT TPtxPdfForms_CheckBox *PDFTOOLBOX_CALL PtxPdfForms_CheckBox_Create(TPtxPdf_Document *pTargetDocument)
Create a check box form field The returned form field object is not yet used, but it is associated wi...

PtxPdfForms_Signature_GetLocationA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetLocationA(TPtxPdfForms_Signature *pSignature, char *pBuffer, size_t nBufferSize)
The location of signing The CPU host name or physical location of the signing.

PtxPdfForms_Widget_GetLocked
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetLocked(TPtxPdfForms_Widget *pWidget)
Whether the widget can be modified This does not restrict modification of the widget's content.

PtxPdfForms_SignedSignatureField_GetType
PDFTOOLBOX_EXPORT TPtxPdfForms_SignedSignatureFieldType PDFTOOLBOX_CALL PtxPdfForms_SignedSignatureField_GetType(TPtxPdfForms_SignedSignatureField *pSignedSignatureField)
Get actual derived type of base type TPtxPdfForms_SignedSignatureField.

PtxPdfForms_GeneralTextField_GetDoNotSpellCheck
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_GetDoNotSpellCheck(TPtxPdfForms_GeneralTextField *pGeneralTextField)
Flags this text field for prevention from spell checking.

PtxPdfForms_ChoiceItemList_Remove
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_Remove(TPtxPdfForms_ChoiceItemList *pChoiceItemList, int iIndex)
Remove certain element from list.

PtxPdfForms_ComboBox_Create
PDFTOOLBOX_EXPORT TPtxPdfForms_ComboBox *PDFTOOLBOX_CALL PtxPdfForms_ComboBox_Create(TPtxPdf_Document *pTargetDocument)
Create a combo box form field The returned form field object is not yet used, but it is associated wi...

PtxPdfForms_Field_SetRequired
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_SetRequired(TPtxPdfForms_Field *pField, BOOL bRequired)
Flags this field as mandatory.

PtxPdfForms_RadioButton_GetExportNameW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_RadioButton_GetExportNameW(TPtxPdfForms_RadioButton *pRadioButton, WCHAR *pBuffer, size_t nBufferSize)
The button's name used when exporting.

PtxPdfForms_FieldNode_GetDisplayNameA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_FieldNode_GetDisplayNameA(TPtxPdfForms_FieldNode *pFieldNode, char *pBuffer, size_t nBufferSize)
User interface name The display name is not directly visible, but a PDF viewer can display this name,...

PtxPdfForms_FieldNodeMap_GetValue
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNode *PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetValue(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it)
Get the value of the entry given a position.

PtxPdfForms_ChoiceItemList_GetCount
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_ChoiceItemList_GetCount(TPtxPdfForms_ChoiceItemList *pChoiceItemList)
Get the number of elements in the list.

PtxPdfForms_SubForm_GetChildren
PDFTOOLBOX_EXPORT TPtxPdfForms_FieldNodeMap *PDFTOOLBOX_CALL PtxPdfForms_SubForm_GetChildren(TPtxPdfForms_SubForm *pSubForm)
The child form fields Adding to this list results in an error:

PtxPdfForms_TextField_GetType
PDFTOOLBOX_EXPORT TPtxPdfForms_TextFieldType PDFTOOLBOX_CALL PtxPdfForms_TextField_GetType(TPtxPdfForms_TextField *pTextField)
Get actual derived type of base type TPtxPdfForms_TextField.

PtxPdfForms_RadioButtonGroup_SetChosenButton
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_SetChosenButton(TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup, TPtxPdfForms_RadioButton *pChosenButton)
This field's selected button if NULL is set, then no button is chosen.

PtxPdfForms_GeneralTextField_SetMultiline
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetMultiline(TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bMultiline)
Flags this text field as multi-line.

PtxPdfForms_ChoiceItem_SetDisplayNameW
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_SetDisplayNameW(TPtxPdfForms_ChoiceItem *pChoiceItem, const WCHAR *szDisplayName)
Displayed name This is the name of the item as displayed in a PDF viewer.

PtxPdfForms_CheckBox_SetChecked
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_CheckBox_SetChecked(TPtxPdfForms_CheckBox *pCheckBox, BOOL bChecked)
The state of the check box.

PtxPdfForms_RadioButtonGroup_AddNewButtonW
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_AddNewButtonW(TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup, const WCHAR *szExportName)
Create a radio button The created radio button is automatically added to this radio button field's Pt...

PtxPdfForms_GeneralTextField_SetPassword
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetPassword(TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bPassword)
Flags this text field as a password entry field.

PtxPdfForms_ChoiceItem_GetExportNameW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_ChoiceItem_GetExportNameW(TPtxPdfForms_ChoiceItem *pChoiceItem, WCHAR *pBuffer, size_t nBufferSize)
Export name This is the name of the item used when exporting.

PtxPdfForms_GeneralTextField_SetDoNotSpellCheck
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_GeneralTextField_SetDoNotSpellCheck(TPtxPdfForms_GeneralTextField *pGeneralTextField, BOOL bDoNotSpellCheck)
Flags this text field for prevention from spell checking.

PtxPdfForms_Signature_GetContactInfoA
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetContactInfoA(TPtxPdfForms_Signature *pSignature, char *pBuffer, size_t nBufferSize)
The contact information of the signer Information provided by the signer to enable a recipient to con...

PtxPdfForms_Widget_GetHidden
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Widget_GetHidden(TPtxPdfForms_Widget *pWidget)
The widget's visibility If TRUE then the widget is present, but is invisible and not available for us...

PtxPdfForms_TextField_SetTextW
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_TextField_SetTextW(TPtxPdfForms_TextField *pTextField, const WCHAR *szText)
This field's text.

PtxPdfForms_Signature_GetContactInfoW
PDFTOOLBOX_EXPORT size_t PDFTOOLBOX_CALL PtxPdfForms_Signature_GetContactInfoW(TPtxPdfForms_Signature *pSignature, WCHAR *pBuffer, size_t nBufferSize)
The contact information of the signer Information provided by the signer to enable a recipient to con...

PtxPdfForms_WidgetList_GetCount
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_WidgetList_GetCount(TPtxPdfForms_WidgetList *pWidgetList)
Get the number of elements in the list.

PtxPdfForms_ChoiceField_GetItems
PDFTOOLBOX_EXPORT TPtxPdfForms_ChoiceItemList *PDFTOOLBOX_CALL PtxPdfForms_ChoiceField_GetItems(TPtxPdfForms_ChoiceField *pChoiceField)
The list of choice items Adding or removing items or clearing the list is not supported.

PtxPdfForms_RadioButtonList_Get
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonList_Get(TPtxPdfForms_RadioButtonList *pRadioButtonList, int iIndex)
Returns the element at the specified position in the given list.

PtxPdfForms_RadioButtonGroup_AddNewButtonA
PDFTOOLBOX_EXPORT TPtxPdfForms_RadioButton *PDFTOOLBOX_CALL PtxPdfForms_RadioButtonGroup_AddNewButtonA(TPtxPdfForms_RadioButtonGroup *pRadioButtonGroup, const char *szExportName)
Create a radio button The created radio button is automatically added to this radio button field's Pt...

PtxPdfForms_DocMdpSignature_GetPermissions
PDFTOOLBOX_EXPORT TPtxPdfForms_MdpPermissions PDFTOOLBOX_CALL PtxPdfForms_DocMdpSignature_GetPermissions(TPtxPdfForms_DocMdpSignature *pDocMdpSignature)
The access permissions granted for this document Note that for encrypted PDF documents,...

PtxPdfForms_FieldNodeMap_GetW
PDFTOOLBOX_EXPORT int PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_GetW(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const WCHAR *szKey)
Get the position of a key in the map. If no error occurred, then the position can be used to get the ...

PtxPdfForms_Field_SetDoNotExport
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_Field_SetDoNotExport(TPtxPdfForms_Field *pField, BOOL bDoNotExport)
Tells whether this field is exported.

PtxPdfForms_ComboBox_SetChosenItem
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_ComboBox_SetChosenItem(TPtxPdfForms_ComboBox *pComboBox, TPtxPdfForms_ChoiceItem *pChosenItem)
The selected combo box item If this property is NULL then the PtxPdfForms_ComboBox_GetEditableItemNam...

PtxPdfForms_FieldNodeMap_SetValue
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetValue(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, int it, TPtxPdfForms_FieldNode *pValue)
Set the value of the entry at a position in the map.

PtxPdfForms_FieldNodeMap_SetW
PDFTOOLBOX_EXPORT BOOL PDFTOOLBOX_CALL PtxPdfForms_FieldNodeMap_SetW(TPtxPdfForms_FieldNodeMap *pFieldNodeMap, const WCHAR *szKey, TPtxPdfForms_FieldNode *pValue)
Set the value of an entry for a given key. This operation invalidates all positions previously return...

PdfToolbox_PtxSys.h

PdfToolbox_Types.h

TPtxPdfForms_SignedSignatureFieldType
TPtxPdfForms_SignedSignatureFieldType
Type and subtype enumeration of TPtxPdfForms_SignedSignatureField.
Definition PdfToolbox_Types.h:1059

TPtxPdfForms_ChoiceFieldType
TPtxPdfForms_ChoiceFieldType
Type and subtype enumeration of TPtxPdfForms_ChoiceField.
Definition PdfToolbox_Types.h:1010

TPtxPdfForms_FieldNodeType
TPtxPdfForms_FieldNodeType
Type and subtype enumeration of TPtxPdfForms_FieldNode.
Definition PdfToolbox_Types.h:928

TPtxPdfForms_TextFieldType
TPtxPdfForms_TextFieldType
Type and subtype enumeration of TPtxPdfForms_TextField.
Definition PdfToolbox_Types.h:988

TPtxPdfForms_SignatureFieldType
TPtxPdfForms_SignatureFieldType
Type and subtype enumeration of TPtxPdfForms_SignatureField.
Definition PdfToolbox_Types.h:1033

TPtxPdfForms_MdpPermissions
TPtxPdfForms_MdpPermissions
Definition PdfToolbox_Types.h:654

TPtxGeom_HorizontalAlignment
TPtxGeom_HorizontalAlignment
Definition PdfToolbox_Types.h:79

TPtxPdfForms_FieldType
TPtxPdfForms_FieldType
Type and subtype enumeration of TPtxPdfForms_Field.
Definition PdfToolbox_Types.h:959

TPtxPdfForms_SignatureType
TPtxPdfForms_SignatureType
Type and subtype enumeration of TPtxPdfForms_Signature.
Definition PdfToolbox_Types.h:1083

BOOL
#define BOOL
Definition PdfToolbox_Types.h:23

TPtxPdf_Document

TPtxPdfForms_CheckBox
A check box field.

TPtxPdfForms_ChoiceField
A choice field.

TPtxPdfForms_ChoiceItem
An item in a list box field or combo box field.

TPtxPdfForms_ChoiceItemList

TPtxPdfForms_CombTextField
A fixed pitch text field In a comb text field, the PtxPdfForms_GeneralTextField_GetMaxLength must be ...

TPtxPdfForms_ComboBox
A combo box field.

TPtxPdfForms_DocMdpSignature
A Document Modification Detection and Prevention (MDP) signature that certifies the document This typ...

TPtxPdfForms_Field
A form field.

TPtxPdfForms_FieldNode
Base class for form fields and sub forms.

TPtxPdfForms_FieldNodeMap

TPtxPdfForms_GeneralTextField
A general text field.

TPtxPdfForms_ListBox
A list box field.

TPtxPdfForms_RadioButtonGroup
A radio button field.

TPtxPdfForms_RadioButton
A button in a radio button group.

TPtxPdfForms_RadioButtonList

TPtxPdfForms_SignatureField
A digital signature field.

TPtxPdfForms_SignatureFieldList

TPtxPdfForms_Signature
A base class for certain signature types.

TPtxPdfForms_SignedSignatureField
A base class for signature fields that have been signed The existence of a signed signature field doe...

TPtxPdfForms_SubForm
A form field that contains other fields.

TPtxPdfForms_TextField
A text field.

TPtxPdfForms_Widget
A form field widget.

TPtxPdfForms_WidgetList

TPtxGeomReal_Rectangle
Definition PdfToolbox_Types.h:2003

TPtxSys_Date
Definition PdfToolbox_Types.h:2142