Aspose::Slides::ProtectionManager Class Referencefinal

Presentation password protection management. More...

Inherits Aspose::Slides::IProtectionManager.

Public Member Functions

bool get_EncryptDocumentProperties ()
 This property makes sense, if presentation is password protected. If true then document properties is encrypted in presentation file. If false then document properties is public while presentation is encrypted. Read bool. More...
 
void set_EncryptDocumentProperties (bool value)
 This property makes sense, if presentation is password protected. If true then document properties is encrypted in presentation file. If false then document properties is public while presentation is encrypted. Write bool. More...
 
bool get_IsEncrypted ()
 Gets a value indicating whether this instance is encrypted. Read-only bool. More...
 
bool get_IsOnlyDocumentPropertiesLoaded ()
 This property makes sense, if presentation file is password protected and document properties of this file are public. Value of true means that only document properties are loaded from an encrypted presentation file without use of password. Value of false means that entire encrypted presentation is loaded with use of right password, not only document properties are loaded. If presentation isn't encrypted then property value is always false. If document properties of an encrypted file aren't public then property value is always false. If Presentation.EncryptDocumentProperties is true than IsOnlyDocumentPropertiesLoaded property value is always false. Read-only bool. More...
 
bool get_IsWriteProtected ()
 Gets a value indicating whether this presentation is write protected. Read-only bool. More...
 
System::String get_EncryptionPassword ()
 Gets the password which is used for presentation encryption. Read-only System::String. More...
 
bool get_ReadOnlyRecommended ()
 Gets read-only recommendation. Read bool. More...
 
void set_ReadOnlyRecommended (bool value)
 Sets read-only recommendation. Write bool. More...
 
void Encrypt (System::String encryptionPassword)
 Encrypts Presentation with specified password. More...
 
void RemoveEncryption ()
 Removes the encryption. More...
 
void SetWriteProtection (System::String password)
 Set write protection for this presentation with specified password. More...
 
void RemoveWriteProtection ()
 Removes write protection for this presentation. More...
 
bool CheckWriteProtection (System::String password)
 Determines whether a presentation is a password protected to modify. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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 refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

 ProtectionManager (System::SharedPtr< Presentation > parentPresentation)
 
void ReadUnencryptedDocumentPropertiesIfItExists (System::SharedPtr< System::IO::Stream > stream)
 
void ReadPptxDocumentPropertiesOnly (System::SharedPtr< CompoundFile::MSCDFileSystem > fs)
 
void EnsureEncryptionPasswordSet ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Presentation password protection management.

Constructor & Destructor Documentation

◆ ProtectionManager()

Aspose::Slides::ProtectionManager::ProtectionManager ( System::SharedPtr< Presentation parentPresentation)
protected

Member Function Documentation

◆ CheckWriteProtection()

bool Aspose::Slides::ProtectionManager::CheckWriteProtection ( System::String  password)
virtual

Determines whether a presentation is a password protected to modify.

auto presentation = System::MakeObject<Presentation>(presentationFilePath);
bool isWriteProtected = presentation->get_ProtectionManager()->CheckWriteProtection(u"my_password");
Parameters
passwordThe password for checking.
Returns
True if the password is valid; otherwise, false.
  1. You should check the ProtectionManager::get_IsWriteProtected property before calling this method.
  2. When the password is null or empty, this method returns false.

Implements Aspose::Slides::IProtectionManager.

◆ Encrypt()

void Aspose::Slides::ProtectionManager::Encrypt ( System::String  encryptionPassword)
virtual

Encrypts Presentation with specified password.

Parameters
encryptionPasswordThe password.

Implements Aspose::Slides::IProtectionManager.

◆ EnsureEncryptionPasswordSet()

void Aspose::Slides::ProtectionManager::EnsureEncryptionPasswordSet ( )
protected

◆ get_EncryptDocumentProperties()

bool Aspose::Slides::ProtectionManager::get_EncryptDocumentProperties ( )
virtual

This property makes sense, if presentation is password protected. If true then document properties is encrypted in presentation file. If false then document properties is public while presentation is encrypted. Read bool.

