com.aspose.words

Constructor Detail

• Document

  public Document()
           throws java.lang.Exception

  Creates a blank Word document.

  The document paper size is Letter by default. If you want to change page setup, use Section.PageSetup.

  After creation, you can use DocumentBuilder to add document content easily.

  Example:

  Shows how to add a formatted run of text to a document using the object model.

  // Create an empty document. It contains one empty paragraph
  Document doc = new Document();
  
  // Create a new run of text
  Run run = new Run(doc, "Hello");
  
  // Specify character formatting for the run of text
  Font f = run.getFont();
  f.setName("Courier New");
  f.setSize(36);
  f.setHighlightColor(Color.YELLOW);
  
  // Append the run of text to the end of the first paragraph
  // in the body of the first section of the document
  doc.getFirstSection().getBody().getFirstParagraph().appendChild(run);

• Document

  public Document(java.lang.String fileName)
           throws java.lang.Exception

  Opens an existing document from a file. Automatically detects the file format.

  Parameters:

  fileName - File name of the document to open.

  Example:

  Shows how to open a document and convert it to .PDF.

  // Open a document that exists in the local file system
  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Save that document as a PDF to another location
  doc.save(getArtifactsDir() + "Document.ConvertToPdf.pdf");

• Document

  public Document(java.lang.String fileName, LoadOptions loadOptions)
           throws java.lang.Exception

  Opens an existing document from a file. Allows to specify additional options such as an encryption password.

  Parameters:

  fileName - File name of the document to open.

  loadOptions - Additional options to use when loading a document. Can be null.

  Example:

  Shows how to load a Microsoft Word document encrypted with a password.

  // If we try open an encrypted document without the password, an IncorrectPasswordException will be thrown
  // We can construct a LoadOptions object with the correct encryption password
  LoadOptions options = new LoadOptions("docPassword");
  
  // Then, we can use that object as a parameter when opening an encrypted document
  AtomicReference<Document> doc = new AtomicReference<>(new Document(getMyDir() + "Encrypted.docx", options));
  
  InputStream stream = new FileInputStream(getMyDir() + "Encrypted.docx");
  try {
      doc.set(new Document(stream, options));
  }
  finally { if (stream != null) stream.close(); }

  Example:

  Shows how to load a document as HTML without automatic file format detection.

  LoadOptions loadOptions = new LoadOptions();
  loadOptions.setLoadFormat(com.aspose.words.LoadFormat.HTML);
  
  Document doc = new Document(getMyDir() + "Document.html", loadOptions);

• Document

  public Document(java.io.InputStream stream)
           throws java.lang.Exception

  Opens an existing document from a stream. Automatically detects the file format.

  The document must be stored at the beginning of the stream.

  Parameters:

  stream - Stream where to load the document from.

  Example:

  Shows how to retrieve a document from a URL and saves it to disk in a different format.

  // This is the URL address pointing to where to find the document
  URL url = new URL("https://omextemplates.content.office.net/support/templates/en-us/tf16402488.dotx");
  
  // The easiest way to load our document from the internet is make use of the URLConnection class
  URLConnection webClient = url.openConnection();
  
  // Download the bytes from the location referenced by the URL
  InputStream inputStream = webClient.getInputStream();
  
  // Convert the input stream to a byte array
  int pos;
  ByteArrayOutputStream bos = new ByteArrayOutputStream();
  while ((pos = inputStream.read()) != -1) bos.write(pos);
  
  byte[] dataBytes = bos.toByteArray();
  
  // Wrap the bytes representing the document in memory into a stream object
  ByteArrayInputStream byteStream = new ByteArrayInputStream(dataBytes);
  
  // Load this memory stream into a new Aspose.Words Document
  // The file format of the passed data is inferred from the content of the bytes itself
  // You can load any document format supported by Aspose.Words in the same way
  Document doc = new Document(byteStream);
  
  // Convert the document to any format supported by Aspose.Words and save
  doc.save(getArtifactsDir() + "Document.OpenDocumentFromWeb.docx");

  Example:

  Shows how to open a document from a stream.

  // Open the stream. Read only access is enough for Aspose.Words to load a document.
  InputStream stream = new FileInputStream(getMyDir() + "Document.docx");
  
  try
  {
      // Load the entire document into memory and read its contents
      Document doc = new Document(stream);
  
      Assert.assertEquals("Hello World!", doc.getText().trim());
  }
  finally { if (stream != null) stream.close(); }

• Document

  public Document(java.io.InputStream stream, LoadOptions loadOptions)
           throws java.lang.Exception

  Opens an existing document from a stream. Allows to specify additional options such as an encryption password.

  The document must be stored at the beginning of the stream.

  Parameters:

  stream - The stream where to load the document from.

  loadOptions - Additional options to use when loading a document. Can be null.

  Example:

  Shows how to insert the HTML contents from a web page into a new document.

  // The url of the page to load
  URL url = new URL("http://www.aspose.com/");
  
  // The easiest way to load our document from the internet is make use of the URLConnection class
  URLConnection webClient = url.openConnection();
  
  // Download the bytes from the location referenced by the URL
  InputStream inputStream = webClient.getInputStream();
  
  // Convert the input stream to a byte array
  int pos;
  ByteArrayOutputStream bos = new ByteArrayOutputStream();
  while ((pos = inputStream.read()) != -1) bos.write(pos);
  
  byte[] dataBytes = bos.toByteArray();
  
  // Wrap the bytes representing the document in memory into a stream object
  ByteArrayInputStream byteStream = new ByteArrayInputStream(dataBytes);
  
  // The baseUri property should be set to ensure any relative img paths are retrieved correctly
  LoadOptions options = new LoadOptions(LoadFormat.HTML, "", url.getPath());
  
  // Load the HTML document from stream and pass the LoadOptions object
  Document doc = new Document(byteStream, options);
  
  // Save the document to the local file system while converting it to .docx
  doc.save(getArtifactsDir() + "Document.InsertHtmlFromWebPage.docx");

  Example:

  Shows how to load a Microsoft Word document encrypted with a password.

  // If we try open an encrypted document without the password, an IncorrectPasswordException will be thrown
  // We can construct a LoadOptions object with the correct encryption password
  LoadOptions options = new LoadOptions("docPassword");
  
  // Then, we can use that object as a parameter when opening an encrypted document
  AtomicReference<Document> doc = new AtomicReference<>(new Document(getMyDir() + "Encrypted.docx", options));
  
  InputStream stream = new FileInputStream(getMyDir() + "Encrypted.docx");
  try {
      doc.set(new Document(stream, options));
  }
  finally { if (stream != null) stream.close(); }

  Example:

  Shows how to open an HTML document with images from a stream using a base URI.

  // Open the stream
  InputStream stream = new FileInputStream(getMyDir() + "Document.html");
  Document doc;
  
  try
  {
      // Pass the URI of the base folder so any images with relative URIs in the HTML document can be found
      // Note the Document constructor detects HTML format automatically
      LoadOptions loadOptions = new LoadOptions();
      loadOptions.setBaseUri(getImageDir());
  
      doc = new Document(stream, loadOptions);
  }
  finally { if (stream != null) stream.close(); }

Property Getters/Setters Detail

• getAttachedTemplate/setAttachedTemplate

  public java.lang.String getAttachedTemplate() / public void setAttachedTemplate(java.lang.String value)
  

  Gets or sets the full path of the template attached to the document.

  Empty string means the document is attached to the Normal template.

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

  See Also:

  BuiltInDocumentProperties.Template

• getAutomaticallyUpdateStyles/setAutomaticallyUpdateStyles

  public boolean getAutomaticallyUpdateStyles() / public void setAutomaticallyUpdateStyles(boolean value)
  

  Gets or sets a flag indicating whether the styles in the document are updated to match the styles in the attached template each time the document is opened in MS Word.

  Example:

  Shows how to update a document's styles based on its template.

  Document doc = new Document();
  
  // Empty Microsoft Word documents by default come with an attached template called "Normal.dotm"
  // There is no default template for Aspose Words documents
  Assert.assertEquals("", doc.getAttachedTemplate());
  
  // For AutomaticallyUpdateStyles to have any effect, we need a document with a template
  // We can make a document with word and open it
  // Or we can attach a template from our file system, as below
  doc.setAttachedTemplate(getMyDir() + "Business brochure.dotx");
  
  // Any changes to the styles in this template will be propagated to those styles in the document
  doc.setAutomaticallyUpdateStyles(true);
  
  doc.save(getArtifactsDir() + "Document.AutomaticallyUpdateStyles.docx");

• getBackgroundShape/setBackgroundShape

  public Shape getBackgroundShape() / public void setBackgroundShape(Shape value)
  

  Gets or sets the background shape of the document. Can be null.

  Microsoft Word allows only a shape that has its ShapeBase.ShapeType property equal to ShapeType.RECTANGLE to be used as a background shape for a document.

  Microsoft Word supports only the fill properties of a background shape. All other properties are ignored.

  Setting this property to a non-null value will also set the ViewOptions.DisplayBackgroundShape to true.

  Example:

  Shows how to set the background shape of a document.

  Document doc = new Document();
  Assert.assertNull(doc.getBackgroundShape());
  
  // A background shape can only be a rectangle
  // We will set the color of this rectangle to light blue
  Shape shapeRectangle = new Shape(doc, ShapeType.RECTANGLE);
  doc.setBackgroundShape(shapeRectangle);
  
  // This rectangle covers the entire page in the output document
  // We can also do this by setting doc.PageColor
  shapeRectangle.setFillColor(Color.blue);
  doc.save(getArtifactsDir() + "DocumentBase.BackgroundShapeFlatColor.docx");
  
  // Setting the image will override the flat background color with the image
  shapeRectangle.getImageData().setImage(getImageDir() + "Transparent background logo.png");
  Assert.assertTrue(doc.getBackgroundShape().hasImage());
  
  // This image is a photo with a white background
  // To make it suitable as a watermark, we will need to do some image processing
  // The default values for these variables are 0.5, so here we are lowering the contrast and increasing the brightness
  shapeRectangle.getImageData().setContrast(0.2);
  shapeRectangle.getImageData().setBrightness(0.7);
  
  // Microsoft Word does not support images in background shapes, so even though we set the background as an image,
  // the output will show a light blue background like before
  // However, we can see our watermark in an output pdf
  doc.save(getArtifactsDir() + "DocumentBase.BackgroundShape.pdf");

  See Also:

  ViewOptions.DisplayBackgroundShape, PageColor

• getBuiltInDocumentProperties

  public BuiltInDocumentProperties getBuiltInDocumentProperties()
  

  Returns a collection that represents all the built-in document properties of the document.

  Example:

  Enumerates through all built-in and custom properties in a document.

  Document doc = new Document(getMyDir() + "Properties.docx");
  
  System.out.println(MessageFormat.format("1. Document name: {0}", doc.getOriginalFileName()));
  
  System.out.println("2. Built-in Properties");
  for (DocumentProperty docProperty : doc.getBuiltInDocumentProperties())
      System.out.println(MessageFormat.format("{0} : {1}", docProperty.getName(), docProperty.getValue()));
  
  System.out.println("3. Custom Properties");
  for (DocumentProperty docProperty : doc.getCustomDocumentProperties())
      System.out.println(MessageFormat.format("{0} : {1}", docProperty.getName(), docProperty.getValue()));

• getChildNodes

  public NodeCollection getChildNodes()
  

  Gets all immediate child nodes of this node.

  Note, ChildNodes is equivalent to calling GetChildNodes(NodeType.Any, false) and creates and returns a new collection every time it is accessed.

  If there are no child nodes, this property returns an empty collection.

  Example:

  Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.

  NodeCollection children = paragraph.getChildNodes();
  for (Node child : (Iterable<Node>) children) {
      // Paragraph may contain children of various types such as runs, shapes and so on
      if (child.getNodeType() == NodeType.RUN) {
          // Say we found the node that we want, do something useful
          Run run = (Run) child;
          System.out.println(run.getText());
      }
  }

• getCompatibilityOptions

  public CompatibilityOptions getCompatibilityOptions()
  

  Provides access to document compatibility options (that is, the user preferences entered on the Compatibility tab of the Options dialog in Word).

  Example:

  Shows how to optimize document for different word versions.

  public void optimizeFor() throws Exception {
      // Create a blank document and get its CompatibilityOptions object
      Document doc = new Document();
      CompatibilityOptions options = doc.getCompatibilityOptions();
  
      // By default, the CompatibilityOptions will contain the set of values printed below
      System.out.println("\nDefault optimization settings:");
      printCompatibilityOptions(options);
  
      // These attributes can be accessed in the output document via File > Options > Advanced > Compatibility for...
      doc.save(getArtifactsDir() + "CompatibilityOptions.OptimizeFor.DefaultSettings.docx");
  
      // We can use the OptimizeFor method to set these values automatically
      // for maximum compatibility with some Microsoft Word versions
      doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2010);
      System.out.println("\nOptimized for Word 2010:");
      printCompatibilityOptions(options);
  
      doc.getCompatibilityOptions().optimizeFor(MsWordVersion.WORD_2000);
      System.out.println("\nOptimized for Word 2000:");
      printCompatibilityOptions(options);
  }
  
  /// <summary>
  /// Prints all options of a CompatibilityOptions object and indicates whether they are enabled or disabled
  /// </summary>
  private static void printCompatibilityOptions(CompatibilityOptions options) throws IntrospectionException {
      for (int i = 1; i >= 0; i--) {
          System.out.println((i != 0) ? "\tEnabled options:" : "\tDisabled options:");
          SortedSet<String> optionNames = null;
  
          BeanInfo infoAboutFoo = Introspector.getBeanInfo(CompatibilityOptions.class);
          PropertyDescriptor[] fooDescriptors = infoAboutFoo.getPropertyDescriptors();
  
          for (PropertyDescriptor descriptor : fooDescriptors) {
              if (descriptor.getPropertyType().getTypeName() == "boolean" && i == (int) descriptor.getValue(String.valueOf(options))) {
                  optionNames.add(descriptor.getName());
              }
          }
  
          for (String s : optionNames) {
              System.out.println(MessageFormat.format("\t\t{0}", s));
          }
      }
  }

• getCompliance

  public int getCompliance()
  

  Gets the OOXML compliance version determined from the loaded document content. Makes sense only for OOXML documents. The value of the property is OoxmlCompliance integer constant.

  If you created a new blank document or load non OOXML document returns the OoxmlCompliance.ECMA_376_2006 value.

  Example:

  Shows how to get OOXML compliance version.

  // Open a DOC and check its OOXML compliance version
  Document doc = new Document(getMyDir() + "Document.doc");
  
  int compliance = doc.getCompliance();
  Assert.assertEquals(compliance, OoxmlCompliance.ECMA_376_2006);
  
  // Open a DOCX which should have a newer one
  doc = new Document(getMyDir() + "Document.docx");
  compliance = doc.getCompliance();
  
  Assert.assertEquals(compliance, OoxmlCompliance.ISO_29500_2008_TRANSITIONAL);

• getCount

  public int getCount()
  

  Gets the number of immediate children of this node.

  Example:

  Shows how to add, update and delete child nodes from within a CompositeNode.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1);
  
  // A paragraph is a composite node because it can contain runs, which are another type of node
  Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
  Run paragraphText = new Run(doc, "Initial text. ");
  paragraph.appendChild(paragraphText);
  
  // We will place these 3 children into the main text of our paragraph
  Run run1 = new Run(doc, "Run 1. ");
  Run run2 = new Run(doc, "Run 2. ");
  Run run3 = new Run(doc, "Run 3. ");
  
  // We initialized them but not in our paragraph yet
  Assert.assertEquals(paragraph.getText(), "Initial text. " + (char) 12);
  
  // Insert run2 before initial paragraph text. This will be at the start of the paragraph
  paragraph.insertBefore(run2, paragraphText);
  
  // Insert run3 after initial paragraph text. This will be at the end of the paragraph
  paragraph.insertAfter(run3, paragraphText);
  
  // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1
  paragraph.prependChild(run1);
  
  Assert.assertEquals(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4);
  
  // Access the child node collection and update/delete children
  ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
  paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
  
  Assert.assertEquals(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);

• getCustomDocumentProperties

  public CustomDocumentProperties getCustomDocumentProperties()
  

  Returns a collection that represents all the custom document properties of the document.

  Example:

  Enumerates through all built-in and custom properties in a document.

  Document doc = new Document(getMyDir() + "Properties.docx");
  
  System.out.println(MessageFormat.format("1. Document name: {0}", doc.getOriginalFileName()));
  
  System.out.println("2. Built-in Properties");
  for (DocumentProperty docProperty : doc.getBuiltInDocumentProperties())
      System.out.println(MessageFormat.format("{0} : {1}", docProperty.getName(), docProperty.getValue()));
  
  System.out.println("3. Custom Properties");
  for (DocumentProperty docProperty : doc.getCustomDocumentProperties())
      System.out.println(MessageFormat.format("{0} : {1}", docProperty.getName(), docProperty.getValue()));

• getCustomXmlParts/setCustomXmlParts

  public CustomXmlPartCollection getCustomXmlParts() / public void setCustomXmlParts(CustomXmlPartCollection value)
  

  Gets or sets the collection of Custom XML Data Storage Parts.

  Aspose.Words loads and saves Custom XML Parts into OOXML and DOC documents only.

  This property cannot be null.

  Example:

  Shows how to create structured document tag with a custom XML data.

  Document doc = new Document();
  
  // Construct an XML part that contains data and add it to the document's collection
  // Once the "Developer" tab in Mircosoft Word is enabled,
  // we can find elements from this collection as well as a couple defaults in the "XML Mapping Pane"
  String xmlPartId = UUID.randomUUID().toString();
  String xmlPartContent = "<root><text>Hello, World!</text></root>";
  CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);
  
  // The data we entered resides in these variables
  Assert.assertEquals(xmlPart.getData(), xmlPartContent.getBytes());
  Assert.assertEquals(xmlPart.getId(), xmlPartId);
  
  // XML parts can be referenced by collection index or GUID
  Assert.assertEquals(doc.getCustomXmlParts().get(0), xmlPart);
  Assert.assertEquals(doc.getCustomXmlParts().getById(xmlPartId), xmlPart);
  
  // Once the part is created, we can add XML schema associations like this
  xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");
  
  // We can also clone parts and insert them into the collection directly
  CustomXmlPart xmlPartClone = xmlPart.deepClone();
  xmlPartClone.setId(UUID.randomUUID().toString());
  doc.getCustomXmlParts().add(xmlPartClone);
  
  Assert.assertEquals(doc.getCustomXmlParts().getCount(), 2);
  
  // Iterate through collection with an enumerator and print the contents of each part
  Iterator<CustomXmlPart> enumerator = doc.getCustomXmlParts().iterator();
  int index = 0;
  while (enumerator.hasNext()) {
      CustomXmlPart customXmlPart = enumerator.next();
      System.out.println(MessageFormat.format("XML part index {0}, ID: {1}", index, customXmlPart.getId()));
      System.out.println(MessageFormat.format("\tContent: {0}", customXmlPart.getData()));
      index++;
  }
  
  // XML parts can be removed by index
  doc.getCustomXmlParts().removeAt(1);
  
  Assert.assertEquals(doc.getCustomXmlParts().getCount(), 1);
  
  // The XML part collection itself can be cloned also
  CustomXmlPartCollection customXmlParts = doc.getCustomXmlParts().deepClone();
  
  // And all elements can be cleared like this
  customXmlParts.clear();
  
  // Create a StructuredDocumentTag that will display the contents of our part,
  // insert it into the document and save the document
  StructuredDocumentTag sdt = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.BLOCK);
  sdt.getXmlMapping().setMapping(xmlPart, "/root[1]/text[1]", "");
  
  doc.getFirstSection().getBody().appendChild(sdt);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.CustomXml.docx");

  See Also:

  CustomXmlPart

• getDefaultTabStop/setDefaultTabStop

  public double getDefaultTabStop() / public void setDefaultTabStop(double value)
  

  Gets or sets the interval (in points) between the default tab stops.

  Example:

  Shows how to change default tab positions for the document and inserts text with some tab characters.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Set default tab stop to 72 points (1 inch)
  builder.getDocument().setDefaultTabStop(72.0);
  
  builder.writeln("Hello" + ControlChar.TAB + "World!");
  builder.writeln("Hello" + ControlChar.TAB_CHAR + "World!");

  See Also:

  TabStopCollection, TabStop

• getDigitalSignatures

  public DigitalSignatureCollection getDigitalSignatures()
  

  Gets the collection of digital signatures for this document and their validation results.

  This collection contains digital signatures that were loaded from the original document. These digital signatures will not be saved when you save this Document object into a file or stream because saving or converting will produce a document that is different from the original and the original digital signatures will no longer be valid.

  This collection is never null. If the document is not signed, it will contain zero elements.

  Example:

  Shows how to validate each signature in a document and display basic information about the signature.

  // Load the document which contains signature
  Document doc = new Document(getMyDir() + "Digitally signed.docx");
  
  for (DigitalSignature signature : doc.getDigitalSignatures()) {
      System.out.println("*** Signature Found ***");
      System.out.println("Is valid: " + signature.isValid());
      // This property is available in MS Word documents only
      System.out.println("Reason for signing: " + signature.getComments()); 
      System.out.println("Signature type: " + signature.getSignatureType());
      System.out.println("Time of signing: " + signature.getSignTime());
      System.out.println("Subject name: " + signature.getSubjectName());
      System.out.println("Issuer name: " + signature.getIssuerName());
      System.out.println();
  }

  Example:

  Shows how to sign documents with X.509 certificates.

  // Verify that a document isn't signed
  Assert.assertFalse(FileFormatUtil.detectFileFormat(getMyDir() + "Document.docx").hasDigitalSignature());
  
  // Create a CertificateHolder object from a PKCS #12 file, which we will use to sign the document
  CertificateHolder certificateHolder = CertificateHolder.create(getMyDir() + "morzal.pfx", "aw", null);
  
  // There are 2 ways of saving a signed copy of a document to the local file system
  // 1: Designate unsigned input and signed output files by filename and sign with the passed CertificateHolder
  SignOptions signOptions = new SignOptions();
  signOptions.setSignTime(new Date());
  
  DigitalSignatureUtil.sign(getMyDir() + "Document.docx", getArtifactsDir() + "Document.DigitalSignature.docx",
          certificateHolder, signOptions);
  
  // 2: Create a stream for the input file and one for the output and create a file, signed with the CertificateHolder, at the file system location determine
  InputStream inDoc = new FileInputStream(getMyDir() + "Document.docx");
  try {
      OutputStream outDoc = new FileOutputStream(getArtifactsDir() + "Document.DigitalSignature.docx");
      try {
          DigitalSignatureUtil.sign(inDoc, outDoc, certificateHolder);
      } finally {
          if (outDoc != null) outDoc.close();
      }
  } finally {
      if (inDoc != null) inDoc.close();
  }
  
  Assert.assertTrue(FileFormatUtil.detectFileFormat(getArtifactsDir() + "Document.DigitalSignature.docx").hasDigitalSignature());
  
  // Open the signed document and get its digital signature collection
  Document signedDoc = new Document(getArtifactsDir() + "Document.DigitalSignature.docx");
  DigitalSignatureCollection digitalSignatureCollection = signedDoc.getDigitalSignatures();
  
  // Verify that all of the document's digital signatures are valid and check their details
  Assert.assertTrue(digitalSignatureCollection.isValid());
  Assert.assertEquals(1, digitalSignatureCollection.getCount());
  Assert.assertEquals(DigitalSignatureType.XML_DSIG, digitalSignatureCollection.get(0).getSignatureType());
  Assert.assertEquals("CN=Morzal.Me", signedDoc.getDigitalSignatures().get(0).getIssuerName());
  Assert.assertEquals("CN=Morzal.Me", signedDoc.getDigitalSignatures().get(0).getSubjectName());

