SignDoc SDK (.NET with exceptions)  5.0.0
SignDocField Class Reference

One field of a document. More...

Public Member Functions

 SignDocField ()
 Constructor. More...
 
 SignDocField (SignDocField aSource)
 Copy constructor. More...
 
 ~SignDocField ()
 Destructor. More...
 
 !SignDocField ()
 Finalizer. More...
 
string getName ()
 Get the name of the field. More...
 
void setName (string aName)
 Set the name of the field. More...
 
string getAlternateName ()
 Get the alternate name of the field. More...
 
void setAlternateName (string aName)
 Set the alternate name of the field. More...
 
string getMappingName ()
 Get the mapping name of the field. More...
 
void setMappingName (string aName)
 Set the mapping name of the field. More...
 
int getValueCount ()
 Get the number of values of the field. More...
 
string getValue (int aIndex)
 Get a value of the field. More...
 
void clearValues ()
 Clear the values. More...
 
void addValue (string aValue)
 Add a value to the field. More...
 
void setValue (string aValue)
 Set the value of the field. More...
 
bool setValue (int aIndex, string aValue)
 Set a value of the field. More...
 
bool removeValue (int aIndex)
 Remove a value from the field. More...
 
int getValueIndex ()
 Get the current value index. More...
 
void setValueIndex (int aIndex)
 Set the value index. More...
 
bool clickButton (int aIndex)
 Click a check box or a radio button. More...
 
int getChoiceCount ()
 Get the number of available choices for a list box or combo box. More...
 
string getChoiceValue (int aIndex)
 Get an available choice of a list box or combo box. More...
 
string getChoiceExport (int aIndex)
 Get the export value for an available choice of a list box or combo box. More...
 
void clearChoices ()
 Clear the choices of a list box or combo box. More...
 
void addChoice (string aValue)
 Add a choice to a list box or combo box. More...
 
void addChoice (string aValue, string aExport)
 Add a choice to a list box or combo box. More...
 
bool setChoice (int aIndex, string aValue)
 Set a choice value of a list box or combo box. More...
 
bool setChoice (int aIndex, string aValue, string aExport)
 Set a choice value of a list box or combo box. More...
 
bool removeChoice (int aIndex)
 Remove a choice from a list box or combo box. More...
 
FieldType getType ()
 Get the type of the field. More...
 
void setType (FieldType aType)
 Set the type of the field. More...
 
FieldFlags getFlags ()
 Get the flags of the field, see enum FieldFlags. More...
 
void setFlags (FieldFlags aFlags)
 Set the flags of the field, see enum FieldFlags. More...
 
SignatureType getSignatureType ()
 Get the signature type of a signature field. More...
 
int getDocMDP ()
 Get the DocMDP P value of a certification signature. More...
 
bool isSigned ()
 Check if this field is a signed signature field. More...
 
bool isCurrentlyClearable ()
 Check if this signature field is currently clearable. More...
 
int getMaxLen ()
 Get maximum length of text field. More...
 
void setMaxLen (int aMaxLen)
 Set maximum length of text fields. More...
 
int getTopIndex ()
 Get the index of the choice to be displayed in the first line of a list box. More...
 
void setTopIndex (int aTopIndex)
 Set the index of the choice to be displayed in the first line of a list box. More...
 
int getWidget ()
 Get the index of the currently selected widget. More...
 
int getWidgetCount ()
 Get the number of widgets. More...
 
bool selectWidget (int aIndex)
 Select a widget. More...
 
bool addWidget ()
 Add a widget to the field. More...
 
bool insertWidget (int aIndex)
 Add a widget to the field in front of another widget. More...
 
bool removeWidget (int aIndex)
 Remove a widget from the field. More...
 
WidgetFlags getWidgetFlags ()
 Get the annotation flags of the widget, see enum WidgetFlags. More...
 
void setWidgetFlags (WidgetFlags aFlags)
 Set the annotation flags of the widget, see enum WidgetFlags. More...
 
int getPage ()
 Get the page number. More...
 
void setPage (int aPage)
 Set the page number. More...
 
double getLeft ()
 Get the left coordinate. More...
 
void setLeft (double aLeft)
 Set the left coordinate. More...
 
double getBottom ()
 Get the bottom coordinate. More...
 
void setBottom (double aBottom)
 Set the bottom coordinate. More...
 
double getRight ()
 Get the right coordinate. More...
 
void setRight (double aRight)
 Set the right coordinate. More...
 
double getTop ()
 Get the top coordinate. More...
 
void setTop (double aTop)
 Set the top coordinate. More...
 
string getButtonValue ()
 Get the button value of a widget of a radio button group or check box. More...
 
void setButtonValue (string aValue)
 
FieldJustification getJustification ()
 Get the justification of the widget. More...
 
void setJustification (FieldJustification aJustification)
 Set the justification of the widget. More...
 
int getRotation ()
 Get the rotation of the widget contents. More...
 
void setRotation (int aRotation)
 Set the rotation of the widget contents. More...
 
SignDocTextFieldAttributes getTextFieldAttributes ()
 Get the text field attributes of the widget. More...
 
bool setTextFieldAttributes (SignDocTextFieldAttributes aInput)
 Set the text field attributes of the widget. More...
 
SignDocColor getBackgroundColor ()
 Get the background color of the widget. More...
 
void setBackgroundColor (SignDocColor aColor)
 Set the background color of the widget. More...
 
SignDocColor getBorderColor ()
 Get the border color of the widget. More...
 
void setBorderColor (SignDocColor aColor)
 Set the border color of the widget. More...
 
double getBorderWidth ()
 Get the border width of the widget. More...
 
void setBorderWidth (double aWidth)
 Set the border width of the widget. More...
 
FieldBorderStyle getBorderStyle ()
 Get the border style. More...
 
void setBorderStyle (FieldBorderStyle aStyle)
 Set the border style. More...
 
FieldButtonStyle getButtonStyle ()
 Get the button style of a check box or radio button field. More...
 
void setButtonStyle (FieldButtonStyle aStyle)
 Set the button style of a check box or radio button field. More...
 
LockType getLockType ()
 Get the lock type. More...
 
void setLockType (LockType aLockType)
 Set the lock type. More...
 
int getLockFieldCount ()
 Get the number of field names for LockType.Include and LockType.Exclude. More...
 
string getLockField (int aIndex)
 Get the name of a lock field. More...
 
void clearLockFields ()
 Clear the lock fields. More...
 
void addLockField (string aName)
 Add a lock field to the field. More...
 
bool setLockField (int aIndex, string aName)
 Set a lock field. More...
 
void setLockField (string aName)
 Set a lock field. More...
 
bool removeLockField (int aIndex)
 Remove a lock field. More...
 
int getLockMDP ()
 Get the lock MDP value. More...
 
void setLockMDP (int aMDP)
 Set the lock MDP value. More...
 
CertSeedValueFlags getCertSeedValueFlags ()
 Get the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field, see enum CertSeedValueFlags. More...
 
void setCertSeedValueFlags (CertSeedValueFlags aFlags)
 Set the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field, see enum CertSeedValueFlags. More...
 
int getCertSeedValueSubjectDNCount ()
 Get the number of subject distinguished names in the certificate seed value dictionary. More...
 
string getCertSeedValueSubjectDN (int aIndex)
 Get a subject distinguished name from the certificate seed value dictionary. More...
 
void clearCertSeedValueSubjectDNs ()
 Remove all subject distinguished names from the certificate seed value dictionary. More...
 
bool addCertSeedValueSubjectDN (string aName)
 Add a subject distinguished name to the certificate seed value dictionary. More...
 
bool setCertSeedValueSubjectDN (int aIndex, string aName)
 Set a subject distinguished name in the certificate seed value dictionary. More...
 
bool setCertSeedValueSubjectDN (string aName)
 Set a subject distinguished name in the certificate seed value dictionary. More...
 
bool removeCertSeedValueSubjectDN (int aIndex)
 Remove a subject distinguished name from the certificate seed value dictionary. More...
 
int getCertSeedValuePolicyCount ()
 Get the number of policy OIDs in the certificate seed value dictionary. More...
 
string getCertSeedValuePolicy (int aIndex)
 Get a policy OID from the certificate seed value dictionary. More...
 
void clearCertSeedValuePolicies ()
 Remove all policy OIDs from the certificate seed value dictionary. More...
 
void addCertSeedValuePolicy (string aOID)
 Add a policy OID to the certificate seed value dictionary. More...
 
bool setCertSeedValuePolicy (int aIndex, string aOID)
 Set a policy OID in the certificate seed value dictionary. More...
 
void setCertSeedValuePolicy (string aOID)
 Set a policy OID in the certificate seed value dictionary. More...
 
bool removeCertSeedValuePolicy (int aIndex)
 Remove a policy OID from the certificate seed value dictionary. More...
 
int getCertSeedValueSubjectCertificateCount ()
 Get the number of subject certificates in the certificate seed value dictionary. More...
 
byte[] getCertSeedValueSubjectCertificate (int aIndex)
 Get a subject certificate of the certificate seed value dictionary. More...
 
