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

#include "ExplicitDestination.h"

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::Page >	get_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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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< ExplicitDestination >	CreateDestination (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< ExplicitDestination >	CreateDestination (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< ExplicitDestination >	CreateDestination (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 TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

Protected Member Functions
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray >	get_EngineDest () const

ASPOSE_PDF_SHARED_API double	GetNumber (int32_t index) const
	Gets double value by specified index of element. More...

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< ExplicitDestination >	CreateDestination (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > engineDest)
	Creates instance of ExplicitDestination descendant classes. More...

Protected Attributes
System::SharedPtr< System::Globalization::CultureInfo >	Culture

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	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

page	The destination Aspose.Pdf.Page object.
type	The type of explicit destination.
values	The 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

pageNumber	The destination page number.
type	The type of explicit destination.
values	The 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

page	The object of destination page.
type	The type of explicit destination.
values	Array 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

doc	Document where destination will be created.
pageNumber	Number of the page.
type	Destionatyion type.
values	Array 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

pageNumber	The destination page number.
type	The type of explicit destination.
values	Array 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

engineDest Engine 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

◆ GetNumber()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::ExplicitDestination::GetNumber ( int32_t index ) const

protected

Gets double value by specified index of element.

Parameters

index The index of element to get.

Returns: Double value of the specified element.

◆ ToString()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::ExplicitDestination::ToString ( ) const

overridepure virtual

Returns string representation of ExplicitDestination object.

Returns: String representation.

Reimplemented from System::Object.

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

Member Data Documentation

◆ Culture

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

protected

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExplicitDestination() [1/3]

◆ ExplicitDestination() [2/3]

◆ ExplicitDestination() [3/3]

Member Function Documentation

◆ CreateDestination() [1/4]

◆ CreateDestination() [2/4]

◆ CreateDestination() [3/4]

◆ CreateDestination() [4/4]

◆ get_EngineDest()

◆ get_Page()

◆ get_PageNumber()

◆ GetNumber()

◆ ToString()

Member Data Documentation

◆ Culture