CustomStringConnectionParameters.ConnectionString Property

Gets or sets a connection string.

Namespace: DevExpress.DataAccess.ConnectionParameters

Assembly: DevExpress.DataAccess.v23.2.dll

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

Declaration

C#

public string ConnectionString { get; set; }

VB.NET

Public Property ConnectionString As String

Property Value

Type	Description
String	A String that contains connection parameters.

Remarks

Use the ConnectionString property in the following cases:

• To pass additional parameters which are not exposed by the appropriate DataConnectionParametersBase descendant.
• To specify a connection string to a cube in an MS Analysis Services database.

To learn how to build connection strings for different data providers, see the following help topic: How To Create a Correct Connection String.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ConnectionString 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#

WebFormsDashboardConfigurator/CS/WebFormsDashboardConfigurator/Global.asax.cs#L39

OlapConnectionParameters olapParams = new OlapConnectionParameters();
olapParams.ConnectionString = "Provider=MSOLAP;Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;"
    + "Initial catalog=Adventure Works DW Standard Edition;Cube name=Adventure Works;Query Timeout=100;";

how-to-bind-dashboard-to-sql-server-database-file/CS/BindToMsSqlDatabaseFileExample/Form1.cs#L28

CustomStringConnectionParameters connectionParameters = new CustomStringConnectionParameters();
connectionParameters.ConnectionString =
    @"XpoProvider=MSSqlServer;Data Source=(LocalDB)\MSSQLLocalDB;" +

asp-net-web-forms-dashboard-register-data-sources/CS/WebFormsDashboardDataSources/Pages/OlapDashboard.aspx.cs#L32

OlapConnectionParameters olapParams = new OlapConnectionParameters();
olapParams.ConnectionString = "Provider=MSOLAP;Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;"
    + "Initial catalog=Adventure Works DW Standard Edition;Cube name=Adventure Works;Query Timeout=100;";

asp-net-mvc-dashboard-register-data-sources/CS/MvcDashboardDataSources/Configuration/OlapDataSourceConfigurator.cs#L19

OlapConnectionParameters olapParams = new OlapConnectionParameters();
olapParams.ConnectionString = "Provider=MSOLAP;Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;"
    + "Initial catalog=Adventure Works DW Standard Edition;Cube name=Adventure Works;Query Timeout=100;";

wpf-dashboard-how-to-bind-to-sql-database-file/CS/WpfDashboard_SqlDataSource/MainWindow.xaml.cs#L63

if (e.DataSourceName == "MySqlDataSource")
    parameters.ConnectionString =
        @"XpoProvider=MSSqlServer;Data Source=(LocalDB)\MSSQLLocalDB;AttachDbFilename=|DataDirectory|\NWind.mdf;Integrated Security=True";

VB.NET

WebFormsDashboardConfigurator/VB/WebFormsDashboardConfigurator/Global.asax.vb#L41

Dim olapParams As New OlapConnectionParameters()
olapParams.ConnectionString = "Provider=MSOLAP;Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;" & "Initial catalog=Adventure Works DW Standard Edition;Cube name=Adventure Works;Query Timeout=100;"
e.ConnectionParameters = olapParams

how-to-bind-dashboard-to-sql-server-database-file/VB/BindToMsSqlDatabaseFileExample/Form1.vb#L30

Dim connectionParameters As New CustomStringConnectionParameters()
connectionParameters.ConnectionString = "XpoProvider=MSSqlServer;Data Source=(LocalDB)\MSSQLLocalDB;" & "AttachDbFilename=|DataDirectory|\NW19.mdf;" & "Integrated Security=True"
Dim sqlDataSource As New DashboardSqlDataSource("NW19 SQL Server Database File", connectionParameters)

asp-net-web-forms-dashboard-register-data-sources/VB/WebFormsDashboardDataSources/Pages/OlapDashboard.aspx.vb#L30

Dim olapParams As OlapConnectionParameters = New OlapConnectionParameters()
olapParams.ConnectionString = "Provider=MSOLAP;Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;" & "Initial catalog=Adventure Works DW Standard Edition;Cube name=Adventure Works;Query Timeout=100;"
e.ConnectionParameters = olapParams

asp-net-mvc-dashboard-register-data-sources/VB/MvcDashboardDataSources/Configuration/OlapDataSourceConfigurator.vb#L19

Dim olapParams As New OlapConnectionParameters()
olapParams.ConnectionString = "Provider=MSOLAP;Data Source=http://demos.devexpress.com/Services/OLAP/msmdpump.dll;" & "Initial catalog=Adventure Works DW Standard Edition;Cube name=Adventure Works;Query Timeout=100;"
e.ConnectionParameters = olapParams

wpf-dashboard-how-to-bind-to-sql-database-file/VB/WpfDashboard_SqlDataSource/MainWindow.xaml.vb#L53

    Dim parameters As CustomStringConnectionParameters = TryCast(e.ConnectionParameters, CustomStringConnectionParameters)
    If Equals(e.DataSourceName, "MySqlDataSource") Then parameters.ConnectionString = "XpoProvider=MSSqlServer;Data Source=(LocalDB)\MSSQLLocalDB;AttachDbFilename=|DataDirectory|\NWind.mdf;Integrated Security=True"
End Sub