SqlDataSourceUIHelper.ConfigureConnection(SqlDataSource) Method

Invokes the Connection Editor with the specified settings.

Namespace: DevExpress.DataAccess.UI.Sql

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

NuGet Package: DevExpress.DataAccess.UI

Declaration

C#

public static bool ConfigureConnection(
    this SqlDataSource sqlDataSource
)

VB.NET

<ExtensionAttribute>
Public Shared Function ConfigureConnection(
    sqlDataSource As SqlDataSource
) As Boolean

Parameters

Name	Type	Description
sqlDataSource	SqlDataSource	A SqlDataSource object, specifying the database connection.

Returns

Type	Description
Boolean	true, if the dialog was finished by clicking the Finish button; otherwise, false.

Remarks

The following image illustrates the Connection Editor invoked by calling the ConfigureConnection method.

The Connection Editor allows an end-user to either specify connection parameters manually, or select an existing connection from the list. If the first option is selected, the next page of the dialog becomes available, prompting an end-user to specify the required connection settings.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ConfigureConnection(SqlDataSource) method.

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#

winforms-grid-edit-the-sqldatasource-connection-and-query-at-runtime/CS/T292798/Form1.cs#L22

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