Foxit PDF SDK
foxit.pdf.CertificateEncryptData Class Reference

Inherits SystemIDisposable.

Public Member Functions

 CertificateEncryptData (bool is_encrypt_metadata, SecurityHandler.CipherType cipher, StringArray envelopes)
 Constructor, with parameters.
More...
 
 CertificateEncryptData ()
 Constructor.

 
 CertificateEncryptData (CertificateEncryptData other)
 Constructor, with another certificate encrypt data object.
More...
 
void Set (bool is_encrypt_metadata, SecurityHandler.CipherType cipher, StringArray envelopes)
 Set value.
More...
 

Properties

SecurityHandler.CipherType cipher [get, set]
 Cipher type. Please refer to values starting from foxit.pdf.SecurityHandler.CipherType.e_CipherRC4 and this should be one of these values except foxit.pdf.SecurityHandler.CipherType.e_CipherNone .

 
StringArrayenvelopes [get, set]
 A string array which specifies an array of certificate envelopes. This array should contains one or more envelopes.

 
bool is_encrypt_metadata [get, set]
 A boolean value to decide whether to encrypt metadata or not. true means to encrypt metadata, and false means not to encrypt metadata.

 

Detailed Description

This class represents some data used for class CertificateSecurityHandler .

Constructor & Destructor Documentation

◆ CertificateEncryptData() [1/2]

foxit.pdf.CertificateEncryptData.CertificateEncryptData ( bool  is_encrypt_metadata,
SecurityHandler.CipherType  cipher,
StringArray  envelopes 
)
inline

Constructor, with parameters.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]cipherCipher type. Please refer to values starting from foxit.pdf.SecurityHandler.CipherType.e_CipherRC4 and this should be one of these values except foxit.pdf.SecurityHandler.CipherType.e_CipherNone .
[in]envelopesA string array which specifies an array of certificate envelopes. This array should contains one or more envelopes.

◆ CertificateEncryptData() [2/2]

foxit.pdf.CertificateEncryptData.CertificateEncryptData ( CertificateEncryptData  other)
inline

Constructor, with another certificate encrypt data object.

Parameters
[in]otherAnother certificate encrypt data object.

Member Function Documentation

◆ Set()

void foxit.pdf.CertificateEncryptData.Set ( bool  is_encrypt_metadata,
SecurityHandler.CipherType  cipher,
StringArray  envelopes 
)
inline

Set value.

Parameters
[in]is_encrypt_metadatatrue means to encrypt metadata, and false means not to encrypt metadata.
[in]cipherCipher type. Please refer to values starting from foxit.pdf.SecurityHandler.CipherType.e_CipherRC4 and this should be one of these values except foxit.pdf.SecurityHandler.CipherType.e_CipherNone .
[in]envelopesA string array which specifies an array of certificate envelopes. This array should contains one or more envelopes.
Returns
None.