HTMLSaveOptions class

HTMLSaveOptions class

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

Inheritance: HTMLSaveOptionsRenderingSaveOptionsSaveOptions

The HTMLSaveOptions type exposes the following members:

Constructors

ConstructorDescription
HTMLSaveOptions()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 rendered diagram pages will be saved if this save options object is used.
Can be SaveFileFormat only.
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.
titleGets or sets the title of diagram to render in HTML.
If Title is null Diagram.DocumentProperties.Title DocumentProperties will be used as Title.
If Diagram.DocumentProperties.Title is null or empty the file name of Diagram will be used as Title.
page_countGets or sets the number of pages to render in HTML.
Default is MaxValue which means all pages of the diagram will be rendered.
save_tool_barSpecifies whether saving toolbar
The default value is true.
page_indexGets or sets the 0-based index of the first page to render. Default is 0.
export_hidden_pageDefines whether need exporting the hidden page or not.
save_titleDefines whether need exporting the title or not.
save_foreground_pages_onlySpecifies whether all pages will be saved in image or only foreground.
stream_providerGets or sets the IStreamProvider for exporting objects.
save_as_single_fileIndicates whether save the html as single file.
The default value is false.
resolutionGets or sets the resolution for the generated html, in dots per inch.

Methods

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

See Also