CompositeNode Class

Base class for nodes that can contain other nodes.

Inheritance Hierarchy

SystemObject
  Aspose.WordsNode
    Aspose.WordsCompositeNode
      More...

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

Syntax

C++

public abstract class CompositeNode : Node, 
	IEnumerable<Node>, IEnumerable, IXPathNavigable

Public MustInherit Class CompositeNode
	Inherits Node
	Implements IEnumerable(Of Node), IEnumerable, 
	IXPathNavigable

public ref class CompositeNode abstract : public Node, 
	IEnumerable<Node^>, IEnumerable, IXPathNavigable

[<AbstractClassAttribute>]
type CompositeNode =  
    class
        inherit Node
        interface IEnumerable<Node>
        interface IEnumerable
        interface IXPathNavigable
    end

The CompositeNode type exposes the following members.

Properties

	Name	Description
	ChildNodes	Gets all immediate child nodes of this node.
	Count	Gets the number of immediate children of this node.
	Document	Gets the document to which this node belongs. (Inherited from Node.)
	FirstChild	Gets the first child of the node.
	HasChildNodes	Returns true if this node has any child nodes.
	IsComposite	Returns true as this node can have child nodes. (Overrides NodeIsComposite.)
	LastChild	Gets the last child of the node.
	NextSibling	Gets the node immediately following this node. (Inherited from Node.)
	NodeType	Gets the type of this node. (Inherited from Node.)
	ParentNode	Gets the immediate parent of this node. (Inherited from Node.)
	PreviousSibling	Gets the node immediately preceding this node. (Inherited from Node.)
	Range	Returns a Range object that represents the portion of a document that is contained in this node. (Inherited from Node.)

Methods

	Name	Description
	Accept	Accepts a visitor. (Inherited from Node.)
	AppendChild	Adds the specified node to the end of the list of child nodes for this node.
	Clone	(Inherited from Node.)
	Equals	(Inherited from Object.)
	GetAncestor(Type)	Gets the first ancestor of the specified object type. (Inherited from Node.)
	GetAncestor(NodeType)	Gets the first ancestor of the specified NodeType. (Inherited from Node.)
	GetChild	Returns an Nth child node that matches the specified type.
	GetChildNodes	Returns a live collection of child nodes that match the specified type.
	GetEnumerator	Provides support for the for each style iteration over the child nodes of this node.
	GetHashCode	(Inherited from Object.)
	GetText	Gets the text of this node and of all its children. (Overrides NodeGetText.)
	GetType	(Inherited from Object.)
	IndexOf	Returns the index of the specified child node in the child node array.
	InsertAfter	Inserts the specified node immediately after the specified reference node.
	InsertBefore	Inserts the specified node immediately before the specified reference node.
	NextPreOrder	Gets next node according to the pre-order tree traversal algorithm. (Inherited from Node.)
	PrependChild	Adds the specified node to the beginning of the list of child nodes for this node.
	PreviousPreOrder	Gets the previous node according to the pre-order tree traversal algorithm. (Inherited from Node.)
	Remove	Removes itself from the parent. (Inherited from Node.)
	RemoveAllChildren	Removes all the child nodes of the current node.
	RemoveChild	Removes the specified child node.
	RemoveSmartTags	Removes all SmartTag descendant nodes of the current node.
	SelectNodes	Selects a list of nodes matching the XPath expression.
	SelectSingleNode	Selects the first Node that matches the XPath expression.
	ToString	(Inherited from Object.)
	ToString(SaveFormat)	Exports the content of the node into a string in the specified format. (Inherited from Node.)
	ToString(SaveOptions)	Exports the content of the node into a string using the specified save options. (Inherited from Node.)

Remarks

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

For more info see the Composite design pattern.

The CompositeNode class:

Provides access to the child nodes.
Implements Composite operations such as insert and remove children.
Provides methods for XPath navigation.

Examples

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

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

Reference

Aspose.Words Namespace

Inheritance Hierarchy

SystemObject
  Aspose.WordsNode
    Aspose.WordsCompositeNode
      Aspose.Words.BuildingBlocksBuildingBlock
      Aspose.WordsDocumentBase
      Aspose.Words.DrawingShapeBase
      Aspose.WordsInlineStory
      Aspose.Words.MarkupSmartTag
      Aspose.Words.MarkupStructuredDocumentTag
      Aspose.Words.MathOfficeMath
      Aspose.WordsParagraph
      Aspose.WordsSection
      Aspose.WordsStory
      Aspose.Words.TablesCell
      Aspose.Words.TablesRow
      Aspose.Words.TablesTable