com.aspose.words

Constructor Detail

• BookmarksOutlineLevelCollection

  public BookmarksOutlineLevelCollection()

Property Getters/Setters Detail

• getCount

  public int getCount()
  

  Gets the number of elements contained in the collection.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();

• get/set

  public int get(int index) / public void set(int index, int value)
  

  Gets or sets a bookmark outline level at the specified index.

  Parameters:

  index - Zero-based index of the bookmark.

  Returns:

  The outline level of the bookmark. Valid range is 0 to 9.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();

• get/set

  public int get(java.lang.String name) / public void set(java.lang.String name, int value)
  

  Gets or a sets a bookmark outline level by the bookmark name.

  Parameters:

  name - Case-insensitive name of the bookmark.

  Returns:

  The outline level of the bookmark. Valid range is 0 to 9.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();

Method Detail

• add

  public void add(java.lang.String name, int outlineLevel)

  Adds a bookmark to the collection.

  Parameters:

  name - The case-insensitive name of the bookmark to add.

  outlineLevel - The outline level of the bookmark. Valid range is 0 to 9.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();

• clear

  public void clear()

  Removes all elements from the collection.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();

• contains

  public boolean contains(java.lang.String name)

  Determines whether the collection contains a bookmark with the given name.

  Parameters:

  name - Case-insensitive name of the bookmark to locate.

  Returns:

  True if item is found in the collection; otherwise, false.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();

• indexOfKey

  public int indexOfKey(java.lang.String name)

  Returns the zero-based index of the specified bookmark in the collection.

  Parameters:

  name - The case-insensitive name of the bookmark.

  Returns:

  The zero based index. Negative value if not found.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();

• iterator

  public java.util.Iterator<java.util.Map.Entry<java.lang.String, int>> iterator()

• remove

  public void remove(java.lang.String name)

  Removes a bookmark with the specified name from the collection.

  Parameters:

  name - The case-insensitive name of the bookmark.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();

• removeAt

  public void removeAt(int index)

  Removes a bookmark at the specified index.

  Parameters:

  index - The zero based index.

  Example:

  Shows how to set outline levels for bookmarks.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert a bookmark with another bookmark nested inside it.
  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");
  
  // Insert another bookmark.
  builder.startBookmark("Bookmark 3");
  builder.writeln("Text inside Bookmark 3.");
  builder.endBookmark("Bookmark 3");
  
  // When saving to .pdf, bookmarks can be accessed via a drop-down menu and used as anchors by most readers.
  // Bookmarks can also have numeric values for outline levels,
  // enabling lower level outline entries to hide higher-level child entries when collapsed in the reader.
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  BookmarksOutlineLevelCollection outlineLevels = pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels();
  
  outlineLevels.add("Bookmark 1", 1);
  outlineLevels.add("Bookmark 2", 2);
  outlineLevels.add("Bookmark 3", 3);
  
  Assert.assertEquals(outlineLevels.getCount(), 3);
  Assert.assertTrue(outlineLevels.contains("Bookmark 1"));
  Assert.assertEquals(outlineLevels.get(0), 1);
  Assert.assertEquals(outlineLevels.get("Bookmark 2"), 2);
  Assert.assertEquals(outlineLevels.indexOfKey("Bookmark 3"), 2);
  
  // We can remove two elements so that only the outline level designation for "Bookmark 1" is left.
  outlineLevels.removeAt(2);
  outlineLevels.remove("Bookmark 2");
  
  // There are nine outline levels. Their numbering will be optimized during the save operation.
  // In this case, levels "5" and "9" will become "2" and "3".
  outlineLevels.add("Bookmark 2", 5);
  outlineLevels.add("Bookmark 3", 9);
  
  doc.save(getArtifactsDir() + "BookmarksOutlineLevelCollection.BookmarkLevels.pdf", pdfSaveOptions);
  
  // Emptying this collection will preserve the bookmarks and put them all on the same outline level.
  outlineLevels.clear();