Signature
Contents
[
Hide
]
Signature class
Represents main class that controls document signing process.
public class Signature : IDisposable
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(BaseSignature) | Deletes passed signature BaseSignature from the document. |
| Delete(List<BaseSignature>) | Deletes passed list of signatures BaseSignature from the document. |
| Delete(List<SignatureType>) | 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 |
| Delete(List<string>) | 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(string) | Deletes signature by its specific signature Id from the document. |
| Dispose() | Implement IDisposable interface to clean up internal resources |
| GeneratePreview(PreviewOptions) | Generates document pages preview. |
| GetDocumentInfo() | Gets information about document pages: their sizes, maximum page height, the width of a page with the maximum height. |
| Search(List<SearchOptions>) | Searches for signatures in a document by SearchOptions list. |
| Search(params SignatureType[]) | Searches for specified signature types in the document by SignatureType value. |
| Search<T>(SearchOptions) | Searches for signatures in a document by SearchOptions options. |
| Search<T>(SignatureType) | Searches for exact type of signatures in the document by SignatureType value. |
| Sign(Stream, List<SignOptions>) | Signs document with collection of SignOptions and saves result to a stream. |
| Sign(Stream, SignOptions) | Signs document with SignOptions and saves result to a stream. |
| Sign(string, List<SignOptions>) | Signs document with collection of SignOptions and saves result to specified file path. |
| Sign(string, SignOptions) | Signs document with SignOptions and saves result to specified file path. |
| Sign(Stream, List<SignOptions>, SaveOptions) | Signs document with collection of SignOptions and saves result to a stream with predefined SaveOptions. |
| Sign(Stream, SignOptions, SaveOptions) | Signs document with SignOptions and saves result to a stream with predefined SaveOptions. |
| Sign(string, List<SignOptions>, SaveOptions) | Signs document with collection of SignOptions and saves result to specified file path with predefined SaveOptions. |
| Sign(string, SignOptions, SaveOptions) | Signs document with SignOptions and saves result to specified file path with predefined SaveOptions. |
| Update(BaseSignature) | Updates passed signature BaseSignature in the document. |
| Update(List<BaseSignature>) | Updates passed signatures BaseSignature in the document. |
| Verify(List<VerifyOptions>) | Verifies the document signatures with list of VerifyOptions data. |
| Verify(VerifyOptions) | Verifies the document signatures with given VerifyOptions data. |
| static GenerateSignaturePreview(PreviewSignatureOptions) | Generates Signature preview based on given SignOptions. SignOptions |
Events
| Name | Description |
|---|---|
| event SearchCompleted | Occurs when signature search process completed. |
| event SearchProgress | Occurs when signature search process progress changed. |
| event SearchStarted | Occurs when signature search process started. |
| event SignCompleted | Occurs when document signing process completed. |
| event SignProgress | Occurs when document signing process progress changed. |
| event SignStarted | Occurs when document signing process started. |
| event VerifyCompleted | Occurs when signature verification process completed. |
| event VerifyProgress | Occurs when signature verification process progress changed. |
| event VerifyStarted | Occurs when signature verification process started. |
Remarks
Learn more
- More about GroupDocs.Signature features: GroupDocs.Signature Developer Guide
See Also
- namespace GroupDocs.Signature
- assembly GroupDocs.Signature
