Aspose::Slides::PresentationInfo Class Referencefinal

Information about presentation file More...

Inherits Aspose::Slides::IPresentationInfo.

Public Member Functions

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

bool CheckPassword (System::String password)
 Checks if the password is correct for encrypted presentation. Reads presentation data if the password is correct. More...
 
 PresentationInfo (System::SharedPtr< System::IO::Stream > stream, System::SharedPtr< System::IO::FileInfo > fileInfo)
 Initializes new PresentationInfo object. More...
 

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

Information about presentation file

Constructor & Destructor Documentation

◆ PresentationInfo()

Aspose::Slides::PresentationInfo::PresentationInfo ( System::SharedPtr< System::IO::Stream stream,
System::SharedPtr< System::IO::FileInfo fileInfo 
)
protected

Initializes new PresentationInfo object.

Parameters
streamStream with presentation.
fileInfoFile info, if stream created from file, null otherwise.

Member Function Documentation

◆ CheckPassword()

bool Aspose::Slides::PresentationInfo::CheckPassword ( System::String  password)
protected

Checks if the password is correct for encrypted presentation. Reads presentation data if the password is correct.

Parameters
passwordPassword.
Returns
True if the presentation is encrypted and password is correct. False otherwise.

◆ CheckWriteProtection()

bool Aspose::Slides::PresentationInfo::CheckWriteProtection ( System::String  password)
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 PresentationInfo::get_IsWriteProtected property before calling this method.
  2. When password is null or empty, this method returns false.
Exceptions
System::InvalidOperationException

Implements Aspose::Slides::IPresentationInfo.

◆ get_IsEncrypted()

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

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

Implements Aspose::Slides::IPresentationInfo.

◆ get_IsPasswordProtected()

bool Aspose::Slides::PresentationInfo::get_IsPasswordProtected ( )
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 password to open.");
}

Implements Aspose::Slides::IPresentationInfo.

◆ get_IsWriteProtected()

NullableBool Aspose::Slides::PresentationInfo::get_IsWriteProtected ( )
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.

Implements Aspose::Slides::IPresentationInfo.

◆ get_LoadFormat()

Aspose::Slides::LoadFormat Aspose::Slides::PresentationInfo::get_LoadFormat ( )
virtual

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

Implements Aspose::Slides::IPresentationInfo.

◆ ReadDocumentProperties()

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

Gets document properties of binded presentation.

Implements Aspose::Slides::IPresentationInfo.

◆ UpdateDocumentProperties()

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

Updates properties of binded presentation.

This sample shows how to call the PresentationInfo::UpdateDocumentProperties method to update the document properties returned by call of the PresentationInfo::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");

Implements Aspose::Slides::IPresentationInfo.

◆ WriteBindedPresentation() [1/2]

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

Writes binded presentation to stream.

Parameters
streamThe stream must be seekable and writable.

Implements Aspose::Slides::IPresentationInfo.

◆ WriteBindedPresentation() [2/2]

void Aspose::Slides::PresentationInfo::WriteBindedPresentation ( System::String  file)
virtual

Writes binded presentation to file.

Parameters
filePresentation file.

Implements Aspose::Slides::IPresentationInfo.