XtraReportBase.DataMember Property

Gets or sets a specific list in a report’s data source.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

[SRCategory(ReportStringId.CatData)]
[DefaultValue("")]
public string DataMember { get; set; }

VB.NET

<SRCategory(ReportStringId.CatData)>
<DefaultValue("")>
Public Property DataMember As String

Property Value

Type	Default	Description
String	String.Empty	A String representing a list in a report’s XtraReportBase.DataSource.

Remarks

The DataMember property specifies the list (the object of a class that implements either the IList or the IListSource interface) in the data source that is returned by the XtraReportBase.DataSource property. Note that for the XtraReport object, this property’s value is usually a data table, and for the DetailReportBand this property’s value is a master-detail relationship.

Note

If the DataMember property is no longer valid after the XtraReportBase.DataSource property has been changed then the DataMember property will be automatically set to Empty.

See also the Bind a Report to a Data Source and Creating a Master-Detail Report using Detail Report Bands topics, to learn more about the DataMember property.

Example

Form1.vb

Imports System.Windows.Forms
Imports System
Imports DevExpress.DataAccess.Sql
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.Configuration

' ...
Private Function BindToData() As SqlDataSource
    ' Create a data source with the required connection parameters.  
    Dim connectionParameters As New Access97ConnectionParameters("../../nwind.mdb", "", "")
    Dim ds As New SqlDataSource(connectionParameters)

    ' Create an SQL query to access the Products table.
    Dim query As New CustomSqlQuery()
    query.Name = "customQuery"
    query.Sql = "SELECT * FROM Products"

    ' Add the query to the collection and return the data source. 
    ds.Queries.Add(query)

    ' Make the data source structure displayed 
    ' in the Field List of an End-User Report Designer.
    ds.RebuildResultSchema()

    Return ds
End Function

Private Function CreateReport() As XtraReport
    ' Create a new report instance.
    Dim report As New XtraReport()

    ' Assign the data source to the report.
    report.DataSource = BindToData()
    report.DataMember = "customQuery"

    ' Add a detail band to the report.
    Dim detailBand As New DetailBand()
    detailBand.Height = 50
    report.Bands.Add(detailBand)

    ' Create a new label.
    Dim label As XRLabel = New XRLabel With {.WidthF = 300}
    ' Specify the label's binding depending on the data binding mode.
    If Settings.Default.UserDesignerOptions.DataBindingMode = DataBindingMode.Bindings Then
       label.DataBindings.Add("Text", Nothing, "customQuery.ProductName")
    Else
        label.ExpressionBindings.Add(New ExpressionBinding("BeforePrint", "Text", "[ProductName]"))
    End If
    ' Add the label to the detail band.
    detailBand.Controls.Add(label)

    Return report
End Function

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button1.Click
    ' Show the report's print preview.
    Dim printTool As New ReportPrintTool(CreateReport())
    printTool.ShowPreview()
End Sub

Private Sub button2_Click(ByVal sender As Object, ByVal e As EventArgs) Handles button2.Click
    ' Open the report in an End-User Designer.
    Dim designTool As New ReportDesignTool(CreateReport())
    designTool.ShowRibbonDesignerDialog()
End Sub

Form1.cs

using System.Windows.Forms;
using System;
using DevExpress.DataAccess.Sql;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.Configuration;

// ...
private SqlDataSource BindToData() {
    // Create a data source with the required connection parameters.  
    Access97ConnectionParameters connectionParameters = 
        new Access97ConnectionParameters("../../nwind.mdb", "", "");
    SqlDataSource ds = new SqlDataSource(connectionParameters);

    // Create an SQL query to access the Products table.
    CustomSqlQuery query = new CustomSqlQuery();
    query.Name = "customQuery";
    query.Sql = "SELECT * FROM Products";

    // Add the query to the collection and return the data source. 
    ds.Queries.Add(query);

    // Make the data source structure displayed 
    // in the Field List of an End-User Report Designer.
    ds.RebuildResultSchema();

    return ds;
}

