SdtListItemCollection

SdtListItemCollection class

Обеспечивает доступ кSdtListItem элементы тега структурированного документа.

Чтобы узнать больше, посетитеСтруктурированные теги документа или контроль содержимого статья документации.

public class SdtListItemCollection : IEnumerable<SdtListItem>

Характеристики

ИмяОписание
Count { get; }Получает количество элементов в коллекции.
Item { get; }ВозвращаетSdtListItem объекту с учетом его нулевого индекса в коллекции.
SelectedValue { get; set; }Указывает текущее выбранное значение в этом списке. Допустимо нулевое значение, что означает, что ни одна выбранная в данный момент запись не связана с этой коллекцией элементов списка.

Методы

ИмяОписание
Add(SdtListItem)Добавляет элемент в эту коллекцию.
Clear()Удаляет все элементы из этой коллекции.
GetEnumerator()Возвращает объект перечислителя, который можно использовать для перебора всех элементов коллекции.
RemoveAt(int)Удаляет элемент списка по указанному индексу.

Примеры

Показывает, как работать с тегами структурированных документов с раскрывающимся списком.

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

// Тег структурированного документа с раскрывающимся списком — это форма, которая позволяет пользователю
// выбираем вариант из списка, щелкнув левой кнопкой мыши и открыв форму в Microsoft Word.
// Свойство «ListItems» содержит все элементы списка, и каждый элемент списка является «SdtListItem».
SdtListItemCollection listItems = tag.ListItems;
listItems.Add(new SdtListItem("Value 1"));

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

// Добавляем еще 3 элемента списка. Инициализируйте эти элементы, используя конструктор, отличный от первого элемента.
// для отображения строк, отличных от их значений.
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);

// В раскрывающемся списке отображается первый элемент. Назначьте другой элемент списка «SelectedValue», чтобы отобразить его.
listItems.SelectedValue = listItems[3];

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

// Перебираем коллекцию и печатаем каждый элемент.
using (IEnumerator<SdtListItem> enumerator = listItems.GetEnumerator())
{
    while (enumerator.MoveNext())
        if (enumerator.Current != null)
            Console.WriteLine($"List item: {enumerator.Current.DisplayText}, value: {enumerator.Current.Value}");
}

 // Удалить последний элемент списка.
listItems.RemoveAt(3);

Assert.AreEqual(3, listItems.Count);

// Поскольку наш раскрывающийся список по умолчанию настроен на отображение удаленного элемента, дайте ему отображаемый элемент, который существует.
listItems.SelectedValue = listItems[1];

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

// Используйте метод «Очистить», чтобы сразу очистить всю коллекцию раскрывающихся элементов.
listItems.Clear();

Assert.AreEqual(0, listItems.Count);

Смотрите также

SdtListItem Class SdtType Enum