Aspose::Pdf::NamedDestinationCollection Class Reference

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 Aspose::Pdf::INamedDestinationCollection.

Public Member Functions

int32_t get_Count ()
 Count of named destinations. More...
 
System::ArrayPtr< System::Stringget_Names ()
 List of names of the destinations. More...
 
System::SharedPtr< Annotations::IAppointmentidx_get (System::String name)
 Gets appointment by its name. More...
 
void idx_set (System::String name, System::SharedPtr< Annotations::IAppointment > value)
 Sets appointment by its name. More...
 
void Remove (System::String name)
 Delete named destination. More...
 
void Add (System::String name, System::SharedPtr< Annotations::IAppointment > appointment)
 Add new named destination. 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 refernce 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

 NamedDestinationCollection (System::SharedPtr< Document > document)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts 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

◆ NamedDestinationCollection()

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

Member Function Documentation

◆ Add()

void Aspose::Pdf::NamedDestinationCollection::Add ( System::String  name,
System::SharedPtr< Annotations::IAppointment appointment 
)
virtual

Add new named destination.

Parameters
nameDestination name.
appointmentAppointment to add.

Implements Aspose::Pdf::INamedDestinationCollection.

◆ get_Count()

int32_t Aspose::Pdf::NamedDestinationCollection::get_Count ( )
virtual

Count of named destinations.

Implements Aspose::Pdf::INamedDestinationCollection.

◆ get_Names()

System::ArrayPtr<System::String> Aspose::Pdf::NamedDestinationCollection::get_Names ( )
virtual

List of names of the destinations.

Implements Aspose::Pdf::INamedDestinationCollection.

◆ idx_get()

System::SharedPtr<Annotations::IAppointment> Aspose::Pdf::NamedDestinationCollection::idx_get ( System::String  name)
virtual

Gets appointment by its name.

Parameters
nameName of the appointment.
Returns
Appoitnemt

Implements Aspose::Pdf::INamedDestinationCollection.

◆ idx_set()

void Aspose::Pdf::NamedDestinationCollection::idx_set ( System::String  name,
System::SharedPtr< Annotations::IAppointment value 
)
virtual

Sets appointment by its name.

Parameters
nameName of the appointment.
valueAppoitnemt

Implements Aspose::Pdf::INamedDestinationCollection.

◆ Remove()

void Aspose::Pdf::NamedDestinationCollection::Remove ( System::String  name)
virtual

Delete named destination.

Parameters
nameName of the destination to delete.

Implements Aspose::Pdf::INamedDestinationCollection.