DashboardFlatDataSource.GetDisplayText(String, Int32) Method

Gets the cell’s display text.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public string GetDisplayText(
    string columnName,
    int rowIndex
)

VB.NET

Public Function GetDisplayText(
    columnName As String,
    rowIndex As Integer
) As String

Parameters

Name	Type	Description
columnName	String	A column name.
rowIndex	Int32	A row index.

Returns

Type	Description
String	The cell’s display text.

Remarks

The GetFlatData method returns the DashboardFlatDataSource object that contains unformatted measure and dimension values. To apply formatting defined for these measures and dimensions, you can replace values with their display text. Use the GetDisplayText method to get display text for a particular measure or dimension and visualize formatted values in a custom item.

The following code snippet formats display text for the custom Grid’s cells:

C#

using DevExpress.DashboardWin;
using DevExpress.XtraGrid;
using DevExpress.DashboardCommon;

namespace CustomItemsSample {
  public class CustomGridProvider : CustomControlProviderBase {
    GridView view;
    // ...
    public CustomGridProvider() {
      view = new GridView();
      grid.MainView = view;
      view.CustomColumnDisplayText += View_CustomColumnDisplayText;
    }
    void View_CustomColumnDisplayText(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs e) {
      DashboardFlatDataSource data = (DashboardFlatDataSource)grid.DataSource;
      e.DisplayText = data.GetDisplayText(e.Column.FieldName, e.ListSourceRowIndex);
    }
  }
}

VB.NET

Imports DevExpress.DashboardWin
Imports DevExpress.XtraGrid
Imports DevExpress.DashboardCommon

Namespace CustomItemsSample
  Public Class CustomGridProvider
      Inherits CustomControlProviderBase

    Private view As GridView
    ' ...
    Public Sub New()
      view = New GridView()
      grid.MainView = view
      AddHandler view.CustomColumnDisplayText, AddressOf View_CustomColumnDisplayText
    End Sub
    Private Sub View_CustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs)
      Dim data As DashboardFlatDataSource = CType(grid.DataSource, DashboardFlatDataSource)
      e.DisplayText = data.GetDisplayText(e.Column.FieldName, e.ListSourceRowIndex)
    End Sub
  End Class
End Namespace

Refer to the following tutorials for more information on how to create a custom item: Custom Item - Tutorials.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetDisplayText(String, Int32) method.

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#

winforms-dashboard-custom-items/CS/TutorialsCustomItems/Form1.cs#L55

    for (int rowIndex = 0; rowIndex < flatData.Count; rowIndex++)
        worksheet.Cells[rowIndex + headerOffset, colIndex].Value = flatData.GetDisplayText(columns[colIndex].Name, rowIndex);
}

winforms-dashboard-custom-items-extension/CS/CustomItemExtension/CustomItems/WebPageItem/WebPageItemControlProvider.cs#L42

if(dashboardItem.Metadata.Attribute != null) {
    attributeValue = customItemData.GetFlatData().GetDisplayText(dashboardItem.Metadata.Attribute.UniqueId, 0);
}

winforms-dashboard-trend-line-indicators/CS/WinformsIndicator/Program.cs#L59

    DashboardFlatDataSource data = (DashboardFlatDataSource)grid.DataSource;
    e.DisplayText = data.GetDisplayText(e.Column.FieldName, e.ListSourceRowIndex);
}

VB.NET

winforms-dashboard-custom-items/VB/TutorialsCustomItems/Form1.vb#L58

For rowIndex As Integer = 0 To flatData.Count - 1
    worksheet.Cells(rowIndex + headerOffset, colIndex).Value = flatData.GetDisplayText(columns(colIndex).Name, rowIndex)
Next rowIndex

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/WebPageItem/WebPageItemControlProvider.vb#L46

If dashboardItem.Metadata.Attribute IsNot Nothing Then
    attributeValue = customItemData.GetFlatData().GetDisplayText(dashboardItem.Metadata.Attribute.UniqueId, 0)
End If

winforms-dashboard-trend-line-indicators/VB/WinformsIndicator/Program.vb#L67

    Dim data As DashboardFlatDataSource = CType(grid.DataSource, DashboardFlatDataSource)
    e.DisplayText = data.GetDisplayText(e.Column.FieldName, e.ListSourceRowIndex)
End Sub