com.aspose.slides

Interface ISwfOptions

All Superinterfaces:

ISaveOptions

All Known Implementing Classes:

SwfOptions

public interface ISwfOptions
extends ISaveOptions

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

Method Summary

Modifier and Type	Method and Description
boolean	getCompressed() Specifies whether the generated SWF document should be compressed or not.
boolean	getEnableContextMenu() Enable/disable context menu.
int	getJpegQuality() Specifies the quality of JPEG images.
byte[]	getLogoImageBytes() Image that will be displayed as logo in the top right corner of the viewer.
java.lang.String	getLogoLink() Gets or sets the full hyperlink address for a logo.
INotesCommentsLayoutingOptions	getNotesCommentsLayouting() Deprecated. Use SlidesLayoutOptions property. The property NotesCommentsLayouting will be removed after release of version 25.8.
boolean	getShowBottomPane() Show/hide bottom pane.
boolean	getShowFullScreen() Show/hide fullscreen button.
boolean	getShowHiddenSlides() Specifies whether the generated document should include hidden slides or not.
boolean	getShowLeftPane() Show/hide left pane.
boolean	getShowPageBorder() Specifies whether border around pages should be shown.
boolean	getShowPageStepper() Show/hide page stepper.
boolean	getShowSearch() Show/hide search section.
boolean	getShowTopPane() Show/hide whole top pane.
ISlidesLayoutOptions	getSlidesLayoutOptions() Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
boolean	getStartOpenLeftPane() Start with opened left pane.
boolean	getViewerIncluded() Specifies whether the generated SWF document should include the integrated document viewer or not.
void	setCompressed(boolean value) Specifies whether the generated SWF document should be compressed or not.
void	setEnableContextMenu(boolean value) Enable/disable context menu.
void	setJpegQuality(int value) Specifies the quality of JPEG images.
void	setLogoImageBytes(byte[] value) Image that will be displayed as logo in the top right corner of the viewer.
void	setLogoLink(java.lang.String value) Gets or sets the full hyperlink address for a logo.
void	setShowBottomPane(boolean value) Show/hide bottom pane.
void	setShowFullScreen(boolean value) Show/hide fullscreen button.
void	setShowHiddenSlides(boolean value) Specifies whether the generated document should include hidden slides or not.
void	setShowLeftPane(boolean value) Show/hide left pane.
void	setShowPageBorder(boolean value) Specifies whether border around pages should be shown.
void	setShowPageStepper(boolean value) Show/hide page stepper.
void	setShowSearch(boolean value) Show/hide search section.
void	setShowTopPane(boolean value) Show/hide whole top pane.
void	setSlidesLayoutOptions(ISlidesLayoutOptions value) Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
void	setStartOpenLeftPane(boolean value) Start with opened left pane.
void	setViewerIncluded(boolean value) Specifies whether the generated SWF document should include the integrated document viewer or not.

Methods inherited from interface com.aspose.slides.ISaveOptions

getDefaultRegularFont, getGradientStyle, getProgressCallback, getSkipJavaScriptLinks, getWarningCallback, setDefaultRegularFont, setGradientStyle, setProgressCallback, setSkipJavaScriptLinks, setWarningCallback

Method Detail

getCompressed

boolean getCompressed()

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

setCompressed

void setCompressed(boolean value)

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

getViewerIncluded

boolean getViewerIncluded()

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

setViewerIncluded

void setViewerIncluded(boolean value)

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

getShowPageBorder

boolean getShowPageBorder()

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

setShowPageBorder

void setShowPageBorder(boolean value)

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

getShowHiddenSlides

boolean getShowHiddenSlides()

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

setShowHiddenSlides

void setShowHiddenSlides(boolean value)

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

getShowFullScreen

boolean getShowFullScreen()

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

setShowFullScreen

void setShowFullScreen(boolean value)

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

getShowPageStepper

boolean getShowPageStepper()

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

setShowPageStepper

void setShowPageStepper(boolean value)

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

getShowSearch

boolean getShowSearch()

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

setShowSearch

void setShowSearch(boolean value)

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

getShowTopPane

boolean getShowTopPane()

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

setShowTopPane

void setShowTopPane(boolean value)

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

getShowBottomPane

boolean getShowBottomPane()

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

setShowBottomPane

void setShowBottomPane(boolean value)

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

getShowLeftPane

boolean getShowLeftPane()

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

setShowLeftPane

void setShowLeftPane(boolean value)

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

getStartOpenLeftPane

boolean getStartOpenLeftPane()

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

setStartOpenLeftPane

void setStartOpenLeftPane(boolean value)

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

getEnableContextMenu

boolean getEnableContextMenu()

Enable/disable context menu. Default is true.

setEnableContextMenu

void setEnableContextMenu(boolean value)

Enable/disable context menu. Default is true.

getLogoImageBytes

byte[] getLogoImageBytes()

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.

setLogoImageBytes

void setLogoImageBytes(byte[] value)

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.

getLogoLink

java.lang.String getLogoLink()

Gets or sets the full hyperlink address for a logo. Has an effect only if a (getLogoImageBytes()/setLogoImageBytes(byte[])) is specified.

setLogoLink

void setLogoLink(java.lang.String value)

Gets or sets the full hyperlink address for a logo. Has an effect only if a (getLogoImageBytes()/setLogoImageBytes(byte[])) is specified.

getJpegQuality

int getJpegQuality()

Specifies the quality of JPEG images. Default is 95.

setJpegQuality

void setJpegQuality(int value)

Specifies the quality of JPEG images. Default is 95.

getNotesCommentsLayouting

@Deprecated
INotesCommentsLayoutingOptions getNotesCommentsLayouting()

Deprecated. Use SlidesLayoutOptions property. The property NotesCommentsLayouting will be removed after release of version 25.8.

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

getSlidesLayoutOptions

ISlidesLayoutOptions getSlidesLayoutOptions()

Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions. This property doesn't support assigning objects of type HandoutLayoutingOptions

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     NotesCommentsLayoutingOptions notesOptions = new NotesCommentsLayoutingOptions();
     notesOptions.setCommentsPosition(CommentsPositions.Right);

     SwfOptions options = new SwfOptions();
     options.setSlidesLayoutOptions(notesOptions);

     pres.save("pres.swf", SaveFormat.Swf, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

setSlidesLayoutOptions

void setSlidesLayoutOptions(ISlidesLayoutOptions value)

Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions. This property doesn't support assigning objects of type HandoutLayoutingOptions

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     NotesCommentsLayoutingOptions notesOptions = new NotesCommentsLayoutingOptions();
     notesOptions.setCommentsPosition(CommentsPositions.Right);

     SwfOptions options = new SwfOptions();
     options.setSlidesLayoutOptions(notesOptions);

     pres.save("pres.swf", SaveFormat.Swf, options);
 } finally {
     if (pres != null) pres.dispose();
 }