void clearCertSeedValueSubjectCertificates ()
 Remove all subject certificates from the certificate seed value dictionary. More...
 
void addCertSeedValueSubjectCertificate (byte[] aCert)
 Add a subject certificate to the certificate seed value dictionary. More...
 
bool setCertSeedValueSubjectCertificate (int aIndex, byte[] aCert)
 Set a subject certificate in the certificate seed value dictionary. More...
 
void setCertSeedValueSubjectCertificate (byte[] aCert)
 Set a subject certificate in the certificate seed value dictionary. More...
 
bool removeCertSeedValueSubjectCertificate (int aIndex)
 Remove a subject certificate from the certificate seed value dictionary. More...
 
int getCertSeedValueIssuerCertificateCount ()
 Get the number of issuer certificates in the certificate seed value dictionary. More...
 
byte[] getCertSeedValueIssuerCertificate (int aIndex)
 Get an issuer certificate of the certificate seed value dictionary. More...
 
void clearCertSeedValueIssuerCertificates ()
 Remove all issuer certificates from the certificate seed value dictionary. More...
 
void addCertSeedValueIssuerCertificate (byte[] aCert)
 Add an issuer certificate to the certificate seed value dictionary. More...
 
bool setCertSeedValueIssuerCertificate (int aIndex, byte[] aCert)
 Set an issuer certificate in the certificate seed value dictionary. More...
 
void setCertSeedValueIssuerCertificate (byte[] aCert)
 Set an issuer certificate in the certificate seed value dictionary. More...
 
bool removeCertSeedValueIssuerCertificate (int aIndex)
 Remove an issuer certificate from the certificate seed value dictionary. More...
 
string getSeedValueTimeStampServerURL ()
 Get the URL of the RFC 3161 time-stamp server from the signature field seed value dictionary. More...
 
bool getSeedValueTimeStampRequired ()
 This function gets a flag from the signature field seed value dictionary that indicates whether a time stamp is required or not for the signature. More...
 
bool setSeedValueTimeStamp (string aURL, bool aRequired)
 Set the URL of an RFC 3161 time-stamp server in the signature field seed value dictionary. More...
 
string getSeedValueFilter ()
 Get Filter entry (signature handler) from the signature field seed value dictionary. More...
 
bool getSeedValueFilterRequired ()
 This function gets a flag from the signature field seed value dictionary that indicates whether the Filter entry (signature handler) is a required constraint or not. More...
 
bool setSeedValueFilter (string aFilter, bool aRequired)
 Set the Filter entry (signature handler) in the signature field seed value dictionary. More...
 
int getSeedValueSubFilterCount ()
 Get the number of SubFilter values in the seed value dictionary. More...
 
string getSeedValueSubFilter (int aIndex)
 Get a SubFilter value from the seed value dictionary. More...
 
bool getSeedValueSubFilterRequired ()
 This function gets a flag from the signature field seed value dictionary that indicates whether the SubFilter values are a required constraint or not. More...
 
void setSeedValueSubFilterRequired (bool aRequired)
 Set a flag from the signature field seed value dictionary that indicates whether the SubFilter values are a required constraint or not. More...
 
void clearSeedValueSubFilters ()
 Remove all SubFilter values from the seed value dictionary. More...
 
void addSeedValueSubFilter (string aSubFilter)
 Add a SubFilter value to the seed value dictionary. More...
 
bool setSeedValueSubFilter (int aIndex, string aSubFilter)
 Set a SubFilter value in the seed value dictionary. More...
 
void setSeedValueSubFilter (string aSubFilter)
 Set a SubFilter value in the seed value dictionary. More...
 
bool removeSeedValueSubFilter (int aIndex)
 Remove a SubFilter value from the seed value dictionary. More...
 
int getSeedValueDigestMethodCount ()
 Get the number of DigestMethod values in the seed value dictionary. More...
 
string getSeedValueDigestMethod (int aIndex)
 Get a DigestMethod value from the seed value dictionary. More...
 
bool getSeedValueDigestMethodRequired ()
 This function gets a flag from the signature field seed value dictionary that indicates whether the DigestMethod values are a required constraint or not. More...
 
void setSeedValueDigestMethodRequired (bool aRequired)
 Set a flag from the signature field seed value dictionary that indicates whether the DigestMethod values are a required constraint or not. More...
 
void clearSeedValueDigestMethods ()
 Remove all DigestMethod values from the seed value dictionary. More...
 
void addSeedValueDigestMethod (string aDigestMethod)
 Add a DigestMethod value to the seed value dictionary. More...
 
bool setSeedValueDigestMethod (int aIndex, string aDigestMethod)
 Set a DigestMethod value in the seed value dictionary. More...
 
void setSeedValueDigestMethod (string aDigestMethod)
 Set a DigestMethod value in the seed value dictionary. More...
 
bool removeSeedValueDigestMethod (int aIndex)
 Remove a DigestMethod value from the seed value dictionary. More...
 
bool getSeedValueAddRevInfo ()
 Get the AddRevInfo flag from the signature field seed value dictionary. More...
 
void setSeedValueAddRevInfo (bool aAddRevInfo)
 Set the AddRevInfo flag in the signature field seed value dictionary. More...
 
int getSeedValueMDP ()
 Get the MDP value from the signature field seed value dictionary. More...
 
bool setSeedValueMDP (int aMDP)
 Set the MDP value in the signature field seed value dictionary. More...
 
SignDocColor getEmptyFieldColor ()
 Get the color used for empty signature field in TIFF document. More...
 
void setEmptyFieldColor (SignDocColor aColor)
 Set color used for empty signature field in TIFF document. More...
 

Detailed Description

One field of a document.

Calling member function of this class does not modify the document, use SignDocDocument.setField() to apply your changes to the document or SignDocDocument.addField() to add the field to the document.

In PDF documents, a field may have multiple visible "widgets". For instance, a radio button group (radio button field) usually has multiple visible buttons, ie, widgets.

A SignDocField object represents the logical field (containing the type, name, value, etc) as well as all its widgets. Each widget has a page number, a coordinate rectangle, and, for some field types, text field attributes.

Only one widget of the field is accessible at a time in a SignDocField object; use selectWidget() to select the widget to be operated on.

For radio button fields and check box fields, each widget also has a "button value". The button value should remain constant after the document has been created (but it can be changed if needed). The field proper has a value which is either "Off" or one of the button values of its widgets.

Each widget of a radio button field or a check box field is either off or on. If all widgets of a radio button field or a check box are off, the field's value is "Off". If at least one widget is on, the field's value is that widget's "button value". As the value of a field must be different for the on and off states of the field, the button values must not be "Off".

Check box fields usually have exactly one widget. If that widget's button value is, say, "On", the field's value is either "Off" (for the off state) or "On" (for the on state).

Check box fields can have multiple widgets. If all widgets have the same button value, say, "yes", the field's value is either "Off" (for the off state) or "yes" (for the on state). Clicking one widget of the check box field will toggle all widgets of that check box field.

Check box fields can have multiple widgets having different button values. If a check box field has two widgets with button values, say, "1" and "2", the field's value is either "Off" (for the off state), "1" (if the first widget is on) or "2" (if the second widget is on). The two widgets cannot be on at the same time.

If a check box field has three widgets with button values, say, "one, "two", and "two", respectively, the field's value is either "Off" (for the off state), "one" (if the first widget is on) or "two" (if the second and third widgets are on). The second and third widgets will always have the same state and that state will never be the same as the state of the first widget.

A radio button field usually has at least two widgets, having different button values. If a radio button field has two widgets with button values, say, "a" and "b", the field's value is either "Off" (for the off state), "a" (if the first widget is on), or "b" (if the second widget is on). Clicking the first widget puts the first widget into the on state and the second one into the off state (and vice versa).

Different widgets of a radio button field can have the same button value. The behavior for clicking a widget with non-unique button value depends on the FieldFlags.RadiosInUnison field flag. If that flag is set (it usually is), widgets having the same button value always have the same on/off state. Clicking one of them will turn all of them on. If the FieldFlags.RadiosInUnison is not set, clicking one widget will put all others (of the same radio button field) into the off state. See getValueIndex() for details.

Signature fields have exactly one widget. Fields of other types must have at least one widget.

Other fields such as text fields (except for signature fields) also can have multiple widgets, but all of them display the same value.

Signature fields in PDF documents are invisible if their width is zero or if their height is zero, that is, if the coordinates set by setLeft() and setRight() are equal or if the coordinates set by setBottom() and setTop()) are equal.

Constructors, destructors, assignment, swapping:

All fields have a type, a name, and flags:

Fields in PDF documents can have an alternate name which is used for displaying the field name in a user interface:

Moreover, fields in PDF documents can have a mapping name which is used for exporting field data:

Most fields in PDF documents can have one or more value:

List boxes and combo boxes can have multiple possible choices:

Fields have one or more widget annotation:

Each widget annotation has a couple of flags:

Each widget annotation has a position on a page:

Radio button widgets and check box widgets have a button value (see above):

Text in a widget is controlled by these functions:

The background color of a widget can be set:

The border of a widget is controlled by these functions:

Radio button widgets and Check box widgets can display various symbols:

The following functions can be used for signature fields only:

Signing signature fields in a PDF document can automatically lock other fields:

Signature fields in a PDF document can have a signature field seed value dictionary controlling various aspects of signing. It can restrict the certificates that can be used for signing:

The certificate can be restricted by subject distinguished name:

The certificate can be restricted by specifying acceptable signing certificates:

The certificate can be restricted by specifying acceptable issuer certificates:

And the certificate can be restricted by policy:

The signature field seed value dictionary can specify an RFC 3161 time-stamp server:

The signature field seed value dictionary can specify a signature handler (Filter):

The signature field seed value dictionary can specify signing methods (SubFilter):

The signature field seed value dictionary can specify a hash algorithms (DigestMethod):

The signature field seed value dictionary can specify whether adding revocation to the signature is mandatory:

The signature field seed value dictionary can specify what changes shall be allowed after signing the signature field:

The color of an empty signature field in a TIFF document can be specified:

Constructor & Destructor Documentation

Constructor.

The new SignDocField object will have one widget.

SignDocField ( SignDocField  aSource)

Copy constructor.

Parameters
[in]aSourceThe object to be copied.
Returns
The new object.

Destructor.

Finalizer.

Member Function Documentation

void addCertSeedValueIssuerCertificate ( byte[]  aCert)

Add an issuer certificate to the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aCertThe DER-encoded certificate.
See also
clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate(), setCertSeedValueIssuerCertificate()
void addCertSeedValuePolicy ( string  aOID)

Add a policy OID to the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aOIDThe policy OID.
See also
clearCertSeedValuePolicies(), getCertSeedValuePolicy(), setCertSeedValuePolicy()
void addCertSeedValueSubjectCertificate ( byte[]  aCert)

Add a subject certificate to the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aCertThe DER-encoded certificate.
See also
clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate(), setCertSeedValueSubjectCertificate()
bool addCertSeedValueSubjectDN ( string  aName)

Add a subject distinguished name to the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aNameThe subject distinguished name formatted according to RFC 4514.
Returns
true if successful, false if aName cannot be parsed.
See also
clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN(), setCertSeedValueSubjectDN()
void addChoice ( string  aValue)

Add a choice to a list box or combo box.

This function uses the choice value as export value.

Note
getValue() and setValue() use the export value.
Parameters
[in]aValueThe choice value and export value to be added. Complex scripts are supported, see Complex Scripts.
See also
clearChoices(), getChoiceExport(), getChoiceValue(), setChoice(), setButtonValue()
void addChoice ( string  aValue,
string  aExport 
)

Add a choice to a list box or combo box.

Note
getValue() and setValue() use the export value.
Parameters
[in]aValueThe choice value to be added. Complex scripts are supported, see Complex Scripts.
[in]aExportThe export value to be added.
See also
clearChoices(), getChoiceExport(), getChoiceValue(), setChoice(), setButtonValue()
void addLockField ( string  aName)

Add a lock field to the field.

Parameters
[in]aNameThe name of the lock field to be added.
See also
clearLockFields(), getLockField(), setLockField()
void addSeedValueDigestMethod ( string  aDigestMethod)

Add a DigestMethod value to the seed value dictionary.

See getSeedValueDigestMethod() for details.

Parameters
[in]aDigestMethodThe DigestMethod value.
See also
clearSeedValueDigestMethods(), getSeedValueDigestMethod(), setSeedValueDigestMethod()
void addSeedValueSubFilter ( string  aSubFilter)

Add a SubFilter value to the seed value dictionary.

See getSeedValueSubFilter() for details.

Parameters
[in]aSubFilterThe SubFilter value.
See also
clearSeedValueSubFilters(), getSeedValueSubFilter(), setSeedValueSubFilter()
void addValue ( string  aValue)

Add a value to the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if FieldFlags.MultiSelect is set.

Hard line breaks for multiline text fields (ie, text fields with flag FieldFlags.MultiLine set) are encoded as "\r", "\n", or "\r\n". The behavior for values containing line breaks is undefined if the FieldFlags.MultiLine flag is not set.

After calling this function, getValueIndex() will return -1.

Parameters
[in]aValueThe value to be added. Complex scripts are supported, see Complex Scripts.
See also
clearValues(), getValue(), getValueIndex(), setValue()
bool addWidget ( )

Add a widget to the field.

The new widget will be added at the end, ie, calling getWidgetCount() before calling addWidget() yields the index of the widget that will be added.

After adding a widget, the new widget will be selected. You must set the page number and the coordinates in the new widget before calling SignDocDocument.addField() or SignDocDocument.setField().

Returns
true iff successful.
See also
addChoice(), getWidget(), getWidgetCount(), insertWidget(), removeWidget(), selectWidget()
void clearCertSeedValueIssuerCertificates ( )

Remove all issuer certificates from the certificate seed value dictionary.

See the PDF Reference for details.

After calling this function, getCertSeedValueIssuerCertificateCount() will return 0.

See also
addCertSeedValueIssuerCertificate(), getCertSeedValueIssuerCertificateCount(), removeCertSeedValueIssuerCertificate()
void clearCertSeedValuePolicies ( )

Remove all policy OIDs from the certificate seed value dictionary.

See the PDF Reference for details.

After calling this function, getCertSeedValuePolicyCount() will return 0.

See also
addCertSeedValuePolicy(), getCertSeedValuePolicyCount(), removeCertSeedValuePolicy()
void clearCertSeedValueSubjectCertificates ( )

Remove all subject certificates from the certificate seed value dictionary.

See the PDF Reference for details.

After calling this function, getCertSeedValueSubjectCertificateCount() will return 0.

See also
addCertSeedValueSubjectCertificate(), getCertSeedValueSubjectCertificateCount(), removeCertSeedValueSubjectCertificate()
void clearCertSeedValueSubjectDNs ( )

Remove all subject distinguished names from the certificate seed value dictionary.

See the PDF Reference for details.

After calling this function, getCertSeedValueSubjectDNCount() will return 0.

See also
addCertSeedValueSubjectDN(), getCertSeedValueSubjectDNCount(), removeCertSeedValueSubjectDN()
void clearChoices ( )

Clear the choices of a list box or combo box.

After calling this function, getChoiceCount() will return 0.

See also
addChoice(), getChoiceCount(), removeChoice(), setButtonValue()
void clearLockFields ( )

Clear the lock fields.

After calling this function, getLockFieldCount() will return 0.

See also
addLockField(), getLockFieldCount(), removeLockField()
void clearSeedValueDigestMethods ( )

Remove all DigestMethod values from the seed value dictionary.

See getSeedValueDigestMethod() for details.

After calling this function, getSeedValueDigestMethodCount() will return 0.

See also
addSeedValueDigestMethod(), getSeedValueDigestMethodCount(), removeSeedValueDigestMethod()
void clearSeedValueSubFilters ( )

Remove all SubFilter values from the seed value dictionary.

See getSeedValueSubFilter() for details.

After calling this function, getSeedValueSubFilterCount() will return 0.

See also
addSeedValueSubFilter(), getSeedValueSubFilterCount(), removeSeedValueSubFilter()
void clearValues ( )

Clear the values.

After calling this function, getValueCount() will return 0 and getValueIndex() will return -1.

See also
addValue(), getValueCount(), getValueIndex(), removeValue()
bool clickButton ( int  aIndex)

Click a check box or a radio button.

This function updates both the value (see setValue()) and the value index (see setValueIndex()) based on the current (non-committed) state of the SignDocField object (not looking at the state of the field in the document). It does nothing for other field types.

Adobe products seem to ignore FieldFlags.NoToggleToOff flag being not set, this function behaves the same way (ie, as if FieldFlags.NoToggleToOff was set).

Note
A return value of false does not indicate an error!
Parameters
[in]aIndexThe 0-based index of the widget being clicked.
Returns
true if anything has been changed, false if nothing has been changed (wrong field type, aIndex out of range, radio button already active).
string getAlternateName ( )

Get the alternate name of the field.

The alternate name (if present) should be used for displaying the field name in a user interface. Currently, only PDF documents support alternate field names.

Returns
The alternate name of the field, empty if the field does not have an alternate name. If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
getMappingName(), getName(), setAlternateName()
SignDocColor getBackgroundColor ( )

Get the background color of the widget.

This function is available for fields of PDF documents only.

Returns
An object describing the background color or null if the widget does not have a background color (transparent background).
See also
getEmptyFieldColor(), selectWidget(), setBackgroundColor()
SignDocColor getBorderColor ( )

Get the border color of the widget.

This function is available for fields of PDF documents only.

The border color is used only if the border width is positive.

Returns
An object describing the border color or null if the widget does not have a border color.
See also
getBorderWidth(), selectWidget(), setBorderColor()
FieldBorderStyle getBorderStyle ( )

Get the border style.

This function is available for fields of PDF documents only.

Returns
The border style, see FieldBorderStyle.
See also
selectWidget(), setBorderStyle()
double getBorderWidth ( )

