Aspose::Pdf::Facades::PdfFileSecurity Class Referencefinal

Represents encrypting or decrypting a Pdf file with owner or user password, changing the security setting and password. More...

#include "PdfFileSecurity.h"

Inherits Aspose::Pdf::Facades::SaveableFacade.

Public Member Functions

ASPOSE_PDF_SHARED_API void set_InputFile (System::String value)
 Sets the input file. More...
 
ASPOSE_PDF_SHARED_API void set_InputStream (System::SharedPtr< System::IO::Stream > value)
 Sets the input stream. More...
 
ASPOSE_PDF_SHARED_API void set_OutputFile (System::String value)
 Sets the output file. More...
 
ASPOSE_PDF_SHARED_API void set_OutputStream (System::SharedPtr< System::IO::Stream > value)
 Sets the output stream. More...
 
ASPOSE_PDF_SHARED_API bool get_AllowExceptions ()
 If this value set to true, exception will be thrown on opearation failure. Else, method returns false on failure and last exception can be checked with LastException property. More...
 
ASPOSE_PDF_SHARED_API void set_AllowExceptions (bool value)
 If this value set to true, exception will be thrown on opearation failure. Else, method returns false on failure and last exception can be checked with LastException property. More...
 
ASPOSE_PDF_SHARED_API System::Exception get_LastException () const
 Returns exception which was thrown by last operation. More...
 
ASPOSE_PDF_SHARED_API PdfFileSecurity (System::SharedPtr< System::IO::Stream > inputStream, System::SharedPtr< System::IO::Stream > outputStream)
 Initialize the object of PdfFileSecurity with input and output stream. More...
 
ASPOSE_PDF_SHARED_API PdfFileSecurity (System::String inputFile, System::String outputFile)
 Initializes the object of PdfFileSecurity with input and output file. More...
 
ASPOSE_PDF_SHARED_API PdfFileSecurity ()
 Initialize the object of PdfFileSecurity. More...
 
ASPOSE_PDF_SHARED_API bool MfEncryptFile (System::String userPassword, System::String ownerPassword, System::SharedPtr< DocumentPrivilege > privilege, KeySize keySize)
 Encrypts Pdf file with userpassword and ownerpassword and sets the document's privileges to access. The user password and the owner password can be null or empty. The owner password will be replaced with a random string if the input owner password is null or empty. Throws exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool TryEncryptFile (System::String userPassword, System::String ownerPassword, System::SharedPtr< DocumentPrivilege > privilege, KeySize keySize)
 Encrypts Pdf file with userpassword and ownerpassword and sets the document's privileges to access. The user password and the owner password can be null or empty. The owner password will be replaced with a random string if the input owner password is null or empty. Does not throw an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool MfEncryptFile (System::String userPassword, System::String ownerPassword, System::SharedPtr< DocumentPrivilege > privilege, KeySize keySize, Algorithm cipher)
 Encrypts Pdf file with userpassword and ownerpassword and sets the document's privileges to access. The user password and the owner password can be null or empty. The owner password will be replaced with a random string if the input owner password is null or empty. There are 6 possible combinations of KeySize and Algorithm values. However (KeySize.x40, Algorithm.AES) and (KeySize.x256, Algorithm.RC4) are invalid and corresponding exception will be raised if kit encounters this combination. Throws an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool MfDecryptFile (System::String ownerPassword)
 Decrypts an encrypted Pdf document by owner password. If the document hasn't owner password, it is allow to use user password. Throws an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool TryDecryptFile (System::String ownerPassword)
 Decrypts an encrypted Pdf document by owner password. If the document hasn't owner password, it is allow to use user password. Does not throw an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool SetPrivilege (System::SharedPtr< DocumentPrivilege > privilege)
 Sets Pdf file security with empty user/owner passwords. The owner password will be added by a random string. Throws an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool SetPrivilege (System::String userPassword, System::String ownerPassword, System::SharedPtr< DocumentPrivilege > privilege)
 Sets Pdf file security with original password. Throws an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool TrySetPrivilege (System::String userPassword, System::String ownerPassword, System::SharedPtr< DocumentPrivilege > privilege)
 Sets Pdf file security with original password. Does not throw an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool ChangePassword (System::String ownerPassword, System::String newUserPassword, System::String newOwnerPassword)
 Changes the user password and owner password by owner password, keeps the original security settings. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. Throws an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool TryChangePassword (System::String ownerPassword, System::String newUserPassword, System::String newOwnerPassword)
 Changes the user password and owner password by owner password, keeps the original security settings. The new user password and the new owner password can be null or empty. The owner password will be replaced Does not throw an exception if process failed. with a random string if the new owner password is null or empty. More...
 
