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

NameTypeAccessDescription
nodeTypeintReadReturns the BuildingBlock value.
sectionsSectionCollectionReadReturns a collection that represents all sections in the building block.
firstSectionSectionReadGets the first section in the building block.
lastSectionSectionReadGets the last section in the building block.
nameStringRead/WriteGets or sets the name of this building block.
guidjava.util.UUIDRead/WriteGets or sets the guid.
descriptionStringRead/WriteGets or sets the description associated with this building block.
galleryintRead/WriteSpecifies the first-level categorization for the building block for the purposes of classification or user interface sorting.
categoryStringRead/WriteSpecifies the second-level categorization for the building block.
behaviorintRead/WriteSpecifies the behavior that shall be applied when the contents of the building block is inserted into the main document.
typeintRead/WriteGets or sets the type.

Methods

SignatureDescription
BuildingBlock(glossaryDoc: GlossaryDocument)Initializes a new instance of this class.
getNodeType() → intReturns the BuildingBlock value.
accept(visitor: DocumentVisitor) → booleanCalls accept(visitor) on this BuildingBlock instance.
acceptStart(visitor: DocumentVisitor) → intAccepts a visitor for visiting the start of the BuildingBlock.
acceptEnd(visitor: DocumentVisitor) → intAccepts a visitor for visiting the end of the BuildingBlock.
getSections() → SectionCollectionReturns a collection that represents all sections in the building block.
getFirstSection() → SectionGets the first section in the building block.
getLastSection() → SectionGets the last section in the building block.
getName() → StringGets or sets the name of this building block.
setName(value: String)Sets the name value.
getGuid() → java.util.UUIDReturns the guid.
setGuid(value: java.util.UUID)Sets the guid value.
getDescription() → StringGets or sets the description associated with this building block.
setDescription(value: String)Sets the description value.
getGallery() → intSpecifies 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() → StringSpecifies the second-level categorization for the building block.
setCategory(value: String)Sets the category value.
getBehavior() → intSpecifies 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() → intReturns the type.
setType(value: int)Sets the type value.

See Also