Get the border width of the widget.

This function is available for fields of PDF documents only.

Returns
The border width
See also
getBorderColor(), getBorderStyle(), selectWidget(), setBorderWidth()
double getBottom ( )

Get the bottom coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems.

Returns
The bottom coordinate.
See also
getLeft(), getRight(), getTop(), selectWidget(), setBottom()
FieldButtonStyle getButtonStyle ( )

Get the button style of a check box or radio button field.

This function is available for fields of PDF documents only.

Returns
The button style, see FieldButtonStyle (FieldButtonStyle.Default will never be returned).
See also
selectWidget(), setButtonStyle()
string getButtonValue ( )

Get the button value of a widget of a radio button group or check box.

Usually, different radio buttons (widgets) of a radio button group (field) have different values. The radio button group has a value (returned by getValue()) which is either "Off" or one of those values. The individual buttons (widgets) of a check box field can also have different export values.

Different radio buttons (widgets) of a radio button group (field) can have the same value; in that case, the radio buttons are linked. The individual buttons of a check box field also can have the same value.

Returns
The button value an empty string (for field types that don't use button values). If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
getChoiceExport(), getChoiceValue(), getValue(), setButtonValue()
CertSeedValueFlags getCertSeedValueFlags ( )

Get the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field, see enum CertSeedValueFlags.

The default value is 0.

Returns
The certificate seed value dictionary flags of the field.
See also
setCertSeedValueFlags()
byte [] getCertSeedValueIssuerCertificate ( int  aIndex)

Get an issuer certificate of the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndex0-based index of the issuer certificate.
Returns
The selected DER-encoded certificate or null if the index is out of range.
Note
The WinRT component returns null instead of an empty blob.
See also
addCertSeedValueIssuerCertificate(), clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificateCount(), removeCertSeedValueIssuerCertificate(), setCertSeedValueIssuerCertificate()
int getCertSeedValueIssuerCertificateCount ( )

Get the number of issuer certificates in the certificate seed value dictionary.

See the PDF Reference for details.

Returns
The number of issuer certificates.
See also
addCertSeedValueIssuerCertificate(), clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate(), removeCertSeedValueIssuerCertificate()
string getCertSeedValuePolicy ( int  aIndex)

Get a policy OID from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndex0-based index of the policy OID.
Returns
The selected policy OID or an empty string if the index is out of range.
See also
addCertSeedValuePolicy(), clearCertSeedValuePolicies(), getCertSeedValuePolicyCount(), removeCertSeedValuePolicy(), setCertSeedValuePolicy()
int getCertSeedValuePolicyCount ( )

Get the number of policy OIDs in the certificate seed value dictionary.

See the PDF Reference for details.

Returns
The number of policy OIDs.
See also
addCertSeedValuePolicy(), clearCertSeedValuePolicies(), getCertSeedValuePolicy(), removeCertSeedValuePolicy()
byte [] getCertSeedValueSubjectCertificate ( int  aIndex)

Get a subject certificate of the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndex0-based index of the subject certificate.
Returns
The selected DER-encoded certificate or null if the index is out of range.
Note
The WinRT component returns null instead of an empty blob.
See also
addCertSeedValueSubjectCertificate(), clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificateCount(), removeCertSeedValueSubjectCertificate(), setCertSeedValueSubjectCertificate()
int getCertSeedValueSubjectCertificateCount ( )

Get the number of subject certificates in the certificate seed value dictionary.

See the PDF Reference for details.

Returns
The number of subject certificates.
See also
addCertSeedValueSubjectCertificate(), clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate(), removeCertSeedValueSubjectCertificate()
string getCertSeedValueSubjectDN ( int  aIndex)

Get a subject distinguished name from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the value to be retrieved.
Returns
The selected subject distinguished name (formatted according to RFC 4514) or an empty string if the index is out of range.
See also
addCertSeedValueSubjectDN(), clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDNCount(), removeCertSeedValueSubjectDN(), setCertSeedValueSubjectDN()
int getCertSeedValueSubjectDNCount ( )

Get the number of subject distinguished names in the certificate seed value dictionary.

See the PDF Reference for details.

Returns
The number of subject distinguished names in the certificate seed value dictionary.
See also
addCertSeedValueSubjectDN(), clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN(), removeCertSeedValueSubjectDN()
int getChoiceCount ( )

Get the number of available choices for a list box or combo box.

List boxes and combo boxes can have multiple possible choices. For other field types, this function returns 0.

Returns
The number of available choices or 0 if not supported for the type of this field.
See also
getButtonValue(), getChoiceExport(), getChoiceValue(), getValueCount()
string getChoiceExport ( int  aIndex)

Get the export value for an available choice of a list box or combo box.

List boxes and combo boxes can have multiple possible choices. Each choice has a value (which will be displayed) and an export value (which is used for exporting the value of the field). Usually, both values are identical. This function returns one export value, use getChoiceValue() to get the associated choice value.

Note
getValue() and setValue() use the export value.
Parameters
[in]aIndex0-based index of the export value.
Returns
The selected export value of the field or an empty string if the index is out of range. If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
addChoice(), clearChoices(), getButtonValue(), getChoiceCount(), getChoiceValue(), removeChoice(), setChoice()
string getChoiceValue ( int  aIndex)

Get an available choice of a list box or combo box.

List boxes and combo boxes can have multiple possible choices. Each choice has a value (which will be displayed) and an export value (which is used for exporting the value of the field). This function returns one choice value, use getChoiceExport() to get the associated export value.

Note
getValue() and setValue() use the export value.
Parameters
[in]aIndex0-based index of the choice value.
Returns
The selected choice value of the field or an empty string if the index is out of range. If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
addChoice(), clearChoices(), getButtonValue(), getChoiceCount(), getChoiceExport(), removeChoice(), setChoice()
int getDocMDP ( )

Get the DocMDP P value of a certification signature.

The DocMDP P value specifies what modifications to the document are allowed by the certification signature.

This function does not verify the certification signature.

Returns
-1 if this field is not a certification signature, 1 if no modifications are allowed, 2 if only filling in forms, instantiating page templates, and signing are permitted, 3 if only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations are permitted. For TIFF documents, this function always returns -1.
See also
getLockMDP(), getSignatureType(), SignDocDocument.getDocMDP(), SignDocDocument.setShootInFoot(), SignDocVerificationResult.getDocMDP()
SignDocColor getEmptyFieldColor ( )

Get the color used for empty signature field in TIFF document.

The default value is white.

Returns
The color used for empty signature field in TIFF document. The return value is not defined for other cases.
See also
getBackgroundColor(), setEmptyFieldColor()
FieldFlags getFlags ( )

Get the flags of the field, see enum FieldFlags.

The default value is 0 (FieldFlags.Radio and FieldFlags.Pushbutton will be computed from the field type).

Do not set FieldFlags.ReadOnly yourself to lock a field before or after signing. Instead, use setLockType() when adding the signature field.

Returns
The flags of the field.
See also
setFlags()
FieldJustification getJustification ( )

Get the justification of the widget.

The default value is FieldJustification.None.

Returns
The justification of the widget for text fields and list boxes, FieldJustification.None for other fields.
See also
selectWidget(), setJustification()
double getLeft ( )

Get the left coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems.

Returns
The left coordinate.
See also
getBottom(), getRight(), getTop(), selectWidget(), setLeft()
string getLockField ( int  aIndex)

Get the name of a lock field.

Parameters
[in]aIndex0-based index of the lock field.
Returns
The name of the selected lock field or an empty string if the index is out of range. If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
addLockField(), clearLockFields(), getLockFieldCount(), removeLockField(), setLockField()
int getLockFieldCount ( )

Get the number of field names for LockType.Include and LockType.Exclude.

Returns
The number of field names.
See also
addLockField(), clearLockFields(), getLockField(), removeLockField()
int getLockMDP ( )

Get the lock MDP value.

Returns
The lock MDP value: -1 if there is no lock MDP value, 1 if no modifications are allowed, 2 if only filling in forms, instantiating page templates, and signing are permitted, 3 if only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations are permitted.
See also
getDocMDP(), setLockMDP()
LockType getLockType ( )

Get the lock type.

The lock type defines the fields to be locked when signing this signature field.

Returns
The lock type.
See also
getLockField(), setLockType()
string getMappingName ( )

Get the mapping name of the field.

The mapping name (if present) should be used for exporting field data. Currently, only PDF documents support mapping field names.

Returns
The mapping name of the field, empty if the field does not have an mapping name. If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
getAlternateName(), getName(), setMappingName()
int getMaxLen ( )

Get maximum length of text field.

The default value is -1.

Returns
The maximum length of text fields or -1 if the field is not a text field or if the text field does not have a maximum length.
See also
setMaxLen()
string getName ( )

Get the name of the field.

Returns
The name of the field. If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
getAlternateName(), getMappingName(), setName()
int getPage ( )

Get the page number.

This function returns the index of the page on which this field occurs (1 for the first page), or 0 if the page number is unknown.

Returns
The 1-based page number or 0 if the page number is unknown.
See also
selectWidget(), setPage()
double getRight ( )

Get the right coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems. If coordinates are given in pixels (this is true for TIFF documents), this coordinate is exclusive.

Returns
The right coordinate.
See also
getBottom(), getLeft(), getTop(), selectWidget(), setRight()
int getRotation ( )

Get the rotation of the widget contents.

The rotation is specified in degrees (counter-clockwise). The default value is 0.

For instance, if the rotation is 270, left-to right text will display top down.

Returns
The rotation of the widget: 0, 90, 180, or 270.
See also
selectWidget(), setJustification()
bool getSeedValueAddRevInfo ( )

Get the AddRevInfo flag from the signature field seed value dictionary.

If the AddRevInfo flag is set, revocation must be checked at signing time and revocation data must be included in the signature.

Returns
true if the AddRevInfo flag is set and the Ff entry specifies that AddRevInfo is a mandatory constraint. false otherwise.
See also
setSeedValueAddRevInfo()
string getSeedValueDigestMethod ( int  aIndex)

Get a DigestMethod value from the seed value dictionary.

DigestMethod values in the seed value dictionary restrict the hash algorithms available for signing with RSA.

Note that DigestMethod values are different from the message digest algorithms returned by SignDocVerificationResult.getDigestAlgorithm():

DigestMethodgetDigestAlgorithm()DetachedHashAlgorithm
n/a "MD5" n/a
"RIPEMD160" "RIPEMD-160" "RIPEMD-160"
"SHA1" "SHA-1" "SHA-1"
- "SHA-224" "SHA-224"
"SHA256" "SHA-256" "SHA-256"
"SHA384" "SHA-384" "SHA-384"
"SHA512" "SHA-512" "SHA-512"
Parameters
[in]aIndex0-based index of the DigestMethod value.
Returns
The selected DigestMethod value or an empty string if the index is out of range.
See also
addSeedValueDigestMethod(), clearSeedValueDigestMethods(), getSeedValueDigestMethodCount(), getSeedValueDigestMethodRequired(), removeSeedValueDigestMethod(), setSeedValueDigestMethod()
int getSeedValueDigestMethodCount ( )

Get the number of DigestMethod values in the seed value dictionary.

See getSeedValueDigestMethod() for details.

Returns
The number of DigestMethod values.
See also
addSeedValueDigestMethod(), clearSeedValueDigestMethods(), getSeedValueDigestMethod(), removeSeedValueDigestMethod()
bool getSeedValueDigestMethodRequired ( )

This function gets a flag from the signature field seed value dictionary that indicates whether the DigestMethod values are a required constraint or not.

If this function returns true, a signing method corresponding to one of the DigestMethod values returned by getSeedValueDigestMethod() must be used for signing.

Returns
true iff one of the DigestMethod values returned by getSeedValueDigestMethod() must be used.
See also
getSeedValueDigestMethodCount(), getSeedValueDigestMethod(), setSeedValueDigestMethodRequired()
string getSeedValueFilter ( )

Get Filter entry (signature handler) from the signature field seed value dictionary.

Note
The Filter entry should be an ASCII string.
Returns
The Filter entry (signature handler) or an empty string if the signature field seed value dictionary does not have a Filter entry.
See also
getSeedValueFilterRequired(), setSeedValueFilter()
bool getSeedValueFilterRequired ( )

This function gets a flag from the signature field seed value dictionary that indicates whether the Filter entry (signature handler) is a required constraint or not.

If this function returns true, the signature handler returned by getSeedValueFilter() must be used for signing.

Note
Adobe Reader seems to ignore this flag.
Returns
true iff the signature handler returned by getSeedValueFilter() must be used.
See also
getSeedValueFilter()
int getSeedValueMDP ( )

Get the MDP value from the signature field seed value dictionary.

Returns
-1 if the MDP value is not set, 0 for an approval signature, 1 through 3 for a certification signature:
  • 1 no changes to the document shall be permitted
  • 2 only filling in forms, instantiating page templates, and signing shall be permitted
  • 3 only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations shall be permitted.
See also
setSeedValueMDP()
string getSeedValueSubFilter ( int  aIndex)

Get a SubFilter value from the seed value dictionary.

SubFilter values in the seed value dictionary restrict the signing methods available for signing. These values are currently defined:

Parameters
[in]aIndex0-based index of the SubFilter value.
Returns
The selected SubFilter value or an empty string if the index is out of range.
See also
addSeedValueSubFilter(), clearSeedValueSubFilters(), getSeedValueSubFilterCount(), getSeedValueSubFilterRequired(), removeSeedValueSubFilter(), setSeedValueSubFilter()
int getSeedValueSubFilterCount ( )

Get the number of SubFilter values in the seed value dictionary.

See getSeedValueSubFilter() for details.

Returns
The number of SubFilter values.
See also
addSeedValueSubFilter(), clearSeedValueSubFilters(), getSeedValueSubFilter(), removeSeedValueSubFilter()
bool getSeedValueSubFilterRequired ( )

This function gets a flag from the signature field seed value dictionary that indicates whether the SubFilter values are a required constraint or not.

If this function returns true, a signing method corresponding to one of the SubFilter values returned by getSeedValueSubFilter() must be used for signing.

Returns
true iff one of the SubFilter values returned by getSeedValueSubFilter() must be used.
See also
getSeedValueSubFilterCount(), getSeedValueSubFilter(), setSeedValueSubFilterRequired()
bool getSeedValueTimeStampRequired ( )

This function gets a flag from the signature field seed value dictionary that indicates whether a time stamp is required or not for the signature.

If this function returns true, the URL returned by getSeedValueTimeStampServerURL() will be used to add a time stamp to the signature when signing.

Returns
false if a time stamp is not required, true if a time stamp is required.
See also
getSeedValueTimeStampServerURL()
string getSeedValueTimeStampServerURL ( )

Get the URL of the RFC 3161 time-stamp server from the signature field seed value dictionary.

Note
The URL should be an ASCII string.
Returns
The URL of the time-stamp server or an empty string if no time-stamp server is defined.
See also
getSeedValueTimeStampRequired(), setSeedValueTimeStamp()
SignatureType getSignatureType ( )

Get the signature type of a signature field.

For TIFF documents, only approval signatures are available.

For SignatureType.Certification, you should display "certified by ..." rather than "signed by ...".

Returns
The signature type.
See also
getDocMDP(), isSigned()
SignDocTextFieldAttributes getTextFieldAttributes ( )

Get the text field attributes of the widget.

This function returns null if the field uses the document's default font name for fields.

Text fields, signature fields, list boxes, and combo boxes can have text field attributes.

Returns
A SignDocTextFieldAttributes object if successful, null on error.
See also
selectWidget(), setTextFieldAttributes(), SignDocDocument.getTextFieldAttributes()
double getTop ( )

Get the top coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems. If coordinates are given in pixels (this is true for TIFF documents), this coordinate is exclusive.

Returns
The top coordinate.
See also
getBottom(), getLeft(), getRight(), selectWidget(), setTop()
int getTopIndex ( )

Get the index of the choice to be displayed in the first line of a list box.

The default value is 0.

Returns
The index of the choice to be displayed in the first line of a list box or 0 for other field types.
See also
getChoiceValue(), setTopIndex()
FieldType getType ( )

Get the type of the field.

The default value is FieldType.Unknown.

Returns
The type of the field.
See also
setType()
string getValue ( int  aIndex)

Get a value of the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if FieldFlags.MultiSelect is set.

Hard line breaks for multiline text fields (ie, text fields with flag FieldFlags.MultiLine set) are encoded as "\r", "\n", or "\r\n".

Parameters
[in]aIndex0-based index of the value.
Returns
The selected value of the field or an empty string if the index is out of range. If flag DocumentFlags.KeepEscapeSequences is set, the string may contain escape sequences for selecting natural languages.
See also
addValue(), clearValues(), getChoiceValue(), getValueCount(), getValueIndex(), removeValue(), setValue()
int getValueCount ( )

Get the number of values of the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if FieldFlags.MultiSelect is set.

Returns
The number of values.
See also
getChoiceCount(), getValue()
int getValueIndex ( )

Get the current value index.

Radio button groups and check box fields can have multiple widgets having the same button value. For check box fields and radio buttons without FieldFlags.RadiosInUnison set, specifying the selected button by value string is not possible in that case. A 0-based value index can be used to find out which button is selected or to select a button.

Radio button groups and check box fields need not use a value index; in fact, they usually don't.

SignDocDocument.addField() and SignDocDocument.setField() update the value index if the value of a radio button group or check box field is selected by string (ie, setValue()) and the field has ambiguous button names.

The "Off" value never has a value index.

Note
addValue(), clearValues(), and setValue() make the value index unset (ie, getValueIndex() will return -1).
Returns
the 0-based value index or -1 if the value index is not set.
See also
clickButton(), getValue(), setValueIndex()
int getWidget ( )

Get the index of the currently selected widget.

Initially, the first widget is selected (ie, this function returns 0). However, there is an exception to this rule: SignDocField objects created by SignDocDocument.getFieldsOfPage() can have a different widget selected initially for PDF documents.

Returns
The 0-based index of the currently selected widget.
See also
selectWidget()
int getWidgetCount ( )

Get the number of widgets.

Signature fields always have exactly one widget. Radio button fields (radio button groups) usually have one widget per button (but can have more widgets than buttons by having multiple widgets for some or all buttons).

Returns
The number of widgets for this field.
WidgetFlags getWidgetFlags ( )

Get the annotation flags of the widget, see enum WidgetFlags.

The default value is WidgetFlags.Print. The annotation flags are used for PDF documents only. Currently, the semantics of the annotation flags are ignored by this software (ie, the flags are stored in the document, but they don't have any meaning to this software).

Returns
The annotation flags of the widget.
See also
selectWidget(), setWidgetFlags()
bool insertWidget ( int  aIndex)

Add a widget to the field in front of another widget.

The new widget will be inserted at the specified index, ie, the index of the new widget will be aIndex.

After adding a widget, the new widget will be selected. You must set the page number and the coordinates in the new widget before calling SignDocDocument.addField() or SignDocDocument.setField().

Parameters
[in]aIndex0-based index of the widget in front of which the new widget shall be inserted. You can pass the current number of widgets as returned by getWidgetCount() to add the new widget to the end as addWidget() does.
Returns
true iff successful.
See also
addWidget(), getWidget(), getWidgetCount(), removeWidget(), selectWidget(), setValueIndex
bool isCurrentlyClearable ( )

Check if this signature field is currently clearable.

For some document formats (TIFF), signatures may only be cleared in the reverse order of signing (LIFO). Use this function to find out whether the signature field is currently clearable (as determined by SignDocDocument.getField() or SignDocDocument.getFields(),

Note
The value returned by this function does not change over the lifetime of this object and therefore may not reflect the current state if signature fields have been signed or cleared since this object was created.
Returns
true iff this is a signature field that can be cleared now.
See also
SignDocDocument.getField(), SignDocDocument.getFields()
bool isSigned ( )

Check if this field is a signed signature field.

This function is much more efficient than SignDocDocument.verifySignature() and SignDocDocument.verifySignature2().

Returns
true if this field is a signed signature field, false if this field is not a signature field or if this field is a signature field that is not signed.
See also
getSignatureType(), SignDocDocument.verifySignature()
bool removeCertSeedValueIssuerCertificate ( int  aIndex)

Remove an issuer certificate from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the issuer certificate to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate()
bool removeCertSeedValuePolicy ( int  aIndex)

Remove a policy OID from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the policy OID to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
clearCertSeedValuePolicies(), getCertSeedValuePolicy()
bool removeCertSeedValueSubjectCertificate ( int  aIndex)

Remove a subject certificate from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the subject certificate to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate()
bool removeCertSeedValueSubjectDN ( int  aIndex)

Remove a subject distinguished name from the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the subject distinguished name to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN()
bool removeChoice ( int  aIndex)

Remove a choice from a list box or combo box.

Parameters
[in]aIndexThe 0-based index of the choice to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
addChoice(), clearChoices()
bool removeLockField ( int  aIndex)

Remove a lock field.

Parameters
[in]aIndexThe 0-based index of the lock field to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
clearLockFields(), getLockField()
bool removeSeedValueDigestMethod ( int  aIndex)

Remove a DigestMethod value from the seed value dictionary.

See getSeedValueDigestMethod() for details.

Parameters
[in]aIndexThe 0-based index of the DigestMethod value to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
clearSeedValueDigestMethods(), getSeedValueDigestMethod()
bool removeSeedValueSubFilter ( int  aIndex)

Remove a SubFilter value from the seed value dictionary.

See getSeedValueSubFilter() for details.

Parameters
[in]aIndexThe 0-based index of the SubFilter value to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
clearSeedValueSubFilters(), getSeedValueSubFilter()
bool removeValue ( int  aIndex)

Remove a value from the field.

After calling this function, getValueIndex() will return -1.

Parameters
[in]aIndexThe 0-based index of the value to be removed.
Returns
true if successful, false if aIndex is out of range.
See also
clearValues(), getValue(), getValueIndex()
bool removeWidget ( int  aIndex)

Remove a widget from the field.

This function fails when there is only one widget. That is, a field always has at least one widget.

If the currently selected widget is removed, the following rules apply:

  • When removing the last widget (the one with index getWidgetCount()-1), the predecessor of the removed widget will be selected.
  • Otherwise, the index of the selected widget won't change, ie, the successor of the removed widget will be selected.

If the widget to be removed is not selected, the currently selected widget will remain selected.

All widgets having an index greater than aIndex will have their index decremented by one.

Parameters
[in]aIndex0-based index of the widget to remove.
Returns
true iff successful.
See also
addWidget(), getWidget(), getWidgetCount(), insertWidget(), selectWidget(), setValueIndex
void setAlternateName ( string  aName)

Set the alternate name of the field.

The alternate name (if present) should be used for displaying the field name in a user interface. Currently, only PDF documents support alternate field names.

Parameters
[in]aNameThe alternate name of the field, empty to remove any alternate field name. Use SignDocDocument.withEscapeSequence() to add a language code. See FieldFlags.RequireAlternateFieldName for details.
See also
getAlternateName(), getName(), setMappingName(), setName(), SignDocDocument.withEscapeSequence(), DocumentFlags.RequireAlternateFieldName
void setBackgroundColor ( SignDocColor  aColor)

Set the background color of the widget.

This function is available for fields of PDF documents only.

The initial value is null (transparent).

Parameters
[in]aColornull for transparent or a SignDocColor object representing the new background color.
See also
getBackgroundColor(), selectWidget(), setEmptyFieldColor()
void setBorderColor ( SignDocColor  aColor)

Set the border color of the widget.

This function is available for fields of PDF documents only.

The border color is used only if the border width is positive.

For combo boxes, check boxes, and radio buttons, the initial value is black, for other field types, the initial value is transparent. After creation of a SignDocField object, calling setType() will set the border color accordingly. Once setBorderColor() has been called, setType() will no longer affect the border color.

Parameters
[in]aColornull for transparent or a SignDocColor object representing the new border color.
See also
getBorderColor(), selectWidget(), setBorderStyle(), setBorderWidth(), setType()
void setBorderStyle ( FieldBorderStyle  aStyle)

Set the border style.

This function is available for fields of PDF documents only.

If aStyle is FieldBorderStyle.Other, SignDocDocument.setField() will keep the current border style and SignDocDocument.addField() will fail.

Parameters
[in]aStyleThe new border style, see FieldBorderStyle.
See also
selectWidget(), getBorderStyle()
void setBorderWidth ( double  aWidth)

Set the border width of the widget.

This function is available for fields of PDF documents only.

The initial value is 1.

Parameters
[in]aWidthThe new border width.
See also
getBorderWidth(), selectWidget(), setBorderColor(), setBorderStyle()
void setBottom ( double  aBottom)

Set the bottom coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems.

Parameters
[in]aBottomThe bottom coordinate.
See also
getBottom(), selectWidget(), setLeft(), setRight(), setTop(), SetFieldFlags.Move
void setButtonStyle ( FieldButtonStyle  aStyle)

Set the button style of a check box or radio button field.

This function is available for fields of PDF documents only.

If aStyle is FieldButtonStyle.Other, SignDocDocument.setField() will keep the current border style and SignDocDocument.addField() will fail.

Parameters
[in]aStyleThe new button style, see FieldButtonStyle.
See also
getButtonStyle(), selectWidget()
void setButtonValue ( string  aValue)

Set the button value of a widget of a radio button group or a check box.

Usually, different radio buttons (widgets) of a radio button group (field) have different values. The radio button group has a value (returned by getValue()) which is either "Off" or one of those values. The individual buttons (widgets) of a check box field can also have different export values.

Different radio buttons (widgets) of a radio button group (field) can have the same value; in that case, the radio buttons are linked. The individual buttons of a check box field also can have the same value.

SignDocDocument.addField() and SignDocDocument.setField() ignore the value set by this function if the field is neither a radio button group nor a check box field.

Parameters
[in]aValueThe value to be set. Must not be empty, must not be "Off".
See also
getButtonValue(), getChoiceValue(), getValue(), selectWidget()
void setCertSeedValueFlags ( CertSeedValueFlags  aFlags)

Set the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field, see enum CertSeedValueFlags.

The default value is 0.

Parameters
[in]aFlagsThe certificate seed value dicitionary flags of the field.
See also
getCertSeedValueFlags()
bool setCertSeedValueIssuerCertificate ( int  aIndex,
byte[]  aCert 
)

Set an issuer certificate in the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]aCertThe DER-encoded certificate.
Returns
true if successful, false if aIndex is out of range or if aCert cannot be parsed.
See also
clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate()
void setCertSeedValueIssuerCertificate ( byte[]  aCert)

Set an issuer certificate in the certificate seed value dictionary.

See the PDF Reference for details.

Calling this function is equivalent to calling clearCertSeedValueIssuerCertificates() and addCertSeedValueIssuerCertificate().

Parameters
[in]aCertThe DER-encoded certificate.
See also
clearCertSeedValueIssuerCertificates(), getCertSeedValueIssuerCertificate()
bool setCertSeedValuePolicy ( int  aIndex,
string  aOID 
)

Set a policy OID in the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]aOIDThe policy OID.
Returns
true if successful, false if aIndex is out of range or if aOID cannot be parsed.
See also
clearCertSeedValuePolicies(), getCertSeedValuePolicy()
void setCertSeedValuePolicy ( string  aOID)

Set a policy OID in the certificate seed value dictionary.

See the PDF Reference for details.

Calling this function is equivalent to calling clearCertSeedValuePolicies() and addCertSeedValuePolicy().

Parameters
[in]aOIDThe policy OID.
See also
clearCertSeedValuePolicies(), getCertSeedValuePolicy()
bool setCertSeedValueSubjectCertificate ( int  aIndex,
byte[]  aCert 
)

Set a subject certificate in the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]aCertThe DER-encoded certificate.
Returns
true if successful, false if aIndex is out of range or if aCert cannot be parsed.
See also
clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate()
void setCertSeedValueSubjectCertificate ( byte[]  aCert)

