IStructuredDocumentTag
Overview
IStructuredDocumentTag is a interface in Aspose.Words FOSS for .NET.
Interface to define a common data for StructuredDocumentTag and StructuredDocumentTagRangeStart.
This interface provides 2 methods for working with IStructuredDocumentTag objects in .NET programs.
Available methods include: GetChildNodes, RemoveSelfOnly.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: Appearance, Color, Id, IsMultiSection, IsShowingPlaceholderText, Level, and 10 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
IsMultiSection | bool | 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 | SdtAppearance | Read/Write | Gets or sets the appearance of the structured document tag. |
IsShowingPlaceholderText | bool | 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 | MarkupLevel | Read | Gets the level at which this SDT occurs in the document tree. |
SdtType | SdtType | Read | Gets type of this Structured document tag. |
LockContentControl | bool | Read/Write | When set to true, this property will prohibit a user from deleting this SDT. |
LockContents | bool | Read/Write | When set to true, this property will prohibit a user from editing the contents of this SDT. |
Color | System.Drawing.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 FlatOpc format. |
Methods
| Signature | Description |
|---|---|
RemoveSelfOnly() | Removes just this SDT node itself, but keeps the content of it inside the document tree. |
GetChildNodes(nodeType: NodeType, isDeep: bool) | Returns a live collection of child nodes that match the specified types. |