StructuredDocumentTagRangeStart

StructuredDocumentTagRangeStart

Overview

StructuredDocumentTagRangeStart is a class in Aspose.Words FOSS for Java. Inherits from: Node, Iterable<Node>, IStructuredDocumentTag.

Represents a start of ranged structured document tag which accepts multi-sections content.

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

This class declares 54 methods for StructuredDocumentTagRangeStart objects in Java programs. Available methods include: StructuredDocumentTagRangeStart, accept, appendChild, deepClone, getAncestor, getAppearance, getChildNodes, getColor, getCustomNodeId, getDocument, getId, getLastChild, and 38 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: appearance, color, composite, customNodeId, document, id, and 22 more.

Properties

NameTypeAccessDescription
nodeTypeintReadReturns StructuredDocumentTagRangeStart.
lastChildNodeReadGets the last child in the stdContent range.
levelintReadGets the level at which this structured document tag range start occurs in the document tree.
sdtTypeintReadGets type of this structured document tag.
colorColorRead/WriteGets or sets the color of the structured document tag.
idintReadSpecifies a unique read-only persistent numerical Id for this structured document tag.
lockContentControlbooleanRead/WriteWhen set to true, this property will prohibit a user from deleting this structured document tag.
lockContentsbooleanRead/WriteWhen set to true, this property will prohibit a user from editing the contents of this structured document tag.
showingPlaceholderTextbooleanRead/WriteSpecifies whether the content of this structured document tag shall be interpreted to contain placeholder text (as opposed to regular text contents within the structured document tag).
placeholderBuildingBlockReadGets the BuildingBlock containing placeholder text which should be displayed when this structured document tag run contents are empty, the associated mapped XML element is empty as specified via the XmlMapping element or the IsShowingPlaceholderText element is true.
placeholderNameStringRead/WriteGets or sets Name of the BuildingBlock containing placeholder text.
tagStringRead/WriteSpecifies a tag associated with the current structured document tag node.
titleStringRead/WriteSpecifies the friendly name associated with this structured document tag.
wordOpenXMLStringReadGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
wordOpenXMLMinimalStringReadGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
appearanceintRead/WriteGets or sets the appearance of the structured document tag.
xmlMappingXmlMappingReadGets an object that represents the mapping of this structured document tag range to XML data in a custom XML part of the current document.
rangeEndStructuredDocumentTagRangeEndReadSpecifies end of range if the StructuredDocumentTag is a ranged structured document tag.
parentNodeCompositeNodeReadGets the immediate parent of this node.
documentDocumentBaseReadGets the document to which this node belongs.
previousSiblingNodeReadGets the node immediately preceding this node.
nextSiblingNodeReadGets the node immediately following this node.
compositebooleanReadReturns true if this node can contain other nodes.
rangeRangeReadReturns a Range object that represents the portion of a document that is contained in this node.
textStringReadGets the text of this node and of all its children.
customNodeIdintRead/WriteSpecifies custom node identifier.
multiSectionbooleanReadReturns true if this instance is a ranged (multi-section) structured document tag.
nodeNodeReadReturns Node object that implements this interface.

Methods