• getDocument

  public DocumentBase getDocument()
  

• getEndnoteOptions

  public EndnoteOptions getEndnoteOptions()
  

  Provides options that control numbering and positioning of endnotes in this document.

  Example:

  Shows how to insert endnotes and edit their appearance.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert 3 paragraphs with an endnote at the end of each one
  builder.write("Text 1. ");
  builder.insertFootnote(FootnoteType.ENDNOTE, "Endnote 1");
  builder.write("Text 2. ");
  builder.insertFootnote(FootnoteType.ENDNOTE, "Endnote 2");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.write("Text 3. ");
  builder.insertFootnote(FootnoteType.ENDNOTE, "Endnote 3", "Custom reference mark");
  
  // Edit the numbering and positioning of endnotes
  doc.getEndnoteOptions().setPosition(EndnotePosition.END_OF_DOCUMENT);
  doc.getEndnoteOptions().setNumberStyle(NumberStyle.UPPERCASE_ROMAN);
  doc.getEndnoteOptions().setRestartRule(FootnoteNumberingRule.CONTINUOUS);
  doc.getEndnoteOptions().setStartNumber(1);
  
  doc.save(getArtifactsDir() + "Document.Endnotes.docx");

• getFieldOptions

  public FieldOptions getFieldOptions()
  

  Gets a FieldOptions object that represents options to control field handling in the document.

  Example:

  Shows how to specify where the culture used for date formatting during field update and mail merge is chosen from.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert two merge fields with German locale
  builder.getFont().setLocaleId(1031);
  builder.insertField("MERGEFIELD Date1 \\@ \"dddd, d MMMM yyyy\"");
  builder.write(" - ");
  builder.insertField("MERGEFIELD Date2 \\@ \"dddd, d MMMM yyyy\"");
  
  // Store the current culture in a variable and explicitly set it to US English
  Locale currentLocale = Locale.getDefault();
  Locale.setDefault(new Locale("en", "US"));
  
  // Execute a mail merge for the first MERGEFIELD using the current culture (US English) for date formatting
  doc.getMailMerge().execute(new String[]{"Date1"}, new Object[]{new SimpleDateFormat("yyyy/MM/DD").parse("2011/01/01")});
  
  // Execute a mail merge for the second MERGEFIELD using the field's culture (German) for date formatting
  doc.getFieldOptions().setFieldUpdateCultureSource(FieldUpdateCultureSource.FIELD_CODE);
  doc.getMailMerge().execute(new String[]{"Date2"}, new Object[]{new SimpleDateFormat("yyyy/MM/DD").parse("2011/01/01")});
  
  // The first MERGEFIELD has received a date formatted in English, while the second one is in German
  Assert.assertEquals(doc.getRange().getText().trim(), "Saturday, 1 January 2011 - Samstag, 1 Januar 2011");
  
  // Restore the original culture
  Locale.setDefault(currentLocale);

• getFirstChild

  public Node getFirstChild()
  

  Gets the first child of the node.

  If there is no first child node, a null is returned.

  Example:

  Shows how to enumerate immediate child nodes of a composite node using NextSibling.

  // In this example we enumerate all paragraphs of a section body
  // Get the section that we want to work on
  Section section = doc.getSections().get(0);
  Body body = section.getBody();
  
  // Loop starting from the first child until we reach null
  for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling()) {
      // Output the types of the nodes that we come across
      System.out.println(Node.nodeTypeToString(node.getNodeType()));
  }

  Example:

  Shows how to efficiently visit all direct and indirect children of a composite node.

  public void recurseAllNodes() throws Exception {
      // Open a document
      Document doc = new Document(getMyDir() + "Document.docx");
  
      // Invoke the recursive function that will walk the tree
      traverseAllNodes(doc);
  }
  
  /**
   * A simple function that will walk through all children of a specified node recursively
   * and print the type of each node to the screen.
   */
  @Test(enabled = false)
  public void traverseAllNodes(final CompositeNode parentNode) {
      // This is the most efficient way to loop through immediate children of a node
      for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
          // Do some useful work
          System.out.println(Node.nodeTypeToString(childNode.getNodeType()));
  
          // Recurse into the node if it is a composite node
          if (childNode.isComposite()) {
              traverseAllNodes((CompositeNode) childNode);
          }
      }
  }

• getFirstSection

  public Section getFirstSection()
  

  Gets the first section in the document.

  Returns null if there are no sections.

  Example:

  Shows how to replace text in the document footer.

  // Open the template document, containing obsolete copyright information in the footer
  Document doc = new Document(getMyDir() + "Footer.docx");
  
  HeaderFooterCollection headersFooters = doc.getFirstSection().getHeadersFooters();
  HeaderFooter footer = headersFooters.getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY);
  
  FindReplaceOptions options = new FindReplaceOptions();
  options.setMatchCase(false);
  options.setFindWholeWordsOnly(false);
  
  int currentYear = Calendar.getInstance().get(Calendar.YEAR);
  footer.getRange().replace("(C) 2006 Aspose Pty Ltd.", MessageFormat.format("Copyright (C) {0} by Aspose Pty Ltd.", currentYear), options);
  
  doc.save(getArtifactsDir() + "HeaderFooter.ReplaceText.doc");

  Example:

  Shows how you can enumerate through children of a composite node and detect types of the children nodes.

  // Open a document
  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Section 1");
  builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
  builder.write("Primary header");
  builder.moveToHeaderFooter(HeaderFooterType.FOOTER_PRIMARY);
  builder.write("Primary footer");
  
  // Get the first section in the document
  Section section = doc.getFirstSection();
  
  // A Section is a composite node and therefore can contain child nodes
  // Section can contain only Body and HeaderFooter nodes
  for (Node node : section) {
      // Every node has the NodeType property
      switch (node.getNodeType()) {
          case NodeType.BODY:
              // If the node type is Body, we can cast the node to the Body class
              Body body = (Body) node;
  
              // Write the content of the main story of the section to the console
              System.out.println("*** Body ***");
              System.out.println(body.getText());
              break;
  
          case NodeType.HEADER_FOOTER:
              // If the node type is HeaderFooter, we can cast the node to the HeaderFooter class
              HeaderFooter headerFooter = (HeaderFooter) node;
  
              // Write the content of the header footer to the console
              System.out.println("*** HeaderFooter ***");
              System.out.println(headerFooter.getHeaderFooterType());
              System.out.println(headerFooter.getText());
              break;
  
          default:
              // Other types of nodes never occur inside a Section node
              throw new Exception("Unexpected node type in a section.");
      }
  }

• getFontInfos

  public FontInfoCollection getFontInfos()
  

  Provides access to properties of fonts used in this document.

  This collection of font definitions is loaded as is from the document. Font definitions might be optional, missing or incomplete in some documents.

  Do not rely on this collection to ascertain that a particular font is used in the document. You should only use this collection to get information about fonts that might be used in the document.

  Example:

  Shows how to save a document with embedded TrueType fonts.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  FontInfoCollection fontInfos = doc.getFontInfos();
  fontInfos.setEmbedTrueTypeFonts(true);
  fontInfos.setEmbedSystemFonts(false);
  fontInfos.setSaveSubsetFonts(false);
  
  doc.save(getArtifactsDir() + "Font.FontInfoCollection.docx");

  Example:

  Shows how to gather the details of what fonts are present in a document.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  FontInfoCollection fonts = doc.getFontInfos();
  int fontIndex = 1;
  
  // The fonts info extracted from this document does not necessarily mean that the fonts themselves are
  // used in the document. If a font is present but not used then most likely they were referenced at some time
  // and then removed from the Document
  for (FontInfo info : fonts) {
      // Print out some important details about the font
      System.out.println(MessageFormat.format("Font #{0}", fontIndex));
      System.out.println(MessageFormat.format("Name: {0}", info.getName()));
      System.out.println(MessageFormat.format("IsTrueType: {0}", info.isTrueType()));
      fontIndex++;
  }

  See Also:

  FontInfoCollection, FontInfo

• getFontSettings/setFontSettings

  public FontSettings getFontSettings() / public void setFontSettings(FontSettings value)
  

  Gets or sets document font settings.

  This property allows to specify font settings per document. If set to null, default static font settings FontSettings.DefaultInstance will be used.

  The default value is null.

  Example:

  Shows how to define alternative fonts if original does not exist.

  FontSettings fontSettings = new FontSettings();
  fontSettings.getSubstitutionSettings().getTableSubstitution().addSubstitutes("Times New Roman", "Slab", "Arvo");

• getFootnoteOptions

  public FootnoteOptions getFootnoteOptions()
  

  Provides options that control numbering and positioning of footnotes in this document.

  Example:

  Shows how to add a footnote to a paragraph in the document using DocumentBuilder.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  for (int i = 0; i <= 100; i++) {
      builder.write("Some text " + i);
  
      builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text " + i);
      builder.insertFootnote(FootnoteType.FOOTNOTE, "Footnote text " + i, "242");
  }

• getGlossaryDocument/setGlossaryDocument

  public GlossaryDocument getGlossaryDocument() / public void setGlossaryDocument(GlossaryDocument value)
  

  Gets or sets the glossary document within this document or template. A glossary document is a storage for AutoText, AutoCorrect and Building Block entries defined in a document.

  This property returns null if the document does not have a glossary document.

  You can add a glossary document to a document by creating a GlossaryDocument object and assigning to this property.

  Example:

  Shows how to add a custom building block to a document.

  public void buildingBlockFields() throws Exception {
      Document doc = new Document();
  
      // BuildingBlocks are stored inside the glossary document
      // If you're making a document from scratch, the glossary document must also be manually created
      GlossaryDocument glossaryDoc = new GlossaryDocument();
      doc.setGlossaryDocument(glossaryDoc);
  
      // Create a building block and name it
      BuildingBlock block = new BuildingBlock(glossaryDoc);
      block.setName("Custom Block");
  
      // Put in in the document's glossary document
      glossaryDoc.appendChild(block);
      Assert.assertEquals(glossaryDoc.getCount(), 1);
  
      // All GUIDs are this value by default
      Assert.assertEquals(block.getGuid().toString(), "00000000-0000-0000-0000-000000000000");
  
      // In Microsoft Word, we can use these attributes to find blocks in Insert > Quick Parts > Building Blocks Organizer
      Assert.assertEquals(block.getCategory(), "(Empty Category)");
      Assert.assertEquals(block.getType(), BuildingBlockType.NONE);
      Assert.assertEquals(block.getGallery(), BuildingBlockGallery.ALL);
      Assert.assertEquals(block.getBehavior(), BuildingBlockBehavior.CONTENT);
  
      // If we want to use our building block as an AutoText quick part, we need to give it some text and change some properties
      // All the necessary preparation will be done in a custom document visitor that we will accept
      BuildingBlockVisitor visitor = new BuildingBlockVisitor(glossaryDoc);
      block.accept(visitor);
  
      // We can find the block we made in the glossary document like this
      BuildingBlock customBlock = glossaryDoc.getBuildingBlock(BuildingBlockGallery.QUICK_PARTS,
              "My custom building blocks", "Custom Block");
  
      // Our block contains one section which now contains our text
      Assert.assertEquals(MessageFormat.format("Text inside {0}\f", customBlock.getName()), customBlock.getFirstSection().getBody().getFirstParagraph().getText());
      Assert.assertEquals(customBlock.getFirstSection(), customBlock.getLastSection());
  
      // Then we can insert it into the document as a new section
      doc.appendChild(doc.importNode(customBlock.getFirstSection(), true));
  
      // Or we can find it in Microsoft Word's Building Blocks Organizer and place it manually
      doc.save(getArtifactsDir() + "BuildingBlocks.BuildingBlockFields.dotx");
  }
  
  /// <summary>
  /// Simple implementation of adding text to a building block and preparing it for usage in the document. Implemented as a Visitor.
  /// </summary>
  public static class BuildingBlockVisitor extends DocumentVisitor {
      public BuildingBlockVisitor(final GlossaryDocument ownerGlossaryDoc) {
          mBuilder = new StringBuilder();
          mGlossaryDoc = ownerGlossaryDoc;
      }
  
      public int visitBuildingBlockStart(final BuildingBlock block) {
          // Change values by default of created BuildingBlock
          block.setBehavior(BuildingBlockBehavior.PARAGRAPH);
          block.setCategory("My custom building blocks");
          block.setDescription("Using this block in the Quick Parts section of word will place its contents at the cursor.");
          block.setGallery(BuildingBlockGallery.QUICK_PARTS);
  
          block.setGuid(UUID.randomUUID());
  
          // Add content for the BuildingBlock to have an effect when used in the document
          Section section = new Section(mGlossaryDoc);
          block.appendChild(section);
  
          Body body = new Body(mGlossaryDoc);
          section.appendChild(body);
  
          Paragraph paragraph = new Paragraph(mGlossaryDoc);
          body.appendChild(paragraph);
  
          // Add text that will be visible in the document
          Run run = new Run(mGlossaryDoc, "Text inside " + block.getName());
          block.getFirstSection().getBody().getFirstParagraph().appendChild(run);
  
          return VisitorAction.CONTINUE;
      }
  
      public int visitBuildingBlockEnd(final BuildingBlock block) {
          mBuilder.append("Visited " + block.getName() + "\r\n");
          return VisitorAction.CONTINUE;
      }
  
      private StringBuilder mBuilder;
      private GlossaryDocument mGlossaryDoc;
  }

  See Also:

  GlossaryDocument

• hasChildNodes

  public boolean hasChildNodes()
  

  Returns true if this node has any child nodes.

• hasMacros

  public boolean hasMacros()
  

  Returns true if the document has a VBA project (macros).

  Example:

  Shows how to use MACROBUTTON fields that enable us to run macros by clicking.

  // Open a document that contains macros
  Document doc = new Document(getMyDir() + "Macro.docm");
  DocumentBuilder builder = new DocumentBuilder(doc);
  Assert.assertTrue(doc.hasMacros());
  
  // Insert a MACROBUTTON field and reference by name a macro that exists within the input document
  FieldMacroButton field = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
  field.setMacroName("MyMacro");
  field.setDisplayText("Double click to run macro: " + field.getMacroName());
  
  Assert.assertEquals(field.getFieldCode(), " MACROBUTTON  MyMacro Double click to run macro: MyMacro");
  
  builder.insertParagraph();
  
  // Reference "ViewZoom200", a macro that was shipped with Microsoft Word, found under "Word commands"
  // If our document has a macro of the same name as one from another source, the field will select ours to run
  field = (FieldMacroButton) builder.insertField(FieldType.FIELD_MACRO_BUTTON, true);
  field.setMacroName("ViewZoom200");
  field.setDisplayText("Run " + field.getMacroName());
  
  Assert.assertEquals(field.getFieldCode(), " MACROBUTTON  ViewZoom200 Run ViewZoom200");
  
  // Save the document as a macro-enabled document type
  doc.save(getArtifactsDir() + "Field.MACROBUTTON.docm");

  See Also:

  removeMacros()

• hasRevisions

  public boolean hasRevisions()
  

  Returns true if the document has any tracked changes.

  This property is a shortcut for comparing RevisionCollection.Count to zero.

  Example:

  Shows how to check if a document has revisions.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Normal editing of the document does not count as a revision
  builder.write("This does not count as a revision. ");
  Assert.assertFalse(doc.hasRevisions());
  
  // In order for our edits to count as revisions, we need to declare an author and start tracking them
  doc.startTrackRevisions("John Doe", new Date());
  builder.write("This is revision #1. ");
  
  // This flag corresponds to the "Track Changes" option being turned on in Microsoft Word, to track the editing manually
  // done there and not the programmatic changes we are about to do here
  Assert.assertFalse(doc.getTrackRevisions());
  
  // As well as nodes in the document, revisions get referenced in this collection
  Assert.assertTrue(doc.hasRevisions());
  Assert.assertEquals(doc.getRevisions().getCount(), 1);
  
  Revision revision = doc.getRevisions().get(0);
  Assert.assertEquals(revision.getAuthor(), "John Doe");
  Assert.assertEquals(revision.getParentNode().getText(), "This is revision #1. ");
  Assert.assertEquals(revision.getRevisionType(), RevisionType.INSERTION);
  Assert.assertEquals(DocumentHelper.getDateWithoutTimeUsingFormat(revision.getDateTime()), DocumentHelper.getDateWithoutTimeUsingFormat(new Date()));
  Assert.assertEquals(revision.getGroup(), doc.getRevisions().getGroups().get(0));
  
  // Deleting content also counts as a revision
  // The most recent revisions are put at the start of the collection
  doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0).remove();
  Assert.assertEquals(doc.getRevisions().get(0).getRevisionType(), RevisionType.DELETION);
  Assert.assertEquals(doc.getRevisions().getCount(), 2);
  
  // Insert revisions are treated as document text by the GetText() method before they are accepted,
  // since they are still nodes with text and are in the body
  Assert.assertEquals(doc.getText().trim(), "This does not count as a revision. This is revision #1.");
  
  // Accepting the deletion revision will assimilate it into the paragraph text and remove it from the collection
  doc.getRevisions().get(0).accept();
  Assert.assertEquals(doc.getRevisions().getCount(), 1);
  
  // Once the delete revision is accepted, the nodes that it concerns are removed and their text will not show up here
  Assert.assertEquals(doc.getText().trim(), "This is revision #1.");
  
  // The second insertion revision is now at index 0, which we can reject to ignore and discard it
  doc.getRevisions().get(0).reject();
  Assert.assertEquals(doc.getRevisions().getCount(), 0);
  Assert.assertEquals(doc.getText().trim(), "");

• getHyphenationOptions

  public HyphenationOptions getHyphenationOptions()
  

  Provides access to document hyphenation options.

  Example:

  Shows how to configure document hyphenation options.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Set this to insert a page break before this paragraph
  builder.getFont().setSize(24.0);
  builder.getParagraphFormat().setSuppressAutoHyphens(false);
  
  builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
          "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
  
  doc.getHyphenationOptions().setAutoHyphenation(true);
  doc.getHyphenationOptions().setConsecutiveHyphenLimit(2);
  doc.getHyphenationOptions().setHyphenationZone(720); // 0.5 inch
  doc.getHyphenationOptions().setHyphenateCaps(true);
  
  // Each paragraph has this flag that can be set to suppress hyphenation
  Assert.assertFalse(builder.getParagraphFormat().getSuppressAutoHyphens());
  
  doc.save(getArtifactsDir() + "Document.HyphenationOptions.docx");

• isComposite

  public boolean isComposite()
  

  Returns true as this node can have child nodes.

  Example:

  Shows how to efficiently visit all direct and indirect children of a composite node.

  public void recurseAllNodes() throws Exception {
      // Open a document
      Document doc = new Document(getMyDir() + "Document.docx");
  
      // Invoke the recursive function that will walk the tree
      traverseAllNodes(doc);
  }
  
  /**
   * A simple function that will walk through all children of a specified node recursively
   * and print the type of each node to the screen.
   */
  @Test(enabled = false)
  public void traverseAllNodes(final CompositeNode parentNode) {
      // This is the most efficient way to loop through immediate children of a node
      for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
          // Do some useful work
          System.out.println(Node.nodeTypeToString(childNode.getNodeType()));
  
          // Recurse into the node if it is a composite node
          if (childNode.isComposite()) {
              traverseAllNodes((CompositeNode) childNode);
          }
      }
  }

• getLastChild

  public Node getLastChild()
  

  Gets the last child of the node.

  If there is no last child node, a null is returned.

  Example:

  Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.

  // Document is a CompositeNode and LastChild returns the last child node in the Document node
  // Since the Document can contain only Section nodes, the last child is the last section
  Node lastSection = doc.getLastChild();
  
  // Each node knows its next and previous sibling nodes
  // Previous sibling of a section is a section before the specified section
  // If the node is the first child, PreviousSibling will return null
  Node sectionBeforeLast = lastSection.getPreviousSibling();
  
  if (sectionBeforeLast != null) {
      doc.removeChild(sectionBeforeLast);
  }

• getLastSection

  public Section getLastSection()
  

  Gets the last section in the document.

  Returns null if there are no sections.

  Example:

  Shows how to edit the last section of a document.

  // Open the template document, containing obsolete copyright information in the footer
  Document doc = new Document(getMyDir() + "Footer.docx");
  
  // Create a new copyright information string to replace an older one with
  int currentYear = Calendar.getInstance().get(Calendar.YEAR);
  String newCopyrightInformation = "Copyright (C) %(currentYear) by Aspose Pty Ltd.";
  
  FindReplaceOptions findReplaceOptions = new FindReplaceOptions();
  findReplaceOptions.setMatchCase(false);
  findReplaceOptions.setFindWholeWordsOnly(false);
  
  // Each section has its own set of headers/footers,
  // so the text in each one has to be replaced individually if we want the entire document to be affected
  HeaderFooter firstSectionFooter = doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY);
  firstSectionFooter.getRange().replace("(C) 2006 Aspose Pty Ltd.", newCopyrightInformation, findReplaceOptions);
  
  HeaderFooter lastSectionFooter = doc.getLastSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY);
  lastSectionFooter.getRange().replace("(C) 2006 Aspose Pty Ltd.", newCopyrightInformation, findReplaceOptions);
  
  doc.save(getArtifactsDir() + "Document.Sections.docx");

• getLayoutOptions

  public LayoutOptions getLayoutOptions()
  

  Gets a LayoutOptions object that represents options to control the layout process of this document.

  Example:

  Shows how to set a document's layout options.

  Document doc = new Document();
  LayoutOptions options = doc.getLayoutOptions();
  
  // The appearance of revisions can be controlled from the layout options property
  doc.startTrackRevisions("John Doe", new Date());
  options.getRevisionOptions().setInsertedTextColor(RevisionColor.BRIGHT_GREEN);
  options.getRevisionOptions().setShowRevisionBars(false);
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.writeln(
          "This is a revision. Normally the text is red with a bar to the left, but we made some changes to the revision options.");
  
  doc.stopTrackRevisions();
  
  // Layout options can be used to show hidden text too
  builder.writeln("This text is not hidden.");
  builder.getFont().setHidden(true);
  builder.writeln(
          "This text is hidden. It will only show up in the output if we allow it to via doc.LayoutOptions.");
  
  options.setShowHiddenText(true);
  
  // This option is equivalent to enabling paragraph marks in Microsoft Word via Home > paragraph > Show Paragraph Marks,
  // and can be used to display these features in a .pdf
  options.setShowParagraphMarks(true);
  
  doc.save(getArtifactsDir() + "Document.LayoutOptions.pdf");