Set a subject certificate in the certificate seed value dictionary.

See the PDF Reference for details.

Calling this function is equivalent to calling clearCertSeedValueSubjectCertificates() and addCertSeedValueSubjectCertificate().

Parameters
[in]aCertThe DER-encoded certificate.
See also
clearCertSeedValueSubjectCertificates(), getCertSeedValueSubjectCertificate()
bool setCertSeedValueSubjectDN ( int  aIndex,
string  aName 
)

Set a subject distinguished name in the certificate seed value dictionary.

See the PDF Reference for details.

Parameters
[in]aIndexThe 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]aNameThe subject distinguished name formatted according to RFC 4514.
Returns
true if successful, false if aIndex is out of range or if aName cannot be parsed.
See also
clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN()
bool setCertSeedValueSubjectDN ( string  aName)

Set a subject distinguished name in the certificate seed value dictionary.

See the PDF Reference for details.

Calling this function is equivalent to calling clearCertSeedValueSubjectDNs() and addCertSeedValueSubjectDN(), but the encoding of aName is checked before modifying this object.

Parameters
[in]aNameThe subject distinguished name formatted according to RFC 4514.
Returns
true if successful, false if aName cannot be parsed.
See also
clearCertSeedValueSubjectDNs(), getCertSeedValueSubjectDN()
bool setChoice ( int  aIndex,
string  aValue 
)

