Aspose::Pdf::Annotations::GoToAction Class Reference

Represents a go-to action that changes the view to a specified destination (page, location, and magnification factor). More...

Inherits Aspose::Pdf::Annotations::PdfAction.

Inherited by Aspose::Pdf::Annotations::GoToRemoteAction.

Public Member Functions

virtual ASPOSE_PDF_SHARED_API System::SharedPtr< IAppointmentget_Destination ()
 Gets the destination to jump to. More...
 
virtual ASPOSE_PDF_SHARED_API void set_Destination (System::SharedPtr< IAppointment > value)
 Sets the destination to jump to. More...
 
ASPOSE_PDF_SHARED_API GoToAction (int32_t page)
 Constructor for GoToAction class. More...
 
ASPOSE_PDF_SHARED_API GoToAction (System::SharedPtr< Page > page)
 Constructor for GoToAction class. More...
 
ASPOSE_PDF_SHARED_API GoToAction (System::SharedPtr< Page > page, ExplicitDestinationType type, const System::ArrayPtr< double > &values)
 Constructor for GoToAction class. More...
 
ASPOSE_PDF_SHARED_API GoToAction (System::SharedPtr< ExplicitDestination > destination)
 Constructor. More...
 
ASPOSE_PDF_SHARED_API GoToAction ()
 Constructor. More...
 
ASPOSE_PDF_SHARED_API GoToAction (System::SharedPtr< Document > doc, System::String name)
 Action which linked with Named Destination. More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
ASPOSE_PDF_SHARED_API System::SharedPtr< ActionCollectionget_Next ()
 Next actions in sequence. More...
 
ASPOSE_PDF_SHARED_API System::String ToString () const override
 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...
 

Protected Member Functions

 GoToAction (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (GoToAction, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action))
 
- Protected Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > get_EngineDict ()
 
void set_EngineDict (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > value)
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > get_EngineObj () const
 
void set_EngineObj (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > value)
 
virtual ASPOSE_PDF_SHARED_API void Execute (const System::SharedPtr< Document > &document)
 
virtual ASPOSE_PDF_SHARED_API ~PdfAction ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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...
 
- Static Protected Member Functions inherited from Aspose::Pdf::Annotations::PdfAction
static System::SharedPtr< PdfActionCreateAction (const System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > &action)
 

Detailed Description

Represents a go-to action that changes the view to a specified destination (page, location, and magnification factor).

Constructor & Destructor Documentation

◆ GoToAction() [1/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::GoToAction::GoToAction ( int32_t  page)

Constructor for GoToAction class.

Deprecated:
Use constructor with Aspose.Pdf.Page parameter instead of this one. Reason: if to use this constructor there is the problem with the document when to resave it in Adobe Acrobat.
Parameters
pageThe destination page number to jump to.

◆ GoToAction() [2/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::GoToAction::GoToAction ( System::SharedPtr< Page page)

Constructor for GoToAction class.

Parameters
pageAspose.Pdf.Page destination object to jump to.

◆ GoToAction() [3/7]

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

Constructor for GoToAction class.

Parameters
pageDestination page.
typeDestination type.
valuesAction parameters.

◆ GoToAction() [4/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::GoToAction::GoToAction ( System::SharedPtr< ExplicitDestination destination)

Constructor.

Parameters
destinationExplicit destination.

◆ GoToAction() [5/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::GoToAction::GoToAction ( )

Constructor.

Deprecated:
Use constructors with parameters.

◆ GoToAction() [6/7]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::GoToAction::GoToAction ( System::SharedPtr< Document doc,
System::String  name 
)

Action which linked with Named Destination.

Parameters
docDocument where action will be created.
nameName of the destination.

◆ GoToAction() [7/7]

Aspose::Pdf::Annotations::GoToAction::GoToAction ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  action)
protected

Member Function Documentation

◆ get_Destination()

virtual ASPOSE_PDF_SHARED_API System::SharedPtr<IAppointment> Aspose::Pdf::Annotations::GoToAction::get_Destination ( )
virtual

Gets the destination to jump to.

Reimplemented in Aspose::Pdf::Annotations::GoToRemoteAction.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Annotations::GoToAction::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( GoToAction  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > action)   
)
protected

◆ set_Destination()

virtual ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::GoToAction::set_Destination ( System::SharedPtr< IAppointment value)
virtual

Sets the destination to jump to.

Reimplemented in Aspose::Pdf::Annotations::GoToRemoteAction.