com.aspose.words
Class SwfSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by FixedPageSaveOptions
          extended by com.aspose.words.SwfSaveOptions
All Implemented Interfaces:
java.lang.Cloneable

public class SwfSaveOptions 
extends FixedPageSaveOptions

Can be used to specify additional options when saving a document into the #Error Cref: F:Aspose.Words.SaveFormat.Swf format.

Constructor Summary
SwfSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the #Error Cref: F:Aspose.Words.SaveFormat.Swf format.
 
Property Getters/Setters Summary
booleangetAllowReadMode()
voidsetAllowReadMode(boolean value)
           Allows to enable read mode. Can be overridden in flashvars. Default is true.
intgetBookmarksOutlineLevel()
voidsetBookmarksOutlineLevel(int value)
           Specifies the level in the SWF document outline at which to display Word bookmarks.
intgetColorMode()→ inherited from SaveOptions
voidsetColorMode(int value)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
booleangetCompressed()
voidsetCompressed(boolean value)
           Specifies whether the generated SWF document should be compressed or not. Default is true.
java.lang.StringgetDefaultTemplate()→ inherited from SaveOptions
voidsetDefaultTemplate(java.lang.String value)
           Gets or sets path to default template (including filename). Default value for this property is #Error Cref: F:System.String.Empty
intgetDmlEffectsRenderingMode()→ inherited from SaveOptions
voidsetDmlEffectsRenderingMode(int value)
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()→ inherited from SaveOptions
voidsetDmlRenderingMode(int value)
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
booleangetEnableContextMenu()
voidsetEnableContextMenu(boolean value)
           Enable/disable context menu. Can be overridden in flashvars. Default is true.
intgetExpandedOutlineLevels()
voidsetExpandedOutlineLevels(int value)
           Specifies how many levels in the SWF document outline to show expanded when the SWF file is viewed.
intgetHeadingsOutlineLevels()
voidsetHeadingsOutlineLevels(int value)
           Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the SWF document outline.
intgetJpegQuality()→ inherited from FixedPageSaveOptions
voidsetJpegQuality(int value)
           Gets or sets a value determining the quality of the JPEG images inside Html document.
intgetLeftPaneControlFlags()
voidsetLeftPaneControlFlags(int value)
           Control flags used to configure appearance of left panel of SWF viewer. Default is SwfLeftPaneControlFlags.SHOW_ALL. The value of the property is SwfLeftPaneControlFlags integer constant.
