Back to Devexpress

ASPxClientWebDocumentViewerDocumentReadyEventArgs Class

xtrareports-js-aspxclientwebdocumentviewerdocumentreadyeventargs.md

latest2.5 KB
Original Source

ASPxClientWebDocumentViewerDocumentReadyEventArgs Class

Provides data for the ASPxClientWebDocumentViewer.DocumentReady and ASPxClientReportDesigner.PreviewDocumentReady events.

Declaration

ts
declare class ASPxClientWebDocumentViewerDocumentReadyEventArgs extends ASPxClientEventArgs

Remarks

ASPxClientWebDocumentViewerDocumentReadyEventArgs objects are automatically created, initialized and passed to corresponding event handlers.

Inheritance

ASPxClientEventArgs ASPxClientWebDocumentViewerDocumentReadyEventArgs

constructor(documentId, reportId, pageCount)

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

Declaration

ts
constructor(
    documentId: string,
    reportId: string,
    pageCount: number
)

Parameters

NameTypeDescription
documentIdstring

A string that specifies the report document ID. This value is assigned to the ASPxClientWebDocumentViewerDocumentReadyEventArgs.DocumentId field.

| | reportId | string |

A string that specifies the report ID. This value is assigned to the ASPxClientWebDocumentViewerDocumentReadyEventArgs.ReportId field.

| | pageCount | number |

An integer value that specifies the total number of pages in a report document. This value is assigned to the ASPxClientWebDocumentViewerDocumentReadyEventArgs.PageCount field.

|

Properties

DocumentId Property

Specifies the report document ID.

Declaration

ts
DocumentId: string

Property Value

Type
string

PageCount Property

Specifies the total number of pages in a report document.

Declaration

ts
PageCount: number

Property Value

Type
number

ReportId Property

Specifies the report ID.

Declaration

ts
ReportId: string

Property Value

Type
string