Represents the base class for explicit destinations in PDF document. More...

Inherits Aspose::Pdf::Annotations::IAppointment.

Inherited by Aspose::Pdf::Annotations::CustomExplicitDestination, Aspose::Pdf::Annotations::FitBExplicitDestination, Aspose::Pdf::Annotations::FitBHExplicitDestination, Aspose::Pdf::Annotations::FitBVExplicitDestination, Aspose::Pdf::Annotations::FitExplicitDestination, Aspose::Pdf::Annotations::FitHExplicitDestination, Aspose::Pdf::Annotations::FitRExplicitDestination, Aspose::Pdf::Annotations::FitVExplicitDestination, and Aspose::Pdf::Annotations::XYZExplicitDestination.

Public Member Functions

ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Pageget_Page () const
 Gets the destination page object More...
 
ASPOSE_PDF_SHARED_API int32_t get_PageNumber () const
 Gets the destination page number More...
 
ASPOSE_PDF_SHARED_API System::String ToString () const override=0
 Returns string representation of ExplicitDestination object. 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 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...
 

Static Public Member Functions

static ASPOSE_PDF_SHARED_API System::SharedPtr< ExplicitDestinationCreateDestination (System::SharedPtr< Aspose::Pdf::Page > page, ExplicitDestinationType type, const System::ArrayPtr< double > &values)
 Creates instances of ExplicitDestination descendant classes. More...
 
static ASPOSE_PDF_SHARED_API System::SharedPtr< ExplicitDestinationCreateDestination (System::SharedPtr< Document > doc, int32_t pageNumber, ExplicitDestinationType type, const System::ArrayPtr< double > &values)
 Creates instances of ExplicitDestination descendant classes. More...
 
static ASPOSE_PDF_SHARED_API System::SharedPtr< ExplicitDestinationCreateDestination (int32_t pageNumber, ExplicitDestinationType type, const System::ArrayPtr< double > &values)
 Creates instances of ExplicitDestination descendant classes. 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...
 

Protected Member Functions

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > get_EngineDest () const
 
ASPOSE_PDF_SHARED_API ExplicitDestination (System::SharedPtr< Aspose::Pdf::Page > page, ExplicitDestinationType type, const System::ArrayPtr< double > &values)
 Creates the explicit destination. More...
 
ASPOSE_PDF_SHARED_API ExplicitDestination (int32_t pageNumber, ExplicitDestinationType type, const System::ArrayPtr< double > &values)
 Creates the explicit destination. More...
 
 ExplicitDestination (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > engineDest)
 

Static Protected Member Functions

static System::SharedPtr< ExplicitDestinationCreateDestination (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > engineDest)
 Creates instance of ExplicitDestination descendant classes. More...
 

Protected Attributes

System::SharedPtr< System::Globalization::CultureInfoCulture
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

Represents the base class for explicit destinations in PDF document.

Constructor & Destructor Documentation

◆ ExplicitDestination() [1/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::ExplicitDestination::ExplicitDestination ( System::SharedPtr< Aspose::Pdf::Page page,
ExplicitDestinationType  type,
const System::ArrayPtr< double > &  values 
)
protected

Creates the explicit destination.

Parameters
pageThe destination Aspose.Pdf.Page object.
typeThe type of explicit destination.
valuesThe additional values of explicit destination type.

◆ ExplicitDestination() [2/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::ExplicitDestination::ExplicitDestination ( int32_t  pageNumber,
ExplicitDestinationType  type,
const System::ArrayPtr< double > &  values 
)
protected

Creates the explicit destination.

Parameters
pageNumberThe destination page number.
typeThe type of explicit destination.
valuesThe additional values of explicit destination type.

◆ ExplicitDestination() [3/3]

Aspose::Pdf::Annotations::ExplicitDestination::ExplicitDestination ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray >  engineDest)
protected

Member Function Documentation

◆ CreateDestination() [1/4]

static ASPOSE_PDF_SHARED_API System::SharedPtr<ExplicitDestination> Aspose::Pdf::Annotations::ExplicitDestination::CreateDestination ( System::SharedPtr< Aspose::Pdf::Page page,
ExplicitDestinationType  type,
const System::ArrayPtr< double > &  values 
)
static

Creates instances of ExplicitDestination descendant classes.

Parameters
pageThe object of destination page.
typeThe type of explicit destination.
valuesArray of double values.
Returns
The explicit destination object.

◆ CreateDestination() [2/4]

static ASPOSE_PDF_SHARED_API System::SharedPtr<ExplicitDestination> Aspose::Pdf::Annotations::ExplicitDestination::CreateDestination ( System::SharedPtr< Document doc,
int32_t  pageNumber,
ExplicitDestinationType  type,
const System::ArrayPtr< double > &  values 
)
static

Creates instances of ExplicitDestination descendant classes.

Deprecated:
Use the method without Document argument.
Parameters
docDocument where destination will be created.
pageNumberNumber of the page.
typeDestionatyion type.
valuesArray of destination specific values.
Returns
The explicit destination object.

◆ CreateDestination() [3/4]

static ASPOSE_PDF_SHARED_API System::SharedPtr<ExplicitDestination> Aspose::Pdf::Annotations::ExplicitDestination::CreateDestination ( int32_t  pageNumber,
ExplicitDestinationType  type,
const System::ArrayPtr< double > &  values 
)
static

Creates instances of ExplicitDestination descendant classes.

Parameters
pageNumberThe destination page number.
typeThe type of explicit destination.
valuesArray of double values.
Returns
The explicit destination object.

◆ CreateDestination() [4/4]

static System::SharedPtr<ExplicitDestination> Aspose::Pdf::Annotations::ExplicitDestination::CreateDestination ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray >  engineDest)
staticprotected

Creates instance of ExplicitDestination descendant classes.

Parameters
engineDestEngine destination object.
Returns
DOM explicit destination object.

◆ get_EngineDest()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfArray> Aspose::Pdf::Annotations::ExplicitDestination::get_EngineDest ( ) const
protected

◆ get_Page()

ASPOSE_PDF_SHARED_API System::SharedPtr<Aspose::Pdf::Page> Aspose::Pdf::Annotations::ExplicitDestination::get_Page ( ) const

Gets the destination page object

◆ get_PageNumber()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::ExplicitDestination::get_PageNumber ( ) const

Gets the destination page number

◆ ToString()

Member Data Documentation

◆ Culture

System::SharedPtr<System::Globalization::CultureInfo> Aspose::Pdf::Annotations::ExplicitDestination::Culture
protected