BuildingBlock
Overview
BuildingBlock is a class in Aspose.Words FOSS for Java.
Inherits from: CompositeNode<Node>.
BuildingBlock represents a reusable content block with properties such as name, GUID, description, gallery, category and behavior, and provides access to its underlying sections.
Edition status of its 33 listed members (a property and its accessor methods are listed separately, overloads once): 33 not yet exercised by a verified example.
This class declares 22 methods for BuildingBlock objects in Java programs.
Available methods include: BuildingBlock, accept, acceptEnd, acceptStart, getBehavior, getCategory, getDescription, getFirstSection, getGallery, getGuid, getLastSection, getName, and 10 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: behavior, category, description, firstSection, gallery, guid, and 5 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
nodeType | int | Read | Returns the BuildingBlock value. |
sections | SectionCollection | Read | Returns a collection that represents all sections in the building block. |
firstSection | Section | Read | Gets the first section in the building block. |
lastSection | Section | Read | Gets the last section in the building block. |
name | String | Read/Write | Gets or sets the name of this building block. |
guid | java.util.UUID | Read/Write | Gets or sets the guid. |
description | String | Read/Write | Gets or sets the description associated with this building block. |
gallery | int | Read/Write | Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting. |
category | String | Read/Write | Specifies the second-level categorization for the building block. |
behavior | int | Read/Write | Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document. |
type | int | Read/Write | Gets or sets the type. |
Methods
| Signature | Description |
|---|---|
BuildingBlock(glossaryDoc: GlossaryDocument) | Initializes a new instance of this class. |
getNodeType() → int | Returns the BuildingBlock value. |
accept(visitor: DocumentVisitor) → boolean | Calls accept(visitor) on this BuildingBlock instance. |
acceptStart(visitor: DocumentVisitor) → int | Accepts a visitor for visiting the start of the BuildingBlock. |
acceptEnd(visitor: DocumentVisitor) → int | Accepts a visitor for visiting the end of the BuildingBlock. |
getSections() → SectionCollection | Returns a collection that represents all sections in the building block. |
getFirstSection() → Section | Gets the first section in the building block. |
getLastSection() → Section | Gets the last section in the building block. |
getName() → String | Gets or sets the name of this building block. |
setName(value: String) | Sets the name value. |
getGuid() → java.util.UUID | Returns the guid. |
setGuid(value: java.util.UUID) | Sets the guid value. |
getDescription() → String | Gets or sets the description associated with this building block. |
setDescription(value: String) | Sets the description value. |
getGallery() → int | Specifies the first-level categorization for the building block for the purposes of classification or user interface sorting. |
setGallery(value: int) | Sets the gallery value. |
getCategory() → String | Specifies the second-level categorization for the building block. |
setCategory(value: String) | Sets the category value. |
getBehavior() → int | Specifies the behavior that shall be applied when the contents of the building block is inserted into the main document. |
setBehavior(value: int) | Sets the behavior value. |
getType() → int | Returns the type. |
setType(value: int) | Sets the type value. |