IStructuredDocumentTag

public interface IStructuredDocumentTag

定义通用数据的接口StructuredDocumentTag和StructuredDocumentTagRangeStart.

方法

方法	描述
getColor()	获取结构化文档标签的颜色。
getId()	为此指定一个唯一的只读持久数字 IdSDT.
getLevel()	获取此级别SDT发生在文档树中。
getLockContentControl()	当设置为 true 时，此属性将禁止用户删除此SDT.
getLockContents()	当设置为 true 时，此属性将禁止用户编辑此文件的内容SDT.
getPlaceholder()	获取BuildingBlock包含应在此 SDT 运行内容为空时显示的占位符文本，关联的映射 XML 元素为空，如通过getXmlMapping()元素或isShowingPlaceholderText() / isShowingPlaceholderText(boolean)元素为真。
getPlaceholderName()	获取或设置名称BuildingBlock包含占位符文本。
getSdtType()	获取 this 的类型Structured document tag.
getTag()	指定与当前 SDT 节点关联的标签。
getTitle()	指定与此关联的友好名称SDT.
getWordOpenXML()	获取一个字符串，该字符串表示包含在SaveFormat.FLAT_OPC格式。
getXmlMapping()	获取一个对象，该对象表示此结构化文档标记到当前文档的自定义 XML 部分中的 XML 数据的映射。
isRanged()	如果此实例是范围结构化文档标记，则返回 true。
isShowingPlaceholderText()	指定此内容是否SDT应被解释为包含占位符文本（与 SDT 中的常规文本内容相反）。
isShowingPlaceholderText(boolean value)	指定此内容是否SDT应被解释为包含占位符文本（与 SDT 中的常规文本内容相反）。
setColor(Color value)	设置结构化文档标签的颜色。
setLockContentControl(boolean value)	当设置为 true 时，此属性将禁止用户删除此SDT.
setLockContents(boolean value)	当设置为 true 时，此属性将禁止用户编辑此文件的内容SDT.
setPlaceholderName(String value)	获取或设置名称BuildingBlock包含占位符文本。
setTag(String value)	指定与当前 SDT 节点关联的标签。
setTitle(String value)	指定与此关联的友好名称SDT.
structuredDocumentTagNode()	返回实现此接口的 Node 对象。

getColor()

public abstract Color getColor()

获取结构化文档标签的颜色。

退货： java.awt.Color - 结构化文档标签的颜色。

getId()

public abstract int getId()

为此指定一个唯一的只读持久数字 IdSDT.

退货： int - 相应的 int 值。

getLevel()

public abstract int getLevel()

获取此级别SDT发生在文档树中。

退货： int - 这个级别SDT发生在文档树中。返回值是其中之一MarkupLevel常数。

getLockContentControl()

public abstract boolean getLockContentControl()

当设置为 true 时，此属性将禁止用户删除此SDT.

退货： boolean - 相应的布尔值。

getLockContents()

public abstract boolean getLockContents()

当设置为 true 时，此属性将禁止用户编辑此文件的内容SDT.

退货： boolean - 相应的布尔值。

getPlaceholder()

public abstract BuildingBlock getPlaceholder()

获取BuildingBlock包含应在此 SDT 运行内容为空时显示的占位符文本，关联的映射 XML 元素为空，如通过getXmlMapping()元素或isShowingPlaceholderText() / isShowingPlaceholderText(boolean)元素为真。可以为空，表示占位符不适用于此 Sdt。

退货： BuildingBlock - 这BuildingBlock包含应在此 SDT 运行内容为空时显示的占位符文本，关联的映射 XML 元素为空，如通过getXmlMapping()元素或isShowingPlaceholderText() / isShowingPlaceholderText(boolean)元素为真。

getPlaceholderName()

public abstract String getPlaceholderName()

获取或设置名称BuildingBlock包含占位符文本。

