ASPxClientReportViewerPageLoadEventArgs Class

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

Declaration

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

constructor(
    pageIndex: number,
    pageCount: number
)

Parameters

Name	Type	Description
pageIndex	number	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

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

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

IsFirstPage(): boolean

Returns

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

Remarks

The IsFirstPage method may be useful to determine the Enabled state of the ReportToolbarItemKind.FirstPage and ReportToolbarItemKind.PreviousPage buttons, when implementing a custom Report Toolbar.

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

IsLastPage(): boolean

Returns

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

Remarks

The IsLastPage method may be useful to determine the Enabled state of the ReportToolbarItemKind.LastPage and ReportToolbarItemKind.NextPage buttons, when implementing a custom Report Toolbar.