com.aspose.words
Class SvgSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by FixedPageSaveOptions
          extended by com.aspose.words.SvgSaveOptions

public class SvgSaveOptions 
extends FixedPageSaveOptions

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

Constructor Summary
SvgSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the #Error Cref: F:Aspose.Words.SaveFormat.Svg format.
 
Property Getters/Setters Summary
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.
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.
booleangetExportEmbeddedImages()
voidsetExportEmbeddedImages(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.
booleangetFitToViewPort()
voidsetFitToViewPort(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.

intgetJpegQuality()→ inherited from FixedPageSaveOptions
voidsetJpegQuality(int value)
           Gets or sets a value determining the quality of the JPEG images inside Html document.
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.
intgetMetafileRenderingMode()
voidsetMetafileRenderingMode(int value)
           Gets or sets a value determining how metafile images should be rendered. The value of the property is MetafileRenderingMode integer constant.
MetafileRenderingOptionsgetMetafileRenderingOptions()→ inherited from FixedPageSaveOptions
           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 of XPS. 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.
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.
IResourceSavingCallbackgetResourceSavingCallback()
voidsetResourceSavingCallback(IResourceSavingCallback value)
           Allows to control how resources (images) are saved when a document is exported to SVG format.
java.lang.StringgetResourcesFolder()
voidsetResourcesFolder(java.lang.String value)
           Specifies the physical folder where resources (images) are saved when exporting a document to Svg format. Default is null.
java.lang.StringgetResourcesFolderAlias()
voidsetResourcesFolderAlias(java.lang.String value)
           Specifies the name of the folder used to construct image URIs written into an SVG document. Default is null.
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.Svg.
booleangetShowPageBorder()
voidsetShowPageBorder(boolean value)
           Controls whether a border is added to the outline of the page. Default is true.
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.
intgetTextOutputMode()
voidsetTextOutputMode(int value)
           Gets or 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.

The value of the property is SvgTextOutputMode integer constant.
booleangetUpdateFields()→ inherited from SaveOptions
voidsetUpdateFields(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
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.
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.
 

Constructor Detail

SvgSaveOptions

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

Property Getters/Setters Detail

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.


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.


getExportEmbeddedImages/setExportEmbeddedImages

public boolean getExportEmbeddedImages() / 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.

getFitToViewPort/setFitToViewPort

public boolean getFitToViewPort() / 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.


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.


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.

getMetafileRenderingMode/setMetafileRenderingMode

public int getMetafileRenderingMode() / public void setMetafileRenderingMode(int value)
Gets or sets a value determining how metafile images should be rendered. The value of the property is MetafileRenderingMode integer constant.

Has effect only when a document contains metafile images.

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

The default value is MetafileRenderingMode.VECTOR_WITH_FALLBACK.


getMetafileRenderingOptions

→ inherited from FixedPageSaveOptions
public MetafileRenderingOptions getMetafileRenderingOptions()
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 of XPS. 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.

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.


getResourceSavingCallback/setResourceSavingCallback

public IResourceSavingCallback getResourceSavingCallback() / public void setResourceSavingCallback(IResourceSavingCallback value)
Allows to control how resources (images) are saved when a document is exported to SVG format.

getResourcesFolder/setResourcesFolder

public java.lang.String getResourcesFolder() / 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 ExportEmbeddedImages property is false.

When you save a Aspose.Words.Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. ResourcesFolder allows you to specify where the images will be saved and ResourcesFolderAlias 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 ResourcesFolder 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 ResourcesFolder property

See Also:
ResourcesFolderAlias

getResourcesFolderAlias/setResourcesFolderAlias

public java.lang.String getResourcesFolderAlias() / 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 Aspose.Words.Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. ResourcesFolder allows you to specify where the images will be saved and ResourcesFolderAlias allows to specify how the image URIs will be constructed.

See Also:
ResourcesFolder

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

getShowPageBorder/setShowPageBorder

public boolean getShowPageBorder() / public void setShowPageBorder(boolean value)
Controls whether a border is added to the outline of the page. Default 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.


getTextOutputMode/setTextOutputMode

public int getTextOutputMode() / public void setTextOutputMode(int value)
Gets or 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.

The value of the property is SvgTextOutputMode integer constant.

getUpdateFields/setUpdateFields

→ inherited from SaveOptions
public boolean getUpdateFields() / public 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

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.


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.


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