DestinationCollection

DestinationCollection

Overview

DestinationCollection is a class in Aspose.PDF FOSS for .NET. Inherits from: System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>>.

Named-destination collection exposed as IEnumerable<KeyValuePair<string, object>>.

This class provides 10 methods for working with DestinationCollection objects in .NET programs. Available methods include: Add, Clear, Contains, CopyTo, GetEnumerator, GetExplicitDestination, GetPageNumber, IndexOf, Remove. All public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package. Properties: Count, IsReadOnly.

Properties

NameTypeAccessDescription
CountintReadNumber of destinations (named-destination tree entries plus locally-added overlay entries).
IsReadOnlyboolReadAlways false: callers may extend via the local overlay.

Methods

SignatureDescription
GetPageNumber(destinameName: string, useCache: bool)Get the 1-based page number for a named destination.
GetPageNumber(destinameName: string)Convenience overload that always caches.
GetExplicitDestination(destinameName: string, useCache: bool)Resolve a named destination to an ExplicitDestination; returns null when not found.
Add(item: System.Collections.Generic.KeyValuePair<string, object>)Append a (name → destination) pair to the local overlay.
Clear()Remove every overlay entry.
Contains(value: System.Collections.Generic.KeyValuePair<string, object>)Whether value is present in the snapshot (named destinations or overlay).
CopyTo(array: System.Collections.Generic.KeyValuePair<string, object>[], arrayIndex: int)Copy the snapshot into array starting at arrayIndex.
IndexOf(value: System.Collections.Generic.KeyValuePair<string, object>)Index of value in the snapshot, or -1.
Remove(item: System.Collections.Generic.KeyValuePair<string, object>)Remove an overlay entry matching item.
GetEnumerator()Calls GetEnumerator on this DestinationCollection instance.

See Also