PDFEncryptor Component

Properties   Methods   Events   Config Settings   Errors  

The PDFEncryptor component encrypts PDF documents.

Syntax

TsbxPDFEncryptor

Remarks

PDFEncryptor encrypts PDF documents with passwords or certificates.

Property List

---

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

DocumentInfo Property (PDFEncryptor Component)

Contains information about the document properties.

Syntax

property DocumentInfo: TsbxPDFDocumentInfo read get_DocumentInfo;

Remarks

Use this property to access general parameters of the document being processed. A good place to check this property is in the handler of the DocumentLoaded event.

This property is read-only and not available at design time.

Please refer to the PDFDocumentInfo type for a complete list of fields.

EncryptionAlgorithm Property (PDFEncryptor Component)

The encryption algorithm to encrypt the document with.

Syntax

property EncryptionAlgorithm: String read get_EncryptionAlgorithm write set_EncryptionAlgorithm;

Default Value

'AES256'

Remarks

Use this property to specify the encryption algorithm to encrypt the PDF document with.

Supported values:

EncryptionCertificate Property (PDFEncryptor Component)

The encryption certificate.

Syntax

property EncryptionCertificate: TsbxCertificate read get_EncryptionCertificate write set_EncryptionCertificate;

Remarks

Use this property to provide the encryption certificate. It does not need to have a private key, but the intended recipient of this PDF document does.

This property is not available at design time.

Please refer to the Certificate type for a complete list of fields.

EncryptMetadata Property (PDFEncryptor Component)

Specifies whether to encrypt the document metadata.

Syntax

property EncryptMetadata: Boolean read get_EncryptMetadata write set_EncryptMetadata;

Default Value

true

Remarks

Use this property to enable or disable metadata encryption.

Metadata contains additional information about the document, such as its name and author.

FIPSMode Property (PDFEncryptor Component)

Reserved.

Syntax

property FIPSMode: Boolean read get_FIPSMode write set_FIPSMode;

Default Value

false

Remarks

This property is reserved for future use.

InputBytes Property (PDFEncryptor Component)

Use this property to pass the input to component in byte array form.

Syntax

property InputBytes: TBytes read get_InputBytes write set_InputBytes;

Remarks

Assign a byte array containing the data to be processed to this property.

This property is not available at design time.

InputFile Property (PDFEncryptor Component)

The PDF file to be encrypted.

Syntax

property InputFile: String read get_InputFile write set_InputFile;

Default Value

''

Remarks

Provide the path to the PDF document to be encrypted.

OutputBytes Property (PDFEncryptor Component)

Use this property to read the output the component object has produced.

Syntax

property OutputBytes: TBytes read get_OutputBytes;

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

This property is read-only and not available at design time.

OutputFile Property (PDFEncryptor Component)

The file to save the encrypted document to.

Syntax

property OutputFile: String read get_OutputFile write set_OutputFile;

Default Value

''

Remarks

Specifies the path where the encrypted PDF should be saved.

OwnerPassword Property (PDFEncryptor Component)

The owner password.

Syntax

property OwnerPassword: String read get_OwnerPassword write set_OwnerPassword;

Default Value

''

Remarks

Use this property to provide the document owner password. Though it may be different from UserPassword, most implementations use the same value for both.

Permissions Property (PDFEncryptor Component)

Specifies the document permissions associated with the encryption.

Syntax

property Permissions: Integer read get_Permissions write set_Permissions;

Default Value

0

Remarks

Use this property to specify the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents, but keep in mind that it is a policy-like requirement rather than an enforcement. Provide the permissions as a bit mask of the following flags:

This property is not available at design time.

UserPassword Property (PDFEncryptor Component)

The user password.

Syntax

property UserPassword: String read get_UserPassword write set_UserPassword;

Default Value

''

Remarks

Use this property to provide the document user password. Though it may be different from OwnerPassword, most implementations use the same value for both.

Config Method (PDFEncryptor Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (PDFEncryptor Component)

Performs an additional action.

Syntax

function DoAction(ActionID: String; ActionParams: String): String;

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Encrypt Method (PDFEncryptor Component)

Encrypts the PDF document.

Syntax

procedure Encrypt();

Remarks

Use this method to encrypt the PDF document as configured in the object's properties.

DocumentLoaded Event (PDFEncryptor Component)

This event is fired when the document has been loaded into memory.

Syntax

type TDocumentLoadedEvent = procedure (
  Sender: TObject;
  var Cancel: Boolean
) of Object;

property OnDocumentLoaded: TDocumentLoadedEvent read FOnDocumentLoaded write FOnDocumentLoaded;

Remarks

The handler for this event is a good place to check the document structure, which may be useful when preparing the signature. For example, you can use the Pages information to find the optimal position for the signature widget.

Set Cancel to true to terminate document processing on this stage.

Error Event (PDFEncryptor Component)

Information about errors during encryption.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The event is fired in case of exceptional conditions during PDF processing.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (PDFEncryptor Component)

This event notifies the application about an underlying control flow event.

Syntax

type TNotificationEvent = procedure (
  Sender: TObject;
  const EventID: String;
  const EventParam: String
) of Object;

property OnNotification: TNotificationEvent read FOnNotification write FOnNotification;

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

>

constructor Create();

Creates a new object with default field values.

PDFDocumentInfo Type

Contains document security information.

Remarks

This type provides an overview of the document security parameters, including the encryption method (if used) and signature count. This information is available early into the signing/validation process and lets you prepare for the subsequent signature validation.

Fields

Constructors

>

constructor Create();

Initializes an instance of PDFDocumentInfo class.

Config Settings (PDFEncryptor Component)

The component accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

PDFEncryptor Config Settings

Base Config Settings

Trappable Errors (PDFEncryptor Component)

PDFEncryptor Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Component is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	26214401   Input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS)
	26214402   Document is encrypted (SB_ERROR_PDF_ENCRYPTED)
	26214403   Document not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED)
	26214404   Unknown certificate type (SB_ERROR_PDF_UNKNOWN_ENCRYPTION_TYPE)
	26214405   Invalid password (SB_ERROR_PDF_INVALID_PASSWORD)
	26214406   Decryption failed (SB_ERROR_PDF_DECRYPTION_FAILED)
	26214407   Document is signed (SB_ERROR_PDF_SIGNED)
	26214408   Document is not signed (SB_ERROR_PDF_NOT_SIGNED)
	26214409   Inappropriate signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE)
	26214410   Not supported (SB_ERROR_PDF_NOT_SUPPORTED)