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.

DocumentInfoEncryptionAlgorithm Property (PDFEncryptor Component)

The symmetric algorithm used to encrypt the document.

Syntax

__property String DocumentInfoEncryptionAlgorithm = { read=FDocumentInfoEncryptionAlgorithm };

Default Value

""

Remarks

The symmetric algorithm used to encrypt the document.

This property contains the encryption algorithm that was used to encrypt the PDF document.

Supported values:

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

Data Type

String

DocumentInfoEncryptionType Property (PDFEncryptor Component)

The document encryption type.

Syntax

__property TsbxPDFEncryptorDocumentInfoEncryptionTypes DocumentInfoEncryptionType = { read=FDocumentInfoEncryptionType };

enum TsbxPDFEncryptorDocumentInfoEncryptionTypes {
  petNone=0,
  petPassword=1,
  petCertificate=2
};

Default Value

petPassword

Remarks

The document encryption type.

This property indicates the kind of encryption that was used to encrypt the PDF document.

Supported values:

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

Data Type

Integer

DocumentInfoMetadataEncrypted Property (PDFEncryptor Component)

Indicates if the document metadata is encrypted.

Syntax

__property bool DocumentInfoMetadataEncrypted = { read=FDocumentInfoMetadataEncrypted };

Default Value

true

Remarks

Indicates if the document metadata is encrypted.

Use this property to check if the document metadata is encrypted.

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

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

Data Type

Boolean

DocumentInfoPermissions Property (PDFEncryptor Component)

Contains the document permissions associated with the encryption.

Syntax

__property int DocumentInfoPermissions = { read=FDocumentInfoPermissions };

Default Value

0

Remarks

Contains the document permissions associated with the encryption.

Use this property to check the permissions protected by this encryption. The PDF specification expects applications to comply with these permissions when handling encrypted documents. Contains a bit mask of the following flags:

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

Data Type

Integer

EncryptionAlgorithm Property (PDFEncryptor Component)

The encryption algorithm to encrypt the document with.

Syntax

__property String EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };

Default Value

"AES256"

Remarks

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

Supported values:

Data Type

String