• getLists

  public ListCollection getLists()
  

  Provides access to the list formatting used in the document.

  For more information see the description of the ListCollection class.

  Example:

  Shows how to specify list level number when building a list using DocumentBuilder.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Create a numbered list based on one of the Microsoft Word list templates and
  // apply it to the current paragraph in the document builder
  builder.getListFormat().setList(doc.getLists().add(ListTemplate.NUMBER_ARABIC_DOT));
  
  // There are 9 levels in this list, lets try them all
  for (int i = 0; i < 9; i++) {
      builder.getListFormat().setListLevelNumber(i);
      builder.writeln("Level " + i);
  }
  
  // Create a bulleted list based on one of the Microsoft Word list templates
  // and apply it to the current paragraph in the document builder
  builder.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DIAMONDS));
  
  // There are 9 levels in this list, lets try them all
  for (int i = 0; i < 9; i++) {
      builder.getListFormat().setListLevelNumber(i);
      builder.writeln("Level " + i);
  }
  
  // This is a way to stop list formatting
  builder.getListFormat().setList(null);
  
  builder.getDocument().save(getArtifactsDir() + "Lists.SpecifyListLevel.doc");

  See Also:

  ListCollection, List, ListFormat

• getMailMerge

  public MailMerge getMailMerge()
  

  Returns a MailMerge object that represents the mail merge functionality for the document.

  Example:

  Executes mail merge from data stored in a ResultSet.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertField(" MERGEFIELD CustomerName ");
  builder.insertParagraph();
  builder.insertField(" MERGEFIELD Address ");
  
  // This example creates a table, but you would normally load table from a database
  DataTable table = new DataTable("Test");
  table.getColumns().add("CustomerName");
  table.getColumns().add("Address");
  table.getRows().add(new Object[]{"Thomas Hardy", "120 Hanover Sq., London"});
  table.getRows().add(new Object[]{"Paolo Accorti", "Via Monte Bianco 34, Torino"});
  
  // Field values from the table are inserted into the mail merge fields found in the document
  doc.getMailMerge().execute(table);
  
  doc.save(getArtifactsDir() + "MailMerge.ExecuteDataTable.doc");
  
  // Create a copy of our document to perform another mail merge
  doc = new Document();
  builder = new DocumentBuilder(doc);
  builder.insertField(" MERGEFIELD CustomerName ");
  builder.insertParagraph();
  builder.insertField(" MERGEFIELD Address ");
  
  // We can also source values for a mail merge from a single row in the table
  doc.getMailMerge().execute(table.getRows().get(1));
  
  doc.save(getArtifactsDir() + "MailMerge.ExecuteDataTable.OneRow.doc");

• getMailMergeSettings/setMailMergeSettings

  public MailMergeSettings getMailMergeSettings() / public void setMailMergeSettings(MailMergeSettings value)
  

  Gets or sets the object that contains all of the mail merge information for a document.

  You can use this object to specify a mail merge data source for a document and this information (along with the available data fields) will appear in Microsoft Word when the user opens this document. Or you can use this object to query mail merge settings that the user has specified in Microsoft Word for this document.

  This object is never null.

  Example:

  Shows how to execute an Office Data Source Object mail merge with MailMergeSettings.

  // We'll create a simple document that will act as a destination for mail merge data
  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Dear ");
  builder.insertField("MERGEFIELD FirstName", "<FirstName>");
  builder.write(" ");
  builder.insertField("MERGEFIELD LastName", "<LastName>");
  builder.writeln(": ");
  builder.insertField("MERGEFIELD Message", "<Message>");
  
  // Also we'll need a data source, in this case it will be an ASCII text file
  // We can use any character we want as a delimiter, in this case we'll choose '|'
  // The delimiter character is selected in the ODSO settings of mail merge settings
  String[] lines = {"FirstName|LastName|Message",
          "John|Doe|Hello! This message was created with Aspose Words mail merge."};
  
  String dataSrcFilename = getArtifactsDir() + "Document.MailMergeSettings.DataSource.txt";
  Files.write(Paths.get(dataSrcFilename),
          (lines + System.lineSeparator()).getBytes(UTF_8),
          new StandardOpenOption[]{StandardOpenOption.CREATE, StandardOpenOption.APPEND});
  
  // Set the data source, query and other things
  MailMergeSettings settings = doc.getMailMergeSettings();
  settings.setMainDocumentType(MailMergeMainDocumentType.MAILING_LABELS);
  settings.setCheckErrors(MailMergeCheckErrors.SIMULATE);
  settings.setDataType(MailMergeDataType.NATIVE);
  settings.setDataSource(dataSrcFilename);
  settings.setQuery("SELECT * FROM " + doc.getMailMergeSettings().getDataSource());
  settings.setLinkToQuery(true);
  settings.setViewMergedData(true);
  
  Assert.assertEquals(settings.getDestination(), MailMergeDestination.DEFAULT);
  Assert.assertFalse(settings.getDoNotSupressBlankLines());
  
  // Office Data Source Object settings
  Odso odso = settings.getOdso();
  odso.setDataSource(dataSrcFilename);
  odso.setDataSourceType(OdsoDataSourceType.TEXT);
  odso.setColumnDelimiter('|');
  odso.setFirstRowContainsColumnNames(true);
  
  // ODSO/MailMergeSettings objects can also be cloned
  Assert.assertNotSame(odso, odso.deepClone());
  Assert.assertNotSame(settings, settings.deepClone());
  
  // The mail merge will be performed when this document is opened
  doc.save(getArtifactsDir() + "Document.MailMergeSettings.docx");

• getNextSibling

  public Node getNextSibling()
  

  Gets the node immediately following this node.

  If there is no next node, a null is returned.

  Example:

  Shows how to enumerate immediate child nodes of a composite node using NextSibling.

  // In this example we enumerate all paragraphs of a section body
  // Get the section that we want to work on
  Section section = doc.getSections().get(0);
  Body body = section.getBody();
  
  // Loop starting from the first child until we reach null
  for (Node node = body.getFirstChild(); node != null; node = node.getNextSibling()) {
      // Output the types of the nodes that we come across
      System.out.println(Node.nodeTypeToString(node.getNodeType()));
  }

  Example:

  Shows how to efficiently visit all direct and indirect children of a composite node.

  public void recurseAllNodes() throws Exception {
      // Open a document
      Document doc = new Document(getMyDir() + "Document.docx");
  
      // Invoke the recursive function that will walk the tree
      traverseAllNodes(doc);
  }
  
  /**
   * A simple function that will walk through all children of a specified node recursively
   * and print the type of each node to the screen.
   */
  @Test(enabled = false)
  public void traverseAllNodes(final CompositeNode parentNode) {
      // This is the most efficient way to loop through immediate children of a node
      for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
          // Do some useful work
          System.out.println(Node.nodeTypeToString(childNode.getNodeType()));
  
          // Recurse into the node if it is a composite node
          if (childNode.isComposite()) {
              traverseAllNodes((CompositeNode) childNode);
          }
      }
  }

• getNodeChangingCallback/setNodeChangingCallback

  public INodeChangingCallback getNodeChangingCallback() / public void setNodeChangingCallback(INodeChangingCallback value)
  

  Called when a node is inserted or removed in the document.

  Example:

  Shows how to implement custom logic over node insertion in the document by changing the font of inserted HTML content.

  public void fontChangeViaCallback() throws Exception
  {
      Document doc = new Document();
      DocumentBuilder builder = new DocumentBuilder(doc);
  
      // Set up and pass the object which implements the handler methods
      doc.setNodeChangingCallback(new HandleNodeChangingFontChanger());
  
      // Insert sample HTML content
      builder.insertHtml("<p>Hello World</p>");
  
      doc.save(getArtifactsDir() + "Document.FontChangeViaCallback.docx");
  }
  
  public class HandleNodeChangingFontChanger implements INodeChangingCallback {
      // Implement the NodeInserted handler to set default font settings for every Run node inserted into the Document
      public void nodeInserted(final NodeChangingArgs args) {
          // Change the font of inserted text contained in the Run nodes
          if (args.getNode().getNodeType() == NodeType.RUN) {
              Font font = ((Run) args.getNode()).getFont();
              font.setSize(24);
              font.setName("Arial");
          }
      }
  
      public void nodeInserting(final NodeChangingArgs args) {
          // Do Nothing
      }
  
      public void nodeRemoved(final NodeChangingArgs args) {
          // Do Nothing
      }
  
      public void nodeRemoving(final NodeChangingArgs args) {
          // Do Nothing
      }
  }

• getNodeType

  public int getNodeType()
  

  Returns NodeType.Document. The value of the property is NodeType integer constant.

  Example:

  Shows how to retrieve the NodeType enumeration of nodes.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Let's pick a node that we can't be quite sure of what type it is
  // In this case lets pick the first node of the first paragraph in the body of the document
  Node node = doc.getFirstSection().getBody().getFirstParagraph().getFirstChild();
  System.out.println("NodeType of first child: " + Node.nodeTypeToString(node.getNodeType()));
  
  // This time let's pick a node that we know the type of
  // Create a new paragraph and a table node
  Paragraph para = new Paragraph(doc);
  Table table = new Table(doc);
  
  // Access to NodeType for typed nodes will always return their specific NodeType
  // i.e A paragraph node will always return NodeType.Paragraph, a table node will always return NodeType.Table
  System.out.println("NodeType of Paragraph: " + Node.nodeTypeToString(para.getNodeType()));
  System.out.println("NodeType of Table: " + Node.nodeTypeToString(table.getNodeType()));

• getOriginalFileName

  public java.lang.String getOriginalFileName()
  

  Gets the original file name of the document.

  Returns null if the document was loaded from a stream or created blank.

  Example:

  Shows how to retrieve the details of the path, filename and LoadFormat of a document from when the document was first loaded into memory.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // This property will return the full path and file name where the document was loaded from
  Assert.assertEquals(getMyDir() + "Document.docx", doc.getOriginalFileName());
  
  // This is the original LoadFormat of the document
  Assert.assertEquals(com.aspose.words.LoadFormat.DOCX, doc.getOriginalLoadFormat());

  Example:

  Shows how to use the FileFormatUtil methods to detect the format of a document without any extension and save it with the correct file extension.

  // Load the document without a file extension into a stream and use the DetectFileFormat method to detect it's format
  // These are both times where you might need extract the file format as it's not visible
  // The file format of this document is actually ".doc"
  FileInputStream docStream = new FileInputStream(getMyDir() + "Word document with missing file extension");
  FileFormatInfo info = FileFormatUtil.detectFileFormat(docStream);
  
  // Retrieve the LoadFormat of the document
  int loadFormat = info.getLoadFormat();
  
  // Let's show the different methods of converting LoadFormat enumerations to SaveFormat enumerations
  //
  // Method #1
  // Convert the LoadFormat to a String first for working with. The String will include the leading dot in front of the extension
  String fileExtension = FileFormatUtil.loadFormatToExtension(loadFormat);
  // Now convert this extension into the corresponding SaveFormat enumeration
  int saveFormat = FileFormatUtil.extensionToSaveFormat(fileExtension);
  
  // Method #2
  // Convert the LoadFormat enumeration directly to the SaveFormat enumeration
  saveFormat = FileFormatUtil.loadFormatToSaveFormat(loadFormat);
  
  // Load a document from the stream.
  Document doc = new Document(docStream);
  
  // Save the document with the original file name, " Out" and the document's file extension
  doc.save(getArtifactsDir() + "File.SaveToDetectedFileFormat" + FileFormatUtil.saveFormatToExtension(saveFormat));

• getOriginalLoadFormat

  public int getOriginalLoadFormat()
  

  Gets the format of the original document that was loaded into this object. The value of the property is LoadFormat integer constant.

  If you created a new blank document, returns the LoadFormat.DOC value.

  Example:

  Shows how to retrieve the details of the path, filename and LoadFormat of a document from when the document was first loaded into memory.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // This property will return the full path and file name where the document was loaded from
  Assert.assertEquals(getMyDir() + "Document.docx", doc.getOriginalFileName());
  
  // This is the original LoadFormat of the document
  Assert.assertEquals(com.aspose.words.LoadFormat.DOCX, doc.getOriginalLoadFormat());

• getPackageCustomParts/setPackageCustomParts

  public CustomPartCollection getPackageCustomParts() / public void setPackageCustomParts(CustomPartCollection value)
  

  Gets or sets the collection of custom parts (arbitrary content) that are linked to the OOXML package using "unknown relationships".

  Do not confuse these custom parts with Custom XML Data. If you need to access Custom XML parts, use the CustomXmlParts property.

  This collection contains OOXML parts whose parent is the OOXML package and they targets are of an "unknown relationship". For more information see CustomPart.

  Aspose.Words loads and saves custom parts into OOXML documents only.

  This property cannot be null.

  Example:

  Shows how to open a document with custom parts and access them.

  // Open a document that contains custom parts
  // CustomParts are arbitrary content OOXML parts
  // Not to be confused with Custom XML data which is represented by CustomXmlParts
  // This part is internal, meaning it is contained inside the OOXML package
  Document doc = new Document(getMyDir() + "Custom parts OOXML package.docx");
  
  // Clone the second part
  CustomPart clonedPart = doc.getPackageCustomParts().get(1).deepClone();
  
  // Add the clone to the collection
  doc.getPackageCustomParts().add(clonedPart);
  
  // Use an enumerator to print information about the contents of each part
  Iterator<CustomPart> enumerator = doc.getPackageCustomParts().iterator();
  
  int index = 0;
  while (enumerator.hasNext()) {
      CustomPart customPart = (CustomPart) enumerator.next();
      System.out.println(MessageFormat.format("Part index {0}:", index));
      System.out.println(MessageFormat.format("\tName: {0}", customPart.getName()));
      System.out.println(MessageFormat.format("\tContentType: {0}", customPart.getContentType()));
      System.out.println(MessageFormat.format("\tRelationshipType: {0}", customPart.getRelationshipType()));
      if (customPart.isExternal()) {
          System.out.println("\tSourced from outside the document");
      } else {
          System.out.println(MessageFormat.format("\tSourced from within the document, length: {0} bytes", customPart.getData().length));
      }
      index++;
  }
  
  // The parts collection can have individual entries removed or be cleared like this
  doc.getPackageCustomParts().removeAt(2);
  doc.getPackageCustomParts().clear();

  See Also:

  CustomPart

• getPageColor/setPageColor

  public java.awt.Color getPageColor() / public void setPageColor(java.awt.Color value)
  

  Gets or sets the page color of the document. This property is a simpler version of BackgroundShape.

  This property provides a simple way to specify a solid page color for the document. Setting this property creates and sets an appropriate BackgroundShape.

  If the page color is not set (e.g. there is no background shape in the document) returns a zero color.

  Example:

  Shows how to set the page color.

  Document doc = new Document();
  
  doc.setPageColor(Color.lightGray);
  
  doc.save(getArtifactsDir() + "DocumentBase.SetPageColor.docx");

  See Also:

  BackgroundShape

• getPageCount

  public int getPageCount()
  

  Gets the number of pages in the document as calculated by the most recent page layout operation.

  Example:

  Shows how to invoke page layout and retrieve the number of pages in the document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert text spanning 3 pages
  builder.write("Page 1");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.write("Page 2");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.write("Page 3");
  
  // Get the page count
  Assert.assertEquals(3, doc.getPageCount());
  
  // Getting the PageCount property invoked the document's page layout to calculate the value
  // This operation will not need to be re-done when rendering the document to a save format like .pdf,
  // which can save time with larger documents
  doc.save(getArtifactsDir() + "Document.GetPageCount.pdf");

  See Also:

  updatePageLayout()

• getParentNode

  public CompositeNode getParentNode()
  

  Gets the immediate parent of this node.

  If a node has just been created and not yet added to the tree, or if it has been removed from the tree, the parent is null.

  Example:

  Shows how to access the parent node.

  // Create a new empty document. It has one section
  Document doc = new Document();
  
  // The section is the first child node of the document
  Node section = doc.getFirstChild();
  
  // The section's parent node is the document
  System.out.println("Section parent is the document: " + (doc == section.getParentNode()));

  Example:

  Shows that when you create any node, it requires a document that will own the node.

  // Open a file from disk
  Document doc = new Document();
  
  // Creating a new node of any type requires a document passed into the constructor
  Paragraph para = new Paragraph(doc);
  
  // The new paragraph node does not yet have a parent
  System.out.println("Paragraph has no parent node: " + (para.getParentNode() == null));
  
  // But the paragraph node knows its document
  System.out.println("Both nodes' documents are the same: " + (para.getDocument() == doc));
  
  // The fact that a node always belongs to a document allows us to access and modify 
  // properties that reference the document-wide data such as styles or lists
  para.getParagraphFormat().setStyleName("Heading 1");
  
  // Now add the paragraph to the main text of the first section
  doc.getFirstSection().getBody().appendChild(para);
  
  // The paragraph node is now a child of the Body node
  System.out.println("Paragraph has a parent node: " + (para.getParentNode() != null));

• getPreviousSibling

  public Node getPreviousSibling()
  

  Gets the node immediately preceding this node.

  If there is no preceding node, a null is returned.

  Example:

  Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.

  // Document is a CompositeNode and LastChild returns the last child node in the Document node
  // Since the Document can contain only Section nodes, the last child is the last section
  Node lastSection = doc.getLastChild();
  
  // Each node knows its next and previous sibling nodes
  // Previous sibling of a section is a section before the specified section
  // If the node is the first child, PreviousSibling will return null
  Node sectionBeforeLast = lastSection.getPreviousSibling();
  
  if (sectionBeforeLast != null) {
      doc.removeChild(sectionBeforeLast);
  }

• getProtectionType

  public int getProtectionType()
  

  Gets the currently active document protection type. The value of the property is ProtectionType integer constant.

  This property allows to retrieve the currently set document protection type. To change the document protection type use the protect(int,java.lang.String) and unprotect() methods.

  When a document is protected, the user can make only limited changes, such as adding annotations, making revisions, or completing a form.

  Note that document protection is different from write protection. Write protection is specified using the WriteProtection

  Example:

  Shows how to protect a document.

  // Create a new document and protect it with a password
  Document doc = new Document();
  doc.protect(ProtectionType.READ_ONLY, "password");
  Assert.assertEquals(ProtectionType.READ_ONLY, doc.getProtectionType());
  
  // If we open this document with Microsoft Word and wish to edit it, 
  // we will first need to stop the protection, which can only be done with the password
  doc.save(getArtifactsDir() + "Document.Protect.docx");
  
  // Note that the protection only applies to Microsoft Word users opening out document
  // The document can still be opened and edited programmatically without a password, despite its protection status
  // Encryption offers a more robust option for protecting document content
  Document protectedDoc = new Document(getArtifactsDir() + "Document.Protect.docx");
  Assert.assertEquals(ProtectionType.READ_ONLY, protectedDoc.getProtectionType());
  
  DocumentBuilder builder = new DocumentBuilder(protectedDoc);
  builder.writeln("Text added to a protected document.");
  
  // Documents can have protection removed either with no password, or with the correct password
  doc.unprotect();
  Assert.assertEquals(ProtectionType.NO_PROTECTION, doc.getProtectionType());
  
  doc.protect(ProtectionType.READ_ONLY, "newPassword");
  doc.unprotect("newPassword");
  Assert.assertEquals(ProtectionType.NO_PROTECTION, doc.getProtectionType());

  See Also:

  protect(int,java.lang.String), unprotect(), WriteProtection

• getRange

  public Range getRange()
  

  Returns a Range object that represents the portion of a document that is contained in this node.

  Example:

  Shows how to delete all characters of a range.

  // Insert two sections into a blank document
  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Section 1. ");
  builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
  builder.write("Section 2.");
  
  // Verify the whole text of the document
  Assert.assertEquals("Section 1. \fSection 2.", doc.getText().trim());
  
  // Delete the first section from the document
  doc.getSections().get(0).getRange().delete();
  
  // Check the first section was deleted by looking at the text of the whole document again
  Assert.assertEquals("Section 2.", doc.getText().trim());

• getRemovePersonalInformation/setRemovePersonalInformation

  public boolean getRemovePersonalInformation() / public void setRemovePersonalInformation(boolean value)
  

  Gets or sets a flag indicating that Microsoft Word will remove all user information from comments, revisions and document properties upon saving the document.

  Example:

  Shows how to get or set a flag to remove all user information upon saving the MS Word document.

  Document doc = new Document(getMyDir() + "Revisions.docx");
  // If flag sets to 'true' that MS Word will remove all user information from comments, revisions and
  // document properties upon saving the document. In MS Word 2013 and 2016 you can see this using
  // File -> Options -> Trust Center -> Trust Center Settings -> Privacy Options -> then the
  // checkbox "Remove personal information from file properties on save"
  doc.setRemovePersonalInformation(true);
  
  // Personal information will not be removed at this time
  // This will happen when we open this document in Microsoft Word and save it manually
  // Once noticeable change will be the revisions losing their author names
  doc.save(getArtifactsDir() + "Document.RemovePersonalInformation.docx");

• getResourceLoadingCallback/setResourceLoadingCallback

  public IResourceLoadingCallback getResourceLoadingCallback() / public void setResourceLoadingCallback(IResourceLoadingCallback value)
  

  Allows to control how external resources are loaded.

  Example:

  Shows how to process inserted resources differently.

  public void resourceLoadingCallback() throws Exception {
      Document doc = new Document();
  
      // Enable our custom image loading
      doc.setResourceLoadingCallback(new ImageNameHandler());
  
      DocumentBuilder builder = new DocumentBuilder(doc);
  
      // We usually insert images as a uri or byte array, but there are many other possibilities with ResourceLoadingCallback
      // In this case we are referencing images with simple names and keep the image fetching logic somewhere else
      builder.insertImage("Google Logo");
      builder.insertImage("Aspose Logo");
      builder.insertImage("My Watermark");
  
      // Images belong to Shape objects, which are placed and scaled in the document
      Assert.assertEquals(3, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  
      doc.save(getArtifactsDir() + "DocumentBase.ResourceLoadingCallback.docx");
  }
  
  private static class ImageNameHandler implements IResourceLoadingCallback {
      public int resourceLoading(final ResourceLoadingArgs args) throws URISyntaxException, IOException {
          if (args.getResourceType() == ResourceType.IMAGE) {
              // builder.InsertImage expects a uri so inputs like "Google Logo" would normally trigger a FileNotFoundException
              // We can still process those inputs and find an image any way we like, as long as an image byte array is passed to args.SetData()
              if ("Google Logo".equals(args.getOriginalUri())) {
                  args.setData(DocumentHelper.getBytesFromStream(new URI("http://www.google.com/images/logos/ps_logo2.png").toURL().openStream()));
                  // We need this return statement any time a resource is loaded in a custom manner
                  return ResourceLoadingAction.USER_PROVIDED;
              }
  
              if ("Aspose Logo".equals(args.getOriginalUri())) {
                  args.setData(DocumentHelper.getBytesFromStream(getAsposelogoUri().toURL().openStream()));
  
                  return ResourceLoadingAction.USER_PROVIDED;
              }
  
              // We can find and add an image any way we like, as long as args.SetData() is called with some image byte array as a parameter
              if ("My Watermark".equals(args.getOriginalUri())) {
                  InputStream imageStream = new FileInputStream(getImageDir() + "Transparent background logo.png");
                  args.setData(DocumentHelper.getBytesFromStream(imageStream));
  
                  return ResourceLoadingAction.USER_PROVIDED;
              }
          }
  
          // All other resources such as documents, CSS stylesheets and images passed as uris are handled as they were normally
          return ResourceLoadingAction.DEFAULT;
      }
  }

• getRevisions

  public RevisionCollection getRevisions()
  

  Gets a collection of revisions (tracked changes) that exist in this document.

  The returned collection is a "live" collection, which means if you remove parts of a document that contain revisions, the deleted revisions will automatically disappear from this collection.

  Example:

  Shows how to check if a document has revisions.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Normal editing of the document does not count as a revision
  builder.write("This does not count as a revision. ");
  Assert.assertFalse(doc.hasRevisions());
  
  // In order for our edits to count as revisions, we need to declare an author and start tracking them
  doc.startTrackRevisions("John Doe", new Date());
  builder.write("This is revision #1. ");
  
  // This flag corresponds to the "Track Changes" option being turned on in Microsoft Word, to track the editing manually
  // done there and not the programmatic changes we are about to do here
  Assert.assertFalse(doc.getTrackRevisions());
  
  // As well as nodes in the document, revisions get referenced in this collection
  Assert.assertTrue(doc.hasRevisions());
  Assert.assertEquals(doc.getRevisions().getCount(), 1);
  
  Revision revision = doc.getRevisions().get(0);
  Assert.assertEquals(revision.getAuthor(), "John Doe");
  Assert.assertEquals(revision.getParentNode().getText(), "This is revision #1. ");
  Assert.assertEquals(revision.getRevisionType(), RevisionType.INSERTION);
  Assert.assertEquals(DocumentHelper.getDateWithoutTimeUsingFormat(revision.getDateTime()), DocumentHelper.getDateWithoutTimeUsingFormat(new Date()));
  Assert.assertEquals(revision.getGroup(), doc.getRevisions().getGroups().get(0));
  
  // Deleting content also counts as a revision
  // The most recent revisions are put at the start of the collection
  doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0).remove();
  Assert.assertEquals(doc.getRevisions().get(0).getRevisionType(), RevisionType.DELETION);
  Assert.assertEquals(doc.getRevisions().getCount(), 2);
  
  // Insert revisions are treated as document text by the GetText() method before they are accepted,
  // since they are still nodes with text and are in the body
  Assert.assertEquals(doc.getText().trim(), "This does not count as a revision. This is revision #1.");
  
  // Accepting the deletion revision will assimilate it into the paragraph text and remove it from the collection
  doc.getRevisions().get(0).accept();
  Assert.assertEquals(doc.getRevisions().getCount(), 1);
  
  // Once the delete revision is accepted, the nodes that it concerns are removed and their text will not show up here
  Assert.assertEquals(doc.getText().trim(), "This is revision #1.");
  
  // The second insertion revision is now at index 0, which we can reject to ignore and discard it
  doc.getRevisions().get(0).reject();
  Assert.assertEquals(doc.getRevisions().getCount(), 0);
  Assert.assertEquals(doc.getText().trim(), "");

