com.aspose.words

Constructor Detail

• StructuredDocumentTag

  public StructuredDocumentTag(DocumentBase doc, int type, int level)

  Initializes a new instance of the Structured document tag class.

  The following types of SDT can be created:

  • SdtType.CHECKBOX
  • SdtType.DROP_DOWN_LIST
  • SdtType.COMBO_BOX
  • SdtType.DATE
  • SdtType.BUILDING_BLOCK_GALLERY
  • SdtType.GROUP
  • SdtType.PICTURE
  • SdtType.RICH_TEXT
  • SdtType.PLAIN_TEXT

  Parameters:

  doc - The owner document.

  type - A SdtType value. Type of SDT node.

  level - A MarkupLevel value. Level of SDT node within the document.

  Example:

  Show how to create and insert checkbox structured document tag.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  StructuredDocumentTag sdtCheckBox = new StructuredDocumentTag(doc, SdtType.CHECKBOX, MarkupLevel.INLINE);
  sdtCheckBox.setChecked(true);
  
  // Insert content control into the document
  builder.insertNode(sdtCheckBox);

Property Getters/Setters Detail

• getBuildingBlockCategory/setBuildingBlockCategory

  public java.lang.String getBuildingBlockCategory() / public void setBuildingBlockCategory(java.lang.String value)
  

  Specifies category of building block for this SDT node. Can not be null.

  Accessing this property will only work for SdtType.BUILDING_BLOCK_GALLERY and SdtType.DOC_PART_OBJ SDT types. It is read-only for SDT of the document part type.

  For all other SDT types exception will occur.

  Example:

  Shows how to insert a StructuredDocumentTag as a building block and set its category and gallery.

  Document doc = new Document();
  
  StructuredDocumentTag buildingBlockSdt =
          new StructuredDocumentTag(doc, SdtType.BUILDING_BLOCK_GALLERY, MarkupLevel.BLOCK);
  buildingBlockSdt.setBuildingBlockCategory("Built-in");
  buildingBlockSdt.setBuildingBlockGallery("Table of Contents");
  
  doc.getFirstSection().getBody().appendChild(buildingBlockSdt);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.BuildingBlockCategories.docx");

• getBuildingBlockGallery/setBuildingBlockGallery

  public java.lang.String getBuildingBlockGallery() / public void setBuildingBlockGallery(java.lang.String value)
  

  Specifies type of building block for this SDT. Can not be null.

  Accessing this property will only work for SdtType.BUILDING_BLOCK_GALLERY and SdtType.DOC_PART_OBJ SDT types. It is read-only for SDT of the document part type.

  For all other SDT types exception will occur.

  Example:

  Shows how to insert a StructuredDocumentTag as a building block and set its category and gallery.

  Document doc = new Document();
  
  StructuredDocumentTag buildingBlockSdt =
          new StructuredDocumentTag(doc, SdtType.BUILDING_BLOCK_GALLERY, MarkupLevel.BLOCK);
  buildingBlockSdt.setBuildingBlockCategory("Built-in");
  buildingBlockSdt.setBuildingBlockGallery("Table of Contents");
  
  doc.getFirstSection().getBody().appendChild(buildingBlockSdt);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.BuildingBlockCategories.docx");

• getCalendarType/setCalendarType

  public int getCalendarType() / public void setCalendarType(int value)
  

  Specifies the type of calendar for this SDT. Default is SdtCalendarType.DEFAULTThe value of the property is SdtCalendarType integer constant.

  Accessing this property will only work for SdtType.DATE SDT type.

  For all other SDT types exception will occur.

  Example:

  Shows how to prompt the user to enter a date with a StructuredDocumentTag.

  // Create a new document
  Document doc = new Document();
  
  // Insert a StructuredDocumentTag that prompts the user to enter a date
  // In Microsoft Word, this element is known as a "Date picker content control"
  // When we click on the arrow on the right end of this tag in Microsoft Word,
  // we will see a pop up in the form of a clickable calendar
  // We can use that popup to select a date that will be displayed by the tag
  StructuredDocumentTag sdtDate = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.INLINE);
  
  // This attribute sets the language that the calendar will be displayed in,
  // which in this case will be Saudi Arabian Arabic
  sdtDate.setDateDisplayLocale(1025);
  
  // We can set the format with which to display the date like this
  // The locale we set above will be carried over to the displayed date
  sdtDate.setDateDisplayFormat("dd MMMM, yyyy");
  
  // Select how the data will be stored in the document
  sdtDate.setDateStorageFormat(SdtDateStorageFormat.DATE_TIME);
  
  // Set the calendar type that will be used to select and display the date
  sdtDate.setCalendarType(SdtCalendarType.HIJRI);
  
  // Before a date is chosen, the tag will display the text "Click here to enter a date."
  // We can set a default date to display by setting this variable
  // We must convert the date to the appropriate calendar ourselves
  Calendar cal = Calendar.getInstance();
  cal.set(1440, 10, 20);
  sdtDate.setFullDate(cal.getTime());
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(sdtDate);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.Date.docx");

• getChecked/setChecked

  public boolean getChecked() / public void setChecked(boolean value)
  

  Gets/Sets current state of the Checkbox SDT. Default value for this property is false.

  Accessing this property will only work for SdtType.CHECKBOX SDT types.

  For all other SDT types exception will occur.

  Example:

  Show how to create and insert checkbox structured document tag.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  StructuredDocumentTag sdtCheckBox = new StructuredDocumentTag(doc, SdtType.CHECKBOX, MarkupLevel.INLINE);
  sdtCheckBox.setChecked(true);
  
  // Insert content control into the document
  builder.insertNode(sdtCheckBox);

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

  Document doc = new Document();
  
  Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
  paragraph.appendChild(new Run(doc, "Hello world!"));
  paragraph.appendChild(new Run(doc, " Hello again!"));
  
  NodeCollection children = paragraph.getChildNodes();
  
  // Paragraph may contain children of various types such as runs, shapes and so on
  for (Node child : (Iterable<Node>) children)
      if (((child.getNodeType()) == (NodeType.RUN))) {
          Run run = (Run) child;
          System.out.println(run.getText());
      }

• getColor/setColor

  public java.awt.Color getColor() / public void setColor(java.awt.Color value)
  

  Gets or sets the color of the structured document tag.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.docx");

• getContentsFont

  public Font getContentsFont()
  

  Font formatting that will be applied to text entered into SDT.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.docx");

• getCount

  public int getCount()
  

  Gets the number of immediate children of this node.

  Example:

  Shows how to add, update and delete child nodes from a CompositeNode's child collection.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
  
  // 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("Initial text.", paragraph.getText().trim());
  
  // 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("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
  Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());
  
  // 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("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
  Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());

