SignDoc SDK (.NET with exceptions)
5.0.0
|
An interface for SignDoc documents. More...
Public Member Functions | |
~SignDocDocument () | |
Destructor. More... | |
!SignDocDocument () | |
Finalizer. More... | |
void | closeDocument () |
Close the document and the underlying file. More... | |
DocumentType | getType () |
Get the type of the document. More... | |
int | getPageCount () |
Get the number of pages. More... | |
SignDocSignatureParameters | createSignatureParameters (string aFieldName, string aProfile) |
Create a SignDocSignatureParameters object for signing a signature field. More... | |
SignDocSignatureParameters | createSignatureParametersForTimeStamp () |
Create a SignDocSignatureParameters object for adding a document time stamp. More... | |
string[] | getProfiles (string aFieldName) |
Get a list of profiles for a signature field. More... | |
void | addSignature (SignDocSignatureParameters aSignatureParameters, SignDocVerificationParameters aVerificationParameters) |
Sign the document. More... | |
string | getLastTimestamp () |
Get the timestamp used by the last successful call of addSignature(). More... | |
string | getPathname () |
Get the current pathname of the document. More... | |
SigningMethodFlags | getAvailableMethods () |
Get a bitset indicating which signing methods are available for this document. More... | |
int | getSignatureCount () |
Get the number of signatures that can be retrieved with getSignature(). More... | |
SignDocSignature | getSignature (int aIndex) |
Get a signature of the document. More... | |
SignDocVerificationResult | verifySignature (string aFieldName) |
Verify a signature of the document. More... | |
SignDocVerificationResult | verifySignature2 (SignDocSignature aSignature) |
Verify a signature of the document. More... | |
void | clearSignature (string aFieldName) |
Remove a signature of the document. More... | |
void | clearAllSignatures () |
Remove all signatures of the document. More... | |
void | clearApprovalSignatures () |
Remove all approval signatures of the document. More... | |
int | updateDSS (SignDocVerificationParameters aParameters, UpdateDSSFlags aFlags) |
Update the DSS for any eligible signatures of the document. More... | |
void | updateDSS2 (string aFieldName, SignDocVerificationParameters aParameters, UpdateDSSFlags aFlags) |
Update the DSS for a signature of the document. More... | |
void | saveToStream (Stream aStream, SaveFlags aFlags) |
Save the document to a stream. More... | |
byte[] | saveToMemory (SaveFlags aFlags) |
Save the document to a blob. More... | |
void | saveToFile (string aPath, SaveFlags aFlags) |
Save the document to a file. More... | |
void | copyToStream (Stream aStream, CopyToStreamFlags aFlags) |
Copy the document's current status or backing file or backing blob to a stream. More... | |
byte[] | copyToMemory (CopyToStreamFlags aFlags) |
Copy the document's current status or backing file or backing blob to a blob. More... | |
void | copyAsSignedToStream (string aFieldName, Stream aStream) |
Copy the document to a stream for viewing the document "as signed". More... | |
byte[] | copyAsSignedToMemory (string aFieldName) |
Copy the document to a blob for viewing the document "as signed". More... | |
SaveFlags | getSaveToStreamFlags () |
Get all flags currently valid for saveToStream() and saveToMemory(). More... | |
SaveFlags | getSaveToFileFlags () |
Get all flags currently valid for saveToFile(). More... | |
SaveFlags | getRequiredSaveToFileFlags () |
Get all flags currently required for saveToFile(). More... | |
SignDocField[] | getFields (FieldTypeFlags aTypes) |
Get all interactive fields of the specified types. More... | |
SignDocField[] | getFieldsOfPage (int aPage, FieldTypeFlags aTypes) |
Get all interactive fields of the specified page, in tab order. More... | |
SignDocField | getField (string aName) |
Get an interactive field by name. More... | |
void | setField (SignDocField aField, SetFieldFlags aFlags) |
Change a field. More... | |
void | addField (SignDocField aField, SetFieldFlags aFlags) |
Add a field. More... | |
void | removeField (string aName) |
Remove a field. More... | |
void | flattenField (string aName, int aWidget) |
Flatten a field. More... | |
void | flattenFields (int aFirstPage, int aLastPage, FlattenFieldsFlags aFlags) |
Flatten all fields of the document or of a range of pages. More... | |
void | exportFields (Stream aStream, ExportFlags aFlags) |
Export all fields as XML to a stream. More... | |
byte[] | exportFieldsToMemory (ExportFlags aFlags) |
Export all fields as XML to a blob. More... | |
void | applyFdf (string aPath, SetFieldFlags aFlags) |
Apply an FDF document to a PDF document. More... | |
SignDocTextFieldAttributes | getTextFieldAttributes () |
Get the document's default text field attributes. More... | |
void | setTextFieldAttributes (SignDocTextFieldAttributes aData) |
Set the document's default text field attributes. More... | |
SignDocProperty[] | getProperties (string aCollection) |
Get the names and types of all SignDoc properties of a certain collection of properties of the document. More... | |
int? | getIntegerProperty (string aCollection, string aName) |
Get the value of a SignDoc property (integer). More... | |
string | getStringProperty (string aCollection, string aName) |
Get the value of a SignDoc property (string). More... | |
bool? | getBooleanProperty (string aCollection, string aName) |
Get the value of a SignDoc property (boolean). More... | |
void | setIntegerProperty (string aCollection, string aName, int aValue) |
Set the value of a SignDoc property (integer). More... | |
void | setStringProperty (string aCollection, string aName, string aValue) |
Set the value of a SignDoc property (string). More... | |
void | setBooleanProperty (string aCollection, string aName, bool aValue) |
Set the value of a SignDoc property (boolean). More... | |
void | removeProperty (string aCollection, string aName) |
Remove a SignDoc property. More... | |
byte[] | exportPropertiesToMemory (string aCollection, ExportFlags aFlags) |
Export properties as XML to a blob. More... | |
void | exportProperties (string aCollection, Stream aStream, ExportFlags aFlags) |
Export properties as XML. More... | |
void | importProperties (string aCollection, InputStream aStream, ImportFlags aFlags) |
Import properties from XML (reading a stresm). More... | |
void | importPropertiesFromMemory (string aCollection, byte[] aBlob, ImportFlags aFlags) |
Import properties from XML (reading a blob). More... | |
double | getResolutionX (int aPage) |
Get the horizontal resolution of a page. More... | |
double | getResolutionY (int aPage) |
Get the vertical resolution of a page. More... | |
double | getConversionFactorX (int aPage) |
Get the horizontal conversion factor for a page. More... | |
double | getConversionFactorY (int aPage) |
Get the vertical conversion factor for a page. More... | |
double | getPageWidth (int aPage) |
Get the width of a page. More... | |
double | getPageHeight (int aPage) |
Get the height of a page. More... | |
string | getPageLabel (int aPage) |
Get the page label for a page number. More... | |
int | getBitsPerPixel (int aPage) |
Get the number of bits per pixel (TIFF only). More... | |
double | computeZoom (SignDocRenderParameters aParams) |
Compute the zoom factor used for rendering. More... | |
void | convCanvasPointToPagePoint (Point aPoint, SignDocRenderParameters aParams) |
Convert a point expressed in canvas (image) coordinates to a point expressed in document coordinate system of the specified page. More... | |
void | convPagePointToCanvasPoint (Point aPoint, SignDocRenderParameters aParams) |
Convert a point expressed in document coordinate system of the specified page to a point expressed in canvas (image) coordinates. More... | |
Rect | convImageRectToPageRect (SignDocImageRect aInput, SignDocRenderParameters aParams) |
Convert a rectangle expressed in canvas (image) coordinates to a rectangle expressed in document coordinate system of the specified page. More... | |
SignDocImageRect | convPageRectToImageRect (Rect aInput, SignDocRenderParameters aParams) |
Convert a rectangle expressed in document coordinate system of the specified page to a rectangle expressed in canvas (image) coordinates. More... | |
byte[] | renderPageAsImage (SignDocRenderOutput aOutput, SignDocRenderParameters aRenderParameters, SignDocVerificationParameters aVerificationParameters, Rect aClipRect) |
Render the selected page (or pages) as image. More... | |
SignDocImage | renderPageAsSignDocImage (SignDocRenderOutput aOutput, SignDocRenderParameters aRenderParameters, SignDocVerificationParameters aVerificationParameters, Rect aClipRect) |
Render the selected page (or pages) as SignDocImage object. More... | |
SignDocRenderOutput | getRenderedSize (SignDocRenderParameters aParams) |
Get the size of the rendered page in pixels (without actually rendering it). More... | |
SignDocAnnotation | createLineAnnotation (Point aStart, Point aEnd) |
Create a line annotation. More... | |
SignDocAnnotation | createLineAnnotation (double aStartX, double aStartY, double aEndX, double aEndY) |
Create a line annotation. More... | |
SignDocAnnotation | createScribbleAnnotation () |
Create a scribble annotation. More... | |
SignDocAnnotation | createFreeTextAnnotation (Point aLowerLeft, Point aUpperRight) |
Create a text annotation. More... | |
SignDocAnnotation | createFreeTextAnnotation (double aX0, double aY0, double aX1, double aY1) |
Create a text annotation. More... | |
void | addAnnotation (int aPage, SignDocAnnotation aAnnot) |
Add an annotation to a page. More... | |
string[] | getAnnotations (int aPage) |
Get a list of all named annotations of a page. More... | |
SignDocAnnotation | getAnnotation (int aPage, string aName) |
Get a named annotation of a page. More... | |
void | removeAnnotation (int aPage, string aName) |
Remove an annotation identified by name. More... | |
void | flattenAnnotations (int aFirstPage, int aLastPage, FlattenAnnotationsFlags aFlags) |
Flatten all annotations of the document or of a range of pages. More... | |
void | addText (string aText, int aPage, double aX, double aY, string aFontName, double aFontSize, SignDocColor aTextColor, double aOpacity, AddTextFlags aFlags) |
Add text to a page. More... | |
void | addText2 (string aText, int aPage, double aX, double aY, string aFontName, double aFontSize, SignDocColor aTextColor, double aOpacity, AddTextFlags aFlags, string aLang) |
Add text to a page (with language identifier). More... | |
void | addTextRect (string aText, int aPage, double aX0, double aY0, double aX1, double aY1, string aFontName, double aFontSize, double aLineSkip, SignDocColor aTextColor, double aOpacity, DocumentHAlignment aHAlignment, DocumentVAlignment aVAlignment, AddTextRectFlags aFlags) |
Add text in a rectangle of a page (with line breaking). More... | |
void | addTextRect2 (string aText, int aPage, double aX0, double aY0, double aX1, double aY1, string aFontName, double aFontSize, double aLineSkip, SignDocColor aTextColor, double aOpacity, DocumentHAlignment aHAlignment, DocumentVAlignment aVAlignment, AddTextRectFlags aFlags, string aLang) |
Add text in a rectangle of a page (with line breaking and language identifier). More... | |
void | addWatermark (SignDocWatermark aInput) |
Add a watermark. More... | |
SignDocFindTextOccurrence[] | findText (int aFirstPage, int aLastPage, string aText, FindTextFlags aFlags) |
Find text. More... | |
SignDocTextIterator | createTextIterator (int aFirstPage, int aLastPage, CreateTextIteratorFlags aFlags) |
Create an iterator that visits all the text of a range of pages. More... | |
void | addAttachmentBlob (string aName, string aDescription, string aType, string aModificationTime, byte[] aData, AddAttachmentFlags aFlags) |
Add an attachment to the document. More... | |
void | addAttachmentFile (string aName, string aDescription, string aType, string aPath, AddAttachmentFlags aFlags) |
Add an attachment (read from a file) to the document. More... | |
void | removeAttachment (string aName) |
Remove an attachment from the document. More... | |
void | changeAttachmentDescription (string aName, string aDescription) |
Change the description of an attachment of the document. More... | |
string[] | getAttachments () |
Get a list of all attachments of the document. More... | |
SignDocAttachment | getAttachment (string aName) |
Get information about an attachment. More... | |
CheckAttachmentResult | checkAttachment (string aName) |
Check the checksum of an attachment. More... | |
byte[] | getAttachmentBlob (string aName) |
Get an attachment as blob. More... | |
InputStream | getAttachmentStream (string aName) |
Get an InputStream for an attachment. More... | |
void | addPage (int aTargetPage, double aWidth, double aHeight) |
Add an empty page to the document. More... | |
void | importPages (int aTargetPage, SignDocDocument aSource, int aSourcePage, int aPageCount, ImportPagesFlags aFlags) |
Import pages from another document. More... | |
void | importPageFromImageBlob (int aTargetPage, byte[] aData, double aZoom, double aWidth, double aHeight, ImportImageFlags aFlags) |
Import a page from a blob containing an image. More... | |
void | importPageFromImageBlob2 (int aTargetPage, byte[] aData, double aZoom, double aWidth, double aHeight, ImportImageFlags aFlags, string aDescription, string aLang) |
Import a page from a blob containing an image (with alternate description). More... | |
void | importPageFromImageFile (int aTargetPage, string aPath, double aZoom, double aWidth, double aHeight, ImportImageFlags aFlags) |
Import a page from a file containing an image. More... | |
void | importPageFromImageFile2 (int aTargetPage, string aPath, double aZoom, double aWidth, double aHeight, ImportImageFlags aFlags, string aDescription, string aLang) |
Import a page from a file containing an image (with alternate description). More... | |
void | addImageFromMemory (int aTargetPage, byte[] aData, double aZoom, double aX, double aY, double aWidth, double aHeight, ImportImageFlags aFlags) |
Add an image (from a blob) to a page. More... | |
void | addImageFromMemory2 (int aTargetPage, byte[] aData, double aZoom, double aX, double aY, double aWidth, double aHeight, ImportImageFlags aFlags, string aDescription, string aLang) |
Add an image (from a blob) to a page (with alternate description). More... | |
void | addImageFromFile (int aTargetPage, string aPath, double aZoom, double aX, double aY, double aWidth, double aHeight, ImportImageFlags aFlags) |
Add an image (from a file) to a page. More... | |
void | addImageFromFile2 (int aTargetPage, string aPath, double aZoom, double aX, double aY, double aWidth, double aHeight, ImportImageFlags aFlags, string aDescription, string aLang) |
Add an image (from a file) to a page (with alternate description). More... | |
void | removePages (ConstArray(int) aPages, KeepOrRemove aMode) |
Remove pages from the document. More... | |
void | setCompatibility (int aMajor, int aMinor) |
Request to not make changes to the document which are incompatible with an older version of this class. More... | |
bool | isModified () |
Check if the document has unsaved changes. More... | |
bool | isTaggedPDF () |
Check if the document is a Tagged PDF document. More... | |
void | setFlags (DocumentFlags aFlags) |
Set flags modifying the behavior of various functions. More... | |
DocumentFlags | getFlags () |
Get the flags set by setFlags(). More... | |
void | setCompressionLevel (int aLevel) |
Set the FlateDecode compression level. More... | |
int | getDocMDP () |
Get the DocMDP P value of the document's certification signature. More... | |
int | getLockMDP () |
Get the lowest lock MDP value of the signed signature fields. More... | |
void | removeDocMDP () |
Remove any certification signature. More... | |
void | removePermissions (RemoveFlags aFlags) |
Remove signatures that grant permissions. More... | |
void | removePDFA (RemoveFlags aFlags) |
Remove PDF/A conformance. More... | |
void | removePDFUA (RemoveFlags aFlags) |
Remove PDF/UA conformance. More... | |
void | removeLogicalStructure (RemoveFlags aFlags) |
Remove the logical structure. More... | |
void | removeXFA (RemoveFlags aFlags) |
Remove XFA (XML Forms Architecture) content. More... | |
string | getDocumentLanguage () |
Get the document's natural language. More... | |
void | setDocumentLanguage (string aLang) |
Set the document's natural language. More... | |
void | setDefaultDocumentLanguage (string aLang) |
Set the language identifier to be used if a language identifier is required but the document doesn't provide one. More... | |
void | setShootInFoot (ShootInFootFlags aFlags) |
Disable safety checks. More... | |
ShootInFootFlags | getShootInFoot () |
Get the flags set by setShootInFoot(). More... | |
string | getErrorMessage () |
Get an error message for the last function call. More... | |
Static Public Member Functions | |
static string[] | splitEscapeSequences (string aInput) |
Split a string obtained from a PDF text string into escape sequences and text segments. More... | |
static string | withoutEscapeSequences (string aInput) |
Remove escape sequences specifying the natural language in text strings. More... | |
static string | withEscapeSequence (string aText, string aLang) |
Prepend an escape sequence for specifying the natural language in a text string. More... | |
An interface for SignDoc documents.
An object of this class represents one document.
Use SignDocDocumentLoader.loadFromMemory(), SignDocDocumentLoader.loadFromFile(), SignDocDocumentLoader.createPDF(), or SignDocDocumentLoader.createPDFA() to create objects.
If the document is loaded from a file, the file may remain in use until this object is destroyed 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.
Use getErrorMessage() to get more information after a function call failed.
Constructors and destructors:
Getting basic information about the document:
Saving the document:
Working with interactive fields:
Signing signature fields:
Verifying and removing signatures:
Working with properties:
Working with pages:
Working with annotations:
Adding text to a page and finding text on pages:
Adding images to a page:
Working with attachments:
Other functions:
~SignDocDocument | ( | ) |
Destructor.
!SignDocDocument | ( | ) |
Finalizer.
void addAnnotation | ( | int | aPage, |
SignDocAnnotation | aAnnot | ||
) |
Add an annotation to a page.
See SignDocAnnotation for details.
[in] | aPage | The page number (1 for the first page). |
[in] | aAnnot | The new annotation. |
void addAttachmentBlob | ( | string | aName, |
string | aDescription, | ||
string | aType, | ||
string | aModificationTime, | ||
byte[] | aData, | ||
AddAttachmentFlags | aFlags | ||
) |
Add an attachment to the document.
Attachments are supported for PDF documents only.
[in] | aName | The name of the attachment. Will also be used as filename of the attachment and must not contain slashes, backslashes, and colons. |
[in] | aDescription | The description of the attachment (can be empty). |
[in] | aType | The MIME type of the attachment (can be empty except for PDF/A-3 documents). |
[in] | aModificationTime | The time and date of the last modification of the file being attached to the document (can be empty). Must be in ISO 8601 extended calendar date format with optional timezone. |
[in] | aData | The attachment. |
[in] | aFlags | Must be AddAttachmentFlags.Zero. |
void addAttachmentFile | ( | string | aName, |
string | aDescription, | ||
string | aType, | ||
string | aPath, | ||
AddAttachmentFlags | aFlags | ||
) |
Add an attachment (read from a file) to the document.
Attachments are supported for PDF documents only.
[in] | aName | The name of the attachment. Will also be used as filename of the attachment and must not contain slashes, backslashes, and colons. |
[in] | aDescription | The description of the attachment (can be empty). |
[in] | aType | The MIME type of the attachment (can be empty except for PDF/A-3 documents). |
[in] | aPath | The pathname of the file to be attached. |
[in] | aFlags | Must be AddAttachmentFlags.Zero. |
void addField | ( | SignDocField | aField, |
SetFieldFlags | aFlags | ||
) |
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 FieldFlags.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 FieldFlags.EnableAddAfterSigning set.
[in,out] | aField | The new field. The font resource name of the default text field attributes may be modified. The value index and the value may be modified for radio button fields and check box fields. |
[in] | aFlags | Set of flags (of enum SetFieldFlags, combined with `|') modifying the behavior of this function. Pass 0 for no flags. |
void addImageFromFile | ( | int | aTargetPage, |
string | aPath, | ||
double | aZoom, | ||
double | aX, | ||
double | aY, | ||
double | aWidth, | ||
double | aHeight, | ||
ImportImageFlags | aFlags | ||
) |
Add an image (from a file) to a page.
This function behaves like addImageFromFile2() with an empty string for aDescription, that is, if the document uses Tagged PDF, a dummy alternate description for the image ("image" with language code "en") will provided to avoid breaking standard compliance. It is strongly recommended to use addImageFromFile2() with a meaningful description of the image.
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aTargetPage | The 1-based number of the page. |
[in] | aPath | The pathname of the file containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP. |
[in] | aZoom | Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom. |
[in] | aX | The X coordinate of the point at which the lower left corner of the image shall be placed. |
[in] | aY | The Y coordinate of the point at which the lower left corner of the image shall be placed. |
[in] | aWidth | Image width (document coordinates) or zero. The image will be scaled to this width. If this argument is non-zero, aZoom must be zero and either aHeight must be non-zero or ImportImageFlags.KeepAspectRatio must be set in aFlags. |
[in] | aHeight | Page height (document coordinates) or zero. The image will be scaled to this height. If this argument is non-zero, aZoom must be zero and either aWidth must be non-zero or ImportImageFlags.KeepAspectRatio must be set in aFlags. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ImportImageFlags. ImportImageFlags.KeepAspectRatio is not needed if aZoom is non-zero. |
void addImageFromFile2 | ( | int | aTargetPage, |
string | aPath, | ||
double | aZoom, | ||
double | aX, | ||
double | aY, | ||
double | aWidth, | ||
double | aHeight, | ||
ImportImageFlags | aFlags, | ||
string | aDescription, | ||
string | aLang | ||
) |
Add an image (from a file) to a page (with alternate description).
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aTargetPage | The 1-based number of the page. |
[in] | aPath | The pathname of the file containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP. |
[in] | aZoom | Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom. |
[in] | aX | The X coordinate of the point at which the lower left corner of the image shall be placed. |
[in] | aY | The Y coordinate of the point at which the lower left corner of the image shall be placed. |
[in] | aWidth | Image width (document coordinates) or zero. The image will be scaled to this width. If this argument is non-zero, aZoom must be zero and either aHeight must be non-zero or ImportImageFlags.KeepAspectRatio must be set in aFlags. |
[in] | aHeight | Page height (document coordinates) or zero. The image will be scaled to this height. If this argument is non-zero, aZoom must be zero and either aWidth must be non-zero or ImportImageFlags.KeepAspectRatio must be set in aFlags. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ImportImageFlags. ImportImageFlags.KeepAspectRatio is not needed if aZoom is non-zero. |
[in] | aDescription | Alternate description for the image. If this value is an empty string, aLang will be ignored. If this value is an empty string and the document uses Tagged PDF, "image" with language code "en" will be used to avoid breaking standard compliance. It is strongly recommended to use a meaningful description. Escape sequences must not be used. |
[in] | aLang | Language identifier for aDescription. Unless aDescription is an empty string, this must be a string containing an RFC 3066 language tag. Example: "en-US". |
void addImageFromMemory | ( | int | aTargetPage, |
byte[] | aData, | ||
double | aZoom, | ||
double | aX, | ||
double | aY, | ||
double | aWidth, | ||
double | aHeight, | ||
ImportImageFlags | aFlags | ||
) |
Add an image (from a blob) to a page.
This function behaves like addImageFromMemory2() with an empty string for aDescription, that is, if the document uses Tagged PDF, a dummy alternate description for the image ("image" with language code "en") will provided to avoid breaking standard compliance. It is strongly recommended to use addImageFromMemory2() with a meaningful description of the image.
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aTargetPage | The 1-based number of the page. |
[in] | aData | he blob containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP. |
[in] | aZoom | Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom. |
[in] | aX | The X coordinate of the point at which the lower left corner of the image shall be placed. |
[in] | aY | The Y coordinate of the point at which the lower left corner of the image shall be placed. |
[in] | aWidth | Image width (document coordinates) or zero. The image will be scaled to this width. If this argument is non-zero, aZoom must be zero and either aHeight must be non-zero or ImportImageFlags.KeepAspectRatio must be set in aFlags. |
[in] | aHeight | Page height (document coordinates) or zero. The image will be scaled to this height. If this argument is non-zero, aZoom must be zero and either aWidth must be non-zero or ImportImageFlags.KeepAspectRatio must be set in aFlags. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ImportImageFlags. ImportImageFlags.KeepAspectRatio is not needed if aZoom is non-zero. |
void addImageFromMemory2 | ( | int | aTargetPage, |
byte[] | aData, | ||
double | aZoom, | ||
double | aX, | ||
double | aY, | ||
double | aWidth, | ||
double | aHeight, | ||
ImportImageFlags | aFlags, | ||
string | aDescription, | ||
string | aLang | ||
) |
Add an image (from a blob) to a page (with alternate description).
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aTargetPage | The 1-based number of the page. |
[in] | aData | The blob containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP. |
[in] | aZoom | Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom. |
[in] | aX | The X coordinate of the point at which the lower left corner of the image shall be placed. |
[in] | aY | The Y coordinate of the point at which the lower left corner of the image shall be placed. |
[in] | aWidth | Image width (document coordinates) or zero. The image will be scaled to this width. If this argument is non-zero, aZoom must be zero and either aHeight must be non-zero or ImportImageFlags.KeepAspectRatio must be set in aFlags. |
[in] | aHeight | Page height (document coordinates) or zero. The image will be scaled to this height. If this argument is non-zero, aZoom must be zero and either aWidth must be non-zero or ImportImageFlags.KeepAspectRatio must be set in aFlags. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ImportImageFlags. ImportImageFlags.KeepAspectRatio is not needed if aZoom is non-zero. |
[in] | aDescription | Alternate description for the image. If this value is an empty string, aLang will be ignored. If this value is an empty string and the document uses Tagged PDF, "image" with language code "en" will be used to avoid breaking standard compliance. It is strongly recommended to use a meaningful description. Escape sequences must not be used. |
[in] | aLang | Language identifier for aDescription. Unless aDescription is an empty string, this must be a string containing an RFC 3066 language tag. Example: "en-US". |
void addPage | ( | int | aTargetPage, |
double | aWidth, | ||
double | aHeight | ||
) |
Add an empty page to the document.
This function is currently implemented for PDF documents only.
[in] | aTargetPage | The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0. |
[in] | aWidth | The width of the page (in 1/72 inches for PDF documents). |
[in] | aHeight | The height of the page (in 1/72 inches for PDF documents). |
void addSignature | ( | SignDocSignatureParameters | aSignatureParameters, |
SignDocVerificationParameters | aVerificationParameters | ||
) |
Sign the document.
This function stores changed properties in the document before signing. If string parameter "OutputPath" is set, the signed document will be stored in a new file specified by that parameter and the original file won't be modified. If "OutputPath" is not set, the document will be written to the file from which it was loaded or to which it was most recently saved.
If a PDF document is backed by memory (most recently loaded from memory or saved to a stream) and "OutputPath" is empty, the signed document will not be saved. Use
or
to save the signed document in that case.
If string parameter "OutputPath" is set to the special value "<memory>" for a PDF document, it will be saved to memory and signed in memory. You'll have to save the document as described in the preceding paragraph.
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 SignDocUnexpectedErrorException 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 ShootInFootFlags.DontVerifyAfterSigning is set. This ensures that the private key matches the certificate. If that verification fails, SignDocInvalidSignatureException will be thrown.
[in] | aSignatureParameters | The signing parameters. The parameters can be used only once, for a single signature. |
[in] | aVerificationParameters | Verification parameters or null for default parameters. If revocation checking is enabled in aVerificationParameters, the revocation state of the certificates (subject to integer parameter "VerificationModel") in both the signing certificate's certificate chain and (if RFC 3161 time stamps are enabled) the RFC 3161 time stamp's certificate chain is checked. These verification parameters are not used for verifying the certificate chain of HTTPS connections to RFC 3161 time-stamp servers. |
void addText | ( | string | aText, |
int | aPage, | ||
double | aX, | ||
double | aY, | ||
string | aFontName, | ||
double | aFontSize, | ||
SignDocColor | aTextColor, | ||
double | aOpacity, | ||
AddTextFlags | aFlags | ||
) |
Add text to a page.
This function behaves like addText2() with an empty string for aLang.
Multiple lines are not supported, the text must not contain CR and LF characters.
[in] | aText | The text. Complex scripts are supported, see Complex Scripts. Escape sequences must not be used. |
[in] | aPage | The 1-based page number of the page. |
[in] | aX | The X coordinate of the reference point of the visually left-most character in document coordinates, see Coordinate Systems. |
[in] | aY | The Y coordinate of the reference point of the visually left-most character in document coordinates. |
[in] | aFontName | The font name. This can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file. |
[in] | aFontSize | The font size (in user space units). |
[in] | aTextColor | The text color. |
[in] | aOpacity | The opacity, 0.0 (transparent) through 1.0 (opaque). Documents conforming to PDF/A-1 must use an opacity of 1.0. |
[in] | aFlags | Must be AddTextFlags.Zero. |
void addText2 | ( | string | aText, |
int | aPage, | ||
double | aX, | ||
double | aY, | ||
string | aFontName, | ||
double | aFontSize, | ||
SignDocColor | aTextColor, | ||
double | aOpacity, | ||
AddTextFlags | aFlags, | ||
string | aLang | ||
) |
Add text to a page (with language identifier).
Multiple lines are not supported, the text must not contain CR and LF characters.
[in] | aText | The text. Complex scripts are supported, see Complex Scripts. Escape sequences must not be used. |
[in] | aPage | The 1-based page number of the page. |
[in] | aX | The X coordinate of the reference point of the visually left-most character in document coordinates, see Coordinate Systems. |
[in] | aY | The Y coordinate of the reference point of the visually left-most character in document coordinates. |
[in] | aFontName | The font name. This can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file. |
[in] | aFontSize | The font size (in user space units). |
[in] | aTextColor | The text color. |
[in] | aOpacity | The opacity, 0.0 (transparent) through 1.0 (opaque). Documents conforming to PDF/A-1 must use an opacity of 1.0. |
[in] | aFlags | Must be AddTextFlags.Zero. |
[in] | aLang | Language identifier for aText, either an RFC 3066 language tag (example: "en-US") or an empty string. If a PDF/UA document does not specify a natural language, a language identifier is required. If a language identifier is required and aLang is an empty string, the behavior depends on flag DocumentFlags.RequireLang:
|
void addTextRect | ( | string | aText, |
int | aPage, | ||
double | aX0, | ||
double | aY0, | ||
double | aX1, | ||
double | aY1, | ||
string | aFontName, | ||
double | aFontSize, | ||
double | aLineSkip, | ||
SignDocColor | aTextColor, | ||
double | aOpacity, | ||
DocumentHAlignment | aHAlignment, | ||
DocumentVAlignment | aVAlignment, | ||
AddTextRectFlags | aFlags | ||
) |
Add text in a rectangle of a page (with line breaking).
This function behaves like addTextRect2() with an empty string for aLang.
The interpretation of CR and LF in the text depends on the value of aFlags, see enum AddTextRectFlags.
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aText | The text. The interpretation of CR and LF depends on the value of aFlags. Escape sequences must not be used. |
[in] | aPage | The 1-based page number of the page. |
[in] | aX0 | X coordinate of lower left corner. |
[in] | aY0 | Y coordinate of lower left corner. |
[in] | aX1 | X coordinate of upper right corner. |
[in] | aY1 | Y coordinate of upper right corner. |
[in] | aFontName | The font name. This can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file. |
[in] | aFontSize | The font size (in user space units). |
[in] | aLineSkip | The vertical distance between the baselines of successive lines (usually 1.2 * aFontSize). |
[in] | aTextColor | The text color. |
[in] | aOpacity | The opacity, 0.0 (transparent) through 1.0 (opaque). Documents conforming to PDF/A-1 must use an opacity of 1.0. |
[in] | aHAlignment | Horizontal alignment of the text. |
[in] | aVAlignment | Vertical alignment of the text. |
[in] | aFlags | Flags modifying the behavior of this function, see enum AddTextRectFlags. |
void addTextRect2 | ( | string | aText, |
int | aPage, | ||
double | aX0, | ||
double | aY0, | ||
double | aX1, | ||
double | aY1, | ||
string | aFontName, | ||
double | aFontSize, | ||
double | aLineSkip, | ||
SignDocColor | aTextColor, | ||
double | aOpacity, | ||
DocumentHAlignment | aHAlignment, | ||
DocumentVAlignment | aVAlignment, | ||
AddTextRectFlags | aFlags, | ||
string | aLang | ||
) |
Add text in a rectangle of a page (with line breaking and language identifier).
The interpretation of CR and LF in the text depends on the value of aFlags, see enum AddTextRectFlags.
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aText | The text. The interpretation of CR and LF depends on the value of aFlags. Escape sequences must not be used. |
[in] | aPage | The 1-based page number of the page. |
[in] | aX0 | X coordinate of lower left corner. |
[in] | aY0 | Y coordinate of lower left corner. |
[in] | aX1 | X coordinate of upper right corner. |
[in] | aY1 | Y coordinate of upper right corner. |
[in] | aFontName | The font name. This can be the name of a standard font, the name of an already embedded font, or the name of a font defined by a font configuration file. |
[in] | aFontSize | The font size (in user space units). |
[in] | aLineSkip | The vertical distance between the baselines of successive lines (usually 1.2 * aFontSize). |
[in] | aTextColor | The text color. |
[in] | aOpacity | The opacity, 0.0 (transparent) through 1.0 (opaque). Documents conforming to PDF/A-1 must use an opacity of 1.0. |
[in] | aHAlignment | Horizontal alignment of the text. |
[in] | aVAlignment | Vertical alignment of the text. |
[in] | aFlags | Flags modifying the behavior of this function, see enum AddTextRectFlags. |
[in] | aLang | Language identifier for aText, either an RFC 3066 language tag (example: "en-US") or an empty string. If a PDF/UA document does not specify a natural language, a language identifier is required. If a language identifier is required and aLang is an empty string, the behavior depends on flag DocumentFlags.RequireLang:
|
void addWatermark | ( | SignDocWatermark | aInput | ) |
Add a watermark.
[in] | aInput | An object describing the watermark. |
void applyFdf | ( | string | aPath, |
SetFieldFlags | aFlags | ||
) |
Apply an FDF document to a PDF document.
FDF documents can be applied to PDF documents only.
[in] | aPath | The pathname of the FDF document. See Using SignDoc SDK in Windows Store apps for restrictions on pathnames in Windows Store apps. |
[in] | aFlags | Flags modifying the behavior of this function, see enum SetFieldFlags. |
void changeAttachmentDescription | ( | string | aName, |
string | aDescription | ||
) |
Change the description of an attachment of the document.
Attachments are supported for PDF documents only.
[in] | aName | The name of the attachment. |
[in] | aDescription | The new description of the attachment. |
CheckAttachmentResult checkAttachment | ( | string | aName | ) |
Check the checksum of an attachment.
Attachments are supported for PDF documents only.
[in] | aName | The name of the attachment. |
void clearAllSignatures | ( | ) |
Remove all signatures of the document.
This includes any certification signature, see removeDocMDP().
void clearApprovalSignatures | ( | ) |
Remove all approval signatures of the document.
void clearSignature | ( | string | aFieldName | ) |
Remove a signature of the document.
For some document formats (TIFF), signatures may only be cleared in the reverse order of signing (LIFO).
[in] | aFieldName | The name of the signature field. |
void closeDocument | ( | ) |
Close the document and the underlying file.
After closing the document, all methods but closeDocument() will fail.
double computeZoom | ( | SignDocRenderParameters | aParams | ) |
Compute the zoom factor used for rendering.
If integer parameter "Height" or "Width" of aParams has been set, the actual factor depends on the document's page size. If multiple pages are selected (integer parameters "FirstPage" and "LastPage" of aParams), the maximum width and maximum height of all selected pages will be used.
See also "Scale" of SignDocRenderParameters.setNumber().
[in] | aParams | The parameters such as the page number and the zoom factor. |
void convCanvasPointToPagePoint | ( | Point | aPoint, |
SignDocRenderParameters | aParams | ||
) |
Convert a point expressed in canvas (image) coordinates to a point expressed in document coordinate system of the specified page.
The origin is in the bottom left corner of the page. The origin is in the upper left corner of the image. See Coordinate Systems. If multiple pages are selected (integer parameters "FirstPage" and "LastPage" of aParams), the first page of the range will be used.
Suppose the specified page of a PDF document has height PH and the rendered image has height IH. Then, point (0,0) will be converted to (0,PH) and point (0,IH) will be converted to (0,0).
[in,out] | aPoint | The point to be converted. |
[in] | aParams | The parameters such as the page number and the zoom factor. |
Rect convImageRectToPageRect | ( | SignDocImageRect | aInput, |
SignDocRenderParameters | aParams | ||
) |
Convert a rectangle expressed in canvas (image) coordinates to a rectangle expressed in document coordinate system of the specified page.
The origin is in the bottom left corner of the page. The origin is in the upper left corner of the image. See Coordinate Systems. If multiple pages are selected (integer parameters "FirstPage" and "LastPage" of aParams), the first page of the range will be used.
Suppose the specified page of a PDF document has height PH and the rendered image has height IH. Then, point (0,0) will be converted to (0,PH) and point (0,IH) will be converted to (0,0).
[in] | aInput | The rectangle to be converted. |
[in] | aParams | The parameters such as the page number and the zoom factor. |
void convPagePointToCanvasPoint | ( | Point | aPoint, |
SignDocRenderParameters | aParams | ||
) |
Convert a point expressed in document coordinate system of the specified 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 Coordinate Systems. If multiple pages are selected (integer parameters "FirstPage" and "LastPage" of aParams), the first page of the range will be used.
Suppose the specified page page of a PDF document has height PH and the rendered image has height IH. Then, point (0,0) will be converted to (0,IH) and point (0,PH) will be converted to (0,0).
[in,out] | aPoint | The point to be converted. |
[in] | aParams | The parameters such as the page number and the zoom factor. |
SignDocImageRect convPageRectToImageRect | ( | Rect | aInput, |
SignDocRenderParameters | aParams | ||
) |
Convert a rectangle expressed in document coordinate system of the specified page to a rectangle 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 Coordinate Systems. If multiple pages are selected (integer parameters "FirstPage" and "LastPage" of aParams), the first page of the range will be used.
Suppose the specified page page of a PDF document has height PH and the rendered image has height IH. Then, point (0,0) will be converted to (0,IH) and point (0,PH) will be converted to (0,0).
[in] | aInput | The rectangle to be converted. |
[in] | aParams | The parameters such as the page number and the zoom factor. |
byte [] copyAsSignedToMemory | ( | string | aFieldName | ) |
Copy the document to a blob for viewing the document "as signed".
This function copies to a blob 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 copyToMemory(). However, for some document formats, this function may require signatures to be valid.
[in] | aFieldName | The name of the signature field. |
void copyAsSignedToStream | ( | string | aFieldName, |
Stream | aStream | ||
) |
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.
[in] | aFieldName | The name of the signature field. |
[in] | aStream | The document will be copied to this stream. |
byte [] copyToMemory | ( | CopyToStreamFlags | aFlags | ) |
Copy the document's current status or backing file or backing blob to a blob.
If aIncludeUnsavedChanges is false, this function will copy to a blob the file or blob 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 blob.
If aIncludeUnsavedChanges is true, unsaved changes made to the in-memory copy of the document will be included (as incremental update for PDF documents) in the blob.
This function does not have side effects on the in-memory copy of the document, that is, unsaved changes remain unsaved (except for being saved to the blob if CopyToStreamFlags.Unsaved is set in aFlags).
[in] | aFlags | Flags modifying the behavior of this function, see enum CopyToStreamFlags. |
void copyToStream | ( | Stream | aStream, |
CopyToStreamFlags | aFlags | ||
) |
Copy the document's current status or backing file or backing blob to a stream.
If aIncludeUnsavedChanges is false, this function will copy to a stream the file or blob 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.
If aIncludeUnsavedChanges is true, unsaved changes made to the in-memory copy of the document will be included (as incremental update for PDF documents) in the stream.
This function does not have side effects on the in-memory copy of the document, that is, unsaved changes remain unsaved (except for being saved to the stream if CopyToStreamFlags.Unsaved is set in aFlags).
[in] | aStream | The document will be copied to this stream. |
[in] | aFlags | Flags modifying the behavior of this function, see enum CopyToStreamFlags. |
SignDocAnnotation createFreeTextAnnotation | ( | Point | aLowerLeft, |
Point | aUpperRight | ||
) |
Create a text annotation.
See SignDocAnnotation for details.
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aLowerLeft | coordinates of lower left corner. |
[in] | aUpperRight | coordinates of upper right corner. |
SignDocAnnotation createFreeTextAnnotation | ( | double | aX0, |
double | aY0, | ||
double | aX1, | ||
double | aY1 | ||
) |
Create a text annotation.
See SignDocAnnotation for details.
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aX0 | X coordinate of lower left corner. |
[in] | aY0 | Y coordinate of lower left corner. |
[in] | aX1 | X coordinate of upper right corner. |
[in] | aY1 | Y coordinate of upper right corner. |
SignDocAnnotation createLineAnnotation | ( | Point | aStart, |
Point | aEnd | ||
) |
Create a line annotation.
See SignDocAnnotation for details.
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aStart | Start point. |
[in] | aEnd | End point. |
SignDocAnnotation createLineAnnotation | ( | double | aStartX, |
double | aStartY, | ||
double | aEndX, | ||
double | aEndY | ||
) |
Create a line annotation.
See SignDocAnnotation for details.
This function uses document (page) coordinates, see Coordinate Systems.
[in] | aStartX | X coordinate of start point. |
[in] | aStartY | Y coordinate of start point. |
[in] | aEndX | X coordinate of end point. |
[in] | aEndY | Y coordinate of end point. |
SignDocAnnotation createScribbleAnnotation | ( | ) |
SignDocSignatureParameters createSignatureParameters | ( | string | aFieldName, |
string | aProfile | ||
) |
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:
Profile | Document Types | Description |
---|---|---|
"" | PDF, TIFF | Image above Signer and SignTime |
"image" | PDF, TIFF | Image only |
For TIFF documents, "" produces the same output as "image".
Profile "" is defined by this template:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE SignatureTemplate SYSTEM "SignatureTemplate.dtd"> <SignatureTemplate text-halignment="center" text-valignment="bottom" image-halignment="center" image-valignment="top" image-transparency="brightest" text-position="below" font-size="0.1 h" text-hmargin="0.1 h" image-margin="1"> <Line item="Signer"/> <Line item="SignTime"/> </SignatureTemplate>
Profile "image" is defined by this template:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE SignatureTemplate SYSTEM "SignatureTemplate.dtd"> <SignatureTemplate text-halignment="center" text-valignment="center" image-halignment="center" image-valignment="center" image-transparency="brightest" text-position="overlay" font-size="0.1 h" text-hmargin="0.1 h" image-margin="1"> </SignatureTemplate>
[in] | aFieldName | The name of the signature field. |
[in] | aProfile | The profile name. Some document types and signature fields support different sets of default parameters. The default profile, "", is supported for all signature fields. |
SignDocSignatureParameters createSignatureParametersForTimeStamp | ( | ) |
Create a SignDocSignatureParameters object for adding a document time stamp.
Each SignDocSignatureParameters object should be used for at most one signature.
SignDocTextIterator createTextIterator | ( | int | aFirstPage, |
int | aLastPage, | ||
CreateTextIteratorFlags | aFlags | ||
) |
Create an iterator that visits all the text of a range of pages.
Text will be returned in the sequence encountered when reading the content streams of the document sequentially.
This function is implemented for PDF documents only.
[in] | aFirstPage | 1-based number of first page to be visited. |
[in] | aLastPage | 1-based number of last page to be visited or 0 for all pages to the end of the document. |
[in] | aFlags | Flags modifying the behavior of this function, must be CreateTextIteratorFlags.Zero. |
void exportFields | ( | Stream | aStream, |
ExportFlags | aFlags | ||
) |
Export all fields as XML to a stream.
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: DocumentFlags.AmbiguousButtonValueEmpty.
[in] | aStream | The fields will be saved to this stream. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ExportFlags. |
byte [] exportFieldsToMemory | ( | ExportFlags | aFlags | ) |
Export all fields as XML to a blob.
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: DocumentFlags.AmbiguousButtonValueEmpty.
[in] | aFlags | Flags modifying the behavior of this function, See enum ExportFlags. |
void exportProperties | ( | string | aCollection, |
Stream | aStream, | ||
ExportFlags | aFlags | ||
) |
Export properties as XML.
This function always uses UTF-8 encoding. The output conforms to schema AllSignDocProperties.xsd (if aCollection is empty) or SignDocProperties.xsd (if aCollection is non-empty).
[in] | aCollection | The name of the collection, see getProperties(). If the string is empty, all properties of the "public" and "encrypted" collections will be exported. |
[in] | aStream | The properties will be saved to this stream. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ExportFlags. |
byte [] exportPropertiesToMemory | ( | string | aCollection, |
ExportFlags | aFlags | ||
) |
Export properties as XML to a blob.
This function always uses UTF-8 encoding. The output conforms to schema AllSignDocProperties.xsd (if aCollection is empty) or SignDocProperties.xsd (if aCollection is non-empty).
[in] | aCollection | The name of the collection, see getProperties(). If the string is empty, all properties of the "public" and "encrypted" collections will be exported. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ExportFlags. |
SignDocFindTextOccurrence [] findText | ( | int | aFirstPage, |
int | aLastPage, | ||
string | aText, | ||
FindTextFlags | aFlags | ||
) |
Find text.
The text of the document will be scanned in the sequence encountered when reading the content streams of the document sequentially.
This function is implemented for PDF documents only.
[in] | aFirstPage | 1-based number of first page to be searched. |
[in] | aLastPage | 1-based number of last page to be searched or 0 to search to the end of the document. |
[in] | aText | Text to be searched for. Multiple successive spaces are treated as single space (and may be ignored subject to aFlags). |
[in] | aFlags | Flags modifying the behavior of this function, see enum FindTextFlags. |
void flattenAnnotations | ( | int | aFirstPage, |
int | aLastPage, | ||
FlattenAnnotationsFlags | aFlags | ||
) |
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
to setShootInFoot(), flatten the annotations, print the document, and throw it away.
[in] | aFirstPage | 1-based number of first page. |
[in] | aLastPage | 1-based number of last page or 0 to process all pages to the end of the document. |
[in] | aFlags | Flags modifying the behavior of this function, see FlattenAnnotationsFlags. |
void flattenField | ( | string | aName, |
int | aWidget | ||
) |
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 uint 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
to setShootInFoot(), flatten the fields, print the document, and throw it away.
[in] | aName | The fully-qualified name of the field. |
[in] | aWidget | The widget index to flatten only one widget or -1 to flatten all widgets. |
void flattenFields | ( | int | aFirstPage, |
int | aLastPage, | ||
FlattenFieldsFlags | aFlags | ||
) |
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 uint 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
to setShootInFoot(), flatten the fields, print the document, and throw it away.
[in] | aFirstPage | 1-based number of first page. |
[in] | aLastPage | 1-based number of last page or 0 to process all pages to the end of the document. |
[in] | aFlags | Flags modifying the behavior of this function, see FlattenFieldsFlags. If this value is 0, signature fields and hidden/invisible widgets will not be flattened. |
SignDocAnnotation getAnnotation | ( | int | aPage, |
string | aName | ||
) |
Get a named annotation of a page.
All setters will fail for the returned object.
[in] | aPage | The page number (1 for the first page). |
[in] | aName | The name of the annotation. |
string [] getAnnotations | ( | int | aPage | ) |
Get a list of all named annotations of a page.
Unnamed annotations are ignored by this function.
[in] | aPage | The page number (1 for the first page). |
SignDocAttachment getAttachment | ( | string | aName | ) |
Get information about an attachment.
Attachments are supported for PDF documents only.
[in] | aName | The name of the attachment. |
byte [] getAttachmentBlob | ( | string | aName | ) |
Get an attachment as blob.
Attachments are supported for PDF documents only.
[in] | aName | The name of the attachment. |
string [] getAttachments | ( | ) |
Get a list of all attachments of the document.
Attachments are supported for PDF documents only.
InputStream getAttachmentStream | ( | string | aName | ) |
Get an InputStream for an attachment.
Attachments are supported for PDF documents only.
[in] | aName | The name of the attachment. |
SigningMethodFlags 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.
int getBitsPerPixel | ( | int | aPage | ) |
Get the number of bits per pixel (TIFF only).
Different pages of the document may have different numbers of bits per pixel.
[in] | aPage | The page number (1 for the first page). |
bool? getBooleanProperty | ( | string | aCollection, |
string | aName | ||
) |
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.
[in] | aCollection | The name of the collection, see getProperties(). |
[in] | aName | The name of the property. |
double getConversionFactorX | ( | int | aPage | ) |
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(). For PDF documents, this function now always returns 72 as UserUnit is taken into account automatically.
See Coordinate Systems.
[in] | aPage | The page number (1 for the first page). |
double getConversionFactorY | ( | int | aPage | ) |
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(). For PDF documents, this function now always returns 72 as UserUnit is taken into account automatically.
See Coordinate Systems.
[in] | aPage | The page number (1 for the first page). |
int 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.
string getDocumentLanguage | ( | ) |
Get the document's natural language.
That language applies to all text unless overridden locally.
string getErrorMessage | ( | ) |
Get an error message for the last function call.
SignDocField getField | ( | string | aName | ) |
Get an interactive field by name.
There is a setFlags() flag modifying the behavior of this function: DocumentFlags.AmbiguousButtonValueEmpty.
[in] | aName | The fully-qualified name of the field. |
SignDocField [] getFields | ( | FieldTypeFlags | aTypes | ) |
Get all interactive fields of the specified types.
There is a setFlags() flag modifying the behavior of this function: DocumentFlags.AmbiguousButtonValueEmpty.
[in] | aTypes | 0 to get fields of all types. Otherwise, a bitset selecting the field types to be included. |
SignDocField [] getFieldsOfPage | ( | int | aPage, |
FieldTypeFlags | aTypes | ||
) |
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: DocumentFlags.AmbiguousButtonValueEmpty.
[in] | aPage | The 1-based page number. |
[in] | aTypes | 0 to get fields of all types. Otherwise, a bitset selecting the field types to be included. |
DocumentFlags getFlags | ( | ) |
int? getIntegerProperty | ( | string | aCollection, |
string | aName | ||
) |
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.
[in] | aCollection | The name of the collection, see getProperties(). |
[in] | aName | The name of the property. |
string 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.
int 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.
int getPageCount | ( | ) |
double getPageHeight | ( | int | aPage | ) |
Get the height of a page.
Different pages of the document may have different sizes.
[in] | aPage | The page number (1 for the first page). |
string getPageLabel | ( | int | aPage | ) |
Get the page label for a page number.
For TIFF documents, aPage will be converted to a decimal number.
[in] | aPage | The page number (1 for the first page). |
double getPageWidth | ( | int | aPage | ) |
Get the width of a page.
Different pages of the document may have different sizes.
[in] | aPage | The page number (1 for the first page). |
string 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.
string [] getProfiles | ( | string | aFieldName | ) |
Get a list of profiles for a signature field.
[in] | aFieldName | The name of the signature field. |
SignDocProperty [] getProperties | ( | string | aCollection | ) |
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.
There are two collections of SignDoc document properties:
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 exception SignDocWrongCollectionException. 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.
[in] | aCollection | The name of the collection, see above. |
SignDocRenderOutput getRenderedSize | ( | SignDocRenderParameters | aParams | ) |
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 (integer parameters "FirstPage" and "LastPage" of aParams), the maximum width and maximum height of all selected pages will be used.
[in] | aParams | Parameters such as the page number. |
SaveFlags getRequiredSaveToFileFlags | ( | ) |
Get all flags currently required for saveToFile().
This function currently returns SaveFlags.Incremental (saving the document non-incrementally would destroy existing signatures) or 0 (the document may be saved non-incrementally).
double getResolutionX | ( | int | aPage | ) |
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.
See Coordinate Systems.
[in] | aPage | The page number (1 for the first page). |
double getResolutionY | ( | int | aPage | ) |
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.
See Coordinate Systems.
[in] | aPage | The page number (1 for the first page). |
SaveFlags getSaveToFileFlags | ( | ) |
Get all flags currently valid for saveToFile().
Note that SaveFlags.Incremental cannot be used together with SaveFlags.Linearized even if all these flags are returned by this function. SaveFlags.PDFAButtons is returned only if the document claims PDF/A-1 conformance.
SaveFlags getSaveToStreamFlags | ( | ) |
Get all flags currently valid for saveToStream() and saveToMemory().
Note that SaveFlags.Incremental cannot be used together with SaveFlags.Linearized even if all these flags are returned by this function. SaveFlags.PDFAButtons is returned only if the document claims PDF/A-1 conformance.
ShootInFootFlags getShootInFoot | ( | ) |
Get the flags set by setShootInFoot().
SignDocSignature getSignature | ( | int | aIndex | ) |
Get a signature of the document.
By passing values for 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.
[in] | aIndex | The index of the signature, 0 for the first signature applied to the document, getSignatureCount()-1 for the newest signature. |
int getSignatureCount | ( | ) |
Get the number of signatures that can be retrieved with getSignature().
string getStringProperty | ( | string | aCollection, |
string | aName | ||
) |
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.
[in] | aCollection | The name of the collection, see getProperties(). |
[in] | aName | The name of the property. |
SignDocTextFieldAttributes getTextFieldAttributes | ( | ) |
Get the document's default text field attributes.
DocumentType getType | ( | ) |
Get the type of the document.
void importPageFromImageBlob | ( | int | aTargetPage, |
byte[] | aData, | ||
double | aZoom, | ||
double | aWidth, | ||
double | aHeight, | ||
ImportImageFlags | aFlags | ||
) |
Import a page from a blob containing an image.
This function behaves like importPageFromImageBlob2() with an empty string for aDescription, that is, if the document uses Tagged PDF, a dummy alternate description for the image ("image" with language code "en") will provided to avoid breaking standard compliance. It is strongly recommended to use importPageFromImageBlob2() with a meaningful description of the image.
This function is currently implemented for PDF documents only.
[in] | aTargetPage | The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0. |
[in] | aData | The blob containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP. |
[in] | aZoom | Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom. |
[in] | aWidth | Page width (document coordinates) or zero. If this argument is non-zero, aHeight must also be non-zero and aZoom must be zero. The image will be scaled to this width. |
[in] | aHeight | Page height (document coordinates) or zero. If this argument is non-zero, aWidth must also be non-zero and aZoom must be zero. The image will be scaled to this height. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ImportImageFlags. ImportImageFlags.KeepAspectRatio is not needed if aZoom is non-zero. |
void importPageFromImageBlob2 | ( | int | aTargetPage, |
byte[] | aData, | ||
double | aZoom, | ||
double | aWidth, | ||
double | aHeight, | ||
ImportImageFlags | aFlags, | ||
string | aDescription, | ||
string | aLang | ||
) |
Import a page from a blob containing an image (with alternate description).
This function is currently implemented for PDF documents only.
[in] | aTargetPage | The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0. |
[in] | aData | The blob containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP. |
[in] | aZoom | Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom. |
[in] | aWidth | Page width (document coordinates) or zero. If this argument is non-zero, aHeight must also be non-zero and aZoom must be zero. The image will be scaled to this width. |
[in] | aHeight | Page height (document coordinates) or zero. If this argument is non-zero, aWidth must also be non-zero and aZoom must be zero. The image will be scaled to this height. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ImportImageFlags. ImportImageFlags.KeepAspectRatio is not needed if aZoom is non-zero. |
[in] | aDescription | Alternate description for the image. If this value is an empty string, aLang will be ignored. If this value is an empty string and the document uses Tagged PDF, "image" with language code "en" will be used to avoid breaking standard compliance. It is strongly recommended to use a meaningful description. Escape sequences must not be used. |
[in] | aLang | Language identifier for aDescription. Unless aDescription is an empty string, this must be a string containing an RFC 3066 language tag. Example: "en-US". |
void importPageFromImageFile | ( | int | aTargetPage, |
string | aPath, | ||
double | aZoom, | ||
double | aWidth, | ||
double | aHeight, | ||
ImportImageFlags | aFlags | ||
) |
Import a page from a file containing an image.
This function behaves like importPageFromImageFile2() with an empty string for aDescription, that is, if the document uses Tagged PDF, a dummy alternate description for the image ("image" with language code "en") will provided to avoid breaking standard compliance. It is strongly recommended to use importPageFromImageFile2() with a meaningful description of the image.
This function is currently implemented for PDF documents only.
[in] | aTargetPage | The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0. |
[in] | aPath | The pathname of the file containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP. |
[in] | aZoom | Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom. |
[in] | aWidth | Page width (document coordinates) or zero. If this argument is non-zero, aHeight must also be non-zero and aZoom must be zero. The image will be scaled to this width. |
[in] | aHeight | Page height (document coordinates) or zero. If this argument is non-zero, aWidth must also be non-zero and aZoom must be zero. The image will be scaled to this height. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ImportImageFlags. ImportImageFlags.KeepAspectRatio is not needed if aZoom is non-zero. |
void importPageFromImageFile2 | ( | int | aTargetPage, |
string | aPath, | ||
double | aZoom, | ||
double | aWidth, | ||
double | aHeight, | ||
ImportImageFlags | aFlags, | ||
string | aDescription, | ||
string | aLang | ||
) |
Import a page from a file containing an image (with alternate description).
This function is currently implemented for PDF documents only.
[in] | aTargetPage | The 1-based number of the page before which to insert the new page. The page will be appended if this value is 0. |
[in] | aPath | The pathname of the file containing the image. Supported formats for inserting into PDF documents are: JPEG, PNG, GIF, TIFF, and BMP. |
[in] | aZoom | Zoom factor or zero. If this argument is non-zero, aWidth and aHeight must be zero. The size of the page is computed from the image size and resolution, multiplied by aZoom. |
[in] | aWidth | Page width (document coordinates) or zero. If this argument is non-zero, aHeight must also be non-zero and aZoom must be zero. The image will be scaled to this width. |
[in] | aHeight | Page height (document coordinates) or zero. If this argument is non-zero, aWidth must also be non-zero and aZoom must be zero. The image will be scaled to this height. |
[in] | aFlags | Flags modifying the behavior of this function, See enum ImportImageFlags. ImportImageFlags.KeepAspectRatio is not needed if aZoom is non-zero. |
[in] | aDescription | Alternate description for the image. If this value is an empty string, aLang will be ignored. If this value is an empty string and the document uses Tagged PDF, "image" with language code "en" will be used to avoid breaking standard compliance. It is strongly recommended to use a meaningful description. Escape sequences must not be used. |
[in] | aLang | Language identifier for aDescription. Unless aDescription is an empty string, this must be a string containing an RFC 3066 language tag. Example: "en-US". |
void importPages | ( | int | aTargetPage, |
SignDocDocument | aSource, | ||
int | aSourcePage, | ||
int | aPageCount, | ||
ImportPagesFlags | aFlags | ||
) |
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 interactive fields in the target document.
Page labels are currently ignored, that is, they will probably be messed up in the target document.
Unless flag ShootInFootFlags.AllowBreakingTaggedPDF is set, this function may fail for some values of aTargetPage as the target structure may not be suitable for insertion of pages between certain pages. Appending pages after the last page should always work.
[in] | aTargetPage | The 1-based number of the page before which to insert the copied pages. The pages will be appended if this value is 0. |
[in] | aSource | The document from which to copy the pages. aSource can be this. |
[in] | aSourcePage | The 1-based number of the first page (in the source document) to be copied. |
[in] | aPageCount | The number of pages to be copied. All pages of aSource starting with aSourcePage will be copied if this value is 0. |
[in] | aFlags | Must be ImportPagesFlags.Zero. |
void importProperties | ( | string | aCollection, |
InputStream | aStream, | ||
ImportFlags | aFlags | ||
) |
Import properties from XML (reading a stresm).
The input must conform to schema AllSignDocProperties.xsd (if aCollection is empty) or SignDocProperties.xsd (if aCollection is non-empty).
[in] | aCollection | The name of the collection, see getProperties(). If the string is empty, properties will be imported into all collections, otherwise properties will be imported into the specified collection. |
[in] | aStream | The properties will be read from this stream. This function reads the input completely, it doesn't stop at the end tag. |
[in] | aFlags | Flags modifying the behavior of this function, see enum ImportFlags. |
void importPropertiesFromMemory | ( | string | aCollection, |
byte[] | aBlob, | ||
ImportFlags | aFlags | ||
) |
Import properties from XML (reading a blob).
The input must conform to schema AllSignDocProperties.xsd (if aCollection is empty) or SignDocProperties.xsd (if aCollection is non-empty).
[in] | aCollection | The name of the collection, see getProperties(). If the string is empty, properties will be imported into all collections, otherwise properties will be imported into the specified collection. |
[in] | aBlob | The properties will be read from this blob. |
[in] | aFlags | Flags modifying the behavior of this function, see enum ImportFlags. |
bool isModified | ( | ) |
Check if the document has unsaved changes.
bool isTaggedPDF | ( | ) |
Check if the document is a Tagged PDF document.
void removeAnnotation | ( | int | aPage, |
string | aName | ||
) |
Remove an annotation identified by name.
[in] | aPage | The page number (1 for the first page). |
[in] | aName | The name of the annotation, must not be empty. |
void removeAttachment | ( | string | aName | ) |
Remove an attachment from the document.
Attachments are supported for PDF documents only.
[in] | aName | The name of the attachment. |
void removeDocMDP | ( | ) |
Remove any certification signature.
This function does nothing for TIFF documents as TIFF documents do not have certification signatures.
void removeField | ( | string | aName | ) |
Remove a field.
Removing a field of a TIFF document will invalidate all signatures.
[in] | aName | The fully-qualified name of the field. |
void removeLogicalStructure | ( | RemoveFlags | aFlags | ) |
Remove the logical structure.
This function is available for PDF documents only.
[in] | aFlags | Must be RemoveFlags.Zero. |
void removePages | ( | ConstArray(int) | aPages, |
KeepOrRemove | aMode | ||
) |
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 FieldFlags.SinglePage flag set can survive removal of pages.
[in] | aPages | An array of one-based page numbers. The order does not matter, neither does the number of occurences of a page number. |
[in] | aMode | Tell this function whether to keep or to remove the pages specified by aPages. |
void removePDFA | ( | RemoveFlags | aFlags | ) |
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.
[in] | aFlags | Must be RemoveFlags.Zero. |
void removePDFUA | ( | RemoveFlags | aFlags | ) |
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.
[in] | aFlags | Must be RemoveFlags.Zero. |
void removePermissions | ( | RemoveFlags | aFlags | ) |
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.
[in] | aFlags | Must be RemoveFlags.Zero. |
void removeProperty | ( | string | aCollection, |
string | aName | ||
) |
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.
[in] | aCollection | The name of the collection, see getProperties(). |
[in] | aName | The name of the property. |
void removeXFA | ( | RemoveFlags | aFlags | ) |
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.
[in] | aFlags | Must be RemoveFlags.Zero. |
byte [] renderPageAsImage | ( | SignDocRenderOutput | aOutput, |
SignDocRenderParameters | aRenderParameters, | ||
SignDocVerificationParameters | aVerificationParameters, | ||
Rect | aClipRect | ||
) |
Render the selected page (or pages) as image.
[in,out] | aOutput | The image size will be stored here. |
[in] | aRenderParameters | Parameters such as the page number. |
[in] | aVerificationParameters | Parameters for verification of signatures. Used only if setDecorations(true) has been called for aRenderParameters. Currently, signatures are verified one after another and the "Timeout" integer parameter applies to each verification. Pass null for default parameters. |
[in] | aClipRect | The rectangle to be rendered (using document coordinates, see Coordinate Systems) or null to render the complete page. |
SignDocImage renderPageAsSignDocImage | ( | SignDocRenderOutput | aOutput, |
SignDocRenderParameters | aRenderParameters, | ||
SignDocVerificationParameters | aVerificationParameters, | ||
Rect | aClipRect | ||
) |
Render the selected page (or pages) as SignDocImage object.
Only a single page can be rendered.
[in,out] | aOutput | The image size will be stored here. |
[in] | aRenderParameters | Parameters such as the page number. |
[in] | aVerificationParameters | Parameters for verification of signatures. Used only if setDecorations(true) has been called for aRenderParameters. Currently, signatures are verified one after another and the "Timeout" integer parameter applies to each verification. Pass null for default parameters. |
[in] | aClipRect | The rectangle to be rendered (using document coordinates, see Coordinate Systems) or null to render the complete page. |
void saveToFile | ( | string | aPath, |
SaveFlags | aFlags | ||
) |
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.
Saving a signed PDF document without SaveFlags.Incremental will fail unless SaveFlags.AutoIncremental is also set. See also getRequiredSaveToFileFlags().
The file will remain open until the document is saved again or the SignDocDocument object is closed or destroyed.
[in] | aPath | The pathname of the file to be created or overwritten. Pass an empty string to save to the file from which the document was loaded or most recently saved (which will fail if the documment was loaded from memory or saved to a stream). See Using SignDoc SDK in Windows Store apps for restrictions on pathnames in Windows Store apps. |
[in] | aFlags | Set of flags (of enum SaveFlags, combined with `|') modifying the behavior of this function. Pass 0 for no flags. Which flags are available depends on the document type. Which flags are required depends on the document state. Call getRequiredSaveToFileFlags() to get the flags that are required. |
byte [] saveToMemory | ( | SaveFlags | aFlags | ) |
Save the document to a blob.
This function may have side effects on the document such as marking it as not modified which may render SaveFlags.Incremental useless for the next saveToFile() call unless the document is changed between those two calls.
After calling this function, the document will be backed by memory.
[in] | aFlags | Set of flags (of enum SaveFlags, combined with `|') modifying the behavior of this function. Pass 0 for no flags. Which flags are available depends on the document type. |
void saveToStream | ( | Stream | aStream, |
SaveFlags | aFlags | ||
) |
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 SaveFlags.Incremental useless for the next saveToFile() call unless the document is changed between those two calls.
After calling this function, the document will be backed by memory.
[in] | aStream | The document will be saved to this stream. |
[in] | aFlags | Set of flags (of enum SaveFlags, combined with `|') modifying the behavior of this function. Pass 0 for no flags. Which flags are available depends on the document type. |
void setBooleanProperty | ( | string | aCollection, |
string | aName, | ||
bool | aValue | ||
) |
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.
[in] | aCollection | The name of the collection, see getProperties(). |
[in] | aName | The name of the property. |
[in] | aValue | The new value of the property. |
void setCompatibility | ( | int | aMajor, |
int | aMinor | ||
) |
Request to not make changes to the document which are incompatible with an older version of this class.
No features introduced after aMajor.aMinor will be used.
Passing a version number before 1.11 or after the current version will fail.
[in] | aMajor | Major version number. |
[in] | aMinor | Minor version number. |
void setCompressionLevel | ( | int | aLevel | ) |
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.
[in] | aLevel | The new compression level for encoding data with the FlateDecode filter. Allowed values are 0 (fastest, do not use FlateDecode), and 1 (fast, least compression) through 9 (slowest, best compression). The default value is 6. |
void setDefaultDocumentLanguage | ( | string | aLang | ) |
Set the language identifier to be used if a language identifier is required but the document doesn't provide one.
If this function is not called, "en" will be used.
This function is available for PDF documents only.
[in] | aLang | An RFC 3066 language tag. Must not be an empty string. Example: "en-US". |
void setDocumentLanguage | ( | string | aLang | ) |
Set the document's natural language.
That language applies to all text unless overridden locally.
This function is available for PDF documents only.
[in] | aLang | The natural language for the document (an RFC 3066 language tag). Must not be an empty string. Example: "en-US". |
void setField | ( | SignDocField | aField, |
SetFieldFlags | aFlags | ||
) |
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 FieldFlags.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 SetFieldFlags.Move is set in 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.
[in,out] | aField | The field to be changed. The font resource name of the default text field attributes may be modified. The value index and the value may be modified for radio button fields and check box fields. |
[in] | aFlags | Set of flags (of enum SetFieldFlags, combined with `|') modifying the behavior of this function. Pass 0 for no flags. |
void setFlags | ( | DocumentFlags | aFlags | ) |
Set flags modifying the behavior of various functions.
The default is value is 0.
[in] | aFlags | New set of flags, see enum DocumentFlags. |
void setIntegerProperty | ( | string | aCollection, |
string | aName, | ||
int | aValue | ||
) |
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.
[in] | aCollection | The name of the collection, see getProperties(). |
[in] | aName | The name of the property. |
[in] | aValue | The new value of the property. |
void setShootInFoot | ( | ShootInFootFlags | aFlags | ) |
Disable safety checks.
The default value, 0, makes operations fail which would invalidate existing signatures (signature fields) or signatures granting permissions.
[in] | aFlags | New set of flags, see enum ShootInFootFlags. |
void setStringProperty | ( | string | aCollection, |
string | aName, | ||
string | aValue | ||
) |
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. Embedded NUL characters are not supported.
[in] | aCollection | The name of the collection, see getProperties(). |
[in] | aName | The name of the property. |
[in] | aValue | The new value of the property. |
void setTextFieldAttributes | ( | SignDocTextFieldAttributes | aData | ) |
Set the document's default text field attributes.
Font name, font size, and text color must be specified. This function fails if aData has any but not all attributes set or if any of the attributes are invalid.
This function fails for signed PDF document.
This function always fails for TIFF documents.
[in,out] | aData | The new default text field attributes. The font resource name will be updated. |
|
static |
Split a string obtained from a PDF text string into escape sequences and text segments.
You don't need to call this function unless flag DocumentFlags.KeepEscapeSequences is set.
[in] | aInput | The input string. |
int updateDSS | ( | SignDocVerificationParameters | aParameters, |
UpdateDSSFlags | aFlags | ||
) |
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.
[in] | aParameters | Verification parameters or null for default parameters. |
[in] | aFlags | Flags modifying the behavior of this function, see UpdateDSSFlags.Simulate and UpdateDSSFlags.VRI. |
void updateDSS2 | ( | string | aFieldName, |
SignDocVerificationParameters | aParameters, | ||
UpdateDSSFlags | aFlags | ||
) |
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 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: SigningMethod.DigSigPKCS7Detached, SigningMethod.DigSigPKCS7SHA1, SigningMethod.DigSigCadesDetached, or SigningMethod.DigSigCadesRFC3161.
This function does nothing if the signature field is not signed.
[in] | aFieldName | The name of the signature field. |
[in] | aParameters | Verification parameters or null for default parameters. |
[in] | aFlags | Flags modifying the behavior of this function, see UpdateDSSFlags.Simulate and UpdateDSSFlags.VRI. |
SignDocVerificationResult verifySignature | ( | string | aFieldName | ) |
Verify a signature of the document.
There is a setFlags() flag modifying the behavior of this function: DocumentFlags.RelaxByteRange.
[in] | aFieldName | The name of the signature field. |
SignDocVerificationResult verifySignature2 | ( | SignDocSignature | aSignature | ) |
Verify a signature of the document.
These are the differences between calling this function and calling verifySignature() with the field name obtained from aSignature:
There is a setFlags() flag modifying the behavior of this function: DocumentFlags.RelaxByteRange.
[in] | aSignature | A SignDocSignature object for this document. |
|
static |
Prepend an escape sequence for specifying the natural language in a text string.
[in] | aText | The text. |
[in] | aLang | Language identifier (an RFC3066 language tag with two-character language code and optional two-character country code). Only the language and the optional country will be used, the dash separating them will be removed. Example: "en-US" will prepend ESC "enUS" ESC. |
|
static |
Remove escape sequences specifying the natural language in text strings.
You don't need to call this function unless flag DocumentFlags.KeepEscapeSequences is set.
[in] | aInput | The input string. |