IStructuredDocumentTag

IStructuredDocumentTag interface

Interface to define a common data for StructuredDocumentTag and StructuredDocumentTagRangeStart.

public interface IStructuredDocumentTag

Properties

Name Description
Color { get; set; } Gets or sets the color of the structured document tag.
Id { get; } Specifies a unique read-only persistent numerical Id for this SDT.
IsShowingPlaceholderText { get; set; } Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT).
Level { get; } Gets the level at which this SDT occurs in the document tree.
LockContentControl { get; set; } When set to true, this property will prohibit a user from deleting this SDT.
LockContents { get; set; } When set to true, this property will prohibit a user from editing the contents of this SDT.
Placeholder { get; } 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 { get; set; } Gets or sets Name of the BuildingBlock containing placeholder text.
SdtType { get; } Gets type of this Structured document tag.
Tag { get; set; } Specifies a tag associated with the current SDT node. Can not be null.
Title { get; set; } Specifies the friendly name associated with this SDT. Can not be null.
WordOpenXML { get; } Gets a string that represents the XML contained within the node in the FlatOpc format.
XmlMapping { get; } Gets an object that represents the mapping of this structured document tag to XML data in a custom XML part of the current document.

Methods

Name Description
IsRanged() Returns true if this instance is a ranged structured document tag.
StructuredDocumentTagNode() Returns Node object that implements this interface.

See Also