ListCollection

ListCollection class

Хранит и управляет форматированием маркированных и нумерованных списков, используемых в документе.

Чтобы узнать больше, посетитеРабота со списками статья документации.

public class ListCollection : IEnumerable<List>

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

Имя	Описание
Count { get; }	Получает количество нумерованных и маркированных списков в документе.
Document { get; }	Получает документ владельца.
Item { get; }	Получает список по индексу.

Методы

Имя	Описание
Add(ListTemplate)	Создает новый список на основе предопределенного шаблона и добавляет его в коллекцию списков в документе.
Add(Style)	Создает новый список, ссылающийся на стиль списка, и добавляет его в коллекцию списков в документе.
AddCopy(List)	Создает новый список, копируя указанный список и добавляя его в коллекцию списков в документе.
GetEnumerator()	Получает объект перечислителя, который будет перечислять списки в документе.
GetListByListId(int)	Получает список по идентификатору списка.

Примечания

Список в документе Microsoft Word представляет собой набор свойств форматирования списка. Форматирование списков хранится вListCollection сбор отдельно из абзацев текста.

Вы не создаете объекты этого класса. Всегда есть только одинListCollection для каждого документа и доступен черезLists свойство.

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

Чтобы создать новый список с форматированием, идентичным существующему списку, используйте командуAddCopy метод.

Чтобы сделать абзац маркированным или нумерованным, вам необходимо применить к абзацу list formatting , присвоив емуListвозражать против the List свойствоListFormat.

Чтобы удалить форматирование списка из абзаца, используйте командуRemoveNumbers метод.

Если вы немного знакомы с WordprocessingML, то, возможно, знаете, что он определяет отдельные Concept для «списка» и «определения списка». Это в точности соответствует тому, как форматирование списка хранится в документе Microsoft Word на нижнем уровне. Определение списка похоже на «схему», а список — на экземпляр определения списка.

Чтобы упростить модель программирования, Aspose.Words скрывает различие между определением list и list почти так же, как Microsoft Word скрывает это в своем пользовательском интерфейсе. Это позволяет вам больше сосредоточиться на том, как вы хотите, чтобы ваш документ выглядел, а не на создание объектов низкого уровня для удовлетворения требований формата файлов Microsoft Word.

Невозможно удалить списки после их создания в текущей версии Aspose.Words. . Это похоже на Microsoft Word, где пользователь не имеет явного контроля над определениями списков.

Примеры

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

public void PrintOutAllLists()
{
    Document srcDoc = new Document(MyDir + "Rendering.docx");

    Document dstDoc = new Document();
    DocumentBuilder builder = new DocumentBuilder(dstDoc);

    foreach (List srcList in srcDoc.Lists)
    {
        List dstList = dstDoc.Lists.AddCopy(srcList);
        AddListSample(builder, dstList);
    }

    dstDoc.Save(ArtifactsDir + "Lists.PrintOutAllLists.docx");
}

private static void AddListSample(DocumentBuilder builder, List list)
{
    builder.Writeln("Sample formatting of list with ListId:" + list.ListId);
    builder.ListFormat.List = list;
    for (int i = 0; i < list.ListLevels.Count; i++)
    {
        builder.ListFormat.ListLevelNumber = i;
        builder.Writeln("Level " + i);
    }

    builder.ListFormat.RemoveNumbers();
    builder.Writeln();
}

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

Document doc = new Document();

// Список позволяет нам организовывать и украшать наборы абзацев префиксными символами и отступами.
 // Мы можем создавать вложенные списки, увеличивая уровень отступа.
 // Мы можем начать и закончить список, используя свойство ListFormat конструктора документов.
// Каждый абзац, который мы добавляем между началом и концом списка, станет элементом списка.
// Создайте список из шаблона Microsoft Word и настройте его первый уровень списка.
List list1 = doc.Lists.Add(ListTemplate.NumberArabicParenthesis);
list1.ListLevels[0].Font.Color = Color.Red;
list1.ListLevels[0].Alignment = ListLevelAlignment.Right;

// Применяем наш список к некоторым абзацам.
DocumentBuilder builder = new DocumentBuilder(doc);

builder.Writeln("List 1 starts below:");
builder.ListFormat.List = list1;
builder.Writeln("Item 1");
builder.Writeln("Item 2");
builder.ListFormat.RemoveNumbers();

// Мы можем добавить копию существующего списка в коллекцию списков документа
// для создания аналогичного списка без внесения изменений в исходный.
List list2 = doc.Lists.AddCopy(list1);
list2.ListLevels[0].Font.Color = Color.Blue;
list2.ListLevels[0].StartAt = 10;

// Применяем второй список к новым абзацам.
builder.Writeln("List 2 starts below:");
builder.ListFormat.List = list2;
builder.Writeln("Item 1");
builder.Writeln("Item 2");
builder.ListFormat.RemoveNumbers();

doc.Save(ArtifactsDir + "Lists.RestartNumberingUsingListCopy.docx");

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

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

Assert.False(builder.ListFormat.IsListItem);

// Список позволяет нам организовывать и украшать наборы абзацев префиксными символами и отступами.
 // Мы можем создавать вложенные списки, увеличивая уровень отступа.
 // Мы можем начать и закончить список, используя свойство ListFormat конструктора документов.
// Каждый абзац, который мы добавляем между началом и концом списка, станет элементом списка.
// Ниже приведены два типа списков, которые мы можем создать с помощью конструктора документов.
// 1 - Нумерованный список:
// Нумерованные списки создают логический порядок абзацев путем нумерации каждого элемента.
builder.ListFormat.List = doc.Lists.Add(ListTemplate.NumberDefault);

Assert.True(builder.ListFormat.IsListItem);

// Установив свойство ListLevelNumber, мы можем повысить уровень списка
// чтобы начать автономный подсписок с текущего элемента списка.
// Шаблон списка Microsoft Word под названием «NumberDefault» использует числа для создания уровней списка для первого уровня списка.
 // На более глубоких уровнях списка используются буквы и строчные римские цифры.
for (int i = 0; i < 9; i++)
{
    builder.ListFormat.ListLevelNumber = i;
    builder.Writeln("Level " + i);
}

// 2 - Маркированный список:
// Этот список будет применять отступ и символ маркера («•») перед каждым абзацем.
// На более глубоких уровнях этого списка будут использоваться другие символы, например «■» и «○».
builder.ListFormat.List = doc.Lists.Add(ListTemplate.BulletDefault);

for (int i = 0; i < 9; i++)
{
    builder.ListFormat.ListLevelNumber = i;
    builder.Writeln("Level " + i);
}

// Мы можем отключить форматирование списка, чтобы не форматировать последующие абзацы как списки, сняв флаг «Список».
builder.ListFormat.List = null;

Assert.False(builder.ListFormat.IsListItem);

doc.Save(ArtifactsDir + "Lists.SpecifyListLevel.docx");

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

class List
пространство имен Aspose.Words.Lists
сборка Aspose.Words

List Class ListFormat Class