Bookmark

Bookmark class

Rappresenta un singolo segnalibro.

public class Bookmark

Proprietà

Nome Descrizione
BookmarkEnd { get; } Ottiene il nodo che rappresenta la fine del segnalibro.
BookmarkStart { get; } Ottiene il nodo che rappresenta l’inizio del segnalibro.
FirstColumn { get; } Ottiene l’indice in base zero della prima colonna dell’intervallo di colonne della tabella associato al segnalibro.
IsColumn { get; } Restituisce VERO se questo segnalibro è un segnalibro della colonna della tabella.
LastColumn { get; } Ottiene l’indice in base zero dell’ultima colonna dell’intervallo di colonne della tabella associato al segnalibro.
Name { get; set; } Ottiene o imposta il nome del segnalibro.
Text { get; set; } Ottiene o imposta il testo racchiuso nel segnalibro.

Metodi

Nome Descrizione
Remove() Rimuove il segnalibro dal documento. Non rimuove il testo all’interno del segnalibro.

Osservazioni

Bookmark è un oggetto “facciata” che incapsula due nodiBookmarkStart eBookmarkEnd in un albero di documenti e permette di lavorare con un segnalibro come un singolo oggetto.

Esempi

Mostra come aggiungere segnalibri e aggiornarne il contenuto.

public void CreateUpdateAndPrintBookmarks()
{
    // Crea un documento con tre segnalibri, quindi utilizza un'implementazione personalizzata del visitatore del documento per stamparne il contenuto.
    Document doc = CreateDocumentWithBookmarks(3);
    BookmarkCollection bookmarks = doc.Range.Bookmarks;

    PrintAllBookmarkInfo(bookmarks);

    // È possibile accedere ai segnalibri nella raccolta di segnalibri in base all'indice o al nome e i loro nomi possono essere aggiornati.
    bookmarks[0].Name = $"{bookmarks[0].Name}_NewName";
    bookmarks["MyBookmark_2"].Text = $"Updated text contents of {bookmarks[1].Name}";

    // Stampa di nuovo tutti i segnalibri per visualizzare i valori aggiornati.
    PrintAllBookmarkInfo(bookmarks);
}

/// <summary>
/// Crea un documento con un determinato numero di segnalibri.
/// </summary>
private static Document CreateDocumentWithBookmarks(int numberOfBookmarks)
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    for (int i = 1; i <= numberOfBookmarks; i++)
    {
        string bookmarkName = "MyBookmark_" + i;

        builder.Write("Text before bookmark.");
        builder.StartBookmark(bookmarkName);
        builder.Write($"Text inside {bookmarkName}.");
        builder.EndBookmark(bookmarkName);
        builder.Writeln("Text after bookmark.");
    }

    return doc;
}

/// <summary>
/// Usa un iteratore e un visitatore per stampare le informazioni di ogni segnalibro nella raccolta.
/// </summary>
private static void PrintAllBookmarkInfo(BookmarkCollection bookmarks)
{
    BookmarkInfoPrinter bookmarkVisitor = new BookmarkInfoPrinter();

    // Ottieni ogni segnalibro nella raccolta per accettare un visitatore che ne stamperà il contenuto.
    using (IEnumerator<Bookmark> enumerator = bookmarks.GetEnumerator())
    {
        while (enumerator.MoveNext())
        {
            Bookmark currentBookmark = enumerator.Current;

            if (currentBookmark != null)
            {
                currentBookmark.BookmarkStart.Accept(bookmarkVisitor);
                currentBookmark.BookmarkEnd.Accept(bookmarkVisitor);

                Console.WriteLine(currentBookmark.BookmarkStart.GetText());
            }
        }
    }
}

/// <summary>
/// Stampa il contenuto di ogni segnalibro visitato sulla console.
/// </summary>
public class BookmarkInfoPrinter : DocumentVisitor
{
    public override VisitorAction VisitBookmarkStart(BookmarkStart bookmarkStart)
    {
        Console.WriteLine($"BookmarkStart name: \"{bookmarkStart.Name}\", Contents: \"{bookmarkStart.Bookmark.Text}\"");
        return VisitorAction.Continue;
    }

    public override VisitorAction VisitBookmarkEnd(BookmarkEnd bookmarkEnd)
    {
        Console.WriteLine($"BookmarkEnd name: \"{bookmarkEnd.Name}\"");
        return VisitorAction.Continue;
    }
}

Guarda anche