DashboardFlatDataSourceOptions.AddDisplayTextColumns Property

Specifies whether the CustomItemData.GetFlatData(DashboardFlatDataSourceOptions) method should add display text columns to DashboardFlatDataSource.

Namespace: DevExpress.DashboardCommon

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

Declaration

C#

public bool AddDisplayTextColumns { get; set; }

VB.NET

Public Property AddDisplayTextColumns As Boolean

Property Value

Type	Description
Boolean	true to add display text columns; otherwise, false.

Remarks

You can include display text values for each data column in a flat data source. To accomplish this, set the AddDisplayTextColumns property to true and pass the DashboardFlatDataSourceOptions object to the CustomItemData.GetFlatData(DashboardFlatDataSourceOptions) method.

The following code snippet adds display text columns to the DashboardFlatDataSource object:

C#

using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;

namespace CustomItemsSample {
  public class SankeyItemControlProvider : CustomControlProviderBase {
    DashboardFlatDataSource flatData;
    CustomDashboardItem<SankeyItemMetadata> dashboardItem;

    protected override void UpdateControl(CustomItemData customItemData) {
        flatData = customItemData.GetFlatData(new DashboardFlatDataSourceOptions() { AddColoringColumns = true, AddDisplayTextColumns = true });
        SetDataBindings(flatData);
    }

    void SetDataBindings(DashboardFlatDataSource flatData) {
        sankey.Colorizer = new SankeyItemColorizer(flatData);
        sankey.SourceDataMember = flatData.GetDisplayTextColumn(dashboardItem.Metadata.Source.UniqueId).Name;
        sankey.TargetDataMember = flatData.GetDisplayTextColumn(dashboardItem.Metadata.Target.UniqueId).Name;
        if(dashboardItem.Metadata.Weight != null)
            sankey.WeightDataMember = dashboardItem.Metadata.Weight.UniqueId;
        try {
            sankey.DataSource = flatData;
        } catch {
            sankey.DataSource = null;
        }
    }  
  }
}

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin

Namespace CustomItemsSample
  Public Class SankeyItemControlProvider
      Inherits CustomControlProviderBase

    Private flatData As DashboardFlatDataSource
    Private dashboardItem As CustomDashboardItem(Of SankeyItemMetadata)

    Protected Overrides Sub UpdateControl(ByVal customItemData As CustomItemData)
        flatData = customItemData.GetFlatData(New DashboardFlatDataSourceOptions() With {
            .AddColoringColumns = True,
            .AddDisplayTextColumns = True
        })
        SetDataBindings(flatData)
    End Sub

    Private Sub SetDataBindings(ByVal flatData As DashboardFlatDataSource)
        sankey.Colorizer = New SankeyItemColorizer(flatData)
        sankey.SourceDataMember = flatData.GetDisplayTextColumn(dashboardItem.Metadata.Source.UniqueId).Name
        sankey.TargetDataMember = flatData.GetDisplayTextColumn(dashboardItem.Metadata.Target.UniqueId).Name
        If dashboardItem.Metadata.Weight IsNot Nothing Then
            sankey.WeightDataMember = dashboardItem.Metadata.Weight.UniqueId
        End If
        Try
            sankey.DataSource = flatData
        Catch
            sankey.DataSource = Nothing
        End Try
    End Sub
  End Class
End Namespace