private XtraReport CreateReport() {
    // Create a new report instance.
    XtraReport report = new XtraReport();

    // Assign the data source to the report.
    report.DataSource = BindToData();
    report.DataMember = "customQuery";

    // Add a detail band to the report.
    DetailBand detailBand = new DetailBand();
    detailBand.Height = 50;
    report.Bands.Add(detailBand);

    // Create a new label.
    XRLabel label = new XRLabel { WidthF = 300 };
    // Specify the label's binding depending on the data binding mode.
    if (Settings.Default.UserDesignerOptions.DataBindingMode == DataBindingMode.Bindings)
       label.DataBindings.Add("Text", null, "customQuery.ProductName");
    else label.ExpressionBindings.Add(new ExpressionBinding("BeforePrint", "Text", "[ProductName]"));
    // Add the label to the detail band.
    detailBand.Controls.Add(label);

    return report;
}

private void button1_Click(object sender, EventArgs e) {
    // Show the report's print preview.
    ReportPrintTool printTool = new ReportPrintTool(CreateReport());
    printTool.ShowPreview();
}

private void button2_Click(object sender, EventArgs e) {
    // Open the report in an End-User Designer.
    ReportDesignTool designTool = new ReportDesignTool(CreateReport());
    designTool.ShowRibbonDesignerDialog();
}

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#

Reporting_how-to-implement-a-custom-authorization-service-t488888/CS/AuthorizationService/Reports/CategoriesReport.cs#L446

this.GroupHeader1});
this.DetailReport.DataMember = "Categories.CategoriesProducts";
this.DetailReport.DataSource = this.sqlDataSource1;

Reporting_how-to-create-a-web-based-report-at-runtime-e573/CS/Default.aspx.cs#L18

r.DataSource = ds;
r.DataMember = ds.Tables[0].TableName;
XRLabel label = new XRLabel();

Reporting_how-to-dynamically-generate-a-master-detail-report-in-a-winforms-application-e4421/CS/MasterDetailAtRuntime/Form1.cs#L24

report.DataSource = dataSet;
report.DataMember = dataSet.Customers.TableName;

Reporting_documentpreviewcontrol-how-to-create-a-drill-down-report-runtime-sample-t337482/CS/dxWPFApp/MainWindow.xaml.cs#L84

masterReport.DataSource = ds;
masterReport.DataMember = "Categories";
CreateMasterReportControls(masterReport);

Reporting_how-to-use-the-web-document-viewer-in-javascript-with-reactjs-t561300/CS/ServerSide/XtraReport2.cs#L324

this.sqlDataSource1});
this.DataMember = "Categories";
this.DataSource = this.sqlDataSource1;

VB.NET

Reporting_how-to-implement-a-custom-authorization-service-t488888/VB/AuthorizationService/Reports/CategoriesReport.vb#L427

Me.DetailReport.Bands.AddRange(New DevExpress.XtraReports.UI.Band() {Me.Detail1, Me.GroupHeader1})
Me.DetailReport.DataMember = "Categories.CategoriesProducts"
Me.DetailReport.DataSource = Me.sqlDataSource1

Reporting_how-to-create-a-web-based-report-at-runtime-e573/VB/Default.aspx.vb#L21

r.DataSource = ds
r.DataMember = ds.Tables(0).TableName
Dim label As New XRLabel()

Reporting_how-to-dynamically-generate-a-master-detail-report-in-a-winforms-application-e4421/VB/MasterDetailAtRuntime/Form1.vb#L22

report.DataSource = dataSet
report.DataMember = dataSet.Customers.TableName

Reporting_documentpreviewcontrol-how-to-create-a-drill-down-report-runtime-sample-t337482/VB/dxWPFApp/MainWindow.xaml.vb#L86

masterReport.DataSource = ds
masterReport.DataMember = "Categories"
CreateMasterReportControls(masterReport)

Reporting_how-to-use-the-web-document-viewer-in-javascript-with-reactjs-t561300/VB/ServerSide/XtraReport2.vb#L305

Me.ComponentStorage.AddRange(New System.ComponentModel.IComponent() { Me.sqlDataSource1})
Me.DataMember = "Categories"
Me.DataSource = Me.sqlDataSource1

Implements

DevExpress.Data.IDataContainerBase.DataMember