GrapeCity.Documents.Excel.ISignature

Interface ISignature

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Corresponds to a digital signature that is attached to a document.

public interface ISignature

Properties

CanSetup

Gets a bool value indicating whether the user can set properties of the GrapeCity.Documents.Excel.Signature object. Read-only.

bool CanSetup { get; }

Property Value

bool

Details

Gets information about a signature. Read-only.

IReadOnlySignatureDetails Details { get; }

Property Value

IReadOnlySignatureDetails

IsSignatureLine

Gets a value indicating whether this is a signature line. Read-only.

bool IsSignatureLine { get; }

Property Value

bool

IsSigned

Gets a bool value indicating whether the document was signed successfully. Read-only.

bool IsSigned { get; }

Property Value

bool

IsValid

Determines if the digital signature that corresponds to the Signature object is a valid signature.

bool IsValid { get; }

Property Value

bool

Parent

Returns the Parent object for the specified object.

ISignatureSet Parent { get; }

Property Value

ISignatureSet

Setup

Gets a ISignatureSetup object that provides access to various properties of a signature packet. Read-only.

ISignatureSetup Setup { get; }

Property Value

ISignatureSetup

SignDate

Returns an Object representing the date and time that the digital certificate corresponding to the Signature object was attached to the document.

DateTime? SignDate { get; }

Property Value

DateTime?

SignatureLineShape

Gets the Shape object associated with a Signature object that is a signature line. Read-only.

IShape SignatureLineShape { get; }

Property Value

IShape

Methods

Countersign(X509Certificate2)

Countersign the signature, if the signature has been signed.

void Countersign(X509Certificate2 certificate)

Parameters

certificate X509Certificate2

The certificate that will be used to countersign this signature.

Exceptions

InvalidOperationException

The signature was not signed.

Delete()

Deletes the signature.

void Delete()

Sign(X509Certificate2, SignatureDetails)

Creates a signature packet for non-visible signature line.

void Sign(X509Certificate2 certificate, SignatureDetails details)

Parameters

certificate X509Certificate2

The certificate that will be used to sign the workbook.

details SignatureDetails

The signature detail of the signature.

Exceptions

InvalidOperationException

Attempted to sign a visible signature line.

Sign(X509Certificate2, Stream, SignatureDetails)

Creates a signature packet for visible signature line.

void Sign(X509Certificate2 certificate, Stream signatureImage, SignatureDetails details)

Parameters

certificate X509Certificate2

The certificate that will be used to sign the workbook.

signatureImage Stream

The signature image of the signature line.

details SignatureDetails

The signature detail of the signature.

Exceptions

InvalidOperationException

Attempted to sign a non-visible signature line.

Sign(X509Certificate2, string, SignatureDetails)

Creates a signature packet for visible signature line.

void Sign(X509Certificate2 certificate, string signatureText, SignatureDetails details)

Parameters

certificate X509Certificate2

The certificate that will be used to sign the workbook.

signatureText string

The signature text of the signature line.

details SignatureDetails

The signature detail of the signature.

Exceptions

InvalidOperationException

Attempted to sign a non-visible signature line.