java.lang.ObjectSaveOptions
com.aspose.words.OoxmlSaveOptions
public class OoxmlSaveOptions
Example:
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
// Set Word2003 version for document, for inserting image as VML shape
doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003);
builder.insertImage(getImageDir() + "Transparent background logo.png");
Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());
// Iso29500_2008 does not allow VML shapes
// You need to use OoxmlCompliance.Iso29500_2008_Strict for converting VML to DML shapes
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT);
saveOptions.setSaveFormat(SaveFormat.DOCX);
doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions);
// The markup language of our shape has changed according to the compliance type
doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx");
Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());
Constructor Summary |
---|
OoxmlSaveOptions()
Initializes a new instance of this class that can be used to save a document in the |
OoxmlSaveOptions(int saveFormat)
Initializes a new instance of this class that can be used to save a document in the |
Property Getters/Setters Summary | ||
---|---|---|
int | getCompliance() | |
void | setCompliance(int value) | |
Specifies the OOXML version for the output document.
The default value is |
||
int | getCompressionLevel() | |
void | setCompressionLevel(int value) | |
Specifies the compression level used to save document.
The default value is |
||
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 | getDml3DEffectsRenderingMode() | → inherited from SaveOptions |
void | setDml3DEffectsRenderingMode(int value) | |
Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant. | ||
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. | ||
boolean | getKeepLegacyControlChars() | |
void | setKeepLegacyControlChars(boolean value) | |
Keeps original representation of legacy control characters. | ||
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. | ||
java.lang.String | getPassword() | |
void | setPassword(java.lang.String value) | |
Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm. | ||
boolean | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
int | getSaveFormat() | |
void | setSaveFormat(int value) | |
Specifies the format in which the document will be saved if this save options object is used.
Can 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 | getUpdateLastPrintedProperty() | → inherited from SaveOptions |
void | setUpdateLastPrintedProperty(boolean value) | |
Gets or sets a value determining whether the |
||
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. |
Constructor Detail |
---|
public OoxmlSaveOptions()
Example:
Shows conversion VML shapes to DML using ISO/IEC 29500:2008 Strict compliance level.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set Word2003 version for document, for inserting image as VML shape doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // Iso29500_2008 does not allow VML shapes // You need to use OoxmlCompliance.Iso29500_2008_Strict for converting VML to DML shapes OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // The markup language of our shape has changed according to the compliance type doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());
public OoxmlSaveOptions(int saveFormat)
saveFormat
- A Example:
Shows how to support legacy control characters when converting to .docx.Document doc = new Document(getMyDir() + "Legacy control character.doc"); // Note that only one legacy character (ShortDateTime) is supported which declared in the "DOC" format OoxmlSaveOptions so = new OoxmlSaveOptions(SaveFormat.DOCX); so.setKeepLegacyControlChars(doKeepLegacyControlChars); doc.save(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx", so); // Open the saved document and verify results doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx"); if (doKeepLegacyControlChars) Assert.assertEquals("\u0013date \\@ \"M/d/yyyy\"\u0014\u0015\f", doc.getFirstSection().getBody().getText()); else Assert.assertEquals("\u001e\f", doc.getFirstSection().getBody().getText());
Property Getters/Setters Detail |
---|
getCompliance/setCompliance | |
public int getCompliance() / public void setCompliance(int value) |
Example:
Shows conversion VML shapes to DML using ISO/IEC 29500:2008 Strict compliance level.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set Word2003 version for document, for inserting image as VML shape doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // Iso29500_2008 does not allow VML shapes // You need to use OoxmlCompliance.Iso29500_2008_Strict for converting VML to DML shapes OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // The markup language of our shape has changed according to the compliance type doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());
getCompressionLevel/setCompressionLevel | |
public int getCompressionLevel() / public void setCompressionLevel(int value) |
Example:
Shows how to specify the compression level used to save the OOXML document.Document doc = new Document(getMyDir() + "Document.docx"); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(SaveFormat.DOCX); // DOCX and DOTX files are internally a ZIP-archive, this property controls // the compression level of the archive // Note, that FlatOpc file is not a ZIP-archive, therefore, this property does // not affect the FlatOpc files // Aspose.Words uses CompressionLevel.Normal by default, but MS Word uses // CompressionLevel.SuperFast by default saveOptions.setCompressionLevel(CompressionLevel.SUPER_FAST); doc.save(getArtifactsDir() + "OoxmlSaveOptions.out.docx", saveOptions);
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.setAutomaticallyUpdateStyles(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() + "Business brochure.dotx"); doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
getDml3DEffectsRenderingMode/setDml3DEffectsRenderingMode | → inherited from SaveOptions |
public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int 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.
Example:
Shows how to configure DrawingML rendering quality with PdfSaveOptions.Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); PdfSaveOptions options = new PdfSaveOptions(); options.setDmlEffectsRenderingMode(effectsRenderingMode); Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode()); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.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 render fallback shapes when saving to Pdf.Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx"); PdfSaveOptions options = new PdfSaveOptions(); options.setDmlRenderingMode(dmlRenderingMode); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);
Example:
Shows how to configure DrawingML rendering quality with PdfSaveOptions.Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); PdfSaveOptions options = new PdfSaveOptions(); options.setDmlEffectsRenderingMode(effectsRenderingMode); Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode()); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);
getKeepLegacyControlChars/setKeepLegacyControlChars | |
public boolean getKeepLegacyControlChars() / public void setKeepLegacyControlChars(boolean value) |
Example:
Shows how to support legacy control characters when converting to .docx.Document doc = new Document(getMyDir() + "Legacy control character.doc"); // Note that only one legacy character (ShortDateTime) is supported which declared in the "DOC" format OoxmlSaveOptions so = new OoxmlSaveOptions(SaveFormat.DOCX); so.setKeepLegacyControlChars(doKeepLegacyControlChars); doc.save(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx", so); // Open the saved document and verify results doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.KeepLegacyControlChars.docx"); if (doKeepLegacyControlChars) Assert.assertEquals("\u0013date \\@ \"M/d/yyyy\"\u0014\u0015\f", doc.getFirstSection().getBody().getText()); else Assert.assertEquals("\u001e\f", doc.getFirstSection().getBody().getText());
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() + "Rendering.docx"); // When set to true it will improve document memory footprint but will add extra time to processing SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF); saveOptions.setMemoryOptimization(true); doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);
getPassword/setPassword | |
public java.lang.String getPassword() / public void setPassword(java.lang.String value) |
In order to save document without encryption this property should be null or empty string.
Example:
Shows how to create a password protected Office Open XML document.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Hello world!"); // Create a SaveOptions object with a password and save our document with it OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setPassword("MyPassword"); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Password.docx", saveOptions); // This document cannot be opened like a normal document Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "OoxmlSaveOptions.Password.docx")); // We can open the document and access its contents by passing the correct password to a LoadOptions object doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Password.docx", new LoadOptions("MyPassword")); Assert.assertEquals("Hello world!", doc.getText().trim());
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.docx"); // 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 HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML); htmlOptions.setPrettyFormat(isPrettyFormat); doc.save(getArtifactsDir() + "Document.SaveHtmlPrettyFormat.html", htmlOptions);
getSaveFormat/setSaveFormat | |
public int getSaveFormat() / public void setSaveFormat(int value) |
Example:
Shows conversion VML shapes to DML using ISO/IEC 29500:2008 Strict compliance level.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Set Word2003 version for document, for inserting image as VML shape doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2003); builder.insertImage(getImageDir() + "Transparent background logo.png"); Assert.assertEquals(ShapeMarkupLanguage.VML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage()); // Iso29500_2008 does not allow VML shapes // You need to use OoxmlCompliance.Iso29500_2008_Strict for converting VML to DML shapes OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setCompliance(OoxmlCompliance.ISO_29500_2008_STRICT); saveOptions.setSaveFormat(SaveFormat.DOCX); doc.save(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx", saveOptions); // The markup language of our shape has changed according to the compliance type doc = new Document(getArtifactsDir() + "OoxmlSaveOptions.Iso29500Strict.docx"); Assert.assertEquals(ShapeMarkupLanguage.DML, ((Shape) doc.getChild(NodeType.SHAPE, 0, true)).getMarkupLanguage());
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.docx"); // 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 = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert two pages of text, including two fields that will need to be updated to display an accurate value builder.write("Page "); builder.insertField("PAGE", ""); builder.write(" of "); builder.insertField("NUMPAGES", ""); builder.insertBreak(BreakType.PAGE_BREAK); builder.writeln("Hello World!"); PdfSaveOptions options = new PdfSaveOptions(); options.setUpdateFields(doUpdateFields); // PdfSaveOptions objects can be cloned Assert.assertNotSame(options, options.deepClone()); doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);
getUpdateLastPrintedProperty/setUpdateLastPrintedProperty | → inherited from SaveOptions |
public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value) |
Example:
Shows how to update BuiltInDocumentProperties.LastPrinted property before saving.Document doc = new Document(); // Aspose.Words update BuiltInDocumentProperties.LastPrinted property by default DocSaveOptions saveOptions = new DocSaveOptions(); saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty); doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.docx", saveOptions);
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 it.Document doc = new Document(getMyDir() + "Document.docx"); // 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(updateSdtContent); doc.save(getArtifactsDir() + "StructuredDocumentTag.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:
Shows how to improve the quality of a rendered document with SaveOptions.Document doc = new Document(getMyDir() + "Rendering.docx"); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setSize(60.0); builder.writeln("Some text."); SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options); options.setUseAntiAliasing(true); options.setUseHighQualityRendering(true); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.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:
Shows how to improve the quality of a rendered document with SaveOptions.Document doc = new Document(getMyDir() + "Rendering.docx"); DocumentBuilder builder = new DocumentBuilder(doc); builder.getFont().setSize(60.0); builder.writeln("Some text."); SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options); options.setUseAntiAliasing(true); options.setUseHighQualityRendering(true); doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);