Implements Aspose::Slides::IProtectionManager.

◆ get_EncryptionPassword()

System::String Aspose::Slides::ProtectionManager::get_EncryptionPassword ( )
virtual

Gets the password which is used for presentation encryption. Read-only System::String.

Implements Aspose::Slides::IProtectionManager.

◆ get_IsEncrypted()

bool Aspose::Slides::ProtectionManager::get_IsEncrypted ( )
virtual

Gets a value indicating whether this instance is encrypted. Read-only bool.

true if presentation was loaded from encrypted file or Aspose::Slides::IProtectionManager::Encrypt(System::String) method was called ; otherwise, false.

Implements Aspose::Slides::IProtectionManager.

◆ get_IsOnlyDocumentPropertiesLoaded()

bool Aspose::Slides::ProtectionManager::get_IsOnlyDocumentPropertiesLoaded ( )
virtual

This property makes sense, if presentation file is password protected and document properties of this file are public. Value of true means that only document properties are loaded from an encrypted presentation file without use of password. Value of false means that entire encrypted presentation is loaded with use of right password, not only document properties are loaded. If presentation isn't encrypted then property value is always false. If document properties of an encrypted file aren't public then property value is always false. If Presentation.EncryptDocumentProperties is true than IsOnlyDocumentPropertiesLoaded property value is always false. Read-only bool.

Implements Aspose::Slides::IProtectionManager.

◆ get_IsWriteProtected()

bool Aspose::Slides::ProtectionManager::get_IsWriteProtected ( )
virtual

Gets a value indicating whether this presentation is write protected. Read-only bool.

Implements Aspose::Slides::IProtectionManager.

◆ get_ReadOnlyRecommended()

bool Aspose::Slides::ProtectionManager::get_ReadOnlyRecommended ( )
virtual

Gets read-only recommendation. Read bool.

auto pres = System::MakeObject<Presentation>();
pres->get_ProtectionManager()->set_ReadOnlyRecommended(true);
pres->Save(u"ReadOnlyPresentation.pptx", Aspose::Slides::Export::SaveFormat::Pptx);

Implements Aspose::Slides::IProtectionManager.

◆ ReadPptxDocumentPropertiesOnly()

void Aspose::Slides::ProtectionManager::ReadPptxDocumentPropertiesOnly ( System::SharedPtr< CompoundFile::MSCDFileSystem >  fs)
protected

◆ ReadUnencryptedDocumentPropertiesIfItExists()

void Aspose::Slides::ProtectionManager::ReadUnencryptedDocumentPropertiesIfItExists ( System::SharedPtr< System::IO::Stream stream)
protected

◆ RemoveEncryption()

void Aspose::Slides::ProtectionManager::RemoveEncryption ( )
virtual

Removes the encryption.

Implements Aspose::Slides::IProtectionManager.

◆ RemoveWriteProtection()

void Aspose::Slides::ProtectionManager::RemoveWriteProtection ( )
virtual

Removes write protection for this presentation.

Implements Aspose::Slides::IProtectionManager.

◆ set_EncryptDocumentProperties()

void Aspose::Slides::ProtectionManager::set_EncryptDocumentProperties ( bool  value)
virtual

This property makes sense, if presentation is password protected. If true then document properties is encrypted in presentation file. If false then document properties is public while presentation is encrypted. Write bool.

Implements Aspose::Slides::IProtectionManager.

◆ set_ReadOnlyRecommended()

void Aspose::Slides::ProtectionManager::set_ReadOnlyRecommended ( bool  value)
virtual

Sets read-only recommendation. Write bool.

auto pres = System::MakeObject<Presentation>();
pres->get_ProtectionManager()->set_ReadOnlyRecommended(true);
pres->Save(u"ReadOnlyPresentation.pptx", Aspose::Slides::Export::SaveFormat::Pptx);

Implements Aspose::Slides::IProtectionManager.

◆ SetWriteProtection()

void Aspose::Slides::ProtectionManager::SetWriteProtection ( System::String  password)
virtual

Set write protection for this presentation with specified password.

Parameters
passwordThe password.

Implements Aspose::Slides::IProtectionManager.