SqlDataSource.ConnectionParameters Property

Specifies the data connection settings of the SqlDataSource.

Namespace: DevExpress.DataAccess.Sql

Assembly: DevExpress.DataAccess.v23.2.dll

NuGet Packages: DevExpress.DataAccess, DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap

Declaration

C#

[DefaultValue(null)]
[LocalizableCategory(DataAccessStringId.PropertyGridConnectionCategoryName)]
public DataConnectionParametersBase ConnectionParameters { get; set; }

VB.NET

<DefaultValue(Nothing)>
<LocalizableCategory(DataAccessStringId.PropertyGridConnectionCategoryName)>
Public Property ConnectionParameters As DataConnectionParametersBase

Property Value

Type	Default	Description
DataConnectionParametersBase	null	A DataConnectionParametersBase descendant that specifies the connection parameters of the SqlDataSource.

Remarks

The ConnectionParameters property value is a DataConnectionParametersBase descendant. To establish a data connection, create an object of the type appropriate for the data source. For instance, MS SQL Server requires the MsSqlConnectionParameters type, Oracle DB uses the OracleConnectionParameters type, and an XML file utilizes the XmlFileConnectionParameters type.

When the ConnectionParameters property is specified, the SqlDataSource.ConfigureDataConnection event occurs each time the SqlDataSource connects to a database. Handle this event to change parameters required to establish a data connection (the server name, the database name, user credentials, the path to a data file, etc.).

Tip

In a Reporting application, the IConnectionProviderService interface allows you to specify connections for all SqlDataSource instances available for the XtraReport instance. The IConnectionProviderService.LoadConnection method is called for each connection serialized into the report definition file. Use the SqlDataSource.ConnectionName property to distinguish between connections.

Tip

For more information, review the following article: SqlDataSource - How to change connection parameters at runtime.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ConnectionParameters property.

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-dashboard-bind-geo-point-map-to-data-in-code/CS/Dashboard_CreateGeoPointMap/Form1.cs#L14

CustomSqlQuery sqlQuery = new CustomSqlQuery("Cities", "select * from Cities");
dataSource.ConnectionParameters =
    new Access97ConnectionParameters(@"..\..\Data\Cities.mdb", "", "");

winforms-dasboard-group-filter-elements-and-bind-to-data/CS/Dashboard_FilterElements_and_Groups/Form1.cs#L21

DashboardSqlDataSource dataSource = new DashboardSqlDataSource();
dataSource.ConnectionParameters =
    new XmlFileConnectionParameters(@"..\..\Data\WebsiteStatisticsData.xml");

VB.NET

winforms-dashboard-bind-geo-point-map-to-data-in-code/VB/Dashboard_CreateGeoPointMap/Form1.vb#L16

Dim sqlQuery As New CustomSqlQuery("Cities", "select * from Cities")
dataSource.ConnectionParameters = New Access97ConnectionParameters("..\..\Data\Cities.mdb", "", "")
dataSource.Queries.Add(sqlQuery)

winforms-dasboard-group-filter-elements-and-bind-to-data/VB/Dashboard_FilterElements_and_Groups/Form1.vb#L23

Dim dataSource As New DashboardSqlDataSource()
dataSource.ConnectionParameters = New XmlFileConnectionParameters("..\..\Data\WebsiteStatisticsData.xml")
Dim selectQuery As SelectQuery = SelectQueryFluentBuilder.AddTable("Data").SelectColumns("Browser", "BrowserDetails", "Date", "Count").Build("Statistics")