• getRevisionsView/setRevisionsView

  public int getRevisionsView() / public void setRevisionsView(int value)
  

  Gets or sets a value indicating whether to work with the original or revised version of a document. The value of the property is RevisionsView integer constant.

  The default value is RevisionsView.ORIGINAL.

  Example:

  Shows how to get revised version of list label and list level formatting in a document.

  Document doc = new Document(getMyDir() + "Revisions at list levels.docx");
  doc.updateListLabels();
  
  // Switch to the revised version of the document
  doc.setRevisionsView(RevisionsView.FINAL);
  
  for (Revision revision : doc.getRevisions()) {
      if (revision.getParentNode().getNodeType() == NodeType.PARAGRAPH) {
          Paragraph paragraph = (Paragraph) revision.getParentNode();
  
          if (paragraph.isListItem()) {
              // Print revised version of LabelString and ListLevel
              System.out.println(paragraph.getListLabel().getLabelString());
              System.out.println(paragraph.getListFormat().getListLevel());
          }
      }
  }

• getSections

  public SectionCollection getSections()
  

  Returns a collection that represents all sections in the document.

  Example:

  Specifies how the section starts, from a new page, on the same page or other.

  Document doc = new Document();
  doc.getSections().get(0).getPageSetup().setSectionStart(com.aspose.words.SectionStart.CONTINUOUS);

  Example:

  Shows how to add/remove sections in a document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.write("Section 1");
  builder.insertBreak(BreakType.SECTION_BREAK_NEW_PAGE);
  builder.write("Section 2");
  
  // This shows what is in the document originally. The document has two sections
  System.out.println(doc.getText());
  
  // Delete the first section from the document
  doc.getSections().removeAt(0);
  
  // Duplicate the last section and append the copy to the end of the document
  int lastSectionIdx = doc.getSections().getCount() - 1;
  Section newSection = doc.getSections().get(lastSectionIdx).deepClone();
  doc.getSections().add(newSection);
  
  // Check what the document contains after we changed it
  System.out.println(doc.getText());

• getShadeFormData/setShadeFormData

  public boolean getShadeFormData() / public void setShadeFormData(boolean value)
  

  Specifies whether to turn on the gray shading on form fields.

  Example:

  Shows how to apply gray shading to bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // By default, bookmarked text is highlighted gray
  Assert.assertTrue(doc.getShadeFormData());
  
  builder.write("Text before bookmark. ");
  
  builder.insertTextInput("My bookmark", TextFormFieldType.REGULAR, "",
          "If gray form field shading is turned on, this is the text that will have a gray background.", 0);
  
  // We can turn the grey shading off so the bookmarked text will blend in with the other text
  doc.setShadeFormData(false);
  doc.save(getArtifactsDir() + "Document.ShadeFormData.docx");

• getShowGrammaticalErrors/setShowGrammaticalErrors

  public boolean getShowGrammaticalErrors() / public void setShowGrammaticalErrors(boolean value)
  

  Specifies whether to display grammar errors in this document.

• getShowSpellingErrors/setShowSpellingErrors

  public boolean getShowSpellingErrors() / public void setShowSpellingErrors(boolean value)
  

  Specifies whether to display spelling errors in this document.

• getStyles

  public StyleCollection getStyles()
  

  Returns a collection of styles defined in the document.

  For more information see the description of the StyleCollection class.

  Example:

  Shows how to get access to the collection of styles defined in the document.

  Document doc = new Document();
  
  Iterator<Style> stylesEnum = doc.getStyles().iterator();
  while (stylesEnum.hasNext()) {
      Style curStyle = stylesEnum.next();
      System.out.println(MessageFormat.format("Style name:\t\"{0}\", of type \"{1}\"", curStyle.getName(), curStyle.getType()));
      System.out.println(MessageFormat.format("\tSubsequent style:\t{0}", curStyle.getNextParagraphStyleName()));
      System.out.println(MessageFormat.format("\tIs heading:\t\t\t{0}", curStyle.isHeading()));
      System.out.println(MessageFormat.format("\tIs QuickStyle:\t\t{0}", curStyle.isQuickStyle()));
  
      Assert.assertEquals(curStyle.getDocument(), doc);
  }

  Example:

  Shows how to create and use a paragraph style with list formatting.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Create a paragraph style and specify some formatting for it
  Style style = doc.getStyles().add(StyleType.PARAGRAPH, "MyStyle1");
  style.getFont().setSize(24);
  style.getFont().setName("Verdana");
  style.getParagraphFormat().setSpaceAfter(12);
  
  // Create a list and make sure the paragraphs that use this style will use this list
  style.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DEFAULT));
  style.getListFormat().setListLevelNumber(0);
  
  // Apply the paragraph style to the current paragraph in the document and add some text
  builder.getParagraphFormat().setStyle(style);
  builder.writeln("Hello World: MyStyle1, bulleted.");
  
  // Change to a paragraph style that has no list formatting
  builder.getParagraphFormat().setStyle(doc.getStyles().get("Normal"));
  builder.writeln("Hello World: Normal.");
  
  builder.getDocument().save(getArtifactsDir() + "Lists.ParagraphStyleBulleted.doc");

  See Also:

  StyleCollection, Style

• getTheme

  public Theme getTheme()
  

  Gets the Theme object for this document.

  Example:

  Shows how to set custom theme colors and fonts.

  Document doc = new Document(getMyDir() + "Theme colors.docx");
  
  // This object gives us access to the document theme, which is a source of default fonts and colors
  Theme theme = doc.getTheme();
  
  // These fonts will be inherited by some styles like "Heading 1" and "Subtitle"
  theme.getMajorFonts().setLatin("Courier New");
  theme.getMinorFonts().setLatin("Agency FB");
  
  Assert.assertEquals(theme.getMajorFonts().getComplexScript(), "");
  Assert.assertEquals(theme.getMajorFonts().getEastAsian(), "");
  Assert.assertEquals(theme.getMinorFonts().getComplexScript(), "");
  Assert.assertEquals(theme.getMinorFonts().getEastAsian(), "");
  
  // This collection of colors corresponds to the color palette from Microsoft Word which appears when changing shading or font color 
  ThemeColors colors = theme.getColors();
  
  // We will set the color of each color palette column going from left to right like this
  colors.setDark1(Color.BLUE);
  colors.setLight1(Color.GREEN);
  colors.setDark2(Color.MAGENTA);
  colors.setLight2(Color.BLACK);
  
  colors.setAccent1(Color.RED);
  colors.setAccent2(Color.PINK);
  colors.setAccent3(Color.YELLOW);
  colors.setAccent4(Color.orange);
  colors.setAccent5(Color.cyan);
  colors.setAccent6(Color.darkGray);
  
  // We can also set colors for hyperlinks like this
  colors.setHyperlink(Color.WHITE);
  colors.setFollowedHyperlink(Color.lightGray);
  
  doc.save(getArtifactsDir() + "Themes.CustomColorsAndFonts.docx");

• getTrackRevisions/setTrackRevisions

  public boolean getTrackRevisions() / public void setTrackRevisions(boolean value)
  

  True if changes are tracked when this document is edited in Microsoft Word.

  Setting this option only instructs Microsoft Word whether the track changes is turned on or off. This property has no effect on changes to the document that you make programmatically via Aspose.Words.

  If you want to automatically track changes as they are made programmatically by Aspose.Words to this document use the startTrackRevisions(java.lang.String,java.util.Date) method.

  Example:

  Shows how to check if a document has revisions.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Normal editing of the document does not count as a revision
  builder.write("This does not count as a revision. ");
  Assert.assertFalse(doc.hasRevisions());
  
  // In order for our edits to count as revisions, we need to declare an author and start tracking them
  doc.startTrackRevisions("John Doe", new Date());
  builder.write("This is revision #1. ");
  
  // This flag corresponds to the "Track Changes" option being turned on in Microsoft Word, to track the editing manually
  // done there and not the programmatic changes we are about to do here
  Assert.assertFalse(doc.getTrackRevisions());
  
  // As well as nodes in the document, revisions get referenced in this collection
  Assert.assertTrue(doc.hasRevisions());
  Assert.assertEquals(doc.getRevisions().getCount(), 1);
  
  Revision revision = doc.getRevisions().get(0);
  Assert.assertEquals(revision.getAuthor(), "John Doe");
  Assert.assertEquals(revision.getParentNode().getText(), "This is revision #1. ");
  Assert.assertEquals(revision.getRevisionType(), RevisionType.INSERTION);
  Assert.assertEquals(DocumentHelper.getDateWithoutTimeUsingFormat(revision.getDateTime()), DocumentHelper.getDateWithoutTimeUsingFormat(new Date()));
  Assert.assertEquals(revision.getGroup(), doc.getRevisions().getGroups().get(0));
  
  // Deleting content also counts as a revision
  // The most recent revisions are put at the start of the collection
  doc.getFirstSection().getBody().getFirstParagraph().getRuns().get(0).remove();
  Assert.assertEquals(doc.getRevisions().get(0).getRevisionType(), RevisionType.DELETION);
  Assert.assertEquals(doc.getRevisions().getCount(), 2);
  
  // Insert revisions are treated as document text by the GetText() method before they are accepted,
  // since they are still nodes with text and are in the body
  Assert.assertEquals(doc.getText().trim(), "This does not count as a revision. This is revision #1.");
  
  // Accepting the deletion revision will assimilate it into the paragraph text and remove it from the collection
  doc.getRevisions().get(0).accept();
  Assert.assertEquals(doc.getRevisions().getCount(), 1);
  
  // Once the delete revision is accepted, the nodes that it concerns are removed and their text will not show up here
  Assert.assertEquals(doc.getText().trim(), "This is revision #1.");
  
  // The second insertion revision is now at index 0, which we can reject to ignore and discard it
  doc.getRevisions().get(0).reject();
  Assert.assertEquals(doc.getRevisions().getCount(), 0);
  Assert.assertEquals(doc.getText().trim(), "");

• getVariables

  public VariableCollection getVariables()
  

  Returns the collection of variables added to a document or template.

• getVbaProject/setVbaProject

  public VbaProject getVbaProject() / public void setVbaProject(VbaProject value)
  

  Gets or sets a VbaProject.

  Example:

  Shows how to get access to VBA project information in the document.

  Document doc = new Document(getMyDir() + "VBA project.docm");
  
  // A VBA project inside the document is defined as a collection of VBA modules
  VbaProject vbaProject = doc.getVbaProject();
  System.out.println(vbaProject.isSigned()
          ? MessageFormat.format("Project name: {0} signed; Project code page: {1}; Modules count: {2}\n", vbaProject.getName(), vbaProject.getCodePage(), vbaProject.getModules().getCount())
          : MessageFormat.format("Project name: {0} not signed; Project code page: {1}; Modules count: {2}\n", vbaProject.getName(), vbaProject.getCodePage(), vbaProject.getModules().getCount()));
  
  VbaModuleCollection vbaModules = doc.getVbaProject().getModules(); 
  
  Assert.assertEquals(vbaModules.getCount(), 3);
  
  for (VbaModule module : vbaModules) {
      System.out.println(MessageFormat.format("Module name: {0};\nModule code:\n{1}\n", module.getName(), module.getSourceCode()));
  }
  
  // Set new source code for VBA module
  // You can retrieve object by integer or by name
  vbaModules.get(0).setSourceCode("Your VBA code...");
  vbaModules.get("Module1").setSourceCode("Your VBA code...");
  
  // Remove one of VbaModule from VbaModuleCollection
  vbaModules.remove(vbaModules.get(2));

• getVersionsCount

  public int getVersionsCount()
  

  Gets the number of document versions that was stored in the DOC document.

  Versions in Microsoft Word are accessed via the File/Versions menu. Microsoft Word supports versions only for DOC files.

  This property allows to detect if there were document versions stored in this document before it was opened in Aspose.Words. Aspose.Words provides no other support for document versions. If you save this document using Aspose.Words, the document will be saved without versions.

  Example:

  Shows how to count how many previous versions a document has.

  // Document versions are not supported but we can open an older document that has them
  Document doc = new Document(getMyDir() + "Versions.doc");
  
  // We can use this property to see how many there are
  // If we save and open the document, they will be lost
  Assert.assertEquals(4, doc.getVersionsCount());

• getViewOptions

  public ViewOptions getViewOptions()
  

  Provides options to control how the document is displayed in Microsoft Word.

  Example:

  Shows how to make sure the document is displayed at 50% zoom when opened in Microsoft Word.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // We can set the zoom factor to a percentage
  doc.getViewOptions().setViewType(ViewType.PAGE_LAYOUT);
  doc.getViewOptions().setZoomPercent(50);
  
  // Or we can set the ZoomType to a different value to avoid using percentages 
  Assert.assertEquals(doc.getViewOptions().getZoomType(), ZoomType.NONE);
  
  doc.save(getArtifactsDir() + "ViewOptions.SetZoom.doc");

• getWarningCallback/setWarningCallback

  public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
  

  Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss.

  Document may generate warnings at any stage of its existence, so it's important to setup warning callback as early as possible to avoid the warnings loss. E.g. such properties as PageCount actually build the document layout which is used later for rendering, and the layout warnings may be lost if warning callback is specified just for the rendering calls later.

  Example:

  Shows how to implement the IWarningCallback to be notified of any font substitution during document save.

  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) {
          // We are only interested in fonts being substituted
          if (info.getWarningType() == WarningType.FONT_SUBSTITUTION) {
              System.out.println("Font substitution: " + info.getDescription());
          }
      }
  
  }

  Example:

  Demonstrates how to receive notifications of font substitutions by using IWarningCallback.

  // Load the document to render
  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Create a new class implementing IWarningCallback and assign it to the PdfSaveOptions class
  HandleDocumentWarnings callback = new HandleDocumentWarnings();
  doc.setWarningCallback(callback);
  
  // We can choose the default font to use in the case of any missing fonts
  FontSettings.getDefaultInstance().getSubstitutionSettings().getDefaultFontSubstitution().setDefaultFontName("Arial");
  
  // For testing we will set Aspose.Words to look for fonts only in a folder which doesn't exist. Since Aspose.Words won't
  // find any fonts in the specified directory, then during rendering the fonts in the document will be substituted with the default 
  // font specified under FontSettings.DefaultFontName. We can pick up on this substitution using our callback
  FontSettings.getDefaultInstance().setFontsFolder("", false);
  
  // Pass the save options along with the save path to the save method
  doc.save(getArtifactsDir() + "Font.SubstitutionNotification.pdf");

• getWatermark

  public Watermark getWatermark()
  

  Provides access to the document watermark.

• getWebExtensionTaskPanes

  public TaskPaneCollection getWebExtensionTaskPanes()
  

  Returns a collection that represents a list of task pane add-ins.

• getWriteProtection

  public WriteProtection getWriteProtection()
  

  Provides access to the document write protection options.

  Example:

  Shows how to protect a document with a password.

  Document doc = new Document();
  
  // Enter a password that's up to 15 characters long
  doc.getWriteProtection().setPassword("MyPassword");
  
  Assert.assertTrue(doc.getWriteProtection().isWriteProtected());
  Assert.assertTrue(doc.getWriteProtection().validatePassword("MyPassword"));
  
  // This flag applies to RTF documents and will be ignored by Microsoft Word
  doc.getWriteProtection().setReadOnlyRecommended(true);
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.writeln("Write protection does not prevent us from editing the document programmatically.");
  
  // Save the document
  // Without the password, we can only read this document in Microsoft Word
  // With the password, we can read and write
  doc.save(getArtifactsDir() + "Document.WriteProtection.docx");

Method Detail

