aspose.diagram
Class PdfSaveOptions

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

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("VisioSaveOptions.vsdx");

// Options when saving a diagram into the PDF format
options = new aspose.diagram.PdfSaveOptions();

// discard saving background pages of the Visio diagram
options.setSaveForegroundPagesOnly(true);

// specify the quality of JPEG compression for images (if JPEG
// compression is used). Default is 95.
options.setJpegQuality(100);

// specify default font name
options.setDefaultFont("Arial");

// conformance level for generated PDF document.
options.setCompliance(aspose.diagram.PdfCompliance.PDF_15);

// Load the certificate from disk.
// The other constructor overloads can be used to load certificates from
// different locations.
cert = new aspose.diagram.X509Certificate2();
// sets a digital signature details. If not set, then no signing will be
// performed.
options.setDigitalSignatureDetails(
    new aspose.diagram.PdfDigitalSignatureDetails(
        cert,
        "Test Signing",
        "Aspose Office",
        aspose.diagram.DateTime.getNow(),
        aspose.diagram.PdfDigitalSignatureHashAlgorithm.SHA_256));

// set encription details
encriptionDetails = new aspose.diagram.PdfEncryptionDetails("user password", "Owner Password",
    aspose.diagram.PdfEncryptionAlgorithm.RC_4_128);
options.setEncryptionDetails(encriptionDetails);
// sets the number of pages to render in PDF.
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);
// save in any supported file format
diagram.save("out-UsePDFSaveOptions.pdf", options);

Constructor Summary
PdfSaveOptions()
           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 .
functiongetCompliance()
functionsetCompliance(value)
           Desired conformance level for generated PDF document. Default is PdfCompliance.PDF_15. The value of the property is PdfCompliance integer constant.
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.
functiongetDigitalSignatureDetails()
functionsetDigitalSignatureDetails(value)
           Gets or sets a digital signature details. If not set, then no signing will be performed.
functiongetEncryptionDetails()
functionsetEncryptionDetails(value)
           Gets or sets a encryption details. If not set, then no encryption will be performed.
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.
functiongetHorizontalResolution()
functionsetHorizontalResolution(value)
           Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images.
functionisExportComments()
functionsetExportComments(value)
           Defines whether need exporting the comments or not.
functiongetJpegQuality()
functionsetJpegQuality(value)
           Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.
functiongetPageCount()
functionsetPageCount(value)
           Gets or sets the number of pages to render in PDF. 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.
functiongetPageSavingCallback()
functionsetPageSavingCallback(value)
           Control/Indicate progress of page saving process.
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.
functiongetShapes()
functionsetShapes(value)
           Gets or sets shapes to render. Default count is 0.
functiongetSplitMultiPages()
functionsetSplitMultiPages(value)
           Defines whether split digram to multi pages according to page's setting.
functiongetTextCompression()
functionsetTextCompression(value)
           Specifies compression type to be used for all content streams except images. Default is #Error Cref: !:PdfTextCompressionCore.Flate. The value of the property is PdfTextCompression integer constant.
functiongetVerticalResolution()
functionsetVerticalResolution(value)
           Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image.
functiongetWarningCallback()
functionsetWarningCallback(value)
           Gets or sets warning callback.
 

Constructor Detail

PdfSaveOptions

function PdfSaveOptions()
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 PDF. 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.

getCompliance/setCompliance : Number 

function getCompliance() / function setCompliance(value)
Desired conformance level for generated PDF document. Default is PdfCompliance.PDF_15. The value of the property is PdfCompliance integer constant.

getEncryptionDetails/setEncryptionDetails : PdfEncryptionDetails 

function getEncryptionDetails() / function setEncryptionDetails(value)
Gets or sets a encryption details. If not set, then no encryption will be performed.

getWarningCallback/setWarningCallback : IWarningCallback 

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

getPageSavingCallback/setPageSavingCallback : IPageSavingCallback 

function getPageSavingCallback() / function setPageSavingCallback(value)
Control/Indicate progress of page saving process.

getJpegQuality/setJpegQuality : Number 

function getJpegQuality() / function setJpegQuality(value)
Specifies the quality of JPEG compression for images (if JPEG compression is used). Default is 95.

getHorizontalResolution/setHorizontalResolution : Number 

function getHorizontalResolution() / function setHorizontalResolution(value)
Gets or sets the horizontal resolution for generated images, in dots per inch. Applies generating image method except Emf format images. The default value is 96.

getVerticalResolution/setVerticalResolution : Number 

function getVerticalResolution() / function setVerticalResolution(value)
Gets or sets the vertical resolution for generated images, in dots per inch. Applies generating image method except Emf format image. The default value is 96.

getSplitMultiPages/setSplitMultiPages : boolean 

function getSplitMultiPages() / function setSplitMultiPages(value)
Defines whether split digram to multi pages according to page's setting. 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.

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

diagram.save("out-ExportOfHiddenVisioPagesToPDF.pdf", options);

getTextCompression/setTextCompression : Number 

function getTextCompression() / function setTextCompression(value)
Specifies compression type to be used for all content streams except images. Default is #Error Cref: !:PdfTextCompressionCore.Flate. The value of the property is PdfTextCompression integer constant.

getDigitalSignatureDetails/setDigitalSignatureDetails : PdfDigitalSignatureDetails 

function getDigitalSignatureDetails() / function setDigitalSignatureDetails(value)
Gets or sets a digital signature details. If not set, then no signing will be performed.

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.

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