Aspose::Slides::ProtectionManager Class Referencefinal

Presentation password protection management. More...

#include <ProtectionManager.h>

Inherits Aspose::Slides::IProtectionManager.

Public Member Functions

bool get_EncryptDocumentProperties () override
 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) override
 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 () override
 Gets a value indicating whether this instance is encrypted. Read-only bool. More...
 
bool get_IsOnlyDocumentPropertiesLoaded () override
 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 () override
 Gets a value indicating whether this presentation is write protected. Read-only bool. More...
 
System::String get_EncryptionPassword () override
 Gets the password which is used for presentation encryption. Read-only System::String. More...
 
bool get_ReadOnlyRecommended () override
 Gets read-only recommendation. Read bool. More...
 
void set_ReadOnlyRecommended (bool value) override
 Sets read-only recommendation. Write bool. More...
 
void Encrypt (System::String encryptionPassword) override
 Encrypts Presentation with specified password. More...
 
void RemoveEncryption () override
 Removes the encryption. More...
 
void SetWriteProtection (System::String password) override
 Set write protection for this presentation with specified password. More...
 
void RemoveWriteProtection () override
 Removes write protection for this presentation. More...
 
bool CheckWriteProtection (System::String password) override
 Determines whether a presentation is a password protected to modify. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool get_EncryptDocumentProperties ()=0
 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...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_EncryptDocumentProperties (bool value)=0
 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...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool get_IsEncrypted ()=0
 Gets a value indicating whether this instance is encrypted. Read-only bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool get_IsOnlyDocumentPropertiesLoaded ()=0
 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 PresentationEx.EncryptDocumentProperties is true than IsOnlyDocumentPropertiesLoaded property value is always false. Read-only bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool get_IsWriteProtected ()=0
 Gets a value indicating whether this presentation is write protected. Read-only bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API System::String get_EncryptionPassword ()=0
 Returns encryption password. Read-only System::String. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool get_ReadOnlyRecommended ()=0
 Gets read-only recommendation. Read bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_ReadOnlyRecommended (bool value)=0
 Sets read-only recommendation. Write bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void Encrypt (System::String encryptionPassword)=0
 Encrypts Presentation with specified password. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void RemoveEncryption ()=0
 Removes the encryption. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void SetWriteProtection (System::String password)=0
 Set write protection for this presentation with specified password. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void RemoveWriteProtection ()=0
 Removes write protection for this presentation. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool CheckWriteProtection (System::String password)=0
 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 reference 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 int32_t 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
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...
 

Detailed Description

Presentation password protection management.

Member Function Documentation

◆ CheckWriteProtection()

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

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)
overridevirtual

Encrypts Presentation with specified password.

Parameters
encryptionPasswordThe password.

The following sample code shows you how to encrypt a PowerPoint Presentation.

auto presentation = System::MakeObject<Presentation>(u"pres.pptx");
presentation->get_ProtectionManager()->Encrypt(u"123123");
presentation->Save(u"encrypted-pres.pptx", SaveFormat::Pptx);

Implements Aspose::Slides::IProtectionManager.

◆ get_EncryptDocumentProperties()

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

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 ( )
overridevirtual

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 ( )
overridevirtual

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

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

Implements Aspose::Slides::IProtectionManager.

◆ get_IsOnlyDocumentPropertiesLoaded()

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

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 ( )
overridevirtual

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 ( )
overridevirtual

Gets read-only recommendation. Read bool.

The following sample code shows you how to set a PowerPoint Presentation to Read-Only in C# using Aspose.Slides.

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

Implements Aspose::Slides::IProtectionManager.

◆ RemoveEncryption()

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

Removes the encryption.

Implements Aspose::Slides::IProtectionManager.

◆ RemoveWriteProtection()

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

Removes write protection for this presentation.

This sample code shows you how to remove the write protection from a PowerPoint Presentation.

auto presentation = System::MakeObject<Presentation>(u"pres.pptx");
presentation->get_ProtectionManager()->RemoveWriteProtection();
presentation->Save(u"write-protection-removed.pptx", SaveFormat::Pptx);

Implements Aspose::Slides::IProtectionManager.

◆ set_EncryptDocumentProperties()

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

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)
overridevirtual

Sets read-only recommendation. Write bool.

The following sample code shows you how to set a PowerPoint Presentation to Read-Only in C# using Aspose.Slides.

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

Implements Aspose::Slides::IProtectionManager.

◆ SetWriteProtection()

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

Set write protection for this presentation with specified password.

Parameters
passwordThe password.

The following sample code shows you how to set a write protection to a presentation.

auto presentation = System::MakeObject<Presentation>(u"pres.pptx");
presentation->get_ProtectionManager()->SetWriteProtection(u"123123");
presentation->Save(u"write-protected-pres.pptx", SaveFormat::Pptx);

Implements Aspose::Slides::IProtectionManager.