FieldToc

FieldToc class

Реализует поле TOC.

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

public class FieldToc : Field

Конструкторы

Имя	Описание
FieldToc()	Конструктор по умолчанию.

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

Имя	Описание
BookmarkName { get; set; }	Получает или задает имя закладки, которая отмечает часть документа, использованную для построения таблицы.
CaptionlessTableOfFiguresLabel { get; set; }	Получает или задает имя идентификатора последовательности, используемого при построении таблицы рисунков, которая не включает метку и номер caption .
CustomStyles { get; set; }	Получает или задает список стилей, отличных от встроенных стилей заголовков, для включения в оглавление.
DisplayResult { get; }	Получает текст, представляющий результат отображаемого поля.
End { get; }	Получает узел, представляющий конец поля.
EntryIdentifier { get; set; }	Получает или задает строку, которая должна соответствовать идентификаторам типов включаемых полей TC.
EntryLevelRange { get; set; }	Получает или задает диапазон уровней включаемых записей оглавления.
EntrySeparator { get; set; }	Получает или задает последовательность символов, разделяющую запись и номер ее страницы.
Format { get; }	Получает`FieldFormat` объект, обеспечивающий типизированный доступ к форматированию поля.
HeadingLevelRange { get; set; }	Получает или задает диапазон уровней заголовков, которые необходимо включить.
HideInWebLayout { get; set; }	Получает или задает, следует ли скрывать заголовок табуляции и номера страниц в представлении веб-макета.
InsertHyperlinks { get; set; }	Получает или задает, следует ли создавать гиперссылки на записи оглавления.
IsDirty { get; set; }	Получает или устанавливает, является ли текущий результат поля более неправильным (устаревшим) из-за других изменений, внесенных в документ.
IsLocked { get; set; }	Получает или задает, заблокировано ли поле (не следует пересчитывать результат).
LocaleId { get; set; }	Получает или задает LCID поля.
PageNumberOmittingLevelRange { get; set; }	Получает или задает диапазон уровней записей оглавления, из которых можно опустить номера страниц.
PrefixedSequenceIdentifier { get; set; }	Получает или задает идентификатор последовательности, для которой к номеру страницы записи следует добавить префикс.
PreserveLineBreaks { get; set; }	Получает или задает, сохранять ли символы новой строки в записях таблицы.
PreserveTabs { get; set; }	Получает или задает, сохранять ли записи вкладок в записях таблицы.
Result { get; set; }	Получает или задает текст, расположенный между разделителем полей и концом поля.
Separator { get; }	Получает узел, представляющий разделитель полей. Возможно`нулевой` .
SequenceSeparator { get; set; }	Получает или задает последовательность символов, которая используется для разделения порядковых номеров и номеров страниц.
Start { get; }	Получает узел, представляющий начало поля.
TableOfFiguresLabel { get; set; }	Получает или задает имя идентификатора последовательности, используемого при построении таблицы рисунков.
virtual Type { get; }	Получает тип поля Microsoft Word.
UseParagraphOutlineLevel { get; set; }	Получает или задает, следует ли использовать примененный уровень структуры абзаца.

Методы

Имя	Описание
GetFieldCode()	Возвращает текст между началом поля и разделителем поля (или концом поля, если разделителя нет). Включены как код поля, так и результат поля дочерних полей.
GetFieldCode(bool)	Возвращает текст между началом поля и разделителем полей (или концом поля, если разделителя нет).
Remove()	Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля является последним дочерним его родительского узла, возвращает его родительский абзац. Если поле уже удалено, возвращается`нулевой` .
Unlink()	Выполняет отсоединение поля.
Update()	Выполняет обновление поля. Выдает, если поле уже обновляется.
Update(bool)	Выполняет обновление поля. Выдает, если поле уже обновляется.
UpdatePageNumbers()	Обновляет номера страниц для элементов в этом оглавлении.

Примечания

Создает оглавление (которое также может быть таблицей рисунков) с использованием записей, указанных в полях TC, их уровней заголовков и указанных стилей, и вставляет эту таблицу в это место документа.

