java.lang.ObjectSaveOptions
FixedPageSaveOptions
com.aspose.words.PdfSaveOptions
public class PdfSaveOptions
Constructor Summary |
---|
PdfSaveOptions()
Initializes a new instance of this class that can be used to save a document in the |
Property Getters/Setters Summary | ||
---|---|---|
int | getBookmarksOutlineLevel() | |
void | setBookmarksOutlineLevel(int value) | |
Specifies the level in the PDF document outline at which to display Word bookmarks. | ||
int | getColorMode() | → inherited from SaveOptions |
void | setColorMode(int value) | |
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant. | ||
int | getCompliance() | |
void | setCompliance(int value) | |
Specifies the PDF standards compliance level for output documents. The value of the property is PdfCompliance integer constant. | ||
boolean | getCreateNoteHyperlinks() | |
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 .
|
||
int | getCustomPropertiesExport() | |
void | setCustomPropertiesExport(int value) | |
Gets or sets a value determining the way |
||
java.lang.String | getDefaultTemplate() | → inherited from SaveOptions |
void | setDefaultTemplate(java.lang.String value) | |
Gets or sets path to default template (including filename).
Default value for this property is |
||
PdfDigitalSignatureDetails | getDigitalSignatureDetails() | |
void | setDigitalSignatureDetails(PdfDigitalSignatureDetails value) | |
Gets or sets the details for signing the output PDF document. | ||
boolean | getDisplayDocTitle() | |
void | setDisplayDocTitle(boolean value) | |
int | getDmlEffectsRenderingMode() | |
void | setDmlEffectsRenderingMode(int value) | |
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. | ||
int | getDmlRenderingMode() | → inherited from SaveOptions |
void | setDmlRenderingMode(int value) | |
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. | ||
boolean | getDownsampleImages() | |
void | setDownsampleImages(boolean value) | |
Specifies whether or not the images should be downsampled. | ||
DownsampleOptions | getDownsampleOptions() | |
Allows to specify downsample options. | ||
int | getDownsampleResolution() | |
void | setDownsampleResolution(int value) | |
Specifies the resolution in pixels per inch to which the images should be downsampled. | ||
boolean | getEmbedFullFonts() | |
void | setEmbedFullFonts(boolean value) | |
Controls how fonts are embedded into the resulting PDF documents. | ||
boolean | getEmbedStandardWindowsFonts() | |
void | setEmbedStandardWindowsFonts(boolean value) | |
Gets or sets a value determining whether or not to embed standard windows fonts Arial and Times New Roman. | ||
PdfEncryptionDetails | getEncryptionDetails() | |
void | setEncryptionDetails(PdfEncryptionDetails value) | |
Gets or sets the details for encrypting the output PDF document. | ||
int | getExpandedOutlineLevels() | |
void | setExpandedOutlineLevels(int value) | |
Specifies how many levels in the PDF document outline to show expanded when the PDF file is viewed. | ||
boolean | getExportCustomPropertiesAsMetadata() | |
void | setExportCustomPropertiesAsMetadata(boolean value) | |
Gets or sets a value determining whether or not to export The default value is The namespace of exported properties in XMP packet is "custprops". Every property has an associated xml-element "custprops:Property1", "custprops:Property2" and so on. There is "rdf:Description" element inside property element. The description element has two elements "custprops:Name", containing custom property's name as a value of this xml-element, and "custprops:Value", containing custom property's value as value of this xml-element. |
||
boolean | getExportDocumentStructure() | |
void | setExportDocumentStructure(boolean value) | |
Gets or sets a value determining whether or not to export document structure. | ||
int | getFontEmbeddingMode() | |
void | setFontEmbeddingMode(int value) | |
Specifies the font embedding mode. The value of the property is PdfFontEmbeddingMode integer constant. | ||
int | getHeadingsOutlineLevels() | |
void | setHeadingsOutlineLevels(int value) | |
Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the PDF document outline. | ||
int | getImageColorSpaceExportMode() | |
void | setImageColorSpaceExportMode(int value) | |
Specifies how the color space will be selected for the images in PDF document. The value of the property is PdfImageColorSpaceExportMode integer constant. | ||
int | getImageCompression() | |
void | setImageCompression(int value) | |
Specifies compression type to be used for all images in the document.
Default is |
||
int | getJpegQuality() | |
void | setJpegQuality(int value) | |
Gets or sets a value determining the quality of the JPEG images inside PDF document. | ||
boolean | getMemoryOptimization() | → inherited from SaveOptions |
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. | ||
int | getMetafileRenderingMode() | |
void | setMetafileRenderingMode(int value) | |
Gets or sets a value determining how metafile images should be rendered. The value of the property is MetafileRenderingMode integer constant. | ||
MetafileRenderingOptions | getMetafileRenderingOptions() | → inherited from FixedPageSaveOptions |
Allows to specify metafile rendering options. | ||
int | getNumeralFormat() | → inherited from FixedPageSaveOptions |
void | setNumeralFormat(int value) | |
Gets or sets |
||
boolean | getOpenHyperlinksInNewWindow() | |
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. | ||
boolean | getOptimizeOutput() | → inherited from FixedPageSaveOptions |
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. | ||
OutlineOptions | getOutlineOptions() | |
Allows to specify outline options. | ||
int | getPageCount() | → inherited from FixedPageSaveOptions |
void | setPageCount(int value) | |
Gets or sets the number of pages to save.
Default is |
||
int | getPageIndex() | → inherited from FixedPageSaveOptions |
void | setPageIndex(int value) | |
Gets or sets the 0-based index of the first page to save. Default is 0. | ||
int | getPageMode() | |
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. | ||
IPageSavingCallback | getPageSavingCallback() | → inherited from FixedPageSaveOptions |
void | setPageSavingCallback(IPageSavingCallback value) | |
Allows to control how separate pages are saved when a document is exported to fixed page format. | ||
boolean | getPreblendImages() | |
void | setPreblendImages(boolean value) | |
Gets or sets a value determining whether or not to preblend transparent images with black background color. | ||
boolean | getPreserveFormFields() | |
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 .
|
||
boolean | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
Aspose.Words.SaveFormat | getSaveFormat() | |
Specifies the format in which the document will be saved if this save options object is used.
Can only be |
||
java.lang.String | getTempFolder() | → inherited from SaveOptions |
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.
|
||
int | getTextCompression() | |
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. | ||
boolean | getUpdateFields() | → inherited from SaveOptions |
void | setUpdateFields(boolean value) | |
Gets or sets a value determining if fields should be updated before saving the document to a fixed page format. Default value for this property is true | ||
boolean | getUpdateSdtContent() | → inherited from SaveOptions |
void | setUpdateSdtContent(boolean value) | |
Gets or sets value determining whether content of |
||
boolean | getUseAntiAliasing() | → inherited from SaveOptions |
void | setUseAntiAliasing(boolean value) | |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. | ||
boolean | getUseBookFoldPrintingSettings() | |
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 |
||
boolean | getUseCoreFonts() | |
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. | ||
boolean | getUseHighQualityRendering() | → inherited from SaveOptions |
void | setUseHighQualityRendering(boolean value) | |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. | ||
Aspose.Words.IWarningCallback | getWarningCallback() | → inherited from SaveOptions |
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss. | ||
int | getZoomBehavior() | |
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. | ||
int | getZoomFactor() | |
void | setZoomFactor(int value) | |
Gets or sets a value determining zoom factor (in percentages) for a document. |
Method Summary | ||
---|---|---|
PdfSaveOptions | deepClone() | |
Creates a deep clone of this object. |
Constructor Detail |
---|
public PdfSaveOptions()
Property Getters/Setters Detail |
---|
getBookmarksOutlineLevel/setBookmarksOutlineLevel | |
public int getBookmarksOutlineLevel() / public void setBookmarksOutlineLevel(int value) |
Specify 0 and Word bookmarks will not be displayed in the PDF document outline. Specify 1 and Word bookmarks will be displayed in the PDF document outline at level 1; 2 for level 2 and so on.
Default is 0. Valid range is 0 to 9.
getColorMode/setColorMode | → inherited from SaveOptions |
public int getColorMode() / public void setColorMode(int value) |
This property is used when the document is exported to fixed page formats.
getCompliance/setCompliance | |
public int getCompliance() / public void setCompliance(int value) |
Default is
getCreateNoteHyperlinks/setCreateNoteHyperlinks | |
public boolean getCreateNoteHyperlinks() / public void setCreateNoteHyperlinks(boolean value) |
false
.
getCustomPropertiesExport/setCustomPropertiesExport | |
public int getCustomPropertiesExport() / public void setCustomPropertiesExport(int value) |
getDefaultTemplate/setDefaultTemplate | → inherited from SaveOptions |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value) |
getDigitalSignatureDetails/setDigitalSignatureDetails | |
public PdfDigitalSignatureDetails getDigitalSignatureDetails() / public void setDigitalSignatureDetails(PdfDigitalSignatureDetails value) |
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
getDisplayDocTitle/setDisplayDocTitle | |
public boolean getDisplayDocTitle() / public void setDisplayDocTitle(boolean value) |
getDmlEffectsRenderingMode/setDmlEffectsRenderingMode | |
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value) |
This property is used when the document is exported to fixed page formats.
If
getDmlRenderingMode/setDmlRenderingMode | → inherited from SaveOptions |
public int getDmlRenderingMode() / public void setDmlRenderingMode(int value) |
This property is used when the document is exported to fixed page formats.
getDownsampleImages/setDownsampleImages | |
public boolean getDownsampleImages() / public void setDownsampleImages(boolean value) |
true
.
getDownsampleOptions | |
public DownsampleOptions getDownsampleOptions() |
getDownsampleResolution/setDownsampleResolution | |
public int getDownsampleResolution() / public void setDownsampleResolution(int value) |
getEmbedFullFonts/setEmbedFullFonts | |
public boolean getEmbedFullFonts() / public void setEmbedFullFonts(boolean value) |
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.
getEmbedStandardWindowsFonts/setEmbedStandardWindowsFonts | |
public boolean getEmbedStandardWindowsFonts() / public void setEmbedStandardWindowsFonts(boolean value) |
The default value is true
. When this value is set to false
Arial and Times New Roman
fonts are not be embedded into PDF.
Only Arial and Times New Roman fonts are affected by this setting because MS Word doesn't embed only these fonts when saving document to the PDF.
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 true
as all fonts must be embedded in the PDF file.
getEncryptionDetails/setEncryptionDetails | |
public PdfEncryptionDetails getEncryptionDetails() / public void setEncryptionDetails(PdfEncryptionDetails value) |
The default value is null and the output document will not be encrypted.
When this property is set to a valid
Note that encryption cannot be used when PDF/A compliance is set as this compliance does not permit encryption.");
getExpandedOutlineLevels/setExpandedOutlineLevels | |
public int getExpandedOutlineLevels() / public void setExpandedOutlineLevels(int value) |
Specify 0 and the document outline will be collapsed; specify 1 and the first level items in the outline will be expanded and so on.
Default is 0. Valid range is 0 to 9.
getExportCustomPropertiesAsMetadata/setExportCustomPropertiesAsMetadata | |
public boolean getExportCustomPropertiesAsMetadata() / public void setExportCustomPropertiesAsMetadata(boolean value) |
The default value is false
. When this value is set to true
custom document properties are exported
in PDF document as metadata.
The namespace of exported properties in XMP packet is "custprops". Every property has an associated xml-element "custprops:Property1", "custprops:Property2" and so on. There is "rdf:Description" element inside property element. The description element has two elements "custprops:Name", containing custom property's name as a value of this xml-element, and "custprops:Value", containing custom property's value as value of this xml-element.
getExportDocumentStructure/setExportDocumentStructure | |
public boolean getExportDocumentStructure() / public void setExportDocumentStructure(boolean value) |
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) |
The default value is
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
getHeadingsOutlineLevels/setHeadingsOutlineLevels | |
public int getHeadingsOutlineLevels() / public void setHeadingsOutlineLevels(int value) |
Specify 0 for no headings in the outline; specify 1 for one level of headings in the outline and so on.
Default is 0. Valid range is 0 to 9.
getImageColorSpaceExportMode/setImageColorSpaceExportMode | |
public int getImageColorSpaceExportMode() / public void setImageColorSpaceExportMode(int value) |
getImageCompression/setImageCompression | |
public int getImageCompression() / public void setImageCompression(int value) |
getJpegQuality/setJpegQuality | |
public int getJpegQuality() / public void setJpegQuality(int value) |
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.
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value) |
getMetafileRenderingMode/setMetafileRenderingMode | |
public int getMetafileRenderingMode() / public void setMetafileRenderingMode(int value) |
Has effect only when a document contains metafile images.
Use this property to get or set the mode of how metafile images inside a document should be rendered when saving in PDF format.
The default value is
getMetafileRenderingOptions | → inherited from FixedPageSaveOptions |
public MetafileRenderingOptions getMetafileRenderingOptions() |
getNumeralFormat/setNumeralFormat | → inherited from FixedPageSaveOptions |
public int getNumeralFormat() / public void setNumeralFormat(int value) |
getOpenHyperlinksInNewWindow/setOpenHyperlinksInNewWindow | |
public boolean getOpenHyperlinksInNewWindow() / public void setOpenHyperlinksInNewWindow(boolean value) |
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 | → inherited from FixedPageSaveOptions |
public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value) |
getOutlineOptions | |
public OutlineOptions getOutlineOptions() |
getPageCount/setPageCount | → inherited from FixedPageSaveOptions |
public int getPageCount() / public void setPageCount(int value) |
getPageIndex/setPageIndex | → inherited from FixedPageSaveOptions |
public int getPageIndex() / public void setPageIndex(int value) |
getPageMode/setPageMode | |
public int getPageMode() / public void setPageMode(int value) |
getPageSavingCallback/setPageSavingCallback | → inherited from FixedPageSaveOptions |
public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value) |
getPreblendImages/setPreblendImages | |
public boolean getPreblendImages() / public void setPreblendImages(boolean value) |
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) |
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.
getPrettyFormat/setPrettyFormat | → inherited from SaveOptions |
public boolean getPrettyFormat() / public void setPrettyFormat(boolean value) |
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.
getSaveFormat | |
public Aspose.Words.SaveFormat getSaveFormat() |
getTempFolder/setTempFolder | → inherited from SaveOptions |
public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value) |
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
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) |
Default is
getUpdateFields/setUpdateFields | → inherited from SaveOptions |
public boolean getUpdateFields() / public void setUpdateFields(boolean value) |
getUpdateSdtContent/setUpdateSdtContent | → inherited from SaveOptions |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
getUseAntiAliasing/setUseAntiAliasing | → inherited from SaveOptions |
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value) |
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:
getUseBookFoldPrintingSettings/setUseBookFoldPrintingSettings | |
public boolean getUseBookFoldPrintingSettings() / public void setUseBookFoldPrintingSettings(boolean value) |
getUseCoreFonts/setUseCoreFonts | |
public boolean getUseCoreFonts() / public void setUseCoreFonts(boolean value) |
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
getUseHighQualityRendering/setUseHighQualityRendering | → inherited from SaveOptions |
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value) |
false
.
This property is used when the document is exported to image formats:
getWarningCallback | → inherited from SaveOptions |
public Aspose.Words.IWarningCallback getWarningCallback() |
This property is obsolete. Please use
getZoomBehavior/setZoomBehavior | |
public int getZoomBehavior() / public void setZoomBehavior(int value) |
getZoomFactor/setZoomFactor | |
public int getZoomFactor() / public void setZoomFactor(int value) |
Method Detail |
---|
deepClone | |
public PdfSaveOptions deepClone() |