PdfEncryptionOptions.Algorithm Property

Specifies an algorithm to encrypt a PDF document.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v23.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public PdfEncryptionAlgorithm Algorithm { get; set; }

VB.NET

Public Property Algorithm As PdfEncryptionAlgorithm

Property Value

Type	Description
PdfEncryptionAlgorithm	A PdfEncryptionAlgorithm enumeration value that specifies an encryption algorithm.

Available values:

Name	Description
ARC4	Use the 128-bit ARC4 algorithm.
AES128	Use the 128-bit AES (Advanced Encryption Standard) algorithm.
AES256	Use the 256-bit AES (Advanced Encryption Standard) algorithm.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Algorithm
PdfSaveOptions	.EncryptionOptions .Algorithm

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Algorithm 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#

pdf-document-api-protect-document-with-password/CS/PDFPasswordProtection/Program.cs#L24

// Specify the 256-bit AES encryption algorithm.
encryptionOptions.Algorithm = PdfEncryptionAlgorithm.AES256;

VB.NET

pdf-document-api-protect-document-with-password/VB/PDFPasswordProtection/Program.vb#L21

' Specify the 256-bit AES encryption algorithm.
encryptionOptions.Algorithm = DevExpress.Pdf.PdfEncryptionAlgorithm.AES256
' Save the protected document with encryption settings.