Aspose::Words::Rendering::PageInfo Class Reference

Represents information about a particular document page. More...

#include "Aspose.Words.Cpp/Rendering/PageInfo.h"

Inherits System::Object.

Public Member Functions

Aspose::Words::PaperSize get_PaperSize ()
 Gets the paper size as enumeration. More...
 
float get_WidthInPoints ()
 Gets the width of the page in points. More...
 
float get_HeightInPoints ()
 Gets the height of the page in points. More...
 
System::Drawing::SizeF get_SizeInPoints () const
 Gets the page size in points. More...
 
int32_t get_PaperTray () const
 Gets the paper tray (bin) for this page as specified in the document. The value is implementation (printer) specific. More...
 
bool get_Landscape () const
 Returns true if the page orientation specified in the document for this page is landscape. More...
 
System::Drawing::Size GetSizeInPixels (float scale, float dpi)
 Calculates the page size in pixels for a specified zoom factor and resolution. More...
 
System::Drawing::Size GetSizeInPixels (float scale, float horizontalDpi, float verticalDpi)
 Calculates the page size in pixels for a specified zoom factor and resolution. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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...
 

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 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...
 
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)
 

Detailed Description

Represents information about a particular document page.

The page width and height returned by this object represent the "final" size of the page e.g. they are already rotated to the correct orientation.

See also
Aspose::Words::Document::GetPageInfo(int32_t)

Member Function Documentation

◆ get_HeightInPoints()

float Aspose::Words::Rendering::PageInfo::get_HeightInPoints ( )

Gets the height of the page in points.

◆ get_Landscape()

bool Aspose::Words::Rendering::PageInfo::get_Landscape ( ) const

Returns true if the page orientation specified in the document for this page is landscape.

◆ get_PaperSize()

Aspose::Words::PaperSize Aspose::Words::Rendering::PageInfo::get_PaperSize ( )

Gets the paper size as enumeration.

◆ get_PaperTray()

int32_t Aspose::Words::Rendering::PageInfo::get_PaperTray ( ) const

Gets the paper tray (bin) for this page as specified in the document. The value is implementation (printer) specific.

◆ get_SizeInPoints()

System::Drawing::SizeF Aspose::Words::Rendering::PageInfo::get_SizeInPoints ( ) const

Gets the page size in points.

◆ get_WidthInPoints()

float Aspose::Words::Rendering::PageInfo::get_WidthInPoints ( )

Gets the width of the page in points.

◆ GetSizeInPixels() [1/2]

System::Drawing::Size Aspose::Words::Rendering::PageInfo::GetSizeInPixels ( float  scale,
float  dpi 
)

Calculates the page size in pixels for a specified zoom factor and resolution.

Parameters
scaleThe zoom factor (1.0 is 100%).
dpiThe resolution (horizontal and vertical) to convert from points to pixels (dots per inch).
Returns
The size of the page in pixels.

◆ GetSizeInPixels() [2/2]

System::Drawing::Size Aspose::Words::Rendering::PageInfo::GetSizeInPixels ( float  scale,
float  horizontalDpi,
float  verticalDpi 
)

Calculates the page size in pixels for a specified zoom factor and resolution.

Parameters
scaleThe zoom factor (1.0 is 100%).
horizontalDpiThe horizontal resolution to convert from points to pixels (dots per inch).
verticalDpiThe vertical resolution to convert from points to pixels (dots per inch).
Returns
The size of the page in pixels.