java.lang.Objectcom.aspose.words.Bookmark
public class Bookmark
Example:
public void createUpdateAndPrintBookmarks() throws Exception {
// Create a document with 3 bookmarks: "MyBookmark 1", "MyBookmark 2", "MyBookmark 3"
Document doc = createDocumentWithBookmarks();
BookmarkCollection bookmarks = doc.getRange().getBookmarks();
// Look at initial values of our bookmarks
printAllBookmarkInfo(bookmarks);
// Obtain bookmarks from a bookmark collection by index/name and update their values
bookmarks.get(0).setName("Updated name of " + bookmarks.get(0).getName());
bookmarks.get("MyBookmark 2").setText("Updated text content of " + bookmarks.get(1).getName());
// Remove the latest bookmark
// The bookmarked text is not deleted
bookmarks.get(2).remove();
bookmarks = doc.getRange().getBookmarks();
// Check that we have 2 bookmarks after the latest bookmark was deleted
Assert.assertEquals(bookmarks.getCount(), 2);
// Look at updated values of our bookmarks
printAllBookmarkInfo(bookmarks);
}
/// <summary>
/// Create a document with bookmarks using the start and end nodes.
/// </summary>
private static Document createDocumentWithBookmarks() throws Exception {
DocumentBuilder builder = new DocumentBuilder();
Document doc = builder.getDocument();
// An empty document has just one empty paragraph by default
Paragraph p = doc.getFirstSection().getBody().getFirstParagraph();
// Add several bookmarks to the document
for (int i = 1; i <= 3; i++) {
String bookmarkName = "MyBookmark " + i;
p.appendChild(new Run(doc, "Text before bookmark."));
p.appendChild(new BookmarkStart(doc, bookmarkName));
p.appendChild(new Run(doc, "Text content of " + bookmarkName));
p.appendChild(new BookmarkEnd(doc, bookmarkName));
p.appendChild(new Run(doc, "Text after bookmark.\r\n"));
}
return builder.getDocument();
}
/// <summary>
/// Use an iterator and a visitor to print info of every bookmark from within a document.
/// </summary>
private static void printAllBookmarkInfo(BookmarkCollection bookmarks) throws Exception {
// Create a DocumentVisitor
BookmarkInfoPrinter bookmarkVisitor = new BookmarkInfoPrinter();
// Get the enumerator from the document's BookmarkCollection and iterate over the bookmarks
Iterator<Bookmark> enumerator = bookmarks.iterator();
while (enumerator.hasNext()) {
Bookmark currentBookmark = enumerator.next();
// Accept our DocumentVisitor it to print information about our bookmarks
if (currentBookmark != null) {
currentBookmark.getBookmarkStart().accept(bookmarkVisitor);
currentBookmark.getBookmarkEnd().accept(bookmarkVisitor);
// Prints a blank line
System.out.println(currentBookmark.getBookmarkStart().getText());
}
}
}
/// <summary>
/// Visitor that prints bookmark information to the console.
/// </summary>
public static class BookmarkInfoPrinter extends DocumentVisitor {
public int visitBookmarkStart(BookmarkStart bookmarkStart) throws Exception {
System.out.println(MessageFormat.format("BookmarkStart name: \"{0}\", Content: \"{1}\"", bookmarkStart.getName(),
bookmarkStart.getBookmark().getText()));
return VisitorAction.CONTINUE;
}
public int visitBookmarkEnd(BookmarkEnd bookmarkEnd) {
System.out.println(MessageFormat.format("BookmarkEnd name: \"{0}\"", bookmarkEnd.getName()));
return VisitorAction.CONTINUE;
}
}
Property Getters/Setters Summary | ||
---|---|---|
BookmarkEnd | getBookmarkEnd() | |
Gets the node that represents the end of the bookmark. | ||
BookmarkStart | getBookmarkStart() | |
Gets the node that represents the start of the bookmark. | ||
int | getFirstColumn() | |
Gets the zero-based index of the first column of the table column range associated with the bookmark. | ||
boolean | isColumn() | |
Returns true if this bookmark is a table column bookmark. | ||
int | getLastColumn() | |
Gets the zero-based index of the last column of the table column range associated with the bookmark. | ||
java.lang.String | getName() | |
void | setName(java.lang.String value) | |
Gets or sets the name of the bookmark. | ||
java.lang.String | getText() | |
void | setText(java.lang.String value) | |
Gets or sets the text enclosed in the bookmark. |
Method Summary | ||
---|---|---|
void | remove() | |
Removes the bookmark from the document. Does not remove text inside the bookmark. |
Property Getters/Setters Detail |
---|
getBookmarkEnd | |
public BookmarkEnd getBookmarkEnd() |
Example:
Shows how to add bookmarks and update their contents.public void createUpdateAndPrintBookmarks() throws Exception { // Create a document with 3 bookmarks: "MyBookmark 1", "MyBookmark 2", "MyBookmark 3" Document doc = createDocumentWithBookmarks(); BookmarkCollection bookmarks = doc.getRange().getBookmarks(); // Look at initial values of our bookmarks printAllBookmarkInfo(bookmarks); // Obtain bookmarks from a bookmark collection by index/name and update their values bookmarks.get(0).setName("Updated name of " + bookmarks.get(0).getName()); bookmarks.get("MyBookmark 2").setText("Updated text content of " + bookmarks.get(1).getName()); // Remove the latest bookmark // The bookmarked text is not deleted bookmarks.get(2).remove(); bookmarks = doc.getRange().getBookmarks(); // Check that we have 2 bookmarks after the latest bookmark was deleted Assert.assertEquals(bookmarks.getCount(), 2); // Look at updated values of our bookmarks printAllBookmarkInfo(bookmarks); } /// <summary> /// Create a document with bookmarks using the start and end nodes. /// </summary> private static Document createDocumentWithBookmarks() throws Exception { DocumentBuilder builder = new DocumentBuilder(); Document doc = builder.getDocument(); // An empty document has just one empty paragraph by default Paragraph p = doc.getFirstSection().getBody().getFirstParagraph(); // Add several bookmarks to the document for (int i = 1; i <= 3; i++) { String bookmarkName = "MyBookmark " + i; p.appendChild(new Run(doc, "Text before bookmark.")); p.appendChild(new BookmarkStart(doc, bookmarkName)); p.appendChild(new Run(doc, "Text content of " + bookmarkName)); p.appendChild(new BookmarkEnd(doc, bookmarkName)); p.appendChild(new Run(doc, "Text after bookmark.\r\n")); } return builder.getDocument(); } /// <summary> /// Use an iterator and a visitor to print info of every bookmark from within a document. /// </summary> private static void printAllBookmarkInfo(BookmarkCollection bookmarks) throws Exception { // Create a DocumentVisitor BookmarkInfoPrinter bookmarkVisitor = new BookmarkInfoPrinter(); // Get the enumerator from the document's BookmarkCollection and iterate over the bookmarks Iterator<Bookmark> enumerator = bookmarks.iterator(); while (enumerator.hasNext()) { Bookmark currentBookmark = enumerator.next(); // Accept our DocumentVisitor it to print information about our bookmarks if (currentBookmark != null) { currentBookmark.getBookmarkStart().accept(bookmarkVisitor); currentBookmark.getBookmarkEnd().accept(bookmarkVisitor); // Prints a blank line System.out.println(currentBookmark.getBookmarkStart().getText()); } } } /// <summary> /// Visitor that prints bookmark information to the console. /// </summary> public static class BookmarkInfoPrinter extends DocumentVisitor { public int visitBookmarkStart(BookmarkStart bookmarkStart) throws Exception { System.out.println(MessageFormat.format("BookmarkStart name: \"{0}\", Content: \"{1}\"", bookmarkStart.getName(), bookmarkStart.getBookmark().getText())); return VisitorAction.CONTINUE; } public int visitBookmarkEnd(BookmarkEnd bookmarkEnd) { System.out.println(MessageFormat.format("BookmarkEnd name: \"{0}\"", bookmarkEnd.getName())); return VisitorAction.CONTINUE; } }
getBookmarkStart | |
public BookmarkStart getBookmarkStart() |
Example:
Shows how to add bookmarks and update their contents.public void createUpdateAndPrintBookmarks() throws Exception { // Create a document with 3 bookmarks: "MyBookmark 1", "MyBookmark 2", "MyBookmark 3" Document doc = createDocumentWithBookmarks(); BookmarkCollection bookmarks = doc.getRange().getBookmarks(); // Look at initial values of our bookmarks printAllBookmarkInfo(bookmarks); // Obtain bookmarks from a bookmark collection by index/name and update their values bookmarks.get(0).setName("Updated name of " + bookmarks.get(0).getName()); bookmarks.get("MyBookmark 2").setText("Updated text content of " + bookmarks.get(1).getName()); // Remove the latest bookmark // The bookmarked text is not deleted bookmarks.get(2).remove(); bookmarks = doc.getRange().getBookmarks(); // Check that we have 2 bookmarks after the latest bookmark was deleted Assert.assertEquals(bookmarks.getCount(), 2); // Look at updated values of our bookmarks printAllBookmarkInfo(bookmarks); } /// <summary> /// Create a document with bookmarks using the start and end nodes. /// </summary> private static Document createDocumentWithBookmarks() throws Exception { DocumentBuilder builder = new DocumentBuilder(); Document doc = builder.getDocument(); // An empty document has just one empty paragraph by default Paragraph p = doc.getFirstSection().getBody().getFirstParagraph(); // Add several bookmarks to the document for (int i = 1; i <= 3; i++) { String bookmarkName = "MyBookmark " + i; p.appendChild(new Run(doc, "Text before bookmark.")); p.appendChild(new BookmarkStart(doc, bookmarkName)); p.appendChild(new Run(doc, "Text content of " + bookmarkName)); p.appendChild(new BookmarkEnd(doc, bookmarkName)); p.appendChild(new Run(doc, "Text after bookmark.\r\n")); } return builder.getDocument(); } /// <summary> /// Use an iterator and a visitor to print info of every bookmark from within a document. /// </summary> private static void printAllBookmarkInfo(BookmarkCollection bookmarks) throws Exception { // Create a DocumentVisitor BookmarkInfoPrinter bookmarkVisitor = new BookmarkInfoPrinter(); // Get the enumerator from the document's BookmarkCollection and iterate over the bookmarks Iterator<Bookmark> enumerator = bookmarks.iterator(); while (enumerator.hasNext()) { Bookmark currentBookmark = enumerator.next(); // Accept our DocumentVisitor it to print information about our bookmarks if (currentBookmark != null) { currentBookmark.getBookmarkStart().accept(bookmarkVisitor); currentBookmark.getBookmarkEnd().accept(bookmarkVisitor); // Prints a blank line System.out.println(currentBookmark.getBookmarkStart().getText()); } } } /// <summary> /// Visitor that prints bookmark information to the console. /// </summary> public static class BookmarkInfoPrinter extends DocumentVisitor { public int visitBookmarkStart(BookmarkStart bookmarkStart) throws Exception { System.out.println(MessageFormat.format("BookmarkStart name: \"{0}\", Content: \"{1}\"", bookmarkStart.getName(), bookmarkStart.getBookmark().getText())); return VisitorAction.CONTINUE; } public int visitBookmarkEnd(BookmarkEnd bookmarkEnd) { System.out.println(MessageFormat.format("BookmarkEnd name: \"{0}\"", bookmarkEnd.getName())); return VisitorAction.CONTINUE; } }
getFirstColumn | |
public int getFirstColumn() |
Example:
Shows how to get information about table column bookmark.Document doc = new Document(getMyDir() + "TableColumnBookmark.doc"); for (Bookmark bookmark : doc.getRange().getBookmarks()) { System.out.println(MessageFormat.format("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()) { // Print text from the first and last cells containing in bookmark System.out.println(row.getCells().get(bookmark.getFirstColumn()).getText().trim()); System.out.println(row.getCells().get(bookmark.getLastColumn()).getText().trim()); } } }
isColumn | |
public boolean isColumn() |
Example:
Shows how to get information about table column bookmark.Document doc = new Document(getMyDir() + "TableColumnBookmark.doc"); for (Bookmark bookmark : doc.getRange().getBookmarks()) { System.out.println(MessageFormat.format("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()) { // Print text from the first and last cells containing in bookmark System.out.println(row.getCells().get(bookmark.getFirstColumn()).getText().trim()); System.out.println(row.getCells().get(bookmark.getLastColumn()).getText().trim()); } } }
getLastColumn | |
public int getLastColumn() |
Example:
Shows how to get information about table column bookmark.Document doc = new Document(getMyDir() + "TableColumnBookmark.doc"); for (Bookmark bookmark : doc.getRange().getBookmarks()) { System.out.println(MessageFormat.format("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()) { // Print text from the first and last cells containing in bookmark System.out.println(row.getCells().get(bookmark.getFirstColumn()).getText().trim()); System.out.println(row.getCells().get(bookmark.getLastColumn()).getText().trim()); } } }
getName/setName | |
public java.lang.String getName() / public void setName(java.lang.String value) |
Example:
Shows how to replace elements in bookmark name.// Open a document with 3 bookmarks: "MyBookmark1", "My_Bookmark2", "MyBookmark3" Document doc = new Document(getMyDir() + "Bookmarks.docx"); // MS Word document does not support bookmark names with whitespaces by default // If you have document which contains bookmark names with underscores, you can simply replace them to whitespaces for (Bookmark bookmark : doc.getRange().getBookmarks()) bookmark.setName(bookmark.getName().replace("_", " "));
Example:
Shows how to add bookmarks and update their contents.public void createUpdateAndPrintBookmarks() throws Exception { // Create a document with 3 bookmarks: "MyBookmark 1", "MyBookmark 2", "MyBookmark 3" Document doc = createDocumentWithBookmarks(); BookmarkCollection bookmarks = doc.getRange().getBookmarks(); // Look at initial values of our bookmarks printAllBookmarkInfo(bookmarks); // Obtain bookmarks from a bookmark collection by index/name and update their values bookmarks.get(0).setName("Updated name of " + bookmarks.get(0).getName()); bookmarks.get("MyBookmark 2").setText("Updated text content of " + bookmarks.get(1).getName()); // Remove the latest bookmark // The bookmarked text is not deleted bookmarks.get(2).remove(); bookmarks = doc.getRange().getBookmarks(); // Check that we have 2 bookmarks after the latest bookmark was deleted Assert.assertEquals(bookmarks.getCount(), 2); // Look at updated values of our bookmarks printAllBookmarkInfo(bookmarks); } /// <summary> /// Create a document with bookmarks using the start and end nodes. /// </summary> private static Document createDocumentWithBookmarks() throws Exception { DocumentBuilder builder = new DocumentBuilder(); Document doc = builder.getDocument(); // An empty document has just one empty paragraph by default Paragraph p = doc.getFirstSection().getBody().getFirstParagraph(); // Add several bookmarks to the document for (int i = 1; i <= 3; i++) { String bookmarkName = "MyBookmark " + i; p.appendChild(new Run(doc, "Text before bookmark.")); p.appendChild(new BookmarkStart(doc, bookmarkName)); p.appendChild(new Run(doc, "Text content of " + bookmarkName)); p.appendChild(new BookmarkEnd(doc, bookmarkName)); p.appendChild(new Run(doc, "Text after bookmark.\r\n")); } return builder.getDocument(); } /// <summary> /// Use an iterator and a visitor to print info of every bookmark from within a document. /// </summary> private static void printAllBookmarkInfo(BookmarkCollection bookmarks) throws Exception { // Create a DocumentVisitor BookmarkInfoPrinter bookmarkVisitor = new BookmarkInfoPrinter(); // Get the enumerator from the document's BookmarkCollection and iterate over the bookmarks Iterator<Bookmark> enumerator = bookmarks.iterator(); while (enumerator.hasNext()) { Bookmark currentBookmark = enumerator.next(); // Accept our DocumentVisitor it to print information about our bookmarks if (currentBookmark != null) { currentBookmark.getBookmarkStart().accept(bookmarkVisitor); currentBookmark.getBookmarkEnd().accept(bookmarkVisitor); // Prints a blank line System.out.println(currentBookmark.getBookmarkStart().getText()); } } } /// <summary> /// Visitor that prints bookmark information to the console. /// </summary> public static class BookmarkInfoPrinter extends DocumentVisitor { public int visitBookmarkStart(BookmarkStart bookmarkStart) throws Exception { System.out.println(MessageFormat.format("BookmarkStart name: \"{0}\", Content: \"{1}\"", bookmarkStart.getName(), bookmarkStart.getBookmark().getText())); return VisitorAction.CONTINUE; } public int visitBookmarkEnd(BookmarkEnd bookmarkEnd) { System.out.println(MessageFormat.format("BookmarkEnd name: \"{0}\"", bookmarkEnd.getName())); return VisitorAction.CONTINUE; } }
getText/setText | |
public java.lang.String getText() / public void setText(java.lang.String value) |
Example:
Shows how to add bookmarks and update their contents.public void createUpdateAndPrintBookmarks() throws Exception { // Create a document with 3 bookmarks: "MyBookmark 1", "MyBookmark 2", "MyBookmark 3" Document doc = createDocumentWithBookmarks(); BookmarkCollection bookmarks = doc.getRange().getBookmarks(); // Look at initial values of our bookmarks printAllBookmarkInfo(bookmarks); // Obtain bookmarks from a bookmark collection by index/name and update their values bookmarks.get(0).setName("Updated name of " + bookmarks.get(0).getName()); bookmarks.get("MyBookmark 2").setText("Updated text content of " + bookmarks.get(1).getName()); // Remove the latest bookmark // The bookmarked text is not deleted bookmarks.get(2).remove(); bookmarks = doc.getRange().getBookmarks(); // Check that we have 2 bookmarks after the latest bookmark was deleted Assert.assertEquals(bookmarks.getCount(), 2); // Look at updated values of our bookmarks printAllBookmarkInfo(bookmarks); } /// <summary> /// Create a document with bookmarks using the start and end nodes. /// </summary> private static Document createDocumentWithBookmarks() throws Exception { DocumentBuilder builder = new DocumentBuilder(); Document doc = builder.getDocument(); // An empty document has just one empty paragraph by default Paragraph p = doc.getFirstSection().getBody().getFirstParagraph(); // Add several bookmarks to the document for (int i = 1; i <= 3; i++) { String bookmarkName = "MyBookmark " + i; p.appendChild(new Run(doc, "Text before bookmark.")); p.appendChild(new BookmarkStart(doc, bookmarkName)); p.appendChild(new Run(doc, "Text content of " + bookmarkName)); p.appendChild(new BookmarkEnd(doc, bookmarkName)); p.appendChild(new Run(doc, "Text after bookmark.\r\n")); } return builder.getDocument(); } /// <summary> /// Use an iterator and a visitor to print info of every bookmark from within a document. /// </summary> private static void printAllBookmarkInfo(BookmarkCollection bookmarks) throws Exception { // Create a DocumentVisitor BookmarkInfoPrinter bookmarkVisitor = new BookmarkInfoPrinter(); // Get the enumerator from the document's BookmarkCollection and iterate over the bookmarks Iterator<Bookmark> enumerator = bookmarks.iterator(); while (enumerator.hasNext()) { Bookmark currentBookmark = enumerator.next(); // Accept our DocumentVisitor it to print information about our bookmarks if (currentBookmark != null) { currentBookmark.getBookmarkStart().accept(bookmarkVisitor); currentBookmark.getBookmarkEnd().accept(bookmarkVisitor); // Prints a blank line System.out.println(currentBookmark.getBookmarkStart().getText()); } } } /// <summary> /// Visitor that prints bookmark information to the console. /// </summary> public static class BookmarkInfoPrinter extends DocumentVisitor { public int visitBookmarkStart(BookmarkStart bookmarkStart) throws Exception { System.out.println(MessageFormat.format("BookmarkStart name: \"{0}\", Content: \"{1}\"", bookmarkStart.getName(), bookmarkStart.getBookmark().getText())); return VisitorAction.CONTINUE; } public int visitBookmarkEnd(BookmarkEnd bookmarkEnd) { System.out.println(MessageFormat.format("BookmarkEnd name: \"{0}\"", bookmarkEnd.getName())); return VisitorAction.CONTINUE; } }
Method Detail |
---|
remove | |
public void remove() throws java.lang.Exception |
Example:
Shows how to add bookmarks and update their contents.public void createUpdateAndPrintBookmarks() throws Exception { // Create a document with 3 bookmarks: "MyBookmark 1", "MyBookmark 2", "MyBookmark 3" Document doc = createDocumentWithBookmarks(); BookmarkCollection bookmarks = doc.getRange().getBookmarks(); // Look at initial values of our bookmarks printAllBookmarkInfo(bookmarks); // Obtain bookmarks from a bookmark collection by index/name and update their values bookmarks.get(0).setName("Updated name of " + bookmarks.get(0).getName()); bookmarks.get("MyBookmark 2").setText("Updated text content of " + bookmarks.get(1).getName()); // Remove the latest bookmark // The bookmarked text is not deleted bookmarks.get(2).remove(); bookmarks = doc.getRange().getBookmarks(); // Check that we have 2 bookmarks after the latest bookmark was deleted Assert.assertEquals(bookmarks.getCount(), 2); // Look at updated values of our bookmarks printAllBookmarkInfo(bookmarks); } /// <summary> /// Create a document with bookmarks using the start and end nodes. /// </summary> private static Document createDocumentWithBookmarks() throws Exception { DocumentBuilder builder = new DocumentBuilder(); Document doc = builder.getDocument(); // An empty document has just one empty paragraph by default Paragraph p = doc.getFirstSection().getBody().getFirstParagraph(); // Add several bookmarks to the document for (int i = 1; i <= 3; i++) { String bookmarkName = "MyBookmark " + i; p.appendChild(new Run(doc, "Text before bookmark.")); p.appendChild(new BookmarkStart(doc, bookmarkName)); p.appendChild(new Run(doc, "Text content of " + bookmarkName)); p.appendChild(new BookmarkEnd(doc, bookmarkName)); p.appendChild(new Run(doc, "Text after bookmark.\r\n")); } return builder.getDocument(); } /// <summary> /// Use an iterator and a visitor to print info of every bookmark from within a document. /// </summary> private static void printAllBookmarkInfo(BookmarkCollection bookmarks) throws Exception { // Create a DocumentVisitor BookmarkInfoPrinter bookmarkVisitor = new BookmarkInfoPrinter(); // Get the enumerator from the document's BookmarkCollection and iterate over the bookmarks Iterator<Bookmark> enumerator = bookmarks.iterator(); while (enumerator.hasNext()) { Bookmark currentBookmark = enumerator.next(); // Accept our DocumentVisitor it to print information about our bookmarks if (currentBookmark != null) { currentBookmark.getBookmarkStart().accept(bookmarkVisitor); currentBookmark.getBookmarkEnd().accept(bookmarkVisitor); // Prints a blank line System.out.println(currentBookmark.getBookmarkStart().getText()); } } } /// <summary> /// Visitor that prints bookmark information to the console. /// </summary> public static class BookmarkInfoPrinter extends DocumentVisitor { public int visitBookmarkStart(BookmarkStart bookmarkStart) throws Exception { System.out.println(MessageFormat.format("BookmarkStart name: \"{0}\", Content: \"{1}\"", bookmarkStart.getName(), bookmarkStart.getBookmark().getText())); return VisitorAction.CONTINUE; } public int visitBookmarkEnd(BookmarkEnd bookmarkEnd) { System.out.println(MessageFormat.format("BookmarkEnd name: \"{0}\"", bookmarkEnd.getName())); return VisitorAction.CONTINUE; } }