Arbeiten mit Lesezeichen

Lesezeichen identifizieren in einem Microsoft Word-Dokument die Orte oder Fragmente, die Sie benennen und für zukünftige Referenzzwecke identifizieren. Sie können beispielsweise ein Lesezeichen verwenden, um Text zu identifizieren, den Sie später überarbeiten möchten. Anstatt durch das Dokument zu scrollen, um den Text zu finden, können Sie ihn über das Dialogfeld Lesezeichen aufrufen.

Mit Aspose.Words können Sie Lesezeichen in Berichten oder Dokumenten verwenden, um einige Daten in das Lesezeichen einzufügen oder dessen Inhalt speziell zu formatieren. Sie können auch Lesezeichen verwenden, um Text von einer bestimmten Stelle in Ihrem Dokument abzurufen.

Die Aktionen, die mit Lesezeichen mit Aspose.Words ausgeführt werden können, sind die gleichen wie die, die Sie mit Microsoft Word ausführen können. Sie können ein neues Lesezeichen einfügen, löschen, zu einem Lesezeichen verschieben, einen Lesezeichennamen abrufen oder festlegen, darin eingeschlossenen Text abrufen oder festlegen.

Lesezeichen einfügen

Verwenden Sie startBookmark und endBookmark, um ein Lesezeichen zu erstellen, indem Sie dessen Anfang bzw. Ende markieren. Vergessen Sie nicht, beiden Methoden denselben Lesezeichennamen zu übergeben. Lesezeichen in einem Dokument können sich überlappen und einen beliebigen Bereich umfassen. Schlecht geformte Lesezeichen oder Lesezeichen mit doppelten Namen werden beim Speichern des Dokuments ignoriert.

Alle Leerzeichen in den Lesezeichen wurden durch Unterstriche ersetzt. Diese Einschränkung ergab sich aus MS -Wortformaten, da Lesezeichen in MS -Wortformaten wie DOCX oder DOC keine Leerzeichen enthalten dürfen. PDF erlaubt jedoch solche Lesezeichen. Wenn Sie also Lesezeichen in PDF-, XPS - oder SWF -Konturen verwenden müssen, können Sie sie mit Leerzeichen verwenden.

Das folgende Codebeispiel zeigt, wie Sie ein neues Lesezeichen erstellen:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(CreateBookmark.class);
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.startBookmark("MyBookmark");
builder.writeln("Text inside a bookmark.");
builder.endBookmark("MyBookmark");

builder.startBookmark("Nested Bookmark");
builder.writeln("Text inside a NestedBookmark.");
builder.endBookmark("Nested Bookmark");

builder.writeln("Text after Nested Bookmark.");
builder.endBookmark("My Bookmark");

PdfSaveOptions options = new PdfSaveOptions();
options.getOutlineOptions().setDefaultBookmarksOutlineLevel(1);
options.getOutlineOptions().setDefaultBookmarksOutlineLevel(2);

doc.save(dataDir + "output.pdf", options);
System.out.println("\nBookmark created successfully.");

Lesezeichen erhalten

Manchmal ist es notwendig, eine Lesezeichensammlung zu erhalten, um Lesezeichen zu durchlaufen oder für andere Zwecke. Verwenden Sie die Eigenschaft Node.getRange, die von einem beliebigen Dokumentknoten bereitgestellt wird, der ein Range-Objekt zurückgibt, das den in diesem Knoten enthaltenen Teil des Dokuments darstellt. Verwenden Sie dieses Objekt, um eine BookmarkCollection abzurufen, und verwenden Sie dann den Sammlungsindexer, um ein bestimmtes Lesezeichen abzurufen.

Sie können die Beispieldatei der folgenden Beispiele herunterladen von Aspose.Words GitHub.

Das folgende Codebeispiel zeigt, wie Lesezeichen aus einer Lesezeichensammlung abgerufen werden:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(AccessBookmarks.class);
Document doc = new Document(dataDir + "Bookmark.doc");
Bookmark bookmark1 = doc.getRange().getBookmarks().get(0);

Bookmark bookmark = doc.getRange().getBookmarks().get("MyBookmark");
doc.save(dataDir + "output.doc");
System.out.println("\nTable bookmarked successfully.\nFile saved at " + dataDir);

Das folgende Codebeispiel zeigt, wie Sie einen Lesezeichennamen und -text abrufen oder festlegen:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(BookmarkNameAndText.class);

Document doc = new Document(dataDir + "Bookmark.doc");
// Use the indexer of the Bookmarks collection to obtain the desired bookmark.
Bookmark bookmark = doc.getRange().getBookmarks().get("MyBookmark");

// Get the name and text of the bookmark.
String name = bookmark.getName();
String text = bookmark.getText();

// Set the name and text of the bookmark.
bookmark.setName("RenamedBookmark");
bookmark.setText("This is a new bookmarked text.");
System.out.println("\nBookmark name and text set successfully.");

Das folgende Codebeispiel zeigt, wie Sie eine Tabelle mit einem Lesezeichen versehen:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
//Create empty document
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// We call this method to start building the table.
builder.startTable();
builder.insertCell();

// Start bookmark here after calling InsertCell
builder.startBookmark("MyBookmark");

