ConfigureDataConnectionEventArgs.ConnectionParameters Property

Gets or sets parameters used to establish a connection to data.

Namespace: DevExpress.DataAccess.Sql

Assembly: DevExpress.DataAccess.v18.2.dll

Declaration

C#

public DataConnectionParametersBase ConnectionParameters { get; set; }

VB.NET

Public Property ConnectionParameters As DataConnectionParametersBase

Property Value

Type	Description
DataConnectionParametersBase	A DataConnectionParametersBase descendant that contains parameters used to establish a connection to data.

Remarks

The ConnectionParameters property specifies a DataConnectionParametersBase descendant that provides parameters required to establish a connection to data (for instance, the server name, the database name, user credentials, the path to a data file, etc).

Different DataConnectionParametersBase descendants provide connection parameters for different DBMS and data file formats. For instance, MsSqlConnectionParameters, OracleConnectionParameters, XmlFileConnectionParameters and many other classes are available.

To edit the current connection parameters, cast the returned DataConnectionParametersBase object to an appropriate descending type and then adjust the parameters. To change the data provider, create an object of an appropriate descending type, customize the parameters and assign the created object to the ConnectionParameters property.

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#

how-to-apply-default-filtering-to-master-filters-in-dashboardviewer-t329583/CS/Dashboard_MFDefaultValues/Dashboard1.cs#L15

Access97ConnectionParameters parameters =
    (Access97ConnectionParameters)e.ConnectionParameters;
string databasePath = @"..\..\Data\nwind.mdb";

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

        + "Initial catalog=Adventure Works DW Standard Edition;Cube name=Adventure Works;Query Timeout=100;";
    e.ConnectionParameters = olapParams;
}

how-to-customize-connection-settings-before-dashboardviewer-connects-to-a-database-e4759/CS/Dashboard_ConfigureDataConnection/Form1.cs#L23

Access97ConnectionParameters parameters =
    (Access97ConnectionParameters)e.ConnectionParameters;

how-to-access-api-of-underlying-widgets-in-the-web-viewer-t197575/CS/Dashboard_WidgetAccess_Web/WebForm1.aspx.cs#L17

Access97ConnectionParameters parameters =
    (Access97ConnectionParameters)e.ConnectionParameters;
string databasePath = Server.MapPath("App_Data/nwind.mdb");

how-to-use-css-to-customize-dashboard-items-in-aspxdashboardviewer-t345484/CS/WebViewer_CustomizeCSS/WebForm1.aspx.cs#L18

{
    Access97ConnectionParameters parameters = (Access97ConnectionParameters)e.ConnectionParameters;
    string databasePath = Server.MapPath("App_Data/nwind.mdb");

VB.NET

how-to-apply-default-filtering-to-master-filters-in-dashboardviewer-t329583/VB/Dashboard_MFDefaultValues/Dashboard1.vb#L16

' Gets connection parameters used to establish a connection to the database.
Dim parameters As Access97ConnectionParameters = CType(e.ConnectionParameters, Access97ConnectionParameters)
Dim databasePath As String = "..\..\Data\nwind.mdb"

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

    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
End If

winforms-dashboard-beforeexportdocument-event/VB/WinForms_Dashboard_BeforeExportEvent_Example/Form1.vb#L38

Private Sub DashboardDesigner1_ConfigureDataConnection(ByVal sender As Object, ByVal e As DevExpress.DashboardCommon.DashboardConfigureDataConnectionEventArgs)
    If TypeOf e.ConnectionParameters Is ExtractDataSourceConnectionParameters Then
        Dim extractParams As ExtractDataSourceConnectionParameters = DirectCast(e.ConnectionParameters, ExtractDataSourceConnectionParameters)

how-to-customize-connection-settings-before-dashboardviewer-connects-to-a-database-e4759/VB/Dashboard_ConfigureDataConnection/Form1.vb#L26

Dim parameters As Access97ConnectionParameters =
    CType(e.ConnectionParameters, Access97ConnectionParameters)

how-to-access-api-of-underlying-widgets-in-the-web-viewer-t197575/VB/Dashboard_WidgetAccess_Web/WebForm1.aspx.vb#L18

' Gets connection parameters used to establish a connection to the database.
Dim parameters As Access97ConnectionParameters = CType(e.ConnectionParameters,  _
    Access97ConnectionParameters)