• getDateDisplayFormat/setDateDisplayFormat

  public java.lang.String getDateDisplayFormat() / public void setDateDisplayFormat(java.lang.String value)
  

  String that represents the format in which dates are displayed. Can not be null.

  Example:

  The dates for English (U.S.) is "mm/dd/yyyy"

  Accessing this property will only work for SdtType.DATE SDT type.

  For all other SDT types exception will occur.

  Example:

  Shows how to prompt the user to enter a date with a StructuredDocumentTag.

  // Create a new document
  Document doc = new Document();
  
  // Insert a StructuredDocumentTag that prompts the user to enter a date
  // In Microsoft Word, this element is known as a "Date picker content control"
  // When we click on the arrow on the right end of this tag in Microsoft Word,
  // we will see a pop up in the form of a clickable calendar
  // We can use that popup to select a date that will be displayed by the tag
  StructuredDocumentTag sdtDate = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.INLINE);
  
  // This attribute sets the language that the calendar will be displayed in,
  // which in this case will be Saudi Arabian Arabic
  sdtDate.setDateDisplayLocale(1025);
  
  // We can set the format with which to display the date like this
  // The locale we set above will be carried over to the displayed date
  sdtDate.setDateDisplayFormat("dd MMMM, yyyy");
  
  // Select how the data will be stored in the document
  sdtDate.setDateStorageFormat(SdtDateStorageFormat.DATE_TIME);
  
  // Set the calendar type that will be used to select and display the date
  sdtDate.setCalendarType(SdtCalendarType.HIJRI);
  
  // Before a date is chosen, the tag will display the text "Click here to enter a date."
  // We can set a default date to display by setting this variable
  // We must convert the date to the appropriate calendar ourselves
  Calendar cal = Calendar.getInstance();
  cal.set(1440, 10, 20);
  sdtDate.setFullDate(cal.getTime());
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(sdtDate);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.Date.docx");

• getDateDisplayLocale/setDateDisplayLocale

  public int getDateDisplayLocale() / public void setDateDisplayLocale(int value)
  

  Allows to set/get the language format for the date displayed in this SDT.

  Accessing this property will only work for SdtType.DATE SDT type.

  For all other SDT types exception will occur.

  Example:

  Shows how to prompt the user to enter a date with a StructuredDocumentTag.

  // Create a new document
  Document doc = new Document();
  
  // Insert a StructuredDocumentTag that prompts the user to enter a date
  // In Microsoft Word, this element is known as a "Date picker content control"
  // When we click on the arrow on the right end of this tag in Microsoft Word,
  // we will see a pop up in the form of a clickable calendar
  // We can use that popup to select a date that will be displayed by the tag
  StructuredDocumentTag sdtDate = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.INLINE);
  
  // This attribute sets the language that the calendar will be displayed in,
  // which in this case will be Saudi Arabian Arabic
  sdtDate.setDateDisplayLocale(1025);
  
  // We can set the format with which to display the date like this
  // The locale we set above will be carried over to the displayed date
  sdtDate.setDateDisplayFormat("dd MMMM, yyyy");
  
  // Select how the data will be stored in the document
  sdtDate.setDateStorageFormat(SdtDateStorageFormat.DATE_TIME);
  
  // Set the calendar type that will be used to select and display the date
  sdtDate.setCalendarType(SdtCalendarType.HIJRI);
  
  // Before a date is chosen, the tag will display the text "Click here to enter a date."
  // We can set a default date to display by setting this variable
  // We must convert the date to the appropriate calendar ourselves
  Calendar cal = Calendar.getInstance();
  cal.set(1440, 10, 20);
  sdtDate.setFullDate(cal.getTime());
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(sdtDate);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.Date.docx");

• getDateStorageFormat/setDateStorageFormat

  public int getDateStorageFormat() / public void setDateStorageFormat(int value)
  

  Gets/sets format in which the date for a date SDT is stored when the SDT is bound to an XML node in the document's data store. Default value is SdtDateStorageFormat.DATE_TIMEThe value of the property is SdtDateStorageFormat integer constant.

  Accessing this property will only work for SdtType.DATE SDT type.

  For all other SDT types exception will occur.

  Example:

  Shows how to prompt the user to enter a date with a StructuredDocumentTag.

  // Create a new document
  Document doc = new Document();
  
  // Insert a StructuredDocumentTag that prompts the user to enter a date
  // In Microsoft Word, this element is known as a "Date picker content control"
  // When we click on the arrow on the right end of this tag in Microsoft Word,
  // we will see a pop up in the form of a clickable calendar
  // We can use that popup to select a date that will be displayed by the tag
  StructuredDocumentTag sdtDate = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.INLINE);
  
  // This attribute sets the language that the calendar will be displayed in,
  // which in this case will be Saudi Arabian Arabic
  sdtDate.setDateDisplayLocale(1025);
  
  // We can set the format with which to display the date like this
  // The locale we set above will be carried over to the displayed date
  sdtDate.setDateDisplayFormat("dd MMMM, yyyy");
  
  // Select how the data will be stored in the document
  sdtDate.setDateStorageFormat(SdtDateStorageFormat.DATE_TIME);
  
  // Set the calendar type that will be used to select and display the date
  sdtDate.setCalendarType(SdtCalendarType.HIJRI);
  
  // Before a date is chosen, the tag will display the text "Click here to enter a date."
  // We can set a default date to display by setting this variable
  // We must convert the date to the appropriate calendar ourselves
  Calendar cal = Calendar.getInstance();
  cal.set(1440, 10, 20);
  sdtDate.setFullDate(cal.getTime());
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(sdtDate);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.Date.docx");

• getDocument

  public DocumentBase getDocument()
  

  Gets the document to which this node belongs.

  The node always belongs to a document even if it has just been created and not yet added to the tree, or if it has been removed from the tree.

  Example:

  Shows how to create a node and set its owning document.

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

• getEndCharacterFont

  public Font getEndCharacterFont()
  

  Font formatting that will be applied to the last character of text entered into SDT.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.docx");

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

  Document doc = new Document(getMyDir() + "Paragraphs.docx");
  
  // Loop starting from the first child until we reach null
  for (Node node = doc.getFirstSection().getBody().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 {
      Document doc = new Document(getMyDir() + "Paragraphs.docx");
  
      // Any node that can contain child nodes, such as the document itself, is composite
      Assert.assertTrue(doc.isComposite());
  
      // Invoke the recursive function that will go through and print all the child nodes of a composite node
      traverseAllNodes(doc, 0);
  }
  
  /// <summary>
  /// Recursively traverses a node tree while printing the type of each node with an indent depending on depth as well as the contents of all inline nodes.
  /// </summary>
  @Test(enabled = false)
  public void traverseAllNodes(CompositeNode parentNode, int depth) {
      // Loop through immediate children of a node
      for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
          System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));
  
          // Recurse into the node if it is a composite node
          if (childNode.isComposite()) {
              System.out.println();
              traverseAllNodes((CompositeNode) childNode, depth + 1);
          } else if (childNode instanceof Inline) {
              System.out.println(" - \"{childNode.GetText().Trim()}\"");
          } else {
              System.out.println();
          }
      }
  }

• getFullDate/setFullDate

  public java.util.Date getFullDate() / public void setFullDate(java.util.Date value)
  

  Specifies the full date and time last entered into this SDT.

  Accessing this property will only work for SdtType.DATE SDT type.

  For all other SDT types exception will occur.

  Example:

  Shows how to prompt the user to enter a date with a StructuredDocumentTag.

  // Create a new document
  Document doc = new Document();
  
  // Insert a StructuredDocumentTag that prompts the user to enter a date
  // In Microsoft Word, this element is known as a "Date picker content control"
  // When we click on the arrow on the right end of this tag in Microsoft Word,
  // we will see a pop up in the form of a clickable calendar
  // We can use that popup to select a date that will be displayed by the tag
  StructuredDocumentTag sdtDate = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.INLINE);
  
  // This attribute sets the language that the calendar will be displayed in,
  // which in this case will be Saudi Arabian Arabic
  sdtDate.setDateDisplayLocale(1025);
  
  // We can set the format with which to display the date like this
  // The locale we set above will be carried over to the displayed date
  sdtDate.setDateDisplayFormat("dd MMMM, yyyy");
  
  // Select how the data will be stored in the document
  sdtDate.setDateStorageFormat(SdtDateStorageFormat.DATE_TIME);
  
  // Set the calendar type that will be used to select and display the date
  sdtDate.setCalendarType(SdtCalendarType.HIJRI);
  
  // Before a date is chosen, the tag will display the text "Click here to enter a date."
  // We can set a default date to display by setting this variable
  // We must convert the date to the appropriate calendar ourselves
  Calendar cal = Calendar.getInstance();
  cal.set(1440, 10, 20);
  sdtDate.setFullDate(cal.getTime());
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(sdtDate);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.Date.docx");

