Aspose::Slides::LoadOptions Class Reference

Allows to specify additional options (such as format or default font) when loading a presentation. More...

Inherits Aspose::Slides::ILoadOptions.

Public Member Functions

Aspose::Slides::LoadFormat get_LoadFormat ()
 Returns format of a presentation to load. Read Slides::LoadFormat. More...
 
void set_LoadFormat (Aspose::Slides::LoadFormat value)
 Sets format of a presentation to load. Write Slides::LoadFormat. More...
 
System::String get_DefaultRegularFont ()
 Returns Regular font used in case source font is not found. Read System::String. More...
 
void set_DefaultRegularFont (System::String value)
 Sets Regular font used in case source font is not found. Write System::String. More...
 
System::String get_DefaultSymbolFont ()
 Returns Symbol font used in case source font is not found. Read System::String. More...
 
void set_DefaultSymbolFont (System::String value)
 Sets Symbol font used in case source font is not found. Write System::String. More...
 
System::String get_DefaultAsianFont ()
 Returns Asian font used in case source font is not found. Read System::String. More...
 
void set_DefaultAsianFont (System::String value)
 Sets Asian font used in case source font is not found. Write System::String. More...
 
System::String get_Password ()
 Gets the password. Read System::String. More...
 
void set_Password (System::String value)
 Sets the password. Write System::String. More...
 
bool get_OnlyLoadDocumentProperties ()
 This property makes sense, if presentation file is password protected. Value of true means that only document properties must be loaded from an encrypted presentation file and password must be ignored. Value of false means that entire encrypted presentation must be loaded with use of right password. If presentation isn't encrypted then property value is always ignored. If document properties of an encrypted file aren't public and property value is true then document properties cannot be loaded and exception will be thrown. Read bool. More...
 
void set_OnlyLoadDocumentProperties (bool value)
 This property makes sense, if presentation file is password protected. Value of true means that only document properties must be loaded from an encrypted presentation file and password must be ignored. Value of false means that entire encrypted presentation must be loaded with use of right password. If presentation isn't encrypted then property value is always ignored. If document properties of an encrypted file aren't public and property value is true then document properties cannot be loaded and exception will be thrown. Write bool. More...
 
System::SharedPtr< Warnings::IWarningCallbackget_WarningCallback ()
 Returns an object which receives warnings and decides whether loading process will continue or will be aborted. Read IWarningCallback. More...
 
void set_WarningCallback (System::SharedPtr< Warnings::IWarningCallback > value)
 Sets an object which receives warnings and decides whether loading process will continue or will be aborted. Write IWarningCallback. More...
 
System::SharedPtr< IBlobManagementOptionsget_BlobManagementOptions ()
 Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior, such as using of temporary files or max BLOBs bytes in memory. These options intended to set up the best performance/memory consumption ratio for a perticular environment or requirements. More...
 
void set_BlobManagementOptions (System::SharedPtr< IBlobManagementOptions > value)
 Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior, such as using of temporary files or max BLOBs bytes in memory. These options intended to set up the best performance/memory consumption ratio for a perticular environment or requirements. More...
 
System::SharedPtr< IFontSourcesget_DocumentLevelFontSources ()
 Specifies sources for external fonts to be used by the presentation. These fonts are available to the presentation throughout its lifetime and are not shared with other presentations More...
 
void set_DocumentLevelFontSources (System::SharedPtr< IFontSources > value)
 Specifies sources for external fonts to be used by the presentation. These fonts are available to the presentation throughout its lifetime and are not shared with other presentations More...
 
System::SharedPtr< IInterruptionTokenget_InterruptionToken ()
 The token to monitor for interruption requests. More...
 
void set_InterruptionToken (System::SharedPtr< IInterruptionToken > value)
 The token to monitor for interruption requests. More...
 
System::SharedPtr< IResourceLoadingCallbackget_ResourceLoadingCallback ()
 Returns callback interface which manages external resources loading. Read IResourceLoadingCallback. More...
 
void set_ResourceLoadingCallback (System::SharedPtr< IResourceLoadingCallback > value)
 Sets callback interface which manages external resources loading. Write IResourceLoadingCallback. More...
 
 LoadOptions ()
 Creates new default load options. More...
 
 LoadOptions (Aspose::Slides::LoadFormat loadFormat)
 Creates new load options. 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 () ASPOSE_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

System::SharedPtr< Aspose::Slides::VentureLicense > get_VentureLicense ()
 
void set_VentureLicense (System::SharedPtr< Aspose::Slides::VentureLicense > value)
 
