com.aspose.words

Class PdfSaveOptions

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class PdfSaveOptions 
    extends FixedPageSaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.PDF format.

Example:

Saves a document to PDF without compression.
Document doc = new Document(getMyDir() + "Rendering.doc");

PdfSaveOptions options = new PdfSaveOptions();
options.setTextCompression(PdfTextCompression.NONE);

doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToPdfNoCompression.pdf", options);

Example:

Converts a whole document to PDF with three levels in the document outline.
Document doc = new Document(getMyDir() + "Rendering.doc");

PdfSaveOptions options = new PdfSaveOptions();
options.getOutlineOptions().setHeadingsOutlineLevels(3);
options.getOutlineOptions().setExpandedOutlineLevels(1);

doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToPdfWithOutline.pdf", options);

Example:

Shows how to sign a generated PDF document using Aspose.Words.
// Create a simple document from scratch.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Test Signed PDF.");

// Load the certificate from disk.
// The other constructor overloads can be used to load certificates from different locations.
CertificateHolder cert = CertificateHolder.create(
    getMyDir() + "morzal.pfx", "aw");

// Pass the certificate and details to the save options class to sign with.
PdfSaveOptions options = new PdfSaveOptions();
options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(
    cert,
    "Test Signing",
    "Aspose Office",
    new Date()));

// Save the document as PDF with the digital signature set.
doc.save(getMyDir() + "\\Artifacts\\Document.Signed.pdf", options);

Constructor Summary
PdfSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFormat.PDF format.
 
Property Getters/Setters Summary
intgetColorMode()
void
setColorMode(intvalue)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
intgetCompliance()
void
setCompliance(intvalue)
           Specifies the PDF standards compliance level for output documents. The value of the property is PdfCompliance integer constant.
booleangetCreateNoteHyperlinks()
void
           Specifies whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. Default is false.
intgetCustomPropertiesExport()
void
           Gets or sets a value determining the way Document.CustomDocumentProperties are exported to PDF file. Default value is PdfCustomPropertiesExport.NONE. The value of the property is PdfCustomPropertiesExport integer constant.
java.lang.StringgetDefaultTemplate()
void
setDefaultTemplate(java.lang.Stringvalue)
           Gets or sets path to default template (including filename). Default value for this property is empty string.
PdfDigitalSignatureDetailsgetDigitalSignatureDetails()
void
           Gets or sets the details for signing the output PDF document.
booleangetDisplayDocTitle()
void
setDisplayDocTitle(booleanvalue)
           A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary.
intgetDmlEffectsRenderingMode()
void
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()
void
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
DownsampleOptionsgetDownsampleOptions()
void
           Allows to specify downsample options.
booleangetEmbedFullFonts()
void
setEmbedFullFonts(booleanvalue)
           Controls how fonts are embedded into the resulting PDF documents.
PdfEncryptionDetailsgetEncryptionDetails()
void
           Gets or sets the details for encrypting the output PDF document.
booleangetEscapeUri()
void
setEscapeUri(booleanvalue)
           A flag specifying whether URI should be escaped before writing.
booleangetExportDocumentStructure()
void
           Gets or sets a value determining whether or not to export document structure.
intgetFontEmbeddingMode()
void
           Specifies the font embedding mode. The value of the property is PdfFontEmbeddingMode integer constant.
intgetHeaderFooterBookmarksExportMode()
void
           Determines how bookmarks in headers/footers are exported. The value of the property is HeaderFooterBookmarksExportMode integer constant.
intgetImageColorSpaceExportMode()
void
           Specifies how the color space will be selected for the images in PDF document. The value of the property is PdfImageColorSpaceExportMode integer constant.
intgetImageCompression()
void
           Specifies compression type to be used for all images in the document. Default is PdfImageCompression.AUTO. The value of the property is PdfImageCompression integer constant.
intgetJpegQuality()
void
setJpegQuality(intvalue)
           Gets or sets a value determining the quality of the JPEG images inside PDF document.
booleangetMemoryOptimization()
void
setMemoryOptimization(booleanvalue)
           Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