Set a choice value of a list box or combo box.

This function uses the choice value as export value.

Note
getValue() and setValue() use the export value.
Parameters
[in]aIndexThe 0-based index of the choice to be set. If aIndex equals the current number of choice, the value will be added.
[in]aValueThe choice value and export value to be set. Complex scripts are supported, see Complex Scripts.
Returns
true if successful, false if aIndex is out of range.
See also
clearChoices(), getChoiceExport(), getChoiceValue(), setButtonValue()
bool setChoice ( int  aIndex,
string  aValue,
string  aExport 
)

Set a choice value of a list box or combo box.

Note
getValue() and setValue() use the export value.
Parameters
[in]aIndexThe 0-based index of the choice to be set. If aIndex equals the current number of choice, the value will be added.
[in]aValueThe choice value to be set. Complex scripts are supported, see Complex Scripts.
[in]aExportThe export value to be set.
Returns
true if successful, false if aIndex is out of range.
See also
clearChoices(), getChoiceExport(), getChoiceValue(), setButtonValue()
void setEmptyFieldColor ( SignDocColor  aColor)

Set color used for empty signature field in TIFF document.

The default value is white. For non-TIFF documents, the value set by this function is ignored. The value is also ignored if compatibility with version 1.12 and earlier is requested.

Parameters
[in]aColorThe new color.
See also
getEmptyFieldColor(), setBackgroundColor(), SignDocDocument.setCompatibility()
void setFlags ( FieldFlags  aFlags)

