CustomSqlQuery Class

A custom query.

Namespace: DevExpress.DataAccess.Sql

Assembly: DevExpress.DataAccess.v17.2.dll

Declaration

C#

public sealed class CustomSqlQuery :
    SqlQuery

VB.NET

Public NotInheritable Class CustomSqlQuery
    Inherits SqlQuery

Related API Members

The following members accept/return CustomSqlQuery objects:

Library	Related API Members
Cross-Platform Class Library	ValidateCustomSqlQueryEventArgs.CustomSqlQuery
Dashboard	ValidateDashboardCustomSqlQueryEventArgs.CustomSqlQuery
	ValidateDashboardCustomSqlQueryWebEventArgs.CustomSqlQuery

Remarks

The code sample below demonstrates how to create a CustomSqlQuery that selects all the elements of all the rows of a table.

C#

using DevExpress.DataAccess;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
// ...

private SqlDataSource BindToData() {
    // Create a data source with the required connection parameters.   
    Access97ConnectionParameters connectionParameters =
    new Access97ConnectionParameters("../../Data/nwind.mdb", "", "");
    SqlDataSource ds = new SqlDataSource(connectionParameters);

    // Create an SQL query to access the Products table.
    CustomSqlQuery query = new CustomSqlQuery();
    query.Name = "customQuery1";
    query.Sql = "SELECT * FROM Products";

    ds.Queries.Add(query);
    return ds;
}

VB.NET

Imports DevExpress.DataAccess
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
' ...

Private Function BindToData() As SqlDataSource
    ' Create a data source with the required connection parameters.   
    Dim connectionParameters As New Access97ConnectionParameters("../../Data/nwind.mdb", "", "")
    Dim ds As New SqlDataSource(connectionParameters)

    ' Create an SQL query to access the Products table.
    Dim query As New CustomSqlQuery()
    query.Name = "customQuery1"
    query.Sql = "SELECT * FROM Products"

    ds.Queries.Add(query)
    Return ds
End Function

Note