bool get_PasswordIsSet ()
 Indicates if password is set More...
 
void SendPresentationSignedWarning ()
 
void SendNotImplementedWarning (System::String description, Warnings::WarningType warningType)
 

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

Allows to specify additional options (such as format or default font) when loading a presentation.

Constructor & Destructor Documentation

◆ LoadOptions() [1/2]

Aspose::Slides::LoadOptions::LoadOptions ( )

Creates new default load options.

◆ LoadOptions() [2/2]

Aspose::Slides::LoadOptions::LoadOptions ( Aspose::Slides::LoadFormat  loadFormat)

Creates new load options.

Parameters
loadFormatFormat of a presentation to load.

Member Function Documentation

◆ get_BlobManagementOptions()

System::SharedPtr<IBlobManagementOptions> Aspose::Slides::LoadOptions::get_BlobManagementOptions ( )
virtual

Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior, such as using of temporary files or max BLOBs bytes in memory. These options intended to set up the best performance/memory consumption ratio for a perticular environment or requirements.

A Binary Large Object (BLOB) is a binary data stored as a single entity - i.e. BLOB can be an audio, video or presentation itself.

Implements Aspose::Slides::ILoadOptions.

◆ get_DefaultAsianFont()

System::String Aspose::Slides::LoadOptions::get_DefaultAsianFont ( )
virtual

Returns Asian font used in case source font is not found. Read System::String.

Implements Aspose::Slides::ILoadOptions.

◆ get_DefaultRegularFont()

System::String Aspose::Slides::LoadOptions::get_DefaultRegularFont ( )
virtual

Returns Regular font used in case source font is not found. Read System::String.

Implements Aspose::Slides::ILoadOptions.

◆ get_DefaultSymbolFont()

System::String Aspose::Slides::LoadOptions::get_DefaultSymbolFont ( )
virtual

Returns Symbol font used in case source font is not found. Read System::String.

Implements Aspose::Slides::ILoadOptions.

◆ get_DocumentLevelFontSources()

System::SharedPtr<IFontSources> Aspose::Slides::LoadOptions::get_DocumentLevelFontSources ( )
virtual

Specifies sources for external fonts to be used by the presentation. These fonts are available to the presentation throughout its lifetime and are not shared with other presentations

Implements Aspose::Slides::ILoadOptions.

◆ get_InterruptionToken()

System::SharedPtr<IInterruptionToken> Aspose::Slides::LoadOptions::get_InterruptionToken ( )
virtual

The token to monitor for interruption requests.

This token manages the whole IPresentation instance lifetime. Any long-running operation, such as loading or saving of presentation, will be interrupted via calling of the InterruptionTokenSource::Interrupt method of the InterruptionTokenSource.

Implements Aspose::Slides::ILoadOptions.

◆ get_LoadFormat()

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

Returns format of a presentation to load. Read Slides::LoadFormat.

Implements Aspose::Slides::ILoadOptions.

◆ get_OnlyLoadDocumentProperties()

bool Aspose::Slides::LoadOptions::get_OnlyLoadDocumentProperties ( )
virtual

This property makes sense, if presentation file is password protected. Value of true means that only document properties must be loaded from an encrypted presentation file and password must be ignored. Value of false means that entire encrypted presentation must be loaded with use of right password. If presentation isn't encrypted then property value is always ignored. If document properties of an encrypted file aren't public and property value is true then document properties cannot be loaded and exception will be thrown. Read bool.

Implements Aspose::Slides::ILoadOptions.

◆ get_Password()

System::String Aspose::Slides::LoadOptions::get_Password ( )
virtual

Gets the password. Read System::String.

The password.

Implements Aspose::Slides::ILoadOptions.

◆ get_PasswordIsSet()

bool Aspose::Slides::LoadOptions::get_PasswordIsSet ( )
protected

Indicates if password is set

◆ get_ResourceLoadingCallback()

System::SharedPtr<IResourceLoadingCallback> Aspose::Slides::LoadOptions::get_ResourceLoadingCallback ( )
virtual

Returns callback interface which manages external resources loading. Read IResourceLoadingCallback.

Implements Aspose::Slides::ILoadOptions.

◆ get_VentureLicense()

System::SharedPtr<Aspose::Slides::VentureLicense> Aspose::Slides::LoadOptions::get_VentureLicense ( )
protected

◆ get_WarningCallback()

System::SharedPtr<Warnings::IWarningCallback> Aspose::Slides::LoadOptions::get_WarningCallback ( )
virtual

