PDFEncryptor Component
Properties Methods Events Configuration 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.
| EncryptionAlgorithm | The encryption algorithm to encrypt the document with. |
| EncryptionCertificate | The encryption certificate. |
| EncryptionCertificates | The encryption certificates. |
| EncryptionType | The encryption type. |
| EncryptMetadata | Specifies whether to encrypt the document metadata. |
| InputBytes | Use this property to pass the input to component in the byte array form. |
| InputFile | The PDF file to be encrypted. |
| OutputBytes | Use this property to read the output the component object has produced. |
| OutputFile | The file to save the encrypted document to. |
| OwnerPassword | The owner password. |
| Permissions | Specifies the document permissions associated with the encryption. |
| UserPassword | The user password. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting. |
| Encrypt | Encrypts the PDF document. |
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.
| Error | Information about errors during encryption. |
| Notification | This event notifies the application about an underlying control flow event. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| EncryptionHandlerName | Specifies the custom security handler PDF-name. |
| HardenedKeyGeneration | Specifies if hardened Key generation should be used. |
| RC4KeyBits | Specifies the number of key bits used for RC4 algorithm. |
| TempPath | Location where the temporary files are stored. |
| CheckKeyIntegrityBeforeUse | Enables or disable private key integrity check before use. |
| CookieCaching | Specifies whether a cookie cache should be used for HTTP(S) transports. |
| Cookies | Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only). |
| DefDeriveKeyIterations | Specifies the default key derivation algorithm iteration count. |
| EnableClientSideSSLFFDHE | Enables or disables finite field DHE key exchange support in TLS clients. |
| GlobalCookies | Gets or sets global cookies for all the HTTP transports. |
| HttpUserAgent | Specifies the user agent name to be used by all HTTP clients. |
| LogDestination | Specifies the debug log destination. |
| LogDetails | Specifies the debug log details to dump. |
| LogFile | Specifies the debug log filename. |
| LogFilters | Specifies the debug log filters. |
| LogFlushMode | Specifies the log flush mode. |
| LogLevel | Specifies the debug log level. |
| LogMaxEventCount | Specifies the maximum number of events to cache before further action is taken. |
| LogRotationMode | Specifies the log rotation mode. |
| MaxASN1BufferLength | Specifies the maximal allowed length for ASN.1 primitive tag data. |
| MaxASN1TreeDepth | Specifies the maximal depth for processed ASN.1 trees. |
| OCSPHashAlgorithm | Specifies the hash algorithm to be used to identify certificates in OCSP requests. |
| UseOwnDNSResolver | Specifies whether the client components should use own DNS resolver. |
| UseSharedSystemStorages | Specifies whether the validation engine should use a global per-process copy of the system certificate stores. |
| UseSystemOAEPAndPSS | Enforces or disables the use of system-driven RSA OAEP and PSS computations. |
| UseSystemRandom | Enables or disables the use of the OS PRNG. |