java.lang.ObjectSaveOptions
FixedPageSaveOptions
com.aspose.words.XamlFixedSaveOptions
public class XamlFixedSaveOptions
Constructor Summary |
---|
XamlFixedSaveOptions()
|
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() | → inherited from FixedPageSaveOptions |
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() | → inherited from FixedPageSaveOptions |
void | setMetafileRenderingOptions(MetafileRenderingOptions value) | |
Allows to specify metafile rendering options. | ||
int | getNumeralFormat() | → inherited from FixedPageSaveOptions |
void | setNumeralFormat(int value) | |
Gets or sets |
||
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. | ||
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. | ||
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 | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
IResourceSavingCallback | getResourceSavingCallback() | |
void | setResourceSavingCallback(IResourceSavingCallback value) | |
Allows to control how resources (images and fonts) are saved when a document is exported to fixed page Xaml format. | ||
java.lang.String | getResourcesFolder() | |
void | setResourcesFolder(java.lang.String value) | |
Specifies the physical folder where resources (images and fonts) are saved when exporting a document to fixed page Xaml format.
Default is null .
|
||
java.lang.String | getResourcesFolderAlias() | |
void | setResourcesFolderAlias(java.lang.String value) | |
Specifies the name of the folder used to construct image URIs written into an fixed page Xaml document.
Default is null .
|
||
int | getSaveFormat() | |
void | setSaveFormat(int value) | |
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.
|
||
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) | → inherited from FixedPageSaveOptions |
Constructor Detail |
---|
public XamlFixedSaveOptions()
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(getMyDir() + "\\Artifacts\\ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);
getDefaultTemplate/setDefaultTemplate | → inherited from SaveOptions |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value) |
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.
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(getMyDir() + "\\Artifacts\\DrawingMl.pdf", pdfSaveOptions);
getJpegQuality/setJpegQuality | → inherited from FixedPageSaveOptions |
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(getMyDir() + "\\Artifacts\\SaveOptions.MemoryOptimization Out.pdf", saveOptions);
getMetafileRenderingOptions/setMetafileRenderingOptions | → inherited from FixedPageSaveOptions |
public MetafileRenderingOptions getMetafileRenderingOptions() / public void setMetafileRenderingOptions(MetafileRenderingOptions value) |
getNumeralFormat/setNumeralFormat | → inherited from FixedPageSaveOptions |
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 | → inherited from FixedPageSaveOptions |
public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value) |
getPageCount/setPageCount | → inherited from FixedPageSaveOptions |
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(getMyDir() + "\\Artifacts\\Rendering.SaveToPdfStreamOnePage.pdf"); try { PdfSaveOptions options = new PdfSaveOptions(); options.setPageIndex(2); options.setPageCount(1); doc.save(stream, options); } finally { if (stream != null) stream.close(); }
getPageIndex/setPageIndex | → inherited from FixedPageSaveOptions |
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(getMyDir() + "\\Artifacts\\Rendering.SaveToPdfStreamOnePage.pdf"); try { PdfSaveOptions options = new PdfSaveOptions(); options.setPageIndex(2); options.setPageCount(1); doc.save(stream, options); } finally { if (stream != null) stream.close(); }
getPageSavingCallback/setPageSavingCallback | → inherited from FixedPageSaveOptions |
public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value) |
Example:
Shows how separate pages are saved when a document is exported to fixed page format.Document doc = new Document(getMyDir() + "Rendering.doc"); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); { htmlFixedSaveOptions.setPageIndex(0); htmlFixedSaveOptions.setPageCount(doc.getPageCount()); } htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback()); doc.save(getMyDir() + "\\Artifacts\\Rendering.html", htmlFixedSaveOptions); String[] filePaths = GetFiles(getMyDir() + "\\Artifacts\\", "Page_*.html"); for (int i = 0; i < doc.getPageCount(); i++) { String file = MessageFormat.format(getMyDir() + "\\Artifacts\\Page_{0}.html", i); } } private static String[] GetFiles(final String path, final String searchPattern) { final Pattern re = Pattern.compile(searchPattern.replace("*", ".*").replace("?", ".?")); String[] filenames = new File(path).list(new FilenameFilter() { @Override public boolean accept(File dir, String name) { return new File(dir, name).isFile() && re.matcher(name).matches(); } }); for (int i = 0; i < filenames.length; i++) { filenames[i] = path + filenames[i]; } return filenames; } /** * Custom PageFileName is specified. */ private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback { public void pageSaving(PageSavingArgs args) throws Exception { // Specify name of the output file for the current page. args.setPageFileName(MessageFormat.format(getMyDir() + "\\Artifacts\\Page_{0}.html", args.getPageIndex())); } }
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(getMyDir() + "\\Artifacts\\Document.PrettyFormat.html", htmlOptions);
getResourceSavingCallback/setResourceSavingCallback | |
public IResourceSavingCallback getResourceSavingCallback() / public void setResourceSavingCallback(IResourceSavingCallback value) |
getResourcesFolder/setResourcesFolder | |
public java.lang.String getResourcesFolder() / public void setResourcesFolder(java.lang.String value) |
null
.
When you save a
If you save a document into a file and provide a file name, Aspose.Words, by default, saves the
images in the same folder where the document file is saved. Use
If you save a document into a stream, Aspose.Words does not have a folder where to save the images,
but still needs to save the images somewhere. In this case, you need to specify an accessible folder
by using the
getResourcesFolderAlias/setResourcesFolderAlias | |
public java.lang.String getResourcesFolderAlias() / public void setResourcesFolderAlias(java.lang.String value) |
null
.
When you save a
getSaveFormat/setSaveFormat | |
public int getSaveFormat() / public void setSaveFormat(int value) |
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.
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); doc.save(getMyDir() + "\\Artifacts\\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);
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:
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:
Method Detail |
---|
equals | → inherited from FixedPageSaveOptions |
public boolean equals(java.lang.Object obj) |