GemBox.Spreadsheet
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    XlsxDigitalSignatureSaveOptions Class

    Namespace:
    GemBox.Spreadsheet
    Assembly:
    GemBox.Spreadsheet.dll

    Represents a class that stores details for signing a workbook saved to XLSX file with a digital signature.

    • C#
    • VB.NET
    public class XlsxDigitalSignatureSaveOptions : DigitalSignatureSaveOptions
    Public Class XlsxDigitalSignatureSaveOptions
        Inherits DigitalSignatureSaveOptions
    Inheritance:
    System.Object
    DigitalSignatureSaveOptions
    XlsxDigitalSignatureSaveOptions
    Remarks

    Workbook will be digitally signed when saved to a XLSX if Certificate, CertificateBytes or CertificatePath is specified, otherwise it will be saved but not digitally signed.

    Constructors

    XlsxDigitalSignatureSaveOptions()

    Initializes a new instance of the XlsxDigitalSignatureSaveOptions class.

    • C#
    • VB.NET
    public XlsxDigitalSignatureSaveOptions()
    Public Sub New

    Properties

    Address

    Get or sets the location at which the signature was created

    • C#
    • VB.NET
    public string Address { get; set; }
    Public Property Address As String
    Property Value
    System.String

    The location at which the signature was created

    Remarks

    This property is displayed in document only when IsAdvancedElectronicSignature is true.

    Address2

    Get or sets the additional location at which the signature was created

    • C#
    • VB.NET
    public string Address2 { get; set; }
    Public Property Address2 As String
    Property Value
    System.String

    The additional location at which the signature was created

    Remarks

    This property is displayed in document only when IsAdvancedElectronicSignature is true.

    Certificates

    Gets additional certificates to be embedded in the signature.

    • C#
    • VB.NET
    public IList<Certificate> Certificates { get; }
    Public ReadOnly Property Certificates As IList(Of Certificate)
    Property Value
    System.Collections.Generic.IList<Certificate>

    The additional certificates to be embedded in the signature.

    Remarks

    This property is saved to the document only when IsAdvancedElectronicSignature is true.

    City

    Gets or sets the city associated with the signer

    • C#
    • VB.NET
    public string City { get; set; }
    Public Property City As String
    Property Value
    System.String

    The city associated with the signer

    Remarks

    This property is saved to the document only when IsAdvancedElectronicSignature is true.

    CommitmentType

    Gets or sets the commitment type when signing a document.

    • C#
    • VB.NET
    public DigitalSignatureCommitmentType CommitmentType { get; set; }
    Public Property CommitmentType As DigitalSignatureCommitmentType
    Property Value
    DigitalSignatureCommitmentType

    The commitment type when signing a document.

    Remarks

    This property is saved to the document only when IsAdvancedElectronicSignature is true.

    Country

    Gets or sets the country associated with the signer

    • C#
    • VB.NET
    public string Country { get; set; }
    Public Property Country As String
    Property Value
    System.String

    The country associated with the signer

    Remarks

    This property is saved to the document only when IsAdvancedElectronicSignature is true.

    IsAdvancedElectronicSignature

    Gets or sets a value indicating whether the signature is XMS Advanced Electronic Signature (XAdES). The default value of this property is true.

    • C#
    • VB.NET
    public bool IsAdvancedElectronicSignature { get; set; }
    Public Property IsAdvancedElectronicSignature As Boolean
    Property Value
    System.Boolean

    true if the signature is XML Advanced Electronic Signature (XAdES); otherwise, false.

    PostalCode

    Gets or sets the postal or zip code associated with the signer

    • C#
    • VB.NET
    public string PostalCode { get; set; }
    Public Property PostalCode As String
    Property Value
    System.String

    The postal or zip code associated with the signer

    Remarks

    This property is saved to the document only when IsAdvancedElectronicSignature is true.

    SignerRole

    Gets or sets the signer role.

    • C#
    • VB.NET
    public string SignerRole { get; set; }
    Public Property SignerRole As String
    Property Value
    System.String

    The signer role.

    Remarks

    This property is saved to the document only when IsAdvancedElectronicSignature is true.

    State

    Gets or sets the state or province associated with the signer

    • C#
    • VB.NET
    public string State { get; set; }
    Public Property State As String
    Property Value
    System.String

    The state or province associated with the signer

    Remarks

    This property is saved to the document only when IsAdvancedElectronicSignature is true.

    Inherited Properties

    Certificate

    Gets or sets the X.509 certificate.

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

    (Inherited from DigitalSignatureSaveOptions)

    CertificateBytes

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

    (Inherited from DigitalSignatureSaveOptions)

    CertificatePassword

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

    (Inherited from DigitalSignatureSaveOptions)

    CertificatePath

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

    (Inherited from DigitalSignatureSaveOptions)

    Reason

    Gets or sets the reason for the signing.

    (Inherited from DigitalSignatureSaveOptions)

    Signature

    Gets or sets the signature.

    (Inherited from DigitalSignatureSaveOptions)

    UseMachineKeySet

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

    (Inherited from DigitalSignatureSaveOptions)

    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.