Aspose::Slides::Export::SwfOptions Class Reference

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

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

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_Compressed () override
 Specifies whether the generated SWF document should be compressed or not. Default is true. More...
 
void set_Compressed (bool value) override
 Specifies whether the generated SWF document should be compressed or not. Default is true. More...
 
bool get_ViewerIncluded () override
 Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true. More...
 
void set_ViewerIncluded (bool value) override
 Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true. More...
 
bool get_ShowPageBorder () override
 Specifies whether border around pages should be shown. Default is true. More...
 
void set_ShowPageBorder (bool value) override
 Specifies whether border around pages should be shown. Default is true. More...
 
bool get_ShowFullScreen () override
 Show/hide fullscreen button. Can be overridden in flashvars. Default is true. More...
 
void set_ShowFullScreen (bool value) override
 Show/hide fullscreen button. Can be overridden in flashvars. Default is true. More...
 
bool get_ShowPageStepper () override
 Show/hide page stepper. Can be overridden in flashvars. Default is true. More...
 
void set_ShowPageStepper (bool value) override
 Show/hide page stepper. Can be overridden in flashvars. Default is true. More...
 
bool get_ShowSearch () override
 Show/hide search section. Can be overridden in flashvars. Default is true. More...
 
void set_ShowSearch (bool value) override
 Show/hide search section. Can be overridden in flashvars. Default is true. More...
 
bool get_ShowTopPane () override
 Show/hide whole top pane. Can be overridden in flashvars. Default is true. More...
 
void set_ShowTopPane (bool value) override
 Show/hide whole top pane. Can be overridden in flashvars. Default is true. More...
 
bool get_ShowBottomPane () override
 Show/hide bottom pane. Can be overridden in flashvars. Default is true. More...
 
void set_ShowBottomPane (bool value) override
 Show/hide bottom pane. Can be overridden in flashvars. Default is true. More...
 
bool get_ShowLeftPane () override
 Show/hide left pane. Can be overridden in flashvars. Default is true. More...
 
void set_ShowLeftPane (bool value) override
 Show/hide left pane. Can be overridden in flashvars. Default is true. More...
 
bool get_StartOpenLeftPane () override
 Start with opened left pane. Can be overridden in flashvars. Default is false. More...
 
void set_StartOpenLeftPane (bool value) override
 Start with opened left pane. Can be overridden in flashvars. Default is false. More...
 
bool get_EnableContextMenu () override
 Enable/disable context menu. Default is true. More...
 
void set_EnableContextMenu (bool value) override
 Enable/disable context menu. Default is true. More...
 
System::ArrayPtr< uint8_tget_LogoImageBytes () override
 Image that will be displayed as logo in the top right corner of the viewer. Image should be 32x64 pixels PNG image, otherwise logo can be displayed improperly. More...
 
void set_LogoImageBytes (System::ArrayPtr< uint8_t > value) override
 Image that will be displayed as logo in the top right corner of the viewer. Image should be 32x64 pixels PNG image, otherwise logo can be displayed improperly. More...
 
System::String get_LogoLink () override
 Gets the full hyperlink address for a logo. Has an effect only if a set_LogoImageBytes() is specified. More...
 
void set_LogoLink (System::String value) override
 Sets the full hyperlink address for a logo. Has an effect only if a set_LogoImageBytes() is specified. More...
 
int32_t get_JpegQuality () override
 Specifies the quality of JPEG images. Default is 95. More...
 
void set_JpegQuality (int32_t value) override
 Specifies the quality of JPEG images. Default is 95. More...
 
System::SharedPtr< INotesCommentsLayoutingOptionsget_NotesCommentsLayouting () override
 Provides options that control how notes and comments is placed in exported document. More...
 
 SwfOptions ()
 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...
 
- 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...
 

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

Constructor & Destructor Documentation

◆ SwfOptions()

Aspose::Slides::Export::SwfOptions::SwfOptions ( )

Default constructor.

Member Function Documentation

◆ get_Compressed()

bool Aspose::Slides::Export::SwfOptions::get_Compressed ( )
overridevirtual

Specifies whether the generated SWF document should be compressed or not. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_EnableContextMenu()

bool Aspose::Slides::Export::SwfOptions::get_EnableContextMenu ( )
overridevirtual

Enable/disable context menu. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_JpegQuality()

int32_t Aspose::Slides::Export::SwfOptions::get_JpegQuality ( )
overridevirtual

Specifies the quality of JPEG images. Default is 95.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_LogoImageBytes()

System::ArrayPtr<uint8_t> Aspose::Slides::Export::SwfOptions::get_LogoImageBytes ( )
overridevirtual

