OutlineCollection

Inheritance: java.lang.Object, com.aspose.pdf.Outlines com.aspose.pdf.OutlineCollection, com.aspose.pdf.Outlines, com.aspose.pdf.OutlineCollection

All Implemented Interfaces: Iterable < OutlineItemCollection >

public final class OutlineCollection extends Outlines

Represents document outline hierarchy.

Methods

Method	Description
add	Adds outline item to collection.
clear	Clears all items from the collection.
contains	Not supported yet. Checks does collection contains given item.
copyTo	Copies the outline items to an System.Array, starting at a particular System.Array index.
delete	Deletes all outline items from the document outline.
delete	Deletes all outline items from the document outline.
get_Item	Gets outline item from collection by index.
getFirst	Gets an outline item representing the first top-level item in the outline.
getLast	Gets an outline item representing the last top-level item in the outline.
getSyncRoot	Gets an object that can be used to synchronize access to this collection.
getVisibleCount	Count is the sum of the number of visible descendent outline items at all levels. Note: please don’t confuse with Count which is number if items in collection.
hasNext
isReadOnly	Gets a value indicating whether the collection is read-only.
isSynchronized	Gets a value indicating whether access to this collection is synchronized (thread safe).
iterator	Returns an enumerator that iterates through the collection.
next
remove	Remove item by index.
remove	Not supported yet. Always throws exception
size	Gets the total number of outline items (bookmarks) at all levels of the document outline.

add

Adds outline item to collection.

clear

public void clear()

Clears all items from the collection.

contains

Not supported yet. Checks does collection contains given item.

copyTo

Copies the outline items to an System.Array, starting at a particular System.Array index.

delete

public void delete()

Deletes all outline items from the document outline.

delete

Deletes all outline items from the document outline.

get_Item

public OutlineItemCollection get_Item(int index)

Gets outline item from collection by index.

Parameters:

Parameter	Type	Description
index		Index of requested item.

Returns: OutlineItemCollection object

getFirst

public OutlineItemCollection getFirst()

Gets an outline item representing the first top-level item in the outline.

Returns: OutlineItemCollection object

getLast

public OutlineItemCollection getLast()

Gets an outline item representing the last top-level item in the outline.

Returns: OutlineItemCollection object

getSyncRoot

public Object getSyncRoot()

Gets an object that can be used to synchronize access to this collection.

Returns: Object for synchronization

getVisibleCount

public int getVisibleCount()

Count is the sum of the number of visible descendent outline items at all levels. Note: please don’t confuse with Count which is number if items in collection.

Returns: int value

hasNext

public boolean hasNext()

isReadOnly

public boolean isReadOnly()

Gets a value indicating whether the collection is read-only.

Returns: boolean value

isSynchronized

public boolean isSynchronized()

Gets a value indicating whether access to this collection is synchronized (thread safe).

Returns: boolean value

iterator

public Iterator < OutlineItemCollection > iterator()

Returns an enumerator that iterates through the collection.

Returns: An System.Collections.IEnumerator object that can be used to iterate through the collection.

next

public OutlineItemCollection next()

remove

public final void remove(int index)

Remove item by index.

Parameters:

Parameter	Type	Description
index		Index of the item to be removed.

remove

Not supported yet. Always throws exception

size

public int size()

Gets the total number of outline items (bookmarks) at all levels of the document outline.

Returns: int value