The client-side equivalent of the ASPxQueryBuilder control.
declare class ASPxClientQueryBuilder extends ASPxClientControlConverts the specified object to the current object's type. This method is effective when you utilize the Client API IntelliSense feature provided by DevExpress.
static Cast(obj: any): ASPxClientQueryBuilder| Name | Type | Description |
|---|---|---|
| obj | any | The client object to be type cast. Represents an instance of a DevExpress web control's client object. |
| Type | Description |
|---|---|
| ASPxClientQueryBuilder | An ASPxClientQueryBuilder object. |
The Cast method is implemented as a part of the JavaScript IntelliSense support for DevExpress ASP.NET controls and MVC extensions. So, using the Cast method is sensible when you intend to use IntelliSense during writing JavaScript code at design time with the help of the DevExpress client API.
A call to the Cast method (which is a static method) casts the specified client object to the ASPxClientQueryBuilder type. As a result, the object's type is now known and ASPxClientQueryBuilder type specific IntelliSense information can be displayed for this client object, facilitating your coding.
The examples of this method application are as follows.
Converting the event source object passed to a client event's handler:
...
<ClientSideEvents Init="function(s, e) {
var clientObject = ASPxClientQueryBuilder.Cast(s);
}" />
Converting a client object accessed by using the value of the ClientInstanceName (or ID) property. For instance, if a web control's ClientInstanceName property is set to 'ASPxClientQueryBuilder1', the object can be type cast in the following manner:
...
var clientObject = ASPxClientQueryBuilder.Cast('ASPxClientQueryBuilder1');
Returns the object model of a Query Builder.
GetDesignerModel(): any| Type | Description |
|---|---|
| any | A Object value. |
Gets a client-side model of the currently opened query serialized to Json.
GetJsonQueryModel(): string| Type | Description |
|---|---|
| string | A string containing a query model. |
Specifies whether or not the current query is a valid SQL string.
IsQueryValid(): boolean| Type | Description |
|---|---|
| boolean | true if the query is valid; otherwise false. |
Sends a callback to the server and generates the server-side event, passing it the specified argument.
PerformCallback(arg: string, onSuccess?: (arg: string) => void): void| Name | Type | Description |
|---|---|---|
| arg | string | A string value that represents any information that needs to be sent to the server-side event. |
| Name | Type | Default | Description |
|---|---|---|---|
| onSuccess | (arg: string) => void | null | A client action to perform if the server round-trip completed successfully. |
Use the PerformCallback method if you need to asynchronously go to the server and perform server-side processing using AJAX-based callback technology. You can pass the required information which can be collected on the client side as a string of arguments using the PerformCallback method args parameter. The onSuccess parameter allows you to specify a client function that should be executed after the server round-trip completed successfully.
Saves the current query.
Save(): voidWhen the Save method is called on the client side, the server-side ASPxQueryBuilder.SaveQuery event occurs allowing you to obtain the resulting query as a SQL query string or a TableQuery object.
Calling the Save method has the same effect as clicking the Save command on the Query Builder toolbar.
Invokes a Previewing Results for the current query.
ShowPreview(): voidUpdates the ASPxClientQueryBuilder properties' localization settings.
UpdateLocalization(localization: { [key: string]: string; }): void| Name | Type | Description |
|---|---|---|
| localization | {[key: string]: string} | A dictionary containing the property names, along with their localized equivalents. |
Occurs before the Query Builder UI is initialized.
BeforeRender: ASPxClientEvent<ASPxClientQueryBuilderBeforeRenderEventHandler<ASPxClientQueryBuilder>>The BeforeRender event handler receives an argument of the ASPxClientQueryBuilderRenderModelEventArgs type.
Handle the BeforeRender event to perform required actions before the Query Builder's UI initialization.
Occurs when a callback for server-side processing is initiated.
BeginCallback: ASPxClientEvent<ASPxClientBeginCallbackEventHandler>The BeginCallback event handler receives an argument of the ASPxClientBeginCallbackEventArgs type. The following properties provide information specific to this event.
| Property | Description |
|---|---|
| command | Gets a command name that identifies which client action forced a callback to occur. |
The BeginCallback and ASPxClientQueryBuilder.EndCallback events can be used to perform specific client-side actions when a callback is being processed on a server.
Fires on the client if any server error occurs during server-side processing of a callback sent by ASPxClientQueryBuilder.
CallbackError: ASPxClientEvent<ASPxClientCallbackErrorEventHandler>The CallbackError event handler receives an argument of the ASPxClientCallbackErrorEventArgs type. The following properties provide information specific to this event.
| Property | Description |
|---|---|
| handled | Gets or sets whether the event is handled and the default error handling actions are not required. |
| message | Gets the error message that describes the server error that occurred. |
The CallbackError event enables you to properly respond to a server error occurring as a result of a callback being processed on the server side. Handle this event to perform specific client-side actions, such as displaying explanatory text or an image related to the error.
Typically, a server error which occurs during server-side processing of a callback, leads to web application hanging, because, in this case, no proper response is generated for a control that initiated the callback. However, AJAX-enabled web controls from the DevExpress product line are able to automatically catch server errors occurring within handlers of their server-side events, and to pass the related error information to the client for further processing through the CallbackError event's argument.
To learn more, see the Handling Callback Exceptions on Client topic.
Enables you to customize the Query Builder's localization strings.
CustomizeLocalization: ASPxClientEvent<ASPxClientQueryBuilderCustomizeLocalizationEventHandler<ASPxClientQueryBuilder>>The CustomizeLocalization event handler receives an argument of the ASPxClientEventArgs type.
Use the client-side ASPxClientQueryBuilder.UpdateLocalization method in the CustomizeLocalization event to manually substitute particular localization strings with custom ones.
Enables you to customize the menu actions of a Query Builder.
CustomizeToolbarActions: ASPxClientEvent<ASPxClientQueryBuilderCustomizeToolbarActionsEventHandler<ASPxClientQueryBuilder>>The CustomizeToolbarActions event handler receives an argument of the ASPxClientCustomizeMenuActionsEventArgs type. The following properties provide information specific to this event.
| Property | Description |
|---|---|
| Actions | Provides access to the collection of actions available in the toolbar and menu. |
Occurs on the client after a callback's server-side processing has been completed.
EndCallback: ASPxClientEvent<ASPxClientEndCallbackEventHandler>The EndCallback event handler receives an argument of the ASPxClientEndCallbackEventArgs type. The following properties provide information specific to this event.
| Property | Description |
|---|---|
| command | Gets a command name that identifies which client action forced a callback to occur. |
The ASPxClientQueryBuilder.BeginCallback and EndCallback events can be used to perform specific client-side actions when a callback is being processed on a server.
Occurs on the client each time a server-side error raises.
OnServerError: ASPxClientEvent<ASPxClientQueryBuilderErrorEventHandler<ASPxClientQueryBuilder>>The OnServerError event handler receives an argument of the ASPxClientErrorEventArgs type. The following properties provide information specific to this event.
| Property | Description |
|---|---|
| Error | Provides access to information about a server-side error. |
Handle the OnServerError event to perform actions when an Ajax request completes with an error.
The following code snippet demonstrates how to show an alert box when any internal server error occurs.
<script type="text/javascript" id="script">
function onError(s, e) {
alert("Internal Server Error occurs");
}
</script>
<dx:ASPxQueryBuilder ID="ASPxQueryBuilder1" runat="server">
<ClientSideEvents OnServerError="onError"/>
</dx:ASPxQueryBuilder>
Occurs when executing the Save command on the client.
SaveCommandExecute: ASPxClientEvent<ASPxClientQueryBuilderSaveCommandExecuteEventHandler<ASPxClientQueryBuilder>>The SaveCommandExecute event handler receives an argument of the ASPxClientQueryBuilderSaveCommandExecuteEventArgs type. The following properties provide information specific to this event.
| Property | Description |
|---|---|
| handled | Specifies whether or not the event was handled. |