MetafileRenderingOptionsgetMetafileRenderingOptions()
void
           Allows to specify metafile rendering options.
intgetNumeralFormat()
void
           Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant.
booleangetOpenHyperlinksInNewWindow()
void
           Gets or sets a value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.
booleangetOptimizeOutput()
void
setOptimizeOutput(booleanvalue)
           Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
OutlineOptionsgetOutlineOptions()
Allows to specify outline options.
intgetPageCount()
void
setPageCount(intvalue)
           Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.
intgetPageIndex()
void
setPageIndex(intvalue)
           Gets or sets the 0-based index of the first page to save. Default is 0.
intgetPageMode()
void
setPageMode(intvalue)
           Specifies how the PDF document should be displayed when opened in the PDF reader. The value of the property is PdfPageMode integer constant.
IPageSavingCallbackgetPageSavingCallback()
void
           Allows to control how separate pages are saved when a document is exported to fixed page format.
booleangetPreblendImages()
void
setPreblendImages(booleanvalue)
           Gets or sets a value determining whether or not to preblend transparent images with black background color.
booleangetPreserveFormFields()
void
setPreserveFormFields(booleanvalue)
           Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.
booleangetPrettyFormat()
void
setPrettyFormat(booleanvalue)
           When true, pretty formats output where applicable. Default value is false.
intgetSaveFormat()
void
setSaveFormat(intvalue)
           Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.PDF. The value of the property is SaveFormat integer constant.
java.lang.StringgetTempFolder()
void
setTempFolder(java.lang.Stringvalue)
           Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.
intgetTextCompression()
void
           Specifies compression type to be used for all textual content in the document. The value of the property is PdfTextCompression integer constant.
booleangetUpdateFields()
void
setUpdateFields(booleanvalue)
           Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
booleangetUpdateLastSavedTimeProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()
void
setUpdateSdtContent(booleanvalue)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()
void
setUseAntiAliasing(booleanvalue)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseBookFoldPrintingSettings()
void
           Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.MultiplePages.
booleangetUseCoreFonts()
void
setUseCoreFonts(booleanvalue)
           Gets or sets a value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.
booleangetUseHighQualityRendering()
void
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
intgetZoomBehavior()
void
setZoomBehavior(intvalue)
           Gets or sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer. The value of the property is PdfZoomBehavior integer constant.
intgetZoomFactor()
void
setZoomFactor(intvalue)
           Gets or sets a value determining zoom factor (in percentages) for a document.
 
