PDFForm Class

Properties   Methods   Events   Config Settings   Errors  

The PDFForm class offers PDF form management capabilities.

Syntax

PDFForm

Remarks

The PDF specification defines seven interactive form field types:

• Button
• Check box
• Radio button
• Text box
• List box
• Combo box
• Signature

To begin, provide the input document as a file (InputFile), byte array (InputData), or stream (SetInputStream) and call the Open method. This method will populate the Fields properties with the existing form fields in the document. When finished editing the form, call the Close method to close the document and save the changes to either OutputFile, OutputData, or the stream set in SetOutputStream.

Adding and Modifying Form Fields

PDFForm includes three additional methods that allow you to customize the form field before it is created. The SetPage and SetPosition methods can be used to specify the form field's location (the page on which it will be added and its position on the page, respectively). If SetPage is not explicitly called, the field will be placed on the first page of the document by default. The SetFont method can also be used to configure font properties (name, size, style, and color) for form fields that contain text.

Button Fields

A button (also known as pushbutton) field is a button on the form that simply responds as soon as it is clicked. Because of this, it is the only form field that does not retain a permanent value. Use the AddButton method to add a button field:

C#
 Copy
int buttonIdx = form.AddButton("button", "Press Me");

The action associated with a button field can be updated to perform specific tasks, such as displaying an alert or triggering a script. The example below assigns a JavaScript action to display an alert message when the button is clicked.

C#
 Copy
form.Fields[buttonIdx].Action = "app.alert('Hello! This is a simple alert message.');";

Check Box Fields

A check box represents a form field that can be toggled between two states: on and off. Use the AddCheckBox method to add a check box field:

C#
 Copy
int checkBoxIdx = form.AddCheckBox("checkbox", false);

The value associated with a check box field determines whether it will be toggled on or off. The example below toggles the check box on.

C#
 Copy
form.Fields[checkBoxIdx].Value = "true";

Radio Button Fields

Radio button fields are a set of related buttons, each of which - just like check boxes - can be in one of two states: on or off. Radio buttons belong to a radio group in which at most one button in the group may be in the on state at a time. Use the AddRadioButton method to add a radio button field:

C#
 Copy
int radioButtonIdx = form.AddRadioButton("radioGroup", "radiobutton", false);
int radioButton2Idx = form.AddRadioButton("radioGroup", "radiobutton2", true);

A radio button field can be modified to change its state. The example below selects the first radio button, switching it on, which automatically deselects the other radio button in the same group, switching it off.

C#
 Copy
form.Fields[radioButtonIdx].Value = "true";

Text Box Fields

A text box field is box or space that allows the user to enter and edit text in a designated area on the form. It can contain default text and can also be configured as a password field to mask the input. Use the AddTextBox method to add a text box field:

C#
 Copy
int textBoxIdx = form.AddTextBox("textbox", "Enter your name here", false);

As shown in the example below, the value of a text box field can be modified to fill it with the desired text.

C#
 Copy
form.Fields[textBoxIdx].Value = "My name is John Doe";

List Box Fields

A list box field is a scrollable choice field that displays a list of selectable text items the user can choose from. Use the AddListBox method to add a list box field:

C#
 Copy
int listBoxIdx = form.AddListBox("numbers", "One\r\nTwo\r\nThree", "One");

A list box field can be modified to select one of the options. The example below updates the list box field to select the option "Three".

C#
 Copy
form.Fields[listBoxIdx].Value = "Three";

Combo Box Fields

A combo box field is a choice field that consists of a drop-down list of text items the user can choose from. At most one item may be selected at a time. Compared to list box fields, combo box fields include an editable text box that allows the user to enter a custom value in addition to the predefined options. Use the AddComboBox method to add a combo box field:

C#
 Copy
int comboBoxIdx = form.AddComboBox("colors", "Red\r\nGreen\r\nBlue", "Red");

A combo box field can be modified to select one of the options. The example below updates the combo box field to select the option "Blue".

C#
 Copy
form.Fields[comboBoxIdx].Value = "Blue";

Removing Form Fields

RemoveField removes a form field identified by its index, whereas RemoveFieldByName removes a field by using its name.

C#
 Copy
form.RemoveField(buttonIdx);
form.RemoveFieldByName("checkbox");

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

DecryptionCert Property (PDFForm Class)

The decryption certificate.

Syntax

• C++
• C
• Qt

SecurePDFCertificate* GetDecryptionCert();
int SetDecryptionCert(SecurePDFCertificate* val);

char* securepdf_pdfform_getdecryptioncerteffectivedate(void* lpObj);

char* securepdf_pdfform_getdecryptioncertexpirationdate(void* lpObj);

char* securepdf_pdfform_getdecryptioncertextendedkeyusage(void* lpObj);

char* securepdf_pdfform_getdecryptioncertfingerprint(void* lpObj);

char* securepdf_pdfform_getdecryptioncertfingerprintsha1(void* lpObj);

char* securepdf_pdfform_getdecryptioncertfingerprintsha256(void* lpObj);

char* securepdf_pdfform_getdecryptioncertissuer(void* lpObj);

char* securepdf_pdfform_getdecryptioncertprivatekey(void* lpObj);

int securepdf_pdfform_getdecryptioncertprivatekeyavailable(void* lpObj);

char* securepdf_pdfform_getdecryptioncertprivatekeycontainer(void* lpObj);

char* securepdf_pdfform_getdecryptioncertpublickey(void* lpObj);

char* securepdf_pdfform_getdecryptioncertpublickeyalgorithm(void* lpObj);

