java.lang.ObjectSaveOptions
com.aspose.words.FixedPageSaveOptions
public abstract class FixedPageSaveOptions
Property Getters/Setters Summary | ||
---|---|---|
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. | ||
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 empty string. | ||
int | getDmlEffectsRenderingMode() | → inherited from SaveOptions |
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. | ||
int | getJpegQuality() | |
void | setJpegQuality(int value) | |
Gets or sets a value determining the quality of the JPEG images inside Html 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. | ||
MetafileRenderingOptions | getMetafileRenderingOptions() | |
void | setMetafileRenderingOptions(MetafileRenderingOptions value) | |
Allows to specify metafile rendering options. | ||
int | getNumeralFormat() | |
void | setNumeralFormat(int value) | |
Gets or sets |
||
boolean | getOptimizeOutput() | |
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 formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false. | ||
int | getPageCount() | |
void | setPageCount(int value) | |
Gets or sets the number of pages to save.
Default is |
||
int | getPageIndex() | |
void | setPageIndex(int value) | |
Gets or sets the 0-based index of the first page to save. Default is 0. | ||
IPageSavingCallback | getPageSavingCallback() | |
void | setPageSavingCallback(IPageSavingCallback value) | |
Allows to control how separate pages are saved when a document is exported to fixed page format. | ||
boolean | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
abstract int | getSaveFormat() | → inherited from SaveOptions |
abstract void | setSaveFormat(int value) | |
Specifies the format in which the document will be saved if this save options object is used. The value of the property is SaveFormat integer constant. | ||
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.
|
||
boolean | getUpdateFields() | → inherited from SaveOptions |
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. | ||
boolean | getUpdateLastSavedTimeProperty() | → inherited from SaveOptions |
void | setUpdateLastSavedTimeProperty(boolean value) | |
Gets or sets a value determining whether the |
||
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 | 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. |
Method Summary | ||
---|---|---|
boolean | equals(java.lang.Object obj) | |
Property Getters/Setters Detail |
---|
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.
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(getArtifactsDir() + "ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);
getDefaultTemplate/setDefaultTemplate | → inherited from SaveOptions |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value) |
Example:
Shows how to set a default .docx document template.Document doc = new Document(); // If we set this flag to true while not having a template attached to the document, // there will be no effect because there is no template document to draw style changes from doc.setAutomaticallyUpdateSyles(true); Assert.assertTrue(doc.getAttachedTemplate().isEmpty()); // We can set a default template document filename in a SaveOptions object to make it apply to // all documents we save with it that have no AttachedTemplate value SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx"); options.setDefaultTemplate(getMyDir() + "Document.BusinessBrochureTemplate.dotx"); doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
getDmlEffectsRenderingMode/setDmlEffectsRenderingMode | → inherited from SaveOptions |
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value) |
This property is used when the document is exported to fixed page formats.
Example:
Shows how to export custom properties while saving to .pdf.Document doc = new Document(); // Add a custom document property that doesn't use the name of some built in properties doc.getCustomDocumentProperties().add("Company", "My value"); // Configure the PdfSaveOptions like this will display the properties // in the "Document Properties" menu of Adobe Acrobat Pro PdfSaveOptions options = new PdfSaveOptions(); options.setCustomPropertiesExport(PdfCustomPropertiesExport.STANDARD); doc.save(getArtifactsDir() + "PdfSaveOptions.CustomPropertiesExport.pdf", options);
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.
Example:
Shows how to define rendering for DML shapesDocument doc = DocumentHelper.createDocumentFillWithDummyText(); PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML); doc.save(getArtifactsDir() + "DrawingMl.pdf", pdfSaveOptions);
Example:
Shows how to configure DrawingML rendering quality with PdfSaveOptions.Document doc = new Document(getMyDir() + "DrawingMLEffects.docx"); // Creating a new PdfSaveOptions object and setting its DmlEffectsRenderingMode to "None" will // strip the shapes of all their shading effects in the output pdf PdfSaveOptions options = new PdfSaveOptions(); options.setDmlEffectsRenderingMode(DmlEffectsRenderingMode.NONE); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingML.pdf", options);
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 fixed page 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.
The default value is 95.
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value) |
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(getArtifactsDir() + "SaveOptions.MemoryOptimization.pdf", saveOptions);
getMetafileRenderingOptions/setMetafileRenderingOptions | |
public MetafileRenderingOptions getMetafileRenderingOptions() / public void setMetafileRenderingOptions(MetafileRenderingOptions value) |
Example:
Shows added fallback to bitmap rendering and changing type of warnings about unsupported metafile recordsDocument doc = new Document(getMyDir() + "PdfSaveOptions.HandleRasterWarnings.doc"); MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions(); metafileRenderingOptions.setEmulateRasterOperations(false); // If Aspose.Words cannot correctly render some of the metafile records to vector graphics then Aspose.Words renders this metafile to a bitmap. metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK); HandleDocumentWarnings callback = new HandleDocumentWarnings(); doc.setWarningCallback(callback); PdfSaveOptions saveOptions = new PdfSaveOptions(); saveOptions.setMetafileRenderingOptions(metafileRenderingOptions); doc.save(getArtifactsDir() + "PdfSaveOptions.HandleRasterWarnings.pdf", saveOptions); Assert.assertEquals(callback.mWarnings.getCount(), 1); Assert.assertTrue(callback.mWarnings.get(0).getDescription().contains("R2_XORPEN")); } public static class HandleDocumentWarnings implements IWarningCallback { /** * Our callback only needs to implement the "Warning" method. This method is called whenever there is a * potential issue during document processing. The callback can be set to listen for warnings generated during document * load and/or document save. */ public void warning(final WarningInfo info) { //For now type of warnings about unsupported metafile records changed from DataLoss/UnexpectedContent to MinorFormattingLoss. if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS) { System.out.println("Unsupported operation: " + info.getDescription()); this.mWarnings.warning(info); } } public WarningInfoCollection mWarnings = new WarningInfoCollection(); }
getNumeralFormat/setNumeralFormat | |
public int getNumeralFormat() / public void setNumeralFormat(int value) |
Example:
Demonstrates how to set the numeral format used when saving to PDF.PdfSaveOptions options = new PdfSaveOptions(); options.setNumeralFormat(NumeralFormat.CONTEXT);
getOptimizeOutput/setOptimizeOutput | |
public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value) |
Example:
Shows how to optimize document objects while saving to xps.Document doc = new Document(getMyDir() + "XPSOutputOptimize.docx"); XpsSaveOptions saveOptions = new XpsSaveOptions(); saveOptions.setOptimizeOutput(true); doc.save(getArtifactsDir() + "XPSOutputOptimize.xps", saveOptions);
getPageCount/setPageCount | |
public int getPageCount() / public void setPageCount(int value) |
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(getArtifactsDir() + "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) |
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(getArtifactsDir() + "Rendering.SaveToPdfStreamOnePage.pdf"); try { PdfSaveOptions options = new PdfSaveOptions(); options.setPageIndex(2); options.setPageCount(1); doc.save(stream, options); } finally { if (stream != null) { stream.close(); } }
getPageSavingCallback/setPageSavingCallback | |
public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value) |
Example:
Shows how separate pages are saved when a document is exported to fixed page format.public void pageFileNameSavingCallback() throws Exception { Document doc = new Document(getMyDir() + "Rendering.doc"); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setPageIndex(0); htmlFixedSaveOptions.setPageCount(doc.getPageCount()); htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback()); doc.save(getArtifactsDir() + "Rendering.html", htmlFixedSaveOptions); String[] filePaths = getFiles(getArtifactsDir() + "", "Page_*.html"); for (int i = 0; i < doc.getPageCount(); i++) { String file = MessageFormat.format(getArtifactsDir() + "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(final File dir, final 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(final PageSavingArgs args) { // Specify name of the output file for the current page. args.setPageFileName(MessageFormat.format(getArtifactsDir() + "Page_{0}.html", args.getPageIndex())); } }
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.
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(getArtifactsDir() + "Document.PrettyFormat.html", htmlOptions);
getSaveFormat/setSaveFormat | → inherited from SaveOptions |
public abstract int getSaveFormat() / public abstract void setSaveFormat(int value) |
Example:
Converts a document to EPUB with save options specified.// Open an existing document from disk. Document doc = new Document(getMyDir() + "Document.EpubConversion.doc"); // Create a new instance of HtmlSaveOptions. This object allows us to set options that control // how the output document is saved. HtmlSaveOptions saveOptions = new HtmlSaveOptions(); // Specify the desired encoding. saveOptions.setEncoding(Charset.forName("UTF-8")); // Specify at what elements to split the internal HTML at. This creates a new HTML within the EPUB // which allows you to limit the size of each HTML part. This is useful for readers which cannot read // HTML files greater than a certain size e.g 300kb. saveOptions.setDocumentSplitCriteria(DocumentSplitCriteria.HEADING_PARAGRAPH); // Specify that we want to export document properties. saveOptions.setExportDocumentProperties(true); // Specify that we want to save in EPUB format. saveOptions.setSaveFormat(SaveFormat.EPUB); // Export the document as an EPUB file. doc.save(getArtifactsDir() + "Document.EpubConversion.epub", saveOptions);
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.
Example:
Shows how to save a document using temporary files.Document doc = new Document(getMyDir() + "Rendering.doc"); // We can use a SaveOptions object to set the saving method of a document from a MemoryStream to temporary files // While saving, the files will briefly pop up in the folder we set as the TempFolder attribute below // Doing this will free up space in the memory that the stream would usually occupy DocSaveOptions options = new DocSaveOptions(); options.setTempFolder(getArtifactsDir() + "TempFiles"); // Ensure that the directory exists and save new File(options.getTempFolder()).mkdir(); doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options);
getUpdateFields/setUpdateFields | → inherited from SaveOptions |
public boolean getUpdateFields() / public void setUpdateFields(boolean value) |
Example:
Shows how to update fields before saving into a PDF document.Document doc = DocumentHelper.createDocumentFillWithDummyText(); PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setUpdateFields(false); // PdfSaveOptions objects can be cloned Assert.assertNotSame(pdfSaveOptions, pdfSaveOptions.deepClone()); doc.save(getArtifactsDir() + "UpdateFields_False.pdf", pdfSaveOptions);
getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty | → inherited from SaveOptions |
public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value) |
Example:
Shows how to update a document time property when you want to save itDocument doc = new Document(getMyDir() + "Document.doc"); //Get last saved time Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime(); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateLastSavedTimeProperty(true); doc.save(getArtifactsDir() + "OoxmlSaveOptions.UpdatingLastSavedTimeDocument.docx", saveOptions);
getUpdateSdtContent/setUpdateSdtContent | → inherited from SaveOptions |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
Example:
Shows how structured document tags can be updated while saving to .pdf.Document doc = new Document(); // Insert two StructuredDocumentTags; a date and a drop down list StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.BLOCK); tag.setFullDate(new Date()); doc.getFirstSection().getBody().appendChild(tag); tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK); tag.getListItems().add(new SdtListItem("Value 1")); tag.getListItems().add(new SdtListItem("Value 2")); tag.getListItems().add(new SdtListItem("Value 3")); tag.getListItems().setSelectedValue(tag.getListItems().get(1)); doc.getFirstSection().getBody().appendChild(tag); // We've selected default values for both tags // We can save those values in the document without immediately updating the tags, leaving them in their default state // by using a SaveOptions object with this flag set PdfSaveOptions options = new PdfSaveOptions(); options.setUpdateSdtContent(false); doc.save(getArtifactsDir() + "UpdateSdtContent.pdf", options);
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:
Example:
Improve the quality of a rendered document with SaveOptions.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setSize(60.0); builder.writeln("Some text."); SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG); Assert.assertEquals(options.getUseAntiAliasing(), false); doc.save(getArtifactsDir() + "Document.SaveOptionsDefault.jpg", options); options.setUseAntiAliasing(true); options.setUseHighQualityRendering(true); doc.save(getArtifactsDir() + "Document.SaveOptionsHighQuality.jpg", options);
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:
Example:
Improve the quality of a rendered document with SaveOptions.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setSize(60.0); builder.writeln("Some text."); SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG); Assert.assertEquals(options.getUseAntiAliasing(), false); doc.save(getArtifactsDir() + "Document.SaveOptionsDefault.jpg", options); options.setUseAntiAliasing(true); options.setUseHighQualityRendering(true); doc.save(getArtifactsDir() + "Document.SaveOptionsHighQuality.jpg", options);
Method Detail |
---|
equals | |
public boolean equals(java.lang.Object obj) |