ListFormat

ListFormat class

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

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

public class ListFormat

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

ИмяОписание
IsListItem { get; }Истинно, если к абзацу применено маркированное или нумерованное форматирование.
List { get; set; }Возвращает или задает список, членом которого является этот абзац.
ListLevel { get; }Возвращает форматирование уровня списка плюс любые переопределения форматирования, примененные к текущему абзацу.
ListLevelNumber { get; set; }Возвращает или задает номер уровня списка (от 0 до 8) для абзаца.

Методы

ИмяОписание
ApplyBulletDefault()Начинает новый маркированный список по умолчанию и применяет его к абзацу.
ApplyNumberDefault()Начинает новый нумерованный список по умолчанию и применяет его к абзацу.
ListIndent()Увеличивает уровень списка текущего абзаца на один уровень.
ListOutdent()Уменьшает уровень списка текущего абзаца на один уровень.
RemoveNumbers()Удаляет номера или маркеры из текущего абзаца и устанавливает уровень списка на ноль.

Примечания

Абзац в документе Microsoft Word может быть маркированным или нумерованным. Когда абзац маркирован или нумерован, говорят, что к нему применено форматирование списка .

Вы не создаете объектыListFormat класс напрямую. Вы получаете доступListFormatкак свойство другого объекта, который can имеет связанное с ним форматирование списка. На данный момент объекты, которые can имеют форматирование списка, следующие:Paragraph , Style иDocumentBuilder.

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

ListFormat изStyle (applicable только для стилей абзацев) позволяет указать, какое форматирование списка и уровень списка применяются ко всем абзацам этого конкретного стиля.

ListFormat изDocumentBuilder обеспечивает доступ к форматированию списка в текущей позиции курсора внутриDocumentBuilder.

Само форматирование списка хранится внутриList объект, который хранится отдельно от абзацев. Список объектов хранится внутриListCollection Коллекция. Есть single ListCollection сбор заDocument.

Параграфы физически не принадлежат списку. Параграфы just ссылаются на конкретный объект списка черезList property и определенный уровень в списке черезListLevelNumber property. Задавая эти два свойства, вы управляете тем, какие маркеры и нумерация применяются к абзацу.

Примеры

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

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");

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

ListCollection Class ListLabel Class