com.aspose.words

Property Getters/Setters Detail

• 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 .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() + "Busniess brochure.dotx");
  
  doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);

• 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");
  
  // 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);
  options.setDmlRenderingMode(DmlRenderingMode.FALLBACK);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingML.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 configure DrawingML rendering quality with PdfSaveOptions.

  Document doc = new Document(getMyDir() + "DrawingML shape effects.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);
  options.setDmlRenderingMode(DmlRenderingMode.FALLBACK);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingML.pdf", options);

• getEncoding/setEncoding

  public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value)
  

  Specifies the encoding to use when exporting in text formats. Default value is 'UTF-8' Charset.

  Example:

  Shows how to set encoding for a .txt output document.

  // Create a new document and add some text from outside the ASCII character set
  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.writeln("� � � � �.");
  
  // We can use a SaveOptions object to make sure the encoding we save the .txt document in supports our content
  TxtSaveOptions txtSaveOptions = new TxtSaveOptions();
  {
      txtSaveOptions.setEncoding(StandardCharsets.UTF_8);
  }
  
  doc.save(getArtifactsDir() + "TxtSaveOptions.Encoding.txt", txtSaveOptions);

• getExportHeadersFootersMode/setExportHeadersFootersMode

  public int getExportHeadersFootersMode() / public void setExportHeadersFootersMode(int value)
  

  Specifies the way headers and footers are exported to the text formats. Default value is TxtExportHeadersFootersMode.PRIMARY_ONLY. The value of the property is TxtExportHeadersFootersMode integer constant.

  Example:

  Shows how to specifies the way headers and footers are exported to plain text format.

  Document doc = new Document(getMyDir() + "Header and footer types.docx");
  
  // Three values are available in TxtExportHeadersFootersMode enum:
  // "None" - No headers and footers are exported
  // "AllAtEnd" - All headers and footers are placed after all section bodies at the very end of a document
  // "PrimaryOnly" - Only primary headers and footers are exported at the beginning and end of each section (default value)
  TxtSaveOptions saveOptions = new TxtSaveOptions();
  saveOptions.setExportHeadersFootersMode(txtExportHeadersFootersMode);
  
  doc.save(getArtifactsDir() + "TxtSaveOptions.ExportHeadersFooters.txt", saveOptions);

• getForcePageBreaks/setForcePageBreaks

  public boolean getForcePageBreaks() / public void setForcePageBreaks(boolean value)
  

  Allows to specify whether the page breaks should be preserved during export.

  The default value is false.

  The property affects only page breaks that are inserted explicitly into a document. It is not related to page breaks that MS Word automatically inserts at the end of each page.

  Example:

  Shows how to specify whether the page breaks should be preserved during export.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.writeln("Page 1");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.writeln("Page 2");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.writeln("Page 3");
  
  TxtSaveOptions saveOptions = new TxtSaveOptions();
  saveOptions.setForcePageBreaks(false);
  
  doc.save(getArtifactsDir() + "TxtSaveOptions.PageBreaks.txt", saveOptions);

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

• getParagraphBreak/setParagraphBreak

  public java.lang.String getParagraphBreak() / public void setParagraphBreak(java.lang.String value)
  

  Specifies the string to use as a paragraph break when exporting in text formats.

  The default value is ControlChar.CR_LF.

  Example:

  Shows how to save a .txt document with a custom paragraph break.

  // Create a new document and add some paragraphs
  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.writeln("Paragraph 1.");
  builder.writeln("Paragraph 2.");
  builder.write("Paragraph 3.");
  
  // When saved to plain text, the paragraphs we created can be separated by a custom string
  TxtSaveOptions txtSaveOptions = new TxtSaveOptions();
  {
      txtSaveOptions.setSaveFormat(SaveFormat.TEXT);
      txtSaveOptions.setParagraphBreak(" End of paragraph.\n\n\t");
  }
  
  doc.save(getArtifactsDir() + "TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);

• getPreserveTableLayout/setPreserveTableLayout

  public boolean getPreserveTableLayout() / public void setPreserveTableLayout(boolean value)
  

  Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format. The default value is false.

  Example:

  Shows how to change the appearance of tables and lists during conversion to a txt document output.

  // Open a document with a table
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Due to the nature of text documents, table grids and text wrapping will be lost during conversion
  // from a file type that supports tables
  // We can preserve some of the table layout in the appearance of our content with the PreserveTableLayout flag
  // The SimplifyListLabels flag will convert some list symbols
  // into ASCII characters such as *, o, +, > etc, depending on list level
  TxtSaveOptions txtSaveOptions = new TxtSaveOptions();
  {
      txtSaveOptions.setSimplifyListLabels(true);
      txtSaveOptions.setPreserveTableLayout(true);
  }
  
  doc.save(getArtifactsDir() + "TxtSaveOptions.Appearance.txt", txtSaveOptions);

• 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.

  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");
  
  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.SaveHtmlPrettyFormat.html", htmlOptions);

• getSaveFormat/setSaveFormat

  public abstract int getSaveFormat() / public 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.

  Example:

  Converts a document to EPUB with save options specified.

  // Open an existing document from disk
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // 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.Doc2EpubSaveOptions.epub", saveOptions);

• 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 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

  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 = DocumentHelper.createDocumentFillWithDummyText();
  
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setUpdateFields(false);
  
  // PdfSaveOptions objects can be cloned
  Assert.assertNotSame(pdfSaveOptions, pdfSaveOptions.deepClone());
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.WithoutUpdateFields.pdf", pdfSaveOptions);

• 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.

• 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(false);
  
  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:

  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.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:

  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.ImageSaveOptions.Default.jpg", options);
  
  options.setUseAntiAliasing(true);
  options.setUseHighQualityRendering(true);
  
  doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);