• accept

  public boolean accept(DocumentVisitor visitor)
                throws java.lang.Exception

  Accepts a visitor.

  Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.

  For more info see the Visitor design pattern.

  Calls DocumentVisitor.VisitDocumentStart, then calls Accept for all child nodes of the document and calls DocumentVisitor.VisitDocumentEnd at the end.

  Parameters:

  visitor - The visitor that will visit the nodes.

  Returns:

  True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.

  Example:

  Traverse a document with a visitor that prints all structure nodes that it encounters.

  public void docStructureToText() throws Exception {
      // Open the document that has nodes we want to print the info of
      Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
  
      // Create an object that inherits from the DocumentVisitor class
      DocStructurePrinter visitor = new DocStructurePrinter();
  
      // Accepting a visitor lets it start traversing the nodes in the document,
      // starting with the node that accepted it to then recursively visit every child
      doc.accept(visitor);
  
      // Once the visiting is complete, we can retrieve the result of the operation,
      // that in this example, has accumulated in the visitor
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// This Visitor implementation prints information about sections, bodies, paragraphs and runs encountered in the document.
  /// </summary>
  public static class DocStructurePrinter extends DocumentVisitor {
      public DocStructurePrinter() {
          mBuilder = new StringBuilder();
      }
  
      /// <summary>
      /// Gets the plain text of the document that was accumulated by the visitor.
      /// </summary>
      public String getText() {
          return mBuilder.toString();
      }
  
      /// <summary>
      /// Called when a Document node is encountered.
      /// </summary>
      public int visitDocumentStart(final Document doc) {
          int childNodeCount = doc.getChildNodes(NodeType.ANY, true).getCount();
  
          // A Document node is at the root of every document, so if we let a document accept a visitor, this will be the first visitor action to be carried out
          indentAndAppendLine("[Document start] Child nodes: " + childNodeCount);
          mDocTraversalDepth++;
  
          // Let the visitor continue visiting other nodes
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Document is ended.
      /// </summary>
      public int visitDocumentEnd(final Document doc) {
          // If we let a document accept a visitor, this will be the last visitor action to be carried out
          mDocTraversalDepth--;
          indentAndAppendLine("[Document end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Section node is encountered in the document.
      /// </summary>
      public int visitSectionStart(final Section section) {
          // Get the index of our section within the document
          NodeCollection docSections = section.getDocument().getChildNodes(NodeType.SECTION, false);
          int sectionIndex = docSections.indexOf(section);
  
          indentAndAppendLine("[Section start] Section index: " + sectionIndex);
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Section node is ended.
      /// </summary>
      public int visitSectionEnd(final Section section) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Section end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Body node is encountered in the document.
      /// </summary>
      public int visitBodyStart(final Body body) {
          int paragraphCount = body.getParagraphs().getCount();
          indentAndAppendLine("[Body start] Paragraphs: " + paragraphCount);
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Body node is ended.
      /// </summary>
      public int visitBodyEnd(final Body body) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Body end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Paragraph node is encountered in the document.
      /// </summary>
      public int visitParagraphStart(final Paragraph paragraph) {
          indentAndAppendLine("[Paragraph start]");
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when the visiting of a Paragraph node is ended.
      /// </summary>
      public int visitParagraphEnd(final Paragraph paragraph) {
          mDocTraversalDepth--;
          indentAndAppendLine("[Paragraph end]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a Run node is encountered in the document.
      /// </summary>
      public int visitRun(final Run run) {
          indentAndAppendLine("[Run] \"" + run.getText() + "\"");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a SubDocument node is encountered in the document.
      /// </summary>
      public int visitSubDocument(final SubDocument subDocument) {
          indentAndAppendLine("[SubDocument]");
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Append a line to the StringBuilder and indent it depending on how deep the visitor is into the document tree.
      /// </summary>
      /// <param name="text"></param>
      private void indentAndAppendLine(final String text) {
          for (int i = 0; i < mDocTraversalDepth; i++) {
              mBuilder.append("|  ");
          }
  
          mBuilder.append(text + "\r\n");
      }
  
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• acceptAllRevisions

  public void acceptAllRevisions()
                         throws java.lang.Exception

  Accepts all tracked changes in the document.

  This method is a shortcut for RevisionCollection.acceptAll().

  Example:

  Shows how to accept all tracking changes in the document.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Start tracking and make some revisions
  doc.startTrackRevisions("Author");
  doc.getFirstSection().getBody().appendParagraph("Hello world!");
  
  // Revisions will now show up as normal text in the output document
  doc.acceptAllRevisions();
  doc.save(getArtifactsDir() + "Document.AcceptAllRevisions.docx");

• appendChild

  public Node appendChild(Node newChild)

  Adds the specified node to the end of the list of child nodes for this node.

  If the newChild is already in the tree, it is first removed.

  If the node being inserted was created from another document, you should use importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

  Parameters:

  newChild - The node to add.

  Returns:

  The node added.

  Example:

  Creates a simple document from scratch using the Aspose.Words object model.

  // Create an "empty" document. Note that like in Microsoft Word, 
  // the empty document has one section, body and one paragraph in it
  Document doc = new Document();
  
  // This truly makes the document empty. No sections (not possible in Microsoft Word)
  doc.removeAllChildren();
  
  // Create a new section node
  // Note that the section has not yet been added to the document, 
  // but we have to specify the parent document
  Section section = new Section(doc);
  
  // Append the section to the document
  doc.appendChild(section);
  
  // Lets set some properties for the section
  section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
  section.getPageSetup().setPaperSize(PaperSize.LETTER);
  
  // The section that we created is empty, lets populate it. The section needs at least the Body node
  Body body = new Body(doc);
  section.appendChild(body);
  
  // The body needs to have at least one paragraph
  // Note that the paragraph has not yet been added to the document, 
  // but we have to specify the parent document
  // The parent document is needed so the paragraph can correctly work
  // with styles and other document-wide information
  Paragraph para = new Paragraph(doc);
  body.appendChild(para);
  
  // We can set some formatting for the paragraph
  para.getParagraphFormat().setStyleName("Heading 1");
  para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
  
  // So far we have one empty paragraph in the document
  // The document is valid and can be saved, but lets add some text before saving
  // Create a new run of text and add it to our paragraph
  Run run = new Run(doc);
  run.setText("Hello World!");
  run.getFont().setColor(Color.RED);
  para.appendChild(run);
  
  // As a matter of interest, you can retrieve text of the whole document and
  // see that \x000c is automatically appended. \x000c is the end of section character
  System.out.println(doc.getText());
  
  // Save the document
  doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");

• appendDocument

  public void appendDocument(Document srcDoc, int importFormatMode)

  Appends the specified document to the end of this document.

  Parameters:

  srcDoc - The document to append.

  importFormatMode - A ImportFormatMode value. Specifies how to merge style formatting that clashes.

  Example:

  Shows how to use the AppendDocument method to combine all the documents in a folder to the end of a template document.

  // Lets start with a simple template and append all the documents in a folder to this document
  Document baseDoc = new Document();
  
  // Add some content to the template
  DocumentBuilder builder = new DocumentBuilder(baseDoc);
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
  builder.writeln("Template Document");
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.NORMAL);
  builder.writeln("Some content here");
  
  // Gather the files which will be appended to our template document
  // In this case we add the optional parameter to include the search only for files with the ".doc" extension
  File srcDir = new File(getMyDir());
  FilenameFilter filter = (dir, name) -> name.endsWith(".doc");
  File[] files = srcDir.listFiles(filter);
  
  // The list of files may come in any order, let's sort the files by name so the documents are enumerated alphabetically
  Arrays.sort(files);
  
  // Iterate through every file in the directory and append each one to the end of the template document
  for (File file : files) {
      String fileName = file.getCanonicalPath();
  
      // We have some encrypted test documents in our directory, Aspose.Words can open encrypted documents
      // but only with the correct password. Let's just skip them here for simplicity
      FileFormatInfo info = FileFormatUtil.detectFileFormat(fileName);
      if (info.isEncrypted()) continue;
  
      Document subDoc = new Document(fileName);
      baseDoc.appendDocument(subDoc, ImportFormatMode.USE_DESTINATION_STYLES);
  }
  
  // Save the combined document to disk
  baseDoc.save(path);

  Example:

  Shows how to append a document to the end of another document.

  // The document that the content will be appended to
  Document dstDoc = new Document();
  dstDoc.getFirstSection().getBody().appendParagraph("Destination document text. ");
  
  // The document to append
  Document srcDoc = new Document();
  srcDoc.getFirstSection().getBody().appendParagraph("Source document text. ");
  
  // Append the source document to the destination document
  // Pass format mode to retain the original formatting of the source document when importing it
  dstDoc.appendDocument(srcDoc, ImportFormatMode.KEEP_SOURCE_FORMATTING);
  
  // Save the document
  dstDoc.save(getArtifactsDir() + "Document.AppendDocument.docx");

• appendDocument

  public void appendDocument(Document srcDoc, int importFormatMode, ImportFormatOptions importFormatOptions)

  Appends the specified document to the end of this document.

  Parameters:

  srcDoc - The document to append.

  importFormatMode - A ImportFormatMode value. Specifies how to merge style formatting that clashes.

  importFormatOptions - Allows to specify options that affect formatting of a result document.

  Example:

  Shows how to resolve styles behavior while append document.

  // Open a document with text in a custom style and clone it
  Document srcDoc = new Document(getMyDir() + "Custom list numbering.docx");
  Document dstDoc = srcDoc.deepClone();
  
  // We now have two documents, each with an identical style named "CustomStyle" 
  // We can change the text color of one of the styles
  dstDoc.getStyles().get("CustomStyle").getFont().setColor(Color.red);
  
  ImportFormatOptions options = new ImportFormatOptions();
  // Specify that if numbering clashes in source and destination documents
  // then a numbering from the source document will be used
  options.setKeepSourceNumbering(true);
  
  // If we join two documents which have different styles that share the same name,
  // we can resolve the style clash with an ImportFormatMode
  dstDoc.appendDocument(srcDoc, ImportFormatMode.KEEP_DIFFERENT_STYLES, options);
  dstDoc.updateListLabels();
  
  dstDoc.save(getArtifactsDir() + "DocumentBuilder.ResolveStyleBehaviorWhileAppendDocument.docx");

• cleanup

  public void cleanup()
              throws java.lang.Exception

  Cleans unused styles and lists from the document.

  Example:

  Shows how to remove unused styles and lists from a document.

  // Create a new document
  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add two styles and apply them to the builder's formats, marking them as "used" 
  builder.getParagraphFormat().setStyle(doc.getStyles().add(StyleType.PARAGRAPH, "My Used Style"));
  builder.getListFormat().setList(doc.getLists().add(ListTemplate.BULLET_DIAMONDS));
  
  // And two more styles and leave them unused by not applying them to anything
  doc.getStyles().add(StyleType.PARAGRAPH, "My Unused Style");
  doc.getLists().add(ListTemplate.NUMBER_ARABIC_DOT);
  
  doc.cleanup();
  
  // The used styles are still in the document
  Assert.assertNotNull(doc.getStyles().get("My Used Style"));
  
  // The unused styles have been removed
  Assert.assertNull(doc.getStyles().get("My Unused Style"));

• cleanup

  public void cleanup(CleanupOptions options)
              throws java.lang.Exception

  Cleans unused styles and lists from the document depending on given CleanupOptions.

  Example:

  Shows how to remove all unused styles and lists from a document.

  Document doc = new Document();
  
  // Insert some styles into a blank document
  doc.getStyles().add(StyleType.LIST, "MyListStyle1");
  doc.getStyles().add(StyleType.LIST, "MyListStyle2");
  doc.getStyles().add(StyleType.CHARACTER, "MyParagraphStyle1");
  doc.getStyles().add(StyleType.CHARACTER, "MyParagraphStyle2");
  
  // Combined with the built in styles, the document now has 8 styles in total,
  // but all 4 of the ones we added count as unused
  Assert.assertEquals(8, doc.getStyles().getCount());
  
  // A character style counts as used when the document contains text in that style
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.getFont().setStyle(doc.getStyles().get("MyParagraphStyle1"));
  builder.writeln("Hello world!");
  
  // A list style is also "used" when there is a list that uses it
  List list = doc.getLists().add(doc.getStyles().get("MyListStyle1"));
  builder.getListFormat().setList(list);
  builder.writeln("Item 1");
  builder.writeln("Item 2");
  
  // The Cleanup() method, when configured with a CleanupOptions object, can target unused styles and remove them
  CleanupOptions cleanupOptions = new CleanupOptions();
  cleanupOptions.setUnusedLists(true);
  cleanupOptions.setUnusedStyles(true);
  
  // We've added 4 styles and used 2 of them, so the other two will be removed when this method is called
  doc.cleanup(cleanupOptions);
  Assert.assertEquals(6, doc.getStyles().getCount());

• compare

  public void compare(Document document, java.lang.String author, java.util.Date dateTime)
              throws java.lang.Exception

  Compares this document with another document producing changes as number of edit and format revisions Revision.

  The following document nodes are not compared at the moment:

  • StructuredDocumentTag
  • Item3

  Note: Documents must not have revisions before comparison.

  Parameters:

  document - Document to compare.

  author - Initials of the author to use for revisions.

  dateTime - The date and time to use for revisions.

  Example:

  Shows how to apply the compare method to two documents and then use the results.

  Document doc1 = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc1);
  builder.writeln("This is the original document.");
  
  Document doc2 = new Document();
  builder = new DocumentBuilder(doc2);
  builder.writeln("This is the edited document.");
  
  // If either document has a revision, an exception will be thrown
  if (doc1.getRevisions().getCount() == 0 && doc2.getRevisions().getCount() == 0) {
      doc1.compare(doc2, "authorName", new Date());
  }
  
  // If doc1 and doc2 are different, doc1 now has some revisions after the comparison, which can now be viewed and processed
  for (Revision r : doc1.getRevisions())
  {
      System.out.println("Revision type: {r.RevisionType}, on a node of type \"{r.ParentNode.NodeType}\"");
      System.out.println("\tChanged text: \"{r.ParentNode.GetText()}\"");
  }
  
  // All the revisions in doc1 are differences between doc1 and doc2, so accepting them on doc1 transforms doc1 into doc2
  doc1.getRevisions().acceptAll();
  
  // doc1, when saved, now resembles doc2
  doc1.save(getArtifactsDir() + "Document.Compare.docx");

• compare

  public void compare(Document document, java.lang.String author, java.util.Date dateTime, CompareOptions options)
              throws java.lang.Exception

  Compares this document with another document producing changes as a number of edit and format revisions Revision. Allows to specify comparison options using CompareOptions.

  Example:

  Shows how to specify which document shall be used as a target during comparison.

  // Create our original document
  Document docOriginal = new Document();
  DocumentBuilder builder = new DocumentBuilder(docOriginal);
  
  // Insert paragraph text with an endnote
  builder.writeln("Hello world! This is the first paragraph.");
  builder.insertFootnote(FootnoteType.ENDNOTE, "Original endnote text.");
  
  // Insert a table
  builder.startTable();
  builder.insertCell();
  builder.write("Original cell 1 text");
  builder.insertCell();
  builder.write("Original cell 2 text");
  builder.endTable();
  
  // Insert a textbox
  Shape textBox = builder.insertShape(ShapeType.TEXT_BOX, 150.0, 20.0);
  builder.moveTo(textBox.getFirstParagraph());
  builder.write("Original textbox contents");
  
  // Insert a DATE field
  builder.moveTo(docOriginal.getFirstSection().getBody().appendParagraph(""));
  builder.insertField(" DATE ");
  
  // Insert a comment
  Comment newComment = new Comment(docOriginal, "John Doe", "J.D.", new Date());
  newComment.setText("Original comment.");
  builder.getCurrentParagraph().appendChild(newComment);
  
  // Insert a header
  builder.moveToHeaderFooter(HeaderFooterType.HEADER_PRIMARY);
  builder.writeln("Original header contents.");
  
  // Create a clone of our document, which we will edit and later compare to the original
  Document docEdited = (Document) docOriginal.deepClone(true);
  Paragraph firstParagraph = docEdited.getFirstSection().getBody().getFirstParagraph();
  
  // Change the formatting of the first paragraph, change casing of original characters and add text
  firstParagraph.getRuns().get(0).setText("hello world! this is the first paragraph, after editing.");
  firstParagraph.getParagraphFormat().setStyle(docEdited.getStyles().getByStyleIdentifier(StyleIdentifier.HEADING_1));
  
  // Edit the footnote
  Footnote footnote = (Footnote) docEdited.getChild(NodeType.FOOTNOTE, 0, true);
  footnote.getFirstParagraph().getRuns().get(1).setText("Edited endnote text.");
  
  // Edit the table
  Table table = (Table) docEdited.getChild(NodeType.TABLE, 0, true);
  table.getFirstRow().getCells().get(1).getFirstParagraph().getRuns().get(0).setText("Edited Cell 2 contents");
  
  // Edit the textbox
  textBox = (Shape) docEdited.getChild(NodeType.SHAPE, 0, true);
  textBox.getFirstParagraph().getRuns().get(0).setText("Edited textbox contents");
  
  // Edit the DATE field
  FieldDate fieldDate = (FieldDate) docEdited.getRange().getFields().get(0);
  fieldDate.setUseLunarCalendar(true);
  
  // Edit the comment
  Comment comment = (Comment) docEdited.getChild(NodeType.COMMENT, 0, true);
  comment.getFirstParagraph().getRuns().get(0).setText("Edited comment.");
  
  // Edit the header
  docEdited.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_PRIMARY).getFirstParagraph().getRuns().get(0).setText("Edited header contents.");
  
  // When we compare documents, the differences of the latter document from the former show up as revisions to the former
  // Each edit that we've made above will have its own revision, after we run the Compare method
  // We can compare with a CompareOptions object, which can suppress changes done to certain types of objects within the original document
  // from registering as revisions after the comparison by setting some of these members to "true"
  CompareOptions compareOptions = new CompareOptions();
  compareOptions.setIgnoreFormatting(false);
  compareOptions.setIgnoreCaseChanges(false);
  compareOptions.setIgnoreComments(false);
  compareOptions.setIgnoreTables(false);
  compareOptions.setIgnoreFields(false);
  compareOptions.setIgnoreFootnotes(false);
  compareOptions.setIgnoreTextboxes(false);
  compareOptions.setIgnoreHeadersAndFooters(false);
  compareOptions.setTarget(ComparisonTargetType.NEW);
  
  docOriginal.compare(docEdited, "John Doe", new Date(), compareOptions);
  docOriginal.save(getArtifactsDir() + "Document.CompareOptions.docx");

• copyStylesFromTemplate

  public void copyStylesFromTemplate(Document template)

  Copies styles from the specified template to a document.

  When styles are copied from a template to a document, like-named styles in the document are redefined to match the style descriptions in the template. Unique styles from the template are copied to the document. Unique styles in the document remain intact.

  Example:

  Shows how to copies styles from the template to a document via Document.

  Document template = new Document(getMyDir() + "Rendering.docx");
  Document target = new Document(getMyDir() + "Document.docx");
  
  target.copyStylesFromTemplate(template);

• copyStylesFromTemplate

  public void copyStylesFromTemplate(java.lang.String template)
                             throws java.lang.Exception

  Copies styles from the specified template to a document.

  When styles are copied from a template to a document, like-named styles in the document are redefined to match the style descriptions in the template. Unique styles from the template are copied to the document. Unique styles in the document remain intact.

  Example:

  Shows how to copies styles from the template to a document via string.

  Document target = new Document(getMyDir() + "Document.docx");
  
  target.copyStylesFromTemplate(getMyDir() + "Rendering.docx");

• deepClone

  public Document deepClone()

  Performs a deep copy of the Document.

  Returns:

  The cloned document.

  Example:

  Shows how to deep clone a document.

  Document doc = new Document(getMyDir() + "Document.docx");
  Document clone = doc.deepClone();
  
  Assert.assertNotEquals(doc, clone);

• deepClone

  public Node deepClone(boolean isCloneChildren)

  Example:

  Shows how to clone composite nodes with and without their child nodes.

  // Create a new empty document
  Document doc = new Document();
  
  // Add some text to the first paragraph
  Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
  para.appendChild(new Run(doc, "Some text"));
  
  // Clone the paragraph and the child nodes
  Node cloneWithChildren = para.deepClone(true);
  // Only clone the paragraph and no child nodes
  Node cloneWithoutChildren = para.deepClone(false);

• ensureMinimum

  public void ensureMinimum()

  If the document contains no sections, creates one section with one paragraph.

  Example:

  Shows how to ensure the Document is valid (has the minimum nodes required to be valid).

  Document doc = new Document();
  
  // Every blank document that we create will contain
  // the minimal set nodes requited for editing; a Section, Body and Paragraph
  Assert.assertEquals(3, doc.getChildNodes(NodeType.ANY, true).getCount());
  
  // We can remove every node from the document with RemoveAllChildren()
  doc.removeAllChildren();
  Assert.assertEquals(0, doc.getChildNodes(NodeType.ANY, true).getCount());
  
  // EnsureMinimum() can ensure that the document has at least those three nodes
  doc.ensureMinimum();
  Assert.assertEquals(3, doc.getChildNodes(NodeType.ANY, true).getCount());

• expandTableStylesToDirectFormatting

  public void expandTableStylesToDirectFormatting()
                                          throws java.lang.Exception

  Converts formatting specified in table styles into direct formatting on tables in the document.

  This method exists because this version of Aspose.Words provides only limited support for table styles (see below). This method might be useful when you load a DOCX or WordprocessingML document that contains tables formatted with table styles and you need to query formatting of tables, cells, paragraphs or text.

  This version of Aspose.Words provides limited support for table styles as follows:

  • Table styles defined in DOCX or WordprocessingML documents are preserved as table styles when saving the document as DOCX or WordprocessingML.
  • Table styles defined in DOCX or WordprocessingML documents are automatically converted to direct formatting on tables when saving the document into any other format, rendering or printing.
  • Table styles defined in DOC documents are preserved as table styles when saving the document as DOC only.

  Example:

  Shows how to expand the formatting from styles onto the rows and cells of the table as direct formatting.

  Document doc = new Document(getMyDir() + "Tables.docx");
  
  Table table = (Table) doc.getChild(NodeType.TABLE, 0, true);
  // First print the color of the cell shading. This should be empty as the current shading
  // is stored in the table style
  double cellShadingBefore = table.getFirstRow().getRowFormat().getHeight();
  System.out.println("Cell shading before style expansion: " + cellShadingBefore);
  
  // Expand table style formatting to direct formatting
  doc.expandTableStylesToDirectFormatting();
  
  // Now print the cell shading after expanding table styles. A blue background pattern color
  // should have been applied from the table style
  double cellShadingAfter = table.getFirstRow().getRowFormat().getHeight();
  System.out.println("Cell shading after style expansion: " + cellShadingAfter);
  
  doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");

• getAncestor

  public CompositeNode getAncestor(int ancestorType)

  Gets the first ancestor of the specified NodeType.

  Parameters:

  ancestorType - A NodeType value. The node type of the ancestor to retrieve.

  Returns:

  The ancestor of the specified type or null if no ancestor of this type was found.

  Example:

  Shows how to find out if a table contains another table or if the table itself is nested inside another table.

  public void calculateDepthOfNestedTables() throws Exception {
      Document doc = new Document(getMyDir() + "Nested tables.docx");
      int tableIndex = 0;
  
      for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) {
          // First lets find if any cells in the table have tables themselves as children
          int count = getChildTableCount(table);
          System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count));
  
          // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth
          int tableDepth = getNestedDepthOfTable(table);
  
          if (tableDepth > 0) {
              System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth));
          } else {
              System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex));
          }
  
          tableIndex++;
      }
  }
  
  /**
   * Calculates what level a table is nested inside other tables.
   *
   * @returns An integer containing the level the table is nested at.
   * 0 = Table is not nested inside any other table
   * 1 = Table is nested within one parent table
   * 2 = Table is nested within two parent tables etc..
   */
  private static int getNestedDepthOfTable(final Table table) {
      int depth = 0;
  
      int type = table.getNodeType();
      // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table
      Node parent = table.getAncestor(table.getNodeType());
  
      while (parent != null) {
          // Every time we find a table a level up we increase the depth counter and then try to find an
          // ancestor of type table from the parent
          depth++;
          parent = parent.getAncestor(Table.class);
      }
  
      return depth;
  }
  
  /**
   * Determines if a table contains any immediate child table within its cells.
   * Does not recursively traverse through those tables to check for further tables.
   *
   * @returns Returns true if at least one child cell contains a table.
   * Returns false if no cells in the table contains a table.
   */
  private static int getChildTableCount(final Table table) {
      int tableCount = 0;
      // Iterate through all child rows in the table
      for (Row row : table.getRows()) {
          // Iterate through all child cells in the row
          for (Cell cell : row.getCells()) {
              // Retrieve the collection of child tables of this cell
              TableCollection childTables = cell.getTables();
  
              // If this cell has a table as a child then return true
              if (childTables.getCount() > 0) tableCount++;
          }
      }
  
      // No cell contains a table
      return tableCount;
  }

• getAncestor

  public CompositeNode getAncestor(java.lang.Class ancestorType)

  Gets the first ancestor of the specified object type.

  The ancestor type matches if it is equal to ancestorType or derived from ancestorType.

  Parameters:

  ancestorType - The object type of the ancestor to retrieve.

  Returns:

  The ancestor of the specified type or null if no ancestor of this type was found.

  Example:

  Shows how to find out if a table contains another table or if the table itself is nested inside another table.

  public void calculateDepthOfNestedTables() throws Exception {
      Document doc = new Document(getMyDir() + "Nested tables.docx");
      int tableIndex = 0;
  
      for (Table table : (Iterable<Table>) doc.getChildNodes(NodeType.TABLE, true)) {
          // First lets find if any cells in the table have tables themselves as children
          int count = getChildTableCount(table);
          System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", tableIndex, count));
  
          // Now let's try the other way around, lets try find if the table is nested inside another table and at what depth
          int tableDepth = getNestedDepthOfTable(table);
  
          if (tableDepth > 0) {
              System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", tableIndex, tableDepth));
          } else {
              System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", tableIndex));
          }
  
          tableIndex++;
      }
  }
  
  /**
   * Calculates what level a table is nested inside other tables.
   *
   * @returns An integer containing the level the table is nested at.
   * 0 = Table is not nested inside any other table
   * 1 = Table is nested within one parent table
   * 2 = Table is nested within two parent tables etc..
   */
  private static int getNestedDepthOfTable(final Table table) {
      int depth = 0;
  
      int type = table.getNodeType();
      // The parent of the table will be a Cell, instead attempt to find a grandparent that is of type Table
      Node parent = table.getAncestor(table.getNodeType());
  
      while (parent != null) {
          // Every time we find a table a level up we increase the depth counter and then try to find an
          // ancestor of type table from the parent
          depth++;
          parent = parent.getAncestor(Table.class);
      }
  
      return depth;
  }
  
  /**
   * Determines if a table contains any immediate child table within its cells.
   * Does not recursively traverse through those tables to check for further tables.
   *
   * @returns Returns true if at least one child cell contains a table.
   * Returns false if no cells in the table contains a table.
   */
  private static int getChildTableCount(final Table table) {
      int tableCount = 0;
      // Iterate through all child rows in the table
      for (Row row : table.getRows()) {
          // Iterate through all child cells in the row
          for (Cell cell : row.getCells()) {
              // Retrieve the collection of child tables of this cell
              TableCollection childTables = cell.getTables();
  
              // If this cell has a table as a child then return true
              if (childTables.getCount() > 0) tableCount++;
          }
      }
  
      // No cell contains a table
      return tableCount;
  }

• getChild

  public Node getChild(int nodeType, int index, boolean isDeep)

  Returns an Nth child node that matches the specified type.

  If index is out of range, a null is returned.

  Note that markup nodes (NodeType.STRUCTURED_DOCUMENT_TAG and NodeType.SMART_TAG) are traversed even when isDeep = false and GetChild is invoked for non-markup node type. For example if the first run in a para is wrapped in a StructuredDocumentTag, it will still be returned by GetChild(NodeType.Run, 0, false).

  Parameters:

  nodeType - A NodeType value. Specifies the type of the child node.

  index - Zero based index of the child node to select. Negative indexes are also allowed and indicate access from the end, that is -1 means the last node.

  isDeep - True to select from all child nodes recursively. False to select only among immediate children. See remarks for more info.

  Returns:

  The child node that matches the criteria or null if no matching node is found.

  Example:

  Shows how to test if a node is inside a field by using an XPath expression.

  // Let's pick a document we know has some fields in
  Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx");
  
  // Let's say we want to check if the Run below is inside a field
  Run run = (Run) doc.getChild(NodeType.RUN, 5, true);
  
  // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart 
  // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields 
  // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs
  NodeList resultList =
          doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]");
  
  // Check if the specified run is one of the nodes that are inside the field
  for (Node node : (Iterable<Node>) resultList) {
      if (node == run) {
          System.out.println("The node is found inside a field");
          break;
      }
  }

  Example:

  Shows how to extract a specific child node from a CompositeNode by using the GetChild method and passing the NodeType and index.

  Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);

