java.lang.ObjectSaveOptions
FixedPageSaveOptions
com.aspose.words.SwfSaveOptions
public class SwfSaveOptions
Constructor Summary |
---|
SwfSaveOptions()
Initializes a new instance of this class that can be used to save a document in the |
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAllowReadMode() | |
void | setAllowReadMode(boolean value) | |
Allows to enable read mode. Can be overridden in flashvars.
Default is true .
|
||
int | getBookmarksOutlineLevel() | |
void | setBookmarksOutlineLevel(int value) | |
Specifies the level in the SWF document outline at which to display Word bookmarks. | ||
int | getColorMode() | → inherited from SaveOptions |
void | setColorMode(int value) | |
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant. | ||
boolean | getCompressed() | |
void | setCompressed(boolean value) | |
Specifies whether the generated SWF document should be compressed or not.
Default is true .
|
||
java.lang.String | getDefaultTemplate() | → inherited from SaveOptions |
void | setDefaultTemplate(java.lang.String value) | |
Gets or sets path to default template (including filename).
Default value for this property is |
||
int | getDmlEffectsRenderingMode() | → inherited from SaveOptions |
void | setDmlEffectsRenderingMode(int value) | |
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. | ||
int | getDmlRenderingMode() | → inherited from SaveOptions |
void | setDmlRenderingMode(int value) | |
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. | ||
boolean | getEnableContextMenu() | |
void | setEnableContextMenu(boolean value) | |
Enable/disable context menu. Can be overridden in flashvars.
Default is true .
|
||
int | getExpandedOutlineLevels() | |
void | setExpandedOutlineLevels(int value) | |
Specifies how many levels in the SWF document outline to show expanded when the SWF file is viewed. | ||
int | getHeadingsOutlineLevels() | |
void | setHeadingsOutlineLevels(int value) | |
Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the SWF document outline. | ||
int | getJpegQuality() | → inherited from FixedPageSaveOptions |
void | setJpegQuality(int value) | |
Gets or sets a value determining the quality of the JPEG images inside Html document. | ||
int | getLeftPaneControlFlags() | |
void | setLeftPaneControlFlags(int value) | |
Control flags used to configure appearance of left panel of SWF viewer.
Default is |
||
byte[] | getLogoImageBytes() | |
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. | ||
java.lang.String | getLogoLink() | |
void | setLogoLink(java.lang.String value) | |
Gets or sets the full hyperlink address for a logo. | ||
boolean | getMemoryOptimization() | → inherited from SaveOptions |
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. | ||
MetafileRenderingOptions | getMetafileRenderingOptions() | → inherited from FixedPageSaveOptions |
Allows to specify metafile rendering options. | ||
int | getNumeralFormat() | → inherited from FixedPageSaveOptions |
void | setNumeralFormat(int value) | |
Gets or sets |
||
boolean | getOptimizeOutput() | → inherited from FixedPageSaveOptions |
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. | ||
OutlineOptions | getOutlineOptions() | |
Allows to specify outline options. | ||
int | getPageCount() | → inherited from FixedPageSaveOptions |
void | setPageCount(int value) | |
Gets or sets the number of pages to save.
Default is |
||
int | getPageIndex() | → inherited from FixedPageSaveOptions |
void | setPageIndex(int value) | |
Gets or sets the 0-based index of the first page to save. Default is 0. | ||
IPageSavingCallback | getPageSavingCallback() | → inherited from FixedPageSaveOptions |
void | setPageSavingCallback(IPageSavingCallback value) | |
Allows to control how separate pages are saved when a document is exported to fixed page format. | ||
boolean | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
Aspose.Words.SaveFormat | getSaveFormat() | |
Specifies the format in which the document will be saved if this save options object is used.
Can only be |
||
boolean | getShowBottomPane() | |
void | setShowBottomPane(boolean value) | |
Show/hide bottom pane. Can be overridden in flashvars.
Default is true .
|
||
boolean | getShowFullScreen() | |
void | setShowFullScreen(boolean value) | |
Show/hide fullscreen button. Can be overridden in flashvars.
Default is true .
|
||
boolean | getShowLeftPane() | |
void | setShowLeftPane(boolean value) | |
Show/hide left pane. Can be overridden in flashvars.
Default is true .
|
||
boolean | getShowPageBorder() | |
void | setShowPageBorder(boolean value) | |
Specifies whether border around pages should be shown.
Default is true .
|
||
boolean | getShowPageStepper() | |
void | setShowPageStepper(boolean value) | |
Show/hide page stepper. Can be overridden in flashvars.
Default is true .
|
||
boolean | getShowSearch() | |
void | setShowSearch(boolean value) | |
Show/hide search section. Can be overridden in flashvars.
Default is true .
|
||
boolean | getShowTopPane() | |
void | setShowTopPane(boolean value) | |
Show/hide whole top pane. Can be overridden in flashvars.
Default is true .
|
||
boolean | getStartOpenLeftPane() | |
void | setStartOpenLeftPane(boolean value) | |
Start with opened left pane. Can be overridden in flashvars.
Default is false .
|
||
java.lang.String | getTempFolder() | → inherited from SaveOptions |
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.
|
||
SwfToolTips | getToolTips() | |
Gets or sets tooltips used in SWF viewer. Default is Arial. | ||
java.lang.String | getToolTipsFontName() | |
void | setToolTipsFontName(java.lang.String value) | |
Gets or sets font used for tooltips in SWF viewer. Default is Arial. | ||
int | getTopPaneControlFlags() | |
void | setTopPaneControlFlags(int value) | |
Control flags used to configure appearance of top panel of SWF viewer.
Default is |
||
boolean | getUpdateFields() | → inherited from SaveOptions |
void | setUpdateFields(boolean value) | |
Gets or sets a value determining if fields should be updated before saving the document to a fixed page format. Default value for this property is true | ||
boolean | getUpdateSdtContent() | → inherited from SaveOptions |
void | setUpdateSdtContent(boolean value) | |
Gets or sets value determining whether content of |
||
boolean | getUseAntiAliasing() | → inherited from SaveOptions |
void | setUseAntiAliasing(boolean value) | |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. | ||
boolean | getUseHighQualityRendering() | → inherited from SaveOptions |
void | setUseHighQualityRendering(boolean value) | |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. | ||
boolean | getViewerIncluded() | |
void | setViewerIncluded(boolean value) | |
Specifies whether the generated SWF document should include the integrated document viewer or not.
Default is true .
|
||
Aspose.Words.IWarningCallback | getWarningCallback() | → inherited from SaveOptions |
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss. |
Method Summary | ||
---|---|---|
SwfSaveOptions | deepClone() | |
Creates a deep clone of this object. |
Constructor Detail |
---|
public SwfSaveOptions()
Property Getters/Setters Detail |
---|
getAllowReadMode/setAllowReadMode | |
public boolean getAllowReadMode() / public void setAllowReadMode(boolean value) |
true
.
Has an effect only if true
.
getBookmarksOutlineLevel/setBookmarksOutlineLevel | |
public int getBookmarksOutlineLevel() / public void setBookmarksOutlineLevel(int value) |
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
getColorMode/setColorMode | → inherited from SaveOptions |
public int getColorMode() / public void setColorMode(int value) |
This property is used when the document is exported to fixed page formats.
getCompressed/setCompressed | |
public boolean getCompressed() / public void setCompressed(boolean value) |
true
.
getDefaultTemplate/setDefaultTemplate | → inherited from SaveOptions |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value) |
getDmlEffectsRenderingMode/setDmlEffectsRenderingMode | → inherited from SaveOptions |
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value) |
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) |
This property is used when the document is exported to fixed page formats.
getEnableContextMenu/setEnableContextMenu | |
public boolean getEnableContextMenu() / public void setEnableContextMenu(boolean value) |
true
.
Has an effect only if true
.
getExpandedOutlineLevels/setExpandedOutlineLevels | |
public int getExpandedOutlineLevels() / public void setExpandedOutlineLevels(int value) |
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
getHeadingsOutlineLevels/setHeadingsOutlineLevels | |
public int getHeadingsOutlineLevels() / public void setHeadingsOutlineLevels(int value) |
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
getJpegQuality/setJpegQuality | → inherited from FixedPageSaveOptions |
public int getJpegQuality() / public void setJpegQuality(int value) |
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) |
Has an effect only if true
.
getLogoImageBytes/setLogoImageBytes | |
public byte[] getLogoImageBytes() / public void setLogoImageBytes(byte[] value) |
Has an effect only if true
.
When null
no logo is displayed.
getLogoLink/setLogoLink | |
public java.lang.String getLogoLink() / public void setLogoLink(java.lang.String value) |
Has an effect only if true
and
Set to null
or empty string to specify no hyperlink.
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value) |
getMetafileRenderingOptions | → inherited from FixedPageSaveOptions |
public MetafileRenderingOptions getMetafileRenderingOptions() |
getNumeralFormat/setNumeralFormat | → inherited from FixedPageSaveOptions |
public int getNumeralFormat() / public void setNumeralFormat(int value) |
getOptimizeOutput/setOptimizeOutput | → inherited from FixedPageSaveOptions |
public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value) |
getOutlineOptions | |
public OutlineOptions getOutlineOptions() |
Note that outline options has effect only if
getPageCount/setPageCount | → inherited from FixedPageSaveOptions |
public int getPageCount() / public void setPageCount(int value) |
getPageIndex/setPageIndex | → inherited from FixedPageSaveOptions |
public int getPageIndex() / public void setPageIndex(int value) |
getPageSavingCallback/setPageSavingCallback | → inherited from FixedPageSaveOptions |
public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value) |
getPrettyFormat/setPrettyFormat | → inherited from SaveOptions |
public boolean getPrettyFormat() / public void setPrettyFormat(boolean value) |
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() |
getShowBottomPane/setShowBottomPane | |
public boolean getShowBottomPane() / public void setShowBottomPane(boolean value) |
true
.
Has an effect only if true
.
getShowFullScreen/setShowFullScreen | |
public boolean getShowFullScreen() / public void setShowFullScreen(boolean value) |
true
.
Has an effect only if true
.
getShowLeftPane/setShowLeftPane | |
public boolean getShowLeftPane() / public void setShowLeftPane(boolean value) |
true
.
Has an effect only if true
.
getShowPageBorder/setShowPageBorder | |
public boolean getShowPageBorder() / public void setShowPageBorder(boolean value) |
true
.
Has an effect only if true
.
getShowPageStepper/setShowPageStepper | |
public boolean getShowPageStepper() / public void setShowPageStepper(boolean value) |
true
.
Has an effect only if true
.
getShowSearch/setShowSearch | |
public boolean getShowSearch() / public void setShowSearch(boolean value) |
true
.
Has an effect only if
getShowTopPane/setShowTopPane | |
public boolean getShowTopPane() / public void setShowTopPane(boolean value) |
true
.
Has an effect only if true
.
getStartOpenLeftPane/setStartOpenLeftPane | |
public boolean getStartOpenLeftPane() / public void setStartOpenLeftPane(boolean value) |
false
.
Has an effect only if true
.
getTempFolder/setTempFolder | → inherited from SaveOptions |
public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value) |
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
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() |
Has an effect only if true
.
getToolTipsFontName/setToolTipsFontName | |
public java.lang.String getToolTipsFontName() / public void setToolTipsFontName(java.lang.String value) |
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 true
.
getTopPaneControlFlags/setTopPaneControlFlags | |
public int getTopPaneControlFlags() / public void setTopPaneControlFlags(int value) |
Has an effect only if true
.
getUpdateFields/setUpdateFields | → inherited from SaveOptions |
public boolean getUpdateFields() / public void setUpdateFields(boolean value) |
getUpdateSdtContent/setUpdateSdtContent | → inherited from SaveOptions |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
getUseAntiAliasing/setUseAntiAliasing | → inherited from SaveOptions |
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value) |
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:
getUseHighQualityRendering/setUseHighQualityRendering | → inherited from SaveOptions |
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value) |
false
.
This property is used when the document is exported to image formats:
getViewerIncluded/setViewerIncluded | |
public boolean getViewerIncluded() / public void setViewerIncluded(boolean value) |
true
.
getWarningCallback | → inherited from SaveOptions |
public Aspose.Words.IWarningCallback getWarningCallback() |
This property is obsolete. Please use
Method Detail |
---|
deepClone | |
public SwfSaveOptions deepClone() |