Set the flags of the field, see enum FieldFlags.

The default value is 0 (FieldFlags.Radio and FieldFlags.Pushbutton will be computed from the field type).

Parameters
[in]aFlagsThe flags of the field.
See also
getFlags()
void setJustification ( FieldJustification  aJustification)

Set the justification of the widget.

The default value is FieldJustification.None.

For text fields and list boxes, the justification must be FieldJustification.Left, FieldJustification.Center, or FieldJustification.Right. For other fields, the justification must be FieldJustification.None.

Parameters
[in]aJustificationThe justification.
See also
getJustification(), selectWidget()
void setLeft ( double  aLeft)

Set the left coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems.

Parameters
[in]aLeftThe left coordinate.
See also
getLeft(), selectWidget(), setBottom(), setRight(), setTop(), SetFieldFlags.Move
bool setLockField ( int  aIndex,
string  aName 
)

Set a lock field.

Parameters
[in]aIndexThe 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]aNameThe name of the lock field to be set.
Returns
true if successful, false if aIndex is out of range.
See also
clearLockFields(), getLockField()
void setLockField ( string  aName)

Set a lock field.

Calling this function is equivalent to calling clearLockFields() and addLockField().

Parameters
[in]aNameThe name of the lock field to be set.
See also
clearLockFields(), getLockField()
void setLockMDP ( int  aMDP)

Set the lock MDP value.

Parameters
[in]aMDPThe new lock MDP value:
  • 1 no changes to the document shall be permitted
  • 2 only filling in forms, instantiating page templates, and signing shall be permitted
  • 3 only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations shall be permitted.
See also
getDocMDP(), getLockMDP()
void setLockType ( LockType  aLockType)

Set the lock type.

The lock type defines the fields to be locked when signing this signature field.

Parameters
[in]aLockTypeThe new lock type.
See also
addLockField(), getLockType()
void setMappingName ( string  aName)

Set the mapping name of the field.

The mapping name (if present) should be used for exporting field data. Currently, only PDF documents support mapping field names.

Parameters
[in]aNameThe mapping name of the field, empty to remove any mapping name.
See also
getMappingName(), getName(), setAlternateName(), setName()
void setMaxLen ( int  aMaxLen)

Set maximum length of text fields.

Parameters
[in]aMaxLenThe maximum length (in characters) of the text field or -1 for no maximum length.
See also
getMaxLen()
void setName ( string  aName)

Set the name of the field.

Different document types impose different restrictions on field names. PDF fields have hierarchical field names with components separated by dots.

SignDocDocument.setField() operates on the field having a fully-qualified name which equals the name set by this function. In consequence, SignDocDocument.setField() cannot change the name of a field.

Parameters
[in]aNameThe name of the field.
See also
getName(), setAlternateName(), setMappingName()
void setPage ( int  aPage)

Set the page number.

This function sets the index of the page on which this field occurs (1 for the first page).

By calling SignDocDocument.getField(), setPage(), and SignDocDocument.setField(), you can move a field's widget to another page.

Parameters
[in]aPageThe 1-based page number of the field.
See also
getPage(), selectWidget()
void setRight ( double  aRight)

Set the right coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems. If coordinates are given in pixels (this is true for TIFF documents), this coordinate is exclusive.

Parameters
[in]aRightThe right coordinate.
See also
getRight(), selectWidget(), setBottom(), setLeft(), setTop(), SetFieldFlags.Move
void setRotation ( int  aRotation)

Set the rotation of the widget contents.

The rotation is specified in degrees (counter-clockwise). The default value is 0.

For instance, if the rotation is 270, left-to right text will display top down.

Currently, the rotation must always be 0 for TIFF documents.

Parameters
[in]aRotationThe rotation: 0, 90, 180, or 270.
See also
getRotation(), selectWidget()
void setSeedValueAddRevInfo ( bool  aAddRevInfo)

Set the AddRevInfo flag in the signature field seed value dictionary.

This function sets both the AddRevInfo flag and the flag specifying that AddRevInfo is mandatory. (Both flags are set to the same value, that is, you cannot set AddRevInfo as optional constraint.)

If the AddRevInfo flag is set, revocation must be checked at signing time and revocation data must be included in the signature.

Parameters
[in]aAddRevInfoThe new AddRevInfo flag value.
See also
getSeedValueAddRevInfo()
bool setSeedValueDigestMethod ( int  aIndex,
string  aDigestMethod 
)

Set a DigestMethod value in the seed value dictionary.

See getSeedValueDigestMethod() for details.

Parameters
[in]aIndexThe 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]aDigestMethodThe DigestMethod value.
Returns
true if successful, false if aIndex is out of range.
See also
clearSeedValueDigestMethods(), getSeedValueDigestMethod()
void setSeedValueDigestMethod ( string  aDigestMethod)

Set a DigestMethod value in the seed value dictionary.

See getSeedValueDigestMethod() for details.

Calling this function is equivalent to calling clearSeedValueDigestMethods() and addSeedValueDigestMethod().