Any parameters passed to a CustomSqlQuery should not be multi-value parameters.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CustomSqlQuery 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_wpf-end-user-report-designer-how-to-create-a-custom-data-source-wizard-t286514/CS/Custom Wizard/Data Wrapper Classes/QueryWrapper.cs#L20

}
public CustomSqlQuery CreateCustomSqlQuery() {
    return new CustomSqlQuery(Name, Sql);

Reporting_how-to-dynamically-generate-a-report-in-a-wpf-application-t356256/CS/RuntimeReportsApplication/MainWindow.xaml.cs#L50

// Create an SQL query to access the master table.
CustomSqlQuery queryCategories = new CustomSqlQuery();
queryCategories.Name = "queryCategories";

Reporting_documentpreviewcontrol-how-to-create-a-drill-down-report-runtime-sample-t337482/CS/dxWPFApp/MainWindow.xaml.cs#L129

SqlDataSource ds = new SqlDataSource(new Access2007ConnectionParameters(@"..\..\App_Data\nwind.mdb", ""));
ds.Queries.Add(new CustomSqlQuery("Categories", "select * from Categories"));
ds.RebuildResultSchema();

Reporting_how-to-programmatically-bind-a-report-to-an-mdb-file-using-a-customsqlquery-e1357/CS/RuntimeBindingToMdbDatabase/Form1.cs#L26

// Create an SQL query to access the Products table.
CustomSqlQuery query = new CustomSqlQuery();
query.Name = "customQuery";

how-to-configure-the-sql-data-access-component-in-code-to-bind-the-gridcontrol-to-a-databa-t190498/CS/dxSample/Form1.cs#L43

SqlDataSource ds = new SqlDataSource(connectionParameters);
CustomSqlQuery query = new CustomSqlQuery();
query.Name = "customQuery1";

VB.NET

Reporting_wpf-end-user-report-designer-how-to-create-a-custom-data-source-wizard-t286514/VB/Custom Wizard/Data Wrapper Classes/QueryWrapper.vb#L24

End Sub
Public Function CreateCustomSqlQuery() As CustomSqlQuery
    Return New CustomSqlQuery(Name, Sql)

Reporting_how-to-dynamically-generate-a-report-in-a-wpf-application-t356256/VB/RuntimeReportsApplication/MainWindow.xaml.vb#L52

' Create an SQL query to access the master table.
Dim queryCategories As New CustomSqlQuery()
queryCategories.Name = "queryCategories"

how-to-pass-a-dashboard-parameter-to-a-custom-sql-query-in-code-e5120/VB/Dashboard_ParametersAndCustomSQL/Form1.vb#L25

    CType(dashboard.DataSources(0), DashboardSqlDataSource)
Dim salesPersonQuery As CustomSqlQuery =
    CType(dataSource.Queries(0), CustomSqlQuery)

Reporting_documentpreviewcontrol-how-to-create-a-drill-down-report-runtime-sample-t337482/VB/dxWPFApp/MainWindow.xaml.vb#L132

Dim ds As New SqlDataSource(New Access2007ConnectionParameters("..\..\App_Data\nwind.mdb", ""))
ds.Queries.Add(New CustomSqlQuery("Categories", "select * from Categories"))
ds.RebuildResultSchema()

Reporting_how-to-programmatically-bind-a-report-to-an-mdb-file-using-a-customsqlquery-e1357/VB/RuntimeBindingToMdbDatabase/Form1.vb#L27

' Create an SQL query to access the Products table.
Dim query As New CustomSqlQuery()
query.Name = "customQuery"

Inheritance

Object

SqlQuery

CustomSqlQuery

Extension Methods

Show 20 items

EditQuery()

EditQuery(IRepositoryItemsProvider)

EditQuery(UserLookAndFeel)

EditQuery(UserLookAndFeel, IRepositoryItemsProvider)

EditQuery(UserLookAndFeel, IWin32Window)

EditQuery(UserLookAndFeel, IWin32Window, IRepositoryItemsProvider)

EditQuery(UserLookAndFeel, IWin32Window, IDBSchemaProvider)

EditQuery(UserLookAndFeel, IWin32Window, IDBSchemaProvider, IRepositoryItemsProvider)

EditQuery(UserLookAndFeel, IWin32Window, IDBSchemaProvider, IParameterService)

EditQuery<TModel>(UserLookAndFeel, IWin32Window, IDBSchemaProvider, IParameterService, Action<IWizardCustomization<TModel>>)

EditQuery<TModel>(UserLookAndFeel, IWin32Window, IDBSchemaProvider, IParameterService, Action<IWizardCustomization<TModel>>, IServiceProvider)

EditQuery(UserLookAndFeel, IWin32Window, IDBSchemaProvider, IParameterService, IRepositoryItemsProvider)

EditQuery<TModel>(UserLookAndFeel, IWin32Window, IDBSchemaProvider, IParameterService, IRepositoryItemsProvider, Action<IWizardCustomization<TModel>>)

EditQuery<TModel>(UserLookAndFeel, IWin32Window, IDBSchemaProvider, IParameterService, IRepositoryItemsProvider, Action<IWizardCustomization<TModel>>, IServiceProvider)

EditQuery<TModel>(UserLookAndFeel, IWin32Window, IDBSchemaProvider, IParameterService, IRepositoryItemsProvider, Action<IWizardCustomization<TModel>>, IServiceProvider, ICustomQueryValidator)

EditQuery(EditQueryContext)

EditQuery<TModel>(EditQueryContext, Action<IWizardCustomization<TModel>>)

EditQueryWithQueryBuilder()

EditQueryWithQueryBuilder(QueryBuilderEditQueryContext)

EditQueryWithQueryBuilder(QueryBuilderEditQueryContext, QueryBuilderRunnerDelegate)