Примеры

Показывает, как вставить оглавление и заполнить его записями на основе стилей заголовков.

public void FieldToc()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    builder.StartBookmark("MyBookmark");

    // Вставьте поле оглавления, которое объединит все заголовки в оглавление.
    // Для каждого заголовка это поле создаст строку с текстом этого стиля заголовка слева,
    // и страница, на которой заголовок отображается справа.
    FieldToc field = (FieldToc)builder.InsertField(FieldType.FieldTOC, true);

    // Используйте свойство BookmarkName, чтобы отображать только заголовки
    // которые появляются в пределах закладки с именем «MyBookmark».
    field.BookmarkName = "MyBookmark";

    // Текст со встроенным стилем заголовка, например «Заголовок 1», примененный к нему, будет считаться заголовком.
    // Мы можем назвать дополнительные стили, которые будут выбраны в качестве заголовков по оглавлению в этом свойстве и их уровням оглавления.
    field.CustomStyles = "Quote; 6; Intense Quote; 7";

    // По умолчанию уровни Styles/TOC разделяются в свойстве CustomStyles запятой,
    // но мы можем установить в этом свойстве собственный разделитель.
    doc.FieldOptions.CustomTocStyleSeparator = ";";

    // Настройте поле, чтобы исключить любые заголовки, содержание содержания которых выходит за пределы этого диапазона.
    field.HeadingLevelRange = "1-3";

    // Содержание не будет отображать номера страниц заголовков, уровни содержания которых находятся в этом диапазоне.
    field.PageNumberOmittingLevelRange = "2-5";

     // Установите специальную строку, которая будет отделять каждый заголовок от номера страницы.
    field.EntrySeparator = "-";
    field.InsertHyperlinks = true;
    field.HideInWebLayout = false;
    field.PreserveLineBreaks = true;
    field.PreserveTabs = true;
    field.UseParagraphOutlineLevel = false;

    InsertNewPageWithHeading(builder, "First entry", "Heading 1");
    builder.Writeln("Paragraph text.");
    InsertNewPageWithHeading(builder, "Second entry", "Heading 1");
    InsertNewPageWithHeading(builder, "Third entry", "Quote");
    InsertNewPageWithHeading(builder, "Fourth entry", "Intense Quote");

    // В этих двух заголовках номера страниц будут опущены, поскольку они находятся в диапазоне «2–5».
    InsertNewPageWithHeading(builder, "Fifth entry", "Heading 2");
    InsertNewPageWithHeading(builder, "Sixth entry", "Heading 3");

    // Эта запись не отображается, поскольку «Заголовок 4» находится за пределами диапазона «1-3», который мы установили ранее.
    InsertNewPageWithHeading(builder, "Seventh entry", "Heading 4");

    builder.EndBookmark("MyBookmark");
    builder.Writeln("Paragraph text.");

    // Эта запись не отображается, поскольку она находится за пределами закладки, указанной в оглавлении.
    InsertNewPageWithHeading(builder, "Eighth entry", "Heading 1");

    Assert.AreEqual(" TOC  \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w", field.GetFieldCode());

    field.UpdatePageNumbers();
    doc.UpdateFields();
    doc.Save(ArtifactsDir + "Field.TOC.docx");
}

/// <summary>
/// Начните новую страницу и вставьте абзац указанного стиля.
/// </summary>
public void InsertNewPageWithHeading(DocumentBuilder builder, string captionText, string styleName)
{
    builder.InsertBreak(BreakType.PageBreak);
    string originalStyle = builder.ParagraphFormat.StyleName;
    builder.ParagraphFormat.Style = builder.Document.Styles[styleName];
    builder.Writeln(captionText);
    builder.ParagraphFormat.Style = builder.Document.Styles[originalStyle];
}

Показывает, как заполнить поле TOC записями с использованием полей SEQ.

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