byte[]getLogoImageBytes()
voidsetLogoImageBytes(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.
java.lang.StringgetLogoLink()
voidsetLogoLink(java.lang.String value)
           Gets or sets the full hyperlink address for a logo.
booleangetMemoryOptimization()→ inherited from SaveOptions
voidsetMemoryOptimization(boolean value)
           Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
MetafileRenderingOptionsgetMetafileRenderingOptions()→ inherited from FixedPageSaveOptions
voidsetMetafileRenderingOptions(MetafileRenderingOptions value)
           Allows to specify metafile rendering options.
intgetNumeralFormat()→ inherited from FixedPageSaveOptions
voidsetNumeralFormat(int value)
           Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant.
booleangetOptimizeOutput()→ inherited from FixedPageSaveOptions
voidsetOptimizeOutput(boolean value)
           Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
OutlineOptionsgetOutlineOptions()
           Allows to specify outline options.
intgetPageCount()→ inherited from FixedPageSaveOptions
voidsetPageCount(int value)
           Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.
intgetPageIndex()→ inherited from FixedPageSaveOptions
voidsetPageIndex(int value)
           Gets or sets the 0-based index of the first page to save. Default is 0.
IPageSavingCallbackgetPageSavingCallback()→ inherited from FixedPageSaveOptions
voidsetPageSavingCallback(IPageSavingCallback value)
           Allows to control how separate pages are saved when a document is exported to fixed page format.
booleangetPrettyFormat()→ inherited from SaveOptions
voidsetPrettyFormat(boolean value)
           When true, pretty formats output where applicable. Default value is false.
Aspose.Words.SaveFormatgetSaveFormat()
           Specifies the format in which the document will be saved if this save options object is used. Can only be #Error Cref: F:Aspose.Words.SaveFormat.Swf.
booleangetShowBottomPane()
voidsetShowBottomPane(boolean value)
           Show/hide bottom pane. Can be overridden in flashvars. Default is true.
booleangetShowFullScreen()
voidsetShowFullScreen(boolean value)
           Show/hide fullscreen button. Can be overridden in flashvars. Default is true.
booleangetShowLeftPane()
voidsetShowLeftPane(boolean value)
           Show/hide left pane. Can be overridden in flashvars. Default is true.
booleangetShowPageBorder()
voidsetShowPageBorder(boolean value)
           Specifies whether border around pages should be shown. Default is true.
booleangetShowPageStepper()
voidsetShowPageStepper(boolean value)
           Show/hide page stepper. Can be overridden in flashvars. Default is true.
booleangetShowSearch()
voidsetShowSearch(boolean value)
           Show/hide search section. Can be overridden in flashvars. Default is true.
booleangetShowTopPane()
voidsetShowTopPane(boolean value)
           Show/hide whole top pane. Can be overridden in flashvars. Default is true.
booleangetStartOpenLeftPane()
voidsetStartOpenLeftPane(boolean value)
           Start with opened left pane. Can be overridden in flashvars. Default is false.
java.lang.StringgetTempFolder()→ inherited from SaveOptions
voidsetTempFolder(java.lang.String value)
           Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.
SwfToolTipsgetToolTips()
           Gets or sets tooltips used in SWF viewer. Default is Arial.
java.lang.StringgetToolTipsFontName()
voidsetToolTipsFontName(java.lang.String value)
           Gets or sets font used for tooltips in SWF viewer. Default is Arial.
intgetTopPaneControlFlags()
voidsetTopPaneControlFlags(int value)
           Control flags used to configure appearance of top panel of SWF viewer. Default is SwfTopPaneControlFlags.SHOW_ALL. The value of the property is SwfTopPaneControlFlags integer constant.
booleangetUpdateFields()→ inherited from SaveOptions
voidsetUpdateFields(boolean value)
           Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true
booleangetUpdateLastSavedTimeProperty()→ inherited from SaveOptions
voidsetUpdateLastSavedTimeProperty(boolean value)
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()→ inherited from SaveOptions
voidsetUpdateSdtContent(boolean value)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()→ inherited from SaveOptions
voidsetUseAntiAliasing(boolean value)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()→ inherited from SaveOptions
voidsetUseHighQualityRendering(boolean value)
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
booleangetViewerIncluded()
voidsetViewerIncluded(boolean value)
           Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.
Aspose.Words.IWarningCallbackgetWarningCallback()→ inherited from SaveOptions
           Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.
 
Method Summary
SwfSaveOptionsdeepClone()
           Creates a deep clone of this object.
booleanequals(java.lang.Object obj)→ inherited from FixedPageSaveOptions
          
 

Constructor Detail

SwfSaveOptions

public SwfSaveOptions()
Initializes a new instance of this class that can be used to save a document in the #Error Cref: F:Aspose.Words.SaveFormat.Swf format.

Property Getters/Setters Detail

getAllowReadMode/setAllowReadMode

public boolean getAllowReadMode() / public void setAllowReadMode(boolean value)
Allows to enable read mode. Can be overridden in flashvars. Default is true.

Has an effect only if ViewerIncluded is true.


getBookmarksOutlineLevel/setBookmarksOutlineLevel

public int getBookmarksOutlineLevel() / public void setBookmarksOutlineLevel(int value)
Specifies the level in the SWF document outline at which to display Word bookmarks.

Specify 0 and Word bookmarks will not be displayed in the SWF document outline. Specify 1 and Word bookmarks will be displayed in the PDF document outline at level 1; 2 for level 2 and so on.

Default is 0. Valid range is 0 to 9.

Has an effect only if ViewerIncluded is true.


getColorMode/setColorMode

→ inherited from SaveOptions
public int getColorMode() / public void setColorMode(int value)
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.The default value is ColorMode.NORMAL

This property is used when the document is exported to fixed page formats.


getCompressed/setCompressed

public boolean getCompressed() / public void setCompressed(boolean value)
Specifies whether the generated SWF document should be compressed or not. Default is true.

getDefaultTemplate/setDefaultTemplate

→ inherited from SaveOptions
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value)
Gets or sets path to default template (including filename). Default value for this property is #Error Cref: F:System.String.EmptyIf specified, this path is used to load template when #Error Cref: P:Aspose.Words.Document.AutomaticallyUpdateSyles is true, but #Error Cref: P:Aspose.Words.Document.AttachedTemplate is empty.

getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

→ inherited from SaveOptions
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value)
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. The default value is DmlEffectsRenderingMode.SIMPLIFIED.

This property is used when the document is exported to fixed page formats.


getDmlRenderingMode/setDmlRenderingMode

→ inherited from SaveOptions
public int getDmlRenderingMode() / public void setDmlRenderingMode(int value)
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. The default value is DmlRenderingMode.FALLBACK.

This property is used when the document is exported to fixed page formats.


getEnableContextMenu/setEnableContextMenu

public boolean getEnableContextMenu() / public void setEnableContextMenu(boolean value)
Enable/disable context menu. Can be overridden in flashvars. Default is true.