• hasChildNodes

  public boolean hasChildNodes()
  

  Returns true if this node has any child nodes.

  Example:

  Shows how to combine the rows from two tables into one.

  // Load the document
  Document doc = new Document(getMyDir() + "Tables.docx");
  
  // Get the first and second table in the document
  // The rows from the second table will be appended to the end of the first table
  Table firstTable = (Table) doc.getChild(NodeType.TABLE, 0, true);
  Table secondTable = (Table) doc.getChild(NodeType.TABLE, 1, true);
  
  // Append all rows from the current table to the next
  // Due to the design of tables even tables with different cell count and widths can be joined into one table
  while (secondTable.hasChildNodes())
      firstTable.getRows().add(secondTable.getFirstRow());
  
  // Remove the empty table container
  secondTable.remove();
  
  doc.save(getArtifactsDir() + "Table.CombineTables.docx");

• getId

  public int getId()
  

  Specifies a unique read-only persistent numerical Id for this SDT.

  Id attribute shall follow these rules:

  • The document shall retain SDT ids only if the whole document is cloned Document.deepClone().
  • During DocumentBase.importNode(com.aspose.words.Node,boolean) Id shall be retained if import does not cause conflicts with other SDT Ids in the target document.
  • If multiple SDT nodes specify the same decimal number value for the Id attribute, then the first SDT in the document shall maintain this original Id, and all subsequent SDT nodes shall have new identifiers assigned to them when the document is loaded.
  • During standalone SDT Clone operation new unique ID will be generated for the cloned SDT node.
  • If Id is not specified in the source document, then the SDT node shall have a new unique identifier assigned to it when the document is loaded.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.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 {
      Document doc = new Document(getMyDir() + "Paragraphs.docx");
  
      // Any node that can contain child nodes, such as the document itself, is composite
      Assert.assertTrue(doc.isComposite());
  
      // Invoke the recursive function that will go through and print all the child nodes of a composite node
      traverseAllNodes(doc, 0);
  }
  
  /// <summary>
  /// Recursively traverses a node tree while printing the type of each node with an indent depending on depth as well as the contents of all inline nodes.
  /// </summary>
  @Test(enabled = false)
  public void traverseAllNodes(CompositeNode parentNode, int depth) {
      // Loop through immediate children of a node
      for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
          System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));
  
          // Recurse into the node if it is a composite node
          if (childNode.isComposite()) {
              System.out.println();
              traverseAllNodes((CompositeNode) childNode, depth + 1);
          } else if (childNode instanceof Inline) {
              System.out.println(" - \"{childNode.GetText().Trim()}\"");
          } else {
              System.out.println();
          }
      }
  }

• isShowingPlaceholderText/isShowingPlaceholderText

  public boolean isShowingPlaceholderText() / public void isShowingPlaceholderText(boolean value)
  

  Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).

  if set to true, this state shall be resumed (showing placeholder text) upon opening this document.

  Example:

  Shows how to use the contents of a BuildingBlock as a custom placeholder text for a StructuredDocumentTag.

  Document doc = new Document();
  
  // Insert a plain text StructuredDocumentTag of the PlainText type, which will function like a text box
  // It contains a default "Click here to enter text." prompt, which we can click and replace with our own text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // We can substitute that default placeholder with a custom phrase, which will be drawn from a BuildingBlock
  // First we will need to create the BuildingBlock, give it content and add it to the GlossaryDocument
  GlossaryDocument glossaryDoc = doc.getGlossaryDocument();
  
  BuildingBlock substituteBlock = new BuildingBlock(glossaryDoc);
  substituteBlock.setName("Custom Placeholder");
  substituteBlock.appendChild(new Section(glossaryDoc));
  substituteBlock.getFirstSection().appendChild(new Body(glossaryDoc));
  substituteBlock.getFirstSection().getBody().appendParagraph("Custom placeholder text.");
  
  glossaryDoc.appendChild(substituteBlock);
  
  // The substitute BuildingBlock we made can be referenced by name
  tag.setPlaceholderName("Custom Placeholder");
  
  // If PlaceholderName refers to an existing block in the parent document's GlossaryDocument,
  // the BuildingBlock will be automatically found and assigned to the Placeholder attribute
  Assert.assertEquals(tag.getPlaceholder(), substituteBlock);
  
  // Setting this to true will register the text inside the StructuredDocumentTag as placeholder text
  // This means that, in Microsoft Word, all the text contents of the StructuredDocumentTag will be highlighted with one click,
  // so we can immediately replace the entire substitute text by typing
  // If this is false, the text will behave like an ordinary Paragraph and a cursor will be placed with nothing highlighted
  tag.isShowingPlaceholderText(true);
  
  // Insert the StructuredDocumentTag into the document using a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlaceholderBuildingBlock.docx");

• isTemporary/isTemporary

  public boolean isTemporary() / public void isTemporary(boolean value)
  

  Specifies whether this SDT shall be removed from the WordProcessingML document when its contents are modified.

  Example:

  Demonstrates the effects of making a StructuredDocumentTag temporary.

  // Create a new Document
  Document doc = new Document();
  
  // Insert a plain text StructuredDocumentTag, which will prompt the user to enter text
  // and allow them to edit it like a text box
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // If we set its Temporary attribute to true, as soon as we start typing,
  // the tag will disappear and its contents will be assimilated into the parent Paragraph
  tag.isTemporary(true);
  
  // Insert the StructuredDocumentTag with a DocumentBuilder
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.write("Temporary text box: ");
  builder.insertNode(tag);
  
  // A StructuredDocumentTag in the form of a check box will let the user a square to check and uncheck
  // Setting it to temporary will freeze its value after the first time it is clicked
  tag = new StructuredDocumentTag(doc, SdtType.CHECKBOX, MarkupLevel.INLINE);
  tag.isTemporary(true);
  
  builder.write("\nTemporary checkbox: ");
  builder.insertNode(tag);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.IsTemporary.docx");

• 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 doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Create a second section by inserting a section break and add text to both sections
  builder.writeln("Section 1 text.");
  builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
  builder.writeln("Section 2 text.");
  
  // Both sections are siblings of each other
  Section lastSection = (Section) doc.getLastChild();
  Section firstSection = (Section) lastSection.getPreviousSibling();
  
  // Remove a section based on its sibling relationship with another section
  if (lastSection.getPreviousSibling() != null)
      doc.removeChild(firstSection);
  
  // The section we removed was the first one, leaving the document with only the second
  Assert.assertEquals("Section 2 text.", doc.getText().trim());

• getLevel

  public int getLevel()
  

  Gets the level at which this SDT occurs in the document tree. The value of the property is MarkupLevel integer constant.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.docx");