builder.write("Row 1, Cell 1 Content.");

// Build the second cell
builder.insertCell();
builder.write("Row 1, Cell 2 Content.");
// Call the following method to end the row and start a new row.
builder.endRow();

// Build the first cell of the second row.
builder.insertCell();
builder.write("Row 2, Cell 1 Content");

// Build the second cell.
builder.insertCell();
builder.write("Row 2, Cell 2 Content.");
builder.endRow();

// Signal that we have finished building the table.
builder.endTable();

//End of bookmark
builder.endBookmark("MyBookmark");

doc.save(dataDir + "output.doc");
System.out.println("\nTable bookmarked successfully.\nFile saved at " + dataDir);

Wenn Sie den Namen eines Lesezeichens in einen Namen ändern, der bereits im Dokument vorhanden ist, wird beim Speichern des Dokuments kein Fehler generiert und nur das erste Lesezeichen gespeichert.

Beachten Sie, dass einige Lesezeichen im Dokument Formularfeldern zugewiesen sind. Wenn Sie zu einem solchen Lesezeichen wechseln und dort Text einfügen, wird der Text in den Formularfeldcode eingefügt. Obwohl dies das Formularfeld nicht ungültig macht, ist der eingefügte Text nicht sichtbar, da er Teil des Feldcodes wird.

Das folgende Codebeispiel zeigt, wie auf Spalten der mit Lesezeichen versehenen Tabelle zugegriffen wird:

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// Create empty document
Document doc = new Document(dataDir + "Bookmark.Table_out.doc");
for (Bookmark bookmark : doc.getRange().getBookmarks())
{
	System.out.printf("Bookmark: {0}{1}", bookmark.getName(), bookmark.isColumn() ? " (Column)" : "");
    if (bookmark.isColumn())
    {
        Row row = (Row) bookmark.getBookmarkStart().getAncestor(NodeType.ROW);
        if (row != null && bookmark.getFirstColumn() < row.getCells().getCount())
        	System.out.print(row.getCells().get(bookmark.getFirstColumn()).getText());
    }
}

Zu einem Lesezeichen verschieben

Wenn Sie umfangreichen Inhalt (nicht nur einfachen Text) in ein Lesezeichen einfügen müssen, sollten Sie den Cursor mit moveToBookmark auf das Lesezeichen bewegen und dann mit DocumentBuilder Methoden und Eigenschaften Inhalte einfügen.

Lesezeichen-Inhalt anzeigen ausblenden

Das gesamte Lesezeichen (including the bookmarked content) kann mit Aspose.Words in den wahren Teil des Felds IF gekapselt werden. Es kann so sein, dass das Feld IF ein verschachteltes Seriendruckfeld im Ausdruck (Left of Operator) enthält und abhängig vom Wert des Seriendruckfelds das Feld IF den Inhalt des Lesezeichens im Word-Dokument ein- oder ausblendet.

Das folgende Codebeispiel zeigt, wie Lesezeichen ein- / ausgeblendet werden.

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
// The path to the documents directory.
String dataDir = Utils.getDataDir(ShowHideBookmarks.class);
        
		Document doc = new Document(dataDir + "Bookmark.doc");
		showHideBookmarkedContent(doc,"MyBookmark",false);
		doc.save(dataDir + "Updated_Document.docx");
		

// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-Java
public static void showHideBookmarkedContent(Document doc, String bookmarkName, boolean showHide) throws Exception {
    DocumentBuilder builder = new DocumentBuilder(doc);
    Bookmark bm = doc.getRange().getBookmarks().get(bookmarkName);

    builder.moveToDocumentEnd();
    // {IF "{MERGEFIELD bookmark}" = "true" "" ""}
    Field field = builder.insertField("IF \"", null);
    builder.moveTo(field.getStart().getNextSibling().getNextSibling());
    builder.insertField("MERGEFIELD " + bookmarkName + "", null);
    builder.write("\" = \"true\" ");
    builder.write("\"");
    builder.write("\"");
    builder.write(" \"\"");

    Node currentNode = field.getStart();
    boolean flag = true;
    while (currentNode != null && flag) {
        if (currentNode.getNodeType() == NodeType.RUN)
            if (currentNode.toString(SaveFormat.TEXT).trim().equals("\""))
                flag = false;

        Node nextNode = currentNode.getNextSibling();

        bm.getBookmarkStart().getParentNode().insertBefore(currentNode, bm.getBookmarkStart());
        currentNode = nextNode;
    }

    Node endNode = bm.getBookmarkEnd();
    flag = true;
    while (currentNode != null && flag) {
        if (currentNode.getNodeType() == NodeType.FIELD_END)
            flag = false;

        Node nextNode = currentNode.getNextSibling();

        bm.getBookmarkEnd().getParentNode().insertAfter(currentNode, endNode);
        endNode = currentNode;
        currentNode = nextNode;
    }

    doc.getMailMerge().execute(new String[]{bookmarkName}, new Object[]{showHide});
    
    //In case, you do not want to use MailMerge then you may use the following lines of code.
    //builder.moveToMergeField(bookmarkName);
    //builder.write(showHide ? "true" : "false");
}