BookmarksOutlineLevelCollection

BookmarksOutlineLevelCollection class

Eine Sammlung einzelner Lesezeichen auf Gliederungsebene.

Um mehr zu erfahren, besuchen Sie dieArbeiten mit Lesezeichen Dokumentationsartikel.

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

Konstrukteure

NameBeschreibung
BookmarksOutlineLevelCollection()Default_Constructor

Eigenschaften

NameBeschreibung
Count { get; }Ruft die Anzahl der in der Sammlung enthaltenen Elemente ab.
Item { get; set; }Ruft eine Lesezeichen-Gliederungsebene anhand des Lesezeichennamens ab oder legt diese fest. (2 indexers)

Methoden

NameBeschreibung
Add(string, int)Fügt der Sammlung ein Lesezeichen hinzu.
Clear()Entfernt alle Elemente aus der Sammlung.
Contains(string)Bestimmt, ob die Sammlung ein Lesezeichen mit dem angegebenen Namen enthält.
GetEnumerator()Gibt ein Enumeratorobjekt zurück, mit dem alle Elemente in der Sammlung durchlaufen werden können.
IndexOfKey(string)Gibt den nullbasierten Index des angegebenen Lesezeichens in der Sammlung zurück.
Remove(string)Entfernt ein Lesezeichen mit dem angegebenen Namen aus der Sammlung.
RemoveAt(int)Entfernt ein Lesezeichen am angegebenen Index.

Bemerkungen

Der Schlüssel ist ein String-Lesezeichenname ohne Berücksichtigung der Groß-/Kleinschreibung. Der Wert ist eine Ganzzahl der Lesezeichengliederungsebene.

Die Gliederungsebene des Lesezeichens kann einen Wert zwischen 0 und 9 haben. Geben Sie 0 an, und das Word-Lesezeichen wird nicht in der Dokumentgliederung angezeigt. Geben Sie 1 an, und das Word-Lesezeichen wird in der Dokumentgliederung auf Ebene 1 angezeigt; 2 für Ebene 2 und so weiter.

Beispiele

Zeigt, wie Gliederungsebenen für Lesezeichen festgelegt werden.

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

// Fügt ein Lesezeichen ein, in dem ein weiteres Lesezeichen verschachtelt ist.
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");

// Ein weiteres Lesezeichen einfügen.
builder.StartBookmark("Bookmark 3");
builder.Writeln("Text inside Bookmark 3.");
builder.EndBookmark("Bookmark 3");

// Beim Speichern im PDF-Format können Lesezeichen über ein Dropdown-Menü aufgerufen und von den meisten Lesern als Anker verwendet werden.
// Lesezeichen können auch numerische Werte für Gliederungsebenen haben,
// Aktivieren von Gliederungseinträgen auf niedrigerer Ebene, um untergeordnete Einträge auf höherer Ebene auszublenden, wenn sie im Reader reduziert werden.
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"));

// Wir können zwei Elemente entfernen, sodass nur noch die Gliederungsebenenbezeichnung für „Lesezeichen 1“ übrig bleibt.
outlineLevels.RemoveAt(2);
outlineLevels.Remove("Bookmark 2");

// Es gibt neun Gliederungsebenen. Ihre Nummerierung wird beim Speichern optimiert.
// In diesem Fall werden die Ebenen „5“ und „9“ zu „2“ und „3“.
outlineLevels.Add("Bookmark 2", 5);
outlineLevels.Add("Bookmark 3", 9);

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

// Durch das Leeren dieser Sammlung bleiben die Lesezeichen erhalten und werden alle auf die gleiche Gliederungsebene gesetzt.
outlineLevels.Clear();

Siehe auch

ColorMode Enum