Back to Devexpress

ASPxClientReportViewerPageLoadEventArgs Class

xtrareports-js-aspxclientreportviewerpageloadeventargs.md

latest3.2 KB
Original Source

ASPxClientReportViewerPageLoadEventArgs Class

Provides data for the ASPxClientReportViewer.PageLoad and ASPxClientDocumentViewer.PageLoad events on the client side.

Declaration

ts
declare class ASPxClientReportViewerPageLoadEventArgs extends ASPxClientEventArgs

Remarks

ASPxClientReportViewerPageLoadEventArgs objects with proper settings are automatically created and passed to the corresponding event handlers.

Inheritance

ASPxClientEventArgs ASPxClientReportViewerPageLoadEventArgs

constructor(pageIndex, pageCount)

Initializes a new instance of the ASPxClientReportViewerPageLoadEventArgs class with the specified settings.

Declaration

ts
constructor(
    pageIndex: number,
    pageCount: number
)

Parameters

NameTypeDescription
pageIndexnumber

An integer value which specifies a zero-based index of a page to be displayed in a report viewer. This value is assigned to the ASPxClientReportViewerPageLoadEventArgs.PageIndex field.

| | pageCount | number |

An integer value which specifies the total number of pages displayed in a report viewer. This value is assigned to the ASPxClientReportViewerPageLoadEventArgs.PageCount field.

|

Remarks

Instances of the ASPxClientReportViewerPageLoadEventArgs class are automatically created, initialized and passed to the corresponding event handlers.

Properties

PageCount Property

Gets a value specifying the total number of pages displayed in a report viewer.

Declaration

ts
PageCount: number

Property Value

Type
number

PageIndex Property

Gets a value specifying a zero-based index of a page to be displayed in a report viewer.

Declaration

ts
PageIndex: number

Property Value

Type
number

Methods

IsFirstPage Method

Gets a value indicating whether a report page, which is currently loaded into the ASPxClientReportViewer, is the first page of a report.

Declaration

ts
IsFirstPage(): boolean

Returns

TypeDescription
boolean

true if the loaded page is first; otherwise, false.

|

See Also

IsLastPage

IsLastPage Method

Gets a value indicating whether a report page, which is currently loaded into the ASPxClientReportViewer, is the last page of a report.

Declaration

ts
IsLastPage(): boolean

Returns

TypeDescription
boolean

true if the loaded page is last; otherwise, false.

|

See Also

IsFirstPage