QueryBuilderExtension Class

Represents an extension object implementing the Query Builder functionality.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc.v18.1.dll

Declaration

C#

public class QueryBuilderExtension :
    ExtensionBase

VB.NET

Public Class QueryBuilderExtension
    Inherits ExtensionBase

Related API Members

The following members accept/return QueryBuilderExtension objects:

• ExtensionsFactory.QueryBuilder(Action<QueryBuilderSettings>)
• ExtensionsFactory.QueryBuilder(QueryBuilderSettings)
• QueryBuilderExtension.Bind(DataConnectionParametersBase)
• QueryBuilderExtension.Bind(DataConnectionParametersBase, SelectQuery)
• QueryBuilderExtension.Bind(DataConnectionParametersBase, SelectQuery, Int32)
• QueryBuilderExtension.Bind(QueryBuilderModel)
• QueryBuilderExtension.Bind(String)
• QueryBuilderExtension.Bind(String, SelectQuery)
• QueryBuilderExtension.Bind(String, SelectQuery, Int32)

Remarks

Use the ExtensionsFactory.QueryBuilder helper method that returns a QueryBuilderExtension object to declare the Query Builder in a required View.

Pass the QueryBuilderSettings object as a helper method’s parameter to configure the Query Builder extension.

Razor

@Html.DevExpress().QueryBuilder(settings => {
    settings.Name = "QueryBuilder";
    settings.RouteValues = new { Controller = "QueryBuilder", Action = "Invoke" };
}).Bind("NorthwindConnection").GetHtml()

See the Query Builder - Getting Started section to learn more about adding the Query Builder to an ASP.NET MVC project.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the QueryBuilderExtension class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

Reporting_how-to-use-the-aspnet-mvc-query-builder-to-provide-data-to-the-gridview-extension-t624853/CS/MvcQueryBuilder/Controllers/QueryBuilderController.cs#L12

public ActionResult Save() {
    var result = QueryBuilderExtension.GetSaveCallbackResult("QueryBuilder");
    Session["SelectCommand"] = result.SelectStatement;

VB.NET

Reporting_how-to-use-the-aspnet-mvc-query-builder-to-provide-data-to-the-gridview-extension-t624853/VB/MvcQueryBuilder/Controllers/QueryBuilderController.vb#L14

Public Function Save() As ActionResult
    Dim result = QueryBuilderExtension.GetSaveCallbackResult("QueryBuilder")
    Session("SelectCommand") = result.SelectStatement

Inheritance

Object

ExtensionBase

QueryBuilderExtension