Method Summary
PdfSaveOptionsdeepClone()
Creates a deep clone of this object.
booleanequals(java.lang.Object obj)
 

    • Constructor Detail

      • PdfSaveOptions

        public PdfSaveOptions()
        Initializes a new instance of this class that can be used to save a document in the SaveFormat.PDF format.

        Example:

        Demonstrates how to set Aspose.Words to embed full fonts in the output PDF document.
        // Load the document to render.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // Aspose.Words embeds full fonts by default when EmbedFullFonts is set to true. The property below can be changed
        // each time a document is rendered.
        PdfSaveOptions options = new PdfSaveOptions();
        options.setEmbedFullFonts(true);
        
        // The output PDF will be embedded with all fonts found in the document.
        doc.save(getMyDir() + "\\Artifacts\\Rendering.EmbedFullFonts.pdf");
    • Property Getters/Setters Detail

      • getColorMode/setColorMode

        public int getColorMode() / public void setColorMode(int value)
        
        Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.The default value is ColorMode.NORMAL.

        This property is used when the document is exported to fixed page formats.

        Example:

        Shows how change image color with save options property
        // Open document with color image
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // Set grayscale mode for document
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE);
        
        // Assert that color image in document was grey
        doc.save(getMyDir() + "\\Artifacts\\ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);
      • getCompliance/setCompliance

        public int getCompliance() / public void setCompliance(int value)
        
        Specifies the PDF standards compliance level for output documents. The value of the property is PdfCompliance integer constant.

        Default is PdfCompliance.PDF_15.

        Example:

        Shows how to save images to PDF using JPEG encoding to decrease file size.
        Document doc = new Document(getMyDir() + "SaveOptions.PdfImageCompression.rtf");
        
        PdfSaveOptions options = new PdfSaveOptions();
        
        options.setImageCompression(PdfImageCompression.JPEG);
        options.setPreserveFormFields(true);
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.PdfImageCompression.pdf", options);
        
        PdfSaveOptions optionsA1B = new PdfSaveOptions();
        optionsA1B.setCompliance(PdfCompliance.PDF_A_1_B);
        optionsA1B.setImageCompression(PdfImageCompression.JPEG);
        optionsA1B.setJpegQuality(50); // Use JPEG compression at 50% quality to reduce file size.
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.PdfImageComppression PDF_A_1_B.pdf", optionsA1B);
      • getCreateNoteHyperlinks/setCreateNoteHyperlinks

        public boolean getCreateNoteHyperlinks() / public void setCreateNoteHyperlinks(boolean value)
        
        Specifies whether to convert footnote/endnote references in main text story into active hyperlinks. When clicked the hyperlink will lead to the corresponding footnote/endnote. Default is false.
      • getDefaultTemplate/setDefaultTemplate

        public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value)
        
        Gets or sets path to default template (including filename). Default value for this property is empty string. If specified, this path is used to load template when Document.AutomaticallyUpdateSyles is true, but Document.AttachedTemplate is empty.
      • getDigitalSignatureDetails/setDigitalSignatureDetails

        public PdfDigitalSignatureDetails getDigitalSignatureDetails() / public void setDigitalSignatureDetails(PdfDigitalSignatureDetails value)
        
        Gets or sets the details for signing the output PDF document.

        At the moment digitally signing PDF documents is only available on .NET 2.0 or higher.

        The default value is null and the output document will not be signed. When this property is set to a valid PdfDigitalSignatureDetails object, then the output PDF document will be digitally signed.

        Example:

        Shows how to sign a generated PDF document using Aspose.Words.
        // Create a simple document from scratch.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Test Signed PDF.");
        
        // Load the certificate from disk.
        // The other constructor overloads can be used to load certificates from different locations.
        CertificateHolder cert = CertificateHolder.create(
            getMyDir() + "morzal.pfx", "aw");
        
        // Pass the certificate and details to the save options class to sign with.
        PdfSaveOptions options = new PdfSaveOptions();
        options.setDigitalSignatureDetails(new PdfDigitalSignatureDetails(
            cert,
            "Test Signing",
            "Aspose Office",
            new Date()));
        
        // Save the document as PDF with the digital signature set.
        doc.save(getMyDir() + "\\Artifacts\\Document.Signed.pdf", options);
      • getDisplayDocTitle/setDisplayDocTitle

        public boolean getDisplayDocTitle() / public void setDisplayDocTitle(boolean value)
        
        A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary. If false, the title bar should instead display the name of the PDF file containing the document.

        The default value is false.

        Example:

        Shows how to display title of the document as title bar.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        doc.getBuiltInDocumentProperties().setTitle("Windows bar pdf title");
        
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setDisplayDocTitle(true);
        
        doc.save(getMyDir() + "\\Artifacts\\PdfTitle.pdf", pdfSaveOptions);
      • getDmlRenderingMode/setDmlRenderingMode

        public int getDmlRenderingMode() / public void setDmlRenderingMode(int value)
        
        Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. The default value is DmlRenderingMode.FALLBACK.

        This property is used when the document is exported to fixed page formats.

        Example:

        Shows how to define rendering for DML shapes
        Document doc = DocumentHelper.createDocumentFillWithDummyText();
        
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML);
        
        doc.save(getMyDir() + "\\Artifacts\\DrawingMl.pdf", pdfSaveOptions);
      • getDownsampleOptions/setDownsampleOptions

        public DownsampleOptions getDownsampleOptions() / public void setDownsampleOptions(DownsampleOptions value)
        
        Allows to specify downsample options.
      • getEmbedFullFonts/setEmbedFullFonts

        public boolean getEmbedFullFonts() / public void setEmbedFullFonts(boolean value)
        
        Controls how fonts are embedded into the resulting PDF documents.

        The default value is false, which means the fonts are subsetted before embedding. Subsetting is useful if you want to keep the output file size smaller. Subsetting removes all unused glyphs from a font.

        When this value is set to true, a complete font file is embedded into PDF without subsetting. This will result in larger output files, but can be a useful option when you want to edit the resulting PDF later (e.g. add more text).

        Some fonts are large (several megabytes) and embedding them without subsetting will result in large output documents.

        Example:

        Demonstrates how to set Aspose.Words to embed full fonts in the output PDF document.
        // Load the document to render.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // Aspose.Words embeds full fonts by default when EmbedFullFonts is set to true. The property below can be changed
        // each time a document is rendered.
        PdfSaveOptions options = new PdfSaveOptions();
        options.setEmbedFullFonts(true);
        
        // The output PDF will be embedded with all fonts found in the document.
        doc.save(getMyDir() + "\\Artifacts\\Rendering.EmbedFullFonts.pdf");

        Example:

        Demonstrates how to set Aspose.Words to subset fonts in the output PDF.
        // Load the document to render.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // To subset fonts in the output PDF document, simply create new PdfSaveOptions and set EmbedFullFonts to false.
        PdfSaveOptions options = new PdfSaveOptions();
        options.setEmbedFullFonts(false);
        
        // The output PDF will contain subsets of the fonts in the document. Only the glyphs used
        // in the document are included in the PDF fonts.
        doc.save(getMyDir() + "\\Artifacts\\Rendering.SubsetFonts.pdf");
      • getEncryptionDetails/setEncryptionDetails

        public PdfEncryptionDetails getEncryptionDetails() / public void setEncryptionDetails(PdfEncryptionDetails value)
        
        Gets or sets the details for encrypting the output PDF document.

        The default value is null and the output document will not be encrypted. When this property is set to a valid PdfEncryptionDetails object, then the output PDF document will be encrypted.

        Note that encryption cannot be used when PDF/A compliance is set as this compliance does not permit encryption.");

        Example:

        Demonstrates how to set permissions on a PDF document generated by Aspose.Words.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        PdfSaveOptions saveOptions = new PdfSaveOptions();
        
        // Create encryption details and set owner password.
        PdfEncryptionDetails encryptionDetails = new PdfEncryptionDetails("", "password", PdfEncryptionAlgorithm.RC_4_128);
        
        // Start by disallowing all permissions.
        encryptionDetails.setPermissions(PdfPermissions.DISALLOW_ALL);
        
        // Extend permissions to allow editing or modifying annotations.
        encryptionDetails.setPermissions(PdfPermissions.MODIFY_ANNOTATIONS | PdfPermissions.DOCUMENT_ASSEMBLY);
        saveOptions.setEncryptionDetails(encryptionDetails);
        
        // Render the document to PDF format with the specified permissions.
        doc.save(getMyDir() + "\\Artifacts\\Rendering.SpecifyPermissions.pdf", saveOptions);
      • getEscapeUri/setEscapeUri

        public boolean getEscapeUri() / public void setEscapeUri(boolean value)
        
        A flag specifying whether URI should be escaped before writing. Note that if this option is set to false hyperlinks are written "as is", so valid (escaped) URI should be provided in document's model.

        The default value is true.

      • getExportDocumentStructure/setExportDocumentStructure

        public boolean getExportDocumentStructure() / public void setExportDocumentStructure(boolean value)
        
        Gets or sets a value determining whether or not to export document structure.

        This value is ignored when saving to PDF/A-1a because document structure is required for this compliance.

        Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.

      • getFontEmbeddingMode/setFontEmbeddingMode

        public int getFontEmbeddingMode() / public void setFontEmbeddingMode(int value)
        
        Specifies the font embedding mode. The value of the property is PdfFontEmbeddingMode integer constant.

        The default value is PdfFontEmbeddingMode.EMBED_ALL.

        This setting works only for the text in ANSI (Windows-1252) encoding. If the document contains non-ANSI text then corresponding fonts will be embedded regardless of this setting.

        Note that when saving to PDF/A this option must be set to PdfFontEmbeddingMode.EMBED_ALL as all fonts must be embedded in the PDF file.

        Example:

        Shows how to set Aspose.Words to skip embedding Arial and Times New Roman fonts into a PDF document.
        // Load the document to render.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // To disable embedding standard windows font use the PdfSaveOptions and set the EmbedStandardWindowsFonts property to false.
        PdfSaveOptions options = new PdfSaveOptions();
        options.setFontEmbeddingMode(PdfFontEmbeddingMode.EMBED_NONE);
        
        // The output PDF will be saved without embedding standard windows fonts.
        doc.save(getMyDir() + "\\Artifacts\\Rendering.DisableEmbedWindowsFonts.pdf");
      • getHeaderFooterBookmarksExportMode/setHeaderFooterBookmarksExportMode

        public int getHeaderFooterBookmarksExportMode() / public void setHeaderFooterBookmarksExportMode(int value)
        
        Determines how bookmarks in headers/footers are exported. The value of the property is HeaderFooterBookmarksExportMode integer constant. The default value is HeaderFooterBookmarksExportMode.ALL.
      • getImageCompression/setImageCompression

        public int getImageCompression() / public void setImageCompression(int value)
        
        Specifies compression type to be used for all images in the document. Default is PdfImageCompression.AUTO. The value of the property is PdfImageCompression integer constant. Using PdfImageCompression.JPEG lets you control quality of images in the output document through the JpegQuality property. Using PdfImageCompression.JPEG provides the fastest conversion speed when compared to the performance of other compression types.

        Example:

        Shows how to save images to PDF using JPEG encoding to decrease file size.
        Document doc = new Document(getMyDir() + "SaveOptions.PdfImageCompression.rtf");
        
        PdfSaveOptions options = new PdfSaveOptions();
        
        options.setImageCompression(PdfImageCompression.JPEG);
        options.setPreserveFormFields(true);
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.PdfImageCompression.pdf", options);
        
        PdfSaveOptions optionsA1B = new PdfSaveOptions();
        optionsA1B.setCompliance(PdfCompliance.PDF_A_1_B);
        optionsA1B.setImageCompression(PdfImageCompression.JPEG);
        optionsA1B.setJpegQuality(50); // Use JPEG compression at 50% quality to reduce file size.
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.PdfImageComppression PDF_A_1_B.pdf", optionsA1B);
      • getJpegQuality/setJpegQuality

        public int getJpegQuality() / public void setJpegQuality(int value)
        
        Gets or sets a value determining the quality of the JPEG images inside PDF document.

        Has effect only when a document contains JPEG images.

        Use this property to get or set the quality of the images inside a document when saving in PDF format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression. If quality is 100 and source image is JPEG, it means no compression - original bytes will be saved.

        The default value is 100.

        Example:

        Shows how to save images to PDF using JPEG encoding to decrease file size.
        Document doc = new Document(getMyDir() + "SaveOptions.PdfImageCompression.rtf");
        
        PdfSaveOptions options = new PdfSaveOptions();
        
        options.setImageCompression(PdfImageCompression.JPEG);
        options.setPreserveFormFields(true);
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.PdfImageCompression.pdf", options);
        
        PdfSaveOptions optionsA1B = new PdfSaveOptions();
        optionsA1B.setCompliance(PdfCompliance.PDF_A_1_B);
        optionsA1B.setImageCompression(PdfImageCompression.JPEG);
        optionsA1B.setJpegQuality(50); // Use JPEG compression at 50% quality to reduce file size.
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.PdfImageComppression PDF_A_1_B.pdf", optionsA1B);
      • getMemoryOptimization/setMemoryOptimization

        public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value)
        
        Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false. Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.

        Example:

        Shows an option to optimize memory consumption when you work with large documents.
        Document doc = new Document(getMyDir() + "SaveOptions.MemoryOptimization.doc");
        
        // When set to true it will improve document memory footprint but will add extra time to processing. 
        // This optimization is only applied during save operation.
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
        saveOptions.setMemoryOptimization(true);
        
        doc.save(getMyDir() + "\\Artifacts\\SaveOptions.MemoryOptimization.pdf", saveOptions);
      • getMetafileRenderingOptions/setMetafileRenderingOptions

        public MetafileRenderingOptions getMetafileRenderingOptions() / public void setMetafileRenderingOptions(MetafileRenderingOptions value)
        
        Allows to specify metafile rendering options.
      • getNumeralFormat/setNumeralFormat

        public int getNumeralFormat() / public void setNumeralFormat(int value)
        
        Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant. If the value of this property is changed and page layout is already built then Document.updatePageLayout() is invoked automatically to update any changes.

        Example:

        Demonstrates how to set the numeral format used when saving to PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        options.setNumeralFormat(NumeralFormat.CONTEXT);
      • getOpenHyperlinksInNewWindow/setOpenHyperlinksInNewWindow

        public boolean getOpenHyperlinksInNewWindow() / public void setOpenHyperlinksInNewWindow(boolean value)
        
        Gets or sets a value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.

        The default value is false. When this value is set to true hyperlinks are saved using JavaScript code. JavaScript code is app.launchURL("URL", true);, where URL is a hyperlink.

        Note that if this option is set to true hyperlinks can't work in some PDF readers e.g. Chrome, Firefox.

      • getOptimizeOutput/setOptimizeOutput

        public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value)
        
        Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
      • getOutlineOptions

        public OutlineOptions getOutlineOptions()
        
        Allows to specify outline options.
      • getPageCount/setPageCount

        public int getPageCount() / public void setPageCount(int value)
        
        Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.

        Example:

        Converts just one page (third page in this example) of the document to PDF.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        OutputStream stream = new FileOutputStream(getMyDir() + "\\Artifacts\\Rendering.SaveToPdfStreamOnePage.pdf");
        try
        {
            PdfSaveOptions options = new PdfSaveOptions();
            options.setPageIndex(2);
            options.setPageCount(1);
            doc.save(stream, options);
        } finally
        {
            if (stream != null) stream.close();
        }
      • getPageIndex/setPageIndex

        public int getPageIndex() / public void setPageIndex(int value)
        
        Gets or sets the 0-based index of the first page to save. Default is 0.

        Example:

        Converts just one page (third page in this example) of the document to PDF.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        OutputStream stream = new FileOutputStream(getMyDir() + "\\Artifacts\\Rendering.SaveToPdfStreamOnePage.pdf");
        try
        {
            PdfSaveOptions options = new PdfSaveOptions();
            options.setPageIndex(2);
            options.setPageCount(1);
            doc.save(stream, options);
        } finally
        {
            if (stream != null) stream.close();
        }
      • getPageMode/setPageMode

        public int getPageMode() / public void setPageMode(int value)
        
        Specifies how the PDF document should be displayed when opened in the PDF reader. The value of the property is PdfPageMode integer constant. The default value is PdfPageMode.USE_OUTLINES.
      • getPageSavingCallback/setPageSavingCallback

        public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value)
        
        Allows to control how separate pages are saved when a document is exported to fixed page format.

        Example:

        Shows how separate pages are saved when a document is exported to fixed page format.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
            HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
            {
                htmlFixedSaveOptions.setPageIndex(0);
                htmlFixedSaveOptions.setPageCount(doc.getPageCount());
            }
            htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());
        
            doc.save(getMyDir() + "\\Artifacts\\Rendering.html", htmlFixedSaveOptions);
        
            String[] filePaths = GetFiles(getMyDir() + "\\Artifacts\\", "Page_*.html");
        
            for (int i = 0; i < doc.getPageCount(); i++)
            {
                String file = MessageFormat.format(getMyDir() + "\\Artifacts\\Page_{0}.html", i);
            }
        }
        
        private static String[] GetFiles(final String path, final String searchPattern)
        {
            final Pattern re = Pattern.compile(searchPattern.replace("*", ".*").replace("?", ".?"));
            String[] filenames = new File(path).list(new FilenameFilter()
            {
                @Override
                public boolean accept(File dir, String name)
                {
                    return new File(dir, name).isFile() && re.matcher(name).matches();
                }
            });
            for (int i = 0; i < filenames.length; i++)
            {
                filenames[i] = path + filenames[i];
            }
            return filenames;
        }
        
        /** 
         * Custom PageFileName is specified.
         */
        private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback
        {
            public void pageSaving(PageSavingArgs args) throws Exception
            {
                // Specify name of the output file for the current page.
                args.setPageFileName(MessageFormat.format(getMyDir() + "\\Artifacts\\Page_{0}.html", args.getPageIndex()));
            }
        }
      • getPreblendImages/setPreblendImages

        public boolean getPreblendImages() / public void setPreblendImages(boolean value)
        
        Gets or sets a value determining whether or not to preblend transparent images with black background color.

        Preblending images may improve PDF document visual appearance in Adobe Reader and remove anti-aliasing artifacts.

        In order to properly display preblended images, PDF viewer application must support /Matte entry in soft-mask image dictionary. Also preblending images may decrease PDF rendering performance.

        The default value is false.

      • getPreserveFormFields/setPreserveFormFields

        public boolean getPreserveFormFields() / public void setPreserveFormFields(boolean value)
        
        Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text. Default is false.

        Microsoft Word form fields include text input, drop down and check box controls. When set to false, these fields will be exported as text to PDF. When set to true, these fields will be exported as PDF form fields.

        When exporting form fields to PDF as form fields, some formatting loss might occur because PDF form fields do not support all features of Microsoft Word form fields.

        Example:

        Shows how to save a document to the PDF format using the Save method and the PdfSaveOptions class.
        // Open the document
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // Option 1: Save document to file in the PDF format with default options
        doc.save(getMyDir() + "\\Artifacts\\Rendering.PdfDefaultOptions.pdf");
        
        // Option 2: Save the document to stream in the PDF format with default options
        ByteArrayOutputStream stream = new ByteArrayOutputStream();
        doc.save(stream, SaveFormat.PDF);
        
        // Option 3: Save document to the PDF format with specified options
        // Render the first page only and preserve form fields as usable controls and not as plain text
        PdfSaveOptions pdfOptions = new PdfSaveOptions();
        pdfOptions.setPageIndex(0);
        pdfOptions.setPageCount(1);
        pdfOptions.setPreserveFormFields(true);
        doc.save(getMyDir() + "\\Artifacts\\Rendering.PdfCustomOptions.pdf", pdfOptions);
      • getPrettyFormat/setPrettyFormat

        public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
        
        When true, pretty formats output where applicable. Default value is false.

        Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.

        Example:

        Shows how to pass an option to export HTML tags in a well spaced, human readable format.
        Document doc = new Document(getMyDir() + "Document.doc");
        
        HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
        // Enabling the PrettyFormat setting will export HTML in an indented format that is easy to read.
        // If this is setting is false (by default) then the HTML tags will be exported in condensed form with no indentation.
        htmlOptions.setPrettyFormat(true);
        
        doc.save(getMyDir() + "\\Artifacts\\Document.PrettyFormat.html", htmlOptions);
      • getSaveFormat/setSaveFormat

        public int getSaveFormat() / public void setSaveFormat(int value)
        
        Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.PDF. The value of the property is SaveFormat integer constant.
      • getTempFolder/setTempFolder

        public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value)
        
        Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.

        When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.

        If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw System.OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

        The folder must exist and be writable, otherwise an exception will be thrown.

        Aspose.Words automatically deletes all temporary files when saving is complete.

      • getTextCompression/setTextCompression

        public int getTextCompression() / public void setTextCompression(int value)
        
        Specifies compression type to be used for all textual content in the document. The value of the property is PdfTextCompression integer constant.

        Default is PdfTextCompression.FLATE.

        Example:

        Saves a document to PDF without compression.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        PdfSaveOptions options = new PdfSaveOptions();
        options.setTextCompression(PdfTextCompression.NONE);
        
        doc.save(getMyDir() + "\\Artifacts\\Rendering.SaveToPdfNoCompression.pdf", options);
      • getUpdateFields/setUpdateFields

        public boolean getUpdateFields() / public void setUpdateFields(boolean value)
        
        Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true. Allows to specify whether to mimic or not MS Word behaviour.

        Example:

        Shows how to update fields before saving into a PDF document.
        Document doc = DocumentHelper.createDocumentFillWithDummyText();
        
        PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
        pdfSaveOptions.setUpdateFields(false);
        
        doc.save(getMyDir() + "\\Artifacts\\UpdateFields_False.pdf", pdfSaveOptions);
      • getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty

        public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.

        Example:

        Shows how to update a document time property when you want to save it
        Document doc = new Document(getMyDir() + "Document.doc");
        
        //Get last saved time
        Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime();
        
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
        saveOptions.setUpdateLastSavedTimeProperty(true);
      • getUpdateSdtContent/setUpdateSdtContent

        public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value)
        
        Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. The default value is true.
      • getUseAntiAliasing/setUseAntiAliasing

        public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
        
        Gets or sets a value determining whether or not to use anti-aliasing for rendering.

        The default value is false. When this value is set to true anti-aliasing is used for rendering.

        This property is used when the document is exported to the following formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.

      • getUseBookFoldPrintingSettings/setUseBookFoldPrintingSettings

        public boolean getUseBookFoldPrintingSettings() / public void setUseBookFoldPrintingSettings(boolean value)
        
        Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.MultiplePages.

        If this option is specified, page range set via PageIndex and PageCount is ignored when saving. This behavior matches MS Word. If book fold printing settings are not specified in page setup, this option will have no effect.

      • getUseCoreFonts/setUseCoreFonts

        public boolean getUseCoreFonts() / public void setUseCoreFonts(boolean value)
        
        Gets or sets a value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.

        The default value is false. When this value is set to true Arial, Times New Roman, Courier New and Symbol fonts are replaced in PDF document with corresponding core Type 1 font.

        Core PDF fonts, or their font metrics and suitable substitution fonts, are required to be available to any PDF viewer application.

        This setting works only for the text in ANSI (Windows-1252) encoding. Non-ANSI text will be written with embedded TrueType font regardless of this setting.

        Settings core fonts to true is not allowed when saving to PDF/A as this compliance requires all fonts to be embedded.

        This option has a higher priority then FontEmbeddingMode option.

        Example:

        Shows how to set Aspose.Words to avoid embedding core fonts and let the reader substitute PDF Type 1 fonts instead.
        // Load the document to render.
        Document doc = new Document(getMyDir() + "Rendering.doc");
        
        // To disable embedding of core fonts and substitute PDF type 1 fonts set UseCoreFonts to true.
        PdfSaveOptions options = new PdfSaveOptions();
        options.setUseCoreFonts(true);
        
        // The output PDF will not be embedded with core fonts such as Arial, Times New Roman etc.
        doc.save(getMyDir() + "\\Artifacts\\Rendering.DisableEmbedWindowsFonts.pdf");
      • getUseHighQualityRendering/setUseHighQualityRendering

        public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
        
        Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. The default value is false.

        This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.

      • getZoomBehavior/setZoomBehavior

        public int getZoomBehavior() / public void setZoomBehavior(int value)
        
        Gets or sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer. The value of the property is PdfZoomBehavior integer constant. The default value is PdfZoomBehavior.NONE, i.e. no fit is applied.
      • getZoomFactor/setZoomFactor

        public int getZoomFactor() / public void setZoomFactor(int value)
        
        Gets or sets a value determining zoom factor (in percentages) for a document. This value is used only if ZoomBehavior is set to PdfZoomBehavior.ZOOM_FACTOR.
    • Method Detail

      • deepClone

        public PdfSaveOptions deepClone()
        Creates a deep clone of this object.
      • equals

        public boolean equals(java.lang.Object obj)