Aspose::Slides::Export::HtmlOptions Class Reference

Represents a HTML exporting options. More...

#include <HtmlOptions.h>

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

Public Member Functions

System::SharedPtr< INotesCommentsLayoutingOptionsget_NotesCommentsLayouting () override
 Provides options that control how notes and comments is placed in exported document. More...
 
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...
 
System::SharedPtr< IHtmlFormatterget_HtmlFormatter () override
 Returns HTML template. Read IHtmlFormatter. More...
 
void set_HtmlFormatter (System::SharedPtr< IHtmlFormatter > value) override
 Sets HTML template. Write IHtmlFormatter. More...
 
System::SharedPtr< ISlideImageFormatget_SlideImageFormat () override
 Returns slide image format options. Read ISlideImageFormat. More...
 
void set_SlideImageFormat (System::SharedPtr< ISlideImageFormat > value) override
 Sets slide image format options. Write ISlideImageFormat. More...
 
uint8_t get_JpegQuality () override
 Returns a value determining the quality of the JPEG images inside PDF document. Read uint8_t. More...
 
void set_JpegQuality (uint8_t value) override
 Sets a value determining the quality of the JPEG images inside PDF document. Write uint8_t. More...
 
Aspose::Slides::Export::PicturesCompression get_PicturesCompression () override
 Represents the pictures compression level More...
 
void set_PicturesCompression (Aspose::Slides::Export::PicturesCompression value) override
 Represents the pictures compression level More...
 
bool get_DeletePicturesCroppedAreas () override
 A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file) More...
 
void set_DeletePicturesCroppedAreas (bool value) override
 A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file) More...
 
bool get_SvgResponsiveLayout () override
 True to exclude width and height attributes from svg container - that will make layout responsive. False - otherwise. Read bool. More...
 
void set_SvgResponsiveLayout (bool value) override
 True to exclude width and height attributes from svg container - that will make layout responsive. False - otherwise. Write bool. More...
 
 HtmlOptions (System::SharedPtr< ILinkEmbedController > linkEmbedController)
 Creates a new HtmlOptions object specifiing callback. More...
 
 HtmlOptions ()
 Creates a new HtmlOptions object for saving into single HTML file. 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 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 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 System::SharedPtr< IProgressCallbackget_ProgressCallback ()=0
 Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...
 
virtual void set_ProgressCallback (System::SharedPtr< IProgressCallback > value)=0
 Represents a callback object for saving progress updates in percentage. See IProgressCallback. More...
 
virtual System::String get_DefaultRegularFont ()=0
 Returns font used in case source font is not found. Reads System::String. More...
 
virtual 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 System::SharedPtr< IHtmlFormatterget_HtmlFormatter ()=0
 Returns HTML template. Read IHtmlFormatter. More...
 
virtual void set_HtmlFormatter (System::SharedPtr< IHtmlFormatter > value)=0
 Sets HTML template. Write IHtmlFormatter. More...
 
virtual System::SharedPtr< ISlideImageFormatget_SlideImageFormat ()=0
 Returns slide image format options. Read ISlideImageFormat. More...
 
virtual void set_SlideImageFormat (System::SharedPtr< ISlideImageFormat > value)=0
 Sets slide image format options. Write ISlideImageFormat. More...
 
virtual bool get_ShowHiddenSlides ()=0
 Specifies whether the generated document should include hidden slides or not. Default is false. More...
 
virtual void set_ShowHiddenSlides (bool value)=0
 Specifies whether the generated document should include hidden slides or not. Default is false. More...
 
virtual uint8_t get_JpegQuality ()=0
 Returns a value determining the quality of the JPEG images inside PDF document. Read uint8_t. More...
 
virtual void set_JpegQuality (uint8_t value)=0
 Sets a value determining the quality of the JPEG images inside PDF document. Write uint8_t. More...
 
virtual Aspose::Slides::Export::PicturesCompression get_PicturesCompression ()=0
 Represents the pictures compression level Read PicturesCompression. More...
 
virtual void set_PicturesCompression (Aspose::Slides::Export::PicturesCompression value)=0
 Represents the pictures compression level Write PicturesCompression. More...
 
virtual bool get_DeletePicturesCroppedAreas ()=0
 A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file) Read bool. More...
 
virtual void set_DeletePicturesCroppedAreas (bool value)=0
 A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file) Write bool. More...
 
virtual bool get_SvgResponsiveLayout ()=0
 True to exclude width and height attributes from SVG container - that will make layout responsive. False - otherwise. Read bool. More...
 
virtual void set_SvgResponsiveLayout (bool value)=0
 True to exclude width and height attributes from SVG container - that will make layout responsive. False - otherwise. Write bool. More...
 
