DocumentBase Class

Provides the abstract base class for a main document and a glossary document of a Word document.

Inheritance Hierarchy

SystemObject
  Aspose.WordsNode
    Aspose.WordsCompositeNode
      Aspose.WordsDocumentBase
        Aspose.Words.BuildingBlocksGlossaryDocument
        Aspose.WordsDocument

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

Syntax

C++

public abstract class DocumentBase : CompositeNode

Public MustInherit Class DocumentBase
	Inherits CompositeNode

public ref class DocumentBase abstract : public CompositeNode

[<AbstractClassAttribute>]
type DocumentBase =  
    class
        inherit CompositeNode
    end

The DocumentBase type exposes the following members.

Properties

	Name	Description
	BackgroundShape	Gets or sets the background shape of the document. Can be null.
	ChildNodes	Gets all immediate child nodes of this node. (Inherited from CompositeNode.)
	Count	Gets the number of immediate children of this node. (Inherited from CompositeNode.)
	Document	(Overrides NodeDocument.)
	FirstChild	Gets the first child of the node. (Inherited from CompositeNode.)
	FontInfos	Provides access to properties of fonts used in this document.
	HasChildNodes	Returns true if this node has any child nodes. (Inherited from CompositeNode.)
	IsComposite	Returns true as this node can have child nodes. (Inherited from CompositeNode.)
	LastChild	Gets the last child of the node. (Inherited from CompositeNode.)
	Lists	Provides access to the list formatting used in the document.
	NextSibling	Gets the node immediately following this node. (Inherited from Node.)
	NodeChangingCallback	Called when a node is inserted or removed in the document.
	NodeType	Gets the type of this node. (Inherited from Node.)
	PageColor	Gets or sets the page color of the document. This property is a simpler version of BackgroundShape.
	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.)
	ResourceLoadingCallback	Allows to control how external resources are loaded.
	Styles	Returns a collection of styles defined in the document.
	WarningCallback	Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss.

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. (Inherited from CompositeNode.)
	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. (Inherited from CompositeNode.)
	GetChildNodes	Returns a live collection of child nodes that match the specified type. (Inherited from CompositeNode.)
	GetEnumerator	Provides support for the for each style iteration over the child nodes of this node. (Inherited from CompositeNode.)
	GetHashCode	(Inherited from Object.)
	GetText	Gets the text of this node and of all its children. (Inherited from CompositeNode.)
	GetType	(Inherited from Object.)
	ImportNode(Node, Boolean)	Imports a node from another document to the current document.
	ImportNode(Node, Boolean, ImportFormatMode)	Imports a node from another document to the current document with an option to control formatting.
	IndexOf	Returns the index of the specified child node in the child node array. (Inherited from CompositeNode.)
	InsertAfter	Inserts the specified node immediately after the specified reference node. (Inherited from CompositeNode.)
	InsertBefore	Inserts the specified node immediately before the specified reference node. (Inherited from CompositeNode.)
	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. (Inherited from CompositeNode.)
	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. (Inherited from CompositeNode.)
	RemoveChild	Removes the specified child node. (Inherited from CompositeNode.)
	RemoveSmartTags	Removes all SmartTag descendant nodes of the current node. (Inherited from CompositeNode.)
	SelectNodes	Selects a list of nodes matching the XPath expression. (Inherited from CompositeNode.)
	SelectSingleNode	Selects the first Node that matches the XPath expression. (Inherited from CompositeNode.)
	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

Aspose.Words represents a Word document as a tree of nodes. DocumentBase is a root node of the tree that contains all other nodes of the document.

DocumentBase also stores document-wide information such as Styles and Lists that the tree nodes might refer to.

Examples

Shows how to initialize the subclasses of DocumentBase.

// DocumentBase is the abstract base class for the Document and GlossaryDocument classes
Document doc = new Document();

GlossaryDocument glossaryDoc = new GlossaryDocument();
doc.GlossaryDocument = glossaryDoc;

Reference

Aspose.Words Namespace

Aspose.WordsDocument

Aspose.WordsDocumentBase