Aspose::Pdf::DestinationCollection Class Referencefinal

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

Inherits System::Collections::Generic::ICollection< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >.

Classes

class  DestinationEnumerator
 Class represents enumerator of the collection. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API int32_t get_Count () const override
 Gets the number of elements contained in the collection. More...
 
ASPOSE_PDF_SHARED_API bool get_IsReadOnly () const override
 Gets a value indicating whether the collection is read-only. More...
 
ASPOSE_PDF_SHARED_API System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > idx_get (int32_t index)
 Gets the destination object by index. More...
 
ASPOSE_PDF_SHARED_API int32_t GetPageNumber (System::String destinameName, bool useCache)
 Returns the page number of destination by the name. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Annotations::ExplicitDestinationGetExplicitDestination (System::String destinameName, bool useCache)
 Returns the explicit destination by the name. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > > GetEnumerator () override
 Returns the enumerator. More...
 
ASPOSE_PDF_SHARED_API int32_t IndexOf (System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >> value) const
 Returns the index of destination in collection. More...
 
ASPOSE_PDF_SHARED_API bool Contains (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >> &value) const override
 Determines whether this instance contains the object. More...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >>> array, int32_t arrayIndex) override
 Copies the elements of the collection to an Array, starting at a particular Array index. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >> &item) override
 Adds the specified item. Collection is read-only. Always throws NotSupportedException exception. More...
 
ASPOSE_PDF_SHARED_API void Clear () override
 Collection is read-only. Always throws NotSupportedException exception. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >> &item) override
 Removes the specified item. Collection is read-only. Always throws NotSupportedException exception. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >
virtual void Add (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > &item)=0
 Adds element into collection. More...
 
virtual bool Contains (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > &item) const=0
 Checks if element is present in collection. More...
 
virtual bool Remove (const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > &item)=0
 Deletes element from collection. More...
 
virtual void CopyTo (System::ArrayPtr< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > array, int arrayIndex)=0
 Copies all collection elements to existing array elements. More...
 
ICollectionoperator= (ICollection &&) noexcept
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&) noexcept
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >
System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > LINQ_First ()
 Returns the first element of a sequence. More...
 
System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > LINQ_First (const Func< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > LINQ_FirstOrDefault (std::function< bool(System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > LINQ_Last ()
 Returns the last element of a sequence. More...
 
System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > > LINQ_Where (std::function< bool(System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > > LINQ_OrderBy (const Func< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > > LINQ_OrderByDescending (const Func< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > > LINQ_Concat (SharedPtr< IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > > > > LINQ_GroupBy (System::Func< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

 DestinationCollection (System::SharedPtr< Document > document)
 Initializes new Destination collection instance from the document . More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (DestinationCollection, CODEPORTING_ARGS(System::SharedPtr< Document > document))
 
virtual ASPOSE_PDF_SHARED_API ~DestinationCollection ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::ICollection< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >
typedef System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > ValueType
 Value type name. More...
 
typedef ICollection< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >
typedef IEnumerator< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >
 
using iterator = System::Details::VirtualizedIterator< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object > >
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ DestinationCollection()

Aspose::Pdf::DestinationCollection::DestinationCollection ( System::SharedPtr< Document document)
protected

Initializes new Destination collection instance from the document .

Parameters
documentDocument contained destinations.

◆ ~DestinationCollection()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::DestinationCollection::~DestinationCollection ( )
protectedvirtual

Member Function Documentation

◆ Add()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DestinationCollection::Add ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >> &  item)
override

Adds the specified item. Collection is read-only. Always throws NotSupportedException exception.

Parameters
itemThe item.
Exceptions
NotSupportedException

◆ Clear()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DestinationCollection::Clear ( )
overridevirtual

◆ Contains()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::DestinationCollection::Contains ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >> &  value) const
override

Determines whether this instance contains the object.

Parameters
valueThe value.
Returns
true if [contains] [the specified value]; otherwise, false.

◆ CopyTo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::DestinationCollection::CopyTo ( System::ArrayPtr< System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >>>  array,
int32_t  arrayIndex 
)
override

Copies the elements of the collection to an Array, starting at a particular Array index.

Parameters
arrayThe one-dimensional Array that is the destination of the elements copied from collection
arrayIndexThe zero-based index in array at which copying begins.

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::DestinationCollection::get_Count ( ) const
overridevirtual

◆ get_IsReadOnly()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::DestinationCollection::get_IsReadOnly ( ) const
overridevirtual

◆ GetEnumerator()

◆ GetExplicitDestination()

ASPOSE_PDF_SHARED_API System::SharedPtr<Annotations::ExplicitDestination> Aspose::Pdf::DestinationCollection::GetExplicitDestination ( System::String  destinameName,
bool  useCache 
)

Returns the explicit destination by the name.

Parameters
destinameNameThe name of destination.
useCacheDetermines whether cached version of collection is used or not.
Returns
The ExplicitDestination object for destination found; otherwise, null.

◆ GetPageNumber()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::DestinationCollection::GetPageNumber ( System::String  destinameName,
bool  useCache 
)

Returns the page number of destination by the name.

Parameters
destinameNameThe name of destination.
useCacheDetermines whether cached version of collection is used or not.
Returns
The page number if destination was found; otherwise, -1.

◆ idx_get()

ASPOSE_PDF_SHARED_API System::Collections::Generic::KeyValuePair<System::String, System::SharedPtr<System::Object> > Aspose::Pdf::DestinationCollection::idx_get ( int32_t  index)

Gets the destination object by index.

Parameters
indexThe index of destination to get.
Returns
Destination.

◆ IndexOf()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::DestinationCollection::IndexOf ( System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >>  value) const

Returns the index of destination in collection.

Parameters
valueThe value to find.
Returns
The index of destination in collection.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::DestinationCollection::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( DestinationCollection  ,
CODEPORTING_ARGS(System::SharedPtr< Document > document)   
)
protected

◆ Remove()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::DestinationCollection::Remove ( const System::Collections::Generic::KeyValuePair< System::String, System::SharedPtr< System::Object >> &  item)
override

Removes the specified item. Collection is read-only. Always throws NotSupportedException exception.

Parameters
itemThe item.
Returns
Exceptions
NotSupportedException