• getChildNodes

  public NodeCollection getChildNodes(int nodeType, boolean isDeep)

  Returns a live collection of child nodes that match the specified type.

  The collection of nodes returned by this method is always live.

  A live collection is always in sync with the document. For example, if you selected all sections in a document and enumerate through the collection deleting the sections, the section is removed from the collection immediately when it is removed from the document.

  Parameters:

  nodeType - A NodeType value. Specifies the type of nodes to select.

  isDeep - True to select from all child nodes recursively. False to select only among immediate children.

  Returns:

  A live collection of child nodes of the specified type.

  Example:

  Shows how to get all comments with all replies.

  Document doc = new Document(getMyDir() + "Comments.docx");
  
  // Get all comment from the document
  NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
  // For all comments and replies we identify comment level and info about it
  for (Comment comment : (Iterable<Comment>) comments) {
      if (comment.getAncestor() == null) {
          System.out.println("\nThis is a top-level comment");
          System.out.println("Comment author: " + comment.getAuthor());
          System.out.println("Comment text: " + comment.getText());
  
          for (Comment commentReply : comment.getReplies())
          {
              System.out.println("\n\tThis is a comment reply");
              System.out.println("\tReply author: " + commentReply.getAuthor());
              System.out.println("\tReply text: " + commentReply.getText());
          }
      }
  }

  Example:

  Shows how to extract images from a document and save them as files.

  public void extractImagesToFiles() throws Exception {
      Document doc = new Document(getMyDir() + "Images.docx");
  
      NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
      int imageIndex = 0;
      for (Shape shape : (Iterable<Shape>) shapes) {
          if (shape.hasImage()) {
              String imageFileName = MessageFormat.format("File.ExtractImagesToFiles.{0}{1}", imageIndex,
                      FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
              shape.getImageData().save(getArtifactsDir() + imageFileName);
              imageIndex++;
          }
      }
  }

  Example:

  Demonstrates how to remove a specified TOC from a document.

  // Open a document which contains a TOC
  Document doc = new Document(getMyDir() + "Table of contents.docx");
  
  // Remove the first TOC from the document
  Field tocField = doc.getRange().getFields().get(0);
  tocField.remove();
  
  // Save the output
  doc.save(getArtifactsDir() + "Field.RemoveTocFromDocument.docx");

• getPageInfo

  public PageInfo getPageInfo(int pageIndex)
                      throws java.lang.Exception

  Gets the page size, orientation and other information about a page that might be useful for printing or rendering.

  Parameters:

  pageIndex - The 0-based page index.

• getText

  public java.lang.String getText()

  Gets the text of this node and of all its children.

  The returned string includes all control and special characters as described in ControlChar.

  Example:

  Shows the difference between calling the GetText and ToString methods on a node.

  Document doc = new Document();
  
  // Enter a field into the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertField("MERGEFIELD Field");
  
  // GetText will retrieve all field codes and special characters
  Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
  
  // ToString will give us the plaintext version of the document in the save format we put into the parameter
  Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));

  Example:

  Finds and outputs all paragraphs in a document that are bulleted or numbered.

  NodeCollection paras = doc.getChildNodes(NodeType.PARAGRAPH, true);
  for (Paragraph para : (Iterable<Paragraph>) paras) {
      if (para.getListFormat().isListItem()) {
          System.out.println(java.text.MessageFormat.format("*** A paragraph belongs to list {0}", para.getListFormat().getList().getListId()));
          System.out.println(para.getText());
      }
  }

• importNode

  public Node importNode(Node srcNode, boolean isImportChildren)

  Imports a node from another document to the current document.

  This method uses the ImportFormatMode.USE_DESTINATION_STYLES option to resolve formatting.

  Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.

  Before a node from another document can be inserted into this document, it must be imported. During import, document-specific properties such as references to styles and lists are translated from the original to the importing document. After the node was imported, it can be inserted into the appropriate place in the document using insertBefore(com.aspose.words.Node,com.aspose.words.Node) or insertAfter(com.aspose.words.Node,com.aspose.words.Node).

  If the source node already belongs to the destination document, then simply a deep clone of the source node is created.

  Parameters:

  srcNode - The node being imported.

  isImportChildren - True to import all child nodes recursively; otherwise, false.

  Returns:

  The cloned node that belongs to the current document.

  See Also:

  NodeImporter

  Example:

  Shows how to import node from source document to destination document.

  Document src = new Document();
  Document dst = new Document();
  
  // Add text to both documents
  src.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(src, "Source document first paragraph text."));
  dst.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(dst, "Destination document first paragraph text."));
  
  // In order for a child node to be successfully appended to another node in a document,
  // both nodes must have the same parent document, or an exception is thrown
  Assert.assertNotEquals(dst, src.getFirstSection().getDocument());
  Assert.assertThrows(IllegalArgumentException.class, () -> dst.appendChild(src.getFirstSection()));
  
  // For that reason, we can't just append a section of the source document to the destination document using Node.AppendChild()
  // Document.ImportNode() lets us get around this by creating a clone of a node and sets its parent to the calling document
  Section importedSection = (Section)dst.importNode(src.getFirstSection(), true);
  
  // Now it is ready to be placed in the document
  dst.appendChild(importedSection);
  
  // Our document now contains both the original and imported section
  Assert.assertEquals("Destination document first paragraph text.\r\nSource document first paragraph text.\r\n",
          dst.toString(SaveFormat.TEXT));

• importNode

  public Node importNode(Node srcNode, boolean isImportChildren, int importFormatMode)

  Imports a node from another document to the current document with an option to control formatting.

  This overload is useful to control how styles and list formatting are imported.

  Importing a node creates a copy of the source node belonging to the importing document. The returned node has no parent. The source node is not altered or removed from the original document.

  Before a node from another document can be inserted into this document, it must be imported. During import, document-specific properties such as references to styles and lists are translated from the original to the importing document. After the node was imported, it can be inserted into the appropriate place in the document using insertBefore(com.aspose.words.Node,com.aspose.words.Node) or insertAfter(com.aspose.words.Node,com.aspose.words.Node).

  If the source node already belongs to the destination document, then simply a deep clone of the source node is created.

  Parameters:

  srcNode - The node to imported.

  isImportChildren - True to import all child nodes recursively; otherwise, false.

  importFormatMode - A ImportFormatMode value. Specifies how to merge style formatting that clashes.

  Returns:

  The cloned, imported node. The node belongs to the destination document, but has no parent.

  See Also:

  ImportFormatMode, NodeImporter

  Example:

  Shows how to import node from source document to destination document with specific options.

  // Create two documents with two styles that differ in font but have the same name
  Document src = new Document();
  Style srcStyle = src.getStyles().add(StyleType.CHARACTER, "My style");
  srcStyle.getFont().setName("Courier New");
  DocumentBuilder srcBuilder = new DocumentBuilder(src);
  srcBuilder.getFont().setStyle(srcStyle);
  srcBuilder.writeln("Source document text.");
  
  Document dst = new Document();
  Style dstStyle = dst.getStyles().add(StyleType.CHARACTER, "My style");
  dstStyle.getFont().setName("Calibri");
  DocumentBuilder dstBuilder = new DocumentBuilder(dst);
  dstBuilder.getFont().setStyle(dstStyle);
  dstBuilder.writeln("Destination document text.");
  
  // Import the Section from the destination document into the source document, causing a style name collision
  // If we use destination styles then the imported source text with the same style name as destination text
  // will adopt the destination style 
  Section importedSection = (Section)dst.importNode(src.getFirstSection(), true, ImportFormatMode.USE_DESTINATION_STYLES);
  Assert.assertEquals(dstStyle.getFont().getName(), importedSection.getBody().getFirstParagraph().getRuns().get(0).getFont().getName());
  Assert.assertEquals(dstStyle.getName(), importedSection.getBody().getFirstParagraph().getRuns().get(0).getFont().getStyleName());
  
  // If we use ImportFormatMode.KeepDifferentStyles,
  // the source style is preserved and the naming clash is resolved by adding a suffix 
  dst.importNode(src.getFirstSection(), true, ImportFormatMode.KEEP_DIFFERENT_STYLES);
  Assert.assertEquals(dstStyle.getFont().getName(), dst.getStyles().get("My style").getFont().getName());
  Assert.assertEquals(srcStyle.getFont().getName(), dst.getStyles().get("My style_0").getFont().getName());

• indexOf

  public int indexOf(Node child)

  Returns the index of the specified child node in the child node array.

  Returns -1 if the node is not found in the child nodes.

  Example:

  Shows how to get the index of a given child node from its parent.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Get the body of the first section in the document
  Body body = doc.getFirstSection().getBody();
  // Retrieve the index of the last paragraph in the body
  int index = body.getChildNodes().indexOf(body.getLastParagraph());

• insertAfter

  public Node insertAfter(Node newChild, Node refChild)

  Inserts the specified node immediately after the specified reference node.

  If refChild is null, inserts newChild at the beginning of the list of child nodes.

  If the newChild is already in the tree, it is first removed.

  If the node being inserted was created from another document, you should use importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

  Parameters:

  newChild - The Node to insert.

  refChild - The Node that is the reference node. The newNode is placed after the refNode.

  Returns:

  The inserted node.

  Example:

  Shows how to add, update and delete child nodes from within a CompositeNode.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1);
  
  // A paragraph is a composite node because it can contain runs, which are another type of node
  Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
  Run paragraphText = new Run(doc, "Initial text. ");
  paragraph.appendChild(paragraphText);
  
  // We will place these 3 children into the main text of our paragraph
  Run run1 = new Run(doc, "Run 1. ");
  Run run2 = new Run(doc, "Run 2. ");
  Run run3 = new Run(doc, "Run 3. ");
  
  // We initialized them but not in our paragraph yet
  Assert.assertEquals(paragraph.getText(), "Initial text. " + (char) 12);
  
  // Insert run2 before initial paragraph text. This will be at the start of the paragraph
  paragraph.insertBefore(run2, paragraphText);
  
  // Insert run3 after initial paragraph text. This will be at the end of the paragraph
  paragraph.insertAfter(run3, paragraphText);
  
  // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1
  paragraph.prependChild(run1);
  
  Assert.assertEquals(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4);
  
  // Access the child node collection and update/delete children
  ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
  paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
  
  Assert.assertEquals(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);

  Example:

  Shows how to replace all textboxes with images.

  Document doc = new Document(getMyDir() + "Textboxes in drawing canvas.docx");
  
  // This gets a live collection of all shape nodes in the document
  NodeCollection shapeCollection = doc.getChildNodes(NodeType.SHAPE, true);
  
  // Since we will be adding/removing nodes, it is better to copy all collection
  // into a fixed size array, otherwise iterator will be invalidated
  Node[] shapes = shapeCollection.toArray();
  
  for (Node node : shapes) {
      Shape shape = (Shape) node;
      // Filter out all shapes that we don't need
      if (shape.getShapeType() == ShapeType.TEXT_BOX) {
          // Create a new shape that will replace the existing shape
          Shape image = new Shape(doc, ShapeType.IMAGE);
  
          // Load the image into the new shape
          image.getImageData().setImage(getImageDir() + "Windows MetaFile.wmf");
  
          // Make new shape's position to match the old shape
          image.setLeft(shape.getLeft());
          image.setTop(shape.getTop());
          image.setWidth(shape.getWidth());
          image.setHeight(shape.getHeight());
          image.setRelativeHorizontalPosition(shape.getRelativeHorizontalPosition());
          image.setRelativeVerticalPosition(shape.getRelativeVerticalPosition());
          image.setHorizontalAlignment(shape.getHorizontalAlignment());
          image.setVerticalAlignment(shape.getVerticalAlignment());
          image.setWrapType(shape.getWrapType());
          image.setWrapSide(shape.getWrapSide());
  
          // Insert new shape after the old shape and remove the old shape
          shape.getParentNode().insertAfter(image, shape);
          shape.remove();
      }
  }
  
  doc.save(getArtifactsDir() + "Shape.ReplaceTextboxesWithImages.doc");

• insertBefore

  public Node insertBefore(Node newChild, Node refChild)

  Inserts the specified node immediately before the specified reference node.

  If refChild is null, inserts newChild at the end of the list of child nodes.

  If the newChild is already in the tree, it is first removed.

  If the node being inserted was created from another document, you should use importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

  Parameters:

  newChild - The Node to insert.

  refChild - The Node that is the reference node. The newChild is placed before this node.

  Returns:

  The inserted node.

  Example:

  Shows how to add, update and delete child nodes from within a CompositeNode.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1);
  
  // A paragraph is a composite node because it can contain runs, which are another type of node
  Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
  Run paragraphText = new Run(doc, "Initial text. ");
  paragraph.appendChild(paragraphText);
  
  // We will place these 3 children into the main text of our paragraph
  Run run1 = new Run(doc, "Run 1. ");
  Run run2 = new Run(doc, "Run 2. ");
  Run run3 = new Run(doc, "Run 3. ");
  
  // We initialized them but not in our paragraph yet
  Assert.assertEquals(paragraph.getText(), "Initial text. " + (char) 12);
  
  // Insert run2 before initial paragraph text. This will be at the start of the paragraph
  paragraph.insertBefore(run2, paragraphText);
  
  // Insert run3 after initial paragraph text. This will be at the end of the paragraph
  paragraph.insertAfter(run3, paragraphText);
  
  // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1
  paragraph.prependChild(run1);
  
  Assert.assertEquals(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4);
  
  // Access the child node collection and update/delete children
  ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
  paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
  
  Assert.assertEquals(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);

• iterator

  public java.util.Iterator<Node> iterator()

  Provides support for the for each style iteration over the child nodes of this node.

  Example:

  Shows how to enumerate immediate children of a CompositeNode using the enumerator provided by the ChildNodes collection.

  NodeCollection children = paragraph.getChildNodes();
  for (Node child : (Iterable<Node>) children) {
      // Paragraph may contain children of various types such as runs, shapes and so on
      if (child.getNodeType() == NodeType.RUN) {
          // Say we found the node that we want, do something useful
          Run run = (Run) child;
          System.out.println(run.getText());
      }
  }

• joinRunsWithSameFormatting

  public int joinRunsWithSameFormatting()

  Joins runs with same formatting in all paragraphs of the document.

  This is an optimization method. Some documents contain adjacent runs with same formatting. Usually this occurs if a document was intensively edited manually. You can reduce the document size and speed up further processing by joining these runs.

  The operation checks every Paragraph node in the document for adjacent Run nodes having identical properties. It ignores unique identifiers used to track editing sessions of run creation and modification. First run in every joining sequence accumulates all text. Remaining runs are deleted from the document.

  Returns:

  Number of joins performed. When N adjacent runs are being joined they count as N - 1 joins.

  Example:

  Shows how to join runs in a document to reduce unneeded runs.

  // Open a document which contains adjacent runs of text with identical formatting
  // This can, for example, occur if we edit one paragraph many times
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Get the number of runs our document contains
  Assert.assertEquals(317, doc.getChildNodes(NodeType.RUN, true).getCount());
  
  // We can merge all nearby runs with the same formatting to reduce that number by calling JoinRunsWithSameFormatting()
  // This method will also notify us of the number of run joins that took place
  Assert.assertEquals(121, doc.joinRunsWithSameFormatting());
  
  // Get the number of runs after joining, which, together with the number of joins should add up to the original number of runs
  Assert.assertEquals(196, doc.getChildNodes(NodeType.RUN, true).getCount());

• nextPreOrder

  public Node nextPreOrder(Node rootNode)

  Gets next node according to the pre-order tree traversal algorithm.

  Parameters:

  rootNode - The top node (limit) of traversal.

  Returns:

  Next node in pre-order order. Null if reached the rootNode.

  Example:

  Shows how to delete all images from a document using pre-order tree traversal.

  Document doc = new Document(getMyDir() + "Images.docx");
  Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
  
  Node curNode = doc;
  while (curNode != null) {
      Node nextNode = curNode.nextPreOrder(doc);
  
      if (curNode.previousPreOrder(doc) != null && nextNode != null) {
          Assert.assertEquals(curNode, nextNode.previousPreOrder(doc));
      }
  
      if (curNode.getNodeType() == NodeType.SHAPE) {
          Shape shape = (Shape) curNode;
  
          // Several shape types can have an image including image shapes and OLE objects
          if (shape.hasImage()) {
              shape.remove();
          }
      }
  
      curNode = nextNode;
  }
  
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  doc.save(getArtifactsDir() + "Image.DeleteAllImagesPreOrder.docx");

• normalizeFieldTypes

  public void normalizeFieldTypes()

  Changes field type values FieldChar.FieldType of FieldStart, FieldSeparator, FieldEnd in the whole document so that they correspond to the field types contained in the field codes.

  Use this method after document changes that affect field types.

  To change field type values in a specific part of the document use Range.normalizeFieldTypes().

  Example:

  Shows how to get the keep a field's type up to date with its field code.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add a date field
  Field field = builder.insertField("DATE", null);
  
  // Based on the field code we entered above, the type of the field has been set to "FieldDate"
  Assert.assertEquals(FieldType.FIELD_DATE, field.getType());
  
  // We can manually access the content of the field we added and change it
  Run fieldText = (Run)doc.getFirstSection().getBody().getFirstParagraph().getChildNodes(NodeType.RUN, true).get(0);
  fieldText.setText("PAGE");
  
  // We changed the text to "PAGE" but the field's type property did not update accordingly
  Assert.assertEquals("PAGE", fieldText.getText());
  Assert.assertEquals(FieldType.FIELD_DATE, field.getType());
  
  // After running this method the type of the field, as well as its FieldStart,
  // FieldSeparator and FieldEnd nodes to "FieldPage", which matches the text "PAGE"
  doc.normalizeFieldTypes();
  
  Assert.assertEquals(FieldType.FIELD_PAGE, field.getType());

