PdfEncryptedPayload Class

Namespace:
GemBox.Pdf.Security
Assembly:
GemBox.Pdf.dll

Identifies that the file specified in the EmbeddedFile of a PdfFileSpecification is an encrypted payload.

public sealed class PdfEncryptedPayload : PdfObject
Public NotInheritable Class PdfEncryptedPayload
    Inherits PdfObject
Inheritance:
System.Object
PdfEncryptedPayload

Properties

CryptographicFilterName

(Required) The name of the cryptographic filter used to encrypt the encrypted payload document. This allows a PDF processor to easily determine whether it has the appropriate cryptographic filter.

public string CryptographicFilterName { get; set; }
Public Property CryptographicFilterName As String
Property Value
System.String

The name of the cryptographic filter used to encrypt the encrypted payload document.

Exceptions
System.ArgumentNullException

Value is null or System.String.Empty.

CryptographicFilterVersion

(Optional) The version number of the cryptographic filter used to encrypt the encrypted payload.

public string CryptographicFilterVersion { get; set; }
Public Property CryptographicFilterVersion As String
Property Value
System.String

The version number of the cryptographic filter used to encrypt the encrypted payload.

Methods

ToString()

Returns a System.String that represents this PdfEncryptedPayload instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this PdfEncryptedPayload instance.

Overrides
System.Object.ToString()
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Inherited Properties

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Extension Methods