ASPOSE_PDF_SHARED_API bool ChangePassword (System::String ownerPassword, System::String newUserPassword, System::String newOwnerPassword, System::SharedPtr< DocumentPrivilege > privilege, KeySize keySize)
 Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. Throws an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool TryChangePassword (System::String ownerPassword, System::String newUserPassword, System::String newOwnerPassword, System::SharedPtr< DocumentPrivilege > privilege, KeySize keySize)
 Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. Does not throw an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool ChangePassword (System::String ownerPassword, System::String newUserPassword, System::String newOwnerPassword, System::SharedPtr< DocumentPrivilege > privilege, KeySize keySize, Algorithm cipher)
 Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. There are 6 possible combinations of KeySize and Algorithm values. However (KeySize.x40, Algorithm.AES) and (KeySize.x256, Algorithm.RC4) are invalid and corresponding exception will be raised if kit encounters this combination. Throws an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API bool TryChangePassword (System::String ownerPassword, System::String newUserPassword, System::String newOwnerPassword, System::SharedPtr< DocumentPrivilege > privilege, KeySize keySize, Algorithm cipher)
 Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. There are 6 possible combinations of KeySize and Algorithm values. However (KeySize.x40, Algorithm.AES) and (KeySize.x256, Algorithm.RC4) are invalid and corresponding exception will be raised if kit encounters this combination. Does not throw an exception if process failed. More...
 
ASPOSE_PDF_SHARED_API PdfFileSecurity (System::SharedPtr< Aspose::Pdf::Document > document)
 Initializes new PdfFileSecurity object on base of the document . More...
 
ASPOSE_PDF_SHARED_API PdfFileSecurity (System::SharedPtr< Aspose::Pdf::Document > document, System::String outputFile)
 Initializes new PdfFileSecurity object on base of the document . More...
 
ASPOSE_PDF_SHARED_API PdfFileSecurity (System::SharedPtr< Aspose::Pdf::Document > document, System::SharedPtr< System::IO::Stream > outputStream)
 Initializes new PdfFileSecurity object on base of the document . More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::String srcFile) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream) override
 Initializes the facade. More...
 
ASPOSE_PDF_SHARED_API void Close () override
 Closes the facade. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::SaveableFacade
ASPOSE_PDF_SHARED_API void Save (System::String destFile) override
 Saves the PDF document to the specified file. More...
 
ASPOSE_PDF_SHARED_API void Save (System::SharedPtr< System::IO::Stream > destStream) override
 Saves the PDF document to the specified stream. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::Facade
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Documentget_Document () const
 Gets the document facade is working on. More...
 
ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< Aspose::Pdf::Document > srcDoc) override
 Initializes the facade. More...
 
- Public Member Functions inherited from Aspose::Pdf::Facades::IFacade
virtual void BindPdf (System::SharedPtr< Document > srcDoc)=0
 Binds PDF document for editing. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
- Protected Member Functions inherited from Aspose::Pdf::Facades::SaveableFacade
ASPOSE_PDF_SHARED_API SaveableFacade ()
 The constructor. More...
 
ASPOSE_PDF_SHARED_API SaveableFacade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
- Protected Member Functions inherited from Aspose::Pdf::Facades::Facade
bool get__IsObjectLicensed ()
 Gets licensed state of the system. Returns true is system works in licensed mode and false otherwise. More...
 
ASPOSE_PDF_SHARED_API Facade ()
 The constructor. More...
 
