Aspose::Slides::IPresentationInfo Class Referenceabstract

Information about presentation file More...

Inherits System::Object.

Inherited by Aspose::Slides::PresentationInfo.

Public Member Functions

virtual bool get_IsEncrypted ()=0
 Gets True if binded presentation is encrypted, otherwise False. Read-only bool. More...
 
virtual bool get_IsPasswordProtected ()=0
 Gets a value that indicates whether a binded presentation is protected by a password to open. More...
 
virtual NullableBool get_IsWriteProtected ()=0
 Gets a value that indicates whether a binded presentation is write protected. More...
 
virtual Aspose::Slides::LoadFormat get_LoadFormat ()=0
 Gets format of the binded presentation. Read-only Slides::LoadFormat. More...
 
virtual bool CheckPassword (System::String password)=0
 Checks whether a password is correct for a presentation protected with open password. More...
 
virtual bool CheckWriteProtection (System::String password)=0
 Checks whether a password to modify is correct for a write protected presentation. More...
 
virtual System::SharedPtr< IDocumentPropertiesReadDocumentProperties ()=0
 Gets document properties of binded presentation. More...
 
virtual void UpdateDocumentProperties (System::SharedPtr< IDocumentProperties > documentProperties)=0
 Updates properties of binded presentation. More...
 
virtual void WriteBindedPresentation (System::SharedPtr< System::IO::Stream > stream)=0
 Writes binded presentation to stream. More...
 
virtual void WriteBindedPresentation (System::String file)=0
 Writes binded presentation to file. 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 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)
 

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...
 

Detailed Description

Information about presentation file

Member Function Documentation

◆ CheckPassword()

virtual bool Aspose::Slides::IPresentationInfo::CheckPassword ( System::String  password)
pure virtual

Checks whether a password is correct for a presentation protected with open password.

auto info = PresentationFactory::get_Instance()->GetPresentationInfo(u"pres.pptx");
bool isPasswordCorrect = info->CheckPassword(u"my_password");
Parameters
passwordThe password to check.
Returns
True if the presentation is protected with open password and the password is correct and false otherwise.

When the password is null or empty, this method returns false.

Implemented in Aspose::Slides::PresentationInfo.

◆ CheckWriteProtection()

virtual bool Aspose::Slides::IPresentationInfo::CheckWriteProtection ( System::String  password)
pure virtual

Checks whether a password to modify is correct for a write protected presentation.

auto info = PresentationFactory::get_Instance()->GetPresentationInfo(presentationFilePath);
if (info->get_IsWriteProtected() == Aspose::Slides::NullableBool::True)
{
bool isWriteProtectedByPassword = info->CheckWriteProtection(u"my_password");
}
Parameters
passwordThe password to check.
Returns
True if the presentation is write protected and the password is correct. False otherwise.
  1. You should check the IPresentationInfo::get_IsWriteProtected property before calling this method.
  2. When password is null or empty, this method returns false.
Exceptions
System::InvalidOperationException

Implemented in Aspose::Slides::PresentationInfo.

◆ get_IsEncrypted()

virtual bool Aspose::Slides::IPresentationInfo::get_IsEncrypted ( )
pure virtual

Gets True if binded presentation is encrypted, otherwise False. Read-only bool.

Implemented in Aspose::Slides::PresentationInfo.

◆ get_IsPasswordProtected()

virtual bool Aspose::Slides::IPresentationInfo::get_IsPasswordProtected ( )
pure virtual

Gets a value that indicates whether a binded presentation is protected by a password to open.

auto info = PresentationFactory::get_Instance()->GetPresentationInfo(presentationFilePath);
if (info->get_IsPasswordProtected())
{
System::Console::WriteLine(System::String(u"The presentation '") + presentationFilePath + u"' is protected by a password to open.");
}

Implemented in Aspose::Slides::PresentationInfo.

◆ get_IsWriteProtected()

virtual NullableBool Aspose::Slides::IPresentationInfo::get_IsWriteProtected ( )
pure virtual

Gets a value that indicates whether a binded presentation is write protected.

auto info = PresentationFactory::get_Instance()->GetPresentationInfo(presentationFilePath);
if (info->get_IsWriteProtected() == Aspose::Slides::NullableBool::True)
{
System::Console::WriteLine(System::String(u"The presentation '") + presentationFilePath + u"' is write protected by a password.");
}

If the presentation is protected by a password to open, the property value equals NotDefined. See NullableBool enumeration.

Implemented in Aspose::Slides::PresentationInfo.

◆ get_LoadFormat()

virtual Aspose::Slides::LoadFormat Aspose::Slides::IPresentationInfo::get_LoadFormat ( )
pure virtual

Gets format of the binded presentation. Read-only Slides::LoadFormat.

Implemented in Aspose::Slides::PresentationInfo.

◆ ReadDocumentProperties()

virtual System::SharedPtr<IDocumentProperties> Aspose::Slides::IPresentationInfo::ReadDocumentProperties ( )
pure virtual

Gets document properties of binded presentation.

Returns
Document properties IDocumentProperties

Implemented in Aspose::Slides::PresentationInfo.

◆ UpdateDocumentProperties()

virtual void Aspose::Slides::IPresentationInfo::UpdateDocumentProperties ( System::SharedPtr< IDocumentProperties documentProperties)
pure virtual

Updates properties of binded presentation.

Parameters
documentPropertiesDocument properties IDocumentProperties

This sample shows how to call the IPresentationInfo::UpdateDocumentProperties method to update the document properties returned by call of the IPresentationInfo::ReadDocumentProperties method.

auto info = PresentationFactory::get_Instance()->GetPresentationInfo(u"pres.pptx");
auto props = info->ReadDocumentProperties();
props->set_Subject(u"New subject");
props->set_LastSavedTime(System::DateTime::get_UtcNow());
info->UpdateDocumentProperties(props);
info->WriteBindedPresentation(u"new_pres.pptx");

Implemented in Aspose::Slides::PresentationInfo.

◆ WriteBindedPresentation() [1/2]

virtual void Aspose::Slides::IPresentationInfo::WriteBindedPresentation ( System::SharedPtr< System::IO::Stream stream)
pure virtual

Writes binded presentation to stream.

Parameters
streamThe stream must be seekable and writable.

Implemented in Aspose::Slides::PresentationInfo.

◆ WriteBindedPresentation() [2/2]

virtual void Aspose::Slides::IPresentationInfo::WriteBindedPresentation ( System::String  file)
pure virtual

Writes binded presentation to file.

Parameters
filePresentation file.

Implemented in Aspose::Slides::PresentationInfo.