CustomItemData.GetBindings(String) Method

Returns a collection of CustomItemBindingValue objects.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public IList<CustomItemBindingValue> GetBindings(
    string sectionName
)

VB.NET

Public Function GetBindings(
    sectionName As String
) As IList(Of CustomItemBindingValue)

Parameters

Name	Type	Description
sectionName	String	The name of the Measure or Dimension property that is declared in metadata and corresponds to the data section.

Returns

Type	Description
IList<CustomItemBindingValue>	A CustomItemBindingValue collection.

Remarks

The GetBindings method gets a CustomItemBindingValue collection. Each object in this collection contains information about data items stored in custom item metadata. You can use the object’s UniqueId property value as a data member when you bind a custom control to data.

The following example shows how to bind data to a custom chart’s series.

C#

using DevExpress.DashboardCommon;
using DevExpress.DashboardWin;
using DevExpress.XtraCharts;
using System.Collections.Generic;
using System.Linq;

namespace CustomItemsSample {
 public class FunnelItemControlProvider : CustomControlProviderBase {
  // ...
  protected override void UpdateControl(CustomItemData customItemData){
      chart.Series.Clear();
      IList<CustomItemBindingValue> valuesSectionBindings = customItemData.GetBindings(nameof(FunnelItemMetadata.Value));
      IList<CustomItemBindingValue> argumentsSectionBindings = customItemData.GetBindings(nameof(FunnelItemMetadata.Arguments));
      if (valuesSectionBindings.Count > 0 && argumentsSectionBindings.Count > 0)
      {
          Series series = new Series("A Funnel Series", ViewType.Funnel);
          flatData = customItemData.GetFlatData(new DashboardFlatDataSourceOptions() { AddColoringColumns = true });
          series.DataSource = flatData;
          series.ValueDataMembers.AddRange(valuesSectionBindings[0].UniqueId);
          series.ArgumentDataMember = argumentsSectionBindings.Last().UniqueId;
          series.ColorDataMember = flatData.GetColoringColumn(valuesSectionBindings[0].UniqueId).Name;
          chart.Series.Add(series);
      }
  }
 }
}

VB.NET

Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardWin
Imports DevExpress.XtraCharts
Imports System.Collections.Generic
Imports System.Linq

Namespace CustomItemsSample
 Public Class FunnelItemControlProvider
     Inherits CustomControlProviderBase
 ' ...
  Protected Overrides Sub UpdateControl(ByVal customItemData As CustomItemData)
      chart.Series.Clear()
      Dim valuesSectionBindings As IList(Of CustomItemBindingValue) = customItemData.GetBindings(NameOf(FunnelItemMetadata.Value))
      Dim argumentsSectionBindings As IList(Of CustomItemBindingValue) = customItemData.GetBindings(NameOf(FunnelItemMetadata.Arguments))
      If valuesSectionBindings.Count > 0 AndAlso argumentsSectionBindings.Count > 0 Then
          Dim series As New Series("A Funnel Series", ViewType.Funnel)
          flatData = customItemData.GetFlatData(New DashboardFlatDataSourceOptions() With {.AddColoringColumns = True})
          series.DataSource = flatData
          series.ValueDataMembers.AddRange(valuesSectionBindings(0).UniqueId)
          series.ArgumentDataMember = argumentsSectionBindings.Last().UniqueId
          series.ColorDataMember = flatData.GetColoringColumn(valuesSectionBindings(0).UniqueId).Name
          chart.Series.Add(series)
      End If
  End Sub
 End Class
End Namespace