ASPOSE_PDF_SHARED_API Facade (System::SharedPtr< Aspose::Pdf::Document > srcDoc)
 The constructor. More...
 
virtual ASPOSE_PDF_SHARED_API void BindPdf (System::String srcFile, System::String password)
 Initializes the facade. More...
 
virtual ASPOSE_PDF_SHARED_API void BindPdf (System::SharedPtr< System::IO::Stream > srcStream, System::String password)
 Initializes the facade. More...
 
virtual ASPOSE_PDF_SHARED_API void AssertDocument () const
 Asserts if the facade is initialized. More...
 
virtual ASPOSE_PDF_SHARED_API ~Facade ()
 

Detailed Description

Represents encrypting or decrypting a Pdf file with owner or user password, changing the security setting and password.

Constructor & Destructor Documentation

◆ PdfFileSecurity() [1/6]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSecurity::PdfFileSecurity ( System::SharedPtr< System::IO::Stream inputStream,
System::SharedPtr< System::IO::Stream outputStream 
)

Initialize the object of PdfFileSecurity with input and output stream.

Deprecated:
Use constructor without destination.
Parameters
inputStreamInput Pdf Stream.
outputStreamOutput Pdf Stream.

◆ PdfFileSecurity() [2/6]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSecurity::PdfFileSecurity ( System::String  inputFile,
System::String  outputFile 
)

Initializes the object of PdfFileSecurity with input and output file.

Deprecated:
Use constructor without destination.
Parameters
inputFileSource input Pdf file.
outputFileOutput Pdf file.

◆ PdfFileSecurity() [3/6]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSecurity::PdfFileSecurity ( )

Initialize the object of PdfFileSecurity.

◆ PdfFileSecurity() [4/6]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSecurity::PdfFileSecurity ( System::SharedPtr< Aspose::Pdf::Document document)

Initializes new PdfFileSecurity object on base of the document .

Parameters
documentPdf document.

◆ PdfFileSecurity() [5/6]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSecurity::PdfFileSecurity ( System::SharedPtr< Aspose::Pdf::Document document,
System::String  outputFile 
)

Initializes new PdfFileSecurity object on base of the document .

Deprecated:
Use constructor without destination.
Parameters
documentPdf document.
outputFileOutput Pdf file.

◆ PdfFileSecurity() [6/6]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Facades::PdfFileSecurity::PdfFileSecurity ( System::SharedPtr< Aspose::Pdf::Document document,
System::SharedPtr< System::IO::Stream outputStream 
)

Initializes new PdfFileSecurity object on base of the document .

Deprecated:
Use constructor without destination.
Parameters
documentPdf document.
outputStreamOutput Pdf Stream.

Member Function Documentation

◆ BindPdf() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSecurity::BindPdf ( System::String  srcFile)
overridevirtual

Initializes the facade.