• getListItems

  public SdtListItemCollection getListItems()
  

  Gets SdtListItemCollection associated with this SDT.

  Accessing this property will only work for SdtType.COMBO_BOX or SdtType.DROP_DOWN_LIST SDT types.

  For all other SDT types exception will occur.

  Example:

  Shows how to work with StructuredDocumentTag nodes of the DropDownList type.

  // Create a blank document and insert a StructuredDocumentTag that will contain a drop down list
  Document doc = new Document();
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
  doc.getFirstSection().getBody().appendChild(tag);
  
  // A drop down list needs elements, each of which will be a SdtListItem
  SdtListItemCollection listItems = tag.getListItems();
  listItems.add(new SdtListItem("Value 1"));
  
  // Each SdtListItem has text that will be displayed when the drop down list is opened, and also a value
  // When we initialize with one string, we are providing just the value
  // Accordingly, value is passed as DisplayText and will consequently be displayed on the screen
  Assert.assertEquals(listItems.get(0).getValue(), listItems.get(0).getDisplayText());
  
  // Add 3 more SdtListItems with non-empty strings passed to DisplayText
  listItems.add(new SdtListItem("Item 2", "Value 2"));
  listItems.add(new SdtListItem("Item 3", "Value 3"));
  listItems.add(new SdtListItem("Item 4", "Value 4"));
  
  // We can obtain a count of the SdtListItems and also set the drop down list's SelectedValue attribute to
  // automatically have one of them pre-selected when we open the document in Microsoft Word
  Assert.assertEquals(listItems.getCount(), 4);
  listItems.setSelectedValue(listItems.get(3));
  
  Assert.assertEquals(listItems.getSelectedValue().getValue(), "Value 4");
  
  // We can enumerate over the collection and print each element
  Iterator<SdtListItem> enumerator = listItems.iterator();
  while (enumerator.hasNext()) {
      SdtListItem sdtListItem = enumerator.next();
      System.out.println(MessageFormat.format("List item: {0}, value: {1}", sdtListItem.getDisplayText(), sdtListItem.getValue()));
  }
  
  // We can also remove elements one at a time
  listItems.removeAt(3);
  Assert.assertEquals(listItems.getCount(), 3);
  
  // Make sure to update the SelectedValue's index if it ever ends up out of bounds before saving the document
  listItems.setSelectedValue(listItems.get(1));
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.ListItemCollection.docx");
  
  // We can clear the whole collection at once too
  listItems.clear();
  Assert.assertEquals(listItems.getCount(), 0);

• getLockContentControl/setLockContentControl

  public boolean getLockContentControl() / public void setLockContentControl(boolean value)
  

  When set to true, this property will prohibit a user from deleting this SDT.

  Example:

  Shows how to restrict the editing of a StructuredDocumentTag.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a plain text StructuredDocumentTag of the PlainText type, which will function like a text box
  // It contains a default "Click here to enter text." prompt, which we can click and replace with our own text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // We can prohibit the users from editing the inner text in Microsoft Word by setting this to true
  tag.setLockContents(true);
  builder.write("The contents of this StructuredDocumentTag cannot be edited: ");
  builder.insertNode(tag);
  
  tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Setting this to true will disable the deletion of this StructuredDocumentTag
  // by text editing operations in Microsoft Word
  tag.setLockContentControl(true);
  
  builder.insertParagraph();
  builder.write("This StructuredDocumentTag cannot be deleted but its contents can be edited: ");
  builder.insertNode(tag);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.Lock.docx");

• getLockContents/setLockContents

  public boolean getLockContents() / public void setLockContents(boolean value)
  

  When set to true, this property will prohibit a user from editing the contents of this SDT.

  Example:

  Shows how to restrict the editing of a StructuredDocumentTag.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a plain text StructuredDocumentTag of the PlainText type, which will function like a text box
  // It contains a default "Click here to enter text." prompt, which we can click and replace with our own text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // We can prohibit the users from editing the inner text in Microsoft Word by setting this to true
  tag.setLockContents(true);
  builder.write("The contents of this StructuredDocumentTag cannot be edited: ");
  builder.insertNode(tag);
  
  tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Setting this to true will disable the deletion of this StructuredDocumentTag
  // by text editing operations in Microsoft Word
  tag.setLockContentControl(true);
  
  builder.insertParagraph();
  builder.write("This StructuredDocumentTag cannot be deleted but its contents can be edited: ");
  builder.insertNode(tag);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.Lock.docx");

• getMultiline/setMultiline

  public boolean getMultiline() / public void setMultiline(boolean value)
  

  Specifies whether this SDT allows multiple lines of text.

  Accessing this property will only work for SdtType.RICH_TEXT and SdtType.PLAIN_TEXT SDT type.

  For all other SDT types exception will occur.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.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.

  Document doc = new Document(getMyDir() + "Paragraphs.docx");
  
  // Loop starting from the first child until we reach null
  for (Node node = doc.getFirstSection().getBody().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 {
      Document doc = new Document(getMyDir() + "Paragraphs.docx");
  
      // Any node that can contain child nodes, such as the document itself, is composite
      Assert.assertTrue(doc.isComposite());
  
      // Invoke the recursive function that will go through and print all the child nodes of a composite node
      traverseAllNodes(doc, 0);
  }
  
  /// <summary>
  /// Recursively traverses a node tree while printing the type of each node with an indent depending on depth as well as the contents of all inline nodes.
  /// </summary>
  @Test(enabled = false)
  public void traverseAllNodes(CompositeNode parentNode, int depth) {
      // Loop through immediate children of a node
      for (Node childNode = parentNode.getFirstChild(); childNode != null; childNode = childNode.getNextSibling()) {
          System.out.println(MessageFormat.format("{0}{1}", String.format("    ", depth), Node.nodeTypeToString(childNode.getNodeType())));
  
          // Recurse into the node if it is a composite node
          if (childNode.isComposite()) {
              System.out.println();
              traverseAllNodes((CompositeNode) childNode, depth + 1);
          } else if (childNode instanceof Inline) {
              System.out.println(" - \"{childNode.GetText().Trim()}\"");
          } else {
              System.out.println();
          }
      }
  }

• getNodeType

  public int getNodeType()
  

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

  Example:

  Shows how to work with styles for content control elements.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Get specific style from the document to apply it to an SDT
  Style quoteStyle = doc.getStyles().getByStyleIdentifier(StyleIdentifier.QUOTE);
  StructuredDocumentTag sdtPlainText = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  sdtPlainText.setStyle(quoteStyle);
  
  StructuredDocumentTag sdtRichText = new StructuredDocumentTag(doc, SdtType.RICH_TEXT, MarkupLevel.INLINE);
  // Second method to apply specific style to an SDT control
  sdtRichText.setStyleName("Quote");
  
  // Insert content controls into the document
  builder.insertNode(sdtPlainText);
  builder.insertNode(sdtRichText);
  
  // We can get a collection of StructuredDocumentTags by looking for the document's child nodes of this NodeType
  Assert.assertEquals(sdtPlainText.getNodeType(), NodeType.STRUCTURED_DOCUMENT_TAG);
  
  NodeCollection tags = doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG, true);
  
  for (StructuredDocumentTag sdt : (Iterable<StructuredDocumentTag>) tags) {
      // If style was not defined before, style should be "Default Paragraph Font"
      Assert.assertEquals(StyleIdentifier.QUOTE, sdt.getStyle().getStyleIdentifier());
      Assert.assertEquals("Quote", sdt.getStyleName());
  }

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

  Document doc = new Document();
  
  // Get the document's first paragraph and append a child node to it in the form of a run with text
  Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
  
  // When inserting a new node, the document that the node will belong to must be provided as an argument
  Run run = new Run(doc, "Hello world!");
  para.appendChild(run);
  
  // The node lineage can be traced back to the document itself
  Assert.assertEquals(para, run.getParentNode());
  Assert.assertEquals(doc.getFirstSection().getBody(), para.getParentNode());
  Assert.assertEquals(doc.getFirstSection(), doc.getFirstSection().getBody().getParentNode());
  Assert.assertEquals(doc, doc.getFirstSection().getParentNode());

  Example:

  Shows how to create a node and set its owning document.

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

