Aspose::Pdf::Annotations::FitBExplicitDestination Class Referencefinal

Represents explicit destination that displays the page with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension. More...

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

Public Member Functions

 FitBExplicitDestination (System::SharedPtr< Aspose::Pdf::Page > page)
 Creates local explicit destination. More...
 
 FitBExplicitDestination (System::SharedPtr< Document > document, int32_t pageNumber)
 Creates remote explicit destination. More...
 
 FitBExplicitDestination (int32_t pageNumber)
 Creates remote explicit destination. More...
 
virtual System::String ToString ()
 Converts the object state into string value. Example: "1 FitB". More...
 
- Public Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
System::SharedPtr< Aspose::Pdf::Pageget_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...
 
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 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 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 (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)
 

Protected Member Functions

 FitBExplicitDestination (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< Objectptr
 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 Public Member Functions inherited from Aspose::Pdf::Annotations::ExplicitDestination
static System::SharedPtr< ExplicitDestinationCreateDestination (System::SharedPtr< Aspose::Pdf::Page > page, ExplicitDestinationType type, const System::ArrayPtr< double > &values)
 Creates instances of ExplicitDestination descendant classes. More...
 
static 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 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 ()
 Impleemnts C# typeof(System.Object) construct. 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 its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.

Constructor & Destructor Documentation

◆ FitBExplicitDestination() [1/4]

Aspose::Pdf::Annotations::FitBExplicitDestination::FitBExplicitDestination ( System::SharedPtr< Aspose::Pdf::Page page)

Creates local explicit destination.

Parameters
pageThe destination page object.

◆ FitBExplicitDestination() [2/4]

Aspose::Pdf::Annotations::FitBExplicitDestination::FitBExplicitDestination ( System::SharedPtr< Document document,
int32_t  pageNumber 
)

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.

◆ FitBExplicitDestination() [3/4]

Aspose::Pdf::Annotations::FitBExplicitDestination::FitBExplicitDestination ( int32_t  pageNumber)

Creates remote explicit destination.

Parameters
pageNumberThe destination page number of remote document.

◆ FitBExplicitDestination() [4/4]

Aspose::Pdf::Annotations::FitBExplicitDestination::FitBExplicitDestination ( 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

◆ ToString()

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

Converts the object state into string value. Example: "1 FitB".

Returns
String value representing object state.

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