Back to Devexpress

PackageSignatureValidation.Result Property

officefileapi-devexpress-dot-office-dot-digitalsignatures-dot-packagesignaturevalidation.md

latest5.1 KB
Original Source

PackageSignatureValidation.Result Property

Retrieves the signature validation result.

Namespace : DevExpress.Office.DigitalSignatures

Assembly : DevExpress.Docs.v25.2.dll

NuGet Package : DevExpress.Document.Processor

Declaration

csharp
public PackageSignatureValidationResult Result { get; }
vb
Public ReadOnly Property Result As PackageSignatureValidationResult

Property Value

TypeDescription
PackageSignatureValidationResult

An enumeration value that indicates the validation result.

|

Available values:

NameDescription
None

No validation result.

| | Valid |

The package signature is valid.

| | Invalid |

The package signature is invalid.

| | PartiallyValid |

The package signature is partially valid.

| | PackageOpenFailed |

Failed to open the target package.

| | SignaturesNotFound |

The target package does not contain any signatures.

|

Remarks

If the document is not signed, the PackageSignatureValidation.Result property returns SignaturesNotFound.

If the document to be validated is encrypted, specify the SignatureValidationOptions.DecryptionPassword property to decrypt the document. Otherwise, the Result property returns PackageSignatureValidationResult.PackageOpenFailed.

If the PackageSignatureValidation.Result property returns Invalid or PartiallyValid, check the PackageSignatureValidation.Items property to obtain a list of items with detailed validation information. The number of SignatureValidationInfo objects in the list is equal to the number of signatures.

The following code snippets (auto-collected from DevExpress Examples) contain references to the Result 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.

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

csharp
//Check validation result and show information in the console:
switch (signatureValidation.Result)
{

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

csharp
//Check validation result and show information in the console:
switch (signatureValidation.Result)
{

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

vb
'Check validation result and show information in the console:
Select Case signatureValidation.Result
    Case PackageSignatureValidationResult.Valid

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

vb
'Check validation result and show information in the console:
Select Case signatureValidation.Result
    Case PackageSignatureValidationResult.Valid

See Also

PackageSignatureValidation Class

PackageSignatureValidation Members

DevExpress.Office.DigitalSignatures Namespace