## FieldToc class Implements the TOC field. To learn more, visit the [Working with Fields](https://docs.aspose.com/words/net/working-with-fields/) documentation article. ```csharp public class FieldToc : Field ``` ## Constructors | Name | Description | | --- | --- | | [FieldToc](fieldtoc/)() | The default constructor. | ## Properties | Name | Description | | --- | --- | | [BookmarkName](../../aspose.words.fields/fieldtoc/bookmarkname/) { get; set; } | Gets or sets the name of the bookmark that marks the portion of the document used to build the table. | | [CaptionlessTableOfFiguresLabel](../../aspose.words.fields/fieldtoc/captionlesstableoffigureslabel/) { get; set; } | Gets or sets the name of the sequence identifier used when building a table of figures that does not include caption's label and number. | | [CustomStyles](../../aspose.words.fields/fieldtoc/customstyles/) { get; set; } | Gets or sets a list of styles other than the built-in heading styles to include in the table of contents. | | [DisplayResult](../../aspose.words.fields/field/displayresult/) { get; } | Gets the text that represents the displayed field result. | | [End](../../aspose.words.fields/field/end/) { get; } | Gets the node that represents the field end. | | [EntryIdentifier](../../aspose.words.fields/fieldtoc/entryidentifier/) { get; set; } | Gets or sets a string that should match type identifiers of TC fields being included. | | [EntryLevelRange](../../aspose.words.fields/fieldtoc/entrylevelrange/) { get; set; } | Gets or sets a range of levels of the table of contents entries to be included. | | [EntrySeparator](../../aspose.words.fields/fieldtoc/entryseparator/) { get; set; } | Gets or sets a sequence of characters that separate an entry and its page number. | | [Format](../../aspose.words.fields/field/format/) { get; } | Gets a [`FieldFormat`](../fieldformat/) object that provides typed access to field's formatting. | | [HeadingLevelRange](../../aspose.words.fields/fieldtoc/headinglevelrange/) { get; set; } | Gets or sets a range of heading levels to include. | | [HideInWebLayout](../../aspose.words.fields/fieldtoc/hideinweblayout/) { get; set; } | Gets or sets whether to hide tab leader and page numbers in Web layout view. | | [InsertHyperlinks](../../aspose.words.fields/fieldtoc/inserthyperlinks/) { get; set; } | Gets or sets whether to make the table of contents entries hyperlinks. | | [IsDirty](../../aspose.words.fields/field/isdirty/) { get; set; } | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | | [IsLocked](../../aspose.words.fields/field/islocked/) { get; set; } | Gets or sets whether the field is locked (should not recalculate its result). | | [LocaleId](../../aspose.words.fields/field/localeid/) { get; set; } | Gets or sets the LCID of the field. | | [PageNumberOmittingLevelRange](../../aspose.words.fields/fieldtoc/pagenumberomittinglevelrange/) { get; set; } | Gets or sets a range of levels of the table of contents entries from which to omits page numbers. | | [PrefixedSequenceIdentifier](../../aspose.words.fields/fieldtoc/prefixedsequenceidentifier/) { get; set; } | Gets or sets the identifier of a sequence for which a prefix should be added to the entry's page number. | | [PreserveLineBreaks](../../aspose.words.fields/fieldtoc/preservelinebreaks/) { get; set; } | Gets or sets whether to preserve newline characters within table entries. | | [PreserveTabs](../../aspose.words.fields/fieldtoc/preservetabs/) { get; set; } | Gets or sets whether to preserve tab entries within table entries. | | [Result](../../aspose.words.fields/field/result/) { get; set; } | Gets or sets text that is between the field separator and field end. | | [Separator](../../aspose.words.fields/field/separator/) { get; } | Gets the node that represents the field separator. Can be `null`. | | [SequenceSeparator](../../aspose.words.fields/fieldtoc/sequenceseparator/) { get; set; } | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. | | [Start](../../aspose.words.fields/field/start/) { get; } | Gets the node that represents the start of the field. | | [TableOfFiguresLabel](../../aspose.words.fields/fieldtoc/tableoffigureslabel/) { get; set; } | Gets or sets the name of the sequence identifier used when building a table of figures. | | virtual [Type](../../aspose.words.fields/field/type/) { get; } | Gets the Microsoft Word field type. | | [UseParagraphOutlineLevel](../../aspose.words.fields/fieldtoc/useparagraphoutlinelevel/) { get; set; } | Gets or sets whether to use the applied paragraph outline level. | ## Methods | Name | Description | | --- | --- | | [GetFieldCode](../../aspose.words.fields/field/getfieldcode/)() | Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. | | [GetFieldCode](../../aspose.words.fields/field/getfieldcode/)(*bool*) | Returns text between field start and field separator (or field end if there is no separator). | | virtual [Remove](../../aspose.words.fields/field/remove/)() | Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns `null`. | | [Unlink](../../aspose.words.fields/field/unlink/)() | Performs the field unlink. | | [Update](../../aspose.words.fields/field/update/)() | Performs the field update. Throws if the field is being updated already. | | [Update](../../aspose.words.fields/field/update/)(*bool*) | Performs a field update. Throws if the field is being updated already. | | [UpdatePageNumbers](../../aspose.words.fields/fieldtoc/updatepagenumbers/)() | Updates the page numbers for items in this table of contents. | ## Remarks Builds a table of contents (which can also be a table of figures) using the entries specified by TC fields, their heading levels, and specified styles, and inserts that table at this place in the document. ## Examples Shows how to insert a TOC, and populate it with entries based on heading styles. ```csharp Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.StartBookmark("MyBookmark"); // Insert a TOC field, which will compile all headings into a table of contents. // For each heading, this field will create a line with the text in that heading style to the left, // and the page the heading appears on to the right. FieldToc field = (FieldToc)builder.InsertField(FieldType.FieldTOC, true); // Use the BookmarkName property to only list headings // that appear within the bounds of a bookmark with the "MyBookmark" name. field.BookmarkName = "MyBookmark"; // Text with a built-in heading style, such as "Heading 1", applied to it will count as a heading. // We can name additional styles to be picked up as headings by the TOC in this property and their TOC levels. field.CustomStyles = "Quote; 6; Intense Quote; 7"; // By default, Styles/TOC levels are separated in the CustomStyles property by a comma, // but we can set a custom delimiter in this property. doc.FieldOptions.CustomTocStyleSeparator = ";"; // Configure the field to exclude any headings that have TOC levels outside of this range. field.HeadingLevelRange = "1-3"; // The TOC will not display the page numbers of headings whose TOC levels are within this range. field.PageNumberOmittingLevelRange = "2-5"; // Set a custom string that will separate every heading from its page number. 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"); // These two headings will have the page numbers omitted because they are within the "2-5" range. InsertNewPageWithHeading(builder, "Fifth entry", "Heading 2"); InsertNewPageWithHeading(builder, "Sixth entry", "Heading 3"); // This entry does not appear because "Heading 4" is outside of the "1-3" range that we have set earlier. InsertNewPageWithHeading(builder, "Seventh entry", "Heading 4"); builder.EndBookmark("MyBookmark"); builder.Writeln("Paragraph text."); // This entry does not appear because it is outside the bookmark specified by the TOC. InsertNewPageWithHeading(builder, "Eighth entry", "Heading 1"); Assert.That(field.GetFieldCode(), Is.EqualTo(" TOC \\b MyBookmark \\t \"Quote; 6; Intense Quote; 7\" \\o 1-3 \\n 2-5 \\p - \\h \\x \\w")); field.UpdatePageNumbers(); doc.UpdateFields(); doc.Save(ArtifactsDir + "Field.TOC.docx"); ``` Shows how to insert a TOC, and populate it with entries based on heading styles (InsertNewPageWithHeading). ```csharp /// /// Start a new page and insert a paragraph of a specified style. /// 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]; } ``` Shows how to populate a TOC field with entries using SEQ fields. ```csharp Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // A TOC field can create an entry in its table of contents for each SEQ field found in the document. // Each entry contains the paragraph that includes the SEQ field and the page's number that the field appears on. FieldToc fieldToc = (FieldToc)builder.InsertField(FieldType.FieldTOC, true); // SEQ fields display a count that increments at each SEQ field. // These fields also maintain separate counts for each unique named sequence // identified by the SEQ field's "SequenceIdentifier" property. // Use the "TableOfFiguresLabel" property to name a main sequence for the TOC. // Now, this TOC will only create entries out of SEQ fields with their "SequenceIdentifier" set to "MySequence". fieldToc.TableOfFiguresLabel = "MySequence"; // We can name another SEQ field sequence in the "PrefixedSequenceIdentifier" property. // SEQ fields from this prefix sequence will not create TOC entries. // Every TOC entry created from a main sequence SEQ field will now also display the count that // the prefix sequence is currently on at the primary sequence SEQ field that made the entry. fieldToc.PrefixedSequenceIdentifier = "PrefixSequence"; // Each TOC entry will display the prefix sequence count immediately to the left // of the page number that the main sequence SEQ field appears on. // We can specify a custom separator that will appear between these two numbers. fieldToc.SequenceSeparator = ">"; Assert.That(fieldToc.GetFieldCode(), Is.EqualTo(" TOC \\c MySequence \\s PrefixSequence \\d >")); builder.InsertBreak(BreakType.PageBreak); // There are two ways of using SEQ fields to populate this TOC. // 1 - Inserting a SEQ field that belongs to the TOC's prefix sequence: // This field will increment the SEQ sequence count for the "PrefixSequence" by 1. // Since this field does not belong to the main sequence identified // by the "TableOfFiguresLabel" property of the TOC, it will not appear as an entry. FieldSeq fieldSeq = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true); fieldSeq.SequenceIdentifier = "PrefixSequence"; builder.InsertParagraph(); Assert.That(fieldSeq.GetFieldCode(), Is.EqualTo(" SEQ PrefixSequence")); // 2 - Inserting a SEQ field that belongs to the TOC's main sequence: // This SEQ field will create an entry in the TOC. // The TOC entry will contain the paragraph that the SEQ field is in and the number of the page that it appears on. // This entry will also display the count that the prefix sequence is currently at, // separated from the page number by the value in the TOC's SeqenceSeparator property. // The "PrefixSequence" count is at 1, this main sequence SEQ field is on page 2, // and the separator is ">", so entry will display "1>2". builder.Write("First TOC entry, MySequence #"); fieldSeq = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true); fieldSeq.SequenceIdentifier = "MySequence"; Assert.That(fieldSeq.GetFieldCode(), Is.EqualTo(" SEQ MySequence")); // Insert a page, advance the prefix sequence by 2, and insert a SEQ field to create a TOC entry afterwards. // The prefix sequence is now at 2, and the main sequence SEQ field is on page 3, // so the TOC entry will display "2>3" at its page count. 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"); ``` ### See Also * class [Field](../field/) * namespace [Aspose.Words.Fields](../../aspose.words.fields/) * assembly [Aspose.Words](../../)