com.aspose.words

Constructor Detail

• DocSaveOptions

  public DocSaveOptions()

  Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC format.

  Example:

  Shows how to set save options for older Microsoft Word formats.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Hello world!");
  
  DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
  
  // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words.
  // Note that this does not encrypt the contents of the document in any way.
  options.setPassword("MyPassword");
  
  // If the document contains a routing slip, we can preserve it while saving by setting this flag to true.
  options.setSaveRoutingSlip(true);
  
  doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
  
  // To be able to load the document,
  // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object.
  Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc"));
  
  LoadOptions loadOptions = new LoadOptions("MyPassword");
  doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions);
  
  Assert.assertEquals("Hello world!", doc.getText().trim());

• DocSaveOptions

  public DocSaveOptions(int saveFormat)

  Initializes a new instance of this class that can be used to save a document in the SaveFormat.DOC or SaveFormat.DOT format.

  Parameters:

  saveFormat - A SaveFormat value. Can be SaveFormat.DOC or SaveFormat.DOT.

  Example:

  Shows how to set save options for older Microsoft Word formats.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Hello world!");
  
  DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
  
  // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words.
  // Note that this does not encrypt the contents of the document in any way.
  options.setPassword("MyPassword");
  
  // If the document contains a routing slip, we can preserve it while saving by setting this flag to true.
  options.setSaveRoutingSlip(true);
  
  doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
  
  // To be able to load the document,
  // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object.
  Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc"));
  
  LoadOptions loadOptions = new LoadOptions("MyPassword");
  doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions);
  
  Assert.assertEquals("Hello world!", doc.getText().trim());

Property Getters/Setters Detail

• getAllowEmbeddingPostScriptFonts/setAllowEmbeddingPostScriptFonts

  public boolean getAllowEmbeddingPostScriptFonts() / public void setAllowEmbeddingPostScriptFonts(boolean value)
  

  Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.

  Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.

  This option only works when FontInfoCollection.EmbedTrueTypeFonts of the DocumentBase.FontInfos property is set to true.

• getAlwaysCompressMetafiles/setAlwaysCompressMetafiles

  public boolean getAlwaysCompressMetafiles() / public void setAlwaysCompressMetafiles(boolean value)
  

  When false, small metafiles are not compressed for performance reason. Default value is true, all metafiles are compressed regardless of its size.

  Example:

  Shows how to change metafiles compression in a document while saving.

  // Open a document that contains a Microsoft Equation 3.0 formula.
  Document doc = new Document(getMyDir() + "Microsoft equation object.docx");
  
  // When we save a document, smaller metafiles are not compressed for performance reasons.
  // We can set a flag in a SaveOptions object to compress every metafile when saving.
  // Some editors such as LibreOffice cannot read uncompressed metafiles.
  DocSaveOptions saveOptions = new DocSaveOptions();
  saveOptions.setAlwaysCompressMetafiles(compressAllMetafiles);
  
  doc.save(getArtifactsDir() + "DocSaveOptions.AlwaysCompressMetafiles.docx", saveOptions);

• getDefaultTemplate/setDefaultTemplate

  public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value)
  

  Gets or sets path to default template (including filename). Default value for this property is empty string.

  If specified, this path is used to load template when Document.AutomaticallyUpdateStyles is true, but Document.AttachedTemplate is empty.

  Example:

  Shows how to set a default template for documents that do not have attached templates.

  Document doc = new Document();
  
  // Enable automatic style updating, but do not attach a template document.
  doc.setAutomaticallyUpdateStyles(true);
  
  Assert.assertEquals("", doc.getAttachedTemplate());
  
  // Since there is no template document, the document had nowhere to track style changes.
  // Use a SaveOptions object to automatically set a template
  // if a document that we are saving does not have one.
  SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx");
  options.setDefaultTemplate(getMyDir() + "Business brochure.dotx");
  
  doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);

• getDml3DEffectsRenderingMode/setDml3DEffectsRenderingMode

  public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int value)
  

  Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant.

  The default value is Dml3DEffectsRenderingMode.BASIC.

• getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

  public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value)
  

  Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.

  The default value is DmlEffectsRenderingMode.SIMPLIFIED.

  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

  public int getDmlRenderingMode() / public void setDmlRenderingMode(int value)
  

  Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.

  The default value is DmlRenderingMode.FALLBACK.

  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);

• getMemoryOptimization/setMemoryOptimization

  public boolean getMemoryOptimization() / public 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.

  Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.

  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)
  

  Gets/sets a password to encrypt document using RC4 encryption method.

  In order to save document without encryption this property should be null or empty string.

  Example:

  Shows how to set save options for older Microsoft Word formats.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Hello world!");
  
  DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
  
  // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words.
  // Note that this does not encrypt the contents of the document in any way.
  options.setPassword("MyPassword");
  
  // If the document contains a routing slip, we can preserve it while saving by setting this flag to true.
  options.setSaveRoutingSlip(true);
  
  doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
  
  // To be able to load the document,
  // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object.
  Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc"));
  
  LoadOptions loadOptions = new LoadOptions("MyPassword");
  doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions);
  
  Assert.assertEquals("Hello world!", doc.getText().trim());