• getPlaceholder

  public BuildingBlock getPlaceholder()
  

  Gets the BuildingBlock containing placeholder text which should be displayed when this SDT run contents are empty, the associated mapped XML element is empty as specified via the XmlMapping element or the IsShowingPlaceholderText element is true.

  Can be null, meaning that the placeholder is not applicable for this Sdt.

  Example:

  Shows how to use the contents of a BuildingBlock as a custom placeholder text for a StructuredDocumentTag.

  Document doc = new Document();
  
  // Insert a plain text StructuredDocumentTag of the PlainText type, which will function like a text box
  // It contains a default "Click here to enter text." prompt, which we can click and replace with our own text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // We can substitute that default placeholder with a custom phrase, which will be drawn from a BuildingBlock
  // First we will need to create the BuildingBlock, give it content and add it to the GlossaryDocument
  GlossaryDocument glossaryDoc = doc.getGlossaryDocument();
  
  BuildingBlock substituteBlock = new BuildingBlock(glossaryDoc);
  substituteBlock.setName("Custom Placeholder");
  substituteBlock.appendChild(new Section(glossaryDoc));
  substituteBlock.getFirstSection().appendChild(new Body(glossaryDoc));
  substituteBlock.getFirstSection().getBody().appendParagraph("Custom placeholder text.");
  
  glossaryDoc.appendChild(substituteBlock);
  
  // The substitute BuildingBlock we made can be referenced by name
  tag.setPlaceholderName("Custom Placeholder");
  
  // If PlaceholderName refers to an existing block in the parent document's GlossaryDocument,
  // the BuildingBlock will be automatically found and assigned to the Placeholder attribute
  Assert.assertEquals(tag.getPlaceholder(), substituteBlock);
  
  // Setting this to true will register the text inside the StructuredDocumentTag as placeholder text
  // This means that, in Microsoft Word, all the text contents of the StructuredDocumentTag will be highlighted with one click,
  // so we can immediately replace the entire substitute text by typing
  // If this is false, the text will behave like an ordinary Paragraph and a cursor will be placed with nothing highlighted
  tag.isShowingPlaceholderText(true);
  
  // Insert the StructuredDocumentTag into the document using a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlaceholderBuildingBlock.docx");

• getPlaceholderName/setPlaceholderName

  public java.lang.String getPlaceholderName() / public void setPlaceholderName(java.lang.String value)
  

  Gets or sets Name of the BuildingBlock containing placeholder text.

  BuildingBlock with this name BuildingBlock.Name has to be present in the Document.GlossaryDocument otherwise System.InvalidOperationException will occur.

  Example:

  Shows how to use the contents of a BuildingBlock as a custom placeholder text for a StructuredDocumentTag.

  Document doc = new Document();
  
  // Insert a plain text StructuredDocumentTag of the PlainText type, which will function like a text box
  // It contains a default "Click here to enter text." prompt, which we can click and replace with our own text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // We can substitute that default placeholder with a custom phrase, which will be drawn from a BuildingBlock
  // First we will need to create the BuildingBlock, give it content and add it to the GlossaryDocument
  GlossaryDocument glossaryDoc = doc.getGlossaryDocument();
  
  BuildingBlock substituteBlock = new BuildingBlock(glossaryDoc);
  substituteBlock.setName("Custom Placeholder");
  substituteBlock.appendChild(new Section(glossaryDoc));
  substituteBlock.getFirstSection().appendChild(new Body(glossaryDoc));
  substituteBlock.getFirstSection().getBody().appendParagraph("Custom placeholder text.");
  
  glossaryDoc.appendChild(substituteBlock);
  
  // The substitute BuildingBlock we made can be referenced by name
  tag.setPlaceholderName("Custom Placeholder");
  
  // If PlaceholderName refers to an existing block in the parent document's GlossaryDocument,
  // the BuildingBlock will be automatically found and assigned to the Placeholder attribute
  Assert.assertEquals(tag.getPlaceholder(), substituteBlock);
  
  // Setting this to true will register the text inside the StructuredDocumentTag as placeholder text
  // This means that, in Microsoft Word, all the text contents of the StructuredDocumentTag will be highlighted with one click,
  // so we can immediately replace the entire substitute text by typing
  // If this is false, the text will behave like an ordinary Paragraph and a cursor will be placed with nothing highlighted
  tag.isShowingPlaceholderText(true);
  
  // Insert the StructuredDocumentTag into the document using a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlaceholderBuildingBlock.docx");

• 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 doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Create a second section by inserting a section break and add text to both sections
  builder.writeln("Section 1 text.");
  builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
  builder.writeln("Section 2 text.");
  
  // Both sections are siblings of each other
  Section lastSection = (Section) doc.getLastChild();
  Section firstSection = (Section) lastSection.getPreviousSibling();
  
  // Remove a section based on its sibling relationship with another section
  if (lastSection.getPreviousSibling() != null)
      doc.removeChild(firstSection);
  
  // The section we removed was the first one, leaving the document with only the second
  Assert.assertEquals("Section 2 text.", doc.getText().trim());

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

• getSdtType

  public int getSdtType()
  

  Gets type of this Structured document tag. The value of the property is SdtType integer constant.

• getStyle/setStyle

  public Style getStyle() / public void setStyle(Style value)
  

  Gets or sets the Style of the structured document tag.

  Only StyleType.CHARACTER style or StyleType.PARAGRAPH style with linked character style can be set.

  Example:

  Shows how to work with styles for content control elements.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Get specific style from the document to apply it to an SDT
  Style quoteStyle = doc.getStyles().getByStyleIdentifier(StyleIdentifier.QUOTE);
  StructuredDocumentTag sdtPlainText = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  sdtPlainText.setStyle(quoteStyle);
  
  StructuredDocumentTag sdtRichText = new StructuredDocumentTag(doc, SdtType.RICH_TEXT, MarkupLevel.INLINE);
  // Second method to apply specific style to an SDT control
  sdtRichText.setStyleName("Quote");
  
  // Insert content controls into the document
  builder.insertNode(sdtPlainText);
  builder.insertNode(sdtRichText);
  
  // We can get a collection of StructuredDocumentTags by looking for the document's child nodes of this NodeType
  Assert.assertEquals(sdtPlainText.getNodeType(), NodeType.STRUCTURED_DOCUMENT_TAG);
  
  NodeCollection tags = doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG, true);
  
  for (StructuredDocumentTag sdt : (Iterable<StructuredDocumentTag>) tags) {
      // If style was not defined before, style should be "Default Paragraph Font"
      Assert.assertEquals(StyleIdentifier.QUOTE, sdt.getStyle().getStyleIdentifier());
      Assert.assertEquals("Quote", sdt.getStyleName());
  }

• getStyleName/setStyleName

  public java.lang.String getStyleName() / public void setStyleName(java.lang.String value)
  

  Gets or sets the name of the style applied to the structured document tag.

  Example:

  Shows how to work with styles for content control elements.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Get specific style from the document to apply it to an SDT
  Style quoteStyle = doc.getStyles().getByStyleIdentifier(StyleIdentifier.QUOTE);
  StructuredDocumentTag sdtPlainText = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  sdtPlainText.setStyle(quoteStyle);
  
  StructuredDocumentTag sdtRichText = new StructuredDocumentTag(doc, SdtType.RICH_TEXT, MarkupLevel.INLINE);
  // Second method to apply specific style to an SDT control
  sdtRichText.setStyleName("Quote");
  
  // Insert content controls into the document
  builder.insertNode(sdtPlainText);
  builder.insertNode(sdtRichText);
  
  // We can get a collection of StructuredDocumentTags by looking for the document's child nodes of this NodeType
  Assert.assertEquals(sdtPlainText.getNodeType(), NodeType.STRUCTURED_DOCUMENT_TAG);
  
  NodeCollection tags = doc.getChildNodes(NodeType.STRUCTURED_DOCUMENT_TAG, true);
  
  for (StructuredDocumentTag sdt : (Iterable<StructuredDocumentTag>) tags) {
      // If style was not defined before, style should be "Default Paragraph Font"
      Assert.assertEquals(StyleIdentifier.QUOTE, sdt.getStyle().getStyleIdentifier());
      Assert.assertEquals("Quote", sdt.getStyleName());
  }

