HTMLSaveOptions
Source: aspose.
Allows to specify additional options when rendering diagram pages to HTML.
Methods
new HTMLSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("VisioSaveOptions.vsdx");
// Options when saving a diagram into Visio format
options = new aspose.diagram.HTMLSaveOptions();
// value or the font is not installed locally, they may appear as a
// block,
// set the DefaultFont such as MingLiu or MS Gothic to show these
// characters.
options.setDefaultFont("MS Gothic");
// sets the number of pages to render in HTML.
options.setPageCount(2);
// sets the 0-based index of the first page to render. Default is 0.
options.setPageIndex(0);
// set page size
pgSize = new aspose.diagram.PageSize(aspose.diagram.PaperSizeFormat.A_1);
options.setPageSize(pgSize);
// discard saving background pages of the Visio diagram
options.setSaveForegroundPagesOnly(true);
// specify whether to include the toolbar or not. Default value is true.
options.setSaveToolBar(false);
// set title of the HTML document
options.setTitle("Title goes here");
// Specify that you want to save tile or not
options.setSaveTitle(true);
// save in any supported file format
diagram.save("out-UseHTMLSaveOptions.html", options);Methods
getDefaultFont()
When 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.
getEmfRenderSetting()
Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is EmfOnly"/>.
getEnlargePage()
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
getExportGuideShapes()
Defines whether need exporting the guide shapes or not. Default value is true.
getExportHiddenPage()
Defines whether need exporting the hidden page or not. Default value is true.
getPageCount()
Gets or sets the number of pages to render in HTML. Default is MaxValue which means all pages of the diagram will be rendered.
getPageIndex()
Gets or sets the 0-based index of the first page to render. Default is 0.
getPageSize()
Gets or sets the page size for the generated images. Can be PageSize or null. The default value is null. If PageSize is null then page size for generated image is obtained from source diagram.
getResolution()
Gets or sets the resolution for the generated html, in dots per inch. This property has effect only when saving to html. The default value is 96.
getSaveAsSingleFile()
Indicates whether save the html as single file. The default value is false. If there are multiple pages,those pages and other resources need to be saved into separate files. For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. If so, user may set this property as true.
getSaveForegroundPagesOnly()
Specifies whether all pages will be saved in image or only foreground. If true - rendered only foreground pages(with background if present). If false - rendered foreground pages(with background if present) after that empty background pages. Can return true only when PageCount > 1. The default value is false.
getSaveFormat()
Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be SaveFileFormat only. The value of the property is SaveFileFormat integer constant.
getSaveTitle()
Defines whether need exporting the title or not. Default value is true.
getSaveToolBar()
Specifies whether saving toolbar The default value is true.
getShapes()
Gets or sets shapes to render. Default count is 0.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("LoadSaveConvert.vsdx");
// create an instance SVG save options class
options = new aspose.diagram.SVGSaveOptions();
shapes = options.getShapes();
// get shapes by page index and shape ID, and then add in the shape collection object
shapes.add(diagram.getPages().get(0).getShapes().getShape(1));
shapes.add(diagram.getPages().get(0).getShapes().getShape(2));
// save Visio drawing
diagram.save("out-SelectiveShapes_out.svg", options);getStreamProvider()
Gets or sets the IStreamProvider for exporting objects.
getTitle()
Gets 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.
getWarningCallback()
Gets or sets warning callback.
isExportComments()
Defines whether need exporting the comments or not. Default value is false.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("Pages.vsdx");
// get a particular page
page = diagram.getPages().getPage("Flow 2");
// set Visio page visiblity
page.getPageSheet().getPageProps().getUIVisibility().setValue(aspose.diagram.BOOL.TRUE);
// initialize Image save options
options = new aspose.diagram.ImageSaveOptions(aspose.diagram.SaveFileFormat.JPEG);
// set export option of hidden Visio pages
options.setExportHiddenPage(false);
// set export option of comments
options.setExportComments(false);
diagram.save("out-ExportOfHiddenVisioPagesToImage.jpeg", options);setDefaultFont()
When 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.
setEmfRenderSetting()
Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. EMF metafiles identified as "EMF+ Dual" can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When EmfPlusPrefer is set, then EMF+ records will be parsed , otherwise only EMF records will be parsed. Default value is EmfOnly"/>.
setEnlargePage()
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.
setExportComments()
Defines whether need exporting the comments or not. Default value is false.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("Pages.vsdx");
// get a particular page
page = diagram.getPages().getPage("Flow 2");
// set Visio page visiblity
page.getPageSheet().getPageProps().getUIVisibility().setValue(aspose.diagram.BOOL.TRUE);
// initialize Image save options
options = new aspose.diagram.ImageSaveOptions(aspose.diagram.SaveFileFormat.JPEG);
// set export option of hidden Visio pages
options.setExportHiddenPage(false);
// set export option of comments
options.setExportComments(false);
diagram.save("out-ExportOfHiddenVisioPagesToImage.jpeg", options);setExportGuideShapes()
Defines whether need exporting the guide shapes or not. Default value is true.
setExportHiddenPage()
Defines whether need exporting the hidden page or not. Default value is true.
setPageCount()
Gets or sets the number of pages to render in HTML. Default is MaxValue which means all pages of the diagram will be rendered.
setPageIndex()
Gets or sets the 0-based index of the first page to render. Default is 0.
setPageSize()
Gets or sets the page size for the generated images. Can be PageSize or null. The default value is null. If PageSize is null then page size for generated image is obtained from source diagram.
setResolution()
Gets or sets the resolution for the generated html, in dots per inch. This property has effect only when saving to html. The default value is 96.
setSaveAsSingleFile()
Indicates whether save the html as single file. The default value is false. If there are multiple pages,those pages and other resources need to be saved into separate files. For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. If so, user may set this property as true.
setSaveForegroundPagesOnly()
Specifies whether all pages will be saved in image or only foreground. If true - rendered only foreground pages(with background if present). If false - rendered foreground pages(with background if present) after that empty background pages. Can return true only when PageCount > 1. The default value is false.
setSaveFormat()
Specifies the format in which the rendered diagram pages will be saved if this save options object is used. Can be SaveFileFormat only. The value of the property is SaveFileFormat integer constant.
setSaveTitle()
Defines whether need exporting the title or not. Default value is true.
setSaveToolBar()
Specifies whether saving toolbar The default value is true.
setShapes()
Gets or sets shapes to render. Default count is 0.
Example
var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");
diagram = new aspose.diagram.Diagram("LoadSaveConvert.vsdx");
// create an instance SVG save options class
options = new aspose.diagram.SVGSaveOptions();
shapes = options.getShapes();
// get shapes by page index and shape ID, and then add in the shape collection object
shapes.add(diagram.getPages().get(0).getShapes().getShape(1));
shapes.add(diagram.getPages().get(0).getShapes().getShape(2));
// save Visio drawing
diagram.save("out-SelectiveShapes_out.svg", options);setStreamProvider()
Gets or sets the IStreamProvider for exporting objects.
setTitle()
Gets 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.
setWarningCallback()
Gets or sets warning callback.