• getPrettyFormat/setPrettyFormat

  public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
  

  When 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/setSaveFormat

  public int getSaveFormat() / public void setSaveFormat(int value)
  

  Specifies the format in which the document will be saved if this save options object is used. Can be SaveFormat.DOC or SaveFormat.DOT. The value of the property is SaveFormat integer constant.

  Example:

  Shows how to set save options for older Microsoft Word formats.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Hello world!");
  
  DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
  
  // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words.
  // Note that this does not encrypt the contents of the document in any way.
  options.setPassword("MyPassword");
  
  // If the document contains a routing slip, we can preserve it while saving by setting this flag to true.
  options.setSaveRoutingSlip(true);
  
  doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
  
  // To be able to load the document,
  // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object.
  Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc"));
  
  LoadOptions loadOptions = new LoadOptions("MyPassword");
  doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions);
  
  Assert.assertEquals("Hello world!", doc.getText().trim());

• getSavePictureBullet/setSavePictureBullet

  public boolean getSavePictureBullet() / public void setSavePictureBullet(boolean value)
  

  When false, PictureBullet data is not saved to output document. Default value is true.

  This option is provided for Word 97, which cannot work correctly with PictureBullet data. To remove PictureBullet data, set the option to "false".

  Example:

  Shows how to omit PictureBullet data from the document when saving.

  Document doc = new Document(getMyDir() + "Image bullet points.docx");
  
  // Some word processors, such as Microsoft Word 97, are incompatible with PictureBullet data.
  // By setting a flag in the SaveOptions object,
  // we can convert all image bullet points to ordinary bullet points while saving.
  DocSaveOptions saveOptions = new DocSaveOptions(SaveFormat.DOC);
  saveOptions.setSavePictureBullet(false);
  
  doc.save(getArtifactsDir() + "DocSaveOptions.PictureBullets.doc", saveOptions);

• getSaveRoutingSlip/setSaveRoutingSlip

  public boolean getSaveRoutingSlip() / public void setSaveRoutingSlip(boolean value)
  

  When false, RoutingSlip data is not saved to output document. Default value is true.

  Example:

  Shows how to set save options for older Microsoft Word formats.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Hello world!");
  
  DocSaveOptions options = new DocSaveOptions(SaveFormat.DOC);
  
  // Set a password which will protect the loading of the document by Microsoft Word or Aspose.Words.
  // Note that this does not encrypt the contents of the document in any way.
  options.setPassword("MyPassword");
  
  // If the document contains a routing slip, we can preserve it while saving by setting this flag to true.
  options.setSaveRoutingSlip(true);
  
  doc.save(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", options);
  
  // To be able to load the document,
  // we will need to apply the password we specified in the DocSaveOptions object in a LoadOptions object.
  Assert.assertThrows(IncorrectPasswordException.class, () -> new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc"));
  
  LoadOptions loadOptions = new LoadOptions("MyPassword");
  doc = new Document(getArtifactsDir() + "DocSaveOptions.SaveAsDoc.doc", loadOptions);
  
  Assert.assertEquals("Hello world!", doc.getText().trim());

• getTempFolder/setTempFolder

  public java.lang.String getTempFolder() / public 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.

  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 System.OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

  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 use the hard drive instead of memory when saving a document.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When we save a document, various elements are temporarily stored in memory as the save operation is taking place.
  // We can use this option to use a temporary folder in the local file system instead,
  // which will reduce our application's memory overhead.
  DocSaveOptions options = new DocSaveOptions();
  options.setTempFolder(getArtifactsDir() + "TempFiles");
  
  // The specified temporary folder must exist in the local file system before the save operation.
  new File(options.getTempFolder()).mkdir();
  
  doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options);
  
  // The folder will persist with no residual contents from the load operation.
  Assert.assertEquals(new File(options.getTempFolder()).listFiles().length, 0);

• getUpdateFields/setUpdateFields

  public boolean getUpdateFields() / public 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.

  Allows to specify whether to mimic or not MS Word behavior.

  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

  public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value)
  

  Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.

  Example:

  Shows how to update a document's "Last printed" property when saving.

  Document doc = new Document();
  
  // This flag determines whether the last printed date, which is a built-in property, is updated.
  // If so, then the date of the document's most recent save operation
  // with this SaveOptions object passed as a parameter is used as the print date.
  DocSaveOptions saveOptions = new DocSaveOptions();
  saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty);
  
  // In Microsoft Word 2003, this property can be found via File -> Properties -> Statistics -> Printed.
  // It can also be displayed in the document's body by using a PRINTDATE field.
  doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc", saveOptions);
  
  // Open the saved document, then verify the value of the property.
  doc = new Document(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc");
  
  Assert.assertNotEquals(Calendar.getInstance().getTime(), doc.getBuiltInDocumentProperties().getLastPrinted());

• getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty

  public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value)
  

  Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.

  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

  public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value)
  

  Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.

  The default value is 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

  public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
  

  Gets or sets a value determining whether or not to use anti-aliasing for rendering.

  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: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.

  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

  public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
  

  Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.

  The default value is false.

  This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.

  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);