Aspose::Email::Clients::PageInfo Class Reference

Contains information about retrieved page when paging methods are used. More...

Inherits Object.

Inherited by Aspose::Email::Clients::Exchange::AppointmentPageInfo, Aspose::Email::Clients::Exchange::ExchangeFolderPageInfo, Aspose::Email::Clients::Exchange::ExchangeMessagePageInfo, and Aspose::Email::Clients::Imap::ImapPageInfo.

Public Member Functions
ASPOSE_EMAIL_SHARED_API int32_t	get_PageOffset () const
	Gets offset of a page More...
ASPOSE_EMAIL_SHARED_API void	set_PageOffset (int32_t value)
	Gets offset of a page More...
ASPOSE_EMAIL_SHARED_API int32_t	get_AbsoluteOffset () const
	Gets additinal offset added to start index of a page More...
ASPOSE_EMAIL_SHARED_API void	set_AbsoluteOffset (int32_t value)
	Gets additinal offset added to start index of a page More...
ASPOSE_EMAIL_SHARED_API bool	get_LastPage () const
	Indicates whether current page is last page in view. More...
ASPOSE_EMAIL_SHARED_API void	set_LastPage (bool value)
	Indicates whether current page is last page in view. More...
ASPOSE_EMAIL_SHARED_API int32_t	get_TotalCount () const
	Gets total count of items in view More...
ASPOSE_EMAIL_SHARED_API void	set_TotalCount (int32_t value)
	Gets total count of items in view More...
ASPOSE_EMAIL_SHARED_API int32_t	get_ItemsPerPage () const
	A number of items in page More...
ASPOSE_EMAIL_SHARED_API void	set_ItemsPerPage (int32_t value)
	A number of items in page More...
virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr< PageInfo >	get_NextPage ()
	Information of the next page or null if current page is last More...
ASPOSE_EMAIL_SHARED_API	PageInfo (int32_t itemsPerPage)
	Initializes a new instance of the PageInfo class More...
ASPOSE_EMAIL_SHARED_API	PageInfo (int32_t itemsPerPage, int32_t offset)
	Initializes a new instance of the PageInfo class More...
ASPOSE_EMAIL_SHARED_API	PageInfo (int32_t totalCount, int32_t itemsPerPage, int32_t offset, bool lastPage)
	Initializes a new instance of the PageInfo class More...
ASPOSE_EMAIL_SHARED_API	PageInfo (int32_t totalCount, int32_t itemsPerPage, int32_t offset, int32_t absoluteOffset, bool lastPage)
	Initializes a new instance of the PageInfo class More...

Protected Attributes
System::SharedPtr< PageInfo >	next

Detailed Description

Contains information about retrieved page when paging methods are used.

Constructor & Destructor Documentation

PageInfo() [1/4]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::PageInfo::PageInfo

(

int32_t

itemsPerPage

)

Initializes a new instance of the PageInfo class

Parameters

itemsPerPage

A number of items in page

PageInfo() [2/4]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::PageInfo::PageInfo	(	int32_t	itemsPerPage,
		int32_t	offset
	)

Initializes a new instance of the PageInfo class

Parameters

itemsPerPage	A number of items in page
offset	offset in view of a page

PageInfo() [3/4]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::PageInfo::PageInfo	(	int32_t	totalCount,
		int32_t	itemsPerPage,
		int32_t	offset,
		bool	lastPage
	)

Initializes a new instance of the PageInfo class

Parameters

totalCount	total count of items in view
itemsPerPage	A number of items in page
offset	offset in view of a page
lastPage	Indicates whether current page is last page in view

PageInfo() [4/4]

ASPOSE_EMAIL_SHARED_API Aspose::Email::Clients::PageInfo::PageInfo	(	int32_t	totalCount,
		int32_t	itemsPerPage,
		int32_t	offset,
		int32_t	absoluteOffset,
		bool	lastPage
	)

Initializes a new instance of the PageInfo class

Parameters

totalCount	total count of items in view
offset	offset in view of a page

///

Parameters

absoluteOffset	additinal offset added to start index of a page
lastPage	Indicates whether current page is last page in view
itemsPerPage	A number of items in page

Member Function Documentation

get_AbsoluteOffset()

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::PageInfo::get_AbsoluteOffset

(

)

const

Gets additinal offset added to start index of a page

get_ItemsPerPage()

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::PageInfo::get_ItemsPerPage

(

)

const

A number of items in page

get_LastPage()

ASPOSE_EMAIL_SHARED_API bool Aspose::Email::Clients::PageInfo::get_LastPage

(

)

const

Indicates whether current page is last page in view.

get_NextPage()

virtual ASPOSE_EMAIL_SHARED_API System::SharedPtr<PageInfo> Aspose::Email::Clients::PageInfo::get_NextPage ( )

virtual

Information of the next page or null if current page is last

Reimplemented in Aspose::Email::Clients::Imap::ImapPageInfo, Aspose::Email::Clients::Exchange::AppointmentPageInfo, Aspose::Email::Clients::Exchange::ExchangeFolderPageInfo, and Aspose::Email::Clients::Exchange::ExchangeMessagePageInfo.

get_PageOffset()

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::PageInfo::get_PageOffset

(

)

const

Gets offset of a page

get_TotalCount()

ASPOSE_EMAIL_SHARED_API int32_t Aspose::Email::Clients::PageInfo::get_TotalCount

(

)

const

Gets total count of items in view

set_AbsoluteOffset()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::PageInfo::set_AbsoluteOffset

(

int32_t

value

)

Gets additinal offset added to start index of a page

set_ItemsPerPage()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::PageInfo::set_ItemsPerPage

(

int32_t

value

)

A number of items in page

set_LastPage()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::PageInfo::set_LastPage

(

bool

value

)

Indicates whether current page is last page in view.

set_PageOffset()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::PageInfo::set_PageOffset

(

int32_t

value

)

Gets offset of a page

set_TotalCount()

ASPOSE_EMAIL_SHARED_API void Aspose::Email::Clients::PageInfo::set_TotalCount

(

int32_t

value

)

Gets total count of items in view

Member Data Documentation

next

System::SharedPtr<PageInfo> Aspose::Email::Clients::PageInfo::next

protected