IStructuredDocumentTag (Aspose.Words for Java API Reference)

All Known Implementing Classes:

StructuredDocumentTag, StructuredDocumentTagRangeStart
```
public interface IStructuredDocumentTag
```
Interface to define a common data for StructuredDocumentTag and StructuredDocumentTagRangeStart.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.awt.Color`	`getColor()` Gets the color of the structured document tag.
`int`	`getId()` Specifies a unique read-only persistent numerical Id for this SDT.
`int`	`getLevel()` Gets the level at which this SDT occurs in the document tree.
`boolean`	`getLockContentControl()` When set to true, this property will prohibit a user from deleting this SDT.
`boolean`	`getLockContents()` When set to true, this property will prohibit a user from editing the contents of this SDT.
`BuildingBlock`	`getPlaceholder()` 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 `getXmlMapping()` element or the `isShowingPlaceholderText()` / `isShowingPlaceholderText(boolean)` element is true.
`java.lang.String`	`getPlaceholderName()` Gets or sets Name of the `BuildingBlock` containing placeholder text.
`int`	`getSdtType()` Gets type of this Structured document tag.
`java.lang.String`	`getTag()` Specifies a tag associated with the current SDT node.
`java.lang.String`	`getTitle()` Specifies the friendly name associated with this SDT.
`java.lang.String`	`getWordOpenXML()` Gets a string that represents the XML contained within the node in the `SaveFormat.FLAT_OPC` format.
`XmlMapping`	`getXmlMapping()` Gets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.
`boolean`	`isRanged()` Returns true if this instance is a ranged structured document tag.
`boolean`	`isShowingPlaceholderText()` Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).
`void`	`isShowingPlaceholderText(boolean value)` Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).
`void`	`setColor(java.awt.Color value)` Sets the color of the structured document tag.
`void`	`setLockContentControl(boolean value)` When set to true, this property will prohibit a user from deleting this SDT.
`void`	`setLockContents(boolean value)` When set to true, this property will prohibit a user from editing the contents of this SDT.
`void`	`setPlaceholderName(java.lang.String value)` Gets or sets Name of the `BuildingBlock` containing placeholder text.
`void`	`setTag(java.lang.String value)` Specifies a tag associated with the current SDT node.
`void`	`setTitle(java.lang.String value)` Specifies the friendly name associated with this SDT.
`Node`	`structuredDocumentTagNode()` Returns Node object that implements this interface.

- Method Detail
  - isRanged
```
boolean isRanged()
```
    Returns true if this instance is a ranged structured document tag.
  - structuredDocumentTagNode
```
Node structuredDocumentTagNode()
```
    Returns Node object that implements this interface.
  - getId
```
int getId()
```
    Specifies a unique read-only persistent numerical Id for this SDT.
    
    Returns:
    
    The corresponding int value.
  - getTag
```
java.lang.String getTag()
```
    Specifies a tag associated with the current SDT node. Can not be null.
    
    Returns:
    
    The corresponding String value.
  - setTag
```
void setTag(java.lang.String value)
```
    Specifies a tag associated with the current SDT node. Can not be null.
    
    Parameters:
    
    value - The corresponding String value.
  - getTitle
```
java.lang.String getTitle()
```
    Specifies the friendly name associated with this SDT. Can not be null.
    
    Returns:
    
    The corresponding String value.
  - setTitle
```
void setTitle(java.lang.String value)
```
    Specifies the friendly name associated with this SDT. Can not be null.
    
    Parameters:
    
    value - The corresponding String value.
  - getPlaceholder
```
BuildingBlock getPlaceholder()
```
    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 getXmlMapping() element or the isShowingPlaceholderText() / isShowingPlaceholderText(boolean) element is true. Can be null, meaning that the placeholder is not applicable for this Sdt.
    
    Returns:
    
    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 getXmlMapping() element or the isShowingPlaceholderText() / isShowingPlaceholderText(boolean) element is true.
  - getPlaceholderName
```
java.lang.String getPlaceholderName()
```
    Gets or sets Name of the BuildingBlock containing placeholder text.
    
    BuildingBlock with this name BuildingBlock.getName() / BuildingBlock.setName(java.lang.String) has to be present in the Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument) otherwise IllegalStateException will occur.
    
    Returns:
    
    The corresponding String value.
  - setPlaceholderName
```
void setPlaceholderName(java.lang.String value)
```
    Gets or sets Name of the BuildingBlock containing placeholder text.
    
    BuildingBlock with this name BuildingBlock.getName() / BuildingBlock.setName(java.lang.String) has to be present in the Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument) otherwise IllegalStateException will occur.
    
    Parameters:
    
    value - The corresponding String value.
  - isShowingPlaceholderText
```
boolean isShowingPlaceholderText()
```
    Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).
    
    if set to true, this state shall be resumed (showing placeholder text) upon opening this document.
    
    Returns:
    
    The corresponding boolean value.
  - isShowingPlaceholderText
```
void isShowingPlaceholderText(boolean value)
```
    Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).
    
    if set to true, this state shall be resumed (showing placeholder text) upon opening this document.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getLevel
```
int getLevel()
```
    Gets the level at which this SDT occurs in the document tree.
    
    Returns:
    
    The level at which this SDT occurs in the document tree. The returned value is one of MarkupLevel constants.
  - getSdtType
```
int getSdtType()
```
    Gets type of this Structured document tag.
    
    Returns:
    
    Type of this Structured document tag. The returned value is one of SdtType constants.
  - getLockContentControl
```
boolean getLockContentControl()
```
    When set to true, this property will prohibit a user from deleting this SDT.
    
    Returns:
    
    The corresponding boolean value.
  - setLockContentControl
```
void setLockContentControl(boolean value)
```
    When set to true, this property will prohibit a user from deleting this SDT.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getLockContents
```
boolean getLockContents()
```
    When set to true, this property will prohibit a user from editing the contents of this SDT.
    
    Returns:
    
    The corresponding boolean value.
  - setLockContents
```
void setLockContents(boolean value)
```
    When set to true, this property will prohibit a user from editing the contents of this SDT.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getColor
```
java.awt.Color getColor()
```
    Gets the color of the structured document tag.
    
    Returns:
    
    The color of the structured document tag.
  - setColor
```
void setColor(java.awt.Color value)
```
    Sets the color of the structured document tag.
    
    Parameters:
    
    value - The color of the structured document tag.
  - getXmlMapping
```
XmlMapping getXmlMapping()
```
    Gets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document. You can use the XmlMapping.setMapping(com.aspose.words.CustomXmlPart, java.lang.String, java.lang.String) method of this object to map a structured document tag to XML data.
    
    Returns:
    
    An object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.
  - getWordOpenXML
```
java.lang.String getWordOpenXML()
                         throws java.lang.Exception
```
    Gets a string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
    
    Returns:
    
    A string that represents the XML contained within the node in the SaveFormat.FLAT_OPC format.
    
    Throws:
    
    java.lang.Exception

Interface IStructuredDocumentTag

Method Summary

Method Detail

isRanged

structuredDocumentTagNode

getId

getTag

setTag

getTitle

setTitle

getPlaceholder

getPlaceholderName

setPlaceholderName

isShowingPlaceholderText

isShowingPlaceholderText

getLevel

getSdtType

getLockContentControl

setLockContentControl

getLockContents

setLockContents

getColor

setColor

getXmlMapping

getWordOpenXML