// Поле TOC может создавать запись в своей таблице содержания для каждого поля SEQ, найденного в документе.
// Каждая запись содержит абзац, включающий поле SEQ и номер страницы, на которой отображается это поле.
FieldToc fieldToc = (FieldToc)builder.InsertField(FieldType.FieldTOC, true);

// Поля SEQ отображают счетчик, который увеличивается в каждом поле SEQ.
// Эти поля также поддерживают отдельные счетчики для каждой уникальной именованной последовательности
// идентифицируется свойством SequenceIdentifier поля SEQ.
// Используйте свойство TableOfFiguresLabel, чтобы назвать основную последовательность оглавления.
// Теперь этот TOC будет создавать записи только из полей SEQ, для которых для параметра «SequenceIdentifier» установлено значение «MySequence».
fieldToc.TableOfFiguresLabel = "MySequence";

// Мы можем назвать другую последовательность полей SEQ в свойстве «PrefixedSequenceIdentifier».
 // Поля SEQ из этой последовательности префиксов не будут создавать записи TOC.
// Каждая запись TOC, созданная из поля SEQ основной последовательности, теперь также будет отображать количество, которое
// последовательность префикса в настоящее время включена в поле SEQ основной последовательности, в котором была сделана запись.
fieldToc.PrefixedSequenceIdentifier = "PrefixSequence";

// Каждая запись оглавления будет отображать счетчик последовательности префикса сразу слева
// номера страницы, на которой отображается поле SEQ основной последовательности.
// Мы можем указать собственный разделитель, который будет стоять между этими двумя числами.
fieldToc.SequenceSeparator = ">";

Assert.AreEqual(" TOC  \\c MySequence \\s PrefixSequence \\d >", fieldToc.GetFieldCode());

builder.InsertBreak(BreakType.PageBreak);

// Существует два способа использования полей SEQ для заполнения этого содержания.
// 1 – Вставка поля SEQ, которое принадлежит последовательности префикса TOC:
// Это поле увеличит счетчик последовательностей SEQ для «PrefixSequence» на 1.
// Так как это поле не принадлежит идентифицированной основной последовательности
// по свойству «TableOfFiguresLabel» оглавления, оно не будет отображаться как запись.
FieldSeq fieldSeq = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true);
fieldSeq.SequenceIdentifier = "PrefixSequence";
builder.InsertParagraph();

Assert.AreEqual(" SEQ  PrefixSequence", fieldSeq.GetFieldCode());

// 2 – Вставка поля SEQ, которое принадлежит основной последовательности TOC:
// Это поле SEQ создаст запись в оглавлении.
// Запись оглавления будет содержать абзац, в котором находится поле SEQ, и номер страницы, на которой оно появляется.
// Эта запись также будет отображать счетчик, на котором в данный момент находится последовательность префикса,
// отделено от номера страницы значением свойства SeqenceSeparator оглавления.
// Счетчик «PrefixSequence» равен 1, это поле SEQ основной последовательности находится на странице 2,
// и разделителем является «>», поэтому в записи будет отображаться «1>2».
builder.Write("First TOC entry, MySequence #");
fieldSeq = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true);
fieldSeq.SequenceIdentifier = "MySequence";

Assert.AreEqual(" SEQ  MySequence", fieldSeq.GetFieldCode());

// Вставьте страницу, увеличьте последовательность префиксов на 2 и вставьте поле SEQ, чтобы впоследствии создать запись оглавления.
// Последовательность префикса теперь равна 2, а поле SEQ основной последовательности находится на странице 3,
// поэтому запись оглавления будет отображать "2>3" при количестве страниц.
builder.InsertBreak(BreakType.PageBreak);
fieldSeq = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true);
fieldSeq.SequenceIdentifier = "PrefixSequence";
builder.InsertParagraph();
fieldSeq = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true);
builder.Write("Second TOC entry, MySequence #");
fieldSeq.SequenceIdentifier = "MySequence";

doc.UpdateFields();
doc.Save(ArtifactsDir + "Field.TOC.SEQ.docx");

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

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

FieldToa Class FieldType Enum