CustomStringConnectionParameters Class

Contains a connection string.

Namespace: DevExpress.DataAccess.ConnectionParameters

Assembly: DevExpress.DataAccess.v18.1.dll

Declaration

C#

public class CustomStringConnectionParameters :
    DataConnectionParametersBase,
    IConnectionPage

VB.NET

Public Class CustomStringConnectionParameters
    Inherits DataConnectionParametersBase
    Implements IConnectionPage

Remarks

The CustomStringConnectionParameters class instances provide a connection string (CustomStringConnectionParameters.ConnectionString) that allows you to establish a connection to any supported database server or file type with custom parameters. Typically, you will need to do this in order to pass additional parameters that are not exposed by the appropriate DataConnectionParametersBase descendant.

To learn how to build connection strings for different data providers, see the following KB article: How to create a correct connection string for XPO providers..

To learn more about the use of classes that provide data connection parameters, see DataConnectionParametersBase.

Related GitHub Examples

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

winforms-end-user-designer-how-to-customize-the-data-source-wizard-connection-string-stora-t119350/CS/T119350/CustomConnectionStorageService.cs#L132

    result.Add(new CustomSqlDataConnection(node["Name"].InnerText,
        new CustomStringConnectionParameters(node["ConnectionString"].InnerText)));
return result;

Reporting_wpf-end-user-report-designer-how-to-create-a-custom-data-source-wizard-t286514/CS/Custom Wizard/WizardDataModel.cs#L234

private void AddInvalidConnection() {
    ConnectionWrapper cw = InitConnection("InvalidConnection", new CustomStringConnectionParameters("invalidConnection"));
}

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

{
    CustomStringConnectionParameters parameters = e.ConnectionParameters as CustomStringConnectionParameters;
    if (e.DataSourceName == "MySqlDataSource")

VB.NET

winforms-end-user-designer-how-to-customize-the-data-source-wizard-connection-string-stora-t119350/VB/T119350/CustomConnectionStorageService.vb#L127

For Each node As XmlNode In doc.SelectNodes("Connections/Connection[Name][ConnectionString]")
    result.Add(New CustomSqlDataConnection(node("Name").InnerText, New CustomStringConnectionParameters(node("ConnectionString").InnerText)))
Next node

Reporting_wpf-end-user-report-designer-how-to-create-a-custom-data-source-wizard-t286514/VB/Custom Wizard/WizardDataModel.vb#L213

Private Sub AddInvalidConnection()
    Dim cw As ConnectionWrapper = InitConnection("InvalidConnection", New CustomStringConnectionParameters("invalidConnection"))
End Sub

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

Private Sub dashboardControl1_ConfigureDataConnection(ByVal sender As Object, ByVal e As DashboardConfigureDataConnectionEventArgs)
    Dim parameters As CustomStringConnectionParameters = TryCast(e.ConnectionParameters, CustomStringConnectionParameters)
    If e.DataSourceName = "MySqlDataSource" Then

Inheritance

Object

DataConnectionParametersBase

CustomStringConnectionParameters

OlapConnectionParameters