InsertTableOfContents

DocumentBuilder.InsertTableOfContents method

Insère un champ TOC (table des matières) dans le document.

public Field InsertTableOfContents(string switches)
ParamètreTaperLa description
switchesStringLe champ TOC change.

Remarques

Cette méthode insère un champ TOC (table des matières) dans le document à la position actuelle.

Dans un document Word, la table des matières peut être construite de plusieurs manières et mise en forme grâce à diverses options. La manière dont la table est construite et affichée par Microsoft Word est contrôlée par les commutateurs de champ.

Le moyen le plus simple de spécifier les commutateurs est d’insérer et de configurer une table des matières dans un document Word via le menu « Insertion > Référence > Index et tables », puis d’activer l’affichage des codes de champ pour visualiser les commutateurs. Vous pouvez appuyer sur Alt+F9 dans Microsoft Word pour activer ou désactiver l’affichage des codes de champ.

Par exemple, après avoir créé une table des matières, le champ suivant est inséré dans le document :{ TOC \o “1-3” \h \z \u } . Vous pouvez copier**\o “1-3” \h \z \u** et l’utiliser comme paramètre de commutateur.

Noter queInsertTableOfContents insérera uniquement un champ TOC, mais ne créera pas la table des matières. Celle-ci est créée par Microsoft Word lors de la mise à jour du champ.

Si vous insérez une table des matières à l’aide de cette méthode, puis ouvrez le fichier dans Microsoft Word, vous ne verrez pas la table des matières car le champ TOC n’a pas encore été mis à jour.

Dans Microsoft Word, les champs ne sont pas automatiquement mis à jour lorsqu’un document est ouvert, mais vous pouvez mettre à jour les champs d’un document à tout moment en appuyant sur F9.

Exemples

Montre comment insérer une table des matières (TOC) dans un document en utilisant des styles de titre comme entrées.

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

// Insérer une table des matières pour la première page du document.
// Configurez le tableau pour récupérer les paragraphes avec des titres de niveaux 1 à 3.
// Définissez également ses entrées comme des hyperliens qui nous mèneront
// à l'emplacement de l'en-tête lors d'un clic gauche dans Microsoft Word.
builder.InsertTableOfContents("\\o \"1-3\" \\h \\z \\u");
builder.InsertBreak(BreakType.PageBreak);

// Remplissez la table des matières en ajoutant des paragraphes avec des styles de titre.
// Chaque titre de ce type avec un niveau compris entre 1 et 3 créera une entrée dans le tableau.
builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading1;
builder.Writeln("Heading 1");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading2;
builder.Writeln("Heading 1.1");
builder.Writeln("Heading 1.2");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading1;
builder.Writeln("Heading 2");
builder.Writeln("Heading 3");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading2;
builder.Writeln("Heading 3.1");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading3;
builder.Writeln("Heading 3.1.1");
builder.Writeln("Heading 3.1.2");
builder.Writeln("Heading 3.1.3");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading4;
builder.Writeln("Heading 3.1.3.1");
builder.Writeln("Heading 3.1.3.2");

builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading2;
builder.Writeln("Heading 3.2");
builder.Writeln("Heading 3.3");

// Une table des matières est un champ d'un type qui doit être mis à jour pour afficher un résultat à jour.
doc.UpdateFields();
doc.Save(ArtifactsDir + "DocumentBuilder.InsertToc.docx");

Voir également

DocumentBuilder.InsertStyleSeparator DocumentBuilder.InsertTextInput