| Signature Class |
Represents main class that controls document signing process.
Inheritance HierarchyNamespace: GroupDocs.Signature
Assembly: GroupDocs.Signature (in GroupDocs.Signature.dll) Version: 22.8.0.0 (22.8)
SyntaxThe Signature type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Signature(Stream) |
Initializes new instance of Signature class with document provided by stream.
|
| Signature(String) |
Initializes new instance of Signature class instance with document provided by file path.
|
| Signature(Stream, LoadOptions) |
Initializes new instance of Signature class with document provided by stream and load options LoadOptions.
|
| Signature(Stream, SignatureSettings) |
Initializes new instance of Signature class instance with document provided by stream and SignatureSettings.
|
| Signature(String, LoadOptions) |
Initializes new instance of Signature class instance with document provided by file path and LoadOptions.
|
| Signature(String, SignatureSettings) |
Initializes new instance of Signature class instance with document provided by file path and SignatureSettings.
|
| Signature(Stream, LoadOptions, SignatureSettings) |
Initializes new instance of Signature class instance with document provided by stream, load options LoadOptions and settings SignatureSettings.
|
| Signature(String, LoadOptions, SignatureSettings) |
Initializes new instance of Signature class instance with document provided by file path, LoadOptions and SignatureSettings.
|
Methods| Name | Description | |
|---|---|---|
| Delete(ListString) |
Deletes passed list of signatures BaseSignature from the document.
|
| Delete(String) |
Deletes signature by its specific signature Id from the document.
|
| Delete(BaseSignature) |
Deletes passed signature BaseSignature from the document.
|
| Delete(ListBaseSignature) |
Deletes passed list of signatures BaseSignature from the document.
|
| Delete(SignatureType) |
Deletes signatures of the certain type SignatureType from the document.
Only signatures that were added by Sign method and marked as Signatures IsSignature will be removed.
Following signature types are supported: Text, Image, Digital, Barcode, QR-Code
|
| Delete(ListSignatureType) |
Deletes the signatures of the certain types list SignatureType from the document.
Only signatures that were added by Sign method and marked as Signatures IsSignature will be removed.
Following signature types are supported: Text, Image, Digital, Barcode, QR-Code
|
| Dispose |
Implement IDisposable interface to clean up internal resources
|
| Equals | (Inherited from Object.) |
 | Finalize | (Inherited from Object.) |
| GeneratePreview |
Generates document pages preview.
|
 | GenerateSignaturePreview |
Generates Signature preview based on given SignOptions. SignOptions |
| GetDocumentInfo |
Gets information about document pages: their sizes,
maximum page height, the width of a page with the maximum height.
|
| GetHashCode | (Inherited from Object.) |
| GetType | (Inherited from Object.) |
| MemberwiseClone | (Inherited from Object.) |
| Search(ListSearchOptions) |
Searches for signatures in a document by SearchOptions list.
|
| Search(SignatureType) |
Searches for specified signature types in the document by SignatureType value.
|
| SearchT(SearchOptions) |
Searches for signatures in a document by SearchOptions options.
|
| SearchT(SignatureType) |
Searches for exact type of signatures in the document by SignatureType value.
|
| Sign(Stream, SignOptions) |
Signs document with SignOptions and saves result to a stream.
|
| Sign(Stream, ListSignOptions) |
Signs document with collection of SignOptions and saves result to a stream.
|
| Sign(String, SignOptions) |
Signs document with SignOptions and saves result to specified file path.
|
| Sign(String, ListSignOptions) |
Signs document with collection of SignOptions and saves result to specified file path.
|
| Sign(Stream, SignOptions, SaveOptions) |
Signs document with SignOptions and saves result to a stream with predefined SaveOptions.
|
| Sign(Stream, ListSignOptions, SaveOptions) |
Signs document with collection of SignOptions and saves result to a stream with predefined SaveOptions.
|
| Sign(String, SignOptions, SaveOptions) |
Signs document with SignOptions and saves result to specified file path with predefined SaveOptions.
|
| Sign(String, ListSignOptions, SaveOptions) |
Signs document with collection of SignOptions and saves result to specified file path with predefined SaveOptions.
|
| ToString | (Inherited from Object.) |
| Update(BaseSignature) |
Updates passed signature BaseSignature in the document.
|
| Update(ListBaseSignature) |
Updates passed signatures BaseSignature in the document.
|
| Verify(VerifyOptions) |
Verifies the document signatures with given VerifyOptions data.
|
| Verify(ListVerifyOptions) |
Verifies the document signatures with list of VerifyOptions data.
|
Events| Name | Description | |
|---|---|---|
 | SearchCompleted |
Occurs when signature search process completed.
|
| SearchProgress |
Occurs when signature search process progress changed.
|
| SearchStarted |
Occurs when signature search process started.
|
| SignCompleted |
Occurs when document signing process completed.
|
| SignProgress |
Occurs when document signing process progress changed.
|
| SignStarted |
Occurs when document signing process started.
|
| VerifyCompleted |
Occurs when signature verification process completed.
|
| VerifyProgress |
Occurs when signature verification process progress changed.
|
| VerifyStarted |
Occurs when signature verification process started.
|
RemarksLearn more
- More about GroupDocs.Signature features: GroupDocs.Signature Developer Guide
See Also