Returns an object which receives warnings and decides whether loading process will continue or will be aborted. Read IWarningCallback.

Implements Aspose::Slides::ILoadOptions.

◆ SendNotImplementedWarning()

void Aspose::Slides::LoadOptions::SendNotImplementedWarning ( System::String  description,
Warnings::WarningType  warningType 
)
protected

◆ SendPresentationSignedWarning()

void Aspose::Slides::LoadOptions::SendPresentationSignedWarning ( )
protected

◆ set_BlobManagementOptions()

void Aspose::Slides::LoadOptions::set_BlobManagementOptions ( System::SharedPtr< IBlobManagementOptions value)
virtual

Represents the options which can be used to manage Binary Large Objects (BLOBs) handling behavior, such as using of temporary files or max BLOBs bytes in memory. These options intended to set up the best performance/memory consumption ratio for a perticular environment or requirements.

A Binary Large Object (BLOB) is a binary data stored as a single entity - i.e. BLOB can be an audio, video or presentation itself.

Implements Aspose::Slides::ILoadOptions.

◆ set_DefaultAsianFont()

void Aspose::Slides::LoadOptions::set_DefaultAsianFont ( System::String  value)
virtual

Sets Asian font used in case source font is not found. Write System::String.

Implements Aspose::Slides::ILoadOptions.

◆ set_DefaultRegularFont()

void Aspose::Slides::LoadOptions::set_DefaultRegularFont ( System::String  value)
virtual

Sets Regular font used in case source font is not found. Write System::String.

Implements Aspose::Slides::ILoadOptions.

◆ set_DefaultSymbolFont()

void Aspose::Slides::LoadOptions::set_DefaultSymbolFont ( System::String  value)
virtual

Sets Symbol font used in case source font is not found. Write System::String.

Implements Aspose::Slides::ILoadOptions.

◆ set_DocumentLevelFontSources()

void Aspose::Slides::LoadOptions::set_DocumentLevelFontSources ( System::SharedPtr< IFontSources value)
virtual

Specifies sources for external fonts to be used by the presentation. These fonts are available to the presentation throughout its lifetime and are not shared with other presentations

Implements Aspose::Slides::ILoadOptions.

◆ set_InterruptionToken()

void Aspose::Slides::LoadOptions::set_InterruptionToken ( System::SharedPtr< IInterruptionToken value)
virtual

The token to monitor for interruption requests.

This token manages the whole IPresentation instance lifetime. Any long-running operation, such as loading or saving of presentation, will be interrupted via calling of the InterruptionTokenSource::Interrupt method of the InterruptionTokenSource.

Implements Aspose::Slides::ILoadOptions.

◆ set_LoadFormat()

void Aspose::Slides::LoadOptions::set_LoadFormat ( Aspose::Slides::LoadFormat  value)
virtual

Sets format of a presentation to load. Write Slides::LoadFormat.

Implements Aspose::Slides::ILoadOptions.

◆ set_OnlyLoadDocumentProperties()

void Aspose::Slides::LoadOptions::set_OnlyLoadDocumentProperties ( bool  value)
virtual

This property makes sense, if presentation file is password protected. Value of true means that only document properties must be loaded from an encrypted presentation file and password must be ignored. Value of false means that entire encrypted presentation must be loaded with use of right password. If presentation isn't encrypted then property value is always ignored. If document properties of an encrypted file aren't public and property value is true then document properties cannot be loaded and exception will be thrown. Write bool.

Implements Aspose::Slides::ILoadOptions.

◆ set_Password()

void Aspose::Slides::LoadOptions::set_Password ( System::String  value)
virtual

Sets the password. Write System::String.

The password.

Implements Aspose::Slides::ILoadOptions.

◆ set_ResourceLoadingCallback()

void Aspose::Slides::LoadOptions::set_ResourceLoadingCallback ( System::SharedPtr< IResourceLoadingCallback value)
virtual

Sets callback interface which manages external resources loading. Write IResourceLoadingCallback.

Implements Aspose::Slides::ILoadOptions.

◆ set_VentureLicense()

void Aspose::Slides::LoadOptions::set_VentureLicense ( System::SharedPtr< Aspose::Slides::VentureLicense >  value)
protected

◆ set_WarningCallback()

void Aspose::Slides::LoadOptions::set_WarningCallback ( System::SharedPtr< Warnings::IWarningCallback value)
virtual

Sets an object which receives warnings and decides whether loading process will continue or will be aborted. Write IWarningCallback.

Implements Aspose::Slides::ILoadOptions.