Image that will be displayed as logo in the top right corner of the viewer. Image should be 32x64 pixels PNG image, otherwise logo can be displayed improperly.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_LogoLink()

System::String Aspose::Slides::Export::SwfOptions::get_LogoLink ( )
overridevirtual

Gets the full hyperlink address for a logo. Has an effect only if a set_LogoImageBytes() is specified.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_NotesCommentsLayouting()

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

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

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ShowBottomPane()

bool Aspose::Slides::Export::SwfOptions::get_ShowBottomPane ( )
overridevirtual

Show/hide bottom pane. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ShowFullScreen()

bool Aspose::Slides::Export::SwfOptions::get_ShowFullScreen ( )
overridevirtual

Show/hide fullscreen button. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ShowHiddenSlides()

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

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

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ShowLeftPane()

bool Aspose::Slides::Export::SwfOptions::get_ShowLeftPane ( )
overridevirtual

Show/hide left pane. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ShowPageBorder()

bool Aspose::Slides::Export::SwfOptions::get_ShowPageBorder ( )
overridevirtual

Specifies whether border around pages should be shown. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ShowPageStepper()

bool Aspose::Slides::Export::SwfOptions::get_ShowPageStepper ( )
overridevirtual

Show/hide page stepper. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ShowSearch()

bool Aspose::Slides::Export::SwfOptions::get_ShowSearch ( )
overridevirtual

Show/hide search section. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ShowTopPane()

bool Aspose::Slides::Export::SwfOptions::get_ShowTopPane ( )
overridevirtual

Show/hide whole top pane. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_StartOpenLeftPane()

bool Aspose::Slides::Export::SwfOptions::get_StartOpenLeftPane ( )
overridevirtual

Start with opened left pane. Can be overridden in flashvars. Default is false.

Implements Aspose::Slides::Export::ISwfOptions.

◆ get_ViewerIncluded()

bool Aspose::Slides::Export::SwfOptions::get_ViewerIncluded ( )
overridevirtual

Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_Compressed()

void Aspose::Slides::Export::SwfOptions::set_Compressed ( bool  value)
overridevirtual

Specifies whether the generated SWF document should be compressed or not. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_EnableContextMenu()

void Aspose::Slides::Export::SwfOptions::set_EnableContextMenu ( bool  value)
overridevirtual

Enable/disable context menu. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_JpegQuality()

void Aspose::Slides::Export::SwfOptions::set_JpegQuality ( int32_t  value)
overridevirtual

Specifies the quality of JPEG images. Default is 95.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_LogoImageBytes()

void Aspose::Slides::Export::SwfOptions::set_LogoImageBytes ( System::ArrayPtr< uint8_t value)
overridevirtual

Image that will be displayed as logo in the top right corner of the viewer. Image should be 32x64 pixels PNG image, otherwise logo can be displayed improperly.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_LogoLink()

void Aspose::Slides::Export::SwfOptions::set_LogoLink ( System::String  value)
overridevirtual

Sets the full hyperlink address for a logo. Has an effect only if a set_LogoImageBytes() is specified.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ShowBottomPane()

void Aspose::Slides::Export::SwfOptions::set_ShowBottomPane ( bool  value)
overridevirtual

Show/hide bottom pane. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ShowFullScreen()

void Aspose::Slides::Export::SwfOptions::set_ShowFullScreen ( bool  value)
overridevirtual

Show/hide fullscreen button. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ShowHiddenSlides()

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

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

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ShowLeftPane()

void Aspose::Slides::Export::SwfOptions::set_ShowLeftPane ( bool  value)
overridevirtual

Show/hide left pane. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ShowPageBorder()

void Aspose::Slides::Export::SwfOptions::set_ShowPageBorder ( bool  value)
overridevirtual

Specifies whether border around pages should be shown. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ShowPageStepper()

void Aspose::Slides::Export::SwfOptions::set_ShowPageStepper ( bool  value)
overridevirtual

Show/hide page stepper. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ShowSearch()

void Aspose::Slides::Export::SwfOptions::set_ShowSearch ( bool  value)
overridevirtual

Show/hide search section. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ShowTopPane()

void Aspose::Slides::Export::SwfOptions::set_ShowTopPane ( bool  value)
overridevirtual

Show/hide whole top pane. Can be overridden in flashvars. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_StartOpenLeftPane()

void Aspose::Slides::Export::SwfOptions::set_StartOpenLeftPane ( bool  value)
overridevirtual

Start with opened left pane. Can be overridden in flashvars. Default is false.

Implements Aspose::Slides::Export::ISwfOptions.

◆ set_ViewerIncluded()

void Aspose::Slides::Export::SwfOptions::set_ViewerIncluded ( bool  value)
overridevirtual

Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.

Implements Aspose::Slides::Export::ISwfOptions.