aspose.diagram
Class HTMLSaveOptions

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

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);

Constructor Summary
HTMLSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
 
Property Getters/Setters Summary
functiongetArea()
           Gets or sets the area of the shapes will be saved .
functiongetDefaultFont()
functionsetDefaultFont(value)
           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.
functiongetEnlargePage()
functionsetEnlargePage(value)
           Specifies whether enlarge page .
functiongetExportGuideShapes()
functionsetExportGuideShapes(value)
           Defines whether need exporting the guide shapes or not.
functiongetExportHiddenPage()
functionsetExportHiddenPage(value)
           Defines whether need exporting the hidden page or not.
functionisExportComments()
functionsetExportComments(value)
           Defines whether need exporting the comments or not.
functiongetPageCount()
functionsetPageCount(value)
           Gets or sets the number of pages to render in HTML. Default is MaxValue which means all pages of the diagram will be rendered.
functiongetPageIndex()
functionsetPageIndex(value)
           Gets or sets the 0-based index of the first page to render. Default is 0.
functiongetPageSize()
functionsetPageSize(value)
           Gets or sets the page size for the generated images. Can be PageSize or null.
functiongetSaveForegroundPagesOnly()
functionsetSaveForegroundPagesOnly(value)
           Specifies whether all pages will be saved in image or only foreground.
functiongetSaveFormat()
functionsetSaveFormat(value)
           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.
functiongetSaveTitle()
functionsetSaveTitle(value)
           Defines whether need exporting the title or not.
functiongetSaveToolBar()
functionsetSaveToolBar(value)
           Specifies whether saving toolbar The default value is true.
functiongetShapes()
functionsetShapes(value)
           Gets or sets shapes to render. Default count is 0.
functiongetStreamProvider()
functionsetStreamProvider(value)
           Gets or sets the IStreamProvider for exporting objects.
functiongetTitle()
functionsetTitle(value)
           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.
functiongetWarningCallback()
functionsetWarningCallback(value)
           Gets or sets warning callback.
 

Constructor Detail

HTMLSaveOptions

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

Property Getters/Setters Detail

getTitle/setTitle : String 

function getTitle() / function setTitle(value)
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.

getPageCount/setPageCount : Number 

function getPageCount() / function setPageCount(value)
Gets or sets the number of pages to render in HTML. Default is MaxValue which means all pages of the diagram will be rendered.

getSaveToolBar/setSaveToolBar : boolean 

function getSaveToolBar() / function setSaveToolBar(value)
Specifies whether saving toolbar The default value is true.

getPageIndex/setPageIndex : Number 

function getPageIndex() / function setPageIndex(value)
Gets or sets the 0-based index of the first page to render. Default is 0.

getSaveFormat/setSaveFormat : Number 

function getSaveFormat() / function setSaveFormat(value)
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.

getExportHiddenPage/setExportHiddenPage : boolean 

function getExportHiddenPage() / function setExportHiddenPage(value)
Defines whether need exporting the hidden page or not. Default value is true.

getSaveTitle/setSaveTitle : boolean 

function getSaveTitle() / function setSaveTitle(value)
Defines whether need exporting the title or not. Default value is true.

getSaveForegroundPagesOnly/setSaveForegroundPagesOnly : boolean 

function getSaveForegroundPagesOnly() / function setSaveForegroundPagesOnly(value)
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.

getStreamProvider/setStreamProvider : IStreamProvider 

function getStreamProvider() / function setStreamProvider(value)
Gets or sets the IStreamProvider for exporting objects.

getPageSize/setPageSize : PageSize 

function getPageSize() / function setPageSize(value)
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.

getShapes/setShapes : ShapeCollection 

function getShapes() / function setShapes(value)
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);

getArea : Float 

function getArea()
Gets or sets the area of the shapes will be saved . This property has effect only when saving to raster image formats.

getExportGuideShapes/setExportGuideShapes : boolean 

function getExportGuideShapes() / function setExportGuideShapes(value)
Defines whether need exporting the guide shapes or not. Default value is true.

isExportComments/setExportComments : boolean 

function isExportComments() / function setExportComments(value)
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);

getEnlargePage/setEnlargePage : boolean 

function getEnlargePage() / function setEnlargePage(value)
Specifies whether enlarge page . If true - enlarge page. If false - not enlarge page. The default value is true.

getDefaultFont/setDefaultFont : String 

function getDefaultFont() / function setDefaultFont(value)
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.

getWarningCallback/setWarningCallback : IWarningCallback 

function getWarningCallback() / function setWarningCallback(value)
Gets or sets warning callback.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.