SignDoc SDK (.NET without exceptions)
5.0.0
|
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... | |
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:
SignDocField | ( | ) |
Constructor.
The new SignDocField object will have one widget.
SignDocField | ( | SignDocField | aSource | ) |
Copy constructor.
[in] | aSource | The object to be copied. |
~SignDocField | ( | ) |
Destructor.
!SignDocField | ( | ) |
Finalizer.
void addCertSeedValueIssuerCertificate | ( | byte[] | aCert | ) |
Add an issuer certificate to the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aCert | The DER-encoded certificate. |
void addCertSeedValuePolicy | ( | string | aOID | ) |
Add a policy OID to the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aOID | The policy OID. |
void addCertSeedValueSubjectCertificate | ( | byte[] | aCert | ) |
Add a subject certificate to the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aCert | The DER-encoded certificate. |
bool addCertSeedValueSubjectDN | ( | string | aName | ) |
Add a subject distinguished name to the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aName | The subject distinguished name formatted according to RFC 4514. |
void addChoice | ( | string | aValue | ) |
Add a choice to a list box or combo box.
This function uses the choice value as export value.
[in] | aValue | The choice value and export value to be added. Complex scripts are supported, see Complex Scripts. |
void addChoice | ( | string | aValue, |
string | aExport | ||
) |
Add a choice to a list box or combo box.
[in] | aValue | The choice value to be added. Complex scripts are supported, see Complex Scripts. |
[in] | aExport | The export value to be added. |
void addLockField | ( | string | aName | ) |
Add a lock field to the field.
[in] | aName | The name of the lock field to be added. |
void addSeedValueDigestMethod | ( | string | aDigestMethod | ) |
Add a DigestMethod value to the seed value dictionary.
See getSeedValueDigestMethod() for details.
[in] | aDigestMethod | The DigestMethod value. |
void addSeedValueSubFilter | ( | string | aSubFilter | ) |
Add a SubFilter value to the seed value dictionary.
See getSeedValueSubFilter() for details.
[in] | aSubFilter | The SubFilter value. |
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.
[in] | aValue | The value to be added. Complex scripts are supported, see Complex Scripts. |
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().
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.
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.
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.
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.
void clearChoices | ( | ) |
Clear the choices of a list box or combo box.
After calling this function, getChoiceCount() will return 0.
void clearLockFields | ( | ) |
Clear the lock fields.
After calling this function, getLockFieldCount() will return 0.
void clearSeedValueDigestMethods | ( | ) |
Remove all DigestMethod values from the seed value dictionary.
See getSeedValueDigestMethod() for details.
After calling this function, getSeedValueDigestMethodCount() will return 0.
void clearSeedValueSubFilters | ( | ) |
Remove all SubFilter values from the seed value dictionary.
See getSeedValueSubFilter() for details.
After calling this function, getSeedValueSubFilterCount() will return 0.
void clearValues | ( | ) |
Clear the values.
After calling this function, getValueCount() will return 0 and getValueIndex() will return -1.
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).
[in] | aIndex | The 0-based index of the widget being clicked. |
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.
SignDocColor getBackgroundColor | ( | ) |
Get the background color of the widget.
This function is available for fields of PDF documents only.
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.
FieldBorderStyle getBorderStyle | ( | ) |
Get the border style.
This function is available for fields of PDF documents only.
double getBorderWidth | ( | ) |
Get the border width of the widget.
This function is available for fields of PDF documents only.
double getBottom | ( | ) |
Get the bottom coordinate.
The origin is in the bottom left corner of the page, see Coordinate Systems.
FieldButtonStyle getButtonStyle | ( | ) |
Get the button style of a check box or radio button field.
This function is available for fields of PDF documents only.
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.
CertSeedValueFlags getCertSeedValueFlags | ( | ) |
Get the certificate seed value dictionary flags (/SV/Cert/Ff) of a signature field, see enum CertSeedValueFlags.
The default value is 0.
byte [] getCertSeedValueIssuerCertificate | ( | int | aIndex | ) |
Get an issuer certificate of the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | 0-based index of the issuer certificate. |
int getCertSeedValueIssuerCertificateCount | ( | ) |
Get the number of issuer certificates in the certificate seed value dictionary.
See the PDF Reference for details.
string getCertSeedValuePolicy | ( | int | aIndex | ) |
Get a policy OID from the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | 0-based index of the policy OID. |
int getCertSeedValuePolicyCount | ( | ) |
Get the number of policy OIDs in the certificate seed value dictionary.
See the PDF Reference for details.
byte [] getCertSeedValueSubjectCertificate | ( | int | aIndex | ) |
Get a subject certificate of the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | 0-based index of the subject certificate. |
int getCertSeedValueSubjectCertificateCount | ( | ) |
Get the number of subject certificates in the certificate seed value dictionary.
See the PDF Reference for details.
string getCertSeedValueSubjectDN | ( | int | aIndex | ) |
Get a subject distinguished name from the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the value to be retrieved. |
int getCertSeedValueSubjectDNCount | ( | ) |
Get the number of subject distinguished names in the certificate seed value dictionary.
See the PDF Reference for details.
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.
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.
[in] | aIndex | 0-based index of the export value. |
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.
[in] | aIndex | 0-based index of the choice value. |
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.
SignDocColor getEmptyFieldColor | ( | ) |
Get the color used for empty signature field in TIFF document.
The default value is white.
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.
FieldJustification getJustification | ( | ) |
Get the justification of the widget.
The default value is FieldJustification.None.
double getLeft | ( | ) |
Get the left coordinate.
The origin is in the bottom left corner of the page, see Coordinate Systems.
string getLockField | ( | int | aIndex | ) |
Get the name of a lock field.
[in] | aIndex | 0-based index of the lock field. |
int getLockFieldCount | ( | ) |
Get the number of field names for LockType.Include and LockType.Exclude.
int getLockMDP | ( | ) |
Get the lock MDP value.
LockType getLockType | ( | ) |
Get the lock type.
The lock type defines the fields to be locked when signing this signature field.
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.
int getMaxLen | ( | ) |
Get maximum length of text field.
The default value is -1.
string getName | ( | ) |
Get the name of the field.
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.
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.
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.
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.
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():
DigestMethod | getDigestAlgorithm() | 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" |
[in] | aIndex | 0-based index of the DigestMethod value. |
int getSeedValueDigestMethodCount | ( | ) |
Get the number of DigestMethod values in the seed value dictionary.
See getSeedValueDigestMethod() for details.
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.
string getSeedValueFilter | ( | ) |
Get Filter entry (signature handler) from the signature field seed value dictionary.
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.
int getSeedValueMDP | ( | ) |
Get the MDP value from the signature field seed value dictionary.
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:
[in] | aIndex | 0-based index of the SubFilter value. |
int getSeedValueSubFilterCount | ( | ) |
Get the number of SubFilter values in the seed value dictionary.
See getSeedValueSubFilter() for details.
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.
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.
string getSeedValueTimeStampServerURL | ( | ) |
Get the URL of the RFC 3161 time-stamp server from the signature field seed value dictionary.
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 ...".
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.
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.
int getTopIndex | ( | ) |
Get the index of the choice to be displayed in the first line of a list box.
The default value is 0.
FieldType getType | ( | ) |
Get the type of the field.
The default value is FieldType.Unknown.
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".
[in] | aIndex | 0-based index of the value. |
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.
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.
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.
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).
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).
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().
[in] | aIndex | 0-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. |
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(),
bool isSigned | ( | ) |
Check if this field is a signed signature field.
This function is much more efficient than SignDocDocument.verifySignature() and SignDocDocument.verifySignature2().
bool removeCertSeedValueIssuerCertificate | ( | int | aIndex | ) |
Remove an issuer certificate from the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the issuer certificate to be removed. |
bool removeCertSeedValuePolicy | ( | int | aIndex | ) |
Remove a policy OID from the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the policy OID to be removed. |
bool removeCertSeedValueSubjectCertificate | ( | int | aIndex | ) |
Remove a subject certificate from the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the subject certificate to be removed. |
bool removeCertSeedValueSubjectDN | ( | int | aIndex | ) |
Remove a subject distinguished name from the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the subject distinguished name to be removed. |
bool removeChoice | ( | int | aIndex | ) |
Remove a choice from a list box or combo box.
[in] | aIndex | The 0-based index of the choice to be removed. |
bool removeLockField | ( | int | aIndex | ) |
Remove a lock field.
[in] | aIndex | The 0-based index of the lock field to be removed. |
bool removeSeedValueDigestMethod | ( | int | aIndex | ) |
Remove a DigestMethod value from the seed value dictionary.
See getSeedValueDigestMethod() for details.
[in] | aIndex | The 0-based index of the DigestMethod value to be removed. |
bool removeSeedValueSubFilter | ( | int | aIndex | ) |
Remove a SubFilter value from the seed value dictionary.
See getSeedValueSubFilter() for details.
[in] | aIndex | The 0-based index of the SubFilter value to be removed. |
bool removeValue | ( | int | aIndex | ) |
Remove a value from the field.
After calling this function, getValueIndex() will return -1.
[in] | aIndex | The 0-based index of the value to be removed. |
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:
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.
[in] | aIndex | 0-based index of the widget to remove. |
bool selectWidget | ( | int | aIndex | ) |
Select a widget.
This function selects the widget to be used by getWidgetFlags(), getPage(), getLeft(), getBottom(), getRight(), getTop(), getButtonValue(), getJustification(), getRotation(), getTextFieldAttributes(), getBackgroundColor(), getBorderColor(), getBorderWidth(), getBorderStyle(), getButtonStyle(), setWidgetFlags(), setPage(), setLeft(), setBottom(), setRight(), setTop(), setButtonValue(), setJustification(), setRotation(), setTextFieldAttributes(), setBackgroundColor(), setBorderColor(), setBorderWidth(), setBorderStyle(), and setButtonStyle().
[in] | aIndex | 0-based index of the widget. |
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.
[in] | aName | The 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. |
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).
[in] | aColor | null for transparent or a SignDocColor object representing the new background color. |
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.
[in] | aColor | null for transparent or a SignDocColor object representing the new border color. |
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.
[in] | aStyle | The new border style, see FieldBorderStyle. |
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.
[in] | aWidth | The new border width. |
void setBottom | ( | double | aBottom | ) |
Set the bottom coordinate.
The origin is in the bottom left corner of the page, see Coordinate Systems.
[in] | aBottom | The bottom coordinate. |
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.
[in] | aStyle | The new button style, see FieldButtonStyle. |
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.
[in] | aValue | The value to be set. Must not be empty, must not be "Off". |
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.
[in] | aFlags | The certificate seed value dicitionary flags of the field. |
bool setCertSeedValueIssuerCertificate | ( | int | aIndex, |
byte[] | aCert | ||
) |
Set an issuer certificate in the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added. |
[in] | aCert | The DER-encoded certificate. |
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().
[in] | aCert | The DER-encoded certificate. |
bool setCertSeedValuePolicy | ( | int | aIndex, |
string | aOID | ||
) |
Set a policy OID in the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added. |
[in] | aOID | The policy OID. |
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().
[in] | aOID | The policy OID. |
bool setCertSeedValueSubjectCertificate | ( | int | aIndex, |
byte[] | aCert | ||
) |
Set a subject certificate in the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added. |
[in] | aCert | The DER-encoded certificate. |
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().
[in] | aCert | The DER-encoded certificate. |
bool setCertSeedValueSubjectDN | ( | int | aIndex, |
string | aName | ||
) |
Set a subject distinguished name in the certificate seed value dictionary.
See the PDF Reference for details.
[in] | aIndex | The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added. |
[in] | aName | The subject distinguished name formatted according to RFC 4514. |
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.
[in] | aName | The subject distinguished name formatted according to RFC 4514. |
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.
[in] | aIndex | The 0-based index of the choice to be set. If aIndex equals the current number of choice, the value will be added. |
[in] | aValue | The choice value and export value to be set. Complex scripts are supported, see Complex Scripts. |
bool setChoice | ( | int | aIndex, |
string | aValue, | ||
string | aExport | ||
) |
Set a choice value of a list box or combo box.
[in] | aIndex | The 0-based index of the choice to be set. If aIndex equals the current number of choice, the value will be added. |
[in] | aValue | The choice value to be set. Complex scripts are supported, see Complex Scripts. |
[in] | aExport | The export value to be set. |
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.
[in] | aColor | The new color. |
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).
[in] | aFlags | The flags of the field. |
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.
[in] | aJustification | The justification. |
void setLeft | ( | double | aLeft | ) |
Set the left coordinate.
The origin is in the bottom left corner of the page, see Coordinate Systems.
[in] | aLeft | The left coordinate. |
bool setLockField | ( | int | aIndex, |
string | aName | ||
) |
Set a lock field.
[in] | aIndex | The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added. |
[in] | aName | The name of the lock field to be set. |
void setLockField | ( | string | aName | ) |
Set a lock field.
Calling this function is equivalent to calling clearLockFields() and addLockField().
[in] | aName | The name of the lock field to be set. |
void setLockMDP | ( | int | aMDP | ) |
Set the lock MDP value.
[in] | aMDP | The new lock MDP value:
|
void setLockType | ( | LockType | aLockType | ) |
Set the lock type.
The lock type defines the fields to be locked when signing this signature field.
[in] | aLockType | The new lock type. |
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.
[in] | aName | The mapping name of the field, empty to remove any mapping name. |
void setMaxLen | ( | int | aMaxLen | ) |
Set maximum length of text fields.
[in] | aMaxLen | The maximum length (in characters) of the text field or -1 for no maximum length. |
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.
[in] | aName | The name of the field. |
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.
[in] | aPage | The 1-based page number of the field. |
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.
[in] | aRight | The right coordinate. |
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.
[in] | aRotation | The rotation: 0, 90, 180, or 270. |
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.
[in] | aAddRevInfo | The new AddRevInfo flag value. |
bool setSeedValueDigestMethod | ( | int | aIndex, |
string | aDigestMethod | ||
) |
Set a DigestMethod value in the seed value dictionary.
See getSeedValueDigestMethod() for details.
[in] | aIndex | The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added. |
[in] | aDigestMethod | The DigestMethod value. |
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().
[in] | aDigestMethod | The DigestMethod value. |
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.
[in] | aRequired | true 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. |
bool setSeedValueFilter | ( | string | aFilter, |
bool | aRequired | ||
) |
Set the Filter entry (signature handler) in the signature field seed value dictionary.
[in] | aFilter | The 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] | aRequired | true if aFilter is a required constraint, false if aFilter is an optional constraint. Adobe Reader seems to ignore this flag. |
bool setSeedValueMDP | ( | int | aMDP | ) |
Set the MDP value in the signature field seed value dictionary.
[in] | aMDP | The new MDP value:
|
bool setSeedValueSubFilter | ( | int | aIndex, |
string | aSubFilter | ||
) |
Set a SubFilter value in the seed value dictionary.
See getSeedValueSubFilter() for details.
[in] | aIndex | The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added. |
[in] | aSubFilter | The SubFilter value. |
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().
[in] | aSubFilter | The SubFilter value. |
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.
[in] | aRequired | true 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. |
bool setSeedValueTimeStamp | ( | string | aURL, |
bool | aRequired | ||
) |
Set the URL of an RFC 3161 time-stamp server in the signature field seed value dictionary.
[in] | aURL | The 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] | aRequired | true if a time stamp is required, false if a time stamp is not required. |
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:
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.
[in] | aInput | The new default text field attributes. |
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.
[in] | aTop | The top coordinate. |
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.
[in] | aTopIndex | The index of the choice to be displayed in the first line of a list box. |
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().
[in] | aType | The type of the field. |
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.
[in] | aValue | The value to be set. Complex scripts are supported, see Complex Scripts. |
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.
[in] | aIndex | The 0-based index of the value to be set. If aIndex equals the current number of values, the value will be added. |
[in] | aValue | The value to be set. Complex scripts are supported, see Complex Scripts. |
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.
[in] | aIndex | the 0-based value index or -1 to make the value index unset. |
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).
[in] | aFlags | The annotation flags of the widget. |