• prependChild

  public Node prependChild(Node newChild)

  Adds the specified node to the beginning of the list of child nodes for this node.

  If the newChild is already in the tree, it is first removed.

  If the node being inserted was created from another document, you should use importNode(com.aspose.words.Node,boolean,int) to import the node to the current document. The imported node can then be inserted into the current document.

  Parameters:

  newChild - The node to add.

  Returns:

  The node added.

  Example:

  Shows how to add, update and delete child nodes from within a CompositeNode.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(doc.getFirstSection().getBody().getParagraphs().getCount(), 1);
  
  // A paragraph is a composite node because it can contain runs, which are another type of node
  Paragraph paragraph = doc.getFirstSection().getBody().getFirstParagraph();
  Run paragraphText = new Run(doc, "Initial text. ");
  paragraph.appendChild(paragraphText);
  
  // We will place these 3 children into the main text of our paragraph
  Run run1 = new Run(doc, "Run 1. ");
  Run run2 = new Run(doc, "Run 2. ");
  Run run3 = new Run(doc, "Run 3. ");
  
  // We initialized them but not in our paragraph yet
  Assert.assertEquals(paragraph.getText(), "Initial text. " + (char) 12);
  
  // Insert run2 before initial paragraph text. This will be at the start of the paragraph
  paragraph.insertBefore(run2, paragraphText);
  
  // Insert run3 after initial paragraph text. This will be at the end of the paragraph
  paragraph.insertAfter(run3, paragraphText);
  
  // Insert run1 before every other child node. run2 was the start of the paragraph, now it will be run1
  paragraph.prependChild(run1);
  
  Assert.assertEquals(paragraph.getText(), "Run 1. Run 2. Initial text. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 4);
  
  // Access the child node collection and update/delete children
  ((Run) paragraph.getChildNodes(NodeType.RUN, true).get(1)).setText("Updated run 2. ");
  paragraph.getChildNodes(NodeType.RUN, true).remove(paragraphText);
  
  Assert.assertEquals(paragraph.getText(), "Run 1. Updated run 2. Run 3. " + (char) 12);
  Assert.assertEquals(paragraph.getChildNodes(NodeType.ANY, true).getCount(), 3);

• previousPreOrder

  public Node previousPreOrder(Node rootNode)

  Gets the previous node according to the pre-order tree traversal algorithm.

  Parameters:

  rootNode - The top node (limit) of traversal.

  Returns:

  Previous node in pre-order order. Null if reached the rootNode.

  Example:

  Shows how to delete all images from a document using pre-order tree traversal.

  Document doc = new Document(getMyDir() + "Images.docx");
  Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
  
  Node curNode = doc;
  while (curNode != null) {
      Node nextNode = curNode.nextPreOrder(doc);
  
      if (curNode.previousPreOrder(doc) != null && nextNode != null) {
          Assert.assertEquals(curNode, nextNode.previousPreOrder(doc));
      }
  
      if (curNode.getNodeType() == NodeType.SHAPE) {
          Shape shape = (Shape) curNode;
  
          // Several shape types can have an image including image shapes and OLE objects
          if (shape.hasImage()) {
              shape.remove();
          }
      }
  
      curNode = nextNode;
  }
  
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  doc.save(getArtifactsDir() + "Image.DeleteAllImagesPreOrder.docx");

• print

  public void print()

  Prints the whole document to the default printer.

  Example:

  Prints the whole document to the default printer.

  Document doc = new Document(getMyDir() + "Document.docx");
  doc.print();

• print

  public void print(java.lang.String printerName)

  Print the whole document to the specified printer, using the standard (no User Interface) print controller.

  Parameters:

  printerName - The name of the printer.

  Example:

  Prints the whole document to a specified printer.

  Document doc = new Document(getMyDir() + "Document.docx");
  doc.print("KONICA MINOLTA magicolor 2400W");

• print

  public void print(javax.print.attribute.AttributeSet printerSettings)

  Prints the document according to the specified printer settings, using the standard (no User Interface) print controller.

  The javax.print.attribute.AttributeSet object allows you to specify the printer to print on, the range of pages of to print and other options.

  The javax.print.attribute.AttributeSet can contain both javax.print.attribute.PrintRequestAttribute to configure PrintJob request and javax.print.attribute.PrintServiceAttribute to configure PrintService lookup.

  Parameters:

  printerSettings - The printer settings to use.

  Example:

  Prints a range of pages.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  PrintRequestAttributeSet printAttribute = new HashPrintRequestAttributeSet();
  printAttribute.add(new PageRanges(1, 3));
  
  doc.print(printAttribute);

• print

  public void print(javax.print.attribute.AttributeSet printerSettings, java.lang.String documentName)

  Prints the document according to the specified printer settings, using the standard (no User Interface) print controller and a document name.

  The javax.print.attribute.AttributeSet object allows you to specify the printer to print on, the range of pages of to print and other options.

  The javax.print.attribute.AttributeSet can contain both javax.print.attribute.PrintRequestAttribute to configure PrintJob request and javax.print.attribute.PrintServiceAttribute to configure PrintService lookup.

  Parameters:

  printerSettings - The printer settings to use.

  documentName - The document name to display (for example, in a print status dialog box or printer queue) while printing the document.

  Example:

  Prints a range of pages along with the name of the document.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  PrintRequestAttributeSet printAttribute = new HashPrintRequestAttributeSet();
  printAttribute.add(new PageRanges(1, 3));
  
  doc.print(printAttribute, "Rendering.PrintRangeWithDocumentName.docx");

• protect

  public void protect(int type)

  Protects the document from changes without changing the existing password or assigns a random password.

  When a document is protected, the user can make only limited changes, such as adding annotations, making revisions, or completing a form.

  When you protect a document, and the document already has a protection password, the existing protection password is not changed.

  When you protect a document, and the document does not have a protection password, this method assigns a random password that makes it impossible to unprotect the document in Microsoft Word, but you still can unprotect the document in Aspose.Words as it does not require a password when unprotecting.

  Parameters:

  type - A ProtectionType value. Specifies the protection type for the document.

  Example:

  Protects a section so only editing in form fields is possible.

  // Create a blank document
  Document doc = new Document();
  
  // Insert two sections with some text
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.writeln("Section 1. Unprotected.");
  builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
  builder.writeln("Section 2. Protected.");
  
  // Section protection only works when document protection is turned and only editing in form fields is allowed
  doc.protect(ProtectionType.ALLOW_ONLY_FORM_FIELDS);
  
  // By default, all sections are protected, but we can selectively turn protection off
  doc.getSections().get(0).setProtectedForForms(false);
  
  builder.getDocument().save(getArtifactsDir() + "Section.Protect.doc");

• protect

  public void protect(int type, java.lang.String password)

  Protects the document from changes and optionally sets a protection password.

  When a document is protected, the user can make only limited changes, such as adding annotations, making revisions, or completing a form.

  Note that document protection is different from write protection. Write protection is specified using the WriteProtection.

  Parameters:

  type - A ProtectionType value. Specifies the protection type for the document.

  password - The password to protect the document with. Specify null or empty string if you want to protect the document without a password.

  Example:

  Shows how to protect a document.

  // Create a new document and protect it with a password
  Document doc = new Document();
  doc.protect(ProtectionType.READ_ONLY, "password");
  Assert.assertEquals(ProtectionType.READ_ONLY, doc.getProtectionType());
  
  // If we open this document with Microsoft Word and wish to edit it, 
  // we will first need to stop the protection, which can only be done with the password
  doc.save(getArtifactsDir() + "Document.Protect.docx");
  
  // Note that the protection only applies to Microsoft Word users opening out document
  // The document can still be opened and edited programmatically without a password, despite its protection status
  // Encryption offers a more robust option for protecting document content
  Document protectedDoc = new Document(getArtifactsDir() + "Document.Protect.docx");
  Assert.assertEquals(ProtectionType.READ_ONLY, protectedDoc.getProtectionType());
  
  DocumentBuilder builder = new DocumentBuilder(protectedDoc);
  builder.writeln("Text added to a protected document.");
  
  // Documents can have protection removed either with no password, or with the correct password
  doc.unprotect();
  Assert.assertEquals(ProtectionType.NO_PROTECTION, doc.getProtectionType());
  
  doc.protect(ProtectionType.READ_ONLY, "newPassword");
  doc.unprotect("newPassword");
  Assert.assertEquals(ProtectionType.NO_PROTECTION, doc.getProtectionType());

• remove

  @Deprecated
  public void remove()

  Deprecated. Reserved for internal use.

• removeAllChildren

  public void removeAllChildren()

  Removes all the child nodes of the current node.

  Example:

  Creates a simple document from scratch using the Aspose.Words object model.

  // Create an "empty" document. Note that like in Microsoft Word, 
  // the empty document has one section, body and one paragraph in it
  Document doc = new Document();
  
  // This truly makes the document empty. No sections (not possible in Microsoft Word)
  doc.removeAllChildren();
  
  // Create a new section node
  // Note that the section has not yet been added to the document, 
  // but we have to specify the parent document
  Section section = new Section(doc);
  
  // Append the section to the document
  doc.appendChild(section);
  
  // Lets set some properties for the section
  section.getPageSetup().setSectionStart(SectionStart.NEW_PAGE);
  section.getPageSetup().setPaperSize(PaperSize.LETTER);
  
  // The section that we created is empty, lets populate it. The section needs at least the Body node
  Body body = new Body(doc);
  section.appendChild(body);
  
  // The body needs to have at least one paragraph
  // Note that the paragraph has not yet been added to the document, 
  // but we have to specify the parent document
  // The parent document is needed so the paragraph can correctly work
  // with styles and other document-wide information
  Paragraph para = new Paragraph(doc);
  body.appendChild(para);
  
  // We can set some formatting for the paragraph
  para.getParagraphFormat().setStyleName("Heading 1");
  para.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
  
  // So far we have one empty paragraph in the document
  // The document is valid and can be saved, but lets add some text before saving
  // Create a new run of text and add it to our paragraph
  Run run = new Run(doc);
  run.setText("Hello World!");
  run.getFont().setColor(Color.RED);
  para.appendChild(run);
  
  // As a matter of interest, you can retrieve text of the whole document and
  // see that \x000c is automatically appended. \x000c is the end of section character
  System.out.println(doc.getText());
  
  // Save the document
  doc.save(getArtifactsDir() + "Section.CreateFromScratch.doc");

• removeChild

  public Node removeChild(Node oldChild)

  Removes the specified child node.

  The parent of oldChild is set to null after the node is removed.

  Parameters:

  oldChild - The node to remove.

  Returns:

  The removed node.

  Example:

  Shows how to use of methods of Node and CompositeNode to remove a section before the last section in the document.

  // Document is a CompositeNode and LastChild returns the last child node in the Document node
  // Since the Document can contain only Section nodes, the last child is the last section
  Node lastSection = doc.getLastChild();
  
  // Each node knows its next and previous sibling nodes
  // Previous sibling of a section is a section before the specified section
  // If the node is the first child, PreviousSibling will return null
  Node sectionBeforeLast = lastSection.getPreviousSibling();
  
  if (sectionBeforeLast != null) {
      doc.removeChild(sectionBeforeLast);
  }

• removeExternalSchemaReferences

  public void removeExternalSchemaReferences()

  Removes external XML schema references from this document.

  Example:

  Shows how to remove all external XML schema references from a document.

  Document doc = new Document(getMyDir() + "External XML schema.docx");
  
  doc.removeExternalSchemaReferences();

• removeMacros

  public void removeMacros()

  Removes all macros (the VBA project) as well as toolbars and command customizations from the document.

  By removing all macros from a document you can ensure the document contains no macro viruses.

  Example:

  Shows how to remove all macros from a document.

  // Open a document that contains a VBA project and macros
  Document doc = new Document(getMyDir() + "Macro.docm");
  
  Assert.assertTrue(doc.hasMacros());
  
  // We can strip the document of this content by calling this method
  doc.removeMacros();
  
  Assert.assertFalse(doc.hasMacros());

• removeSmartTags

  public void removeSmartTags()

  Removes all SmartTag descendant nodes of the current node.

  This method does not remove the content of the smart tags.

  Example:

  Removes all smart tags from descendant nodes of the composite node.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Remove smart tags from the first paragraph in the document
  doc.getFirstSection().getBody().getFirstParagraph().removeSmartTags();

• renderToScale

  public java.awt.geom.Point2D.Float renderToScale(int pageIndex, java.awt.Graphics2D graphics, float x, float y, float scale)
                     throws java.lang.Exception

  Renders a document page into a java.awt.Graphics2D object to a specified scale.

  Parameters:

  pageIndex - The 0-based page index.

  graphics - The object where to render to.

  x - The X coordinate (in world units) of the top left corner of the rendered page.

  y - The Y coordinate (in world units) of the top left corner of the rendered page.

  scale - The scale for rendering the page (1.0 is 100%).

  Returns:

  The width and height (in world units) of the rendered page.

  Example:

  Renders individual pages to graphics to create one image with thumbnails of all pages.

  // The user opens or builds a document
  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // This defines the number of columns to display the thumbnails in
  final int thumbColumns = 2;
  
  // Calculate the required number of rows for thumbnails
  // We can now get the number of pages in the document
  int thumbRows = doc.getPageCount() / thumbColumns;
  int remainder = doc.getPageCount() % thumbColumns;
  
  if (remainder > 0) thumbRows++;
  
  // Lets say I want thumbnails to be of this zoom
  float scale = 0.25f;
  
  // For simplicity lets pretend all pages in the document are of the same size,
  // so we can use the size of the first page to calculate the size of the thumbnail
  Dimension thumbSize = doc.getPageInfo(0).getSizeInPixels(scale, 96);
  
  // Calculate the size of the image that will contain all the thumbnails
  int imgWidth = (int) (thumbSize.getWidth() * thumbColumns);
  int imgHeight = (int) (thumbSize.getHeight() * thumbRows);
  
  BufferedImage img = new BufferedImage(imgWidth, imgHeight, BufferedImage.TYPE_INT_ARGB);
  // The user has to provides a Graphics object to draw on
  // The Graphics object can be created from a bitmap, from a metafile, printer or window
  Graphics2D gr = img.createGraphics();
  try {
      gr.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
  
      gr.setColor(Color.white);
      // Fill the "paper" with white, otherwise it will be transparent
      gr.fillRect(0, 0, imgWidth, imgHeight);
  
      for (int pageIndex = 0; pageIndex < doc.getPageCount(); pageIndex++) {
          int rowIdx = pageIndex / thumbColumns;
          int columnIdx = pageIndex % thumbColumns;
  
          // Specify where we want the thumbnail to appear
          float thumbLeft = (float) (columnIdx * thumbSize.getWidth());
          float thumbTop = (float) (rowIdx * thumbSize.getHeight());
  
          Point2D.Float size = doc.renderToScale(pageIndex, gr, thumbLeft, thumbTop, scale);
  
          gr.setColor(Color.black);
  
          // Draw the page rectangle
          gr.drawRect((int) thumbLeft, (int) thumbTop, (int) size.getX(), (int) size.getY());
      }
  
      ImageIO.write(img, "PNG", new File(getArtifactsDir() + "Rendering.Thumbnails.png"));
  } finally {
      if (gr != null) {
          gr.dispose();
      }
  }

• renderToSize

  public float renderToSize(int pageIndex, java.awt.Graphics2D graphics, float x, float y, float width, float height)
                    throws java.lang.Exception

  Renders a document page into a java.awt.Graphics2D object to a specified size.

  Parameters:

  pageIndex - The 0-based page index.

  graphics - The object where to render to.

  x - The X coordinate (in world units) of the top left corner of the rendered page.

  y - The Y coordinate (in world units) of the top left corner of the rendered page.

  width - The maximum width (in world units) that can be occupied by the rendered page.

  height - The maximum height (in world units) that can be occupied by the rendered page.

  Returns:

  The scale that was automatically calculated for the rendered page to fit the specified size.

  Example:

  Render to a BufferedImage at a specified location and size.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  BufferedImage img = new BufferedImage(700, 700, BufferedImage.TYPE_INT_ARGB);
  // User has some sort of a Graphics object
  // In this case created from a bitmap
  Graphics2D gr = img.createGraphics();
  try {
      // The user can specify any options on the Graphics object including
      // transform, antialiasing, page units, etc
      gr.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON);
  
      // The output should be offset 0.5" from the edge and rotated
      gr.translate(ConvertUtil.inchToPoint(0.5f), ConvertUtil.inchToPoint(0.5f));
      gr.rotate(10.0 * Math.PI / 180.0, img.getWidth() / 2.0, img.getHeight() / 2.0);
  
      // Set pen color and draw our test rectangle
      gr.setColor(Color.RED);
      gr.drawRect(0, 0, (int) ConvertUtil.inchToPoint(3), (int) ConvertUtil.inchToPoint(3));
  
      // User specifies (in world coordinates) where on the Graphics to render and what size
      float returnedScale = doc.renderToSize(0, gr, 0f, 0f, (float) ConvertUtil.inchToPoint(3), (float) ConvertUtil.inchToPoint(3));
  
      // This is the calculated scale factor to fit 297mm into 3"
      System.out.println(MessageFormat.format("The image was rendered at {0,number,#}% zoom.", returnedScale * 100));
  
      ImageIO.write(img, "PNG", new File(getArtifactsDir() + "Rendering.RenderToSize.png"));
  } finally {
      if (gr != null) {
          gr.dispose();
      }
  }

• save

  public void save(java.io.OutputStream outputStream, SaveOptions saveOptions)
           throws java.lang.Exception

  Saves the document to a stream using the specified save options.

  Parameters:

  stream - Stream where to save the document.

  saveOptions - Specifies the options that control how the document is saved. Can be null. If this is null, the document will be saved in the binary DOC format.

  Returns:

  Additional information that you can optionally use.

  Example:

  Converts just one page (third page in this example) of the document to PDF.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  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();
      }
  }

• save

  public void save(java.io.OutputStream outputStream, int saveFormat)
           throws java.lang.Exception

  Saves the document to a stream using the specified format.

  Parameters:

  stream - Stream where to save the document.

  saveFormat - The format in which to save the document.

  Returns:

  Additional information that you can optionally use.

  Example:

  Shows how to save a document to the JPEG format using the Save method and the ImageSaveOptions class.

  // Open the document
  Document doc = new Document(getMyDir() + "Rendering.docx");
  // Save as a JPEG image file with default options
  doc.save(getArtifactsDir() + "Rendering.SaveAsImage.DefaultJpgOptions.jpg");
  
  // Save document to an ByteArrayOutputStream as a JPEG with default options
  ByteArrayOutputStream docStream = new ByteArrayOutputStream();
  doc.save(docStream, SaveFormat.JPEG);
  
  // Save document to a JPEG image with specified options
  // Render the third page only and set the JPEG quality to 80%
  // In this case we need to pass the desired SaveFormat to the ImageSaveOptions constructor 
  // to signal what type of image to save as
  ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
  imageOptions.setPageIndex(2);
  imageOptions.setPageCount(1);
  imageOptions.setJpegQuality(80);
  doc.save(getArtifactsDir() + "Rendering.SaveAsImage.CustomJpgOptions.jpg", imageOptions);

  Example:

  Shows how to save a document to a stream.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  ByteArrayOutputStream dstStream = new ByteArrayOutputStream();
  doc.save(dstStream, SaveFormat.DOCX);
  
  // In you want to read the result into a Document object again, in Java you need to get the
  // data bytes and wrap into an input stream
  ByteArrayInputStream srcStream = new ByteArrayInputStream(dstStream.toByteArray());

  Example:

  Saves a document page as a BMP image into a ByteArayOutputStream.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ByteArrayOutputStream stream = new ByteArrayOutputStream();
  doc.save(stream, SaveFormat.BMP);
  
  // The stream now contains image bytes
  byte[] imageBytes = stream.toByteArray();
  
  // Read the bytes back into an image
  BufferedImage image = ImageIO.read(new ByteArrayInputStream(imageBytes));

• save

  public SaveOutputParameters save(java.lang.String fileName)
                           throws java.lang.Exception

  Saves the document to a file. Automatically determines the save format from the extension.

  Parameters:

  fileName - The name for the document. If a document with the specified file name already exists, the existing document is overwritten.

  Returns:

  Additional information that you can optionally use.

  Example:

  Shows how to save a document to the JPEG format using the Save method and the ImageSaveOptions class.

  // Open the document
  Document doc = new Document(getMyDir() + "Rendering.docx");
  // Save as a JPEG image file with default options
  doc.save(getArtifactsDir() + "Rendering.SaveAsImage.DefaultJpgOptions.jpg");
  
  // Save document to an ByteArrayOutputStream as a JPEG with default options
  ByteArrayOutputStream docStream = new ByteArrayOutputStream();
  doc.save(docStream, SaveFormat.JPEG);
  
  // Save document to a JPEG image with specified options
  // Render the third page only and set the JPEG quality to 80%
  // In this case we need to pass the desired SaveFormat to the ImageSaveOptions constructor 
  // to signal what type of image to save as
  ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
  imageOptions.setPageIndex(2);
  imageOptions.setPageCount(1);
  imageOptions.setJpegQuality(80);
  doc.save(getArtifactsDir() + "Rendering.SaveAsImage.CustomJpgOptions.jpg", imageOptions);

  Example:

  Shows how to open a document and convert it to .PDF.

  // Open a document that exists in the local file system
  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Save that document as a PDF to another location
  doc.save(getArtifactsDir() + "Document.ConvertToPdf.pdf");

• save

  public SaveOutputParameters save(java.lang.String fileName, SaveOptions saveOptions)
                           throws java.lang.Exception

  Saves the document to a file using the specified save options.

  Parameters:

  fileName - The name for the document. If a document with the specified file name already exists, the existing document is overwritten.

  saveOptions - Specifies the options that control how the document is saved. Can be null.

  Returns:

  Additional information that you can optionally use.

  Example:

  Shows how to save a document to the JPEG format using the Save method and the ImageSaveOptions class.

  // Open the document
  Document doc = new Document(getMyDir() + "Rendering.docx");
  // Save as a JPEG image file with default options
  doc.save(getArtifactsDir() + "Rendering.SaveAsImage.DefaultJpgOptions.jpg");
  
  // Save document to an ByteArrayOutputStream as a JPEG with default options
  ByteArrayOutputStream docStream = new ByteArrayOutputStream();
  doc.save(docStream, SaveFormat.JPEG);
  
  // Save document to a JPEG image with specified options
  // Render the third page only and set the JPEG quality to 80%
  // In this case we need to pass the desired SaveFormat to the ImageSaveOptions constructor 
  // to signal what type of image to save as
  ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
  imageOptions.setPageIndex(2);
  imageOptions.setPageCount(1);
  imageOptions.setJpegQuality(80);
  doc.save(getArtifactsDir() + "Rendering.SaveAsImage.CustomJpgOptions.jpg", imageOptions);

  Example:

  Converts every page of a DOC file into a separate scalable EMF file.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.EMF);
  options.setPageCount(1);
  
  for (int i = 0; i < doc.getPageCount(); i++) {
      options.setPageIndex(i);
      doc.save(getArtifactsDir() + "Rendering.SaveToEmf." + Integer.toString(i) + ".emf", options);
  }

  Example:

  Converts a whole document to PDF with three levels in the document outline.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.getOutlineOptions().setHeadingsOutlineLevels(3);
  options.getOutlineOptions().setExpandedOutlineLevels(1);
  
  doc.save(getArtifactsDir() + "Rendering.SaveToPdfWithOutline.pdf", options);

• save

  public SaveOutputParameters save(java.lang.String fileName, int saveFormat)
                           throws java.lang.Exception

  Saves the document to a file in the specified format.

  Parameters:

  fileName - The name for the document. If a document with the specified file name already exists, the existing document is overwritten.

  saveFormat - A SaveFormat value. The format in which to save the document.

  Returns:

  Additional information that you can optionally use.

  Example:

  Shows how to convert from DOCX to HTML format.

  Document doc = new Document(getMyDir() + "Document.docx");
  doc.save(getArtifactsDir() + "Document.ConvertToHtml.html", SaveFormat.HTML);

• selectNodes

  public NodeList selectNodes(java.lang.String xpath)

  Selects a list of nodes matching the XPath expression.

  Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

  Parameters:

  xpath - The XPath expression.

  Returns:

  A list of nodes matching the XPath query.

  Example:

  Shows how to select certain nodes by using an XPath expression.

  Document doc = new Document(getMyDir() + "Tables.docx");
  
  // This expression will extract all paragraph nodes which are descendants of any table node in the document
  // This will return any paragraphs which are in a table
  NodeList nodeList = doc.selectNodes("//Table//Paragraph");
  
  // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table
  int index = 0;
  Iterator<Node> e = nodeList.iterator();
  while (e.hasNext()) {
      Node currentNode = e.next();
      System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim()));
  }
  
  // This expression will select any paragraphs that are direct children of any body node in the document
  nodeList = doc.selectNodes("//Body/Paragraph");
  
  // We can treat the list as an array too
  Assert.assertEquals(nodeList.toArray().length, 4);
  
  // Use SelectSingleNode to select the first result of the same expression as above
  Node node = doc.selectSingleNode("//Body/Paragraph");

  Example:

  Shows how to test if a node is inside a field by using an XPath expression.

  // Let's pick a document we know has some fields in
  Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx");
  
  // Let's say we want to check if the Run below is inside a field
  Run run = (Run) doc.getChild(NodeType.RUN, 5, true);
  
  // Evaluate the XPath expression. The resulting NodeList will contain all nodes found inside a field a field (between FieldStart 
  // and FieldEnd exclusive). There can however be FieldStart and FieldEnd nodes in the list if there are nested fields 
  // in the path. Currently does not find rare fields in which the FieldCode or FieldResult spans across multiple paragraphs
  NodeList resultList =
          doc.selectNodes("//FieldStart/following-sibling::node()[following-sibling::FieldEnd]");
  
  // Check if the specified run is one of the nodes that are inside the field
  for (Node node : (Iterable<Node>) resultList) {
      if (node == run) {
          System.out.println("The node is found inside a field");
          break;
      }
  }

• selectSingleNode

  public Node selectSingleNode(java.lang.String xpath)

  Selects the first Node that matches the XPath expression.

  Only expressions with element names are supported at the moment. Expressions that use attribute names are not supported.

  Parameters:

  xpath - The XPath expression.

  Returns:

  The first Node that matches the XPath query or null if no matching node is found.

  Example:

  Shows how to select certain nodes by using an XPath expression.

  Document doc = new Document(getMyDir() + "Tables.docx");
  
  // This expression will extract all paragraph nodes which are descendants of any table node in the document
  // This will return any paragraphs which are in a table
  NodeList nodeList = doc.selectNodes("//Table//Paragraph");
  
  // Iterate through the list with an enumerator and print the contents of every paragraph in each cell of the table
  int index = 0;
  Iterator<Node> e = nodeList.iterator();
  while (e.hasNext()) {
      Node currentNode = e.next();
      System.out.println(MessageFormat.format("Table paragraph index {0}, contents: \"{1}\"", index++, currentNode.getText().trim()));
  }
  
  // This expression will select any paragraphs that are direct children of any body node in the document
  nodeList = doc.selectNodes("//Body/Paragraph");
  
  // We can treat the list as an array too
  Assert.assertEquals(nodeList.toArray().length, 4);
  
  // Use SelectSingleNode to select the first result of the same expression as above
  Node node = doc.selectSingleNode("//Body/Paragraph");

• startTrackRevisions

  public void startTrackRevisions(java.lang.String author)

  Starts automatically marking all further changes you make to the document programmatically as revision changes.

  If you call this method and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.

  Currently Aspose.Words supports tracking of node insertions and deletions only. Formatting changes are not recorded as revisions.

  Automatic tracking of changes is supported both when modifying this document through node manipulations as well as when using DocumentBuilder

  This method does not change the TrackRevisions option and does not use its value for the purposes of revision tracking.

  Parameters:

  author - Initials of the author to use for revisions.

  See Also:

  stopTrackRevisions()

  Example:

  Shows how tracking revisions affects document editing.

  Document doc = new Document();
  
  // This text will appear as normal text in the document and no revisions will be counted
  doc.getFirstSection().getBody().getFirstParagraph().getRuns().add(new Run(doc, "Hello world!"));
  Assert.assertEquals(0, doc.getRevisions().getCount());
  
  doc.startTrackRevisions("Author");
  
  // This text will appear as a revision
  // We did not specify a time while calling StartTrackRevisions(), so the date/time that's noted
  // on the revision will be the real time when StartTrackRevisions() executes
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(2, doc.getRevisions().getCount());
  
  // Stopping the tracking of revisions makes this text appear as normal text
  // Revisions are not counted when the document is changed
  doc.stopTrackRevisions();
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(2, doc.getRevisions().getCount());
  
  // Specifying some date/time will apply that date/time to all subsequent revisions until StopTrackRevisions() is called
  // Note that placing values such as DateTime.MinValue as an argument will create revisions that do not have a date/time at all
  doc.startTrackRevisions("Author", new SimpleDateFormat("yyyy/MM/DD").parse("1970/01/01"));
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(4, doc.getRevisions().getCount());
  
  doc.save(getArtifactsDir() + "Document.StartTrackRevisions.docx");

