OutlineItemCollection

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

All Implemented Interfaces: Iterable < OutlineItemCollection >

public final class OutlineItemCollection extends Outlines

Represents outline entry in outline hierarchy of PDF document.

Constructors

Constructor	Description
OutlineItemCollection	Initializes new instance of this class using internal engine outline entry object.
OutlineItemCollection	Initializes outline item instance using root hierarchy object.

Methods

Method	Description
add	Adds outline item to collection.
clear	Clears all items from the collection.
contains	Not supported yet. Always throws NotImplementedException
copyTo	Copies the outline entries to an System.Array, starting at a particular System.Array index.
delete	Deletes this outline item from the document outline hierarchy.
delete	Deletes this outline item from the document outline hierarchy.
get_Item	Gets outline item from the collection using index.
getAction	Gets the action for this outline item.
getBold	Gets bold flag for the title text of this outline item
getColor	Gets the color for the title text of this outline item.
getDestination	Gets the destination for this outline item.
getEngineDict	Internal only
getEngineObj	Internal only
getFirst	Gets the outline item representing the first top-level item in the outline hierarchy.
getItalic	Gets an italic flag for the title text of this outline item
getLast	Gets the outline item representing the last top-level item in the outline hierarchy.
getLevel	Gets hierarchy level of outline item.
getNext	Gets the outline item representing next item relatively this item in the outline hierarchy.
getOpen	Get open status (true/false) for outline item.
getParent	Gets the parent object of this outline item in the outline hierarchy.
getPrev	Gets the outline item representing previous item relatively this item in the outline hierarchy.
getSyncRoot	Gets the object that can be used to synchronize access to this collection.
getTitle	Gets the title for this outline item.
getVisibleCount	Gets the total number of outline items at all levels in the document outline hierarchy.
hasNext	Check if outline item representing next item relatively this item in the outline hierarchy.
insert	Inserts the outline item into collection at the specified place.
isReadOnly	Gets a value indicating whether the collection is read-only.
isSynchronized	Gets the 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 NotImplementedException
setAction	Sets the action for this outline item.
setBold	Sets bold flag for the title text of this outline item
setColor	Sets the color for the title text of this outline item.
setDestination	Sets the destination for this outline item.
setItalic	Sets italic flag for the title text of this outline item
setOpen	Sets open status (true/false) for outline item.
setTitle	Sets the title for this outline item.
size	Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels.

OutlineItemCollection

Initializes new instance of this class using internal engine outline entry object.

OutlineItemCollection

Initializes outline item instance using root hierarchy object.

add

Adds outline item to collection.

clear

public void clear()

Clears all items from the collection.

contains

Not supported yet. Always throws NotImplementedException

copyTo

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

delete

public void delete()

Deletes this outline item from the document outline hierarchy.

delete

Deletes this outline item from the document outline hierarchy.

get_Item

public OutlineItemCollection get_Item(int index)

Gets outline item from the collection using index.

Parameters:

Parameter	Type	Description
index		Index within the collection.

Returns: OutlineItemCollection object.

getAction

public PdfAction getAction()

Gets the action for this outline item.

Returns: PdfAction value

getBold

public boolean getBold()

Gets bold flag for the title text of this outline item

Returns: boolean value

getColor

public Color getColor()

Gets the color for the title text of this outline item.

Returns: Color value

getDestination

public IAppointment getDestination()

Gets the destination for this outline item.

Returns: IAppointment value

getEngineDict

public com.aspose.pdf.engine.data.IPdfDictionary getEngineDict()

Internal only

Returns: IPdfDictionary object

getEngineObj

public com.aspose.pdf.engine.data.IPdfObject getEngineObj()

Internal only

Returns: IPdfObject object

getFirst

public OutlineItemCollection getFirst()

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

Returns: OutlineItemCollection value

getItalic

public boolean getItalic()

Gets an italic flag for the title text of this outline item

Returns: boolean value

getLast

public OutlineItemCollection getLast()

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

Returns: OutlineItemCollection value

getLevel

public int getLevel()

Gets hierarchy level of outline item.

Returns: int value

getNext

public OutlineItemCollection getNext()

Gets the outline item representing next item relatively this item in the outline hierarchy.

Returns: OutlineItemCollection value

getOpen

public boolean getOpen()

Get open status (true/false) for outline item.

Returns: boolean value

getParent

public Outlines getParent()

Gets the parent object of this outline item in the outline hierarchy.

Returns: Object value

getPrev

public OutlineItemCollection getPrev()

Gets the outline item representing previous item relatively this item in the outline hierarchy.

Returns: OutlineItemCollection value

getSyncRoot

public Object getSyncRoot()

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

Returns: Object value

getTitle

public String getTitle()

Gets the title for this outline item.

Returns: String value

getVisibleCount

public int getVisibleCount()

Gets the total number of outline items at all levels in the document outline hierarchy.

Returns: int value

hasNext

public final boolean hasNext()

Check if outline item representing next item relatively this item in the outline hierarchy.

Returns: boolean value

insert

Inserts the outline item into collection at the specified place.

isReadOnly

public boolean isReadOnly()

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

Returns: boolean value

isSynchronized

public boolean isSynchronized()

Gets the 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 item to be deleted.

remove

Not supported yet. Always throws NotImplementedException

setAction

Sets the action for this outline item.

setBold

public void setBold(boolean value)

Sets bold flag for the title text of this outline item

Parameters:

Parameter	Type	Description
value		boolean value

setColor

Sets the color for the title text of this outline item.

setDestination

Sets the destination for this outline item.

setItalic

public void setItalic(boolean value)

Sets italic flag for the title text of this outline item

Parameters:

Parameter	Type	Description
value		boolean value

setOpen

public void setOpen(boolean value)

Sets open status (true/false) for outline item.

Parameters:

Parameter	Type	Description
value		boolean value

setTitle

Sets the title for this outline item.

size

public int size()

Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels.

Returns: int value