int securepdf_pdfform_getdecryptioncertpublickeylength(void* lpObj);

char* securepdf_pdfform_getdecryptioncertserialnumber(void* lpObj);

char* securepdf_pdfform_getdecryptioncertsignaturealgorithm(void* lpObj);

int securepdf_pdfform_getdecryptioncertstore(void* lpObj, char** lpDecryptionCertStore, int* lenDecryptionCertStore);
int securepdf_pdfform_setdecryptioncertstore(void* lpObj, const char* lpDecryptionCertStore, int lenDecryptionCertStore);

char* securepdf_pdfform_getdecryptioncertstorepassword(void* lpObj);
int securepdf_pdfform_setdecryptioncertstorepassword(void* lpObj, const char* lpszDecryptionCertStorePassword);

int securepdf_pdfform_getdecryptioncertstoretype(void* lpObj);
int securepdf_pdfform_setdecryptioncertstoretype(void* lpObj, int iDecryptionCertStoreType);

char* securepdf_pdfform_getdecryptioncertsubjectaltnames(void* lpObj);

char* securepdf_pdfform_getdecryptioncertthumbprintmd5(void* lpObj);

char* securepdf_pdfform_getdecryptioncertthumbprintsha1(void* lpObj);

char* securepdf_pdfform_getdecryptioncertthumbprintsha256(void* lpObj);

char* securepdf_pdfform_getdecryptioncertusage(void* lpObj);

int securepdf_pdfform_getdecryptioncertusageflags(void* lpObj);

char* securepdf_pdfform_getdecryptioncertversion(void* lpObj);

char* securepdf_pdfform_getdecryptioncertsubject(void* lpObj);
int securepdf_pdfform_setdecryptioncertsubject(void* lpObj, const char* lpszDecryptionCertSubject);

int securepdf_pdfform_getdecryptioncertencoded(void* lpObj, char** lpDecryptionCertEncoded, int* lenDecryptionCertEncoded);
int securepdf_pdfform_setdecryptioncertencoded(void* lpObj, const char* lpDecryptionCertEncoded, int lenDecryptionCertEncoded);

QString GetDecryptionCertEffectiveDate();

QString GetDecryptionCertExpirationDate();

QString GetDecryptionCertExtendedKeyUsage();

QString GetDecryptionCertFingerprint();

QString GetDecryptionCertFingerprintSHA1();

QString GetDecryptionCertFingerprintSHA256();

QString GetDecryptionCertIssuer();

QString GetDecryptionCertPrivateKey();

bool GetDecryptionCertPrivateKeyAvailable();

QString GetDecryptionCertPrivateKeyContainer();

QString GetDecryptionCertPublicKey();

QString GetDecryptionCertPublicKeyAlgorithm();

int GetDecryptionCertPublicKeyLength();

QString GetDecryptionCertSerialNumber();

QString GetDecryptionCertSignatureAlgorithm();

QByteArray GetDecryptionCertStore();
int SetDecryptionCertStore(QByteArray qbaDecryptionCertStore);

QString GetDecryptionCertStorePassword();
int SetDecryptionCertStorePassword(QString qsDecryptionCertStorePassword);

int GetDecryptionCertStoreType();
int SetDecryptionCertStoreType(int iDecryptionCertStoreType);

QString GetDecryptionCertSubjectAltNames();

QString GetDecryptionCertThumbprintMD5();

QString GetDecryptionCertThumbprintSHA1();

QString GetDecryptionCertThumbprintSHA256();

QString GetDecryptionCertUsage();

int GetDecryptionCertUsageFlags();

QString GetDecryptionCertVersion();

QString GetDecryptionCertSubject();
int SetDecryptionCertSubject(QString qsDecryptionCertSubject);

QByteArray GetDecryptionCertEncoded();
int SetDecryptionCertEncoded(QByteArray qbaDecryptionCertEncoded);

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

This property is not available at design time.

Data Type

SecurePDFCertificate

Fields Property (PDFForm Class)

The entire collection of form fields contained in the PDF document.

Syntax

• C++
• C
• Qt

SecurePDFList<SecurePDFPDFField>* GetFields();

int securepdf_pdfform_getfieldcount(void* lpObj);

