StructuredDocumentTag class
StructuredDocumentTag class
Represents a structured document tag (SDT or content control) in a document. To learn more, visit the Structured Document Tags or Content Control documentation article.
Remarks
Structured document tags (SDTs) allow to embed customer-defined semantics as well as its behavior and appearance into a document.
In this version Aspose.Words provides a number of public methods and properties to manipulate the behavior and content of StructuredDocumentTag. Mapping of SDT nodes to custom XML packages within a document can be performed with using the StructuredDocumentTag.xmlMapping property.
StructuredDocumentTag can occur in a document in the following places:
Block-level - Among paragraphs and tables, as a child of a Body, HeaderFooter, Comment, Footnote or a Shape node.
Row-level - Among rows in a table, as a child of a Table node.
Cell-level - Among cells in a table row, as a child of a Row node.
Inline-level - Among inline content inside, as a child of a Paragraph.
Nested inside another StructuredDocumentTag.
Inheritance: StructuredDocumentTag → CompositeNode → Node
Constructors
| Name | Description |
|---|---|
| StructuredDocumentTag(doc, type, level) | Initializes a new instance of the Structured document tag class. |
Properties
| Name | Description |
|---|---|
| appearance | Gets/sets the appearance of a structured document tag. |
| buildingBlockCategory | Specifies category of building block for this SDT node. Can not be null. |
| buildingBlockGallery | Specifies type of building block for this SDT. Can not be null. |
| calendarType | Specifies the type of calendar for this SDT. Default is SdtCalendarType.Default |
| checked | Gets/Sets current state of the Checkbox SDT. Default value for this property is false. |
| color | Gets or sets the color of the structured document tag. |
| contentsFont | Font formatting that will be applied to text entered into SDT. |
| count | Gets the number of immediate children of this node. (Inherited from CompositeNode) |
| customNodeId | Specifies custom node identifier. (Inherited from Node) |
| dateDisplayFormat | String that represents the format in which dates are displayed. |
| dateDisplayLocale | Allows to set/get the language format for the date displayed in this SDT. |
| dateStorageFormat | Gets/sets format in which the date for a date SDT is stored when the SDT is bound to an XML node in the document’s data store. Default value is SdtDateStorageFormat.DateTime |
| document | Gets the document to which this node belongs. (Inherited from Node) |
| endCharacterFont | Font formatting that will be applied to the last character of text entered into SDT. |
| firstChild | Gets the first child of the node. (Inherited from CompositeNode) |
| fullDate | Specifies the full date and time last entered into this SDT. |
| hasChildNodes | Returns true if this node has any child nodes.(Inherited from CompositeNode) |
| id | Specifies a unique read-only persistent numerical Id for this SDT. |
| isComposite | Returns true if this node can contain other nodes.(Inherited from Node) |
| isShowingPlaceholderText | Specifies whether the content of this SDT shall be interpreted to contain placeholder text (as opposed to regular text contents within the SDT). |
| isTemporary | Specifies whether this SDT shall be removed from the WordProcessingML document when its contents are modified. |
| lastChild | Gets the last child of the node. (Inherited from CompositeNode) |
| level | Gets the level at which this SDT occurs in the document tree. |
| listItems | Gets SdtListItemCollection associated with this SDT. |
| lockContentControl | When set to true, this property will prohibit a user from deleting this SDT. |
| lockContents | When set to true, this property will prohibit a user from editing the contents of this SDT. |
| multiline | Specifies whether this SDT allows multiple lines of text. |
| nextSibling | Gets the node immediately following this node. (Inherited from Node) |
| nodeType | Returns NodeType.StructuredDocumentTag. |
| parentNode | Gets the immediate parent of this node. (Inherited from Node) |
| placeholder | 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 StructuredDocumentTag.xmlMapping element or the StructuredDocumentTag.isShowingPlaceholderText element is true. |
| placeholderName | Gets or sets Name of the BuildingBlock containing placeholder text. |
| previousSibling | Gets the node immediately preceding this node. (Inherited from Node) |
| range | Returns a Range object that represents the portion of a document that is contained in this node. (Inherited from Node) |
| sdtType | Gets type of this Structured document tag. |
| style | Gets or sets the Style of the structured document tag. |
| styleName | Gets or sets the name of the style applied to the structured document tag. |
| tag | Specifies a tag associated with the current SDT node. Can not be null. |
| title | Specifies the friendly name associated with this SDT. Can not be null. |
| wordOpenXML | Gets a string that represents the XML contained within the node in the SaveFormat.FlatOpc format. |
| wordOpenXMLMinimal | Gets a string that represents the XML contained within the node in the SaveFormat.FlatOpc format. |
| xmlMapping | 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 |
|---|---|
| accept(visitor) | Accepts a visitor. |
| acceptEnd(visitor) | Accepts a visitor for visiting the end of the StructuredDocumentTag. |
| acceptStart(visitor) | Accepts a visitor for visiting the start of the StructuredDocumentTag. |
| appendChild(newChild) | Adds the specified node to the end of the list of child nodes for this node. (Inherited from CompositeNode) |
| asBody() | Cast node to Body. (Inherited from Node) |
| asBookmarkEnd() | Cast node to BookmarkEnd. (Inherited from Node) |
| asBookmarkStart() | Cast node to BookmarkStart. (Inherited from Node) |
| asBuildingBlock() | Cast node to BuildingBlock. (Inherited from Node) |
| asCell() | Cast node to Cell. (Inherited from Node) |
| asComment() | Cast node to Comment. (Inherited from Node) |
| asCommentRangeEnd() | Cast node to CommentRangeEnd. (Inherited from Node) |
| asCommentRangeStart() | Cast node to CommentRangeStart. (Inherited from Node) |
| asCompositeNode() | Cast node to CompositeNode. (Inherited from Node) |
| asDocument() | Cast node to Node.document. (Inherited from Node) |
| asEditableRangeEnd() | Cast node to EditableRangeEnd. (Inherited from Node) |
| asEditableRangeStart() | Cast node to EditableRangeStart. (Inherited from Node) |
| asFieldEnd() | Cast node to FieldEnd. (Inherited from Node) |
| asFieldSeparator() | Cast node to FieldSeparator. (Inherited from Node) |
| asFieldStart() | Cast node to FieldStart. (Inherited from Node) |
| asFootnote() | Cast node to Footnote. (Inherited from Node) |
| asFormField() | Cast node to FormField. (Inherited from Node) |
| asGlossaryDocument() | Cast node to GlossaryDocument. (Inherited from Node) |
| asGroupShape() | Cast node to GroupShape. (Inherited from Node) |
| asHeaderFooter() | Cast node to HeaderFooter. (Inherited from Node) |
| asOfficeMath() | Cast node to OfficeMath. (Inherited from Node) |
| asParagraph() | Cast node to Paragraph. (Inherited from Node) |
| asRow() | Cast node to Row. (Inherited from Node) |
| asRun() | Cast node to Run. (Inherited from Node) |
| asSection() | Cast node to Section. (Inherited from Node) |
| asShape() | Cast node to Shape. (Inherited from Node) |
| asSmartTag() | Cast node to SmartTag. (Inherited from Node) |
| asSpecialChar() | Cast node to SpecialChar. (Inherited from Node) |
| asStructuredDocumentTag() | Cast node to StructuredDocumentTag. (Inherited from Node) |
| asStructuredDocumentTagRangeEnd() | Cast node to StructuredDocumentTagRangeEnd. (Inherited from Node) |
| asStructuredDocumentTagRangeStart() | Cast node to StructuredDocumentTagRangeStart. (Inherited from Node) |
| asSubDocument() | Cast node to SubDocument. (Inherited from Node) |
| asTable() | Cast node to Table. (Inherited from Node) |
| clear() | Clears contents of this structured document tag and displays a placeholder if it is defined. |
| clone(isCloneChildren) | Creates a duplicate of the node. (Inherited from Node) |
| getAncestor(ancestorType) | Gets the first ancestor of the specified NodeType. (Inherited from Node) |
| getBuildingBlock(index, isDeep) | (Inherited from CompositeNode) |
| getChild(nodeType, index, isDeep) | Returns an Nth child node that matches the specified type. (Inherited from CompositeNode) |
| getChildNodes(nodeType, isDeep) | Returns a live collection of child nodes that match the specified type. (Inherited from CompositeNode) |
| getComment(index, isDeep) | (Inherited from CompositeNode) |
| getEditableRangeStart(index, isDeep) | (Inherited from CompositeNode) |
| getFootnote(index, isDeep) | (Inherited from CompositeNode) |
| getGroupShape(index, isDeep) | (Inherited from CompositeNode) |
| getOfficeMath(index, isDeep) | (Inherited from CompositeNode) |
| getParagraph(index, isDeep) | (Inherited from CompositeNode) |
| getRun(index, isDeep) | (Inherited from CompositeNode) |
| getSdt(index, isDeep) | (Inherited from CompositeNode) |
| getSdtRangeEnd(index, isDeep) | (Inherited from CompositeNode) |
| getSdtRangeStart(index, isDeep) | (Inherited from CompositeNode) |
| getShape(index, isDeep) | (Inherited from CompositeNode) |
| getSmartTag(index, isDeep) | (Inherited from CompositeNode) |
| getTable(index, isDeep) | (Inherited from CompositeNode) |
| getText() | Gets the text of this node and of all its children. (Inherited from Node) |
| indexOf(child) | Returns the index of the specified child node in the child node array. (Inherited from CompositeNode) |
| insertAfter(newChild, refChild) | Inserts the specified node immediately after the specified reference node. (Inherited from CompositeNode) |
| insertBefore(newChild, refChild) | Inserts the specified node immediately before the specified reference node. (Inherited from CompositeNode) |
| nextPreOrder(rootNode) | Gets next node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| nodeTypeToString(nodeType) | A utility method that converts a node type enum value into a user friendly string. (Inherited from Node) |
| prependChild(newChild) | Adds the specified node to the beginning of the list of child nodes for this node. (Inherited from CompositeNode) |
| previousPreOrder(rootNode) | Gets the previous node according to the pre-order tree traversal algorithm. (Inherited from Node) |
| referenceEquals(other) | (Inherited from Node) |
| remove() | Removes itself from the parent. (Inherited from Node) |
| removeAllChildren() | Removes all the child nodes of the current node. (Inherited from CompositeNode) |
| removeChild(oldChild) | Removes the specified child node. (Inherited from CompositeNode) |
| removeSelfOnly() | Removes just this SDT node itself, but keeps the content of it inside the document tree. |
| removeSmartTags() | Removes all SmartTag descendant nodes of the current node. (Inherited from CompositeNode) |
| selectNodes(xpath) | Selects a list of nodes matching the XPath expression. (Inherited from CompositeNode) |
| selectSingleNode(xpath) | Selects the first Node that matches the XPath expression. (Inherited from CompositeNode) |
| setCheckedSymbol(characterCode, fontName) | Sets the symbol used to represent the checked state of a check box content control. |
| setUncheckedSymbol(characterCode, fontName) | Sets the symbol used to represent the unchecked state of a check box content control. |
| toString(saveFormat) | Exports the content of the node into a string in the specified format. (Inherited from Node) |
| toString(saveOptions) | Exports the content of the node into a string using the specified save options. (Inherited from Node) |
Examples
Shows how to work with styles for content control elements.
let doc = new aw.Document();
let builder = new aw.DocumentBuilder(doc);
// Below are two ways to apply a style from the document to a structured document tag.
// 1 - Apply a style object from the document's style collection:
let quoteStyle = doc.styles.at(aw.StyleIdentifier.Quote);
let sdtPlainText = new aw.Markup.StructuredDocumentTag(doc, aw.Markup.SdtType.PlainText, aw.Markup.MarkupLevel.Inline);
sdtPlainText.style = quoteStyle;
// 2 - Reference a style in the document by name:
let sdtRichText = new aw.Markup.StructuredDocumentTag(doc, aw.Markup.SdtType.RichText, aw.Markup.MarkupLevel.Inline);
sdtRichText.styleName = "Quote";
builder.insertNode(sdtPlainText);
builder.insertNode(sdtRichText);
expect(sdtPlainText.nodeType).toEqual(aw.NodeType.StructuredDocumentTag);
let tags = doc.getChildNodes(aw.NodeType.StructuredDocumentTag, true);
for (let node of tags)
{
let sdt = node.asStructuredDocumentTag();
console.log(sdt.wordOpenXMLMinimal);
expect(sdt.style.styleIdentifier).toEqual(aw.StyleIdentifier.Quote);
expect(sdt.styleName).toEqual("Quote");
}
See Also
- module Aspose.Words.Markup
- class CompositeNode