virtual System::SharedPtr< INotesCommentsLayoutingOptionsget_NotesCommentsLayouting ()=0
 Provides options that control how notes and comments is placed in exported document. 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

Represents a HTML exporting options.

Constructor & Destructor Documentation

◆ HtmlOptions() [1/2]

Aspose::Slides::Export::HtmlOptions::HtmlOptions ( System::SharedPtr< ILinkEmbedController linkEmbedController)

Creates a new HtmlOptions object specifiing callback.

Parameters
linkEmbedControllerCallback object which controls saving project.

◆ HtmlOptions() [2/2]

Aspose::Slides::Export::HtmlOptions::HtmlOptions ( )

Creates a new HtmlOptions object for saving into single HTML file.

Member Function Documentation

◆ get_DeletePicturesCroppedAreas()

bool Aspose::Slides::Export::HtmlOptions::get_DeletePicturesCroppedAreas ( )
overridevirtual

A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file)

Implements Aspose::Slides::Export::IHtmlOptions.

◆ get_HtmlFormatter()

System::SharedPtr< IHtmlFormatter > Aspose::Slides::Export::HtmlOptions::get_HtmlFormatter ( )
overridevirtual

Returns HTML template. Read IHtmlFormatter.

Implements Aspose::Slides::Export::IHtmlOptions.

◆ get_JpegQuality()

uint8_t Aspose::Slides::Export::HtmlOptions::get_JpegQuality ( )
overridevirtual

Returns a value determining the quality of the JPEG images inside PDF document. Read uint8_t.

Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 95.

Implements Aspose::Slides::Export::IHtmlOptions.

◆ get_NotesCommentsLayouting()

System::SharedPtr< INotesCommentsLayoutingOptions > Aspose::Slides::Export::HtmlOptions::get_NotesCommentsLayouting ( )
overridevirtual

Provides options that control how notes and comments is placed in exported document.

Implements Aspose::Slides::Export::IHtmlOptions.

◆ get_PicturesCompression()

Aspose::Slides::Export::PicturesCompression Aspose::Slides::Export::HtmlOptions::get_PicturesCompression ( )
overridevirtual

Represents the pictures compression level

Implements Aspose::Slides::Export::IHtmlOptions.

◆ get_ShowHiddenSlides()

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

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

Implements Aspose::Slides::Export::IHtmlOptions.

◆ get_SlideImageFormat()

System::SharedPtr< ISlideImageFormat > Aspose::Slides::Export::HtmlOptions::get_SlideImageFormat ( )
overridevirtual

Returns slide image format options. Read ISlideImageFormat.

Implements Aspose::Slides::Export::IHtmlOptions.

◆ get_SvgResponsiveLayout()

bool Aspose::Slides::Export::HtmlOptions::get_SvgResponsiveLayout ( )
overridevirtual

True to exclude width and height attributes from svg container - that will make layout responsive. False - otherwise. Read bool.

Implements Aspose::Slides::Export::IHtmlOptions.

◆ set_DeletePicturesCroppedAreas()

void Aspose::Slides::Export::HtmlOptions::set_DeletePicturesCroppedAreas ( bool  value)
overridevirtual

A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file)

Implements Aspose::Slides::Export::IHtmlOptions.

◆ set_HtmlFormatter()

void Aspose::Slides::Export::HtmlOptions::set_HtmlFormatter ( System::SharedPtr< IHtmlFormatter value)
overridevirtual

Sets HTML template. Write IHtmlFormatter.

Implements Aspose::Slides::Export::IHtmlOptions.

◆ set_JpegQuality()

void Aspose::Slides::Export::HtmlOptions::set_JpegQuality ( uint8_t  value)
overridevirtual

Sets a value determining the quality of the JPEG images inside PDF document. Write uint8_t.

Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 95.

Implements Aspose::Slides::Export::IHtmlOptions.

◆ set_PicturesCompression()

void Aspose::Slides::Export::HtmlOptions::set_PicturesCompression ( Aspose::Slides::Export::PicturesCompression  value)
overridevirtual

Represents the pictures compression level

Implements Aspose::Slides::Export::IHtmlOptions.

◆ set_ShowHiddenSlides()

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

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

Implements Aspose::Slides::Export::IHtmlOptions.

◆ set_SlideImageFormat()

void Aspose::Slides::Export::HtmlOptions::set_SlideImageFormat ( System::SharedPtr< ISlideImageFormat value)
overridevirtual

Sets slide image format options. Write ISlideImageFormat.

Implements Aspose::Slides::Export::IHtmlOptions.

◆ set_SvgResponsiveLayout()

void Aspose::Slides::Export::HtmlOptions::set_SvgResponsiveLayout ( bool  value)
overridevirtual

True to exclude width and height attributes from svg container - that will make layout responsive. False - otherwise. Write bool.

Implements Aspose::Slides::Export::IHtmlOptions.