PdfSaveOptions (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.SaveOptions
- - com.aspose.words.FixedPageSaveOptions
  - - com.aspose.words.PdfSaveOptions

All Implemented Interfaces:

java.lang.Cloneable
```
public class PdfSaveOptions
extends FixedPageSaveOptions
implements java.lang.Cloneable
```
Can be used to specify additional options when saving a document into the SaveFormat.PDF format.
To learn more, visit the Specify Save Options documentation article.

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`PdfSaveOptions()` Initializes a new instance of this class that can be used to save a document in the `SaveFormat.PDF` format.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PdfSaveOptions`	`deepClone()` Creates a deep clone of this object.
`boolean`	`getAdditionalTextPositioning()` A flag specifying whether to write additional text positioning operators or not.
`boolean`	`getCacheHeaderFooterShapes()` Gets a value determining whether or not to cache shapes placed in header and footer of document.
`int`	`getCompliance()` Specifies the PDF standards compliance level for output documents.
`boolean`	`getCreateNoteHyperlinks()` Specifies whether to convert footnote/endnote references in main text story into active hyperlinks.
`int`	`getCustomPropertiesExport()` Gets a value determining the way `Document.getCustomDocumentProperties()` are exported to PDF file.
`PdfDigitalSignatureDetails`	`getDigitalSignatureDetails()` Gets the details for signing the output PDF document.
`boolean`	`getDisplayDocTitle()` A flag specifying whether the window’s title bar should display the document title taken from the Title entry of the document information dictionary.
`int`	`getDmlEffectsRenderingMode()` Gets a value determining how DrawingML effects are rendered.
`DownsampleOptions`	`getDownsampleOptions()` Allows to specify downsample options.
`boolean`	`getEmbedFullFonts()` Controls how fonts are embedded into the resulting PDF documents.
`PdfEncryptionDetails`	`getEncryptionDetails()` Gets the details for encrypting the output PDF document.
`boolean`	`getExportDocumentStructure()` Gets a value determining whether or not to export document structure.
`boolean`	`getExportLanguageToSpanTag()` Gets a value determining whether or not to create a "Span" tag in the document structure to export the text language.
`int`	`getFontEmbeddingMode()` Specifies the font embedding mode.
`int`	`getHeaderFooterBookmarksExportMode()` Determines how bookmarks in headers/footers are exported.
`int`	`getImageColorSpaceExportMode()` Specifies how the color space will be selected for the images in PDF document.
`int`	`getImageCompression()` Specifies compression type to be used for all images in the document.
`boolean`	`getInterpolateImages()` A flag indicating whether image interpolation shall be performed by a conforming reader.
`int`	`getJpegQuality()` Gets a value determining the quality of the JPEG images inside PDF document.
`boolean`	`getOpenHyperlinksInNewWindow()` Gets a value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.
`OutlineOptions`	`getOutlineOptions()` Allows to specify outline options.
`int`	`getPageMode()` Specifies how the PDF document should be displayed when opened in the PDF reader.
`boolean`	`getPreblendImages()` Gets a value determining whether or not to preblend transparent images with black background color.
`boolean`	`getPreserveFormFields()` Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text.
`int`	`getSaveFormat()` Specifies the format in which the document will be saved if this save options object is used.
`int`	`getTextCompression()` Specifies compression type to be used for all textual content in the document.
`boolean`	`getUseBookFoldPrintingSettings()` Gets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via `PageSetup.getMultiplePages()` / `PageSetup.setMultiplePages(int)`.
`boolean`	`getUseCoreFonts()` Gets a value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.
`int`	`getZoomBehavior()` Gets a value determining what type of zoom should be applied when a document is opened with a PDF viewer.
`int`	`getZoomFactor()` Gets a value determining zoom factor (in percentages) for a document.
`protected java.lang.Object`	`memberwiseClone()`
`void`	`setAdditionalTextPositioning(boolean value)` A flag specifying whether to write additional text positioning operators or not.
`void`	`setCacheHeaderFooterShapes(boolean value)` Sets a value determining whether or not to cache shapes placed in header and footer of document.
`void`	`setCompliance(int value)` Specifies the PDF standards compliance level for output documents.
`void`	`setCreateNoteHyperlinks(boolean value)` Specifies whether to convert footnote/endnote references in main text story into active hyperlinks.
`void`	`setCustomPropertiesExport(int value)` Sets a value determining the way `Document.getCustomDocumentProperties()` are exported to PDF file.
`void`	`setDigitalSignatureDetails(PdfDigitalSignatureDetails value)` Sets the details for signing the output PDF document.
`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.
`void`	`setDmlEffectsRenderingMode(int value)` Sets a value determining how DrawingML effects are rendered.
`void`	`setDownsampleOptions(DownsampleOptions value)` Allows to specify downsample options.
`void`	`setEmbedFullFonts(boolean value)` Controls how fonts are embedded into the resulting PDF documents.
`void`	`setEncryptionDetails(PdfEncryptionDetails value)` Sets the details for encrypting the output PDF document.
`void`	`setExportDocumentStructure(boolean value)` Sets a value determining whether or not to export document structure.
`void`	`setExportLanguageToSpanTag(boolean value)` Sets a value determining whether or not to create a "Span" tag in the document structure to export the text language.
`void`	`setFontEmbeddingMode(int value)` Specifies the font embedding mode.
`void`	`setHeaderFooterBookmarksExportMode(int value)` Determines how bookmarks in headers/footers are exported.
`void`	`setImageColorSpaceExportMode(int value)` Specifies how the color space will be selected for the images in PDF document.
`void`	`setImageCompression(int value)` Specifies compression type to be used for all images in the document.
`void`	`setInterpolateImages(boolean value)` A flag indicating whether image interpolation shall be performed by a conforming reader.
`void`	`setJpegQuality(int value)` Sets a value determining the quality of the JPEG images inside PDF document.
`void`	`setOpenHyperlinksInNewWindow(boolean value)` 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.
`void`	`setPageMode(int value)` Specifies how the PDF document should be displayed when opened in the PDF reader.
`void`	`setPreblendImages(boolean value)` Sets a value determining whether or not to preblend transparent images with black background color.
`void`	`setPreserveFormFields(boolean value)` Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text.
`void`	`setSaveFormat(int value)` Specifies the format in which the document will be saved if this save options object is used.
`void`	`setTextCompression(int value)` Specifies compression type to be used for all textual content in the document.
`void`	`setUseBookFoldPrintingSettings(boolean value)` Sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via `PageSetup.getMultiplePages()` / `PageSetup.setMultiplePages(int)`.
`void`	`setUseCoreFonts(boolean value)` 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.
`void`	`setZoomBehavior(int value)` Sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer.
`void`	`setZoomFactor(int value)` Sets a value determining zoom factor (in percentages) for a document.

Methods inherited from class com.aspose.words.FixedPageSaveOptions
equals, getColorMode, getMetafileRenderingOptions, getNumeralFormat, getOptimizeOutput, getPageSavingCallback, getPageSet, setColorMode, setMetafileRenderingOptions, setNumeralFormat, setOptimizeOutput, setPageSavingCallback, setPageSet

Methods inherited from class com.aspose.words.SaveOptions
createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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.
- Method Detail
  - getSaveFormat
```
public int getSaveFormat()
```
    Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.PDF.
    
    Specified by:
    
    getSaveFormat in class SaveOptions
    
    Returns:
    
    The corresponding int value. The returned value is one of SaveFormat constants.
  - setSaveFormat
```
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.
    
    Specified by:
    
    setSaveFormat in class SaveOptions
    
    Parameters:
    
    value - The corresponding int value. The value must be one of SaveFormat constants.
  - getOutlineOptions
```
public OutlineOptions getOutlineOptions()
```
    Allows to specify outline options.
    Outlines can be created from headings and bookmarks.
    
    For headings outline level is determined by the heading level.
    
    It is possible to set the max heading level to be included into outlines or disable heading outlines at all.
    
    For bookmarks outline level may be set in options as a default value for all bookmarks or as individual values for particular bookmarks.
    
    Also, outlines can be exported to XPS format by using the same getOutlineOptions() class.
    
    Returns:
    
    The corresponding OutlineOptions value.
  - getTextCompression
```
public int getTextCompression()
```
    Specifies compression type to be used for all textual content in the document.
    Default is PdfTextCompression.FLATE.
    
    Significantly increases output size when saving a document without compression.
    
    Returns:
    
    The corresponding int value. The returned value is one of PdfTextCompression constants.
  - setTextCompression
```
public void setTextCompression(int value)
```
    Specifies compression type to be used for all textual content in the document.
    Default is PdfTextCompression.FLATE.
    
    Significantly increases output size when saving a document without compression.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of PdfTextCompression constants.
  - getJpegQuality
```
public int getJpegQuality()
```
    Gets a value determining the quality of the JPEG images inside PDF document.
    The default value is 100.
    
    This property is used in conjunction with the getImageCompression() / setImageCompression(int) option.
    
    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.
    
    Overrides:
    
    getJpegQuality in class FixedPageSaveOptions
    
    Returns:
    
    A value determining the quality of the JPEG images inside PDF document.
  - setJpegQuality
```
public void setJpegQuality(int value)
```
    Sets a value determining the quality of the JPEG images inside PDF document.
    The default value is 100.
    
    This property is used in conjunction with the getImageCompression() / setImageCompression(int) option.
    
    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.
    
    Overrides:
    
    setJpegQuality in class FixedPageSaveOptions
    
    Parameters:
    
    value - A value determining the quality of the JPEG images inside PDF document.
  - getPreserveFormFields
```
public boolean getPreserveFormFields()
```
    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.
    
    Also, the output size depends on the content size because editable forms in Microsoft Word are inline objects.
    
    Editable forms are prohibited by PDF/A compliance. false value will be used automatically when saving to PDF/A.
    
    Form fields are not supported when saving to PDF/UA. false value will be used automatically.
    
    Returns:
    
    The corresponding boolean value.
  - setPreserveFormFields
```
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.
    
    Also, the output size depends on the content size because editable forms in Microsoft Word are inline objects.
    
    Editable forms are prohibited by PDF/A compliance. false value will be used automatically when saving to PDF/A.
    
    Form fields are not supported when saving to PDF/UA. false value will be used automatically.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getCreateNoteHyperlinks
```
public boolean getCreateNoteHyperlinks()
```
    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.
    
    Returns:
    
    The corresponding boolean value.
  - setCreateNoteHyperlinks
```
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.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getEncryptionDetails
```
public PdfEncryptionDetails getEncryptionDetails()
```
    Gets 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.
    
    AES-128 encryption algorithm is used when saving to PDF 1.7 based compliance (including PDF/UA-1). AES-256 encryption algorithm is used when saving to PDF 2.0 based compliance.
    
    Encryption is prohibited by PDF/A compliance. This option will be ignored when saving to PDF/A.
    
    PdfPermissions.CONTENT_COPY_FOR_ACCESSIBILITY permission is required by PDF/UA compliance if the output document is encrypted. This permission will automatically used when saving to PDF/UA.
    
    PdfPermissions.CONTENT_COPY_FOR_ACCESSIBILITY permission is deprecated in PDF 2.0 format. This permission will be ignored when saving to PDF 2.0.
    
    Returns:
    
    The details for encrypting the output PDF document.
  - setEncryptionDetails
```
public void setEncryptionDetails(PdfEncryptionDetails value)
```
    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.
    
    AES-128 encryption algorithm is used when saving to PDF 1.7 based compliance (including PDF/UA-1). AES-256 encryption algorithm is used when saving to PDF 2.0 based compliance.
    
    Encryption is prohibited by PDF/A compliance. This option will be ignored when saving to PDF/A.
    
    PdfPermissions.CONTENT_COPY_FOR_ACCESSIBILITY permission is required by PDF/UA compliance if the output document is encrypted. This permission will automatically used when saving to PDF/UA.
    
    PdfPermissions.CONTENT_COPY_FOR_ACCESSIBILITY permission is deprecated in PDF 2.0 format. This permission will be ignored when saving to PDF 2.0.
    
    Parameters:
    
    value - The details for encrypting the output PDF document.
  - getDigitalSignatureDetails
```
public PdfDigitalSignatureDetails getDigitalSignatureDetails()
```
    Gets the details for signing the output PDF document.
    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.
    
    Returns:
    
    The details for signing the output PDF document.
  - setDigitalSignatureDetails
```
public void setDigitalSignatureDetails(PdfDigitalSignatureDetails value)
```
    Sets the details for signing the output PDF document.
    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.
    
    Parameters:
    
    value - The details for signing the output PDF document.
  - deepClone
```
public PdfSaveOptions deepClone()
```
    Creates a deep clone of this object.
  - getEmbedFullFonts
```
public boolean getEmbedFullFonts()
```
    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.
    
    Returns:
    
    The corresponding boolean value.
  - setEmbedFullFonts
```
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.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getFontEmbeddingMode
```
public int getFontEmbeddingMode()
```
    Specifies the font embedding mode.
    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.
    
    PDF/A and PDF/UA compliance requires all fonts to be embedded. PdfFontEmbeddingMode.EMBED_ALL value will be used automatically when saving to PDF/A and PDF/UA.
    
    Returns:
    
    The corresponding int value. The returned value is one of PdfFontEmbeddingMode constants.
  - setFontEmbeddingMode
```
public void setFontEmbeddingMode(int value)
```
    Specifies the font embedding mode.
    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.
    
    PDF/A and PDF/UA compliance requires all fonts to be embedded. PdfFontEmbeddingMode.EMBED_ALL value will be used automatically when saving to PDF/A and PDF/UA.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of PdfFontEmbeddingMode constants.
  - getUseCoreFonts
```
public boolean getUseCoreFonts()
```
    Gets 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.
    
    PDF/A and PDF/UA compliance requires all fonts to be embedded. false value will be used automatically when saving to PDF/A and PDF/UA.
    
    Core fonts are not supported when saving to PDF 2.0 format. false value will be used automatically when saving to PDF 2.0.
    
    This option has a higher priority then getFontEmbeddingMode() / setFontEmbeddingMode(int) option.
    
    Returns:
    
    A value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.
  - setUseCoreFonts
```
public void setUseCoreFonts(boolean value)
```
    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.
    
    PDF/A and PDF/UA compliance requires all fonts to be embedded. false value will be used automatically when saving to PDF/A and PDF/UA.
    
    Core fonts are not supported when saving to PDF 2.0 format. false value will be used automatically when saving to PDF 2.0.
    
    This option has a higher priority then getFontEmbeddingMode() / setFontEmbeddingMode(int) option.
    
    Parameters:
    
    value - A value determining whether or not to substitute TrueType fonts Arial, Times New Roman, Courier New and Symbol with core PDF Type 1 fonts.
  - getCustomPropertiesExport
```
public int getCustomPropertiesExport()
```
    Gets a value determining the way Document.getCustomDocumentProperties() are exported to PDF file.
    Default value is PdfCustomPropertiesExport.NONE.
    
    PdfCustomPropertiesExport.METADATA value is not supported when saving to PDF/A. PdfCustomPropertiesExport.STANDARD will be used instead for PDF/A-1 and PDF/A-2 and PdfCustomPropertiesExport.NONE for PDF/A-4.
    
    PdfCustomPropertiesExport.STANDARD value is not supported when saving to PDF 2.0. PdfCustomPropertiesExport.METADATA will be used instead.
    
    Returns:
    
    A value determining the way Document.getCustomDocumentProperties() are exported to PDF file. The returned value is one of PdfCustomPropertiesExport constants.
  - setCustomPropertiesExport
```
public void setCustomPropertiesExport(int value)
```
    Sets a value determining the way Document.getCustomDocumentProperties() are exported to PDF file.
    Default value is PdfCustomPropertiesExport.NONE.
    
    PdfCustomPropertiesExport.METADATA value is not supported when saving to PDF/A. PdfCustomPropertiesExport.STANDARD will be used instead for PDF/A-1 and PDF/A-2 and PdfCustomPropertiesExport.NONE for PDF/A-4.
    
    PdfCustomPropertiesExport.STANDARD value is not supported when saving to PDF 2.0. PdfCustomPropertiesExport.METADATA will be used instead.
    
    Parameters:
    
    value - A value determining the way Document.getCustomDocumentProperties() are exported to PDF file. The value must be one of PdfCustomPropertiesExport constants.
  - getZoomBehavior
```
public int getZoomBehavior()
```
    Gets a value determining what type of zoom should be applied when a document is opened with a PDF viewer. The default value is PdfZoomBehavior.NONE, i.e. no fit is applied.
    
    Returns:
    
    A value determining what type of zoom should be applied when a document is opened with a PDF viewer. The returned value is one of PdfZoomBehavior constants.
  - setZoomBehavior
```
public void setZoomBehavior(int value)
```
    Sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer. The default value is PdfZoomBehavior.NONE, i.e. no fit is applied.
    
    Parameters:
    
    value - A value determining what type of zoom should be applied when a document is opened with a PDF viewer. The value must be one of PdfZoomBehavior constants.
  - getZoomFactor
```
public int getZoomFactor()
```
    Gets a value determining zoom factor (in percentages) for a document. This value is used only if getZoomBehavior() / setZoomBehavior(int) is set to PdfZoomBehavior.ZOOM_FACTOR.
    
    Returns:
    
    A value determining zoom factor (in percentages) for a document.
  - setZoomFactor
```
public void setZoomFactor(int value)
```
    Sets a value determining zoom factor (in percentages) for a document. This value is used only if getZoomBehavior() / setZoomBehavior(int) is set to PdfZoomBehavior.ZOOM_FACTOR.
    
    Parameters:
    
    value - A value determining zoom factor (in percentages) for a document.
  - getImageCompression
```
public int getImageCompression()
```
    Specifies compression type to be used for all images in the document.
    Default is PdfImageCompression.AUTO.
    
    Using PdfImageCompression.JPEG lets you control the quality of images in the output document through the getJpegQuality() / setJpegQuality(int) property.
    
    Using PdfImageCompression.JPEG provides the fastest conversion speed when compared to the performance of other compression types, but in this case, there is lossy JPEG compression.
    
    Using PdfImageCompression.AUTO lets to control the quality of Jpeg in the output document through the getJpegQuality() / setJpegQuality(int) property, but for other formats, raw pixel data is extracted and saved with Flate compression. This case is slower than Jpeg conversion but lossless.
    
    Returns:
    
    The corresponding int value. The returned value is one of PdfImageCompression constants.
  - setImageCompression
```
public void setImageCompression(int value)
```
    Specifies compression type to be used for all images in the document.
    Default is PdfImageCompression.AUTO.
    
    Using PdfImageCompression.JPEG lets you control the quality of images in the output document through the getJpegQuality() / setJpegQuality(int) property.
    
    Using PdfImageCompression.JPEG provides the fastest conversion speed when compared to the performance of other compression types, but in this case, there is lossy JPEG compression.
    
    Using PdfImageCompression.AUTO lets to control the quality of Jpeg in the output document through the getJpegQuality() / setJpegQuality(int) property, but for other formats, raw pixel data is extracted and saved with Flate compression. This case is slower than Jpeg conversion but lossless.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of PdfImageCompression constants.
  - getOpenHyperlinksInNewWindow
```
public boolean getOpenHyperlinksInNewWindow()
```
    Gets 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.
    
    JavaScript actions are prohibited by PDF/A-1 and PDF/A-2 compliance. false will be used automatically when saving to PDF/A-1 and PDF/A-2.
    
    Returns:
    
    A value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.
  - setOpenHyperlinksInNewWindow
```
public void setOpenHyperlinksInNewWindow(boolean value)
```
    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.
    
    JavaScript actions are prohibited by PDF/A-1 and PDF/A-2 compliance. false will be used automatically when saving to PDF/A-1 and PDF/A-2.
    
    Parameters:
    
    value - A value determining whether hyperlinks in the output Pdf document are forced to be opened in a new window (or tab) of a browser.
  - getExportDocumentStructure
```
public boolean getExportDocumentStructure()
```
    Gets a value determining whether or not to export document structure.
    This value is ignored when saving to PDF/A-1a, PDF/A-2a and PDF/UA-1 because document structure is required for this compliance.
    
    Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.
    
    Returns:
    
    A value determining whether or not to export document structure.
  - setExportDocumentStructure
```
public void setExportDocumentStructure(boolean value)
```
    Sets a value determining whether or not to export document structure.
    This value is ignored when saving to PDF/A-1a, PDF/A-2a and PDF/UA-1 because document structure is required for this compliance.
    
    Note that exporting the document structure significantly increases the memory consumption, especially for the large documents.
    
    Parameters:
    
    value - A value determining whether or not to export document structure.
  - getExportLanguageToSpanTag
```
public boolean getExportLanguageToSpanTag()
```
    Gets a value determining whether or not to create a "Span" tag in the document structure to export the text language.
    Default value is false and "Lang" attribute is attached to a marked-content sequence in a page content stream.
    
    When the value is true "Span" tag is created for the text with non-default language and "Lang" attribute is attached to this tag.
    
    This value is ignored when getExportDocumentStructure() / setExportDocumentStructure(boolean) is false.
    
    Returns:
    
    A value determining whether or not to create a "Span" tag in the document structure to export the text language.
  - setExportLanguageToSpanTag
```
public void setExportLanguageToSpanTag(boolean value)
```
    Sets a value determining whether or not to create a "Span" tag in the document structure to export the text language.
    Default value is false and "Lang" attribute is attached to a marked-content sequence in a page content stream.
    
    When the value is true "Span" tag is created for the text with non-default language and "Lang" attribute is attached to this tag.
    
    This value is ignored when getExportDocumentStructure() / setExportDocumentStructure(boolean) is false.
    
    Parameters:
    
    value - A value determining whether or not to create a "Span" tag in the document structure to export the text language.
  - getUseBookFoldPrintingSettings
```
public boolean getUseBookFoldPrintingSettings()
```
    Gets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int).
    If this option is specified, FixedPageSaveOptions.getPageSet() / FixedPageSaveOptions.setPageSet(com.aspose.words.PageSet) 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.
    
    Returns:
    
    A boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int).
  - setUseBookFoldPrintingSettings
