DataDashboardItem.DataMember Property

Gets or sets a specific data member in a dashboard data source to which the dashboard item is bound.

Namespace: DevExpress.DashboardCommon

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

[DefaultValue(null)]
public string DataMember { get; set; }

VB.NET

<DefaultValue(Nothing)>
Public Property DataMember As String

Property Value

Type	Default	Description
String	null	A String value that specifies a data member in a dashboard data source.

Remarks

Use the DataDashboardItem.DataSource property to specify the data source to which the current dashboard item is bound. To access the collection of existing dashboard data sources, use the Dashboard.DataSources property.

Note that the DataMember property is in effect for DashboardSqlDataSource and DashboardEFDataSource only. For SQL data sources, the data member is a query used to select a specific subset of data. Use the SqlDataSource.Queries property to obtain the available data source queries. Then, assign the name of the required query (SqlQuery.Name) to the DataMember property to bind the dashboard item to this query.

Related GitHub Examples

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

web-forms-dashboard-replace-sql-data-source-with-object-data-source-with-filtered-data/CS/ASPxDashboard/Default.aspx.cs#L81

foreach (var item in dashboard.Items.OfType<DataDashboardItem>().Where(i => Object.ReferenceEquals(i.DataSource, query.DataSource) && i.DataMember == query.Query.Name)) {
    item.DataMember = "";

winforms-dashboard-replace-sql-data-source-with-object-data-source-with-filtered-data/CS/WinFormsDashboard/ViewerForm.cs#L32

e.Dashboard.DataSources.Add(ods);
foreach (var item in e.Dashboard.Items.OfType<DataDashboardItem>().Where(i => i.DataSource == query.DataSource && i.DataMember == query.Query.Name)) {
    item.DataMember = "";

winforms-dashboard-bind-to-entity-framework-data-source-at-runtime/CS/Dashboard_EntityFramework/Form1.cs#L20

PivotDashboardItem pivot = new PivotDashboardItem();
pivot.DataMember = "Orders";
pivot.DataSource = dashboard.DataSources[0];

winforms-dashboard-data-federation/CS/DataFederationExample/Form1.cs#L39

PivotDashboardItem pivot = new PivotDashboardItem();
pivot.DataMember = "FDS-Created-by-NodeBulder";
pivot.DataSource = federatedDS_Join;

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

ChartDashboardItem chart = new ChartDashboardItem();
chart.DataSource = sqlDataSource; chart.DataMember = "MyQuery";
chart.Arguments.Add(new Dimension("OrderDate", DateTimeGroupInterval.MonthYear));

VB.NET

web-forms-dashboard-replace-sql-data-source-with-object-data-source-with-filtered-data/VB/ASPxDashboard/Default.aspx.vb#L83

dashboard.DataSources.Add(ods)
For Each item In dashboard.Items.OfType(Of DataDashboardItem)().Where(Function(i) Object.ReferenceEquals(i.DataSource, dsQuery.DataSource) AndAlso i.DataMember = dsQuery.Query.Name)
    item.DataMember = ""

winforms-dashboard-replace-sql-data-source-with-object-data-source-with-filtered-data/VB/WinFormsDashboard/ViewerForm.vb#L34

e.Dashboard.DataSources.Add(ods)
For Each item In e.Dashboard.Items.OfType(Of DataDashboardItem)().Where(Function(i) i.DataSource.Equals(query.DataSource) AndAlso i.DataMember = query.Query.Name)
    item.DataMember = ""

winforms-dashboard-bind-to-entity-framework-data-source-at-runtime/VB/Dashboard_EntityFramework/Form1.vb#L21

Dim pivot As New PivotDashboardItem()
pivot.DataMember = "Orders"
pivot.DataSource = dashboard.DataSources(0)

winforms-dashboard-data-federation/VB/DataFederationExample/Form1.vb#L41

Dim pivot As New PivotDashboardItem()
pivot.DataMember = "FDS-Created-by-NodeBulder"
pivot.DataSource = federatedDS_Join

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

chart.DataSource = sqlDataSource
chart.DataMember = "MyQuery"
chart.Arguments.Add(New Dimension("OrderDate", DateTimeGroupInterval.MonthYear))