SwfOptions

SwfOptions class

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

class SwfOptions : public Aspose::Slides::Export::SaveOptions,
                   public Aspose::Slides::Export::ISwfOptions

Methods

MethodDescription
virtual bool Equals(ptr)Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares value type objects in C# style.
static bool Equals(float const&, float const&)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.
static bool Equals(double const&, double const&)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.
virtual bool FastCast(const Details::FastRttiBase&, void **) constFor internal purposes only.
bool get_Compressed() overrideSpecifies whether the generated SWF document should be compressed or not. Default is true.
System::String get_DefaultRegularFont() overrideReturns font used in case source font is not found. Reads System::String.
bool get_EnableContextMenu() overrideEnable/disable context menu. Default is true.
Aspose::Slides::GradientStyle get_GradientStyle() overrideReturns the visual style of the gradient. Read GradientStyle.
int32_t get_JpegQuality() overrideSpecifies the quality of JPEG images. Default is 95.
System::ArrayPtr<uint8_t> get_LogoImageBytes() overrideImage 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.
System::String get_LogoLink() overrideGets the full hyperlink address for a logo. Has an effect only if a set_LogoImageBytes() is specified.
System::SharedPtr<INotesCommentsLayoutingOptions> get_NotesCommentsLayouting() overrideProvides options that control how notes and comments is placed in exported document.
System::SharedPtr<IProgressCallback> get_ProgressCallback() overrideRepresents a callback object for saving progress updates in percentage. See IProgressCallback.
bool get_ShowBottomPane() overrideShow/hide bottom pane. Can be overridden in flashvars. Default is true.
bool get_ShowFullScreen() overrideShow/hide fullscreen button. Can be overridden in flashvars. Default is true.
bool get_ShowHiddenSlides() overrideSpecifies whether the generated document should include hidden slides or not. Default is false.
bool get_ShowLeftPane() overrideShow/hide left pane. Can be overridden in flashvars. Default is true.
bool get_ShowPageBorder() overrideSpecifies whether border around pages should be shown. Default is true.
bool get_ShowPageStepper() overrideShow/hide page stepper. Can be overridden in flashvars. Default is true.
bool get_ShowSearch() overrideShow/hide search section. Can be overridden in flashvars. Default is true.
bool get_ShowTopPane() overrideShow/hide whole top pane. Can be overridden in flashvars. Default is true.
bool get_StartOpenLeftPane() overrideStart with opened left pane. Can be overridden in flashvars. Default is false.
bool get_ViewerIncluded() overrideSpecifies whether the generated SWF document should include the integrated document viewer or not. Default is true.
System::SharedPtr<Aspose::Slides::Warnings::IWarningCallback> get_WarningCallback() overrideReturns of sets an object which receives warnings and decides whether loading process will continue or will be aborted. Read Aspose::Slides::Warnings::IWarningCallback.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) constCheck if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() constAnalog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()Creates object. Initializes all internal data structures.
Object(Object const&)Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)Decreases shared reference count by specified value.
SaveOptions()
void set_Compressed(bool) overrideSpecifies whether the generated SWF document should be compressed or not. Default is true.
void set_DefaultRegularFont(System::String) overrideSets font used in case source font is not found. Writes System::String.
void set_EnableContextMenu(bool) overrideEnable/disable context menu. Default is true.
void set_GradientStyle(Aspose::Slides::GradientStyle) overrideSets the visual style of the gradient. Write GradientStyle.
void set_JpegQuality(int32_t) overrideSpecifies the quality of JPEG images. Default is 95.
void set_LogoImageBytes(System::ArrayPtr<uint8_t>) overrideImage 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.
void set_LogoLink(System::String) overrideSets the full hyperlink address for a logo. Has an effect only if a set_LogoImageBytes() is specified.
void set_ProgressCallback(System::SharedPtr<IProgressCallback>) overrideRepresents a callback object for saving progress updates in percentage. See IProgressCallback.
void set_ShowBottomPane(bool) overrideShow/hide bottom pane. Can be overridden in flashvars. Default is true.
void set_ShowFullScreen(bool) overrideShow/hide fullscreen button. Can be overridden in flashvars. Default is true.
void set_ShowHiddenSlides(bool) overrideSpecifies whether the generated document should include hidden slides or not. Default is false.
void set_ShowLeftPane(bool) overrideShow/hide left pane. Can be overridden in flashvars. Default is true.
void set_ShowPageBorder(bool) overrideSpecifies whether border around pages should be shown. Default is true.
void set_ShowPageStepper(bool) overrideShow/hide page stepper. Can be overridden in flashvars. Default is true.
void set_ShowSearch(bool) overrideShow/hide search section. Can be overridden in flashvars. Default is true.
void set_ShowTopPane(bool) overrideShow/hide whole top pane. Can be overridden in flashvars. Default is true.
void set_StartOpenLeftPane(bool) overrideStart with opened left pane. Can be overridden in flashvars. Default is false.
void set_ViewerIncluded(bool) overrideSpecifies whether the generated SWF document should include the integrated document viewer or not. Default is true.
void set_WarningCallback(System::SharedPtr<Aspose::Slides::Warnings::IWarningCallback>) overrideReturns of sets an object which receives warnings and decides whether loading process will continue or will be aborted. Write Aspose::Slides::Warnings::IWarningCallback.
virtual void SetTemplateWeakPtr(uint32_t)Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() constGets current value of shared reference counter.
Object * SharedRefAdded()Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
SwfOptions()Default constructor.
virtual String ToString() constAnalog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()Implements C# typeof(System.Object) construct.
void Unlock()Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual ~Object()Destroys object. Frees all internal data structures.

Remarks

The following example shows how to convert PowerPoint to SWF Flash.

auto presentation = System::MakeObject<Presentation>(u"HelloWorld.pptx");
auto swfOptions = System::MakeObject<SwfOptions>();

swfOptions->set_ViewerIncluded(false);
auto notesOptions = swfOptions->get_NotesCommentsLayouting();
notesOptions->set_NotesPosition(NotesPositions::BottomFull);

// Saving presentation and notes pages
presentation->Save(u"SaveAsSwf_out.swf", SaveFormat::Swf, swfOptions);
swfOptions->set_ViewerIncluded(true);
presentation->Save(u"SaveNotes_out.swf", SaveFormat::Swf, swfOptions);

See Also