com.aspose.words
Class BookmarksOutlineLevelCollection

java.lang.Object
    com.aspose.words.BookmarksOutlineLevelCollection

All Implemented Interfaces:

java.lang.Iterable

public class BookmarksOutlineLevelCollection 
extends java.lang.Object

BookmarksOutlineLevelCollection

public BookmarksOutlineLevelCollection()

public int getCount()

Gets the number of elements contained in the collection.

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.

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.

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 adding bookmarks outlines with whitespaces(pdf, xps)

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

// Add bookmarks with whitespaces. MS Word formats (like doc, docx) does not support bookmarks with whitespaces by default 
// and all whitespaces in the bookmarks were replaced with underscores. If you need to use bookmarks in PDF or XPS outlines, you can use them with whitespaces.
builder.startBookmark("My Bookmark");
builder.writeln("Text inside a bookmark.");

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

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

// Specify bookmarks outline level. If you are using xps format, just use XpsSaveOptions.
PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels().add("My Bookmark", 1);
pdfSaveOptions.getOutlineOptions().getBookmarksOutlineLevels().add("Nested Bookmark", 2);

doc.save(getMyDir() + "\\Artifacts\\Bookmarks.WhiteSpaces.pdf", pdfSaveOptions);

public void clear()

Removes all elements from the collection.

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.

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.

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

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.

public void removeAt(int index)

Removes a bookmark at the specified index.

Parameters:

index - The zero based index.