SdtListItemCollection

SdtListItemCollection class

Bietet Zugriff aufSdtListItem Elemente eines strukturierten Dokument-Tags.

Um mehr zu erfahren, besuchen Sie dieStrukturierte Dokument-Tags oder Inhaltssteuerung Dokumentationsartikel.

public class SdtListItemCollection : IEnumerable<SdtListItem>

Eigenschaften

NameBeschreibung
Count { get; }Ruft die Anzahl der Elemente in der Sammlung ab.
Item { get; }Gibt einenSdtListItem Objekt mit seinem nullbasierten Index in der Sammlung.
SelectedValue { get; set; }Gibt den aktuell ausgewählten Wert in dieser Liste an. Nullwert zulässig, was bedeutet, dass dieser Listenelementsammlung kein aktuell ausgewählter Eintrag zugeordnet ist.

Methoden

NameBeschreibung
Add(SdtListItem)Fügt dieser Sammlung ein Element hinzu.
Clear()Löscht alle Elemente aus dieser Sammlung.
GetEnumerator()Gibt ein Enumeratorobjekt zurück, mit dem alle Elemente in der Sammlung durchlaufen werden können.
RemoveAt(int)Entfernt ein Listenelement am angegebenen Index.

Beispiele

Zeigt, wie mit Dokument-Tags in Form von Dropdown-Listen gearbeitet wird.

Document doc = new Document();
StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DropDownList, MarkupLevel.Block);
doc.FirstSection.Body.AppendChild(tag);

// Ein Dropdown-Listen-strukturiertes Dokument-Tag ist ein Formular, das dem Benutzer erlaubt,
// Wählen Sie eine Option aus einer Liste aus, indem Sie mit der linken Maustaste klicken und das Formular in Microsoft Word öffnen.
// Die Eigenschaft „ListItems“ enthält alle Listenelemente und jedes Listenelement ist ein „SdtListItem“.
SdtListItemCollection listItems = tag.ListItems;
listItems.Add(new SdtListItem("Value 1"));

Assert.AreEqual(listItems[0].DisplayText, listItems[0].Value);

// Füge drei weitere Listenelemente hinzu. Initialisiere diese Elemente mit einem anderen Konstruktor als das erste Element.
// um Zeichenfolgen anzuzeigen, die sich von ihren Werten unterscheiden.
listItems.Add(new SdtListItem("Item 2", "Value 2"));
listItems.Add(new SdtListItem("Item 3", "Value 3"));
listItems.Add(new SdtListItem("Item 4", "Value 4"));

Assert.AreEqual(4, listItems.Count);

// Die Dropdown-Liste zeigt das erste Element an. Weisen Sie dem „SelectedValue“ ein anderes Listenelement zu, um es anzuzeigen.
listItems.SelectedValue = listItems[3];

Assert.AreEqual("Value 4", listItems.SelectedValue.Value);

// Durchlaufen Sie die Sammlung und drucken Sie jedes Element.
using (IEnumerator<SdtListItem> enumerator = listItems.GetEnumerator())
{
    while (enumerator.MoveNext())
        if (enumerator.Current != null)
            Console.WriteLine($"List item: {enumerator.Current.DisplayText}, value: {enumerator.Current.Value}");
}

    // Entfernen Sie das letzte Listenelement.
listItems.RemoveAt(3);

Assert.AreEqual(3, listItems.Count);

// Da unser Dropdown-Steuerelement standardmäßig so eingestellt ist, dass das entfernte Element angezeigt wird, geben Sie ihm ein Element zur Anzeige, das vorhanden ist.
listItems.SelectedValue = listItems[1];

doc.Save(ArtifactsDir + "StructuredDocumentTag.ListItemCollection.docx");

// Verwenden Sie die Methode „Clear“, um die gesamte Dropdown-Elementsammlung auf einmal zu leeren.
listItems.Clear();

Assert.AreEqual(0, listItems.Count);

Siehe auch