Aspose::Slides::Export::XpsOptions Class Reference

Provides options that control how a presentation is saved in XPS format. More...

#include <XpsOptions.h>

Inherits Aspose::Slides::Export::SaveOptions, and Aspose::Slides::Export::IXpsOptions.

Public Member Functions

bool get_ShowHiddenSlides () override
 Specifies whether the generated document should include hidden slides or not. Default is false. More...
 
void set_ShowHiddenSlides (bool value) override
 Specifies whether the generated document should include hidden slides or not. Default is false. More...
 
bool get_SaveMetafilesAsPng () override
 True to convert all metafiles used in a presentation to the PNG images. Read bool. More...
 
void set_SaveMetafilesAsPng (bool value) override
 True to convert all metafiles used in a presentation to the PNG images. Write bool. More...
 
bool get_DrawSlidesFrame () override
 True to draw black frame around each slide. Read bool. More...
 
void set_DrawSlidesFrame (bool value) override
 True to draw black frame around each slide. Write bool. More...
 
 XpsOptions ()
 Default constructor. More...
 
- Public Member Functions inherited from Aspose::Slides::Export::SaveOptions
System::SharedPtr< Aspose::Slides::Warnings::IWarningCallbackget_WarningCallback () override
 Returns of sets an object which receives warnings and decides whether loading process will continue or will be aborted. Read Aspose::Slides::Warnings::IWarningCallback. More...
 
void set_WarningCallback (System::SharedPtr< Aspose::Slides::Warnings::IWarningCallback > value) override
 Returns of sets an object which receives warnings and decides whether loading process will continue or will be aborted. Write Aspose::Slides::Warnings::IWarningCallback. More...
 
System::SharedPtr< IProgressCallbackget_ProgressCallback () override
 Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...
 
void set_ProgressCallback (System::SharedPtr< IProgressCallback > value) override
 Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...
 
System::String get_DefaultRegularFont () override
 Returns font used in case source font is not found. Reads System::String. More...
 
void set_DefaultRegularFont (System::String value) override
 Sets font used in case source font is not found. Writes System::String. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< Aspose::Slides::Warnings::IWarningCallbackget_WarningCallback ()=0
 Returns an object which receives warnings and decides whether loading process will continue or will be aborted. Read Aspose::Slides::Warnings::IWarningCallback. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_WarningCallback (System::SharedPtr< Aspose::Slides::Warnings::IWarningCallback > value)=0
 Sets an object which receives warnings and decides whether loading process will continue or will be aborted. Write Aspose::Slides::Warnings::IWarningCallback. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< IProgressCallbackget_ProgressCallback ()=0
 Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_ProgressCallback (System::SharedPtr< IProgressCallback > value)=0
 Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API System::String get_DefaultRegularFont ()=0
 Returns font used in case source font is not found. Reads System::String. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_DefaultRegularFont (System::String value)=0
 Sets font used in case source font is not found. Writes System::String. 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...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool get_SaveMetafilesAsPng ()=0
 True to convert all metafiles used in a presentation to the PNG images. Read bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_SaveMetafilesAsPng (bool value)=0
 True to convert all metafiles used in a presentation to the PNG images. Write bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool get_DrawSlidesFrame ()=0
 True to draw black frame around each slide. Read bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_DrawSlidesFrame (bool value)=0
 True to draw black frame around each slide. Write bool. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API bool get_ShowHiddenSlides ()=0
 Specifies whether the generated document should include hidden slides or not. Default is false. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_ShowHiddenSlides (bool value)=0
 Specifies whether the generated document should include hidden slides or not. Default is false. 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

Provides options that control how a presentation is saved in XPS format.

The following example shows how to converting presentations to XPS using default settings.

// Instantiate a Presentation object that represents a presentation file
auto pres = System::MakeObject<Presentation>(u"Convert_XPS.pptx");
// Saving the presentation to XPS document
pres->Save(u"XPS_Output_Without_XPSOption_out.xps", SaveFormat::Xps);
@ Xps
Save presentation in XPS format.

The following example shows how to converting presentations to XPS using custom settings.

// Instantiate a Presentation object that represents a presentation file
auto pres = System::MakeObject<Presentation>(u"Convert_XPS_Options.pptx");
// Instantiate the TiffOptions class
System::SharedPtr<XpsOptions> options = System::MakeObject<XpsOptions>();
// Save MetaFiles as PNG
options->set_SaveMetafilesAsPng(true);
// Save the presentation to XPS document
pres->Save(u"XPS_With_Options_out.xps", SaveFormat::Xps, options);
Pointer class to wrap types being allocated on heap. Use it to manage memory for classes inheriting O...
Definition: smart_ptr.h:180

Constructor & Destructor Documentation

◆ XpsOptions()

Aspose::Slides::Export::XpsOptions::XpsOptions ( )

Default constructor.

Member Function Documentation

◆ get_DrawSlidesFrame()

bool Aspose::Slides::Export::XpsOptions::get_DrawSlidesFrame ( )
overridevirtual

True to draw black frame around each slide. Read bool.

Default is false.

Implements Aspose::Slides::Export::IXpsOptions.

◆ get_SaveMetafilesAsPng()

bool Aspose::Slides::Export::XpsOptions::get_SaveMetafilesAsPng ( )
overridevirtual

True to convert all metafiles used in a presentation to the PNG images. Read bool.

Default is true.

Implements Aspose::Slides::Export::IXpsOptions.

◆ get_ShowHiddenSlides()

bool Aspose::Slides::Export::XpsOptions::get_ShowHiddenSlides ( )
overridevirtual

Specifies whether the generated document should include hidden slides or not. Default is false.

Implements Aspose::Slides::Export::IXpsOptions.

◆ set_DrawSlidesFrame()

void Aspose::Slides::Export::XpsOptions::set_DrawSlidesFrame ( bool  value)
overridevirtual

True to draw black frame around each slide. Write bool.

Default is false.

Implements Aspose::Slides::Export::IXpsOptions.

◆ set_SaveMetafilesAsPng()

void Aspose::Slides::Export::XpsOptions::set_SaveMetafilesAsPng ( bool  value)
overridevirtual

True to convert all metafiles used in a presentation to the PNG images. Write bool.

Default is true.

Implements Aspose::Slides::Export::IXpsOptions.

◆ set_ShowHiddenSlides()

void Aspose::Slides::Export::XpsOptions::set_ShowHiddenSlides ( bool  value)
overridevirtual

Specifies whether the generated document should include hidden slides or not. Default is false.

Implements Aspose::Slides::Export::IXpsOptions.