• getTag/setTag

  public java.lang.String getTag() / public void setTag(java.lang.String value)
  

  Specifies a tag associated with the current SDT node. Can not be null.

  A tag is an arbitrary string which applications can associate with SDT in order to identify it without providing a visible friendly name.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.docx");

• getTitle/setTitle

  public java.lang.String getTitle() / public void setTitle(java.lang.String value)
  

  Specifies the friendly name associated with this SDT. Can not be null.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.docx");

• getXmlMapping

  public XmlMapping getXmlMapping()
  

  Gets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.

  You can use the XmlMapping.setMapping(com.aspose.words.CustomXmlPart,java.lang.String,java.lang.String) method of this object to map a structured document tag to XML data.

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

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.visitStructuredDocumentTagStart(com.aspose.words.StructuredDocumentTag), then calls accept(com.aspose.words.DocumentVisitor) for all child nodes of the smart tag and calls DocumentVisitor.visitStructuredDocumentTagEnd(com.aspose.words.StructuredDocumentTag) 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:

  Shows how to print the node structure of every structured document tag in a document.

  public void structuredDocumentTagToText() throws Exception {
      Document doc = new Document(getMyDir() + "DocumentVisitor-compatible features.docx");
      StructuredDocumentTagNodePrinter visitor = new StructuredDocumentTagNodePrinter();
  
      // When we get a composite node to accept a document visitor, the visitor visits the accepting node,
      // and then traverses all of the node's children in a depth-first manner.
      // The visitor can read and modify each visited node.
      doc.accept(visitor);
  
      System.out.println(visitor.getText());
  }
  
  /// <summary>
  /// Traverses a node's non-binary tree of child nodes.
  /// Creates a map in the form of a string of all encountered StructuredDocumentTag nodes and their children.
  /// </summary>
  public static class StructuredDocumentTagNodePrinter extends DocumentVisitor {
      public StructuredDocumentTagNodePrinter() {
          mBuilder = new StringBuilder();
          mVisitorIsInsideStructuredDocumentTag = false;
      }
  
      /// <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 Run node is encountered in the document.
      /// </summary>
      public int visitRun(final Run run) {
          if (mVisitorIsInsideStructuredDocumentTag) {
              indentAndAppendLine("[Run] \"" + run.getText() + "\"");
          }
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called when a StructuredDocumentTag node is encountered in the document.
      /// </summary>
      public int visitStructuredDocumentTagStart(final StructuredDocumentTag sdt) {
          indentAndAppendLine("[StructuredDocumentTag start] Title: " + sdt.getTitle());
          mDocTraversalDepth++;
  
          return VisitorAction.CONTINUE;
      }
  
      /// <summary>
      /// Called after all the child nodes of a StructuredDocumentTag node have been visited.
      /// </summary>
      public int visitStructuredDocumentTagEnd(final StructuredDocumentTag sdt) {
          mDocTraversalDepth--;
          indentAndAppendLine("[StructuredDocumentTag end]");
  
          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 boolean mVisitorIsInsideStructuredDocumentTag;
      private int mDocTraversalDepth;
      private StringBuilder mBuilder;
  }

• 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 DocumentBase.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 construct an Aspose Words document node by node.

  Document doc = new Document();
  
  // A newly created blank document still comes one section, one body and one paragraph
  // Calling this method will remove all those nodes to completely empty the document
  doc.removeAllChildren();
  
  // This document now has no composite nodes that content can be added to
  // If we wish to edit it, we will need to repopulate its node collection,
  // which we will start to do with by creating a new Section node
  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);
  
  // A section needs a body, which will contain all other nodes that can be edited
  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);
  
  // Now we can begin adding content to the document
  Run run = new Run(doc);
  run.setText("Hello World!");
  run.getFont().setColor(Color.RED);
  para.appendChild(run);
  
  Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText());
  
  doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");

• clear

  public void clear()
            throws java.lang.Exception

  Clears contents of this structured document tag and displays a placeholder if it is defined.

  It is not possible to clear contents of a structured document tag if it has revisions.

  If this structured document tag is mapped to custom XML (with using the XmlMapping property), the referenced XML node is cleared.

  Example:

  Shows how to delete content of StructuredDocumentTag elements.

  Document doc = new Document();
  
  // Create a plain text structured document tag and append it to the document
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.BLOCK);
  doc.getFirstSection().getBody().appendChild(tag);
  
  // This structured document tag, which is in the form of a text box, already displays placeholder text
  Assert.assertEquals("Click here to enter text.", tag.getText().trim());
  Assert.assertTrue(tag.isShowingPlaceholderText());
  
  // Create a building block that 
  GlossaryDocument glossaryDoc = doc.getGlossaryDocument();
  BuildingBlock substituteBlock = new BuildingBlock(glossaryDoc);
  substituteBlock.setName("My placeholder");
  substituteBlock.appendChild(new Section(glossaryDoc));
  substituteBlock.getFirstSection().ensureMinimum();
  substituteBlock.getFirstSection().getBody().getFirstParagraph().appendChild(new Run(glossaryDoc, "Custom placeholder text."));
  glossaryDoc.appendChild(substituteBlock);
  
  // Set the tag's placeholder to the building block
  tag.setPlaceholderName("My placeholder");
  
  Assert.assertEquals("Custom placeholder text.", tag.getText().trim());
  Assert.assertTrue(tag.isShowingPlaceholderText());
  
  // Edit the text of the structured document tag and disable showing of placeholder text
  Run run = (Run) tag.getChild(NodeType.RUN, 0, true);
  run.setText("New text.");
  tag.isShowingPlaceholderText(false);
  
  Assert.assertEquals("New text.", tag.getText().trim());
  
  tag.clear();
  
  // Clearing a PlainText tag reverts these changes
  Assert.assertTrue(tag.isShowingPlaceholderText());
  Assert.assertEquals("Custom placeholder text.", tag.getText().trim());

• deepClone

  public Node deepClone(boolean isCloneChildren)

  Creates a duplicate of the node.

  This method serves as a copy constructor for nodes. The cloned node has no parent, but belongs to the same document as the original node.

  This method always performs a deep copy of the node. The isCloneChildren parameter specifies whether to perform copy all child nodes as well.

  Parameters:

  isCloneChildren - True to recursively clone the subtree under the specified node; false to clone only the node itself.

  Returns:

  The cloned node.

  Example:

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

  Document doc = new Document();
  Paragraph para = doc.getFirstSection().getBody().getFirstParagraph();
  para.appendChild(new Run(doc, "Hello world!"));
  
  // Clone the paragraph and the child nodes
  Node cloneWithChildren = para.deepClone(true);
  
  Assert.assertTrue(((CompositeNode) cloneWithChildren).hasChildNodes());
  Assert.assertEquals("Hello world!", cloneWithChildren.getText().trim());
  
  // Clone the paragraph without its clild nodes
  Node cloneWithoutChildren = para.deepClone(false);
  
  Assert.assertFalse(((CompositeNode) cloneWithoutChildren).hasChildNodes());
  Assert.assertEquals("", cloneWithoutChildren.getText().trim());

