Aspose::Pdf::Annotations::XYZExplicitDestination Class Referencefinal

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

ASPOSE_PDF_SHARED_API double get_Left ()
 Gets left horizontal coordinate of the upper-left corner of the window. More...
 
ASPOSE_PDF_SHARED_API double get_Top ()
 Gets top vertical coordinate of the upper-left corner of the window. More...
 
ASPOSE_PDF_SHARED_API double get_Zoom ()
 Gets zoom factor. More...
 
ASPOSE_PDF_SHARED_API XYZExplicitDestination (System::SharedPtr< Aspose::Pdf::Page > page, double left, double top, double zoom)
 Creates local explicit destination. More...
 
ASPOSE_PDF_SHARED_API XYZExplicitDestination (System::SharedPtr< Document > document, int32_t pageNumber, double left, double top, double zoom)
 Creates remote explicit destination. More...
 
ASPOSE_PDF_SHARED_API XYZExplicitDestination (int32_t pageNumber, double left, double top, double zoom)
 Creates remote explicit destination. More...
 
ASPOSE_PDF_SHARED_API System::String ToString () const override
 Converts the object state into string value. Example: "1 XYZ 100 200 3". More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
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...
 
- 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< XYZExplicitDestinationCreateDestination (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 ASPOSE_PDF_SHARED_API System::SharedPtr< XYZExplicitDestinationCreateDestinationToUpperLeftCorner (System::SharedPtr< Aspose::Pdf::Page > page, double zoom)
 Create destionation to upper left corner of the specifed page. More...
 
static ASPOSE_PDF_SHARED_API System::SharedPtr< XYZExplicitDestinationCreateDestinationToUpperLeftCorner (System::SharedPtr< Aspose::Pdf::Page > page)
 Create destination to specified page. More...
 
- Static Public Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
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

 XYZExplicitDestination (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > engineDest)
 Creates the instance and initializes it by engine destination object. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XYZExplicitDestination, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > engineDest))
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
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)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Protected Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
static System::SharedPtr< ExplicitDestinationCreateDestination (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::CultureInfoCulture
 

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.

Constructor & Destructor Documentation

◆ XYZExplicitDestination() [1/4]

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

Creates local explicit destination.

Parameters
pageThe destination page object.
leftLeft horizontal coordinate of the upper-left corner of the window.
topTop vertical coordinate of the upper-left corner of the window.
zoomZoom factor.

◆ XYZExplicitDestination() [2/4]

ASPOSE_PDF_SHARED_API 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
documentThe parent document that contains this object.
pageNumberThe destination page number of remote document.
leftLeft horizontal coordinate of the upper-left corner of the window.
topTop vertical coordinate of the upper-left corner of the window.
zoomZoom factor.

◆ XYZExplicitDestination() [3/4]

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

Creates remote explicit destination.

Parameters
pageNumberThe destination page number of remote document.
leftLeft horizontal coordinate of the upper-left corner of the window.
topTop vertical coordinate of the upper-left corner of the window.
zoomZoom 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
engineDestEngine destination object.

Member Function Documentation

◆ CreateDestination()

static ASPOSE_PDF_SHARED_API 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
pageDestination page.
leftLeft position on the page.
topTop position on the page.
zoomZoom factor (0 for default).
considerRotationIf true position will be recalculated according to page rotation.
Returns
Destination object.

◆ CreateDestinationToUpperLeftCorner() [1/2]

static ASPOSE_PDF_SHARED_API 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
pageDestination page.
zoomZoom factor.
Returns
Destination object.

◆ CreateDestinationToUpperLeftCorner() [2/2]

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

Create destination to specified page.

Parameters
pageDestination page.
Returns
Destination object.

◆ get_Left()

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

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

◆ get_Top()

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

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

◆ get_Zoom()

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

Gets zoom factor.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Annotations::XYZExplicitDestination::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( XYZExplicitDestination  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfArray > engineDest)   
)
protected

◆ ToString()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::XYZExplicitDestination::ToString ( ) const
overridevirtual

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

Returns
String value representing object state.

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