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.

Syntax

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

Default Value

false

Remarks

Indicates whether the certificate has a CA capability. For the certificate to be considered a CA, it must have its Basic Constraints extension set with the CA indicator enabled.

Set this property when generating a new certificate to have its Basic Constraints extension generated automatically.

This property is not available at design time.

Data Type

Boolean

EncryptionCertificateCAKeyID Property (PDFEncryptor Component)

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

Syntax

__property DynamicArray EncryptionCertificateCAKeyID = { read=FEncryptionCertificateCAKeyID };

Remarks

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

Authority Key Identifier is a certificate extension which allows identification of certificates belonging to the same issuer, but with different public keys. It is a de-facto standard to include this extension in all certificates to facilitate chain building.

This setting cannot be set when generating a certificate as it always derives from another certificate property. CertificateManager generates this setting automatically if enough information is available to it: for self-signed certificates, this value is copied from the EncryptionCertificateSubjectKeyID setting, and for lower-level certificates, from the parent certificate's subject key ID extension.

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

Data Type

Byte Array

EncryptionCertificateCertType Property (PDFEncryptor Component)

Returns the type of the entity contained in the Certificate object.

Syntax

__property TsbxPDFEncryptorEncryptionCertificateCertTypes EncryptionCertificateCertType = { read=FEncryptionCertificateCertType };

enum TsbxPDFEncryptorEncryptionCertificateCertTypes {
  ctUnknown=0,
  ctX509Certificate=1,
  ctX509CertificateRequest=2
};

Default Value

ctUnknown

Remarks

Returns the type of the entity contained in the Certificate object.

A Certificate object can contain two types of cryptographic objects: a ready-to-use X.509 certificate, or a certificate request ("an unsigned certificate"). Certificate requests can be upgraded to full certificates by signing them with a CA certificate.

Use the CertificateManager component to load or create new certificate and certificate requests objects.

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

Data Type

Integer

EncryptionCertificateCRLDistributionPoints Property (PDFEncryptor Component)

Contains a list of locations of CRL distribution points used to check this certificate's validity.

Syntax

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

Default Value

""

Remarks

Contains a list of locations of CRL distribution points used to check this certificate's validity. The list is taken from the respective certificate extension.

Use this property when generating a certificate to provide a list of CRL endpoints that should be made part of the new certificate.

The endpoints are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

This property is not available at design time.

Data Type

String

EncryptionCertificateCurve Property (PDFEncryptor Component)

Specifies the elliptic curve associated with the certificate's public key.

Syntax

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

Default Value

""

Remarks

Specifies the elliptic curve associated with the certificate's public key. This setting only applies to certificates containing EC keys.

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 String EncryptionCertificateFingerprint = { read=FEncryptionCertificateFingerprint };

Default Value

""

Remarks

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

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

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

Data Type

String

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. The friendly name is not a property of a certificate: it is maintained by the certificate media rather than being included in its DER representation. Windows certificate stores are one example of media that does support friendly names.

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)

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing).

Syntax

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

Default Value

""

Remarks

Provides means to set the hash algorithm to be used in the subsequent operation on the certificate (such as generation or key signing). It is not a property of a certificate; use EncryptionCertificateSigAlgorithm to find out the hash algorithm that is part of the certificate signature.

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 is part of a larger set of credentials available via EncryptionCertificateIssuerRDN.

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

Data Type

String

