IStructuredDocumentTag
Overview
IStructuredDocumentTag is an interface in Aspose.Words FOSS for Java.
Interface to define a common data for StructuredDocumentTag and StructuredDocumentTagRangeStart.
Edition status of its 41 listed members (a property and its accessor methods are listed separately, overloads once): 41 not yet exercised by a verified example.
This interface declares 26 methods for IStructuredDocumentTag objects in Java programs.
Available methods include: getAppearance, getChildNodes, getColor, getId, getLevel, getLockContentControl, getLockContents, getNode, getPlaceholder, getPlaceholderName, getSdtType, getTag, and 13 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: appearance, color, id, level, lockContentControl, lockContents, and 10 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
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. |
id | int | Read | Specifies a unique read-only persistent numerical Id for this SDT. |
tag | String | Read/Write | Specifies a tag associated with the current SDT node. |
title | String | Read/Write | Specifies the friendly name associated with this SDT. |
placeholder | BuildingBlock | Read | Gets the BuildingBlock containing placeholder text which should be displayed when this SDT 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. |
appearance | int | Read/Write | Gets or sets the appearance of the structured document tag. |
showingPlaceholderText | boolean | Read/Write | Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT). |
level | int | Read | Gets the level at which this SDT occurs in the document tree. |
sdtType | int | Read | Gets type of this Structured document tag. |
lockContentControl | boolean | Read/Write | When set to true, this property will prohibit a user from deleting this SDT. |
lockContents | boolean | Read/Write | When set to true, this property will prohibit a user from editing the contents of this SDT. |
color | Color | Read/Write | Gets or sets the color of the structured document tag. |
xmlMapping | XmlMapping | Read | Gets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document. |
wordOpenXML | String | Read | Gets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format. |
Methods
| Signature | Description |
|---|---|
removeSelfOnly() | Removes just this SDT node itself, but keeps the content of it inside the document tree. |
getChildNodes(nodeType: int, isDeep: boolean) → NodeCollection | Returns a live collection of child nodes that match the specified types. |
isMultiSection() → boolean | Returns true if this instance is a ranged (multi-section) structured document tag. |
getNode() → Node | Returns Node object that implements this interface. |
getId() → int | Specifies a unique read-only persistent numerical Id for this SDT. |
getTag() → String | Specifies a tag associated with the current SDT node. |
setTag(value: String) | Sets the tag value. |
getTitle() → String | Specifies the friendly name associated with this SDT. |
setTitle(value: String) | Sets the title value. |
getPlaceholder() → BuildingBlock | Gets the BuildingBlock containing placeholder text which should be displayed when this SDT 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. |
getAppearance() → int | Gets or sets the appearance of the structured document tag. |
setAppearance(value: int) | Sets the appearance value. |
isShowingPlaceholderText() → boolean | Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT). |
isShowingPlaceholderText(value: boolean) | Calls isShowingPlaceholderText(value) on this IStructuredDocumentTag instance. |
getLevel() → int | Gets the level at which this SDT occurs in the document tree. |
getSdtType() → int | Gets type of this Structured document tag. |
getLockContentControl() → boolean | When set to true, this property will prohibit a user from deleting this SDT. |
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 SDT. |
setLockContents(value: boolean) | Sets the lock contents value. |
getColor() → Color | Gets or sets the color of the structured document tag. |
setColor(value: Color) | Sets the color value. |
getXmlMapping() → XmlMapping | Gets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document. |
getWordOpenXML() → String | Gets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format. |