SignatureOptions.SignatureFlags Property

Gets or sets the flags that specify additional signature creation actions.

Namespace: DevExpress.Office.DigitalSignatures

Assembly: DevExpress.Docs.v20.2.dll

NuGet Package: DevExpress.Document.Processor

NuGet Packages: DevExpress.Document.Processor, DevExpress.WindowsDesktop.Document.Processor

Declaration

C#

public SignatureFlags SignatureFlags { get; set; }

VB.NET

Public Property SignatureFlags As SignatureFlags

Property Value

Type	Description
SignatureFlags	An enumeration value that indicates additional signature creation actions.

Available values:

Name	Description
None	No action is required.
ValidateCertificate	Validate a certificate before adding it to the signature.
IncludeTimestamp	Include a timestamp in a signature.
EmbedCertificateChain	Embed the whole certificate chain, including the root certificate.
EmbedCertificateCRL	Embed the whole certificate revocation list (CRL) for a certificate.
EmbedCertificateOCSP	Embed the Online Certificate Status Protocol (OCSP) request for a certificate.
EmbedTimestampCertificateChain	Embed the whole timestamp certificate chain, including the root certificate.
EmbedTimestampCertificateCRL	Embed the whole certificate revocation list (CRL) for a timestamp certificate.
EmbedTimestampCertificateOCSP	Embed the Online Certificate Status Protocol (OCSP) request for a timestamp certificate.
All	Perform all actions in this list.

Remarks

Use the SignatureFlags to skip signature creation stages. The default property value is SignatureFlags.All.

The code sample below skips certificate validation before adding it to the signature:

C#

SignatureOptions options = new SignatureOptions();
options.SignatureFlags &= ~SignatureFlags.ValidateCertificate;

VB.NET

Dim options As New SignatureOptions()
options.SignatureFlags = options.SignatureFlags And Not SignatureFlags.ValidateCertificate

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SignatureFlags property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

word-document-api-sign-document-and-validate-signature/CS/WordDocumentDigitalSignatureSample/Program.cs#L40

//In this example, certificate validation is skipped
options.SignatureFlags &= ~SignatureFlags.ValidateCertificate;
options.CertificateKeyUsageFlags = X509KeyUsageFlags.None;

spreadsheet-document-api-sign-workbook-and-validate-signature/CS/WorkbookDigitalSignatureSample/Program.cs#L44

//In this example, certificate validation is skipped
options.SignatureFlags &= ~SignatureFlags.ValidateCertificate;
options.CertificateKeyUsageFlags = X509KeyUsageFlags.None;

VB.NET

word-document-api-sign-document-and-validate-signature/VB/WordDocumentDigitalSignatureSample/Program.vb#L37

'In this example, certificate validation is skipped
options.SignatureFlags = options.SignatureFlags And Not SignatureFlags.ValidateCertificate
options.CertificateKeyUsageFlags = X509KeyUsageFlags.None

spreadsheet-document-api-sign-workbook-and-validate-signature/VB/WorkbookDigitalSignatureSample/Program.vb#L40

'In this example, certificate validation is skipped
options.SignatureFlags = options.SignatureFlags And Not SignatureFlags.ValidateCertificate
options.CertificateKeyUsageFlags = X509KeyUsageFlags.None