具有此名称的 BuildingBlockBuildingBlock.getName() / BuildingBlock.setName(java.lang.String)必须出现在Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument)否则会出现 java.lang.IllegalStateException。

退货： java.lang.String - 相应的 java.lang.String 值。

getSdtType()

public abstract int getSdtType()

获取 this 的类型Structured document tag.

退货： int - 这个的类型Structured document tag .返回值是其中之一SdtType常数。

getTag()

public abstract String getTag()

指定与当前 SDT 节点关联的标签。不能为空。

退货： java.lang.String - 相应的 java.lang.String 值。

getTitle()

public abstract String getTitle()

指定与此关联的友好名称SDT.不能为空。

退货： java.lang.String - 相应的 java.lang.String 值。

getWordOpenXML()

public abstract String getWordOpenXML()

获取一个字符串，该字符串表示包含在SaveFormat.FLAT_OPC格式。

退货： java.lang.String - 一个字符串，表示包含在SaveFormat.FLAT_OPC格式。

getXmlMapping()

public abstract XmlMapping getXmlMapping()

获取一个对象，该对象表示此结构化文档标记到当前文档的自定义 XML 部分中的 XML 数据的映射。您可以使用XmlMapping.setMapping(com.aspose.words.CustomXmlPart, java.lang.String, java.lang.String)此对象的方法将结构化文档标记映射到 XML 数据。

退货： XmlMapping - 表示此结构化文档标记到当前文档的自定义 XML 部分中的 XML 数据的映射的对象。

isRanged()

public abstract boolean isRanged()

如果此实例是范围结构化文档标记，则返回 true。

退货： 布尔值

isShowingPlaceholderText()

public abstract boolean isShowingPlaceholderText()

指定此内容是否SDT应被解释为包含占位符文本（与 SDT 中的常规文本内容相反）。

如果设置为 true，则在打开此文档时应恢复此状态（显示占位符文本）。

退货： boolean - 相应的布尔值。

isShowingPlaceholderText(boolean value)

public abstract void isShowingPlaceholderText(boolean value)

指定此内容是否SDT应被解释为包含占位符文本（与 SDT 中的常规文本内容相反）。

如果设置为 true，则在打开此文档时应恢复此状态（显示占位符文本）。

参数：

范围	类型	描述
value	boolean	对应的布尔值。

setColor(Color value)

public abstract void setColor(Color value)

设置结构化文档标签的颜色。

参数：

范围	类型	描述
value	java.awt.Color	结构化文档标签的颜色。

setLockContentControl(boolean value)

public abstract void setLockContentControl(boolean value)

当设置为 true 时，此属性将禁止用户删除此SDT.

参数：

范围	类型	描述
value	boolean	对应的布尔值。

setLockContents(boolean value)

public abstract void setLockContents(boolean value)

当设置为 true 时，此属性将禁止用户编辑此文件的内容SDT.

参数：

范围	类型	描述
value	boolean	对应的布尔值。

setPlaceholderName(String value)

public abstract void setPlaceholderName(String value)

获取或设置名称BuildingBlock包含占位符文本。

具有此名称的 BuildingBlockBuildingBlock.getName() / BuildingBlock.setName(java.lang.String)必须出现在Document.getGlossaryDocument() / Document.setGlossaryDocument(com.aspose.words.GlossaryDocument)否则会出现 java.lang.IllegalStateException。

参数：

范围	类型	描述
value	java.lang.String	对应的java.lang.String值。

setTag(String value)

public abstract void setTag(String value)

指定与当前 SDT 节点关联的标签。不能为空。

参数：

范围	类型	描述
value	java.lang.String	对应的java.lang.String值。

setTitle(String value)

public abstract void setTitle(String value)

指定与此关联的友好名称SDT.不能为空。

参数：

范围	类型	描述
value	java.lang.String	对应的java.lang.String值。

structuredDocumentTagNode()

public abstract Node structuredDocumentTagNode()

返回实现此接口的 Node 对象。

退货： Node