Has an effect only if ViewerIncluded is true.


getExpandedOutlineLevels/setExpandedOutlineLevels

public int getExpandedOutlineLevels() / public void setExpandedOutlineLevels(int value)
Specifies how many levels in the SWF document outline to show expanded when the SWF file is viewed.

Specify 0 and the document outline will be collapsed; specify 1 and the first level items in the outline will be expanded and so on.

Default is 0. Valid range is 0 to 9.

Has an effect only if ViewerIncluded is true.


getHeadingsOutlineLevels/setHeadingsOutlineLevels

public int getHeadingsOutlineLevels() / public void setHeadingsOutlineLevels(int value)
Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the SWF document outline.

Specify 0 for no headings in the outline; specify 1 for one level of headings in the outline and so on.

Default is 0. Valid range is 0 to 9.

Has an effect only if ViewerIncluded is true.


getJpegQuality/setJpegQuality

→ inherited from FixedPageSaveOptions
public int getJpegQuality() / public void setJpegQuality(int value)
Gets or sets a value determining the quality of the JPEG images inside Html document.

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 fixed page 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.


getLeftPaneControlFlags/setLeftPaneControlFlags

public int getLeftPaneControlFlags() / public void setLeftPaneControlFlags(int value)
Control flags used to configure appearance of left panel of SWF viewer. Default is SwfLeftPaneControlFlags.SHOW_ALL. The value of the property is SwfLeftPaneControlFlags integer constant.

Has an effect only if ViewerIncluded is true.


getLogoImageBytes/setLogoImageBytes

public byte[] getLogoImageBytes() / public 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.

Has an effect only if ViewerIncluded is true.

When null no logo is displayed.


getLogoLink/setLogoLink

public java.lang.String getLogoLink() / public void setLogoLink(java.lang.String value)
Gets or sets the full hyperlink address for a logo.

Has an effect only if ViewerIncluded is true and LogoImageBytes is specified.

Set to null or empty string to specify no hyperlink.


getMemoryOptimization/setMemoryOptimization

→ inherited from SaveOptions
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value)
Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.

getMetafileRenderingOptions/setMetafileRenderingOptions

→ inherited from FixedPageSaveOptions
public MetafileRenderingOptions getMetafileRenderingOptions() / public void setMetafileRenderingOptions(MetafileRenderingOptions value)
Allows to specify metafile rendering options.

getNumeralFormat/setNumeralFormat

→ inherited from FixedPageSaveOptions
public int getNumeralFormat() / public void setNumeralFormat(int value)
Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant. If the value of this property is changed and page layout is already built then #Error Cref: M:Aspose.Words.Document.UpdatePageLayout is invoked automatically to update any changes.

getOptimizeOutput/setOptimizeOutput

→ inherited from FixedPageSaveOptions
public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value)
Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.

getOutlineOptions

public OutlineOptions getOutlineOptions()
Allows to specify outline options.

Note that outline options has effect only if ViewerIncluded is true.


getPageCount/setPageCount

→ inherited from FixedPageSaveOptions
public int getPageCount() / public void setPageCount(int value)
Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.

getPageIndex/setPageIndex

→ inherited from FixedPageSaveOptions
public int getPageIndex() / public void setPageIndex(int value)
Gets or sets the 0-based index of the first page to save. Default is 0.

getPageSavingCallback/setPageSavingCallback

→ inherited from FixedPageSaveOptions
public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value)
Allows to control how separate pages are saved when a document is exported to fixed page format.

getPrettyFormat/setPrettyFormat

→ inherited from SaveOptions
public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
When true, pretty formats output where applicable. Default value is false.

Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.


getSaveFormat

public Aspose.Words.SaveFormat getSaveFormat()
Specifies the format in which the document will be saved if this save options object is used. Can only be #Error Cref: F:Aspose.Words.SaveFormat.Swf.

getShowBottomPane/setShowBottomPane

public boolean getShowBottomPane() / public void setShowBottomPane(boolean value)
Show/hide bottom pane. Can be overridden in flashvars. Default is true.

Has an effect only if ViewerIncluded is true.


getShowFullScreen/setShowFullScreen

public boolean getShowFullScreen() / public void setShowFullScreen(boolean value)
Show/hide fullscreen button. Can be overridden in flashvars. Default is true.

Has an effect only if ViewerIncluded is true.


getShowLeftPane/setShowLeftPane

public boolean getShowLeftPane() / public void setShowLeftPane(boolean value)
Show/hide left pane. Can be overridden in flashvars. Default is true.

Has an effect only if ViewerIncluded is true.


getShowPageBorder/setShowPageBorder

