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
| Name | Description |
|---|---|
| SvgSaveOptions() | The default constructor. |
Properties
| Name | Description |
|---|---|
| allow_embedding_post_script_fonts | Gets 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) |
| color_mode | Gets or sets a value determining how colors are rendered. (Inherited from FixedPageSaveOptions) |
| default_template | Gets or sets path to default template (including filename). Default value for this property is empty string (). (Inherited from SaveOptions) |
| dml_3d_effects_rendering_mode | Gets or sets a value determining how 3D effects are rendered. (Inherited from SaveOptions) |
| dml_effects_rendering_mode | Gets or sets a value determining how DrawingML effects are rendered. (Inherited from SaveOptions) |
| dml_rendering_mode | Gets or sets a value determining how DrawingML shapes are rendered. (Inherited from SaveOptions) |
| export_embedded_images | Specified whether images should be embedded into SVG document as base64. Note setting this flag can significantly increase size of output SVG file. |
| export_generator_name | When True, causes the name and version of Aspose.Words to be embedded into produced files. Default value is True.(Inherited from SaveOptions) |
| fit_to_view_port | 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%. |
| iml_rendering_mode | Gets or sets a value determining how ink (InkML) objects are rendered. (Inherited from SaveOptions) |
| jpeg_quality | Gets or sets a value determining the quality of the JPEG images inside Html document. (Inherited from FixedPageSaveOptions) |
| memory_optimization | Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is False.(Inherited from SaveOptions) |
| metafile_rendering_options | Allows to specify metafile rendering options. (Inherited from FixedPageSaveOptions) |
| numeral_format | Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. (Inherited from FixedPageSaveOptions) |
| optimize_output | 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.(Inherited from FixedPageSaveOptions) |
| page_saving_callback | Allows to control how separate pages are saved when a document is exported to fixed page format. (Inherited from FixedPageSaveOptions) |
| page_set | Gets or sets the pages to render. Default is all the pages in the document. (Inherited from FixedPageSaveOptions) |
| pretty_format | When True, pretty formats output where applicable. Default value is False.(Inherited from SaveOptions) |
| progress_callback | Called during saving a document and accepts data about saving progress. (Inherited from SaveOptions) |
| resource_saving_callback | Allows to control how resources (images) are saved when a document is exported to SVG format. |
| resources_folder | Specifies the physical folder where resources (images) are saved when exporting a document to Svg format. Default is None. |
| resources_folder_alias | Specifies the name of the folder used to construct image URIs written into an SVG document. Default is None. |
| save_format | Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.SVG. |
| show_page_border | Controls whether a border is added to the outline of the page. Default is True. |
| temp_folder | Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is None and no temporary files are used.(Inherited from SaveOptions) |
| text_output_mode | Gets or sets a value determining how text should be rendered in SVG. |
| update_created_time_property | Gets or sets a value determining whether the BuiltInDocumentProperties.created_time property is updated before saving. Default value is False;(Inherited from SaveOptions) |
| update_fields | Gets 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) |
| update_last_printed_property | Gets or sets a value determining whether the BuiltInDocumentProperties.last_printed property is updated before saving. (Inherited from SaveOptions) |
| update_last_saved_time_property | Gets or sets a value determining whether the BuiltInDocumentProperties.last_saved_time property is updated before saving. (Inherited from SaveOptions) |
| use_anti_aliasing | Gets or sets a value determining whether or not to use anti-aliasing for rendering. (Inherited from SaveOptions) |
| use_high_quality_rendering | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. (Inherited from SaveOptions) |
Methods
| Name | Description |
|---|---|
| create_save_options(save_format) | Creates a save options object of a class suitable for the specified save format. (Inherited from SaveOptions) |
| create_save_options(file_name) | 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.
#def test_svg_resource_folder(self):
# doc = aw.Document(MY_DIR + "Rendering.docx")
# options = aw.saving.SvgSaveOptions()
# options.save_format = aw.saving.SaveFormat.SVG
# options.export_embedded_images = False
# options.resources_folder = ARTIFACTS_DIR + "SvgResourceFolder"
# options.resources_folder_alias = ARTIFACTS_DIR + "SvgResourceFolderAlias",
# options.show_page_border = False
# options.resource_saving_callback = ExSvgSaveOptions.ResourceUriPrinter()
# os.mkdir(options.resources_folder_alias)
# doc.save(ARTIFACTS_DIR + "SvgSaveOptions.SvgResourceFolder.svg", options)
#class ResourceUriPrinter(aw.saving.IResourceSavingCallback):
# """Counts and prints URIs of resources contained by as they are converted to .svg."""
# def __init__(self):
# self.saved_resource_count = 0
# def resource_saving(self, args: aw.saving.ResourceSavingArgs):
# self.saved_resource_count += 1
# print(f"Resource #{self.saved_resource_count} \"{args.resource_file_name}\"")
# print("\t" + args.resource_file_uri)
See Also
- module aspose.words.saving
- class FixedPageSaveOptions