char* securepdf_pdfform_getfieldaction(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldaction(void* lpObj, int fieldindex, const char* lpszFieldAction);

char* securepdf_pdfform_getfieldaltname(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldaltname(void* lpObj, int fieldindex, const char* lpszFieldAltName);

char* securepdf_pdfform_getfieldcaption(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldcaption(void* lpObj, int fieldindex, const char* lpszFieldCaption);

char* securepdf_pdfform_getfielddefaultvalue(void* lpObj, int fieldindex);
int securepdf_pdfform_setfielddefaultvalue(void* lpObj, int fieldindex, const char* lpszFieldDefaultValue);

char* securepdf_pdfform_getfieldname(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldname(void* lpObj, int fieldindex, const char* lpszFieldName);

int securepdf_pdfform_getfieldtype(void* lpObj, int fieldindex);

char* securepdf_pdfform_getfieldfullname(void* lpObj, int fieldindex);

char* securepdf_pdfform_getfieldheight(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldheight(void* lpObj, int fieldindex, const char* lpszFieldHeight);

int securepdf_pdfform_getfieldmaxlen(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldmaxlen(void* lpObj, int fieldindex, int iFieldMaxLen);

char* securepdf_pdfform_getfieldoffsetx(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldoffsetx(void* lpObj, int fieldindex, const char* lpszFieldOffsetX);

char* securepdf_pdfform_getfieldoffsety(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldoffsety(void* lpObj, int fieldindex, const char* lpszFieldOffsetY);

char* securepdf_pdfform_getfieldoptions(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldoptions(void* lpObj, int fieldindex, const char* lpszFieldOptions);

int securepdf_pdfform_getfieldpageindex(void* lpObj, int fieldindex);

int securepdf_pdfform_getfieldterminal(void* lpObj, int fieldindex);

char* securepdf_pdfform_getfieldvalue(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldvalue(void* lpObj, int fieldindex, const char* lpszFieldValue);

int securepdf_pdfform_getfieldvisible(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldvisible(void* lpObj, int fieldindex, int bFieldVisible);

char* securepdf_pdfform_getfieldwidth(void* lpObj, int fieldindex);
int securepdf_pdfform_setfieldwidth(void* lpObj, int fieldindex, const char* lpszFieldWidth);

int GetFieldCount();

QString GetFieldAction(int iFieldIndex);
int SetFieldAction(int iFieldIndex, QString qsFieldAction);

QString GetFieldAltName(int iFieldIndex);
int SetFieldAltName(int iFieldIndex, QString qsFieldAltName);

QString GetFieldCaption(int iFieldIndex);
int SetFieldCaption(int iFieldIndex, QString qsFieldCaption);

QString GetFieldDefaultValue(int iFieldIndex);
int SetFieldDefaultValue(int iFieldIndex, QString qsFieldDefaultValue);

QString GetFieldName(int iFieldIndex);
int SetFieldName(int iFieldIndex, QString qsFieldName);

int GetFieldType(int iFieldIndex);

QString GetFieldFullName(int iFieldIndex);

QString GetFieldHeight(int iFieldIndex);
int SetFieldHeight(int iFieldIndex, QString qsFieldHeight);

int GetFieldMaxLen(int iFieldIndex);
int SetFieldMaxLen(int iFieldIndex, int iFieldMaxLen);

QString GetFieldOffsetX(int iFieldIndex);
int SetFieldOffsetX(int iFieldIndex, QString qsFieldOffsetX);

QString GetFieldOffsetY(int iFieldIndex);
int SetFieldOffsetY(int iFieldIndex, QString qsFieldOffsetY);

QString GetFieldOptions(int iFieldIndex);
int SetFieldOptions(int iFieldIndex, QString qsFieldOptions);

int GetFieldPageIndex(int iFieldIndex);

bool GetFieldTerminal(int iFieldIndex);

QString GetFieldValue(int iFieldIndex);
int SetFieldValue(int iFieldIndex, QString qsFieldValue);

bool GetFieldVisible(int iFieldIndex);
int SetFieldVisible(int iFieldIndex, bool bFieldVisible);

QString GetFieldWidth(int iFieldIndex);
int SetFieldWidth(int iFieldIndex, QString qsFieldWidth);

Remarks

This property is used to access individual form fields within the document.

The PDF specification allows for an advanced, tree-like structure of the form fields, with each field residing within that tree. Much like in the object-oriented approach, form fields inherit properties from the fields that are their immediate parents in the tree. The leaf fields, called "terminal" by the specification, are the actual fields available for filling in and submitting. The fields occupying intermediate tree nodes are abstract and are only there to define a set of their descendant fields.

The PDFForm class flattens the tree structure, presenting the fields as one linear list. The following mechanisms can be used to navigate the tree:

• Use the Terminal property to find out if the field is terminal/leaf and can be filled in.
• The FullName property contains the full name of the field in dotted format (parent.intermediate.child). Remove the last element from the name to obtain the name of the parent field (parent.intermediate in this case).
• Use the FindField method to easily locate the field in the Fields properties.

This property is read-only and not available at design time.

Data Type

SecurePDFPDFField

Font Property (PDFForm Class)

The currently set font.

Syntax

• C++
• C
• Qt

SecurePDFPDFFont* GetFont();

char* securepdf_pdfform_getfontcolor(void* lpObj);

char* securepdf_pdfform_getfontname(void* lpObj);

char* securepdf_pdfform_getfontsize(void* lpObj);

char* securepdf_pdfform_getfontstyle(void* lpObj);

QString GetFontColor();

QString GetFontName();

QString GetFontSize();

QString GetFontStyle();

Remarks

This property is used to access the font details specified using the SetFont method.

This property is read-only and not available at design time.

Data Type

SecurePDFPDFFont

InputData Property (PDFForm Class)

A byte array containing the PDF document to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInputData(char* &lpInputData, int &lenInputData);
int SetInputData(const char* lpInputData, int lenInputData);

Unicode (Windows)
INT GetInputData(LPSTR &lpInputData, INT &lenInputData);
INT SetInputData(LPCSTR lpInputData, INT lenInputData);

int securepdf_pdfform_getinputdata(void* lpObj, char** lpInputData, int* lenInputData);
int securepdf_pdfform_setinputdata(void* lpObj, const char* lpInputData, int lenInputData);

QByteArray GetInputData();
int SetInputData(QByteArray qbaInputData);

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PDFForm Class)

The PDF file to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* securepdf_pdfform_getinputfile(void* lpObj);
int securepdf_pdfform_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

""

Remarks

This property is used to provide a path to the PDF document to be processed.

Data Type

String

OutputData Property (PDFForm Class)

A byte array containing the PDF document after processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOutputData(char* &lpOutputData, int &lenOutputData);

Unicode (Windows)
INT GetOutputData(LPSTR &lpOutputData, INT &lenOutputData);

int securepdf_pdfform_getoutputdata(void* lpObj, char** lpOutputData, int* lenOutputData);

QByteArray GetOutputData();

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It will only be set if an output file and output stream have not been assigned via OutputFile and SetOutputStream respectively.

This property is read-only and not available at design time.

Data Type

Byte Array

OutputFile Property (PDFForm Class)

The path to a local file where the output will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* securepdf_pdfform_getoutputfile(void* lpObj);
int securepdf_pdfform_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

""

Remarks

This property is used to provide a path where the resulting PDF document will be saved after the operation has completed.

Data Type

String

Overwrite Property (PDFForm Class)

Whether or not the class should overwrite files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int securepdf_pdfform_getoverwrite(void* lpObj);
int securepdf_pdfform_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite OutputFile, OutputData, or the stream set in SetOutputStream. If set to false, an error will be thrown whenever OutputFile, OutputData, or the stream set in SetOutputStream exists before an operation.

Data Type

Boolean

Password Property (PDFForm Class)

The password to decrypt the document with.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPassword();
int SetPassword(const char* lpszPassword);

Unicode (Windows)
LPWSTR GetPassword();
INT SetPassword(LPCWSTR lpszPassword);

char* securepdf_pdfform_getpassword(void* lpObj);
int securepdf_pdfform_setpassword(void* lpObj, const char* lpszPassword);

QString GetPassword();
int SetPassword(QString qsPassword);

Default Value

""

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

Data Type

String

Position Property (PDFForm Class)

The currently set position.

Syntax

• C++
• C
• Qt

SecurePDFPDFPagePosition* GetPosition();

int securepdf_pdfform_getpositionpageindex(void* lpObj);

char* securepdf_pdfform_getpositionx(void* lpObj);

char* securepdf_pdfform_getpositiony(void* lpObj);

int GetPositionPageIndex();

QString GetPositionX();

QString GetPositionY();

Remarks

This property is used to access the position details specified using the SetPosition and SetPage methods.

This property is read-only and not available at design time.

Data Type

SecurePDFPDFPagePosition

AddBitmap Method (PDFForm Class)

Adds a bitmap image at the current position.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddBitmap(const char* lpszFormat, const char* lpBitmapBytes, int lenBitmapBytes, int iBitmapWidth, int iBitmapHeight, const char* lpszWidth, const char* lpszHeight);

Unicode (Windows)
INT AddBitmap(LPCWSTR lpszFormat, LPCSTR lpBitmapBytes, INT lenBitmapBytes, INT iBitmapWidth, INT iBitmapHeight, LPCWSTR lpszWidth, LPCWSTR lpszHeight);

int securepdf_pdfform_addbitmap(void* lpObj, const char* lpszFormat, const char* lpBitmapBytes, int lenBitmapBytes, int iBitmapWidth, int iBitmapHeight, const char* lpszWidth, const char* lpszHeight);

int AddBitmap(const QString& qsFormat, QByteArray& qbaBitmapBytes, int iBitmapWidth, int iBitmapHeight, const QString& qsWidth, const QString& qsHeight);

Remarks

This function is not available in the current version of the product.

Use this function to add a bitmap image at the specified Position. Provide the parameters of the serialized image using the Format, BitmapBytes, BitmapWidth, and BitmapHeight parameters.

Use Width and Height parameters to specify the dimensions, in points, which the image should be scaled/stretched to when placed on the page.

Note: please make sure to provide the original width and height of the bitmap, in pixels, via the BitmapWidth and BitmapHeight parameters.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddButton Method (PDFForm Class)

Adds a button field to the form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddButton(const char* lpszName, const char* lpszCaption);

Unicode (Windows)
INT AddButton(LPCWSTR lpszName, LPCWSTR lpszCaption);

int securepdf_pdfform_addbutton(void* lpObj, const char* lpszName, const char* lpszCaption);

int AddButton(const QString& qsName, const QString& qsCaption);

Remarks

This method is used to create a button field with name Name and caption Caption at the specified Position.

The button is added to the end of the Fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the Fields properties.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AddCaption Method (PDFForm Class)

Adds a caption for a form field.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCaption(const char* lpszCaption);

Unicode (Windows)
INT AddCaption(LPCWSTR lpszCaption);

int securepdf_pdfform_addcaption(void* lpObj, const char* lpszCaption);

int AddCaption(const QString& qsCaption);

Remarks

This method is used to add a caption (title) for a form field at the specified Position.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddCheckBox Method (PDFForm Class)

Adds a check box field to the form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddCheckBox(const char* lpszName, int bDefaultValue);

Unicode (Windows)
INT AddCheckBox(LPCWSTR lpszName, BOOL bDefaultValue);

int securepdf_pdfform_addcheckbox(void* lpObj, const char* lpszName, int bDefaultValue);

int AddCheckBox(const QString& qsName, bool bDefaultValue);

Remarks

This method is used to create a check box field with name Name at the specified Position.

The DefaultValue parameter specifies the initial state of the check box (checked/unchecked).

The check box field is added to the end of the Fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the Fields properties.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AddComboBox Method (PDFForm Class)

Adds a combo box field to the form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddComboBox(const char* lpszName, const char* lpszOptions, const char* lpszDefaultValue);

Unicode (Windows)
INT AddComboBox(LPCWSTR lpszName, LPCWSTR lpszOptions, LPCWSTR lpszDefaultValue);

int securepdf_pdfform_addcombobox(void* lpObj, const char* lpszName, const char* lpszOptions, const char* lpszDefaultValue);

int AddComboBox(const QString& qsName, const QString& qsOptions, const QString& qsDefaultValue);

Remarks

This method is used to create a combo box field with name Name at the specified Position.

The Options parameter specifies a list of choices as a multi-line string.

The DefaultValue parameter specifies the initial value selected in the combo box.

The new combo box field is added to the end of the Fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the Fields properties.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AddDrawing Method (PDFForm Class)

Adds a vector drawing at the current position.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddDrawing(const char* lpszFormat, const char* lpDrawingBytes, int lenDrawingBytes, const char* lpszWidth, const char* lpszHeight);

Unicode (Windows)
INT AddDrawing(LPCWSTR lpszFormat, LPCSTR lpDrawingBytes, INT lenDrawingBytes, LPCWSTR lpszWidth, LPCWSTR lpszHeight);

int securepdf_pdfform_adddrawing(void* lpObj, const char* lpszFormat, const char* lpDrawingBytes, int lenDrawingBytes, const char* lpszWidth, const char* lpszHeight);

int AddDrawing(const QString& qsFormat, QByteArray& qbaDrawingBytes, const QString& qsWidth, const QString& qsHeight);

Remarks

This function is not available in the current version of the product.

Use this function to add a vector drawing at the specified Position. Provide the drawing, as an encoded PDF appearance stream, via the DrawingBytes parameter.

Use Width and Height parameters to specify the dimensions, in points, which the drawing should be scaled/stretched to when placed on the page.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddListBox Method (PDFForm Class)

Adds a list box field to the form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddListBox(const char* lpszName, const char* lpszOptions, const char* lpszDefaultValue);

Unicode (Windows)
INT AddListBox(LPCWSTR lpszName, LPCWSTR lpszOptions, LPCWSTR lpszDefaultValue);

int securepdf_pdfform_addlistbox(void* lpObj, const char* lpszName, const char* lpszOptions, const char* lpszDefaultValue);

int AddListBox(const QString& qsName, const QString& qsOptions, const QString& qsDefaultValue);

Remarks

This method is used to create a list box field with name Name at the specified Position.

The Options parameter specifies a list of choices as a multi-line string.

The DefaultValue parameter specifies the initial value selected in the list box.

The new list box field is added to the end of the Fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the Fields properties.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AddNewPage Method (PDFForm Class)

Adds a new blank page to a PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddNewPage(int iPageIndex);

Unicode (Windows)
INT AddNewPage(INT iPageIndex);

int securepdf_pdfform_addnewpage(void* lpObj, int iPageIndex);

int AddNewPage(int iPageIndex);

Remarks

This method is used to add a new page to the document at the position specified by the PageIndex parameter. Note that when this method returns, the Position will not be automatically moved to the newly added page.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddRadioButton Method (PDFForm Class)

Adds a radio button to the form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddRadioButton(const char* lpszRadioGroup, const char* lpszName, int bIsDefaultButton);

Unicode (Windows)
INT AddRadioButton(LPCWSTR lpszRadioGroup, LPCWSTR lpszName, BOOL bIsDefaultButton);

int securepdf_pdfform_addradiobutton(void* lpObj, const char* lpszRadioGroup, const char* lpszName, int bIsDefaultButton);

int AddRadioButton(const QString& qsRadioGroup, const QString& qsName, bool bIsDefaultButton);

Remarks

This method is used to create a radio button field with name Name, within the radio group RadioGroup, at the specified Position.

The IsDefaultButton parameter specifies whether the radio button will be selected initially (i.e., whether it will be the DefaultValue of the radio group).

The new radio button field is added to the end of the Fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the Fields properties.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AddTextBox Method (PDFForm Class)

Adds a text box field to the form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddTextBox(const char* lpszName, const char* lpszDefaultValue, int bPassword);

Unicode (Windows)
INT AddTextBox(LPCWSTR lpszName, LPCWSTR lpszDefaultValue, BOOL bPassword);

int securepdf_pdfform_addtextbox(void* lpObj, const char* lpszName, const char* lpszDefaultValue, int bPassword);

int AddTextBox(const QString& qsName, const QString& qsDefaultValue, bool bPassword);

Remarks

This method is used to create a text box field with name Name at the specified Position.

The DefaultValue parameter specifies the initial value contained in the text box.

The Password parameter specifies whether the text box is intended to contain a password. If this parameter is true, the text will be displayed as asterisk characters (*).

The new text box field is added to the end of the Fields properties and can be modified using the properties of the respective PDFField object.

This method returns the index of the newly added field in the Fields properties.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Close Method (PDFForm Class)

Closes an opened PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int securepdf_pdfform_close(void* lpObj);

int Close();

Remarks

This method is used to close the previously opened document specified in InputFile, InputData, or SetInputStream. It should always be preceded by a call to the Open method.

Example:

C#
 Copy
component.InputFile = "input.pdf";
component.Open();
// Some operation
component.Close();

If any changes are made to the document, they will be saved automatically to OutputFile, OutputData, or the stream set in SetOutputStream when this method is called. To configure this saving behavior, set the SaveChanges configuration setting.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (PDFForm Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* securepdf_pdfform_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CreateNew Method (PDFForm Class)

Creates a new document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateNew();

Unicode (Windows)
INT CreateNew();

int securepdf_pdfform_createnew(void* lpObj);

int CreateNew();

Remarks

Use this method to create a blank PDF document with one empty page.

Having created the baseline document, you can use methods of the component (such as AddStream) to add objects to it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Encrypted Method (PDFForm Class)

Checks whether a PDF document is encrypted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool Encrypted();

Unicode (Windows)
bool Encrypted();

bool securepdf_pdfform_encrypted(void* lpObj);

bool Encrypted();

Remarks

This method is used to determine whether or not the document specified in InputFile, InputData, or SetInputStream is encrypted. It will return false if the document is pseudo-encrypted with an empty password.

Example:

C#
 Copy
component.InputFile = "input.pdf";
if (component.Encrypted())
{
  // Set Password or DecryptionCert
}
component.Open();
// Some operation
component.Close();

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

FindField Method (PDFForm Class)

Locates a field in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int FindField(const char* lpszName);

Unicode (Windows)
INT FindField(LPCWSTR lpszName);

int securepdf_pdfform_findfield(void* lpObj, const char* lpszName);

int FindField(const QString& qsName);

Remarks

This method is used to quickly locate the field with name Name in the document. This method returns the index of the field in the Fields properties, or -1 if the field was not found.

Error Handling (C++)

This method returns an Integer value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Flatten Method (PDFForm Class)

Flattens the form by removing the interactive form fields.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Flatten();

Unicode (Windows)
INT Flatten();

int securepdf_pdfform_flatten(void* lpObj);

int Flatten();

Remarks

This method is used to substitute all the existing form fields in the document with their currently set values, thus fixing them.

This method strips the interactive form features from the document. The flattened fields are no longer fields and can no longer be modified or extracted. Any signatures that may have been included in the original document are removed from the flattened document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetFieldProperty Method (PDFForm Class)

Retrieves the value of a field property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFieldProperty(int iFieldIndex, const char* lpszFieldProperty);

Unicode (Windows)
LPWSTR GetFieldProperty(INT iFieldIndex, LPCWSTR lpszFieldProperty);

char* securepdf_pdfform_getfieldproperty(void* lpObj, int iFieldIndex, const char* lpszFieldProperty);

QString GetFieldProperty(int iFieldIndex, const QString& qsFieldProperty);

Remarks

This method is used to retrieve the value of a field property. Together with SetFieldProperty, this method provides an extensible way of managing the field settings that are not available through the PDFField type. The list of settings below may be extended in the future.

The FieldIndex parameter is the index of the field of interest in the Fields properties, and the FieldProperty parameter specifies the field property to read. The latter can take one of the following values:

Note: Each field property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetPageProperty Method (PDFForm Class)

Retrieves the value of a page property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPageProperty(int iPageIndex, const char* lpszPageProperty);

Unicode (Windows)
LPWSTR GetPageProperty(INT iPageIndex, LPCWSTR lpszPageProperty);

char* securepdf_pdfform_getpageproperty(void* lpObj, int iPageIndex, const char* lpszPageProperty);

QString GetPageProperty(int iPageIndex, const QString& qsPageProperty);

Remarks

This method is used to read general information about the pages of the document specified in InputFile, InputData, or SetInputStream, such as their dimensions and content positioning details.

The PageIndex parameter specifies the page to read information about (with a valid range from 0 to PageCount - 1), and the PageProperty parameter specifies the page property to read. The latter can take one of the following values:

Example:

C#
 Copy
int pageCount = 0;
component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; };
component.InputFile = "input.pdf";
component.Open();
for (int i = 0; i < pageCount; i++) component.GetPageProperty(i, "Height");
component.Close();

C#
 Copy
int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100;
int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100;
pdfsign.SetWidgetProperty("OffsetX", x.ToString());
pdfsign.SetWidgetProperty("OffsetY", y.ToString());

NOTE: If the document is not already opened, this method will open it, perform the operation, then close it.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Open Method (PDFForm Class)

Opens a PDF document for processing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int securepdf_pdfform_open(void* lpObj);

int Open();

Remarks

This method is used to open the document specified in InputFile, InputData, or SetInputStream before performing some operation on it, such as adding, editing, or removing form fields. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

NOTE: This method will populate the Fields properties with any form fields found in the document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveField Method (PDFForm Class)

Removes a field from the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveField(int iIndex);

Unicode (Windows)
INT RemoveField(INT iIndex);

int securepdf_pdfform_removefield(void* lpObj, int iIndex);

int RemoveField(int iIndex);

Remarks

This method is used to remove a field from the document. The Index parameter specifies the index of the field in the Fields properties to be removed.

NOTE: This method can only be used with terminal fields.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

RemoveFieldByName Method (PDFForm Class)

Removes a field from the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RemoveFieldByName(const char* lpszName);

Unicode (Windows)
INT RemoveFieldByName(LPCWSTR lpszName);

int securepdf_pdfform_removefieldbyname(void* lpObj, const char* lpszName);

int RemoveFieldByName(const QString& qsName);

Remarks

This method is used to remove a field from the document. The Name parameter specifies the full name of the field in the Fields properties to be removed.

NOTE: This method can only be used with terminal fields.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (PDFForm Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int securepdf_pdfform_reset(void* lpObj);

int Reset();

Remarks

This method is used to reset the class's properties and configuration settings to their default values.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetFieldProperty Method (PDFForm Class)

Sets the value of a field property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetFieldProperty(int iFieldIndex, const char* lpszFieldProperty, const char* lpszValue);

Unicode (Windows)
INT SetFieldProperty(INT iFieldIndex, LPCWSTR lpszFieldProperty, LPCWSTR lpszValue);

int securepdf_pdfform_setfieldproperty(void* lpObj, int iFieldIndex, const char* lpszFieldProperty, const char* lpszValue);

int SetFieldProperty(int iFieldIndex, const QString& qsFieldProperty, const QString& qsValue);

Remarks

This method is used to modify the value of a field property. Together with GetFieldProperty, this method provides an extensible way of managing the field settings that are not available through the PDFField type. The list of settings below may be extended in the future.

The FieldIndex parameter is the index of the field of interest in the Fields properties, and the FieldProperty and Value parameters specify the field property and value to set respectively. The former can take one of the following values:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetFont Method (PDFForm Class)

Sets the font properties to be applied to form fields.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetFont(const char* lpszName, const char* lpszSize, const char* lpszStyle, const char* lpszColor);

Unicode (Windows)
INT SetFont(LPCWSTR lpszName, LPCWSTR lpszSize, LPCWSTR lpszStyle, LPCWSTR lpszColor);

int securepdf_pdfform_setfont(void* lpObj, const char* lpszName, const char* lpszSize, const char* lpszStyle, const char* lpszColor);

int SetFont(const QString& qsName, const QString& qsSize, const QString& qsStyle, const QString& qsColor);

Remarks

This method is used to define the font attributes for text in form fields.

The Name parameter specifies the font name.

The Size parameter specifies the font size, either as an absolute value (e.g., "12") or relative adjustment (e.g., "+2").

The Style parameter specifies the font style: a combination of bold ("B"), italic ("I"), or underline ("U").

The Color parameter specifies the font color in hexadecimal format.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetInputStream Method (PDFForm Class)

Sets the stream containing the PDF document to process.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetInputStream(SecurePDFStream* sInputStream);

Unicode (Windows)
INT SetInputStream(SecurePDFStream* sInputStream);

int securepdf_pdfform_setinputstream(void* lpObj, SecurePDFStream* sInputStream);

int SetInputStream(SecurePDFStream* sInputStream);

Remarks

This method is used to set the stream from which the class will read the PDF document to be processed. If an input stream is set before the class attempts to perform operations on the document, the class will read the data from the input stream instead of from the InputFile or InputData properties.

NOTE: It may be useful to additionally set the CloseInputStreamAfterProcessing configuration setting to true when using input streams.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetOutputStream Method (PDFForm Class)

Sets the stream to write the processed document to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetOutputStream(SecurePDFStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(SecurePDFStream* sOutputStream);

int securepdf_pdfform_setoutputstream(void* lpObj, SecurePDFStream* sOutputStream);

int SetOutputStream(SecurePDFStream* sOutputStream);

Remarks

This method is used to set the stream to which the class will write the resulting PDF document. If an output stream is set before the class attempts to perform operations on the document, the class will write the data to the output stream instead of writing to OutputFile or populating OutputData.

NOTE: It may be useful to additionally set the CloseOutputStreamAfterProcessing configuration setting to true when using output streams.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetPage Method (PDFForm Class)

Sets the page to be used as the working page.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetPage(int iPageIndex);

Unicode (Windows)
INT SetPage(INT iPageIndex);

int securepdf_pdfform_setpage(void* lpObj, int iPageIndex);

int SetPage(int iPageIndex);

Remarks

This method is used to specify the page on which all subsequent operations will be performed. The page is identified by the PageIndex parameter.

NOTE: PageIndex set to -1 specifies the last page of the document.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetPosition Method (PDFForm Class)

Sets the position for form fields.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetPosition(const char* lpszX, const char* lpszY);

Unicode (Windows)
INT SetPosition(LPCWSTR lpszX, LPCWSTR lpszY);

int securepdf_pdfform_setposition(void* lpObj, const char* lpszX, const char* lpszY);

int SetPosition(const QString& qsX, const QString& qsY);

Remarks

This method is used to define the Position where form fields will be added. The X parameter specifies the horizontal position, and the Y parameter specifies the vertical position.

Values that are absolute, relative to the current position, and relative to the page dimensions are all supported.

Example:

C#
 Copy
// Sets to exact coordinates.
form.SetPosition("100", "20");
// Moves 20 points to the right and 20 points down from the current position.
form.SetPosition("{x}+20", "{y}-20");
// Moves 20 points from the right edge and 120 points from the top edge of the page.
form.SetPosition("{width}-20", "{height}-120");

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DocumentInfo Event (PDFForm Class)

Fired when the document has been loaded into memory.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireDocumentInfo(PDFFormDocumentInfoEventParams *e);

typedef struct {
  int PageCount;
  int SignatureCount;
  int reserved;
} PDFFormDocumentInfoEventParams;


Unicode (Windows)
virtual INT FireDocumentInfo(PDFFormDocumentInfoEventParams *e);

typedef struct {
  INT PageCount;
  INT SignatureCount;
  INT reserved;
} PDFFormDocumentInfoEventParams;

#define EID_PDFFORM_DOCUMENTINFO 1

virtual INT SECUREPDF_CALL FireDocumentInfo(INT &iPageCount, INT &iSignatureCount);

class PDFFormDocumentInfoEventParams {
public:
  int PageCount();

  int SignatureCount();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void DocumentInfo(PDFFormDocumentInfoEventParams *e);

// Or, subclass PDFForm and override this emitter function.
virtual int FireDocumentInfo(PDFFormDocumentInfoEventParams *e) {...}

Remarks

This event is fired once per document processing routine to report that the document has been processed and loaded into memory.

The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details. These may be useful when preparing the signature. For example, the GetPageProperty method can be used to find the optimal position for the signature widget.

The PageCount parameter reports the number of pages in the document.

The SignatureCount parameter reports the number of signatures in the document.

This event is fired when the Open method is called, but only after Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

Error Event (PDFForm Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(PDFFormErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} PDFFormErrorEventParams;


Unicode (Windows)
virtual INT FireError(PDFFormErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} PDFFormErrorEventParams;

#define EID_PDFFORM_ERROR 2

virtual INT SECUREPDF_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class PDFFormErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(PDFFormErrorEventParams *e);

// Or, subclass PDFForm and override this emitter function.
virtual int FireError(PDFFormErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (PDFForm Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(PDFFormLogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} PDFFormLogEventParams;


Unicode (Windows)
virtual INT FireLog(PDFFormLogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} PDFFormLogEventParams;

#define EID_PDFFORM_LOG 3

virtual INT SECUREPDF_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class PDFFormLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(PDFFormLogEventParams *e);

// Or, subclass PDFForm and override this emitter function.
virtual int FireLog(PDFFormLogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel configuration setting.

The LogLevel parameter indicates the detail level of the message. Possible values are:

The Message parameter is the log message.

The LogType parameter identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

Password Event (PDFForm Class)

Fired when the class detects that the PDF document is encrypted with a password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePassword(PDFFormPasswordEventParams *e);

typedef struct {
  int Available;
  int Cancel;
  int reserved;
} PDFFormPasswordEventParams;


Unicode (Windows)
virtual INT FirePassword(PDFFormPasswordEventParams *e);

typedef struct {
  BOOL Available;
  BOOL Cancel;
  INT reserved;
} PDFFormPasswordEventParams;

#define EID_PDFFORM_PASSWORD 4

virtual INT SECUREPDF_CALL FirePassword(BOOL &bAvailable, BOOL &bCancel);

class PDFFormPasswordEventParams {
public:
  bool Available();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Password(PDFFormPasswordEventParams *e);

// Or, subclass PDFForm and override this emitter function.
virtual int FirePassword(PDFFormPasswordEventParams *e) {...}

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to the Password property.

The Available parameter indicates whether the decryption password is already available to the class or still needs to be set. If this parameter is set to false, the correct password must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a password.

RecipientInfo Event (PDFForm Class)

Fired for each recipient certificate of the encrypted PDF document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireRecipientInfo(PDFFormRecipientInfoEventParams *e);

typedef struct {
  const char *Issuer;
  const char *SerialNumber;
  const char *SubjectKeyIdentifier;
  int Available;
  int Cancel;
  int reserved;
} PDFFormRecipientInfoEventParams;


Unicode (Windows)
virtual INT FireRecipientInfo(PDFFormRecipientInfoEventParams *e);

typedef struct {
  LPCWSTR Issuer;
  LPCWSTR SerialNumber;
  LPCWSTR SubjectKeyIdentifier;
  BOOL Available;
  BOOL Cancel;
  INT reserved;
} PDFFormRecipientInfoEventParams;

#define EID_PDFFORM_RECIPIENTINFO 5

virtual INT SECUREPDF_CALL FireRecipientInfo(LPSTR &lpszIssuer, LPSTR &lpszSerialNumber, LPSTR &lpszSubjectKeyIdentifier, BOOL &bAvailable, BOOL &bCancel);

class PDFFormRecipientInfoEventParams {
public:
  const QString &Issuer();

  const QString &SerialNumber();

  const QString &SubjectKeyIdentifier();

  bool Available();

  bool Cancel();
  void SetCancel(bool bCancel);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void RecipientInfo(PDFFormRecipientInfoEventParams *e);

// Or, subclass PDFForm and override this emitter function.
virtual int FireRecipientInfo(PDFFormRecipientInfoEventParams *e) {...}

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to the DecryptionCert property.

The Issuer parameter specifies the subject of the issuer certificate.

The SerialNumber parameter specifies the serial number of the encryption certificate.

The SubjectKeyIdentifier parameter specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

The Available parameter indicates whether the decryption certificate is already available to the class or still needs to be set. If this parameter is set to false, the correct certificate must be provided for the decryption attempt to succeed.

The Cancel parameter determines whether the class will stop firing this event to request a certificate.

NOTE: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate will cause its own invocation of this event.

Certificate Type

This is the digital certificate being used.

Syntax

SecurePDFCertificate (declared in securepdf.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

C#
 Copy
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; //PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

PDFField Type

This type represents a single form field.

Syntax

SecurePDFPDFField (declared in securepdf.h)

Remarks

PDFField objects provide access to the properties of an individual field object.

• Action
• AltName
• Caption
• DefaultValue
• FieldName
• FieldType
• FullName
• Height
• MaxLen
• OffsetX
• OffsetY
• Options
• PageIndex
• Terminal
• Value
• Visible
• Width

Fields

Constructors

PDFField()

PDFFont Type

The font used in a PDF document.

Syntax

SecurePDFPDFFont (declared in securepdf.h)

Remarks

This type contains details about the font being applied to form fields.

• Color
• Name
• Size
• Style

Fields

Constructors

PDFFont()

PDFPagePosition Type

The position within a PDF document.

Syntax

SecurePDFPDFPagePosition (declared in securepdf.h)

Remarks

This type contains information about the current position on a page.

• PageIndex
• X
• Y

Fields

Constructors

PDFPagePosition()

SecurePDFList Type

Syntax

SecurePDFList<T> (declared in securepdf.h)

Remarks

SecurePDFList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the PDFForm class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

SecurePDFStream Type

Syntax

SecurePDFStream (declared in securepdf.h)

Remarks

The PDFForm class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the SecurePDFStream interface and pass the PDFForm class an instance of that concrete class.

When implementing the SecurePDFStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (PDFForm Class)

PDFForm Config Settings

Base Config Settings

Trappable Errors (PDFForm Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

PDFForm Errors

PDF Errors

Parsing Errors