SqlDataSourceUIHelper Class

Provides functionality to configure the connection to a SqlDataSource in code.

Namespace: DevExpress.DataAccess.UI.Sql

Assembly: DevExpress.DataAccess.v18.1.UI.dll

Declaration

C#

public static class SqlDataSourceUIHelper

VB.NET

Public Module SqlDataSourceUIHelper

Remarks

The SqlDataSourceUIHelper provides an application programming interface (API) to invoke various tools available to end-users for configuring the data connection settings in an application.

• To manage the data connection settings without writing any code, use the Query Builder of a SqlDataSource component.

  After a SQL Data Source is created, you can configure it by using the commands available in its smart tag.

  

• To configure a data connection in code, use the extension methods of the SqlDataSourceUIHelper class (requires referencing the DevExpress.DataAccess.v18.1.UI.dll assembly for an application).

  For example, after adding two or more queries to a data connection, it becomes possible to configure their data relations by using the Master-Detail Relations Editor (invoked by calling the SqlDataSourceUIHelper.ManageRelations method of the SqlDataSourceUIHelper class).

  

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SqlDataSourceUIHelper 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#

how-to-edit-the-sqldatasource-connection-and-query-at-runtime-via-wizard-by-using-the-sqld-t292798/CS/T292798/Form1.cs#L22

private void btConfigureConnection_Click(object sender, EventArgs e) {
    SqlDataSourceUIHelper.ConfigureConnection(sqlDataSource1);
}

VB.NET

how-to-edit-the-sqldatasource-connection-and-query-at-runtime-via-wizard-by-using-the-sqld-t292798/VB/T292798/Form1.vb#L24

Private Sub btConfigureConnection_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btConfigureConnection.Click
    SqlDataSourceUIHelper.ConfigureConnection(sqlDataSource1)
End Sub

Inheritance

Object

SqlDataSourceUIHelper