SubDocument
Overview
SubDocument is a class in Aspose.Words FOSS for .NET.
Inherits from: Node.
Represents a SubDocument - which is a reference to an externally stored document.
This class provides 10 methods for working with SubDocument objects in .NET programs.
Available methods include: Accept, Clone, GetAncestor, GetAncestorOf, GetText, NextPreOrder, NodeTypeToString, PreviousPreOrder, Remove, ToString.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: CustomNodeId, Document, IsComposite, NextSibling, NodeType, ParentNode, and 2 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
NodeType | NodeType | Read | Returns SubDocument. |
ParentNode | CompositeNode | Read | Gets the immediate parent of this node. |
Document | DocumentBase | Read | Gets the document to which this node belongs. |
PreviousSibling | Node | Read | Gets the node immediately preceding this node. |
NextSibling | Node | Read | Gets the node immediately following this node. |
IsComposite | bool | Read | Returns true if this node can contain other nodes. |
Range | Range | Read | Returns a Range object that represents the portion of a document that is contained in this node. |
CustomNodeId | int | Read/Write | Specifies custom node identifier. |
Methods
| Signature | Description |
|---|---|
Accept(visitor: DocumentVisitor) | Calls Accept(visitor) on this SubDocument instance. |
Clone(isCloneChildren: bool) | You should use the Clone(bool, INodeCloningListener) overload when the node cloning is a part of another (usually composite) node cloning process. |
GetText() | Gets the text of this node and of all its children. |
GetAncestor(ancestorType: Type) | Gets the first ancestor of the specified object type. |
GetAncestorOf() | Calls GetAncestorOf on this SubDocument instance. |
Remove() | Removes itself from the parent. |
NextPreOrder(rootNode: Node) | Gets next node according to the pre-order tree traversal algorithm. |
PreviousPreOrder(rootNode: Node) | Gets the previous node according to the pre-order tree traversal algorithm. |
ToString(saveFormat: SaveFormat) | Exports the content of the node into a string in the specified format. |
NodeTypeToString(nodeType: NodeType) | A utility method that converts a node type enum value into a user friendly string. |