SVGSaveOptions class

SVGSaveOptions class

Allows to specify additional options when rendering diagram pages to SVG.

Inheritance: SVGSaveOptionsRenderingSaveOptionsSaveOptions

The SVGSaveOptions type exposes the following members:

Constructors

ConstructorDescription
SVGSaveOptions()Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.

Properties

PropertyDescription
save_formatSpecifies the format in which the document will be saved if this save options object is used.
default_fontWhen characters in the diagram are unicode and not be set with correct font value or the font is not installed locally,
they may appear as block in pdf, image or XPS.
Set the DefaultFont such as MingLiu or MS Gothic to show these characters.
warning_callbackGets or sets warning callback.
page_sizeGets or sets the page size for the generated images.
Can be PageSize or null.
shapesGets or sets shapes to render. Default count is 0.
areaGets or sets the area of the shapes will be saved .
export_guide_shapesDefines whether need exporting the guide shapes or not.
is_export_commentsDefines whether need exporting the comments or not.
enlarge_pageSpecifies whether enlarge page .
emf_render_settingSetting for rendering Emf metafile.
page_indexGets or sets the 0-based index of the page to render. Default is 0.
export_hidden_pageDefines whether need exporting the hidden page or not.
qualityGets or sets a value determining the quality of the generated images
to apply only when saving pages to the Jpeg format. The default value is 100
svg_fit_to_view_portif this property is true, the generated svg will fit to view port.
export_element_as_rect_tagDefines whether need exporting rectangle elements as rect tag or not.
is_export_scale_in_matrixDefines whether need export scale in matrix or not.
is_saving_image_separatelyDefines whether Saving Image Separately.
is_saving_custom_line_patternDefines whether Saving custom line pattern.
custom_image_pathThe user custom path(URL) saved in generated svg file for the image. If not defined by user, Current directory will be used.

Methods

MethodDescription
create_save_options(save_format)Creates a save options object of a class suitable for the specified save format.

See Also