com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class OutlineCollection

  • All Implemented Interfaces:
    Iterable


    public final class OutlineCollection
    extends Object
    implements Iterable

    Represents document outline hierarchy.

    • Method Detail

      • size

        public int size()

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

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

        public void add(OutlineItemCollection outline)

        Adds outline item to collection.

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

        public com.aspose.ms.System.Collections.IEnumerator iterator()

        Returns an enumerator that iterates through the collection.

        Specified by:
        iterator in interface Iterable
        Returns:
        An System.Collections.IEnumerator object that can be used to iterate through the collection.
      • get_Item

        public OutlineItemCollection get_Item(int index)

        Gets outline item from collection by index.

        Parameters:
        index - Index of requested item.
        Returns:
        OutlineItemCollection object