Represents explicit destination that displays the page with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value. More...

Inherits Aspose::Pdf::Annotations::ExplicitDestination.

Public Member Functions
double	get_Left ()
	Gets left horizontal coordinate of the upper-left corner of the window. More...

double	get_Top ()
	Gets top vertical coordinate of the upper-left corner of the window. More...

double	get_Zoom ()
	Gets zoom factor. More...

	XYZExplicitDestination (System::SharedPtr< Aspose::Pdf::Page > page, double left, double top, double zoom)
	Creates local explicit destination. More...

	XYZExplicitDestination (System::SharedPtr< Document > document, int32_t pageNumber, double left, double top, double zoom)
	Creates remote explicit destination. More...

	XYZExplicitDestination (int32_t pageNumber, double left, double top, double zoom)
	Creates remote explicit destination. More...

virtual System::String	ToString ()
	Converts the object state into string value. Example: "1 XYZ 100 200 3". More...

Public Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
System::SharedPtr< Aspose::Pdf::Page >	get_Page () const
	Gets the destination page object More...

int32_t	get_PageNumber () const
	Gets the destination page number 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 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 () 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 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 (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)

Static Public Member Functions
static System::SharedPtr< XYZExplicitDestination >	CreateDestination (System::SharedPtr< Aspose::Pdf::Page > page, double left, double top, double zoom, bool considerRotation)
	Create destintion to specified location of the page considering page rotation if required. More...

static System::SharedPtr< XYZExplicitDestination >	CreateDestinationToUpperLeftCorner (System::SharedPtr< Aspose::Pdf::Page > page, double zoom)
	Create destionation to upper left corner of the specifed page. More...

static System::SharedPtr< XYZExplicitDestination >	CreateDestinationToUpperLeftCorner (System::SharedPtr< Aspose::Pdf::Page > page)
	Create destination to specified page. More...

Static Public Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
static 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 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 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 ()
	Impleemnts C# typeof(System.Object) construct. More...

Protected Member Functions
	XYZExplicitDestination (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > engineDest)
	Creates the instance and initializes it by engine destination object. More...

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

	ExplicitDestination (System::SharedPtr< Aspose::Pdf::Page > page, ExplicitDestinationType type, const System::ArrayPtr< double > &values)
	Creates the explicit destination. More...

	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)

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	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 Protected Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
static System::SharedPtr< ExplicitDestination >	CreateDestination (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > engineDest)
	Creates instance of ExplicitDestination descendant classes. More...

Protected Attributes inherited from Aspose::Pdf::Annotations::ExplicitDestination
System::SharedPtr< System::Globalization::CultureInfo >	Culture

Detailed Description

Represents explicit destination that displays the page with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value.

Document doc = new Document("example.pdf");
XYZExplicitDestination dest = (XYZExplicitDestination)doc.Outlines[1].Destination;
string left = dest.Left;
string top = dest.Top;
string zoom = dest.Zoom;

Constructor & Destructor Documentation

◆ XYZExplicitDestination() [1/4]

Aspose::Pdf::Annotations::XYZExplicitDestination::XYZExplicitDestination	(	System::SharedPtr< Aspose::Pdf::Page >	page,
		double	left,
		double	top,
		double	zoom
	)

Creates local explicit destination.

Parameters

page	The destination page object.
left	Left horizontal coordinate of the upper-left corner of the window.
top	Top vertical coordinate of the upper-left corner of the window.
zoom	Zoom factor.

◆ XYZExplicitDestination() [2/4]

Aspose::Pdf::Annotations::XYZExplicitDestination::XYZExplicitDestination	(	System::SharedPtr< Document >	document,
		int32_t	pageNumber,
		double	left,
		double	top,
		double	zoom
	)

Creates remote explicit destination.

Deprecated:: Use constructor without Document argument.

Parameters

document	The parent document that contains this object.
pageNumber	The destination page number of remote document.
left	Left horizontal coordinate of the upper-left corner of the window.
top	Top vertical coordinate of the upper-left corner of the window.
zoom	Zoom factor.

◆ XYZExplicitDestination() [3/4]

Aspose::Pdf::Annotations::XYZExplicitDestination::XYZExplicitDestination	(	int32_t	pageNumber,
		double	left,
		double	top,
		double	zoom
	)

Creates remote explicit destination.

Parameters

pageNumber	The destination page number of remote document.
left	Left horizontal coordinate of the upper-left corner of the window.
top	Top vertical coordinate of the upper-left corner of the window.
zoom	Zoom factor.

◆ XYZExplicitDestination() [4/4]

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

protected

Creates the instance and initializes it by engine destination object.

Parameters

engineDest Engine destination object.

Member Function Documentation

◆ CreateDestination()

static System::SharedPtr<XYZExplicitDestination> Aspose::Pdf::Annotations::XYZExplicitDestination::CreateDestination	(	System::SharedPtr< Aspose::Pdf::Page >	page,
		double	left,
		double	top,
		double	zoom,
		bool	considerRotation
	)

static

Create destintion to specified location of the page considering page rotation if required.

Parameters

page	Destination page.
left	Left position on the page.
top	Top position on the page.
zoom	Zoom factor (0 for default).
considerRotation	If true position will be recalculated according to page rotation.

Returns: Destination object.

◆ CreateDestinationToUpperLeftCorner() [1/2]

static System::SharedPtr<XYZExplicitDestination> Aspose::Pdf::Annotations::XYZExplicitDestination::CreateDestinationToUpperLeftCorner	(	System::SharedPtr< Aspose::Pdf::Page >	page,
		double	zoom
	)

static

Create destionation to upper left corner of the specifed page.

Parameters

page	Destination page.
zoom	Zoom factor.

Returns: Destination object.

◆ CreateDestinationToUpperLeftCorner() [2/2]

static System::SharedPtr<XYZExplicitDestination> Aspose::Pdf::Annotations::XYZExplicitDestination::CreateDestinationToUpperLeftCorner ( System::SharedPtr< Aspose::Pdf::Page > page )

static

Create destination to specified page.

Parameters

page	Destination page.

Returns: Destination object.

◆ get_Left()

double Aspose::Pdf::Annotations::XYZExplicitDestination::get_Left ( )

Gets left horizontal coordinate of the upper-left corner of the window.

◆ get_Top()

double Aspose::Pdf::Annotations::XYZExplicitDestination::get_Top ( )

Gets top vertical coordinate of the upper-left corner of the window.

◆ get_Zoom()

double Aspose::Pdf::Annotations::XYZExplicitDestination::get_Zoom ( )

Gets zoom factor.

◆ ToString()

virtual System::String Aspose::Pdf::Annotations::XYZExplicitDestination::ToString ( )

virtual

Converts the object state into string value. Example: "1 XYZ 100 200 3".

Returns: String value representing object state.

Implements Aspose::Pdf::Annotations::ExplicitDestination.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ XYZExplicitDestination() [1/4]

◆ XYZExplicitDestination() [2/4]

◆ XYZExplicitDestination() [3/4]

◆ XYZExplicitDestination() [4/4]

Member Function Documentation

◆ CreateDestination()

◆ CreateDestinationToUpperLeftCorner() [1/2]

◆ CreateDestinationToUpperLeftCorner() [2/2]

◆ get_Left()

◆ get_Top()

◆ get_Zoom()

◆ ToString()