FieldListDockPanel.UpdateDataSource(IDesignerHost) Method

Forcibly updates the structure of data sources currently displayed within this FieldListDockPanel object.

Namespace: DevExpress.XtraReports.UserDesigner

Assembly: DevExpress.XtraReports.v24.2.Extensions.dll

NuGet Package: DevExpress.Win.Reporting

Declaration

C#

public void UpdateDataSource(
    IDesignerHost designerHost
)

VB.NET

Public Sub UpdateDataSource(
    designerHost As IDesignerHost
)

Parameters

Name	Type	Description
designerHost	IDesignerHost	An object implementing the IDesignerHost interface that is used to manage designer transactions and components.

Remarks

The first step in troubleshooting field update problems is to verify that the data source and data member settings are correct. You can also call the data source’s RebuildResultSchema method.

Use the UpdateDataSource method only in special cases such as when a report’s data source is changed, but this change isn’t reflected in the Field List, and it is necessary to update the Field List.

Example

The following code demonstrates how to update the Field List in the End-User Report Designer by calling the FieldListDockPanel.UpdateDataSource method after assigning a data source to a report.

This may be required after a report has been assigned a new data source at runtime without adding this data source to the End-User Report Designer host. For example, this situation occurs when binding to a list data source (e.g., ArrayList), as demonstrated in the following sample.

Form1.vb

Private Sub BindReportToData()
    If xrDesignPanel1.Report Is Nothing Then
        Return
    End If
     ' Create a data source and bind it to a report.
    xrDesignPanel1.Report.DataSource = CreateDataSource()

    ' Update the Field List.
    Dim fieldList As FieldListDockPanel = CType(xrDesignDockManager1(DesignDockPanelType.FieldList), FieldListDockPanel)
    Dim host As IDesignerHost = CType(xrDesignPanel1.GetService(GetType(IDesignerHost)), IDesignerHost)
    fieldList.UpdateDataSource(host)
End Sub

Form1.cs

private void BindReportToData() {
    if (xrDesignPanel1.Report == null)
        return;
     // Create a data source and bind it to a report.
    xrDesignPanel1.Report.DataSource = CreateDataSource();

    // Update the Field List.
    FieldListDockPanel fieldList =
        (FieldListDockPanel)xrDesignDockManager1[DesignDockPanelType.FieldList];
    IDesignerHost host = 
        (IDesignerHost)xrDesignPanel1.GetService(typeof(IDesignerHost));
    fieldList.UpdateDataSource(host);
}