```
public void setUseBookFoldPrintingSettings(boolean value)
```
    Sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int).
    If this option is specified, FixedPageSaveOptions.getPageSet() / FixedPageSaveOptions.setPageSet(com.aspose.words.PageSet) 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.
    
    Parameters:
    
    value - A boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.getMultiplePages() / PageSetup.setMultiplePages(int).
  - getDownsampleOptions
```
public DownsampleOptions getDownsampleOptions()
```
    Allows to specify downsample options.
    
    Returns:
    
    The corresponding DownsampleOptions value.
  - setDownsampleOptions
```
public void setDownsampleOptions(DownsampleOptions value)
```
    Allows to specify downsample options.
    
    Parameters:
    
    value - The corresponding DownsampleOptions value.
  - getPageMode
```
public int getPageMode()
```
    Specifies how the PDF document should be displayed when opened in the PDF reader. The default value is PdfPageMode.USE_OUTLINES.
    
    Returns:
    
    The corresponding int value. The returned value is one of PdfPageMode constants.
  - setPageMode
```
public void setPageMode(int value)
```
    Specifies how the PDF document should be displayed when opened in the PDF reader. The default value is PdfPageMode.USE_OUTLINES.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of PdfPageMode constants.
  - getImageColorSpaceExportMode
```
public int getImageColorSpaceExportMode()
```
    Specifies how the color space will be selected for the images in PDF document.
    The default value is PdfImageColorSpaceExportMode.AUTO.
    
    If PdfImageColorSpaceExportMode.SIMPLE_CMYK value is specified, getImageCompression() / setImageCompression(int) option is ignored and Flate compression is used for all images in the document.
    
    PdfImageColorSpaceExportMode.SIMPLE_CMYK value is not supported when saving to PDF/A. PdfImageColorSpaceExportMode.AUTO value will be used instead.
    
    Returns:
    
    The corresponding int value. The returned value is one of PdfImageColorSpaceExportMode constants.
  - setImageColorSpaceExportMode