Parameters
[in]aDigestMethodThe DigestMethod value.
See also
clearSeedValueDigestMethods(), getSeedValueDigestMethod()
void setSeedValueDigestMethodRequired ( bool  aRequired)

Set a flag from the signature field seed value dictionary that indicates whether the DigestMethod values are a required constraint or not.

Parameters
[in]aRequiredtrue if the DigestMethod values are a required constraint, false if the DigestMethod values are an optional constraint. If aRequired is true, there should be at least one DigestMethod value.
See also
getSeedValueDigestMethod(), getSeedValueDigestMethodRequired()
bool setSeedValueFilter ( string  aFilter,
bool  aRequired 
)

Set the Filter entry (signature handler) in the signature field seed value dictionary.

Parameters
[in]aFilterThe name of the signature handler to be used for signing, e.g., "Adobe.PPKLite". An empty value will cause the Filter entry (constraint) to be removed. This should be an ASCII string.
[in]aRequiredtrue if aFilter is a required constraint, false if aFilter is an optional constraint. Adobe Reader seems to ignore this flag.
Returns
true if successful, false if aFilter is invalid.
See also
getSeedValueFilter(), getSeedValueFilterRequired()
bool setSeedValueMDP ( int  aMDP)

Set the MDP value in the signature field seed value dictionary.

Parameters
[in]aMDPThe new MDP value:
  • -1 to remove the MDP value
  • 0 for an approval signature
  • 1 for a certification signature, no changes to the document shall be permitted
  • 2 for a certification signature, only filling in forms, instantiating page templates, and signing shall be permitted
  • 3 for a certification signature, only filling in forms, instantiating page templates, signing, creating annotations, deleting annotations, and modifying annotations shall be permitted.
Returns
true if successful, false if aMDP is invalid.
See also
getSeedValueMDP()
bool setSeedValueSubFilter ( int  aIndex,
string  aSubFilter 
)

Set a SubFilter value in the seed value dictionary.

See getSeedValueSubFilter() for details.

Parameters
[in]aIndexThe 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]aSubFilterThe SubFilter value.
Returns
true if successful, false if aIndex is out of range.
See also
clearSeedValueSubFilters(), getSeedValueSubFilter()
void setSeedValueSubFilter ( string  aSubFilter)

Set a SubFilter value in the seed value dictionary.

See getSeedValueSubFilter() for details.

Calling this function is equivalent to calling clearSeedValueSubFilters() and addSeedValueSubFilter().

Parameters
[in]aSubFilterThe SubFilter value.
See also
clearSeedValueSubFilters(), getSeedValueSubFilter()
void setSeedValueSubFilterRequired ( bool  aRequired)

Set a flag from the signature field seed value dictionary that indicates whether the SubFilter values are a required constraint or not.

Parameters
[in]aRequiredtrue if the SubFilter values are a required constraint, false if the SubFilter values are an optional constraint. If aRequired is true, there should be at least one SubFilter value.
See also
getSeedValueSubFilter(), getSeedValueSubFilterRequired()
bool setSeedValueTimeStamp ( string  aURL,
bool  aRequired 
)

Set the URL of an RFC 3161 time-stamp server in the signature field seed value dictionary.

Note
URLs must be ASCII strings.
Parameters
[in]aURLThe URL (must be ASCII), empty for no time-stamp server. Must be non-empty if aRequired is true. The scheme must be http or https.
[in]aRequiredtrue if a time stamp is required, false if a time stamp is not required.
Returns
true if successful, false if aURL is invalid.
See also
getSeedValueTimeStampRequired(), getSeedValueTimeStampServerURL()
bool setTextFieldAttributes ( SignDocTextFieldAttributes  aInput)

Set the text field attributes of the widget.

Font name and font size must be specified. The text color is optional. This function fails if any of the attributes of aInput are invalid.

Text field attributes can be specified for text fields, signature fields, list boxes, and combo boxes.

If SignDocTextFieldAttributes.isSet() returns false for aInput, the text field attributes of the field will be removed by SignDocDocument.setField().

The following rules apply if the field does not have text field attributes:

  • If the field inherits text field attributes from a ancestor field, those will be used by PDF processing software.
  • Otherwise, if the document has specifies text field attributes (see SignDocDocument.getTextFieldAttributes()), those will be used by PDF processing software.
  • Otherwise, the field is not valid.

To avoid having invalid fields, SignDocDocument.addField() and SignDocDocument.setField() will use text field attributes specifying Helvetica as the font and black for the text color if the field does not inherit text field attributes from an ancestor field or from the document.

This function always fails for TIFF documents.

Parameters
[in]aInputThe new default text field attributes.
Returns
true iff successful.
See also
getTextFieldAttributes(), selectWidget()
void setTop ( double  aTop)

Set the top coordinate.

The origin is in the bottom left corner of the page, see Coordinate Systems. If coordinates are given in pixels (this is true for TIFF documents), this coordinate is exclusive.

Parameters
[in]aTopThe top coordinate.
See also
getTop(), selectWidget(), setBottom(), setLeft(), setRight(), SetFieldFlags.Move
void setTopIndex ( int  aTopIndex)

Set the index of the choice to be displayed in the first line of a list box.

This value is ignored for other field types.

Parameters
[in]aTopIndexThe index of the choice to be displayed in the first line of a list box.
See also
getChoiceValue(), getTopIndex()
void setType ( FieldType  aType)

Set the type of the field.

The default value is FieldType.Unknown.

Calling this function may affect the border color, see setBorderColor().

Parameters
[in]aTypeThe type of the field.
See also
getType(), setBorderColor()
void setValue ( string  aValue)

Set the value of the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if FieldFlags.MultiSelect is set.

Hard line breaks for multiline text fields (ie, text fields with flag FieldFlags.MultiLine set) are encoded as "\r", "\n", or "\r\n". The behavior for values containing line breaks is undefined if the FieldFlags.MultiLine flag is not set.

Calling this function is equivalent to calling clearValues() and addValue(), but the encoding of aValue is checked before modifying this object.

After calling this function, getValueIndex() will return -1.

Parameters
[in]aValueThe value to be set. Complex scripts are supported, see Complex Scripts.
See also
clearValues(), clickButton(), getValue(), getValueIndex(), setValueIndex()
bool setValue ( int  aIndex,
string  aValue 
)

Set a value of the field.

Pushbutton fields and signature fields don't have a value, list boxes can have multiple values selected if FieldFlags.MultiSelect is set.

Hard line breaks for multiline text fields (ie, text fields with flag FieldFlags.MultiLine set) are encoded as "\r", "\n", or "\r\n". The behavior for values containing line breaks is undefined if the FieldFlags.MultiLine flag is not set.

After calling this function, getValueIndex() will return -1.

Parameters
[in]aIndexThe 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added.
[in]aValueThe value to be set. Complex scripts are supported, see Complex Scripts.
Returns
true if successful, false if aIndex is out of range.
See also
clearValues(), clickButton(), getValue(), getValueIndex(), setValueIndex()
void setValueIndex ( int  aIndex)

Set the value index.

Radio button groups and check box fields can have multiple widgets having the same button value. For check box fields and radio buttons without FieldFlags.RadiosInUnison set, specifying the selected button by value string is ambiguous in that case. A 0-based value index can be used to find out which button is selected or to select a button.

Radio button groups and check box fields need not use a value index; in fact, they usually don't. However, you can always set a value index for radio button groups and check box fields.

If the value index is non-negative, SignDocDocument.addField() and SignDocDocument.setField() will use the value index instead of the string value set by setValue().

Calling setValueIndex() doesn't affect the return value of getValue() as the value index is used by SignDocDocument.addField() and SignDocDocument.setField() only. However, successful calls to SignDocDocument.addField() and SignDocDocument.setField() will make getValue() return the selected value.

For radio button groups with FieldFlags.RadiosInUnison set and non-unique button values and for check box fields with non-unique button values, for each button value, the lowest index having that button value is the canonical one. After calling SignDocDocument.addField() or SignDocDocument.setField(), getValueIndex() will return the canonical value index.

Don't forget to update the value index when adding or removing widgets!

SignDocDocument.addField() and SignDocDocument.setField() will fail if the value index is non-negative for fields other than radio button groups and check box fields.

The "Off" value never has a value index.

Note
addValue(), clearValues(), and setValue() make the value index unset (ie, getValueIndex() will return -1). Therefore, you don't have to call setValueIndex(-1) to make setValue() take effect on SignDocDocument.addField() and SignDocDocument.setField().
Parameters
[in]aIndexthe 0-based value index or -1 to make the value index unset.
See also
clickButton(), getValue(), getValueIndex(), setValue()
void setWidgetFlags ( WidgetFlags  aFlags)

Set the annotation flags of the widget, see enum WidgetFlags.

The default value is WidgetFlags.Print. The annotation flags are used for PDF documents only. Currently, the semantics of the annotation flags are ignored by this software (ie, the flags are stored in the document, but they don't have any meaning to this software).

Parameters
[in]aFlagsThe annotation flags of the widget.
See also
getWidgetFlags(), selectWidget()

The documentation for this class was generated from the following file: