com.aspose.words

Class SvgSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.FixedPageSaveOptions

com.aspose.words.SvgSaveOptions

public class SvgSaveOptions
extends FixedPageSaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.SVG format.

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

Method Summary

Modifier and Type	Method and Description
boolean	getExportEmbeddedImages() Specified whether images should be embedded into SVG document as base64.
boolean	getFitToViewPort() Specifies if the output SVG should fill the available viewport area (browser window or container).
IResourceSavingCallback	getResourceSavingCallback() Allows to control how resources (images) are saved when a document is exported to SVG format.
java.lang.String	getResourcesFolder() Specifies the physical folder where resources (images) are saved when exporting a document to Svg format.
java.lang.String	getResourcesFolderAlias() Specifies the name of the folder used to construct image URIs written into an SVG document.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
boolean	getShowPageBorder() Controls whether a border is added to the outline of the page.
int	getTextOutputMode() Gets a value determining how text should be rendered in SVG.
void	setExportEmbeddedImages(boolean value) Specified whether images should be embedded into SVG document as base64.
void	setFitToViewPort(boolean value) Specifies if the output SVG should fill the available viewport area (browser window or container).
void	setResourceSavingCallback(IResourceSavingCallback value) Allows to control how resources (images) are saved when a document is exported to SVG format.
void	setResourcesFolder(java.lang.String value) Specifies the physical folder where resources (images) are saved when exporting a document to Svg format.
void	setResourcesFolderAlias(java.lang.String value) Specifies the name of the folder used to construct image URIs written into an SVG document.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.
void	setShowPageBorder(boolean value) Controls whether a border is added to the outline of the page.
void	setTextOutputMode(int value) Sets a value determining how text should be rendered in SVG.

Methods inherited from class com.aspose.words.FixedPageSaveOptions

equals, getColorMode, getJpegQuality, getMetafileRenderingOptions, getNumeralFormat, getOptimizeOutput, getPageSavingCallback, getPageSet, setColorMode, setJpegQuality, setMetafileRenderingOptions, setNumeralFormat, setOptimizeOutput, setPageSavingCallback, setPageSet

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, 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

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.SVG.

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

public void setSaveFormat(int value)

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.SVG.

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

getShowPageBorder

public boolean getShowPageBorder()

Controls whether a border is added to the outline of the page. Default is true.

Returns:

The corresponding boolean value.

setShowPageBorder

public void setShowPageBorder(boolean value)

Controls whether a border is added to the outline of the page. Default is true.

Parameters:

value - The corresponding boolean value.

getTextOutputMode

public int getTextOutputMode()

Gets a value determining how text should be rendered in SVG.

Use this property to get or set the mode of how text inside a document should be rendered when saving in SVG format.

The default value is SvgTextOutputMode.USE_TARGET_MACHINE_FONTS.

Returns:

A value determining how text should be rendered in SVG. The returned value is one of SvgTextOutputMode constants.

setTextOutputMode

public void setTextOutputMode(int value)

Sets a value determining how text should be rendered in SVG.

Use this property to get or set the mode of how text inside a document should be rendered when saving in SVG format.

The default value is SvgTextOutputMode.USE_TARGET_MACHINE_FONTS.

Parameters:

value - A value determining how text should be rendered in SVG. The value must be one of SvgTextOutputMode constants.

getResourcesFolder

public java.lang.String getResourcesFolder()

Specifies the physical folder where resources (images) are saved when exporting a document to Svg format. Default is null.

Has effect only if getExportEmbeddedImages() / setExportEmbeddedImages(boolean) property is false.

When you save a Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in the same folder where the document file is saved. Use getResourcesFolder() / setResourcesFolder(java.lang.String) to override this behavior.

If you save a document into a stream, Aspose.Words does not have a folder where to save the images, but still needs to save the images somewhere. In this case, you need to specify an accessible folder in the getResourcesFolder() / setResourcesFolder(java.lang.String) property

Returns:

The corresponding String value.

See Also:

getResourcesFolderAlias(), setResourcesFolderAlias(java.lang.String)

setResourcesFolder

public void setResourcesFolder(java.lang.String value)

Specifies the physical folder where resources (images) are saved when exporting a document to Svg format. Default is null.

Has effect only if getExportEmbeddedImages() / setExportEmbeddedImages(boolean) property is false.

When you save a Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in the same folder where the document file is saved. Use getResourcesFolder() / setResourcesFolder(java.lang.String) to override this behavior.

If you save a document into a stream, Aspose.Words does not have a folder where to save the images, but still needs to save the images somewhere. In this case, you need to specify an accessible folder in the getResourcesFolder() / setResourcesFolder(java.lang.String) property

Parameters:

value - The corresponding String value.

See Also:

getResourcesFolderAlias(), setResourcesFolderAlias(java.lang.String)

getResourcesFolderAlias

public java.lang.String getResourcesFolderAlias()

Specifies the name of the folder used to construct image URIs written into an SVG document. Default is null.

When you save a Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

Returns:

The corresponding String value.

See Also:

getResourcesFolder(), setResourcesFolder(java.lang.String)

setResourcesFolderAlias

public void setResourcesFolderAlias(java.lang.String value)

Specifies the name of the folder used to construct image URIs written into an SVG document. Default is null.

When you save a Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. getResourcesFolder() / setResourcesFolder(java.lang.String) allows you to specify where the images will be saved and getResourcesFolderAlias() / setResourcesFolderAlias(java.lang.String) allows to specify how the image URIs will be constructed.

Parameters:

value - The corresponding String value.

See Also:

getResourcesFolder(), setResourcesFolder(java.lang.String)

getExportEmbeddedImages

public boolean getExportEmbeddedImages()

Specified whether images should be embedded into SVG document as base64. Note setting this flag can significantly increase size of output SVG file.

Returns:

The corresponding boolean value.

setExportEmbeddedImages

public void setExportEmbeddedImages(boolean value)

Specified whether images should be embedded into SVG document as base64. Note setting this flag can significantly increase size of output SVG file.

Parameters:

value - The corresponding boolean value.

getFitToViewPort

public boolean getFitToViewPort()

Specifies if the output SVG should fill the available viewport area (browser window or container). When set to true width and height of output SVG are set to 100%.

The default value is false.

Returns:

The corresponding boolean value.

setFitToViewPort

public void setFitToViewPort(boolean value)

Specifies if the output SVG should fill the available viewport area (browser window or container). When set to true width and height of output SVG are set to 100%.

The default value is false.

Parameters:

value - The corresponding boolean value.

getResourceSavingCallback

public IResourceSavingCallback getResourceSavingCallback()

Allows to control how resources (images) are saved when a document is exported to SVG format.

Returns:

The corresponding IResourceSavingCallback value.

setResourceSavingCallback

public void setResourceSavingCallback(IResourceSavingCallback value)

Allows to control how resources (images) are saved when a document is exported to SVG format.

Parameters:

value - The corresponding IResourceSavingCallback value.