Node Class

Base class for all nodes of a Word document.

ExpandedInheritance Hierarchy

SystemObject
  Aspose.WordsNode
    More...

Namespace:  Aspose.Words
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 21.3.0

ExpandedSyntax

public abstract class Node

The Node type exposes the following members.

ExpandedProperties

  NameDescription
Public propertyCustomNodeId
Specifies custom node identifier.
Public propertyCode exampleDocument
Gets the document to which this node belongs.
Public propertyCode exampleIsComposite
Returns true if this node can contain other nodes.
Public propertyCode exampleNextSibling
Gets the node immediately following this node.
Public propertyCode exampleNodeType
Gets the type of this node.
Public propertyCode exampleParentNode
Gets the immediate parent of this node.
Public propertyCode examplePreviousSibling
Gets the node immediately preceding this node.
Public propertyCode exampleRange
Returns a Range object that represents the portion of a document that is contained in this node.

ExpandedMethods

  NameDescription
Public methodCode exampleAccept
Accepts a visitor.
Public methodCode exampleClone
Creates a duplicate of the node.
Public methodEquals (Inherited from Object.)
Public methodCode exampleGetAncestor(Type)
Gets the first ancestor of the specified object type.
Public methodCode exampleGetAncestor(NodeType)
Gets the first ancestor of the specified NodeType.
Public methodGetHashCode (Inherited from Object.)
Public methodCode exampleGetText
Gets the text of this node and of all its children.
Public methodGetType (Inherited from Object.)
Public methodCode exampleNextPreOrder
Gets next node according to the pre-order tree traversal algorithm.
Public methodStatic memberCode exampleNodeTypeToString
A utility method that converts a node type enum value into a user friendly string.
Public methodCode examplePreviousPreOrder
Gets the previous node according to the pre-order tree traversal algorithm.
Public methodCode exampleRemove
Removes itself from the parent.
Public methodToString (Inherited from Object.)
Public methodCode exampleToString(SaveFormat)
Exports the content of the node into a string in the specified format.
Public methodCode exampleToString(SaveOptions)
Exports the content of the node into a string using the specified save options.

ExpandedRemarks

A document is represented as a tree of nodes, similar to DOM or XmlDocument.

For more info see the Composite design pattern.

The Node class:

  • Defines the child node interface.
  • Defines the interface for visiting nodes.
  • Provides default cloning capability.
  • Implements parent node and owner document mechanisms.
  • Implements access to sibling nodes.

ExpandedExamples

Shows how to remove all child nodes of a specific type from a composite node.
Document doc = new Document(MyDir + "Tables.docx");

Assert.AreEqual(2, doc.GetChildNodes(NodeType.Table, true).Count);

Node curNode = doc.FirstSection.Body.FirstChild;

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.NextSibling;

    // A section body can contain Paragraph and Table nodes.
    // If the node is a Table, remove it from the parent.
    if (curNode.NodeType.Equals(NodeType.Table))
        curNode.Remove();

    curNode = nextNode;
}

Assert.AreEqual(0, doc.GetChildNodes(NodeType.Table, true).Count);
Shows how to clone a composite node.
Document doc = new Document();
Paragraph para = doc.FirstSection.Body.FirstParagraph;
para.AppendChild(new Run(doc, "Hello world!"));

// Below are two ways of cloning a composite node.
// 1 -  Create a clone of a node, and create a clone of each of its child nodes as well.
Node cloneWithChildren = para.Clone(true);

Assert.IsTrue(((CompositeNode)cloneWithChildren).HasChildNodes);
Assert.AreEqual("Hello world!", cloneWithChildren.GetText().Trim());

// 2 -  Create a clone of a node just by itself without any children.
Node cloneWithoutChildren = para.Clone(false);

Assert.IsFalse(((CompositeNode)cloneWithoutChildren).HasChildNodes);
Assert.AreEqual(string.Empty, cloneWithoutChildren.GetText().Trim());
Shows how to traverse through a composite node's collection of child nodes.
Document doc = new Document();

// Add two runs and one shape as child nodes to the first paragraph of this document.
Paragraph paragraph = (Paragraph)doc.GetChild(NodeType.Paragraph, 0, true);
paragraph.AppendChild(new Run(doc, "Hello world! "));

Shape shape = new Shape(doc, ShapeType.Rectangle);
shape.Width = 200;
shape.Height = 200;
shape.WrapType = WrapType.Inline;
paragraph.AppendChild(shape);

paragraph.AppendChild(new Run(doc, "Hello again!"));

// Iterate through the paragraph's collection of immediate children,
// and print any runs or shapes that we find within.
NodeCollection children = paragraph.ChildNodes;

Assert.AreEqual(3, paragraph.ChildNodes.Count);

foreach (Node child in children)
    switch (child.NodeType)
    {
        case NodeType.Run:
            Console.WriteLine("Run contents:");
            Console.WriteLine($"\t\"{child.GetText().Trim()}\"");
            break;
        case NodeType.Shape:
            Shape childShape = (Shape)child;
            Console.WriteLine("Shape:");
            Console.WriteLine($"\t{childShape.ShapeType}, {childShape.Width}x{childShape.Height}");
            break;
    }

ExpandedSee Also

ExpandedInheritance Hierarchy