Parameters
srcFileThe PDF file.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ BindPdf() [2/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSecurity::BindPdf ( System::SharedPtr< System::IO::Stream srcStream)
overridevirtual

Initializes the facade.

Parameters
srcStreamThe stream of PDF file.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ ChangePassword() [1/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::ChangePassword ( System::String  ownerPassword,
System::String  newUserPassword,
System::String  newOwnerPassword 
)

Changes the user password and owner password by owner password, keeps the original security settings. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. Throws an exception if process failed.

Parameters
ownerPasswordOriginal Owner password.
newUserPasswordNew User password.
newOwnerPasswordNew Owner password.
Returns
True for success.

◆ ChangePassword() [2/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::ChangePassword ( System::String  ownerPassword,
System::String  newUserPassword,
System::String  newOwnerPassword,
System::SharedPtr< DocumentPrivilege privilege,
KeySize  keySize 
)

Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. Throws an exception if process failed.

Parameters
ownerPasswordOriginal owner password.
newUserPasswordNew User password.
newOwnerPasswordNew Owner password.
privilegeReset security.
keySizeKeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption.
Returns
True for success.

◆ ChangePassword() [3/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::ChangePassword ( System::String  ownerPassword,
System::String  newUserPassword,
System::String  newOwnerPassword,
System::SharedPtr< DocumentPrivilege privilege,
KeySize  keySize,
Algorithm  cipher 
)

Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. There are 6 possible combinations of KeySize and Algorithm values. However (KeySize.x40, Algorithm.AES) and (KeySize.x256, Algorithm.RC4) are invalid and corresponding exception will be raised if kit encounters this combination. Throws an exception if process failed.

Parameters
ownerPasswordOriginal owner password.
newUserPasswordNew User password.
newOwnerPasswordNew Owner password.
privilegeReset security.
keySizeKeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption.
cipherAlgorithm.AES to encrypt using AES algorithm or Algorithm.RC4 for RC4 encryption.
Returns
True for success.

◆ Close()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSecurity::Close ( )
overridevirtual

Closes the facade.

Reimplemented from Aspose::Pdf::Facades::Facade.

◆ get_AllowExceptions()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::get_AllowExceptions ( )

If this value set to true, exception will be thrown on opearation failure. Else, method returns false on failure and last exception can be checked with LastException property.

Deprecated:
This property is deprecated and can not be used to allow throwing exceptions.

◆ get_LastException()

ASPOSE_PDF_SHARED_API System::Exception Aspose::Pdf::Facades::PdfFileSecurity::get_LastException ( ) const

Returns exception which was thrown by last operation.

◆ MfDecryptFile()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::MfDecryptFile ( System::String  ownerPassword)

Decrypts an encrypted Pdf document by owner password. If the document hasn't owner password, it is allow to use user password. Throws an exception if process failed.

Parameters
ownerPasswordOwner password.
Returns
True for success.

◆ MfEncryptFile() [1/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::MfEncryptFile ( System::String  userPassword,
System::String  ownerPassword,
System::SharedPtr< DocumentPrivilege privilege,
KeySize  keySize 
)

Encrypts Pdf file with userpassword and ownerpassword and sets the document's privileges to access. The user password and the owner password can be null or empty. The owner password will be replaced with a random string if the input owner password is null or empty. Throws exception if process failed.

Parameters
userPasswordUser password.
ownerPasswordOwner password.
privilegeSet privilege.
keySizeKeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption.
Returns
True for success.

◆ MfEncryptFile() [2/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::MfEncryptFile ( System::String  userPassword,
System::String  ownerPassword,
System::SharedPtr< DocumentPrivilege privilege,
KeySize  keySize,
Algorithm  cipher 
)

Encrypts Pdf file with userpassword and ownerpassword and sets the document's privileges to access. The user password and the owner password can be null or empty. The owner password will be replaced with a random string if the input owner password is null or empty. There are 6 possible combinations of KeySize and Algorithm values. However (KeySize.x40, Algorithm.AES) and (KeySize.x256, Algorithm.RC4) are invalid and corresponding exception will be raised if kit encounters this combination. Throws an exception if process failed.

Parameters
userPasswordUser password.
ownerPasswordOwner password.
privilegeSet privilege.
keySizeKeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption.
cipherAlgorithm.AES to encrypt using AES algorithm or Algorithm.RC4 for RC4 encryption.
Returns
True for success.

◆ set_AllowExceptions()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSecurity::set_AllowExceptions ( bool  value)

If this value set to true, exception will be thrown on opearation failure. Else, method returns false on failure and last exception can be checked with LastException property.

Deprecated:
This property is deprecated and can not be used to allow throwing exceptions.

◆ set_InputFile()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSecurity::set_InputFile ( System::String  value)

Sets the input file.

Deprecated:
Use BindPdf(inputFile) method for facade initialization.

◆ set_InputStream()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSecurity::set_InputStream ( System::SharedPtr< System::IO::Stream value)

Sets the input stream.

Deprecated:
Use BindPdf(inputStream) method for facade initialization.

◆ set_OutputFile()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSecurity::set_OutputFile ( System::String  value)

Sets the output file.

Deprecated:
Use Save(outputFile) method for getting facade results.

◆ set_OutputStream()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Facades::PdfFileSecurity::set_OutputStream ( System::SharedPtr< System::IO::Stream value)

Sets the output stream.

Deprecated:
Use Save(outputStream) method for getting facade results.

◆ SetPrivilege() [1/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::SetPrivilege ( System::SharedPtr< DocumentPrivilege privilege)

Sets Pdf file security with empty user/owner passwords. The owner password will be added by a random string. Throws an exception if process failed.

Parameters
privilegeSet privilege.
Returns
True for success.

◆ SetPrivilege() [2/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::SetPrivilege ( System::String  userPassword,
System::String  ownerPassword,
System::SharedPtr< DocumentPrivilege privilege 
)

Sets Pdf file security with original password. Throws an exception if process failed.

Parameters
userPasswordOriginal user password.
ownerPasswordOriginal owner password.
privilegeSet privilege.
Returns
True for success.

◆ TryChangePassword() [1/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::TryChangePassword ( System::String  ownerPassword,
System::String  newUserPassword,
System::String  newOwnerPassword 
)

Changes the user password and owner password by owner password, keeps the original security settings. The new user password and the new owner password can be null or empty. The owner password will be replaced Does not throw an exception if process failed. with a random string if the new owner password is null or empty.

Parameters
ownerPasswordOriginal Owner password.
newUserPasswordNew User password.
newOwnerPasswordNew Owner password.
Returns
True for success,or false.

◆ TryChangePassword() [2/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::TryChangePassword ( System::String  ownerPassword,
System::String  newUserPassword,
System::String  newOwnerPassword,
System::SharedPtr< DocumentPrivilege privilege,
KeySize  keySize 
)

Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. Does not throw an exception if process failed.

Parameters
ownerPasswordOriginal owner password.
newUserPasswordNew User password.
newOwnerPasswordNew Owner password.
privilegeReset security.
keySizeKeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption.
Returns
True for success, or false.

◆ TryChangePassword() [3/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::TryChangePassword ( System::String  ownerPassword,
System::String  newUserPassword,
System::String  newOwnerPassword,
System::SharedPtr< DocumentPrivilege privilege,
KeySize  keySize,
Algorithm  cipher 
)

Changes the user password and password by owner password, allows to reset Pdf documnent security. The new user password and the new owner password can be null or empty. The owner password will be replaced with a random string if the new owner password is null or empty. There are 6 possible combinations of KeySize and Algorithm values. However (KeySize.x40, Algorithm.AES) and (KeySize.x256, Algorithm.RC4) are invalid and corresponding exception will be raised if kit encounters this combination. Does not throw an exception if process failed.

Parameters
ownerPasswordOriginal owner password.
newUserPasswordNew User password.
newOwnerPasswordNew Owner password.
privilegeReset security.
keySizeKeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption.
cipherAlgorithm.AES to encrypt using AES algorithm or Algorithm.RC4 for RC4 encryption.
Returns
True for success, or false.

◆ TryDecryptFile()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::TryDecryptFile ( System::String  ownerPassword)

Decrypts an encrypted Pdf document by owner password. If the document hasn't owner password, it is allow to use user password. Does not throw an exception if process failed.

Parameters
ownerPasswordOwner password.
Returns
True for success,or false.

◆ TryEncryptFile()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::TryEncryptFile ( System::String  userPassword,
System::String  ownerPassword,
System::SharedPtr< DocumentPrivilege privilege,
KeySize  keySize 
)

Encrypts Pdf file with userpassword and ownerpassword and sets the document's privileges to access. The user password and the owner password can be null or empty. The owner password will be replaced with a random string if the input owner password is null or empty. Does not throw an exception if process failed.

Parameters
userPasswordUser password.
ownerPasswordOwner password.
privilegeSet privilege.
keySizeKeySize.x40 for 40 bits encryption, KeySize.x128 for 128 bits encryption and KeySize.x256 for 256 bits encryption.
Returns
True for success, or false.

◆ TrySetPrivilege()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Facades::PdfFileSecurity::TrySetPrivilege ( System::String  userPassword,
System::String  ownerPassword,
System::SharedPtr< DocumentPrivilege privilege 
)

Sets Pdf file security with original password. Does not throw an exception if process failed.

Parameters
userPasswordOriginal user password.
ownerPasswordOriginal owner password.
privilegeSet privilege.
Returns
True for success, or false.