Skip to main content
All docs
V18.2

ASPxClientWebDocumentViewer Members

A client-side equivalent of the ASPxWebDocumentViewer class.

Constructors

Name Description
ASPxClientWebDocumentViewer() Initializes a new instance of the ASPxClientWebDocumentViewer class with the default settings.

Methods

Name Description
Cast(Object) static Converts the specified object to the current object’s type. This method is effective when you utilize the Client API IntelliSense feature provided by DevExpress.
Close() Closes the document which is currently opened in the Web Document Viewer.
DrillThrough(String) Enables navigation between drill-through reports on the client-side.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
ExportTo() Exports the document to a PDF file.
ExportTo(String, Boolean) Exports the document to a specified file format.
ExportTo(String) Exports the document to a specified file format.
GetCurrentPageIndex() Returns the current page’s zero-based index.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetParametersModel() Provide access to the report parameters’ client-side model.
GetPreviewModel() Provides access to the Document Viewer’s client-side model.
GetReportPreview() Provides access to the report preview.
GetType() Gets the Type of the current instance. Inherited from Object.
GoToPage(Int32) Displays the report page with the specified page index.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OpenReport(String) Opens the specified report on the Web Document Viewer’s client side.
PerformCustomDocumentOperation() Performs a custom operation with a currently opened document on the client side.
PerformCustomDocumentOperation(String, Boolean) Performs a custom operation with a currently opened document on the client-side.
PerformCustomDocumentOperation(String) Performs a custom operation with a currently opened document on the client-side.
Print() Prints the current document.
Print(Int32) Prints the document’s page with the specified index.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ResetParameters() Resets the report parameter values to the default values.
StartBuild() Starts building a report document.
ToString() Returns a string that represents the current object. Inherited from Object.
UpdateLocalization(Dictionary<String, String>) Updates the Web Document Viewer properties’ localization settings.

Events

Name Description
BeforeRender Occurs before the Web Document Viewer UI is initialized.
CustomizeElements Allows you to customize the Web Document Viewer’s UI elements.
CustomizeExportOptions Allows you to customize the Web Document Viewer’s available export formats and corresponding export options.
CustomizeLocalization Enables you to customize the Web Document Viewer’s localization strings.
CustomizeMenuActions Enables you to customize the Web Document Viewer’s toolbar commands.
CustomizeParameterEditors Occurs each time a standard editor is created for a report parameter based on a parameter type.
CustomizeParameterLookUpSource Occurs each time a look-up editor is created for a report parameter.
DocumentReady Occurs after the Web Document Viewer loads a report document.
EditingFieldChanged Occurs each time an editing field’s value changes.
OnServerError Occurs on the client each time a server-side error raises.
ParametersReset Occurs after report parameter values are reset to their default values.
ParametersSubmitted Occurs after report parameter values are submitted.
PreviewClick Occurs when the left mouse button is clicked on a report document.
See Also