SignatureDescription
StructuredDocumentTagRangeStart(doc: DocumentBase, type: int)Initializes a new instance of the Structured document tag range start class.
getChildNodes(nodeType: int, isDeep: boolean) → NodeCollectionReturns a live collection of child nodes that match the specified types.
getNodeType() → intReturns StructuredDocumentTagRangeStart.
getLastChild() → NodeGets the last child in the stdContent range.
getLevel() → intGets the level at which this structured document tag range start occurs in the document tree.
getSdtType() → intGets type of this structured document tag.
getColor() → ColorGets or sets the color of the structured document tag.
setColor(value: Color)Sets the color value.
getId() → intSpecifies a unique read-only persistent numerical Id for this structured document tag.
getLockContentControl() → booleanWhen set to true, this property will prohibit a user from deleting this structured document tag.
setLockContentControl(value: boolean)Sets the lock content control value.
getLockContents() → booleanWhen set to true, this property will prohibit a user from editing the contents of this structured document tag.
setLockContents(value: boolean)Sets the lock contents value.
isShowingPlaceholderText() → booleanSpecifies whether the content of this structured document tag shall be interpreted to contain placeholder text (as opposed to regular text contents within the structured document tag).
isShowingPlaceholderText(value: boolean)Calls isShowingPlaceholderText(value) on this StructuredDocumentTagRangeStart instance.
getPlaceholder() → BuildingBlockGets the BuildingBlock containing placeholder text which should be displayed when this structured document tag run contents are empty, the associated mapped XML element is empty as specified via the XmlMapping element or the IsShowingPlaceholderText element is true.
getPlaceholderName() → StringGets or sets Name of the BuildingBlock containing placeholder text.
setPlaceholderName(value: String)Sets the placeholder name value.
getTag() → StringSpecifies a tag associated with the current structured document tag node.
setTag(value: String)Sets the tag value.
getTitle() → StringSpecifies the friendly name associated with this structured document tag.
setTitle(value: String)Sets the title value.
getWordOpenXML() → StringGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
getWordOpenXMLMinimal() → StringGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
getAppearance() → intGets or sets the appearance of the structured document tag.
setAppearance(value: int)Sets the appearance value.
getXmlMapping() → XmlMappingGets an object that represents the mapping of this structured document tag range to XML data in a custom XML part of the current document.
accept(visitor: DocumentVisitor) → booleanCalls accept(visitor) on this StructuredDocumentTagRangeStart instance.
getRangeEnd() → StructuredDocumentTagRangeEndSpecifies end of range if the StructuredDocumentTag is a ranged structured document tag.
iterator() → Iterator<Node>Provides support for the for each style iteration over the child nodes of this node.
appendChild(newChild: Node) → NodeAdds the specified node to the end of the stdContent range.
removeAllChildren()Removes all the nodes between this range start node and the range end node.
removeSelfOnly()Removes this range start and appropriate range end nodes of the structured document tag, but keeps its content inside the document tree.
getParentNode() → CompositeNodeGets the immediate parent of this node.
getDocument() → DocumentBaseGets the document to which this node belongs.
getPreviousSibling() → NodeGets the node immediately preceding this node.
getNextSibling() → NodeGets the node immediately following this node.
isComposite() → booleanReturns true if this node can contain other nodes.
getRange() → RangeReturns a Range object that represents the portion of a document that is contained in this node.
deepClone(isCloneChildren: boolean) → NodeCalls deepClone(isCloneChildren) on this StructuredDocumentTagRangeStart instance.
getText() → StringGets the text of this node and of all its children.
getAncestor(ancestorType: Class) → CompositeNodeGets the first ancestor of the specified object type.
getAncestor(ancestorType: int) → CompositeNodeGets the first ancestor of the specified NodeType.
remove()Removes itself from the parent.
nextPreOrder(rootNode: Node) → NodeGets next node according to the pre-order tree traversal algorithm.
previousPreOrder(rootNode: Node) → NodeGets the previous node according to the pre-order tree traversal algorithm.
toString(saveFormat: int) → StringExports the content of the node into a string in the specified format.
toString(saveOptions: SaveOptions) → StringExports the content of the node into a string using the specified save options.
nodeTypeToString(nodeType: int) → StringA utility method that converts a node type enum value into a user friendly string.
getCustomNodeId() → intSpecifies custom node identifier.
setCustomNodeId(value: int)Sets the custom node id value.
toString() → StringCalls toString on this StructuredDocumentTagRangeStart instance.
isMultiSection() → booleanReturns true if this instance is a ranged (multi-section) structured document tag.
getNode() → NodeReturns Node object that implements this interface.

See Also