public boolean getShowPageBorder() / public void setShowPageBorder(boolean value)
Specifies whether border around pages should be shown. Default is true.

Has an effect only if ViewerIncluded is true.


getShowPageStepper/setShowPageStepper

public boolean getShowPageStepper() / public void setShowPageStepper(boolean value)
Show/hide page stepper. Can be overridden in flashvars. Default is true.

Has an effect only if ViewerIncluded is true.


getShowSearch/setShowSearch

public boolean getShowSearch() / public void setShowSearch(boolean value)
Show/hide search section. Can be overridden in flashvars. Default is true.

Has an effect only if ViewerIncluded is true.


getShowTopPane/setShowTopPane

public boolean getShowTopPane() / public void setShowTopPane(boolean value)
Show/hide whole top pane. Can be overridden in flashvars. Default is true.

Has an effect only if ViewerIncluded is true.


getStartOpenLeftPane/setStartOpenLeftPane

public boolean getStartOpenLeftPane() / public void setStartOpenLeftPane(boolean value)
Start with opened left pane. Can be overridden in flashvars. Default is false.

Has an effect only if ViewerIncluded is true.


getTempFolder/setTempFolder

→ inherited from SaveOptions
public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value)
Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.

When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.

If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw System.OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

The folder must exist and be writable, otherwise an exception will be thrown.

Aspose.Words automatically deletes all temporary files when saving is complete.


getToolTips

public SwfToolTips getToolTips()
Gets or sets tooltips used in SWF viewer. Default is Arial.

Has an effect only if ViewerIncluded is true.


getToolTipsFontName/setToolTipsFontName

public java.lang.String getToolTipsFontName() / public void setToolTipsFontName(java.lang.String value)
Gets or sets font used for tooltips in SWF viewer. Default is Arial.

If null or empty string is specified, default font is used.

If font is not installed an alternative font is used.

Has an effect only if ViewerIncluded is true.


getTopPaneControlFlags/setTopPaneControlFlags

public int getTopPaneControlFlags() / public void setTopPaneControlFlags(int value)
Control flags used to configure appearance of top panel of SWF viewer. Default is SwfTopPaneControlFlags.SHOW_ALL. The value of the property is SwfTopPaneControlFlags integer constant.

Has an effect only if ViewerIncluded is true.


getUpdateFields/setUpdateFields

→ inherited from SaveOptions
public boolean getUpdateFields() / public void setUpdateFields(boolean value)
Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true Allows to specify whether to mimic or not MS Word behaviour.

getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty

→ inherited from SaveOptions
public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value)
Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.

getUpdateSdtContent/setUpdateSdtContent

→ inherited from SaveOptions
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value)
Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. The default value is true.

getUseAntiAliasing/setUseAntiAliasing

→ inherited from SaveOptions
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
Gets or sets a value determining whether or not to use anti-aliasing for rendering.

The default value is false. When this value is set to true anti-aliasing is used for rendering.

This property is used when the document is exported to the following formats: #Error Cref: F:Aspose.Words.SaveFormat.Tiff, #Error Cref: F:Aspose.Words.SaveFormat.Png, #Error Cref: F:Aspose.Words.SaveFormat.Bmp, #Error Cref: F:Aspose.Words.SaveFormat.Jpeg, #Error Cref: F:Aspose.Words.SaveFormat.Emf. When the document is exported to the #Error Cref: F:Aspose.Words.SaveFormat.Html, #Error Cref: F:Aspose.Words.SaveFormat.Mhtml and #Error Cref: F:Aspose.Words.SaveFormat.Epub formats this option is used for raster images.


getUseHighQualityRendering/setUseHighQualityRendering

→ inherited from SaveOptions
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. The default value is false.

This property is used when the document is exported to image formats: #Error Cref: F:Aspose.Words.SaveFormat.Tiff, #Error Cref: F:Aspose.Words.SaveFormat.Png, #Error Cref: F:Aspose.Words.SaveFormat.Bmp, #Error Cref: F:Aspose.Words.SaveFormat.Jpeg, #Error Cref: F:Aspose.Words.SaveFormat.Emf.


getViewerIncluded/setViewerIncluded

public boolean getViewerIncluded() / public void setViewerIncluded(boolean value)
Specifies whether the generated SWF document should include the integrated document viewer or not. Default is true.

getWarningCallback

→ inherited from SaveOptions
public Aspose.Words.IWarningCallback getWarningCallback()
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.

This property is obsolete. Please use #Error Cref: P:Aspose.Words.DocumentBase.WarningCallback instead.


Method Detail

deepClone

public SwfSaveOptions deepClone()
Creates a deep clone of this object.

equals

→ inherited from FixedPageSaveOptions
public boolean equals(java.lang.Object obj)

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.