DigitalSignatureSaveOptions Class

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Represents a class that stores details for signing a document with a digital signature.

public abstract class DigitalSignatureSaveOptions
Public MustInherit Class DigitalSignatureSaveOptions
Inheritance:
System.Object
DigitalSignatureSaveOptions
Derived
DocxDigitalSignatureSaveOptions
PdfDigitalSignatureSaveOptions

Properties

Certificate

Gets or sets the X.509 certificate.

Value must be of type System.Security.Cryptography.X509Certificates.X509Certificate2.

public object Certificate { get; set; }
Public Property Certificate As Object
Property Value
System.Object

The X.509 certificate.

See Also

CertificateBytes

Gets or sets the byte array that contains data from an X.509 certificate.

public byte[] CertificateBytes { get; set; }
Public Property CertificateBytes As Byte()
Property Value
System.Byte[]

The byte array that contains data from an X.509 certificate.

CertificatePassword

Gets or sets the password required to access the X.509 certificate data.

public string CertificatePassword { get; set; }
Public Property CertificatePassword As String
Property Value
System.String

The password required to access the X.509 certificate data.

CertificatePath

Gets or sets the file path to the X.509 certificate.

public string CertificatePath { get; set; }
Public Property CertificatePath As String
Property Value
System.String

The file path to the X.509 certificate.

Reason

Gets or sets the reason for the signing.

public string Reason { get; set; }
Public Property Reason As String
Property Value
System.String

The reason for the signing, such as ( I agree … ).

Signature

Gets or sets the signature.

public DrawingElement Signature { get; set; }
Public Property Signature As DrawingElement
Property Value
DrawingElement

The signature.

Remarks

If value is null, then digital signature won't have any visual representation.

Signature is not drawn in the same layer as the rest of the page, but in a layer above the page. If signature is contained in the document, then its position is specified through Layout. Otherwise, if signature is not contained in the document, its position is relative to SignatureLine. So, if signature is not contained in the document and its layout is InlineLayout, then signature will have the same bottom-left position as the SignatureLine (they will both be in the same line). If signature is not contained in the document and its layout is FloatingLayout, then signature will be positioned relative to SignatureLine regardless whether horizontal/vertical anchor is Page, Column, Paragraph, Line or Character.

SignatureLine

Gets or sets the signature line.

public DrawingElement SignatureLine { get; set; }
Public Property SignatureLine As DrawingElement
Property Value
DrawingElement

The signature line.

Remarks

Used to associate digital signature with document's content (so that digital signature has a placeholder for its visual representation) if digital signature is not contained in the document. If value is null and Signature is not contained in the document, then digital signature won't have any visual representation.

UseMachineKeySet

Gets or sets a value indicating whether private keys are stored in the local computer store rather than the current user store.

public bool UseMachineKeySet { get; set; }
Public Property UseMachineKeySet As Boolean
Property Value
System.Boolean

true if private keys are stored in the local computer store rather than the current user store; otherwise, false.