SvgSaveOptions class

SvgSaveOptions class

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.

Inheritance: SvgSaveOptions → FixedPageSaveOptions → SaveOptions

Constructors

NameDescription
SvgSaveOptions()The default constructor.

Properties

NameDescription
allowEmbeddingPostScriptFontsGets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.
(Inherited from SaveOptions)
colorModeGets or sets a value determining how colors are rendered.
(Inherited from FixedPageSaveOptions)
defaultTemplateGets or sets path to default template (including filename). Default value for this property is empty string .
(Inherited from SaveOptions)
dml3DEffectsRenderingModeGets or sets a value determining how 3D effects are rendered.
(Inherited from SaveOptions)
dmlEffectsRenderingModeGets or sets a value determining how DrawingML effects are rendered.
(Inherited from SaveOptions)
dmlRenderingModeGets or sets a value determining how DrawingML shapes are rendered.
(Inherited from SaveOptions)
exportEmbeddedImagesSpecifies whether images should be embedded into the SVG document as base64. Be aware that activating this option can lead to a significant increase in the size of the output SVG file.
exportGeneratorNameWhen true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
(Inherited from SaveOptions)
fitToViewPortSpecifies 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%.
idPrefixSpecifies a prefix that is prepended to all generated element IDs in the output document. Default value is null and no prefix is prepended.
imlRenderingModeGets or sets a value determining how ink (InkML) objects are rendered.
(Inherited from SaveOptions)
jpegQualityGets or sets a value determining the quality of the JPEG images inside Html document.
(Inherited from FixedPageSaveOptions)
maxImageResolutionGets or sets a value in pixels per inch that limits resolution of exported raster images. Default value is zero.
memoryOptimizationGets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
(Inherited from SaveOptions)
metafileRenderingOptionsAllows to specify metafile rendering options.
(Inherited from FixedPageSaveOptions)
numeralFormatGets or sets NumeralFormat used for rendering of numerals. European numerals are used by default.
(Inherited from FixedPageSaveOptions)
optimizeOutputFlag 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.
(Inherited from FixedPageSaveOptions)
pageSavingCallbackAllows to control how separate pages are saved when a document is exported to fixed page format.
(Inherited from FixedPageSaveOptions)
pageSetGets or sets the pages to render. Default is all the pages in the document.
(Inherited from FixedPageSaveOptions)
prettyFormatWhen true, pretty formats output where applicable. Default value is false.
(Inherited from SaveOptions)
removeJavaScriptFromLinksSpecifies whether JavaScript will be removed from links. Default is false. If this option is enabled, all links containing JavaScript will be replaced with “javascript:void(0)”.
resourcesFolderSpecifies the physical folder where resources (images) are saved when exporting a document to Svg format. Default is null.
resourcesFolderAliasSpecifies the name of the folder used to construct image URIs written into an SVG document. Default is null.
saveFormatSpecifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.Svg.
showPageBorderControls whether a border is added to the outline of the page. Default is true.
tempFolderSpecifies 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.
(Inherited from SaveOptions)
textOutputModeGets or sets a value determining how text should be rendered in SVG.
updateAmbiguousTextFontDetermines whether the font attributes will be changed according to the character code being used.
(Inherited from SaveOptions)
updateCreatedTimePropertyGets or sets a value determining whether the BuiltInDocumentProperties.createdTime property is updated before saving. Default value is false;
(Inherited from SaveOptions)
updateFieldsGets 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.
(Inherited from SaveOptions)
updateLastPrintedPropertyGets or sets a value determining whether the BuiltInDocumentProperties.lastPrinted property is updated before saving.
(Inherited from SaveOptions)
updateLastSavedTimePropertyGets or sets a value determining whether the BuiltInDocumentProperties.lastSavedTime property is updated before saving.
(Inherited from SaveOptions)
useAntiAliasingGets or sets a value determining whether or not to use anti-aliasing for rendering.
(Inherited from SaveOptions)
useHighQualityRenderingGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
(Inherited from SaveOptions)

Methods

NameDescription
createSaveOptions(saveFormat)Creates a save options object of a class suitable for the specified save format.
(Inherited from SaveOptions)
createSaveOptions(fileName)Creates a save options object of a class suitable for the file extension specified in the given file name.
(Inherited from SaveOptions)

Examples

Shows how to manipulate and print the URIs of linked resources created while converting a document to .svg.

test.skip('SvgResourceFolder - TODO: sourceSavingCallback not supported yet', () => {
    let doc = new aw.Document(base.myDir + "Rendering.docx");

    let options = new aw.Saving.SvgSaveOptions();
    options.saveFormat = aw.SaveFormat.Svg;
    options.exportEmbeddedImages = false;
    options.resourcesFolder = base.artifactsDir + "SvgResourceFolder";
    options.resourcesFolderAlias = base.artifactsDir + "SvgResourceFolderAlias";
    options.showPageBorder = false;

    options.sourceSavingCallback = new ResourceUriPrinter()

    if (!fs.existsSync(options.resourcesFolderAlias)) {
      fs.mkdirSync(options.resourcesFolderAlias);
    }

    doc.save(base.artifactsDir + "SvgSaveOptions.SvgResourceFolder.svg", options);
  });

/*
  /// <summary>
  /// Counts and prints URIs of resources contained by as they are converted to .svg.
  /// </summary>
  private class ResourceUriPrinter : IResourceSavingCallback
  {
    void aw.Saving.IResourceSavingCallback.resourceSaving(ResourceSavingArgs args)
    {
      console.log(`Resource #${++mSavedResourceCount} \"${args.resourceFileName}\"`);
      console.log("\t" + args.resourceFileUri);
    }

    private int mSavedResourceCount;
  }

See Also

SaveOutputParameters class SvgTextOutputMode enumeration