跳到主要内容

GetContentControlsByTag

Returns a list of all content controls in the document with the specified tag name.

Syntax

expression.GetContentControlsByTag(sTag);

expression - A variable that represents a ApiDocument class.

Parameters

NameRequired/OptionalData typeDefaultDescription
sTagRequiredstringContent control tag.

Returns

ApiBlockLvlSdt[] | ApiInlineLvlSdt[]

Example

This example shows how to get a list of all content controls in the document with the specified tag name.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
let inlineLvlSdt = Api.CreateInlineLvlSdt();
paragraph.AddInlineLvlSdt(inlineLvlSdt);
inlineLvlSdt.AddText("Inline content control");
inlineLvlSdt.SetTag("Tag 1");
let blockLvlSdt = Api.CreateBlockLvlSdt();
blockLvlSdt.GetContent().GetElement(0).AddText("Block text content control");
blockLvlSdt.SetTag("Tag 2");
doc.AddElement(0, blockLvlSdt);
let contentControls = doc.GetContentControlsByTag("Tag 1");
contentControls[0].SetAlias("№1");