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

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)

#include <Aspose.Words.Cpp/Rendering/PageInfo.h>

+ Inheritance diagram for Aspose::Words::Rendering::PageInfo:

Public Member Functions

float get_HeightInPoints ()
 Gets the height of the page in points. More...
 
bool get_Landscape () const
 Returns true if the page orientation specified in the document for this page is landscape. More...
 
PaperSize get_PaperSize ()
 Gets the paper size as enumeration. 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...
 
SizeF get_SizeInPoints () const
 Gets the page size in points. More...
 
float get_WidthInPoints ()
 Gets the width of the page in points. More...
 
Size GetSizeInPixels (float scale, float dpi)
 Calculates the page size in pixels for a specified zoom factor and resolution. More...
 
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 Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 

Additional Inherited Members

- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

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.