aspose.diagram
Class XPSSaveOptions

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

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 XPS save options
options = new aspose.diagram.XPSSaveOptions();
// set export option of hidden Visio pages
options.setExportHiddenPage(false);

diagram.save("out-ExportOfHiddenVisioPagesToXPS.xps", options);

Constructor Summary
XPSSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the SaveFileFormat format.
 
Property Getters/Setters Summary
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.
functiongetExportHiddenPage()
functionsetExportHiddenPage(value)
           Defines whether need exporting the hidden page or not.
functiongetPageCount()
functionsetPageCount(value)
           Gets or sets the number of pages to render in XPS. 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.
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.
functiongetWarningCallback()
functionsetWarningCallback(value)
           Gets or sets warning callback.
 

Constructor Detail

XPSSaveOptions

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

Property Getters/Setters Detail

getPageCount/setPageCount : Number 

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

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.

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.

getExportHiddenPage/setExportHiddenPage : boolean 

function getExportHiddenPage() / function setExportHiddenPage(value)
Defines whether need exporting the hidden page or not. 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.