DestinationCollection
Inheritance: java.lang.Object, com.aspose.pdf.DestinationCollection
All Implemented Interfaces: Iterable <com.aspose.ms.System.Collections.Generic.KeyValuePair< String, Object »
public final class DestinationCollection extends Object implements Iterable <com.aspose.ms.System.Collections.Generic.KeyValuePair< String , Object >>
Class represents the collection of all destinations (a name tree mapping name strings to destinations (see 12.3.2.3, “Named Destinations”) and (see 7.7.4, “Name Dictionary”)) in the pdf document.
Methods
| Method | Description |
|---|---|
| add | Adds the specified item. |
| clear | Collection is read-only. Always throws NotSupportedException exception. |
| contains | Determines whether this instance contains the object. |
| copyTo | Copies the elements of the collection to an Array, starting at a particular Array index. |
| get_Item | Gets the destination object by index. |
| getExplicitDestination | Returns the explicit destination by the name. |
| getPageNumber | Returns the page number of destination by the name. |
| indexOf | Returns the index of destination in collection. |
| isReadOnly | Gets a value indicating whether the collection is read-only. |
| iterator | Returns the enumerator. |
| remove | Removes the specified item. |
| size | Gets the number of elements contained in the collection. |
add
Adds the specified item.
clear
public void clear()
Collection is read-only. Always throws NotSupportedException exception.
contains
Determines whether this instance contains the object.
copyTo
Copies the elements of the collection to an Array, starting at a particular Array index.
get_Item
public com.aspose.ms.System.Collections.Generic.KeyValuePair< String , Object > get_Item(int index)
Gets the destination object by index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | The index of destination to get. |
Returns: Destination.
getExplicitDestination
Returns the explicit destination by the name.
getPageNumber
Returns the page number of destination by the name.
indexOf
Returns the index of destination in collection.
isReadOnly
public boolean isReadOnly()
Gets a value indicating whether the collection is read-only.
Returns: boolean value
iterator
public com.aspose.ms.System.Collections.IEnumerator<com.aspose.ms.System.Collections.Generic.KeyValuePair< String , Object >> iterator()
Returns the enumerator.
Returns: The enumerator.
remove
Removes the specified item.
size
public int size()
Gets the number of elements contained in the collection.
Returns: int value