EncryptionCertificateBytes Property (PDFEncryptor Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray EncryptionCertificateBytes = { read=FEncryptionCertificateBytes };

Remarks

Returns the raw certificate data in DER format.

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

Data Type

Byte Array

EncryptionCertificateCA Property (PDFEncryptor Component)

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

Syntax

__property bool EncryptionCertificateCA = { read=FEncryptionCertificateCA, write=FSetEncryptionCertificateCA };

Default Value

false

Remarks

Indicates whether the certificate has a CA capability (a setting in the BasicConstraints extension).

This property is not available at design time.

Data Type

Boolean

EncryptionCertificateCAKeyID Property (PDFEncryptor Component)

A unique identifier (fingerprint) of the CA certificate's private key.

Syntax

__property DynamicArray EncryptionCertificateCAKeyID = { read=FEncryptionCertificateCAKeyID };

Remarks

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

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

Data Type

Byte Array

EncryptionCertificateCRLDistributionPoints Property (PDFEncryptor Component)

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

Syntax

__property String EncryptionCertificateCRLDistributionPoints = { read=FEncryptionCertificateCRLDistributionPoints, write=FSetEncryptionCertificateCRLDistributionPoints };

Default Value

""

Remarks

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

This property is not available at design time.

Data Type

String

EncryptionCertificateCurve Property (PDFEncryptor Component)

Specifies the elliptic curve of the EC public key.

Syntax

__property String EncryptionCertificateCurve = { read=FEncryptionCertificateCurve, write=FSetEncryptionCertificateCurve };

Default Value

""

Remarks

Specifies the elliptic curve of the EC public key.

This property is not available at design time.

Data Type

String

EncryptionCertificateFingerprint Property (PDFEncryptor Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

__property DynamicArray EncryptionCertificateFingerprint = { read=FEncryptionCertificateFingerprint };

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

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

Data Type

Byte Array

EncryptionCertificateFriendlyName Property (PDFEncryptor Component)

Contains an associated alias (friendly name) of the certificate.

Syntax

__property String EncryptionCertificateFriendlyName = { read=FEncryptionCertificateFriendlyName };

Default Value

""

Remarks

Contains an associated alias (friendly name) of the certificate.

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

Data Type

String

EncryptionCertificateHandle Property (PDFEncryptor Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 EncryptionCertificateHandle = { read=FEncryptionCertificateHandle, write=FSetEncryptionCertificateHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

This property is not available at design time.

Data Type

Long64

EncryptionCertificateHashAlgorithm Property (PDFEncryptor Component)

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing) SB_HASH_ALGORITHM_SHA1 SHA1 SB_HASH_ALGORITHM_SHA224 SHA224 SB_HASH_ALGORITHM_SHA256 SHA256 SB_HASH_ALGORITHM_SHA384 SHA384 SB_HASH_ALGORITHM_SHA512 SHA512 SB_HASH_ALGORITHM_MD2 MD2 SB_HASH_ALGORITHM_MD4 MD4 SB_HASH_ALGORITHM_MD5 MD5 SB_HASH_ALGORITHM_RIPEMD160 RIPEMD160 SB_HASH_ALGORITHM_CRC32 CRC32 SB_HASH_ALGORITHM_SSL3 SSL3 SB_HASH_ALGORITHM_GOST_R3411_1994 GOST1994 SB_HASH_ALGORITHM_WHIRLPOOL WHIRLPOOL SB_HASH_ALGORITHM_POLY1305 POLY1305 SB_HASH_ALGORITHM_SHA3_224 SHA3_224 SB_HASH_ALGORITHM_SHA3_256 SHA3_256 SB_HASH_ALGORITHM_SHA3_384 SHA3_384 SB_HASH_ALGORITHM_SHA3_512 SHA3_512 SB_HASH_ALGORITHM_BLAKE2S_128 BLAKE2S_128 SB_HASH_ALGORITHM_BLAKE2S_160 BLAKE2S_160 SB_HASH_ALGORITHM_BLAKE2S_224 BLAKE2S_224 SB_HASH_ALGORITHM_BLAKE2S_256 BLAKE2S_256 SB_HASH_ALGORITHM_BLAKE2B_160 BLAKE2B_160 SB_HASH_ALGORITHM_BLAKE2B_256 BLAKE2B_256 SB_HASH_ALGORITHM_BLAKE2B_384 BLAKE2B_384 SB_HASH_ALGORITHM_BLAKE2B_512 BLAKE2B_512 SB_HASH_ALGORITHM_SHAKE_128 SHAKE_128 SB_HASH_ALGORITHM_SHAKE_256 SHAKE_256 SB_HASH_ALGORITHM_SHAKE_128_LEN SHAKE_128_LEN SB_HASH_ALGORITHM_SHAKE_256_LEN SHAKE_256_LEN .

Syntax

__property String EncryptionCertificateHashAlgorithm = { read=FEncryptionCertificateHashAlgorithm, write=FSetEncryptionCertificateHashAlgorithm };

Default Value

""

Remarks

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

This property is not available at design time.

Data Type

String

EncryptionCertificateIssuer Property (PDFEncryptor Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String EncryptionCertificateIssuer = { read=FEncryptionCertificateIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name.

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

Data Type

String

EncryptionCertificateIssuerRDN Property (PDFEncryptor Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

Syntax

__property String EncryptionCertificateIssuerRDN = { read=FEncryptionCertificateIssuerRDN, write=FSetEncryptionCertificateIssuerRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyAlgorithm Property (PDFEncryptor Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String EncryptionCertificateKeyAlgorithm = { read=FEncryptionCertificateKeyAlgorithm, write=FSetEncryptionCertificateKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyBits Property (PDFEncryptor Component)

Returns the length of the public key.

Syntax

__property int EncryptionCertificateKeyBits = { read=FEncryptionCertificateKeyBits };

Default Value

0

Remarks

Returns the length of the public key.

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

Data Type

Integer

EncryptionCertificateKeyFingerprint Property (PDFEncryptor Component)

Returns a fingerprint of the public key contained in the certificate.

Syntax

__property DynamicArray EncryptionCertificateKeyFingerprint = { read=FEncryptionCertificateKeyFingerprint };

Remarks

Returns a fingerprint of the public key contained in the certificate.

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

Data Type

Byte Array

EncryptionCertificateKeyUsage Property (PDFEncryptor Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int EncryptionCertificateKeyUsage = { read=FEncryptionCertificateKeyUsage, write=FSetEncryptionCertificateKeyUsage };

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

This property is not available at design time.

Data Type

Integer

EncryptionCertificateKeyValid Property (PDFEncryptor Component)

Returns True if the certificate's key is cryptographically valid, and False otherwise.

Syntax

__property bool EncryptionCertificateKeyValid = { read=FEncryptionCertificateKeyValid };

Default Value

false

Remarks

Returns True if the certificate's key is cryptographically valid, and False otherwise.

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

Data Type

Boolean

EncryptionCertificateOCSPLocations Property (PDFEncryptor Component)

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

Syntax

__property String EncryptionCertificateOCSPLocations = { read=FEncryptionCertificateOCSPLocations, write=FSetEncryptionCertificateOCSPLocations };

Default Value

""

Remarks

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

This property is not available at design time.

Data Type

String

EncryptionCertificateOCSPNoCheck Property (PDFEncryptor Component)

Accessor to the value of the certificate's ocsp-no-check extension.

Syntax

__property bool EncryptionCertificateOCSPNoCheck = { read=FEncryptionCertificateOCSPNoCheck, write=FSetEncryptionCertificateOCSPNoCheck };

Default Value

false

Remarks

Accessor to the value of the certificate's ocsp-no-check extension.

This property is not available at design time.

Data Type

Boolean

EncryptionCertificateOrigin Property (PDFEncryptor Component)

Returns the origin of this certificate.

Syntax

__property int EncryptionCertificateOrigin = { read=FEncryptionCertificateOrigin };

Default Value

0

Remarks

Returns the origin of this certificate.

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

Data Type

Integer

EncryptionCertificatePolicyIDs Property (PDFEncryptor Component)

Contains identifiers (OIDs) of the applicable certificate policies.

Syntax

__property String EncryptionCertificatePolicyIDs = { read=FEncryptionCertificatePolicyIDs, write=FSetEncryptionCertificatePolicyIDs };

Default Value

""

Remarks

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

This property is not available at design time.

Data Type

String

EncryptionCertificatePrivateKeyBytes Property (PDFEncryptor Component)

Contains the certificate's private key.

Syntax

__property DynamicArray EncryptionCertificatePrivateKeyBytes = { read=FEncryptionCertificatePrivateKeyBytes };

Remarks

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

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

Data Type

Byte Array

EncryptionCertificatePrivateKeyExists Property (PDFEncryptor Component)

Indicates whether the certificate has an associated private key.

Syntax

__property bool EncryptionCertificatePrivateKeyExists = { read=FEncryptionCertificatePrivateKeyExists };

Default Value

false

Remarks

Indicates whether the certificate has an associated private key.

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

Data Type

Boolean

EncryptionCertificatePrivateKeyExtractable Property (PDFEncryptor Component)

Indicates whether the private key is extractable.

Syntax

__property bool EncryptionCertificatePrivateKeyExtractable = { read=FEncryptionCertificatePrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable.

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

Data Type

Boolean

EncryptionCertificatePublicKeyBytes Property (PDFEncryptor Component)

Contains the certificate's public key in DER format.

Syntax

__property DynamicArray EncryptionCertificatePublicKeyBytes = { read=FEncryptionCertificatePublicKeyBytes };

Remarks

Contains the certificate's public key in DER format.

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

Data Type

Byte Array

EncryptionCertificateQualifiedStatements Property (PDFEncryptor Component)

Returns the qualified status of the certificate.

Syntax

__property TsbxPDFEncryptorEncryptionCertificateQualifiedStatements EncryptionCertificateQualifiedStatements = { read=FEncryptionCertificateQualifiedStatements, write=FSetEncryptionCertificateQualifiedStatements };

enum TsbxPDFEncryptorEncryptionCertificateQualifiedStatements {
  qstNonQualified=0,
  qstQualifiedHardware=1,
  qstQualifiedSoftware=2
};

Default Value

qstNonQualified

Remarks

Returns the qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

EncryptionCertificateSelfSigned Property (PDFEncryptor Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool EncryptionCertificateSelfSigned = { read=FEncryptionCertificateSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

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

Data Type

Boolean

EncryptionCertificateSerialNumber Property (PDFEncryptor Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray EncryptionCertificateSerialNumber = { read=FEncryptionCertificateSerialNumber, write=FSetEncryptionCertificateSerialNumber };

Remarks

Returns the certificate's serial number.

This property is not available at design time.

Data Type

Byte Array

EncryptionCertificateSigAlgorithm Property (PDFEncryptor Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String EncryptionCertificateSigAlgorithm = { read=FEncryptionCertificateSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

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

Data Type

String

EncryptionCertificateSubject Property (PDFEncryptor Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String EncryptionCertificateSubject = { read=FEncryptionCertificateSubject };

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

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

Data Type

String

EncryptionCertificateSubjectAlternativeName Property (PDFEncryptor Component)

Returns or sets the value of the Subject Alternative Name extension of the certificate.

Syntax

__property String EncryptionCertificateSubjectAlternativeName = { read=FEncryptionCertificateSubjectAlternativeName, write=FSetEncryptionCertificateSubjectAlternativeName };

Default Value

""

Remarks

Returns or sets the value of the Subject Alternative Name extension of the certificate.

This property is not available at design time.

Data Type

String

EncryptionCertificateSubjectKeyID Property (PDFEncryptor Component)

Contains a unique identifier (fingerprint) of the certificate's private key.

Syntax

__property DynamicArray EncryptionCertificateSubjectKeyID = { read=FEncryptionCertificateSubjectKeyID, write=FSetEncryptionCertificateSubjectKeyID };

Remarks

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

This property is not available at design time.

Data Type

Byte Array

EncryptionCertificateSubjectRDN Property (PDFEncryptor Component)

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

Syntax

__property String EncryptionCertificateSubjectRDN = { read=FEncryptionCertificateSubjectRDN, write=FSetEncryptionCertificateSubjectRDN };

Default Value

""

Remarks

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

This property is not available at design time.

Data Type

String

EncryptionCertificateValidFrom Property (PDFEncryptor Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String EncryptionCertificateValidFrom = { read=FEncryptionCertificateValidFrom, write=FSetEncryptionCertificateValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

This property is not available at design time.

Data Type

String

EncryptionCertificateValidTo Property (PDFEncryptor Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String EncryptionCertificateValidTo = { read=FEncryptionCertificateValidTo, write=FSetEncryptionCertificateValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

This property is not available at design time.

Data Type

String

EncryptMetadata Property (PDFEncryptor Component)

Specifies whether to encrypt the document metadata.

Syntax

__property bool EncryptMetadata = { read=FEncryptMetadata, write=FSetEncryptMetadata };

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.

Data Type

Boolean

FIPSMode Property (PDFEncryptor Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

InputBytes Property (PDFEncryptor Component)

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

Syntax

__property DynamicArray InputBytes = { read=FInputBytes, write=FSetInputBytes };

Remarks

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

This property is not available at design time.

Data Type

Byte Array

InputFile Property (PDFEncryptor Component)

The PDF file to be encrypted.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

Default Value

""

Remarks

Provide the path to the PDF document to be encrypted.

Data Type

String

OutputBytes Property (PDFEncryptor Component)

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

Syntax

__property DynamicArray OutputBytes = { read=FOutputBytes };

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.

Data Type

Byte Array

OutputFile Property (PDFEncryptor Component)

The file to save the encrypted document to.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

Default Value

""

Remarks

Specifies the path where the encrypted PDF should be saved.

Data Type

String

OwnerPassword Property (PDFEncryptor Component)

The owner password.

Syntax

__property String OwnerPassword = { read=FOwnerPassword, write=FSetOwnerPassword };

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.

Data Type

String

Permissions Property (PDFEncryptor Component)

Specifies the document permissions associated with the encryption.

Syntax

__property int Permissions = { read=FPermissions, write=FSetPermissions };

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.

Data Type

Integer

UserPassword Property (PDFEncryptor Component)

The user password.

Syntax

__property String UserPassword = { read=FUserPassword, write=FSetUserPassword };

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.

Data Type

String

Config Method (PDFEncryptor Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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

String __fastcall DoAction(String ActionID, String ActionParams);

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

void __fastcall 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

typedef struct {
  bool Cancel;
} TsbxPDFEncryptorDocumentLoadedEventParams;
typedef void __fastcall (__closure *TsbxPDFEncryptorDocumentLoadedEvent)(System::TObject* Sender, TsbxPDFEncryptorDocumentLoadedEventParams *e);
__property TsbxPDFEncryptorDocumentLoadedEvent OnDocumentLoaded = { 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

typedef struct {
  int ErrorCode;
  String Description;
} TsbxPDFEncryptorErrorEventParams;
typedef void __fastcall (__closure *TsbxPDFEncryptorErrorEvent)(System::TObject* Sender, TsbxPDFEncryptorErrorEventParams *e);
__property TsbxPDFEncryptorErrorEvent OnError = { 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

typedef struct {
  String EventID;
  String EventParam;
} TsbxPDFEncryptorNotificationEventParams;
typedef void __fastcall (__closure *TsbxPDFEncryptorNotificationEvent)(System::TObject* Sender, TsbxPDFEncryptorNotificationEventParams *e);
__property TsbxPDFEncryptorNotificationEvent OnNotification = { 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.

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)