EncryptionCertificateIssuerRDN Property (PDFEncryptor Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

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

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

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.

Use the EncryptionCertificateKeyBits, EncryptionCertificateCurve, and EncryptionCertificatePublicKeyBytes properties to get more details about the key the certificate contains.

This property is not available at design time.

Data Type

String

EncryptionCertificateKeyBits Property (PDFEncryptor Component)

Returns the length of the public key in bits.

Syntax

__property int EncryptionCertificateKeyBits = { read=FEncryptionCertificateKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the EncryptionCertificatePublicKeyBytes or EncryptionCertificatePrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

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

Data Type

Integer

EncryptionCertificateKeyFingerprint Property (PDFEncryptor Component)

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

Syntax

__property String EncryptionCertificateKeyFingerprint = { read=FEncryptionCertificateKeyFingerprint };

Default Value

""

Remarks

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

Note that the key fingerprint is different from the certificate fingerprint accessible via the EncryptionCertificateFingerprint property. The key fingeprint uniquely identifies the public key, and so can be the same for multiple certificates containing the same key.

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

Data Type

String

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:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

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 services that can be used to check this certificate's validity in real time, as recorded by the CA.

Syntax

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

Default Value

""

Remarks

Locations of OCSP services that can be used to check this certificate's validity in real time, as recorded by the CA.

Set this property before calling the certificate manager's Generate method to propagate it to the new certificate.

The OCSP locations are provided as a list of CRLF-separated URLs. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the location separator.

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 location that the certificate was taken or loaded from.

Syntax

__property int EncryptionCertificateOrigin = { read=FEncryptionCertificateOrigin };

Default Value

0

Remarks

Returns the location that the certificate was taken or loaded from.

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.

Set this property when generating a certificate to propagate the policies information to the new certificate.

The policies are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the policy element separator.

This property is not available at design time.

Data Type

String

EncryptionCertificatePrivateKeyBytes Property (PDFEncryptor Component)

Returns the certificate's private key in DER-encoded format.

Syntax

__property DynamicArray EncryptionCertificatePrivateKeyBytes = { read=FEncryptionCertificatePrivateKeyBytes };

Remarks

Returns the certificate's private key in DER-encoded format. It is normal for this property to be empty if the private key is non-exportable, which, for example, is typical for certificates originating from hardware security devices.

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

Data Type

Byte Array

EncryptionCertificatePrivateKeyExists Property (PDFEncryptor Component)

Indicates whether the certificate has a usable private key associated with it.

Syntax

__property bool EncryptionCertificatePrivateKeyExists = { read=FEncryptionCertificatePrivateKeyExists };

Default Value

false

Remarks

Indicates whether the certificate has a usable private key associated with it. If it is set to True, the certificate can be used for private key operations, such as signing or decryption.

This property is independent from EncryptionCertificatePrivateKeyBytes, and can be set to True even if the former is empty. This would imply that the private key is non-exportable, but still can be used for cryptographic operations.

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 (exportable).

Syntax

__property bool EncryptionCertificatePrivateKeyExtractable = { read=FEncryptionCertificatePrivateKeyExtractable };

Default Value

false

Remarks

Indicates whether the private key is extractable (exportable).

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 typically would contain an ASN.1-encoded public key value. The exact format depends on the type of the public key contained in the certificate.

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

Data Type

Byte Array

EncryptionCertificateQualified Property (PDFEncryptor Component)

Indicates whether the certificate is qualified.

Syntax

__property bool EncryptionCertificateQualified = { read=FEncryptionCertificateQualified };

Default Value

false

Remarks

Indicates whether the certificate is qualified.

This property is set to True if the certificate is confirmed by a Trusted List to be qualified.

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

Data Type

Boolean

EncryptionCertificateQualifiedStatements Property (PDFEncryptor Component)

Returns a simplified 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 a simplified qualified status of the certificate.

This property is not available at design time.

Data Type

Integer

EncryptionCertificateQualifiers Property (PDFEncryptor Component)

A list of qualifiers.

Syntax

__property String EncryptionCertificateQualifiers = { read=FEncryptionCertificateQualifiers };

Default Value

""

Remarks

A list of qualifiers.

Contains a comma-separated list of qualifier aliases for the certificate, for example QCP-n-qscd,QCWithSSCD.

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

Data Type

String

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.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

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.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

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

Data Type

String

EncryptionCertificateSource Property (PDFEncryptor Component)

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

Syntax

__property TsbxPDFEncryptorEncryptionCertificateSources EncryptionCertificateSource = { read=FEncryptionCertificateSource };

enum TsbxPDFEncryptorEncryptionCertificateSources {
  pksUnknown=0,
  pksSignature=1,
  pksDocument=2,
  pksUser=3,
  pksLocal=4,
  pksOnline=5
};

Default Value

pksUnknown

Remarks

Returns the source (location or disposition) of a cryptographic primitive entity, such as a certificate, CRL, or OCSP response.

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

Data Type

Integer

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 is part of a larger set of credentials available via EncryptionCertificateSubjectRDN.

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.

Subject alternative names are used to provide additional names that are impractical to store in the main EncryptionCertificateSubjectRDN field. For example, it is often used to store all the domain names that a TLS certificate is authorized to protect.

The alternative names are provided as a list of CRLF-separated entries. Note that this differs from the behaviour used in earlier product versions, where the "|" character was used as the element separator.

This property is not available at design time.

Data Type

String

EncryptionCertificateSubjectKeyID Property (PDFEncryptor Component)

Contains a unique identifier of the certificate's cryptographic key.

Syntax

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

Remarks

Contains a unique identifier of the certificate's cryptographic key.

Subject Key Identifier is a certificate extension which allows a specific public key to be associated with a certificate holder. Typically, subject key identifiers of CA certificates are recorded as respective CA key identifiers in the subordinate certificates that they issue, which facilitates chain building.

The EncryptionCertificateSubjectKeyID and EncryptionCertificateCAKeyID properties of self-signed certificates typically contain identical values, as in that specific case, the issuer and the subject are the same entity.

This property is not available at design time.

Data Type

Byte Array

EncryptionCertificateSubjectRDN Property (PDFEncryptor Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

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

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

This property is not available at design time.

Data Type

String

EncryptionCertificateValid Property (PDFEncryptor Component)

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

Syntax

__property bool EncryptionCertificateValid = { read=FEncryptionCertificateValid };

Default Value

false

Remarks

Indicates whether or not the signature over the certificate or the request is valid and matches the public key contained in the CA certificate/request.

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

Data Type

Boolean

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.

Reset Method (PDFEncryptor Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

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.

This component can fire this event with the following EventID values:

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