• startTrackRevisions

  public void startTrackRevisions(java.lang.String author, java.util.Date dateTime)

  Starts automatically marking all further changes you make to the document programmatically as revision changes.

  If you call this method and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions.

  Currently Aspose.Words supports tracking of node insertions and deletions only. Formatting changes are not recorded as revisions.

  Automatic tracking of changes is supported both when modifying this document through node manipulations as well as when using DocumentBuilder

  This method does not change the TrackRevisions option and does not use its value for the purposes of revision tracking.

  Parameters:

  author - Initials of the author to use for revisions.

  dateTime - The date and time to use for revisions.

  See Also:

  stopTrackRevisions()

  Example:

  Shows how tracking revisions affects document editing.

  Document doc = new Document();
  
  // This text will appear as normal text in the document and no revisions will be counted
  doc.getFirstSection().getBody().getFirstParagraph().getRuns().add(new Run(doc, "Hello world!"));
  Assert.assertEquals(0, doc.getRevisions().getCount());
  
  doc.startTrackRevisions("Author");
  
  // This text will appear as a revision
  // We did not specify a time while calling StartTrackRevisions(), so the date/time that's noted
  // on the revision will be the real time when StartTrackRevisions() executes
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(2, doc.getRevisions().getCount());
  
  // Stopping the tracking of revisions makes this text appear as normal text
  // Revisions are not counted when the document is changed
  doc.stopTrackRevisions();
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(2, doc.getRevisions().getCount());
  
  // Specifying some date/time will apply that date/time to all subsequent revisions until StopTrackRevisions() is called
  // Note that placing values such as DateTime.MinValue as an argument will create revisions that do not have a date/time at all
  doc.startTrackRevisions("Author", new SimpleDateFormat("yyyy/MM/DD").parse("1970/01/01"));
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(4, doc.getRevisions().getCount());
  
  doc.save(getArtifactsDir() + "Document.StartTrackRevisions.docx");

• stopTrackRevisions

  public void stopTrackRevisions()

  Stops automatic marking of document changes as revisions.

  See Also:

  startTrackRevisions(java.lang.String,java.util.Date)

  Example:

  Shows how tracking revisions affects document editing.

  Document doc = new Document();
  
  // This text will appear as normal text in the document and no revisions will be counted
  doc.getFirstSection().getBody().getFirstParagraph().getRuns().add(new Run(doc, "Hello world!"));
  Assert.assertEquals(0, doc.getRevisions().getCount());
  
  doc.startTrackRevisions("Author");
  
  // This text will appear as a revision
  // We did not specify a time while calling StartTrackRevisions(), so the date/time that's noted
  // on the revision will be the real time when StartTrackRevisions() executes
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(2, doc.getRevisions().getCount());
  
  // Stopping the tracking of revisions makes this text appear as normal text
  // Revisions are not counted when the document is changed
  doc.stopTrackRevisions();
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(2, doc.getRevisions().getCount());
  
  // Specifying some date/time will apply that date/time to all subsequent revisions until StopTrackRevisions() is called
  // Note that placing values such as DateTime.MinValue as an argument will create revisions that do not have a date/time at all
  doc.startTrackRevisions("Author", new SimpleDateFormat("yyyy/MM/DD").parse("1970/01/01"));
  doc.getFirstSection().getBody().appendParagraph("Hello again!");
  Assert.assertEquals(4, doc.getRevisions().getCount());
  
  doc.save(getArtifactsDir() + "Document.StartTrackRevisions.docx");

• toString

  public java.lang.String toString(SaveOptions saveOptions)
                 throws java.lang.Exception

  Exports the content of the node into a string using the specified save options.

  Parameters:

  saveOptions - Specifies the options that control how the node is saved.

  Returns:

  The content of the node in the specified format.

  Example:

  Exports the content of a node to String in HTML format using custom specified options.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Extract the last paragraph in the document to convert to HTML
  Node node = doc.getLastSection().getBody().getLastParagraph();
  
  // Create an instance of HtmlSaveOptions and set a few options
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  saveOptions.setExportHeadersFootersMode(ExportHeadersFootersMode.PER_SECTION);
  saveOptions.setExportRelativeFontSize(true);
  
  // Convert the document to HTML and return as a String. Pass the instance of HtmlSaveOptions to
  // to use the specified options during the conversion
  String nodeAsHtml = node.toString(saveOptions);

• toString

  public java.lang.String toString(int saveFormat)
                 throws java.lang.Exception

  Exports the content of the node into a string in the specified format.

  Returns:

  The content of the node in the specified format.

  Parameters:

  saveFormat - A SaveFormat value.

  Example:

  Shows how to extract the label of each paragraph in a list as a value or a String.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  doc.updateListLabels();
  int listParaCount = 1;
  
  for (Paragraph paragraph : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
      // Find if we have the paragraph list. In our document our list uses plain arabic numbers,
      // which start at three and ends at six
      if (paragraph.getListFormat().isListItem()) {
          System.out.println(MessageFormat.format("Paragraph #{0}", listParaCount));
  
          // This is the text we get when actually getting when we output this node to text format
          // The list labels are not included in this text output. Trim any paragraph formatting characters
          String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
          System.out.println("Exported Text: " + paragraphText);
  
          ListLabel label = paragraph.getListLabel();
          // This gets the position of the paragraph in current level of the list. If we have a list with multiple level then this
          // will tell us what position it is on that particular level
          System.out.println("Numerical Id: " + label.getLabelValue());
  
          // Combine them together to include the list label with the text in the output
          System.out.println("List label combined with text: " + label.getLabelString() + " " + paragraphText);
  
          listParaCount++;
      }
  }

  Example:

  Exports the content of a node to String in HTML format using default options.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Extract the last paragraph in the document to convert to HTML
  Node node = doc.getLastSection().getBody().getLastParagraph();
  
  // When ToString is called using the SaveFormat overload then conversion is executed using default save options
  // When saving to HTML using default options the following settings are set:
  //   ExportImagesAsBase64 = true
  //   CssStyleSheetType = CssStyleSheetType.Inline
  //   ExportFontResources = false
  String nodeAsHtml = node.toString(SaveFormat.HTML);

  Example:

  Shows the difference between calling the GetText and ToString methods on a node.

  Document doc = new Document();
  
  // Enter a field into the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertField("MERGEFIELD Field");
  
  // GetText will retrieve all field codes and special characters
  Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
  
  // ToString will give us the plaintext version of the document in the save format we put into the parameter
  Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));

• unlinkFields

  public void unlinkFields()
                   throws java.lang.Exception

  Unlinks fields in the whole document.

  Replaces all the fields in the whole document with their most recent results.

  To unlink fields in a specific part of the document use Range.unlinkFields().

  Example:

  Shows how to unlink all fields in the document.

  Document doc = new Document(getMyDir() + "Linked fields.docx");
  
  doc.unlinkFields();

• unprotect

  public void unprotect()

  Removes protection from the document regardless of the password.

  This method unprotects the document even if it has a protection password.

  Note that document protection is different from write protection. Write protection is specified using the WriteProtection.

  Example:

  Shows how to protect a document.

  // Create a new document and protect it with a password
  Document doc = new Document();
  doc.protect(ProtectionType.READ_ONLY, "password");
  Assert.assertEquals(ProtectionType.READ_ONLY, doc.getProtectionType());
  
  // If we open this document with Microsoft Word and wish to edit it, 
  // we will first need to stop the protection, which can only be done with the password
  doc.save(getArtifactsDir() + "Document.Protect.docx");
  
  // Note that the protection only applies to Microsoft Word users opening out document
  // The document can still be opened and edited programmatically without a password, despite its protection status
  // Encryption offers a more robust option for protecting document content
  Document protectedDoc = new Document(getArtifactsDir() + "Document.Protect.docx");
  Assert.assertEquals(ProtectionType.READ_ONLY, protectedDoc.getProtectionType());
  
  DocumentBuilder builder = new DocumentBuilder(protectedDoc);
  builder.writeln("Text added to a protected document.");
  
  // Documents can have protection removed either with no password, or with the correct password
  doc.unprotect();
  Assert.assertEquals(ProtectionType.NO_PROTECTION, doc.getProtectionType());
  
  doc.protect(ProtectionType.READ_ONLY, "newPassword");
  doc.unprotect("newPassword");
  Assert.assertEquals(ProtectionType.NO_PROTECTION, doc.getProtectionType());

• unprotect

  public boolean unprotect(java.lang.String password)

  Removes protection from the document if a correct password is specified.

  This method unprotects the document only if a correct password is specified.

  Note that document protection is different from write protection. Write protection is specified using the WriteProtection.

  Parameters:

  password - The password to unprotect the document with.

  Returns:

  True if a correct password was specified and the document was unprotected.

  Example:

  Shows how to protect a document.

  // Create a new document and protect it with a password
  Document doc = new Document();
  doc.protect(ProtectionType.READ_ONLY, "password");
  Assert.assertEquals(ProtectionType.READ_ONLY, doc.getProtectionType());
  
  // If we open this document with Microsoft Word and wish to edit it, 
  // we will first need to stop the protection, which can only be done with the password
  doc.save(getArtifactsDir() + "Document.Protect.docx");
  
  // Note that the protection only applies to Microsoft Word users opening out document
  // The document can still be opened and edited programmatically without a password, despite its protection status
  // Encryption offers a more robust option for protecting document content
  Document protectedDoc = new Document(getArtifactsDir() + "Document.Protect.docx");
  Assert.assertEquals(ProtectionType.READ_ONLY, protectedDoc.getProtectionType());
  
  DocumentBuilder builder = new DocumentBuilder(protectedDoc);
  builder.writeln("Text added to a protected document.");
  
  // Documents can have protection removed either with no password, or with the correct password
  doc.unprotect();
  Assert.assertEquals(ProtectionType.NO_PROTECTION, doc.getProtectionType());
  
  doc.protect(ProtectionType.READ_ONLY, "newPassword");
  doc.unprotect("newPassword");
  Assert.assertEquals(ProtectionType.NO_PROTECTION, doc.getProtectionType());

• updateFields

  public void updateFields()
                   throws java.lang.Exception

  Updates the values of fields in the whole document.

  When you open, modify and then save a document, Aspose.Words does not update fields automatically, it keeps them intact. Therefore, you would usually want to call this method before saving if you have modified the document programmatically and want to make sure the proper (calculated) field values appear in the saved document.

  There is no need to update fields after executing a mail merge because mail merge is a kind of field update and automatically updates all fields in the document.

  This method does not update all field types. For the detailed list of supported field types, see the Programmers Guide.

  This method does not update fields that are related to the page layout algorithms (e.g. PAGE, PAGES, PAGEREF). The page layout-related fields are updated when you render a document or call updatePageLayout().

  Use the normalizeFieldTypes() method before fields updating if there were document changes that affected field types.

  To update fields in a specific part of the document use Range.updateFields().

  Example:

  Shows how to set user details and display them with fields.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Set user information
  UserInformation userInformation = new UserInformation();
  userInformation.setName("John Doe");
  userInformation.setInitials("J. D.");
  userInformation.setAddress("123 Main Street");
  doc.getFieldOptions().setCurrentUser(userInformation);
  
  // Insert fields that reference our user information
  Assert.assertEquals(userInformation.getName(), builder.insertField(" USERNAME ").getResult());
  Assert.assertEquals(userInformation.getInitials(), builder.insertField(" USERINITIALS ").getResult());
  Assert.assertEquals(userInformation.getAddress(), builder.insertField(" USERADDRESS ").getResult());
  
  // The field options object also has a static default user value that fields from many documents can refer to
  UserInformation.getDefaultUser().setName("Default User");
  UserInformation.getDefaultUser().setInitials("D. U.");
  UserInformation.getDefaultUser().setAddress("One Microsoft Way");
  doc.getFieldOptions().setCurrentUser(UserInformation.getDefaultUser());
  
  Assert.assertEquals("Default User", builder.insertField(" USERNAME ").getResult());
  Assert.assertEquals("D. U.", builder.insertField(" USERINITIALS ").getResult());
  Assert.assertEquals("One Microsoft Way", builder.insertField(" USERADDRESS ").getResult());
  
  doc.updateFields();
  doc.save(getArtifactsDir() + "FieldOptions.FieldOptionsCurrentUser.docx");

  Example:

  Demonstrates how to insert a Table of contents (TOC) into a document using heading styles as entries.

  // Use a blank document
  Document doc = new Document();
  // Create a document builder to insert content with into document
  DocumentBuilder builder = new DocumentBuilder(doc);
  // Insert a table of contents at the beginning of the document
  builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u");
  // Start the actual document content on the second page
  builder.insertBreak(BreakType.PAGE_BREAK);
  // Build a document with complex structure by applying different heading styles thus creating TOC entries
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
  
  builder.writeln("Heading 1");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
  
  builder.writeln("Heading 1.1");
  builder.writeln("Heading 1.2");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
  
  builder.writeln("Heading 2");
  builder.writeln("Heading 3");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
  
  builder.writeln("Heading 3.1");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
  
  builder.writeln("Heading 3.1.1");
  builder.writeln("Heading 3.1.2");
  builder.writeln("Heading 3.1.3");
  
  builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
  
  builder.writeln("Heading 3.2");
  builder.writeln("Heading 3.3");
  
  // Call the method below to update the TOC
  doc.updateFields();

  Example:

  Shows how to update all fields before rendering a document.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // This updates all fields in the document
  doc.updateFields();
  
  doc.save(getArtifactsDir() + "Rendering.UpdateFields.pdf");

• updateListLabels

  public void updateListLabels()
                       throws java.lang.Exception

  Updates list labels for all list items in the document.

  This method updates list label properties such as ListLabel.LabelValue and ListLabel.LabelString for each Paragraph.ListLabel object in the document.

  Also, this method is sometimes implicitly called when updating fields in the document. This is required because some fields that may reference list numbers (such as TOC or REF) need them be up-to-date.

  Example:

  Shows how to extract the label of each paragraph in a list as a value or a String.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  doc.updateListLabels();
  int listParaCount = 1;
  
  for (Paragraph paragraph : (Iterable<Paragraph>) doc.getChildNodes(NodeType.PARAGRAPH, true)) {
      // Find if we have the paragraph list. In our document our list uses plain arabic numbers,
      // which start at three and ends at six
      if (paragraph.getListFormat().isListItem()) {
          System.out.println(MessageFormat.format("Paragraph #{0}", listParaCount));
  
          // This is the text we get when actually getting when we output this node to text format
          // The list labels are not included in this text output. Trim any paragraph formatting characters
          String paragraphText = paragraph.toString(SaveFormat.TEXT).trim();
          System.out.println("Exported Text: " + paragraphText);
  
          ListLabel label = paragraph.getListLabel();
          // This gets the position of the paragraph in current level of the list. If we have a list with multiple level then this
          // will tell us what position it is on that particular level
          System.out.println("Numerical Id: " + label.getLabelValue());
  
          // Combine them together to include the list label with the text in the output
          System.out.println("List label combined with text: " + label.getLabelString() + " " + paragraphText);
  
          listParaCount++;
      }
  }

• updatePageLayout

  public void updatePageLayout()
                       throws java.lang.Exception

  Rebuilds the page layout of the document.

  This method formats a document into pages and updates the page number related fields in the document such as PAGE, PAGES, PAGEREF and REF. The up-to-date page layout information is required for a correct rendering of the document to fixed-page formats.

  This method is automatically invoked when you first convert a document to PDF, XPS, image or print it. However, if you modify the document after rendering and then attempt to render it again - Aspose.Words will not update the page layout automatically. In this case you should call updatePageLayout() before rendering again.

  Example:

  Shows when to request page layout of the document to be recalculated.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // Saving a document to PDF or to image or printing for the first time will automatically
  // layout document pages and this information will be cached inside the document
  doc.save(getArtifactsDir() + "Rendering.UpdatePageLayout.1.pdf");
  
  // Modify the document in any way
  doc.getStyles().get("Normal").getFont().setSize(6.0);
  doc.getSections().get(0).getPageSetup().setOrientation(com.aspose.words.Orientation.LANDSCAPE);
  
  // In the current version of Aspose.Words, modifying the document does not automatically rebuild 
  // the cached page layout. If you want to save to PDF or render a modified document again,
  // you need to manually request page layout to be updated
  doc.updatePageLayout();
  
  doc.save(getArtifactsDir() + "Rendering.UpdatePageLayout.2.pdf");

• updateTableLayout

  public void updateTableLayout()

  Updates widths of cells and tables in the document according to their preferred widths and content. You do not need to call this method if the tables appear correct in the output document.

  You do not normally need to call this method as cell and table widths are maintained automatically. You can call this method before exporting to PDF (or any other fixed-page format), only in rare cases where you confirmed that tables appear incorrectly laid out in the output document. Calling this method might help to correct the output.

  Example:

  Shows how to update the layout of tables in a document.

  // Create a new document and insert a table
  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.insertCell();
  builder.write("Cell 1");
  builder.insertCell();
  builder.write("Cell 2");
  builder.insertCell();
  builder.write("Cell 3");
  
  // Create a SaveOptions object to prepare this document to be saved to .txt
  TxtSaveOptions options = new TxtSaveOptions();
  options.setPreserveTableLayout(true);
  
  // Previewing the appearance of the document in .txt form shows that the table will not be represented accurately
  Assert.assertEquals("CCC\r\neee\r\nlll\r\nlll\r\n   \r\n123\r\n\r\n", doc.toString(options));
  
  // We can call UpdateTableLayout() to fix some of these issues
  doc.updateTableLayout();
  
  Assert.assertEquals("Cell 1             Cell 2             Cell 3\r\n\r\n", doc.toString(options));

• updateThumbnail

  public void updateThumbnail()
                      throws java.lang.Exception

  Updates BuiltInDocumentProperties.Thumbnail of the document using default options.

  Example:

  Shows how to update a document's thumbnail.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // If we aren't setting the thumbnail via built in document properties,
  // we can set the first page of the document to be the thumbnail in an output .epub like this
  doc.updateThumbnail();
  doc.save(getArtifactsDir() + "Document.UpdateThumbnail.FirstPage.epub");
  
  // Another way is to use the first image shape found in the document as the thumbnail
  // Insert an image with a builder that we want to use as a thumbnail
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertImage(getImageDir() + "Logo.jpg");
  
  ThumbnailGeneratingOptions options = new ThumbnailGeneratingOptions();
  options.setThumbnailSize(new Dimension(400, 400));
  options.setGenerateFromFirstPage(false);
  
  doc.updateThumbnail(options);
  doc.save(getArtifactsDir() + "Document.UpdateThumbnail.FirstImage.epub");

• updateThumbnail

  public void updateThumbnail(ThumbnailGeneratingOptions options)
                      throws java.lang.Exception

  Updates BuiltInDocumentProperties.Thumbnail of the document according to the specified options.

  The ThumbnailGeneratingOptions allows you to specify the source of thumbnail, size and other options. If attempt to generate thumbnail fails, doesn't change one.

  Parameters:

  options - The generating options to use.

  Example:

  Shows how to update a document's thumbnail.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // If we aren't setting the thumbnail via built in document properties,
  // we can set the first page of the document to be the thumbnail in an output .epub like this
  doc.updateThumbnail();
  doc.save(getArtifactsDir() + "Document.UpdateThumbnail.FirstPage.epub");
  
  // Another way is to use the first image shape found in the document as the thumbnail
  // Insert an image with a builder that we want to use as a thumbnail
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertImage(getImageDir() + "Logo.jpg");
  
  ThumbnailGeneratingOptions options = new ThumbnailGeneratingOptions();
  options.setThumbnailSize(new Dimension(400, 400));
  options.setGenerateFromFirstPage(false);
  
  doc.updateThumbnail(options);
  doc.save(getArtifactsDir() + "Document.UpdateThumbnail.FirstImage.epub");

• updateWordCount

  public void updateWordCount()
                      throws java.lang.Exception

  Updates word count properties of the document.

  UpdateWordCount recalculates and updates Characters, Words and Paragraphs properties in the BuiltInDocumentProperties collection of the Document.

  Note that UpdateWordCount does not update number of lines and pages properties. Use the updateWordCount() overload and pass True value as a parameter to do that.

  When you use an evaluation version, the evaluation watermark will also be included in the word count.

  Example:

  Shows how to update all list labels in a document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add a paragraph of text to the document
  builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
                  "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
  builder.write("Ut enim ad minim veniam, " +
                  "quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.");
  
  // Document metrics are not tracked in code in real time
  Assert.assertEquals(0, doc.getBuiltInDocumentProperties().getCharacters());
  Assert.assertEquals(0, doc.getBuiltInDocumentProperties().getWords());
  Assert.assertEquals(1, doc.getBuiltInDocumentProperties().getParagraphs());
  Assert.assertEquals(1, doc.getBuiltInDocumentProperties().getLines());
  
  // We will need to call this method to update them
  doc.updateWordCount();
  
  // Check the values of the properties
  Assert.assertEquals(196, doc.getBuiltInDocumentProperties().getCharacters());
  Assert.assertEquals(36, doc.getBuiltInDocumentProperties().getWords());
  Assert.assertEquals(2, doc.getBuiltInDocumentProperties().getParagraphs());
  Assert.assertEquals(1, doc.getBuiltInDocumentProperties().getLines());
  
  // To also get the line count as it would appear in Microsoft Word,
  // we will need to pass "true" to UpdateWordCount()
  doc.updateWordCount(true);
  Assert.assertEquals(4, doc.getBuiltInDocumentProperties().getLines());

• updateWordCount

  public void updateWordCount(boolean updateLinesCount)
                      throws java.lang.Exception

  Updates word count properties of the document, optionally updates BuiltInDocumentProperties.Lines property.

  This method will rebuild page layout of the document.

  Parameters:

  updateLinesCount - True if number of lines in the document shall be calculated.

  Example:

  Shows how to update all list labels in a document.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Add a paragraph of text to the document
  builder.writeln("Lorem ipsum dolor sit amet, consectetur adipiscing elit, " +
                  "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.");
  builder.write("Ut enim ad minim veniam, " +
                  "quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.");
  
  // Document metrics are not tracked in code in real time
  Assert.assertEquals(0, doc.getBuiltInDocumentProperties().getCharacters());
  Assert.assertEquals(0, doc.getBuiltInDocumentProperties().getWords());
  Assert.assertEquals(1, doc.getBuiltInDocumentProperties().getParagraphs());
  Assert.assertEquals(1, doc.getBuiltInDocumentProperties().getLines());
  
  // We will need to call this method to update them
  doc.updateWordCount();
  
  // Check the values of the properties
  Assert.assertEquals(196, doc.getBuiltInDocumentProperties().getCharacters());
  Assert.assertEquals(36, doc.getBuiltInDocumentProperties().getWords());
  Assert.assertEquals(2, doc.getBuiltInDocumentProperties().getParagraphs());
  Assert.assertEquals(1, doc.getBuiltInDocumentProperties().getLines());
  
  // To also get the line count as it would appear in Microsoft Word,
  // we will need to pass "true" to UpdateWordCount()
  doc.updateWordCount(true);
  Assert.assertEquals(4, doc.getBuiltInDocumentProperties().getLines());