• 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");
      NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
  
      for (int i = 0; i < tables.getCount(); i++) {
          // First lets find if any cells in the table have tables themselves as children
          int count = getChildTableCount((Table) tables.get(i));
          System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, 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) tables.get(i));
  
          if (tableDepth > 0)
              System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
          else
              System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
      }
  }
  
  /**
   * 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");
      NodeCollection tables = doc.getChildNodes(NodeType.TABLE, true);
  
      for (int i = 0; i < tables.getCount(); i++) {
          // First lets find if any cells in the table have tables themselves as children
          int count = getChildTableCount((Table) tables.get(i));
          System.out.println(MessageFormat.format("Table #{0} has {1} tables directly within its cells", i, 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) tables.get(i));
  
          if (tableDepth > 0)
              System.out.println(MessageFormat.format("Table #{0} is nested inside another table at depth of {1}", i, tableDepth));
          else
              System.out.println(MessageFormat.format("Table #{0} is a non nested table (is not a child of another table)", i));
      }
  }
  
  /**
   * 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 apply attributes of a table's style directly to the table's elements.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  Table table = builder.startTable();
  builder.insertCell();
  builder.write("Hello world!");
  builder.endTable();
  
  TableStyle tableStyle = (TableStyle)doc.getStyles().add(StyleType.TABLE, "MyTableStyle1");
  tableStyle.setRowStripe(3);
  tableStyle.setCellSpacing(5.0);
  tableStyle.getShading().setBackgroundPatternColor(Color.WHITE);
  tableStyle.getBorders().setColor(Color.BLUE);
  tableStyle.getBorders().setLineStyle(LineStyle.DOT_DASH);
  
  table.setStyle(tableStyle);
  
  // This method concerns table style attributes such as the ones we set above.
  doc.expandTableStylesToDirectFormatting();
  
  doc.save(getArtifactsDir() + "Document.TableStyleToDirectFormatting.docx");

  Example:

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

  Document doc = new Document();
  
  Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
  paragraph.appendChild(new Run(doc, "Hello world!"));
  paragraph.appendChild(new Run(doc, " Hello again!"));
  
  NodeCollection children = paragraph.getChildNodes();
  
  // Paragraph may contain children of various types such as runs, shapes and so on
  for (Node child : (Iterable<Node>) children)
      if (((child.getNodeType()) == (NodeType.RUN))) {
          Run run = (Run) child;
          System.out.println(run.getText());
      }

• 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 print all of a document's comments and their replies.

  Document doc = new Document(getMyDir() + "Comments.docx");
  
  NodeCollection comments = doc.getChildNodes(NodeType.COMMENT, true);
  
  // If a comment has no ancestor, it is a "top-level" comment as opposed to a reply-type comment.
  // Print all top-level comments along with their replies, if there are any.
  for (Comment comment : (Iterable<Comment>) comments)
  {
      if (comment.getAncestor() == null) {
          System.out.println("Top-level comment:");
          System.out.println("\t\"{comment.GetText().Trim()}\", by {comment.Author}");
          System.out.println("Has {comment.Replies.Count} replies");
          for (Comment commentReply : (Iterable<Comment>) comment.getReplies()) {
              System.out.println("\t\"{commentReply.GetText().Trim()}\", by {commentReply.Author}");
          }
          System.out.println();
      }
  }

  Example:

  Shows how to extract images from a document, and save them to the local file system as individual files.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  // Get the collection of shapes from the document,
  // and save the image data of every shape with an image as a file to the local file system.
  NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
  
  int imageIndex = 0;
  for (Shape shape : (Iterable<Shape>) shapes) {
      if (shape.hasImage()) {
          // The image data of shapes may contain images of many possible image formats. 
          // We can determine a file extension for each image automatically, based on its format.
          String imageFileName = MessageFormat.format("File.ExtractImages.{0}{1}", imageIndex, FileFormatUtil.imageTypeToExtension(shape.getImageData().getImageType()));
          shape.getImageData().save(getArtifactsDir() + imageFileName);
          imageIndex++;
      }
  }

• 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 how to output all paragraphs in a document that are bulleted or numbered.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.getListFormat().applyNumberDefault();
  builder.writeln("Numbered list item 1");
  builder.writeln("Numbered list item 2");
  builder.writeln("Numbered list item 3");
  builder.getListFormat().removeNumbers();
  
  builder.getListFormat().applyBulletDefault();
  builder.writeln("Bulleted list item 1");
  builder.writeln("Bulleted list item 2");
  builder.writeln("Bulleted list item 3");
  builder.getListFormat().removeNumbers();
  
  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());
      }
  }

  Example:

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

  Document doc = new Document();
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertField("MERGEFIELD Field");
  
  // GetText will retrieve the visible text as well as field codes and special characters.
  Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
  
  // ToString will give us the document's appearance if saved to a passed save format.
  Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));

• 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
  Assert.assertEquals(24, 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 DocumentBase.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 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.docx");

  Example:

  Shows how to add, update and delete child nodes from a CompositeNode's child collection.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
  
  // 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("Initial text.", paragraph.getText().trim());
  
  // 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("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
  Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());
  
  // 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("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
  Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());

• 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 DocumentBase.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 a CompositeNode's child collection.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
  
  // 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("Initial text.", paragraph.getText().trim());
  
  // 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("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
  Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());
  
  // 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("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
  Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());

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

  Document doc = new Document();
  
  Paragraph paragraph = (Paragraph) doc.getChild(NodeType.PARAGRAPH, 0, true);
  paragraph.appendChild(new Run(doc, "Hello world!"));
  paragraph.appendChild(new Run(doc, " Hello again!"));
  
  NodeCollection children = paragraph.getChildNodes();
  
  // Paragraph may contain children of various types such as runs, shapes and so on
  for (Node child : (Iterable<Node>) children)
      if (((child.getNodeType()) == (NodeType.RUN))) {
          Run run = (Run) child;
          System.out.println(run.getText());
      }

• 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;
  }
  
  // The only remaining shape doesn't have an image
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());

• 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 DocumentBase.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 a CompositeNode's child collection.

  Document doc = new Document();
  
  // An empty document has one paragraph by default
  Assert.assertEquals(1, doc.getFirstSection().getBody().getParagraphs().getCount());
  
  // 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("Initial text.", paragraph.getText().trim());
  
  // 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("Run 1. Run 2. Initial text. Run 3.", paragraph.getText().trim());
  Assert.assertEquals(4, paragraph.getChildNodes(NodeType.ANY, true).getCount());
  
  // 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("Run 1. Updated run 2. Run 3.", paragraph.getText().trim());
  Assert.assertEquals(3, paragraph.getChildNodes(NodeType.ANY, true).getCount());

• 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;
  }
  
  // The only remaining shape doesn't have an image
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());

• remove

  public void remove()

  Removes itself from the parent.

  Example:

  Shows how to delete all images from a document.

  Document doc = new Document(getMyDir() + "Images.docx");
  Assert.assertEquals(doc.getChildNodes(NodeType.SHAPE, true).getCount(), 10);
  
  // Here we get all shapes from the document node, but you can do this for any smaller
  // node too, for example delete shapes from a single section or a paragraph
  NodeCollection shapes = doc.getChildNodes(NodeType.SHAPE, true);
  
  // We cannot delete shape nodes while we enumerate through the collection
  // One solution is to add nodes that we want to delete to a temporary array and delete afterwards
  ArrayList shapesToDelete = new ArrayList();
  for (Shape shape : (Iterable<Shape>) shapes) {
      // Several shape types can have an image including image shapes and OLE objects
      if (shape.hasImage()) {
          shapesToDelete.add(shape);
      }
  }
  
  // Now we can delete shapes
  for (Shape shape : (Iterable<Shape>) shapesToDelete)
      shape.remove();
  
  // The only remaining shape doesn't have an image
  Assert.assertEquals(1, doc.getChildNodes(NodeType.SHAPE, true).getCount());
  Assert.assertFalse(((Shape) doc.getChild(NodeType.SHAPE, 0, true)).hasImage());

  Example:

  Shows how to remove all nodes of a specific type from a composite node.

  Document doc = new Document(getMyDir() + "Tables.docx");
  
  Assert.assertEquals(2, doc.getChildNodes(NodeType.TABLE, true).getCount());
  
  // Select the first child node in the body
  Node curNode = doc.getFirstSection().getBody().getFirstChild();
  
  while (curNode != null) {
      // Save the next sibling node as a variable in case we want to move to it after deleting this node
      Node nextNode = curNode.getNextSibling();
  
      // A section body can contain Paragraph and Table nodes
      // If the node is a Table, remove it from the parent
      if (curNode.getNodeType() == NodeType.TABLE) {
          curNode.remove();
      }
  
      // Continue going through child nodes until null (no more siblings) is reached
      curNode = nextNode;
  }
  
  Assert.assertEquals(0, doc.getChildNodes(NodeType.TABLE, true).getCount());

• removeAllChildren

  public void removeAllChildren()

  Removes all the child nodes of the current node.

  Example:

  Shows how to construct an Aspose Words document node by node.

  Document doc = new Document();
  
  // A newly created blank document still comes one section, one body and one paragraph
  // Calling this method will remove all those nodes to completely empty the document
  doc.removeAllChildren();
  
  // This document now has no composite nodes that content can be added to
  // If we wish to edit it, we will need to repopulate its node collection,
  // which we will start to do with by creating a new Section node
  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);
  
  // A section needs a body, which will contain all other nodes that can be edited
  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);
  
  // Now we can begin adding content to the document
  Run run = new Run(doc);
  run.setText("Hello World!");
  run.getFont().setColor(Color.RED);
  para.appendChild(run);
  
  Assert.assertEquals("Hello World!" + ControlChar.SECTION_BREAK_CHAR, doc.getText());
  
  doc.save(getArtifactsDir() + "Section.CreateFromScratch.docx");

• 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 doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Create a second section by inserting a section break and add text to both sections
  builder.writeln("Section 1 text.");
  builder.insertBreak(BreakType.SECTION_BREAK_CONTINUOUS);
  builder.writeln("Section 2 text.");
  
  // Both sections are siblings of each other
  Section lastSection = (Section) doc.getLastChild();
  Section firstSection = (Section) lastSection.getPreviousSibling();
  
  // Remove a section based on its sibling relationship with another section
  if (lastSection.getPreviousSibling() != null)
      doc.removeChild(firstSection);
  
  // The section we removed was the first one, leaving the document with only the second
  Assert.assertEquals("Section 2 text.", doc.getText().trim());

• removeSelfOnly

  public void removeSelfOnly()
                     throws java.lang.Exception

  Removes just this SDT node itself, but keeps the content of it inside the document tree.

  Example:

  Shows how to create a StructuredDocumentTag in the form of a plain text box and modify its appearance.

  // Create a new document
  Document doc = new Document();
  
  // Create a StructuredDocumentTag that will contain plain text
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.PLAIN_TEXT, MarkupLevel.INLINE);
  
  // Set the title and color of the frame that appears when you mouse over it
  tag.setTitle("My plain text");
  tag.setColor(Color.MAGENTA);
  
  // Set a programmatic tag for this StructuredDocumentTag
  // Unlike the title, this value will not be visible in the document but will be programmatically obtainable
  // as an XML element named "tag", with the string below in its "@val" attribute
  tag.setTag("MyPlainTextSDT");
  
  // Every StructuredDocumentTag gets a random unique ID
  Assert.assertTrue(tag.getId() > 0);
  
  // Set the font for the text inside the StructuredDocumentTag
  tag.getContentsFont().setName("Arial");
  
  // Set the font for the text at the end of the StructuredDocumentTag
  // Any text that's typed in the document body after moving out of the tag with arrow keys will keep this font
  tag.getEndCharacterFont().setName("Arial Black");
  
  // By default, this is false and pressing enter while inside a StructuredDocumentTag does nothing
  // When set to true, our StructuredDocumentTag can have multiple lines
  tag.setMultiline(true);
  
  // Insert the StructuredDocumentTag into the document with a DocumentBuilder and save the document to a file
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertNode(tag);
  
  // Insert a clone of our StructuredDocumentTag in a new paragraph
  StructuredDocumentTag tagClone = (StructuredDocumentTag) tag.deepClone(true);
  builder.insertParagraph();
  builder.insertNode(tagClone);
  
  // We can remove the tag while keeping its contents where they were in the Paragraph by calling RemoveSelfOnly()
  tagClone.removeSelfOnly();
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.PlainText.docx");

• 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() + "Smart tags.doc");
  Assert.assertEquals(8, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());
  
  // Remove smart tags from the whole document
  doc.removeSmartTags();
  
  Assert.assertEquals(0, doc.getChildNodes(NodeType.SMART_TAG, true).getCount());

• 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");
  
  Assert.assertEquals(Paragraph.class, node.getClass());

  Example:

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

  Document doc = new Document(getMyDir() + "Mail merge destination - Northwind employees.docx");
  
  // 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
  System.out.println("Contents of the first Run node that's part of a field: {resultList.First(n => n.NodeType == NodeType.Run).GetText().Trim()}");

• 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");
  
  Assert.assertEquals(Paragraph.class, node.getClass());

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

  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 html SaveFormat overload then the node is converted directly to html
  Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
          "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
          "</p>", node.toString(SaveFormat.HTML));
  
  // We can also modify the result of this conversion using a SaveOptions object
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  saveOptions.setExportRelativeFontSize(true);
  
  Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
          "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
          "</p>", 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("List item 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("\tNumerical Id: " + label.getLabelValue());
  
          // Combine them together to include the list label with the text in the output
          System.out.println("\tList label combined with text: " + label.getLabelString() + " " + paragraphText);
  
          listParaCount++;
      }
  }

  Example:

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

  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 html SaveFormat overload then the node is converted directly to html
  Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%; font-size:12pt\">" +
          "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
          "</p>", node.toString(SaveFormat.HTML));
  
  // We can also modify the result of this conversion using a SaveOptions object
  HtmlSaveOptions saveOptions = new HtmlSaveOptions();
  saveOptions.setExportRelativeFontSize(true);
  
  Assert.assertEquals("<p style=\"margin-top:0pt; margin-bottom:8pt; line-height:108%\">" +
          "<span style=\"font-family:'Times New Roman'\">Hello World!</span>" +
          "</p>", node.toString(saveOptions));

  Example:

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

  Document doc = new Document();
  
  DocumentBuilder builder = new DocumentBuilder(doc);
  builder.insertField("MERGEFIELD Field");
  
  // GetText will retrieve the visible text as well as field codes and special characters.
  Assert.assertEquals("\u0013MERGEFIELD Field\u0014«Field»\u0015\f", doc.getText());
  
  // ToString will give us the document's appearance if saved to a passed save format.
  Assert.assertEquals("«Field»\r\n", doc.toString(SaveFormat.TEXT));