Skip to main content
All docs
V18.2

ASPxClientReportDesigner Members

The client-side equivalent of the Web Report Designer control.

Constructors

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

Methods

Name Description
AddParameterType(ASPxDesignerParameterType, ASPxDesignerEditorOptions) Adds a custom parameter type to the Web End-User Report Designer.
AddToPropertyGrid(String, ASPxDesignerElementSerializationInfo) Adds a custom property to the Properties Panel.
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.
CloseCurrentTab() Closes the report tab currently being opened in the Web Report Designer.
CloseTab(ASPxDesignerNavigateTab, Boolean) Closes the specified report tab avaialble the Web Report Designer silently or with the Save Report dialog.
CloseTab(ASPxDesignerNavigateTab) Closes the specified report tab available in the Web Report Designer.
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.
GetButtonStorage() Returns actions performed by buttons available in the menu and toolbar of the Web Report Designer.
GetCurrentTab() Returns the currently active tab in the Web Report Designer.
GetDesignerModel() Provides access to a client-side model of a Web Report Designer.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetJsonReportModel() Gets a client-side model of the currently opened report serialized to Json.
GetParameterEditor(String) Returns a value editor associated with the specified parameter type.
GetParameterInfo(String) Returns an object that contains information on the specified parameter type.
GetPreviewModel() Provides access to the Document Viewer’s client-side model.
GetPropertyInfo(String, String) Returns information about the specified property of the specified control.
GetPropertyInfo(String, String[]) Returns information about the specified properties of the specified control.
GetTabs() Returns all available Report Designer tabs.
GetType() Gets the Type of the current instance. Inherited from Object.
IsModified() Indicates whether or not the current ASPxClientReportDesigner instance has been modified.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
OpenReport(String) Opens the specified report on the Web Report Designer’s client side.
PerformCallback(String, Action<String>) Sends a callback to the server and generates the server-side event, passing it the specified argument.
PerformCallback(String) Sends a callback to the server with the specified argument.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveParameterType(String) Removes the specified parameter type from the Web End-User Report Designer.
ReportStorageGetData(String) Returns the report layout stored in a report storage under the specified URL.
ReportStorageGetUrls() Returns the report URLs and display names existing in a report storage.
ReportStorageSetData(String, String) Stores the specified report to a report storage using the specified URL.
ReportStorageSetNewData(String, String) Stores the specified report to a report storage using a new URL.
ResetIsModified() Resets the value returned by the ASPxClientReportDesigner.IsModified method.
SaveNewReport(String) Saves the current report under a new name.
SaveReport() Saves the current report.
ShowPreview() Switches the Web Report Designer to the preview mode.
ToString() Returns a string that represents the current object. Inherited from Object.
UpdateLocalization(Dictionary<String, String>) Updates the Report Designer properties’ localization settings.

Events

Name Description
BeforeRender Occurs before the Web Report Designer UI is initialized.
BeginCallback Occurs when a callback for server-side processing is initiated.
CallbackError Fires on the client if any server error occurs during server-side processing of a callback sent by ASPxClientReportDesigner.
ComponentAdded Occurs after a component has been added to the report currently being edited in the Web Report Designer.
CustomizeElements Enables you to customize the Web Report Designer’s UI elements.
CustomizeFieldListActions Enables you to customize actions available in the Web Report Designer’s Field List.
CustomizeLocalization Enables you to customize the Web Report Designer’s localization strings.
CustomizeMenuActions Enables you to customize the Web Report Designer’s toolbar commands.
CustomizeOpenDialog Enables you to customize the Open Report dialog of the Web Report Designer.
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.
CustomizeSaveAsDialog Enables you to customize the Save Report dialog of the Web Report Designer.
CustomizeSaveDialog Enables you to customize the Save dialog of the Web Report Designer.
CustomizeToolbox Enables you to customize the Web Report Designer’s available controls.
EndCallback Occurs on the client after a callback’s server-side processing has been completed.
ExitDesigner Occurs on the client side when the Report Designer is being closed.
OnServerError Occurs on the client each time a server-side error raises.
PreviewClick Occurs when the left mouse button is clicked on a report document in Print Preview.
PreviewCustomizeElements Enables you to customize UI elements of a Document Viewer built into a Web Report Designer.
PreviewCustomizeExportOptions Allows you to customize available export formats and corresponding export options in a Document Viewer built into a Web Report Designer.
PreviewCustomizeMenuActions Enables you to customize the actions of a Document Viewer built into a Web Report Designer.
PreviewDocumentReady Occurs after a report has been switched to Print Preview.
PreviewEditingFieldChanged Occurs each time an editing field’s value changes in Print Preview.
PreviewParametersReset Occurs after report parameter values are reset to their default values in Print Preview.
PreviewParametersSubmitted Occurs after report parameter values are submitted in Print Preview.
ReportOpened Occurs when a report has been opened in the Web Report Designer.
ReportOpening Occurs when a report is about to be opened in the Web Report Designer.
ReportSaved Occurs when a report has been saved in the Web Report Designer.
ReportSaving Occurs when a report is about to be saved in the Web Report Designer.
ReportTabClosed Occurs when a report tab was closed in the Web Report Designer.
ReportTabClosing Occurs when a report tab is about to be closed in the Web Report Designer.
SaveCommandExecute Occurs when executing the Save command on the client.
TabChanged Occurs when an active report tab was changed in the Web Report Designer.
See Also