DocumentBase

Overview

DocumentBase is a class in Aspose.Words FOSS for Java. Inherits from: CompositeNode<T>.

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

Edition status of its 26 listed members (a property and its accessor methods are listed separately, overloads once): 26 not yet exercised by a verified example.

This class declares 17 methods for DocumentBase objects in Java programs. Available methods include: getBackgroundShape, getDocument, getFontInfos, getFootnoteSeparators, getLists, getNodeChangingCallback, getPageColor, getResourceLoadingCallback, getStyles, getWarningCallback, importNode, setBackgroundShape, and 4 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: backgroundShape, document, fontInfos, footnoteSeparators, lists, nodeChangingCallback, and 4 more.

Properties

NameTypeAccessDescription
documentDocumentBaseReadGets this instance.
nodeChangingCallbackINodeChangingCallbackRead/WriteCalled when a node is inserted or removed in the document.
resourceLoadingCallbackIResourceLoadingCallbackRead/WriteAllows to control how external resources are loaded.
fontInfosFontInfoCollectionReadProvides access to properties of fonts used in this document.
stylesStyleCollectionReadReturns a collection of styles defined in the document.
listsListCollectionReadProvides access to the list formatting used in the document.
warningCallbackIWarningCallbackRead/WriteCalled during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss.
footnoteSeparatorsFootnoteSeparatorCollectionReadProvides access to the footnote/endnote separators defined in the document.
backgroundShapeShapeRead/WriteGets or sets the background shape of the document.
pageColorColorRead/WriteGets or sets the page color of the document.

Methods

SignatureDescription
importNode(srcNode: Node, isImportChildren: boolean) → NodeImports a node from another document to the current document.
importNode(srcNode: Node, isImportChildren: boolean, importFormatMode: int) → NodeImports a node from another document to the current document with an option to control formatting.
getDocument() → DocumentBaseGets this instance.
getNodeChangingCallback() → INodeChangingCallbackCalled when a node is inserted or removed in the document.
setNodeChangingCallback(value: INodeChangingCallback)Sets the node changing callback value.
getResourceLoadingCallback() → IResourceLoadingCallbackAllows to control how external resources are loaded.
setResourceLoadingCallback(value: IResourceLoadingCallback)Sets the resource loading callback value.
getFontInfos() → FontInfoCollectionProvides access to properties of fonts used in this document.
getStyles() → StyleCollectionReturns a collection of styles defined in the document.
getLists() → ListCollectionProvides access to the list formatting used in the document.
getWarningCallback() → IWarningCallbackCalled during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss.
setWarningCallback(value: IWarningCallback)Sets the warning callback value.
getFootnoteSeparators() → FootnoteSeparatorCollectionProvides access to the footnote/endnote separators defined in the document.
getBackgroundShape() → ShapeGets or sets the background shape of the document.
setBackgroundShape(value: Shape)Sets the background shape value.
getPageColor() → ColorGets or sets the page color of the document.
setPageColor(value: Color)Sets the page color value.

See Also