IStructuredDocumentTag

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

NameTypeAccessDescription
multiSectionbooleanReadReturns true if this instance is a ranged (multi-section) structured document tag.
nodeNodeReadReturns Node object that implements this interface.
idintReadSpecifies a unique read-only persistent numerical Id for this SDT.
tagStringRead/WriteSpecifies a tag associated with the current SDT node.
titleStringRead/WriteSpecifies the friendly name associated with this SDT.
placeholderBuildingBlockReadGets 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.
placeholderNameStringRead/WriteGets or sets Name of the BuildingBlock containing placeholder text.
appearanceintRead/WriteGets or sets the appearance of the structured document tag.
showingPlaceholderTextbooleanRead/WriteSpecifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).
levelintReadGets the level at which this SDT occurs in the document tree.
sdtTypeintReadGets type of this Structured document tag.
lockContentControlbooleanRead/WriteWhen set to true, this property will prohibit a user from deleting this SDT.
lockContentsbooleanRead/WriteWhen set to true, this property will prohibit a user from editing the contents of this SDT.
colorColorRead/WriteGets or sets the color of the structured document tag.
xmlMappingXmlMappingReadGets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.
wordOpenXMLStringReadGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.

Methods

SignatureDescription
removeSelfOnly()Removes just this SDT node itself, but keeps the content of it inside the document tree.
getChildNodes(nodeType: int, isDeep: boolean) → NodeCollectionReturns a live collection of child nodes that match the specified types.
isMultiSection() → booleanReturns true if this instance is a ranged (multi-section) structured document tag.
getNode() → NodeReturns Node object that implements this interface.
getId() → intSpecifies a unique read-only persistent numerical Id for this SDT.
getTag() → StringSpecifies a tag associated with the current SDT node.
setTag(value: String)Sets the tag value.
getTitle() → StringSpecifies the friendly name associated with this SDT.
setTitle(value: String)Sets the title value.
getPlaceholder() → BuildingBlockGets 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() → StringGets or sets Name of the BuildingBlock containing placeholder text.
setPlaceholderName(value: String)Sets the placeholder name value.
getAppearance() → intGets or sets the appearance of the structured document tag.
setAppearance(value: int)Sets the appearance value.
isShowingPlaceholderText() → booleanSpecifies 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() → intGets the level at which this SDT occurs in the document tree.
getSdtType() → intGets type of this Structured document tag.
getLockContentControl() → booleanWhen set to true, this property will prohibit a user from deleting this SDT.
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 SDT.
setLockContents(value: boolean)Sets the lock contents value.
getColor() → ColorGets or sets the color of the structured document tag.
setColor(value: Color)Sets the color value.
getXmlMapping() → XmlMappingGets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.
getWordOpenXML() → StringGets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.

See Also