com.aspose.words

Class FixedPageSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.FixedPageSaveOptions

Direct Known Subclasses:

HtmlFixedSaveOptions, ImageSaveOptions, PclSaveOptions, PdfSaveOptions, PsSaveOptions, SvgSaveOptions, XamlFixedSaveOptions, XpsSaveOptions

public abstract class FixedPageSaveOptions
extends SaveOptions

Contains common options that can be specified when saving a document into fixed page formats (PDF, XPS, images etc).

To learn more, visit the Specify Save Options documentation article.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FixedPageSaveOptions() Initializes a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Determines whether the specified object is equal in value to the current object.
int	getColorMode() Gets a value determining how colors are rendered.
int	getJpegQuality() Gets a value determining the quality of the JPEG images inside Html document.
MetafileRenderingOptions	getMetafileRenderingOptions() Allows to specify metafile rendering options.
int	getNumeralFormat() Gets NumeralFormat used for rendering of numerals.
boolean	getOptimizeOutput() Flag indicates whether it is required to optimize output.
IPageSavingCallback	getPageSavingCallback() Allows to control how separate pages are saved when a document is exported to fixed page format.
PageSet	getPageSet() Gets the pages to render.
void	setColorMode(int value) Sets a value determining how colors are rendered.
void	setJpegQuality(int value) Sets a value determining the quality of the JPEG images inside Html document.
void	setMetafileRenderingOptions(MetafileRenderingOptions value) Allows to specify metafile rendering options.
void	setNumeralFormat(int value) Sets NumeralFormat used for rendering of numerals.
void	setOptimizeOutput(boolean value) Flag indicates whether it is required to optimize output.
void	setPageSavingCallback(IPageSavingCallback value) Allows to control how separate pages are saved when a document is exported to fixed page format.
void	setPageSet(PageSet value) Sets the pages to render.

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getSaveFormat, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setSaveFormat, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FixedPageSaveOptions

protected FixedPageSaveOptions()

Initializes a new instance of this class.

Method Detail

getPageSet

public PageSet getPageSet()

Gets the pages to render. Default is all the pages in the document.

Returns:

The pages to render.

setPageSet

public void setPageSet(PageSet value)

Sets the pages to render. Default is all the pages in the document.

Parameters:

value - The pages to render.

getPageSavingCallback

public IPageSavingCallback getPageSavingCallback()

Allows to control how separate pages are saved when a document is exported to fixed page format.

Returns:

The corresponding IPageSavingCallback value.

setPageSavingCallback

public void setPageSavingCallback(IPageSavingCallback value)

Allows to control how separate pages are saved when a document is exported to fixed page format.

Parameters:

value - The corresponding IPageSavingCallback value.

getNumeralFormat

public int getNumeralFormat()

Gets NumeralFormat used for rendering of numerals. European numerals are used by default. If the value of this property is changed and page layout is already built then Document.updatePageLayout() is invoked automatically to update any changes.

Returns:

NumeralFormat used for rendering of numerals. The returned value is one of NumeralFormat constants.

setNumeralFormat

public void setNumeralFormat(int value)

Sets NumeralFormat used for rendering of numerals. European numerals are used by default. If the value of this property is changed and page layout is already built then Document.updatePageLayout() is invoked automatically to update any changes.

Parameters:

value - NumeralFormat used for rendering of numerals. The value must be one of NumeralFormat constants.

getMetafileRenderingOptions

public MetafileRenderingOptions getMetafileRenderingOptions()

Allows to specify metafile rendering options.

Returns:

The corresponding MetafileRenderingOptions value.

setMetafileRenderingOptions

public void setMetafileRenderingOptions(MetafileRenderingOptions value)

Allows to specify metafile rendering options.

Parameters:

value - The corresponding MetafileRenderingOptions value.

getJpegQuality

public int getJpegQuality()

Gets 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.

Returns:

A value determining the quality of the JPEG images inside Html document.

setJpegQuality

public void setJpegQuality(int value)

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.

Parameters:

value - A value determining the quality of the JPEG images inside Html document.

getColorMode

public int getColorMode()

Gets a value determining how colors are rendered. The default value is ColorMode.NORMAL.

Returns:

A value determining how colors are rendered. The returned value is one of ColorMode constants.

setColorMode

public void setColorMode(int value)

Sets a value determining how colors are rendered. The default value is ColorMode.NORMAL.

Parameters:

value - A value determining how colors are rendered. The value must be one of ColorMode constants.

getOptimizeOutput

public boolean getOptimizeOutput()

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 formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.

Returns:

The corresponding boolean value.

setOptimizeOutput

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 formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.

Parameters:

value - The corresponding boolean value.

equals

public boolean equals(java.lang.Object obj)

Determines whether the specified object is equal in value to the current object.

Overrides:

equals in class java.lang.Object