```
public void setImageColorSpaceExportMode(int value)
```
    Specifies how the color space will be selected for the images in PDF document.
    The default value is PdfImageColorSpaceExportMode.AUTO.
    
    If PdfImageColorSpaceExportMode.SIMPLE_CMYK value is specified, getImageCompression() / setImageCompression(int) option is ignored and Flate compression is used for all images in the document.
    
    PdfImageColorSpaceExportMode.SIMPLE_CMYK value is not supported when saving to PDF/A. PdfImageColorSpaceExportMode.AUTO value will be used instead.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of PdfImageColorSpaceExportMode constants.
  - getPreblendImages
```
public boolean getPreblendImages()
```
    Gets 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.
    
    Returns:
    
    A value determining whether or not to preblend transparent images with black background color.
  - setPreblendImages
```
public void setPreblendImages(boolean value)
```
    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.
    
    Parameters:
    
    value - A value determining whether or not to preblend transparent images with black background color.
  - getDisplayDocTitle
```
public boolean getDisplayDocTitle()
```
    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.
    
    This flag is required by PDF/UA compliance. true value will be used automatically when saving to PDF/UA.
    
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setDisplayDocTitle
```
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.
    
    This flag is required by PDF/UA compliance. true value will be used automatically when saving to PDF/UA.
    
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getDmlEffectsRenderingMode
```
public int getDmlEffectsRenderingMode()
```
    Gets a value determining how DrawingML effects are rendered. The default value is DmlEffectsRenderingMode.SIMPLIFIED.
    This property is used when the document is exported to fixed page formats.
    
    If getCompliance() / setCompliance(int) is set to PdfCompliance.PDF_A_1_A or PdfCompliance.PDF_A_1_B, property always returns DmlEffectsRenderingMode.NONE.
    
    Overrides:
    
    getDmlEffectsRenderingMode in class SaveOptions
    
    Returns:
    
    A value determining how DrawingML effects are rendered. The returned value is one of DmlEffectsRenderingMode constants.
  - setDmlEffectsRenderingMode
```
public void setDmlEffectsRenderingMode(int value)
```
    Sets a value determining how DrawingML effects are rendered. The default value is DmlEffectsRenderingMode.SIMPLIFIED.
    This property is used when the document is exported to fixed page formats.
    
    If getCompliance() / setCompliance(int) is set to PdfCompliance.PDF_A_1_A or PdfCompliance.PDF_A_1_B, property always returns DmlEffectsRenderingMode.NONE.
    
    Overrides:
    
    setDmlEffectsRenderingMode in class SaveOptions
    
    Parameters:
    
    value - A value determining how DrawingML effects are rendered. The value must be one of DmlEffectsRenderingMode constants.
  - getHeaderFooterBookmarksExportMode
```
public int getHeaderFooterBookmarksExportMode()
```
    Determines how bookmarks in headers/footers are exported.
    The default value is HeaderFooterBookmarksExportMode.ALL.
    
    This property is used in conjunction with the getOutlineOptions() option.
    
    Returns:
    
    The corresponding int value. The returned value is one of HeaderFooterBookmarksExportMode constants.
  - setHeaderFooterBookmarksExportMode
```
public void setHeaderFooterBookmarksExportMode(int value)
```
    Determines how bookmarks in headers/footers are exported.
    The default value is HeaderFooterBookmarksExportMode.ALL.
    
    This property is used in conjunction with the getOutlineOptions() option.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of HeaderFooterBookmarksExportMode constants.
  - getAdditionalTextPositioning
```
public boolean getAdditionalTextPositioning()
```
    A flag specifying whether to write additional text positioning operators or not.
    If true, additional text positioning operators are written to the output PDF. This may help to overcome issues with inaccurate text positioning with some printers. The downside is the increased PDF document size.
    
    The default value is false.
    
    Returns:
    
    The corresponding boolean value.
  - setAdditionalTextPositioning
```
public void setAdditionalTextPositioning(boolean value)
```
    A flag specifying whether to write additional text positioning operators or not.
    If true, additional text positioning operators are written to the output PDF. This may help to overcome issues with inaccurate text positioning with some printers. The downside is the increased PDF document size.
    
    The default value is false.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getInterpolateImages
```
public boolean getInterpolateImages()
```
    A flag indicating whether image interpolation shall be performed by a conforming reader. When false is specified, the flag is not written to the output document and the default behaviour of reader is used instead.
    When the resolution of a source image is significantly lower than that of the output device, each source sample covers many device pixels. As a result, images can appear jaggy or blocky. These visual artifacts can be reduced by applying an image interpolation algorithm during rendering. Instead of painting all pixels covered by a source sample with the same color, image interpolation attempts to produce a smooth transition between adjacent sample values.
    
    A conforming Reader may choose to not implement this feature of PDF, or may use any specific implementation of interpolation that it wishes.
    
    The default value is false.
    
    Interpolation flag is prohibited by PDF/A compliance. false value will be used automatically when saving to PDF/A.
    
    Returns:
    
    The corresponding boolean value.
  - setInterpolateImages
```
public void setInterpolateImages(boolean value)
```
    A flag indicating whether image interpolation shall be performed by a conforming reader. When false is specified, the flag is not written to the output document and the default behaviour of reader is used instead.
    When the resolution of a source image is significantly lower than that of the output device, each source sample covers many device pixels. As a result, images can appear jaggy or blocky. These visual artifacts can be reduced by applying an image interpolation algorithm during rendering. Instead of painting all pixels covered by a source sample with the same color, image interpolation attempts to produce a smooth transition between adjacent sample values.
    
    A conforming Reader may choose to not implement this feature of PDF, or may use any specific implementation of interpolation that it wishes.
    
    The default value is false.
    
    Interpolation flag is prohibited by PDF/A compliance. false value will be used automatically when saving to PDF/A.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getCompliance
```
public int getCompliance()
```
    Specifies the PDF standards compliance level for output documents.
    Default is PdfCompliance.PDF_17.
    
    Returns:
    
    The corresponding int value. The returned value is one of PdfCompliance constants.
  - setCompliance
```
public void setCompliance(int value)
```
    Specifies the PDF standards compliance level for output documents.
    Default is PdfCompliance.PDF_17.
    
    Parameters:
    
    value - The corresponding int value. The value must be one of PdfCompliance constants.
  - getCacheHeaderFooterShapes
```
public boolean getCacheHeaderFooterShapes()
```
    Gets a value determining whether or not to cache shapes placed in header and footer of document.
    Default value is false and shapes are not cached.
    
    When the value is true shapes graphics are written to the PDF document as an xObject.
    
    Some shapes are not supported for caching(shapes with fields, bookmarks, HRefs).
    
    Returns:
    
    A value determining whether or not to cache shapes placed in header and footer of document.
  - setCacheHeaderFooterShapes
```
public void setCacheHeaderFooterShapes(boolean value)
```
    Sets a value determining whether or not to cache shapes placed in header and footer of document.
    Default value is false and shapes are not cached.
    
    When the value is true shapes graphics are written to the PDF document as an xObject.
    
    Some shapes are not supported for caching(shapes with fields, bookmarks, HRefs).
    
    Parameters:
    
    value - A value determining whether or not to cache shapes placed in header and footer of document.
  - memberwiseClone
```
protected java.lang.Object memberwiseClone()
```

Class PdfSaveOptions

Constructor Summary

Method Summary

Methods inherited from class com.aspose.words.FixedPageSaveOptions

Methods inherited from class com.aspose.words.SaveOptions

Methods inherited from class java.lang.Object

Constructor Detail

PdfSaveOptions

Method Detail

getSaveFormat

setSaveFormat

getOutlineOptions

getTextCompression

setTextCompression

getJpegQuality

setJpegQuality

getPreserveFormFields

setPreserveFormFields

getCreateNoteHyperlinks

setCreateNoteHyperlinks

getEncryptionDetails

setEncryptionDetails

getDigitalSignatureDetails

setDigitalSignatureDetails

deepClone

getEmbedFullFonts

setEmbedFullFonts

getFontEmbeddingMode

setFontEmbeddingMode

getUseCoreFonts

setUseCoreFonts

getCustomPropertiesExport

setCustomPropertiesExport

getZoomBehavior

setZoomBehavior

getZoomFactor

setZoomFactor

getImageCompression

setImageCompression

getOpenHyperlinksInNewWindow

setOpenHyperlinksInNewWindow

getExportDocumentStructure

setExportDocumentStructure

getExportLanguageToSpanTag

setExportLanguageToSpanTag

getUseBookFoldPrintingSettings

setUseBookFoldPrintingSettings

getDownsampleOptions

setDownsampleOptions

getPageMode

setPageMode

getImageColorSpaceExportMode

setImageColorSpaceExportMode

getPreblendImages

setPreblendImages

getDisplayDocTitle

setDisplayDocTitle

getDmlEffectsRenderingMode

setDmlEffectsRenderingMode

getHeaderFooterBookmarksExportMode

setHeaderFooterBookmarksExportMode

getAdditionalTextPositioning

setAdditionalTextPositioning

getInterpolateImages

setInterpolateImages

getCompliance

setCompliance

getCacheHeaderFooterShapes

setCacheHeaderFooterShapes

memberwiseClone