## FieldToc class Implementa il campo TOC. Per saperne di più, visita il[Lavorare con i campi](https://docs.aspose.com/words/net/working-with-fields/) articolo di documentazione. ```csharp public class FieldToc : Field ``` ## Costruttori | Nome | Descrizione | | --- | --- | | [FieldToc](fieldtoc/)() | Default_Costruttore | ## Proprietà | Nome | Descrizione | | --- | --- | | [BookmarkName](../../aspose.words.fields/fieldtoc/bookmarkname/) { get; set; } | Ottiene o imposta il nome del segnalibro che contrassegna la parte del documento utilizzata per creare la tabella. | | [CaptionlessTableOfFiguresLabel](../../aspose.words.fields/fieldtoc/captionlesstableoffigureslabel/) { get; set; } | Ottiene o imposta il nome dell'identificatore di sequenza utilizzato durante la creazione di una tabella di figure che non include l'etichetta e il numero della didascalia. | | [CustomStyles](../../aspose.words.fields/fieldtoc/customstyles/) { get; set; } | Ottiene o imposta un elenco di stili diversi dagli stili di intestazione predefiniti da includere nel sommario. | | [DisplayResult](../../aspose.words.fields/field/displayresult/) { get; } | Ottiene il testo che rappresenta il risultato del campo visualizzato. | | [End](../../aspose.words.fields/field/end/) { get; } | Ottiene il nodo che rappresenta la fine del campo. | | [EntryIdentifier](../../aspose.words.fields/fieldtoc/entryidentifier/) { get; set; } | Ottiene o imposta una stringa che dovrebbe corrispondere agli identificatori di tipo dei campi TC inclusi. | | [EntryLevelRange](../../aspose.words.fields/fieldtoc/entrylevelrange/) { get; set; } | Ottiene o imposta un intervallo di livelli delle voci del sommario da includere. | | [EntrySeparator](../../aspose.words.fields/fieldtoc/entryseparator/) { get; set; } | Ottiene o imposta una sequenza di caratteri che separano una voce dal suo numero di pagina. | | [Format](../../aspose.words.fields/field/format/) { get; } | Ottiene un[`FieldFormat`](../fieldformat/)oggetto che fornisce accesso tipizzato alla formattazione del campo. | | [HeadingLevelRange](../../aspose.words.fields/fieldtoc/headinglevelrange/) { get; set; } | Ottiene o imposta un intervallo di livelli di intestazione da includere. | | [HideInWebLayout](../../aspose.words.fields/fieldtoc/hideinweblayout/) { get; set; } | Ottiene o imposta se nascondere il leader della tabulazione e i numeri di pagina nella visualizzazione layout Web. | | [InsertHyperlinks](../../aspose.words.fields/fieldtoc/inserthyperlinks/) { get; set; } | Ottiene o imposta se rendere le voci del sommario collegamenti ipertestuali. | | [IsDirty](../../aspose.words.fields/field/isdirty/) { get; set; } | Ottiene o imposta se il risultato corrente del campo non è più corretto (obsoleto) a causa di altre modifiche apportate al documento. | | [IsLocked](../../aspose.words.fields/field/islocked/) { get; set; } | Ottiene o imposta se il campo è bloccato (non dovrebbe ricalcolare il suo risultato). | | [LocaleId](../../aspose.words.fields/field/localeid/) { get; set; } | Ottiene o imposta l'LCID del campo. | | [PageNumberOmittingLevelRange](../../aspose.words.fields/fieldtoc/pagenumberomittinglevelrange/) { get; set; } | Ottiene o imposta un intervallo di livelli delle voci del sommario da cui omettere i numeri di pagina. | | [PrefixedSequenceIdentifier](../../aspose.words.fields/fieldtoc/prefixedsequenceidentifier/) { get; set; } | Ottiene o imposta l'identificatore di una sequenza per la quale deve essere aggiunto un prefisso al numero di pagina della voce. | | [PreserveLineBreaks](../../aspose.words.fields/fieldtoc/preservelinebreaks/) { get; set; } | Ottiene o imposta se preservare i caratteri di nuova riga all'interno delle voci della tabella. | | [PreserveTabs](../../aspose.words.fields/fieldtoc/preservetabs/) { get; set; } | Ottiene o imposta se conservare le voci di tabulazione all'interno delle voci della tabella. | | [Result](../../aspose.words.fields/field/result/) { get; set; } | Ottiene o imposta il testo compreso tra il separatore di campo e la fine del campo. | | [Separator](../../aspose.words.fields/field/separator/) { get; } | Ottiene il nodo che rappresenta il separatore di campo. Può essere`null` . | | [SequenceSeparator](../../aspose.words.fields/fieldtoc/sequenceseparator/) { get; set; } | Ottiene o imposta la sequenza di caratteri utilizzata per separare i numeri di sequenza e i numeri di pagina. | | [Start](../../aspose.words.fields/field/start/) { get; } | Ottiene il nodo che rappresenta l'inizio del campo. | | [TableOfFiguresLabel](../../aspose.words.fields/fieldtoc/tableoffigureslabel/) { get; set; } | Ottiene o imposta il nome dell'identificatore di sequenza utilizzato durante la creazione di una tabella di figure. | | virtual [Type](../../aspose.words.fields/field/type/) { get; } | Ottiene il tipo di campo di Microsoft Word. | | [UseParagraphOutlineLevel](../../aspose.words.fields/fieldtoc/useparagraphoutlinelevel/) { get; set; } | Ottiene o imposta se utilizzare il livello di struttura del paragrafo applicato. | ## Metodi | Nome | Descrizione | | --- | --- | | [GetFieldCode](../../aspose.words.fields/field/getfieldcode/)() | Restituisce il testo tra l'inizio del campo e il separatore di campo (o la fine del campo se non c'è un separatore). Sono inclusi sia il codice di campo che il risultato del campo dei campi figlio. | | [GetFieldCode](../../aspose.words.fields/field/getfieldcode/)(*bool*) | Restituisce il testo tra l'inizio del campo e il separatore di campo (o la fine del campo se non c'è separatore). | | [Remove](../../aspose.words.fields/field/remove/)() | Rimuove il campo dal documento. Restituisce un nodo subito dopo il campo. Se la fine del campo è l'ultimo nodo figlio del suo nodo padre, restituisce il paragrafo padre. Se il campo è già stato rimosso, restituisce`null` . | | [Unlink](../../aspose.words.fields/field/unlink/)() | Esegue lo scollegamento del campo. | | [Update](../../aspose.words.fields/field/update/)() | Esegue l'aggiornamento del campo. Genera un'eccezione se il campo è già in fase di aggiornamento. | | [Update](../../aspose.words.fields/field/update/)(*bool*) | Esegue un aggiornamento di campo. Genera un'eccezione se il campo è già in fase di aggiornamento. | | [UpdatePageNumbers](../../aspose.words.fields/fieldtoc/updatepagenumbers/)() | Aggiorna i numeri di pagina per gli elementi di questo indice. | ## Osservazioni Crea un indice (che può anche essere un indice di figure) utilizzando le voci specificate dai campi TC, i loro livelli di intestazione e gli stili specificati e inserisce tale tabella in questo punto del documento. ## Esempi Mostra come inserire un indice e popolarlo con voci in base agli stili di intestazione. ```csharp public void FieldToc() { Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.StartBookmark("MyBookmark"); // Inserire un campo TOC, che compilerà tutte le intestazioni in un indice. // Per ogni titolo, questo campo creerà una riga con il testo in quello stile di titolo a sinistra, // e la pagina in cui appare l'intestazione sulla destra. FieldToc field = (FieldToc)builder.InsertField(FieldType.FieldTOC, true); // Utilizzare la proprietà BookmarkName per elencare solo le intestazioni // che compaiono all'interno dei limiti di un segnalibro con il nome "MyBookmark". field.BookmarkName = "MyBookmark"; // Il testo a cui è applicato uno stile di intestazione incorporato, ad esempio "Intestazione 1", verrà conteggiato come intestazione. // In questa proprietà possiamo nominare stili aggiuntivi da selezionare come titoli dall'indice e i relativi livelli di indice. field.CustomStyles = "Quote; 6; Intense Quote; 7"; // Per impostazione predefinita, i livelli Stili/TOC sono separati nella proprietà CustomStyles da una virgola, // ma possiamo impostare un delimitatore personalizzato in questa proprietà. doc.FieldOptions.CustomTocStyleSeparator = ";"; // Configurare il campo per escludere tutte le intestazioni con livelli di indice al di fuori di questo intervallo. field.HeadingLevelRange = "1-3"; // L'indice non visualizzerà i numeri di pagina dei titoli i cui livelli rientrano in questo intervallo. field.PageNumberOmittingLevelRange = "2-5"; // Imposta una stringa personalizzata che separerà ogni intestazione dal suo numero di pagina. 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"); // I numeri di pagina di queste due intestazioni saranno omessi perché rientrano nell'intervallo "2-5". InsertNewPageWithHeading(builder, "Fifth entry", "Heading 2"); InsertNewPageWithHeading(builder, "Sixth entry", "Heading 3"); // Questa voce non viene visualizzata perché "Titolo 4" è al di fuori dell'intervallo "1-3" impostato in precedenza. InsertNewPageWithHeading(builder, "Seventh entry", "Heading 4"); builder.EndBookmark("MyBookmark"); builder.Writeln("Paragraph text."); // Questa voce non viene visualizzata perché è esterna al segnalibro specificato dall'indice. 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"); } /// /// Inizia una nuova pagina e inserisci un paragrafo con uno stile specificato. /// 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]; } ``` Mostra come popolare un campo TOC con voci utilizzando i campi SEQ. ```csharp Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Un campo TOC può creare una voce nel suo indice per ogni campo SEQ trovato nel documento. // Ogni voce contiene il paragrafo che include il campo SEQ e il numero di pagina in cui appare il campo. FieldToc fieldToc = (FieldToc)builder.InsertField(FieldType.FieldTOC, true); // I campi SEQ visualizzano un conteggio che aumenta in ogni campo SEQ. // Questi campi mantengono anche conteggi separati per ogni sequenza denominata univoca // identificato dalla proprietà "SequenceIdentifier" del campo SEQ. // Utilizzare la proprietà "TableOfFiguresLabel" per assegnare un nome alla sequenza principale per l'indice. // Ora, questo TOC creerà voci solo dai campi SEQ con il loro "SequenceIdentifier" impostato su "MySequence". fieldToc.TableOfFiguresLabel = "MySequence"; // Possiamo nominare un'altra sequenza di campi SEQ nella proprietà "PrefixedSequenceIdentifier". // I campi SEQ di questa sequenza di prefissi non creeranno voci TOC. // Ogni voce TOC creata da un campo SEQ della sequenza principale ora visualizzerà anche il conteggio che // la sequenza del prefisso è attualmente attiva nel campo SEQ della sequenza primaria che ha creato la voce. fieldToc.PrefixedSequenceIdentifier = "PrefixSequence"; // Ogni voce del TOC visualizzerà il conteggio della sequenza del prefisso immediatamente a sinistra // del numero di pagina in cui appare il campo SEQ della sequenza principale. // Possiamo specificare un separatore personalizzato che apparirà tra questi due numeri. fieldToc.SequenceSeparator = ">"; Assert.AreEqual(" TOC \\c MySequence \\s PrefixSequence \\d >", fieldToc.GetFieldCode()); builder.InsertBreak(BreakType.PageBreak); // Esistono due modi per utilizzare i campi SEQ per popolare questo indice. // 1 - Inserimento di un campo SEQ appartenente alla sequenza di prefissi del TOC: // Questo campo incrementerà di 1 il conteggio delle sequenze SEQ per "PrefixSequence". // Poiché questo campo non appartiene alla sequenza principale identificata // tramite la proprietà "TableOfFiguresLabel" del TOC, non verrà visualizzato come voce. FieldSeq fieldSeq = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true); fieldSeq.SequenceIdentifier = "PrefixSequence"; builder.InsertParagraph(); Assert.AreEqual(" SEQ PrefixSequence", fieldSeq.GetFieldCode()); // 2 - Inserimento di un campo SEQ appartenente alla sequenza principale del TOC: // Questo campo SEQ creerà una voce nel sommario. // La voce TOC conterrà il paragrafo in cui si trova il campo SEQ e il numero della pagina in cui appare. // Questa voce mostrerà anche il conteggio attuale della sequenza di prefissi, // separato dal numero di pagina dal valore della proprietà SeqenceSeparator del TOC. // Il conteggio "PrefixSequence" è a 1, questo campo SEQ della sequenza principale si trova a pagina 2, // e il separatore è ">", quindi la voce visualizzerà "1>2". builder.Write("First TOC entry, MySequence #"); fieldSeq = (FieldSeq)builder.InsertField(FieldType.FieldSequence, true); fieldSeq.SequenceIdentifier = "MySequence"; Assert.AreEqual(" SEQ MySequence", fieldSeq.GetFieldCode()); // Inserisce una pagina, fa avanzare di 2 la sequenza del prefisso e inserisce un campo SEQ per creare in seguito una voce di sommario. // La sequenza del prefisso è ora a 2 e il campo SEQ della sequenza principale è a pagina 3, // quindi la voce TOC visualizzerà "2>3" al suo conteggio di pagine. 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"); ``` ### Guarda anche * class [Field](../field/) * spazio dei nomi [Aspose.Words.Fields](../../aspose.words.fields/) * assemblea [Aspose.Words](../../)