| SignDocDocument Class |
An interface for SignDoc documents.
An object of this class represents one document. Use SignDocDocumentLoader.loadFromMemory() or SignDocDocumentLoader.loadFromFile() to create objects. If the document is loaded from a file, the file may remain in use until this object is destroyed or close() is called or the document is saved to a different file with saveToFile(). Please do not change the file while there is a SignDocDocument object for it. Getting basic information about the document : -getType() -getPageCount() -getPathname() -isModified() . Saving the document : -copyToStream() -getRequiredSaveToFileFlags() -getSaveToFileFlags() -getSaveToStreamFlags() -saveToStream() -saveToFile() . Working with interactive fields : -addField() -applyFdf() -exportFields() -flattenField() -flattenFields() -getField() -getFields() -getFieldsOfPage() -getTextFieldAttributes() -removeField() -setField() -setTextFieldAttributes() . Signing signature fields : -addSignature() -createSignatureParametersForTimeStamp() -createSignatureParameters() -getAvailableMethods() -getLastTimestamp() -getProfiles() . Verifying and removing signatures : -clearAllSignatures() -clearApprovalSignatures() -clearSignature() -copyAsSignedToStream() -getSignature() -getSignatureCount() -removeDocMDP() -updateDSS() -updateDSS2() -verifySignature() -verifySignature2() Working with properties : -exportProperties() -getBooleanProperty() -getIntegerProperty() -getProperties() -getStringProperty() -importProperties() -removeProperty() -setBooleanProperty() -setIntegerProperty() -setStringProperty() . Working with pages : -addPage() -computeZoom() -convCanvasPointToPagePoint() -convPagePointToCanvasPoint() -getBitsPerPixel() -getConversionFactorX() -getConversionFactorY() -getPageHeight() -getPageWidth() -getRenderedSize() -getResolutionX() -getResolutionY() -importPageFromImageBlob() -importPageFromImageFile() -importPages() -removePages() -renderPageAsImage() . Working with annotations : -addAnnotation() -createFreeTextAnnotation() -createLineAnnotation() -createScribbleAnnotation() -flattenAnnotations() -getAnnotation() -getAnnotations() -removeAnnotation() . Adding text to a page and finding text on pages : -addText() -addTextRect() -addWatermark() -findText() . Adding images to a page : -addImageFromBlob() -addImageFromFile() . Working with attachments : -addAttachmentBlob() -addAttachmentFile() -changeAttachmentDescription() -checkAttachment() -getAttachment() -getAttachmentBlob() -getAttachmentStream() -getAttachments() -removeAttachment() . Other functions : -getDocMDP() -getFlags() -getLockMDP() -getShootInFoot() -removeDocMDP() -removeLogicalStructure() -removePDFA() -removePDFUA() -removePermissions() -removeXFA() -setCompatibility() -setCompressionLevel() -setFlags() -setShootInFoot()
Inheritance HierarchyNamespace: de.softpro.signdocsdk
Assembly: SPSignDoc_4.3_DotNetLib (in SPSignDoc_4.3_DotNetLib.dll) Version: 1.0.6773.37566
SyntaxC#
public sealed class SignDocDocument : IDisposable
The SignDocDocument type exposes the following members.
Methods| Name | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 | addAnnotation | Add an annotation to a page.
See SignDocAnnotation for details.
| |||||||||
| addAttachmentBlob | Add an attachment to the document.
| |||||||||
| addAttachmentFile | Add an attachment (read from a file) to the document.
| |||||||||
| addField | Add a field.
See the members of SignDocField for details.
This function can add check boxes, radio button groups,
text fields, and signature fields to PDF documents.
When adding a radio button group or a check box
field, a value must be set, see SignDocField.setValue() and
SignDocField.setValueIndex().
The SignDocField.f_NoToggleToOff flag should be set for all
radio button groups. Adobe products seem to ignore this flag
being not set.
When adding a text field, the justification must be set with
SignDocField.setJustification().
Currently, you don't have control over the appearance of the
field being inserted except for the text field attributes.
Adding a field to a PDF document that doesn't contain any fields
will set the document's default text field attributes to font
Helvetica, font size 0, text color black.
Only signature fields can be added to PDF documents having signed
signature fields.
TIFF documents support signature fields only and all signature
fields must be inserted before the first signature is added to
the document (you may want to use invisible fields) unless all
existing signature fields have flag f_EnableAddAfterSigning set.
| |||||||||
| addImageFromBlob | Add an image (from a blob) to a page.
| |||||||||
| addImageFromFile | Add an image (from a blob) to a page.
This function is not yet implemented.
| |||||||||
| addPage | ||||||||||
| addSignature | Sign the document.
This function stores changed properties in the document before
signing. If the string parameter "OutputPath" is set, the
document will be stored in a new file specified by that
parameter. If string parameter "TemporaryDirectory" is set (and
"OutputPath" is not set), the document will be stored in a new
temporary file. Use getPathname() to obtain the pathname of that
temporary file. In either case, the original file won't be
modified (however, it will be deleted if it is a temporary file,
ie, if "TemporaryDirectory" was used). If neither "OutputPath"
nor "TemporaryDirectory" is set, the document will be written to
the file from which it was loaded or to which it was most
recently saved.
Some document types may allow adding signatures only if all signatures
of the documents are valid.
For PDF documents, this function either signs or certifies the
document, see integer parameter DocMDP.
If you are using RFC 3161 timestamps and get error rc_unexpected_error
with a message like "Contents overflow: xxx vs. yyy", try using a
bigger value for integer parameter "TimeStampSize".
This function performs a basic verification of the signature after
signing a PDF document unless #DontVerifyAfterSigning is set.
This ensures that the private key matches the certificate.
If that verification fails, SignDocInvalidSignatureException
will be thrown.
| |||||||||
| addText | Add text to a page.
Multiple lines are not supported, the text must not contain CR
and LF characters.
| |||||||||
| addTextRect | Add text in a rectangle of a page (with line breaking).
Any sequence of CR and LF characters in the text starts a new
paragraph (ie, text following such a sequence will be placed at
the beginning of the next output line). In consequence, empty
lines in the input do not produce empty lines in the output. To
get an empty line in the output, you have to add a paragraph
containing a non-breaking space (0xa0) only:
| |||||||||
| addWatermark | Add a watermark.
| |||||||||
| applyFdf | Apply an FDF document to a PDF document.
FDF documents can be applied to PDF documents only.
| |||||||||
| changeAttachmentDescription | Change the description of an attachment of the document.
Attachments are supported for PDF documents only.
| |||||||||
| checkAttachment | Check the checksum of an attachment.
Attachments are supported for PDF documents only.
| |||||||||
| clearAllSignatures | Remove all signatures of the document.
This includes any certification signature, see removeDocMDP().
| |||||||||
| clearApprovalSignatures | Remove all approval signatures of the document. | |||||||||
| clearSignature | Remove a signature of the document.
| |||||||||
| computeZoom | Compute the zoom factor used for rendering.
If de.softpro.doc.SignDocRenderParameters.fitWidth(),
de.softpro.doc.SignDocRenderParameters.fitHeight(), or
de.softpro.doc.SignDocRenderParameters.fitRect() has been called,
the actual factor depends on the document's page size.
If multiple pages are selected (see
#de.softpro.doc.SignDocRenderParameters.setPages()),
the maximum width and maximum height of all selected pages will be used.
| |||||||||
| convCanvasPointToPagePoint | Convert a point expressed in canvas (image) coordinates to
a point expressed in document coordinate system of the
current page.
The origin is in the bottom left corner of the page.
The origin is in the upper left corner of the image.
See @ref signdocshared_coordinates.
If multiple pages are selected (see
#de.softpro.doc.SignDocRenderParameters.setPages()),
the first page of the range will be used.
| |||||||||
| convPagePointToCanvasPoint | Convert a point expressed in document coordinate system of the
current page to a point expressed in canvas (image) coordinates.
The origin is in the bottom left corner of the page.
The origin is in the upper left corner of the image.
See @ref signdocshared_coordinates.
If multiple pages are selected (see
#de.softpro.doc.SignDocRenderParameters.setPages()),
the first page of the range will be used.
| |||||||||
| copyAsSignedToStream | Copy the document to a stream for viewing the document "as signed".
This function copies to a stream the document as it was when the specified
signature field was signed. If the specified signature field contains
the last signature applied to the document, this function is equivalent
to copyToStream(). However, for some document formats, this function
may require signatures to be valid.
| |||||||||
| copyToStream | Copy the document's backing file to a stream.
This function copies to a stream the file from which the document
was loaded or to which the document was most recently
saved. Changes made to the in-memory copy of the document since
it was loaded or saved will not be reflected in the copy written
to the stream. This function does not have side effects on the
document. This function will fail (throwing SignDocNotSupportedException) if
the document has not been saved to a file since it was loaded
from memory or saved to a stream.
| |||||||||
| createFreeTextAnnotation(Point, Point) | Create a text annotation.
See SignDocAnnotation for details.
This function uses document (page) coordinates,
see @ref signdocshared_coordinates.
| |||||||||
| createFreeTextAnnotation(Double, Double, Double, Double) | Create a text annotation.
See SignDocAnnotation for details.
This function uses document (page) coordinates,
see @ref signdocshared_coordinates.
| |||||||||
| createLineAnnotation(Point, Point) | Create a line annotation.
See SignDocAnnotation for details.
This function uses document (page) coordinates,
see @ref signdocshared_coordinates.
| |||||||||
| createLineAnnotation(Double, Double, Double, Double) | Create a line annotation.
See SignDocAnnotation for details.
This function uses document (page) coordinates,
see @ref signdocshared_coordinates.
| |||||||||
| createScribbleAnnotation | Create a scribble annotation.
See SignDocAnnotation for details.
| |||||||||
| createSignatureParameters | Create a SignDocSignatureParameters object for signing a
signature field.
Each SignDocSignatureParameters object should be used for at most
one signature.
The following profiles are available and documented :
For TIFF documents, "" produces the same output as "image".
Profile "" is defined by this template:
SignatureTemplate - standard.xml
Profile "image" is defined by this template:
SignatureTemplate - ImageOnly.xml
| |||||||||
| createSignatureParametersForTimeStamp | Create a SignDocSignatureParameters object for adding a
document time stamp.
| |||||||||
| Dispose | Releases all resources used by the SignDocDocument | |||||||||
| exportFields | Export all fields as XML.
This function always uses UTF-8 encoding. The output conforms
to schema PdfFields.xsd.
There is a setFlags() flag modifying the behavior of this function:
AmbiguousButtonValueEmpt
| |||||||||
| exportProperties | Export all properties (in all collections) as XML.
Export properties as XML.
This function always uses UTF-8 encoding.
The output conforms to schema AllSignDocProperties.xsd
(if @a aCollection is empty) or SignDocProperties.xsd
(if @a aCollection is non-empty).
| |||||||||
| findText | Find text.
| |||||||||
| flattenAnnotations | Flatten all annotations of the document or of a range of pages.
Flattening an annotation of a PDF document makes its appearance part of
the page and removes the selected annotation or all annotations.
This function selects all non-widget annotations on the specified pages,
ie, it does not flatten fields.
Flattening annotations breaks existing signatures. If you are flattening
annotations only for printing with PDF components that don't support
annotations, make a copy of the document, pass | |||||||||
| flattenField | Flatten a field.
Flattening a field of a PDF document makes its appearance part of
the page and removes the selected widget or all widgets; the field
will be removed when all its widgets have been flattened.
Flattening unsigned signature fields does not work correctly.
Flattening fields breaks existing signatures. If you are flattening
fields only for printing with PDF components that don't support
annotations, make a copy of the document, pass
Enums.EDocument.ShootInFootFlag.AllowBreakingPermissions | Enums.EDocument.ShootInFootFlag.AllowBreakingSignatures | |||||||||
| flattenFields | Flatten all fields of the document or of a range of pages.
Flattening a field of a PDF document makes its appearance part of
the page and removes the selected widget or all widgets; the field
will be removed when all its widgets have been flattened.
This function selects all widgets on the specified pages.
Flattening unsigned signature fields does not work correctly.
Flattening fields breaks existing signatures. If you are flattening
fields only for printing with PDF components that don't support
annotations, make a copy of the document, pass
Enums.EDocument.ShootInFootFlag.AllowBreakingPermissions | Enums.EDocument.ShootInFootFlag.AllowBreakingSignatures | |||||||||
| getAnnotation | Get a named annotation of a page.
All setters will fail for the returned object.
| |||||||||
| getAnnotations | Get a list of all named annotations of a page.
Unnamed annotations are ignored by this function.
| |||||||||
| getAttachment | Get information about an attachment.
Attachments are supported for PDF documents only.
| |||||||||
| getAttachmentBlob | Get an attachment as blob.
Attachments are supported for PDF documents only.
| |||||||||
| getAttachments | Get a list of all attachments of the document.
Attachments are supported for PDF documents only.
| |||||||||
| getAttachmentStream | Get an InputStream for an attachment.
Attachments are supported for PDF documents only.
| |||||||||
| getAvailableMethods | Get a bitset indicating which signing methods are available
for this document.
This document's signature fields offer a subset of the signing methods
returned by this function.
| |||||||||
| getBitsPerPixel | Get the number of bits per pixel (TIFF only).
Different pages of the document may have different numbers of bits
per pixel.
| |||||||||
| getBooleanProperty | Get the value of a SignDoc property (boolean).
In the "public" and "encrypted" collections, property names are
compared under Unicode simple case folding, that is, lower case
and upper case is not distinguished.
| |||||||||
| getConversionFactorX | Get the horizontal conversion factor for a page.
Different pages of the document may have different conversion factors.
For TIFF documents, this function returns the same value as
getResolutionX().
| |||||||||
| getConversionFactorY | Get the vertical conversion factor for a page.
Different pages of the document may have different conversion factors.
For TIFF documents, this function returns the same value as
getResolutionX().
| |||||||||
| getDocMDP | Get the DocMDP P value of the document's certification signature.
The DocMDP P value of the certification signature specifies what
modifications to the document are allowed.
This function does not verify the certification signature.
| |||||||||
| getField | Get an interactive field by name.
There is a setFlags() flag modifying the behavior of this function:
AmbiguousButtonValueEmpty.
| |||||||||
| getFields | Get all interactive fields of the specified types.
There is a setFlags() flag modifying the behavior of this function:
AbiguousButtonValueEmpty.
| |||||||||
| getFieldsOfPage | Get all interactive fields of the specified page, in tab order.
If the document does not specify a tab order, the fields will be
returned in widget order.
There is a setFlags() flag modifying the behavior of this function:
AbiguousButtonValueEmpty.
| |||||||||
| getFlags | Get the flags set by setFlags(). | |||||||||
| getIntegerProperty | Get the value of a SignDoc property (integer).
In the "public" and "encrypted" collections, property names are
compared under Unicode simple case folding, that is, lower case
and upper case is not distinguished.
| |||||||||
| getLastTimestamp | Get the timestamp used by the last successful call of
addSignature().
This function may return a timestamp even if the last call of
addSignature() was not successful. See also string parameters
"Timestamp" and "TimeStampServerURL" of SignDocSignatureParameters.
| |||||||||
| getLockMDP | Get the lowest lock MDP value of the signed signature fields.
The lock MDP value specifies what modifications to the document
are allowed.
This function does not verify any signature.
| |||||||||
| getPageCount | Get the number of pages of the document.
| |||||||||
| getPageHeight | Get the height of a page.
Different pages of the document may have different sizes.
Use getConversionFactorY() to get factors for converting the page height
from document coordinates to real world dimensions.
| |||||||||
| getPageLabel | Get the page label for a page number.
For TIFF documents, page will be converted to a
decimal number. | |||||||||
| getPageWidth | Get the width of a page.
Different pages of the document may have different sizes.
Use getConversionFactorX() to get factors for converting the page width
from document coordinates to real world dimensions.
| |||||||||
| getPathname | Get the current pathname of the document.
The pathname will be empty if the document is stored in memory
(ie, if it has been loaded from memory or saved to a stream).
If a FDF document has been opened, this function will return
the pathname of the referenced PDF file.
| |||||||||
| getProfiles | Get a list of profiles for a signature field.
| |||||||||
| getProperties | Get the names and types of all SignDoc properties of a
certain collection of properties of the document.
Use getBooleanProperty(), getIntegerProperty(), or
getStringProperty() to get the values of the
properties. Documents supporting a SignDoc data block store
properties in the SignDoc data block.
There are two collections of SignDoc document properties:
- "encrypted" Encrypted properties. Names and values are symmetrically
encrypted.
- "public" Public properties. Document viewer applications may
be able to display or let the user modify these
properties.
- "pdfa" PDF/A properties (PDF documents only):
- part (PDF/A version identifier)
- amd (optional PDF/A amendment identifier)
- conformance (PDF/A conformance level: A or B)
.
All properties in this collection have string values,
the property names are case-sensitive.
If the "part" property is present, the document claims
to be conforming to PDF/A. Your application may change
its behavior when dealing with PDF/A documents. For
instance, it might want to avoid transparency.
-"pdfua" PDF / UA properties(PDF documents only) :
-part(PDF / UA version identifier : 1)
-amd(optional PDF / UA amendment identifier)
-corr(optional PDF / UA corrigenda identifier)
.
All properties in this collection have string values,
the property names are case-sensitive.
If the "part" property is present, the document claims
to be conforming to PDF / UA.Your application may change
its behavior when dealing with PDF / UA documents.
.
Using the same property name in the "encrypted" and "public"
collections is not possible. Attempts to get, set, or remove a
property in the wrong collection will fail with error code
rc_wrong_collection. To move a property from one collection to
another collection, first remove it from the source collection,
then add it to the target collection.
The "pdfa" and "pdfua" collections are read - only and a property
name existing in those collections does not prevent that property
name from appearing in one of the other collections.
The syntax of property names depends on the document type and the
collection containing the property.
"public" properties of PDF documents are stored according to XMP in
namespace "http://www.softpro.de/pdfa/signdoc/public/", therefore
property names must be valid unqualified XML names, see the syntax
of "Name" in the XML 1.1 specification at
http://www.w3.org/TR/2004/REC-xml11-20040204/#sec-common-syn
(section 2.3 Common Syntactic Constructs).
For "encrypted" properties and any properties in TIFF documents,
property names can contain arbitrary Unicode characters except for
NUL.
| |||||||||
| getRenderedSize | Get the size of the rendered page in pixels (without actually
rendering it).
The returned values may be approximations for some document formats.
If multiple pages are selected (see
#de.softpro.doc.SignDocRenderParameters.setPages()),
the maximum width and maximum height of all selected pages will be used.
| |||||||||
| getRequiredSaveToFileFlags | Get all flags currently required for saveToFile().
This function currently returns #sf_incremental (saving the document
non-incrementally would destroy existing signatures) or 0 (the
document may be saved non-incrementally).
| |||||||||
| getResolutionX | Get the horizontal resolution of a page.
Different pages of the document may have different resolutions.
Use getConversionFactorX() to get the factor for converting document
coordinates to real world coordinates.
| |||||||||
| getResolutionY | Get the vertical resolution of a page.
Different pages of the document may have different resolutions.
Use getConversionFactorY() to get the factor for converting document
coordinates to real world coordinates.
| |||||||||
| getSaveToFileFlags | Get all flags currently valid for saveToFile().
Note that #sf_incremental cannot be used together with
#sf_linearized even if all these flags are returned by this
function. sf_pdfa_buttons is returned only if the document
claims to be PDF/A-compliant.
| |||||||||
| getSaveToStreamFlags | Get all flags currently valid for saveToStream().
sf_pdfa_buttons is returned only if the document claims to be
PDF/A-compliant.
| |||||||||
| getShootInFoot | Get the flags set by setShootInFoot(). | |||||||||
| getSignature | Get a signature of the document.
By passing values for @a aIndex from 0 up to getSignatureCount()-1,
the history of changes to the document can be obtained.
Exception: If clearSignature() has been called for a TIFF document,
the order of signatures is indeterminate.
| |||||||||
| getSignatureCount | Get the number of signatures that can be retrieved with
getSignature(). | |||||||||
| getStringProperty | Get the value of a SignDoc property (string).
In the "public" and "encrypted" collections, property names are
compared under Unicode simple case folding, that is, lower case
and upper case is not distinguished.
| |||||||||
| getTextFieldAttributes | Get the document's default text field attributes.
| |||||||||
| getType | Get the type of the document.
| |||||||||
| importPageFromImageBlob | Import a page from a blob containing an image.
This function is currently implemented for PDF documents only.
| |||||||||
| importPageFromImageFile | Import a page from a file containing an image.
This function is currently implemented for PDF documents only.
| |||||||||
| importPages | Import pages from another document.
This function is currently implemented for PDF documents only.
The pages to be imported must not contain any interactive fields
having names that are already used for intercative fields in the
target document.
Page labels are currently ignored, that is, they will probably
be messed up in the target document.
Logical structure is currently not imported.
| |||||||||
| importProperties | Import properties from XML.
The input must conform to schema AllSignDocProperties.xsd
(if @a aCollection is empty) or SignDocProperties.xsd
(if @a aCollection is non-empty).
| |||||||||
| isModified | Check if the document has unsaved changes.
Note that this function might report unsaved changes directly
after loading the document if the document is changed during
loading by the underlying PDF library.
| |||||||||
| removeAnnotation | Remove an annotation identified by name.
| |||||||||
| removeAttachment | Remove an attachment from the document.
Attachments are supported for PDF documents only.
| |||||||||
| removeDocMDP | Remove any certification signature.
This function does nothing for TIFF documents as TIFF documents
do not have certification signatures.
| |||||||||
| removeField | Remove a field.
Removing a field of a TIFF document will invalidate all signatures.
| |||||||||
| removeLogicalStructure | Remove the logical structure.
This function is available for PDF documents only.
| |||||||||
| removePages | Remove pages from the document.
A document must have at least page. This function will fail if
you attempt to remove all pages.
Fields will be removed if all their widgets are on removed pages.
Only signatures in signature fields having the SignDocField.f_SinglePage
flag set can survive removal of pages.
| |||||||||
| removePDFA | Remove PDF/A conformance.
Some operations on PDF documents (such as using standard fonts)
are not allowed in PDF/A documents. This function turns a PDF/A
document into a plain document, enabling those operations.
This function is available for PDF documents only.
| |||||||||
| removePDFUA | Remove PDF/UA conformance.
Some operations on PDF documents (such as using standard fonts)
are not allowed in PDF/UA documents. This function turns a PDF/UA
document into a plain document, enabling those operations.
This function is available for PDF documents only.
| |||||||||
| removePermissions | Remove signatures that grant permissions.
If you want to modify (beyond adding signature fields, signing
signature fields, and filling in form fields) a PDF document that
has permissions granted to Adobe Reader by digital signatures,
you have to remove those signatures first by calling this
function. That action will remove the permissions for Adobe
Reader but enable modifying the document without breaking those
signatures.
Permissions granted via encryption are not altered by this
function.
This function is available for PDF documents only.
| |||||||||
| removeProperty | Remove a SignDoc property.
In the "public" and "encrypted" collections, property names are
compared under Unicode simple case folding, that is, lower case
and upper case is not distinguished.
| |||||||||
| removeXFA | Remove XFA (XML Forms Architecture) content.
SignDoc SDK does not support XFA (XML Forms Architecture) and
therefore addSignature(), addField(), applyFdf(), and setField()
remove XFA from the document to avoid descrepancies between
"classic" form fields and XFA. This function is available for
PDF documents only.
You can also remove XFA content by calling this function. It
will fail if the document prohibits removal of XFA (removing
XFA from signed documents breaks signatures).
This function is available for PDF documents only.
| |||||||||
| renderPageAsImage | Render the selected page (or pages) as image.
| |||||||||
| saveToFile | Save the document to a file.
After a successful call to this function, the document behaves as
if it had been loaded from the specified file. sf_incremental is
supported only if null is passed for @a aPath, that is, when
saving to the file from which the document was loaded or to which
the document was most recently saved (by saveToFile(), not by
saveToStream()).
Saving a signed PDF document without sf_incremental will break
all signatures, see getRequiredSaveToFileFlags().
| |||||||||
| saveToStream | Save the document to a stream.
This function may have side effects on the document such as
marking it as not modified which may render sf_incremental
useless for the next saveToFile() call unless the document is
changed between those two calls. sf_incremental is not supported
by this function.
| |||||||||
| setBooleanProperty | Set the value of a SignDoc property (boolean).
In the "public" and "encrypted" collections, property names are
compared under Unicode simple case folding, that is, lower case
and upper case is not distinguished.
It's not possible to change the type of a property.
| |||||||||
| setCompatibility | Request to not make changes to the document which are
incompatible with an older version of this class.
No features introduced after @a aMajor.@a aMinor will be used.
Passing a version number before 1.11 or after the current version
will fail.
| |||||||||
| setCompressionLevel | Set the FlateDecode compression level.
Calling this function has an effect for PDF documents only.
You might want to use a low compression level on slow
machines such as mobile devices. That will speed up operations
such as embedding fonts, adding attachments, and adding images.
| |||||||||
| setField | Change a field.
This function changes a field in the document using attributes
from a SignDocField object. Everything except for the name and
the type of the field can be changed. See the member functions of
SignDocField for details.
Always get a SignDocField object for a field by calling
getField(), getFields(), or getFields(), then apply your
modifications to that object, then call setField().
Applications should not call setField() for fields that are
locked, ie, have SignDocField.f_ReadOnly set in the return
value of SignDocField.getFlags().However, setField() does not
fail in that case.
The coordinates of the field are not changed unless
#sff_move is set in @a aFlags.
Do not try to build a SignDocField object from scratch for
changing a field as future versions of the SignDocField class may
have additional attributes.
This function is implemented for PDF documents only.
This function always fails for PDF documents that have signed
signature fields.
| |||||||||
| setFlags | Set flags modifying the behavior of various functions.
The default is value is 0.
| |||||||||
| setIntegerProperty | Set the value of a SignDoc property (integer).
In the "public" and "encrypted" collections, property names are
compared under Unicode simple case folding, that is, lower case
and upper case is not distinguished.
It's not possible to change the type of a property.
| |||||||||
| setShootInFoot | Disable safety checks.
The default value, 0, makes operations fail which would
invalidate existing signatures(signature fields) or signatures
granting permissions.
| |||||||||
| setStringProperty | Set the value of a SignDoc property (string).
In the "public" and "encrypted" collections, property names are
compared under Unicode simple case folding, that is, lower case
and upper case is not distinguished.
It's not possible to change the type of a property.
| |||||||||
| setTextFieldAttributes | Get the document's default text field attributes.
| |||||||||
| updateDSS | Update the DSS for any eligible signatures of the document.
This function is available for PDF documents only.
To extend the validity of the signatures in a PDF document (long
term validity LTV), call this function, save the document
incrementally, and add a document time stamp.
If the document already has a document time stamp, this function
adds information for the latest document time stamp to the DSS.
If the document does not have a document time stamp, this function
adds information for all eligible signature fields to the DSS.
This function fails if verification fails for any of the signatures.
| |||||||||
| updateDSS2 | Update the DSS for a signature of the document.
The main purpose of this function is testing SignDoc SDK, please
use updateDSS() instead.
This function is available for PDF documents only.
Call this function (possibly a long time) after signing field
@a aFieldName, then save the document incrementally and add
a document time stamp. Before applying the first document
time stamp, this function should be called for all eligable
signature fields. If any document time stamp has already been
added, this function should be called for the last document
time stamp.
The signature field must have been signed with one of these
methods: SignDocSignatureParameters DigSigPKCS7Detached,
SignDocSignatureParameters DigSigPKCS7SHA1,
SignDocSignatureParameters DigSigCadesDetached, or
SignDocSignatureParameters DigSigCadesRFC3161.
This function does nothing if the signature field is not signed.
| |||||||||
| verifySignature | Verify a signature of the document.
There is a setFlags() flag modifying the behavior of this function:
f_relax_byte_range.
| |||||||||
| verifySignature2 | Verify a signature of the document.
These are the differences between calling this function
and calling verifySignature() with the field name obtained
from signature:
- This function fails unless signature.getClearedIndex()
returns -1.
- PDF only: This function uses the DSS of the first document
time stamp following the signature described by signature.
If there is no such document time stamp, the latest DSS will
be used. This behavior is required for verifying signatures
with LTV (long term validity).
.
There is a setFlags() flag modifying the behavior of this function:
f_relax_byte_range.
|
See Also