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
| Name | Type | Access | Description |
|---|---|---|---|
document | DocumentBase | Read | Gets this instance. |
nodeChangingCallback | INodeChangingCallback | Read/Write | Called when a node is inserted or removed in the document. |
resourceLoadingCallback | IResourceLoadingCallback | Read/Write | Allows to control how external resources are loaded. |
fontInfos | FontInfoCollection | Read | Provides access to properties of fonts used in this document. |
styles | StyleCollection | Read | Returns a collection of styles defined in the document. |
lists | ListCollection | Read | Provides access to the list formatting used in the document. |
warningCallback | IWarningCallback | Read/Write | Called during various document processing procedures when an issue is detected that might result in data or formatting fidelity loss. |
footnoteSeparators | FootnoteSeparatorCollection | Read | Provides access to the footnote/endnote separators defined in the document. |
backgroundShape | Shape | Read/Write | Gets or sets the background shape of the document. |
pageColor | Color | Read/Write | Gets or sets the page color of the document. |
Methods
| Signature | Description |
|---|---|
importNode(srcNode: Node, isImportChildren: boolean) → Node | Imports a node from another document to the current document. |
importNode(srcNode: Node, isImportChildren: boolean, importFormatMode: int) → Node | Imports a node from another document to the current document with an option to control formatting. |
getDocument() → DocumentBase | Gets this instance. |
getNodeChangingCallback() → INodeChangingCallback | Called when a node is inserted or removed in the document. |
setNodeChangingCallback(value: INodeChangingCallback) | Sets the node changing callback value. |
getResourceLoadingCallback() → IResourceLoadingCallback | Allows to control how external resources are loaded. |
setResourceLoadingCallback(value: IResourceLoadingCallback) | Sets the resource loading callback value. |
getFontInfos() → FontInfoCollection | Provides access to properties of fonts used in this document. |
getStyles() → StyleCollection | Returns a collection of styles defined in the document. |
getLists() → ListCollection | Provides access to the list formatting used in the document. |
getWarningCallback() → IWarningCallback | Called 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() → FootnoteSeparatorCollection | Provides access to the footnote/endnote separators defined in the document. |
getBackgroundShape() → Shape | Gets or sets the background shape of the document. |
setBackgroundShape(value: Shape) | Sets the background shape value. |
getPageColor() → Color | Gets or sets the page color of the document. |
setPageColor(value: Color) | Sets the page color value. |