BookmarksOutlineLevelCollection

BookmarksOutlineLevelCollection class

Une collection de signets individuels de niveau hiérarchique.

Pour en savoir plus, visitez leTravailler avec des signets article de documentation.

public class BookmarksOutlineLevelCollection : IEnumerable<KeyValuePair<string, int>>

Constructeurs

NomLa description
BookmarksOutlineLevelCollection()Default_Constructor

Propriétés

NomLa description
Count { get; }Obtient le nombre d’éléments contenus dans la collection.
Item { get; set; }Obtient ou définit un niveau de contour de signet par le nom du signet. (2 indexers)

Méthodes

NomLa description
Add(string, int)Ajoute un signet à la collection.
Clear()Supprime tous les éléments de la collection.
Contains(string)Détermine si la collection contient un signet portant le nom donné.
GetEnumerator()Renvoie un objet énumérateur qui peut être utilisé pour parcourir tous les éléments de la collection.
IndexOfKey(string)Renvoie l’index de base zéro du signet spécifié dans la collection.
Remove(string)Supprime un signet portant le nom spécifié de la collection.
RemoveAt(int)Supprime un signet à l’index spécifié.

Remarques

La clé est un nom de signet de type chaîne, insensible à la casse. La valeur est un niveau hiérarchique de signet de type int.

Le niveau de plan du signet peut être une valeur comprise entre 0 et 9. Spécifiez 0 et le signet Word ne sera pas affiché dans le plan du document. Spécifiez 1 et le signet Word sera affiché dans le plan du document au niveau 1 ; 2 pour le niveau 2 et ainsi de suite.

Exemples

Montre comment définir les niveaux de contour des signets.

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

// Insérer un signet avec un autre signet imbriqué à l'intérieur.
builder.StartBookmark("Bookmark 1");
builder.Writeln("Text inside Bookmark 1.");

builder.StartBookmark("Bookmark 2");
builder.Writeln("Text inside Bookmark 1 and 2.");
builder.EndBookmark("Bookmark 2");

builder.Writeln("Text inside Bookmark 1.");
builder.EndBookmark("Bookmark 1");

// Insérer un autre signet.
builder.StartBookmark("Bookmark 3");
builder.Writeln("Text inside Bookmark 3.");
builder.EndBookmark("Bookmark 3");

// Lors de l'enregistrement au format .pdf, les signets sont accessibles via un menu déroulant et utilisés comme ancres par la plupart des lecteurs.
// Les signets peuvent également avoir des valeurs numériques pour les niveaux de plan,
// activer les entrées de plan de niveau inférieur pour masquer les entrées enfants de niveau supérieur lorsqu'elles sont réduites dans le lecteur.
PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.OutlineOptions.BookmarksOutlineLevels;

outlineLevels.Add("Bookmark 1", 1);
outlineLevels.Add("Bookmark 2", 2);
outlineLevels.Add("Bookmark 3", 3);

Assert.AreEqual(3, outlineLevels.Count);
Assert.True(outlineLevels.Contains("Bookmark 1"));
Assert.AreEqual(1, outlineLevels[0]);
Assert.AreEqual(2, outlineLevels["Bookmark 2"]);
Assert.AreEqual(2, outlineLevels.IndexOfKey("Bookmark 3"));

// Nous pouvons supprimer deux éléments afin qu'il ne reste que la désignation du niveau de plan pour « Signet 1 ».
outlineLevels.RemoveAt(2);
outlineLevels.Remove("Bookmark 2");

// Il existe neuf niveaux de plan. Leur numérotation sera optimisée lors de la sauvegarde.
// Dans ce cas, les niveaux « 5 » et « 9 » deviendront « 2 » et « 3 ».
outlineLevels.Add("Bookmark 2", 5);
outlineLevels.Add("Bookmark 3", 9);

doc.Save(ArtifactsDir + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);

// Vider cette collection préservera les signets et les placera tous au même niveau de plan.
outlineLevels.Clear();

Voir également

ColorMode Enum