com.aspose.pdf

Method Detail

• hasNext

  public boolean hasNext()

• next

  public OutlineItemCollection next()

• 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.

  Specified by:

  getVisibleCount in class Outlines

  Returns:

  int value

• size

  public int size()

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

  Specified by:

  size in class Outlines

  Returns:

  int value

• 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

• isSynchronized

  public boolean isSynchronized()

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

  Returns:

  boolean value

• getSyncRoot

  public Object getSyncRoot()

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

  Returns:

  Object for synchronization

• isReadOnly

  public boolean isReadOnly()

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

  Specified by:

  isReadOnly in class Outlines

  Returns:

  boolean value

• add

  public void add(OutlineItemCollection outline)

  Adds outline item to collection.

  Specified by:

  add in class Outlines

  Parameters:

  outline - The outline item to be added.

• delete

  public void delete()

  Deletes all outline items from the document outline.

• delete

  public void delete(String name)

  Deletes the outline item with specified title from the document outline.

  Parameters:

  name - The title of outline item to be deleted

• copyTo

  public void copyTo(OutlineItemCollection[] array,
                     int index)

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

  Specified by:

  copyTo in class Outlines

  Parameters:

  array - The one-dimensional System.Array that is the destination. Must have zero-based indexing.

  index - The zero-based index in array at which copying begins.

• iterator

  public Iterator<OutlineItemCollection> iterator()

  Returns an enumerator that iterates through the collection.

  Specified by:

  iterator in interface Iterable<OutlineItemCollection>

  Specified by:

  iterator in class Outlines

  Returns:

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

• clear

  public void clear()

  Clears all items from the collection.

  Specified by:

  clear in class Outlines

• contains

  public boolean contains(OutlineItemCollection item)

  Not supported yet.

  Checks does collection contains given item.

  Specified by:

  contains in class Outlines

  Parameters:

  item - The object to locate in the collection

  Returns:

  boolean value

• remove

  public boolean remove(OutlineItemCollection item)

  Not supported yet.

  Always throws NotImplementedException

  Specified by:

  remove in class Outlines

  Parameters:

  item - The object to locate in the collection

  Returns:

  boolean value

• remove

  public final void remove(int index)

  Remove item by index.

  Parameters:

  index - Index of the item to be removed.

• get_Item

  public OutlineItemCollection get_Item(int index)

  Gets outline item from collection by index.

  Parameters:

  index - Index of requested item.

  Returns:

  OutlineItemCollection object