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
| Name | Type | Access | Description |
|---|---|---|---|
nodeType | int | Read | Returns StructuredDocumentTagRangeStart. |
lastChild | Node | Read | Gets the last child in the stdContent range. |
level | int | Read | Gets the level at which this structured document tag range start occurs in the document tree. |
sdtType | int | Read | Gets type of this structured document tag. |
color | Color | Read/Write | Gets or sets the color of the structured document tag. |
id | int | Read | Specifies a unique read-only persistent numerical Id for this structured document tag. |
lockContentControl | boolean | Read/Write | When set to true, this property will prohibit a user from deleting this structured document tag. |
lockContents | boolean | Read/Write | When set to true, this property will prohibit a user from editing the contents of this structured document tag. |
showingPlaceholderText | boolean | Read/Write | Specifies 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). |
placeholder | BuildingBlock | Read | Gets 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. |
placeholderName | String | Read/Write | Gets or sets Name of the BuildingBlock containing placeholder text. |
tag | String | Read/Write | Specifies a tag associated with the current structured document tag node. |
title | String | Read/Write | Specifies the friendly name associated with this structured document tag. |
wordOpenXML | String | Read | Gets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format. |
wordOpenXMLMinimal | String | Read | Gets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format. |
appearance | int | Read/Write | Gets or sets the appearance of the structured document tag. |
xmlMapping | XmlMapping | Read | Gets an object that represents the mapping of this structured document tag range to XML data in a custom XML part of the current document. |
rangeEnd | StructuredDocumentTagRangeEnd | Read | Specifies end of range if the StructuredDocumentTag is a ranged structured document tag. |
parentNode | CompositeNode | Read | Gets the immediate parent of this node. |
document | DocumentBase | Read | Gets the document to which this node belongs. |
previousSibling | Node | Read | Gets the node immediately preceding this node. |
nextSibling | Node | Read | Gets the node immediately following this node. |
composite | boolean | Read | Returns true if this node can contain other nodes. |
range | Range | Read | Returns a Range object that represents the portion of a document that is contained in this node. |
text | String | Read | Gets the text of this node and of all its children. |
customNodeId | int | Read/Write | Specifies custom node identifier. |
multiSection | boolean | Read | Returns true if this instance is a ranged (multi-section) structured document tag. |
node | Node | Read | Returns Node object that implements this interface. |
Methods
| Signature | Description |
|---|---|
StructuredDocumentTagRangeStart(doc: DocumentBase, type: int) | Initializes a new instance of the Structured document tag range start class. |
getChildNodes(nodeType: int, isDeep: boolean) → NodeCollection | Returns a live collection of child nodes that match the specified types. |
getNodeType() → int | Returns StructuredDocumentTagRangeStart. |
getLastChild() → Node | Gets the last child in the stdContent range. |
getLevel() → int | Gets the level at which this structured document tag range start occurs in the document tree. |
getSdtType() → int | Gets type of this structured document tag. |
getColor() → Color | Gets or sets the color of the structured document tag. |
setColor(value: Color) | Sets the color value. |
getId() → int | Specifies a unique read-only persistent numerical Id for this structured document tag. |
getLockContentControl() → boolean | When 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() → boolean | When 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() → boolean | Specifies 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() → BuildingBlock | Gets 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() → String | Gets or sets Name of the BuildingBlock containing placeholder text. |
setPlaceholderName(value: String) | Sets the placeholder name value. |
getTag() → String | Specifies a tag associated with the current structured document tag node. |
setTag(value: String) | Sets the tag value. |
getTitle() → String | Specifies the friendly name associated with this structured document tag. |
setTitle(value: String) | Sets the title value. |
getWordOpenXML() → String | Gets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format. |
getWordOpenXMLMinimal() → String | Gets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format. |
getAppearance() → int | Gets or sets the appearance of the structured document tag. |
setAppearance(value: int) | Sets the appearance value. |
getXmlMapping() → XmlMapping | Gets 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) → boolean | Calls accept(visitor) on this StructuredDocumentTagRangeStart instance. |
getRangeEnd() → StructuredDocumentTagRangeEnd | Specifies 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) → Node | Adds 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() → CompositeNode | Gets the immediate parent of this node. |
getDocument() → DocumentBase | Gets the document to which this node belongs. |
getPreviousSibling() → Node | Gets the node immediately preceding this node. |
getNextSibling() → Node | Gets the node immediately following this node. |
isComposite() → boolean | Returns true if this node can contain other nodes. |
getRange() → Range | Returns a Range object that represents the portion of a document that is contained in this node. |
deepClone(isCloneChildren: boolean) → Node | Calls deepClone(isCloneChildren) on this StructuredDocumentTagRangeStart instance. |
getText() → String | Gets the text of this node and of all its children. |
getAncestor(ancestorType: Class) → CompositeNode | Gets the first ancestor of the specified object type. |
getAncestor(ancestorType: int) → CompositeNode | Gets the first ancestor of the specified NodeType. |
remove() | Removes itself from the parent. |
nextPreOrder(rootNode: Node) → Node | Gets next node according to the pre-order tree traversal algorithm. |
previousPreOrder(rootNode: Node) → Node | Gets the previous node according to the pre-order tree traversal algorithm. |
toString(saveFormat: int) → String | Exports the content of the node into a string in the specified format. |
toString(saveOptions: SaveOptions) → String | Exports the content of the node into a string using the specified save options. |
nodeTypeToString(nodeType: int) → String | A utility method that converts a node type enum value into a user friendly string. |
getCustomNodeId() → int | Specifies custom node identifier. |
setCustomNodeId(value: int) | Sets the custom node id value. |
toString() → String | Calls toString on this StructuredDocumentTagRangeStart instance. |
isMultiSection() → boolean | Returns true if this instance is a ranged (multi-section) structured document tag. |
getNode() → Node | Returns Node object that implements this interface. |