CustomizeExportDocumentEventArgs.GetItemData(String) Method

Returns multidimensional data for the specified dashboard item.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public MultiDimensionalData GetItemData(
    string dashboardItemName
)

VB.NET

Public Function GetItemData(
    dashboardItemName As String
) As MultiDimensionalData

Parameters

Name	Type	Description
dashboardItemName	String	The dashboard item’s component name.

Returns

Type	Description
MultiDimensionalData	The multidimensional data.

Remarks

Call the e.GetItemData method to obtain dashboard item’s data.

The code snippet below demonstrates how you can generate an XLSX document. The code uses Spreadsheet Document API to modify the generated document’s layout and content. This library is part of the DevExpress Office File API suite.

Form1.cs

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Drawing;
using System.Linq;
using System.Windows.Forms;
using DevExpress.DashboardCommon;
using DevExpress.DashboardCommon.ViewerData;
using DevExpress.Spreadsheet;
// ...
dashboardDesigner1.CustomizeExportDocument += DashboardDesigner1_CustomizeExportDocument;
// ...
private void DashboardDesigner1_CustomizeExportDocument(object sender, CustomizeExportDocumentEventArgs e){
  if (e.ExportAction == DashboardExportAction.ExportToExcel && e.ExcelExportOptions.Format == ExcelFormat.Xlsx) {
    CustomDashboardItem item = dashboardDesigner1.Dashboard.Items.FirstOrDefault(i => i.ComponentName == e.ItemComponentName) as CustomDashboardItem;

    if (item != null) {
        DevExpress.Spreadsheet.Workbook workbook = new DevExpress.Spreadsheet.Workbook();
        Worksheet worksheet = workbook.Worksheets[0];

        MultiDimensionalData itemData = e.GetItemData(e.ItemComponentName);
         CustomItemData customItemData = new CustomItemData(item, itemData);

        DashboardFlatDataSource flatData = customItemData.GetFlatData();
        IList<DashboardFlatDataColumn> columns = flatData.GetColumns();
        for (int colIndex = 0; colIndex < columns.Count; colIndex++){
            worksheet.Cells[0, colIndex].Value = columns[colIndex].DisplayName;
            worksheet.Cells[0, colIndex].FillColor = Color.LightGreen;
            worksheet.Cells[0, colIndex].Font.FontStyle = SpreadsheetFontStyle.Bold;
            int headerOffset = 1;
            for (int rowIndex = 0; rowIndex < flatData.Count; rowIndex++)
                worksheet.Cells[rowIndex + headerOffset, colIndex].Value = flatData.GetDisplayText(columns[colIndex].Name, rowIndex);
        }
        workbook.SaveDocument(e.Stream, DocumentFormat.Xlsx);
    }
  }
}

Form1.vb

Imports System
Imports System.Collections.Generic
Imports System.Collections.ObjectModel
Imports System.Drawing
Imports System.Linq
Imports System.Windows.Forms
Imports DevExpress.DashboardCommon
Imports DevExpress.DashboardCommon.ViewerData
Imports DevExpress.Spreadsheet
' ...
Private dashboardDesigner1.CustomizeExportDocument += AddressOf DashboardDesigner1_CustomizeExportDocument
' ...
Private Sub DashboardDesigner1_CustomizeExportDocument(ByVal sender As Object, ByVal e As CustomizeExportDocumentEventArgs)
  If e.ExportAction = DashboardExportAction.ExportToExcel AndAlso e.ExcelExportOptions.Format = ExcelFormat.Xlsx Then

    Dim item As CustomDashboardItem = TryCast(dashboardDesigner1.Dashboard.Items.FirstOrDefault(Function(i) i.ComponentName = e.ItemComponentName), CustomDashboardItem)

    If item IsNot Nothing Then
      Dim workbook As New DevExpress.Spreadsheet.Workbook()
      Dim worksheet As Worksheet = workbook.Worksheets(0)

      Dim itemData As MultiDimensionalData = e.GetItemData(e.ItemComponentName)
      Dim customItemData As New CustomItemData(item, itemData)

      Dim flatData As DashboardFlatDataSource = customItemData.GetFlatData()
      Dim columns As IList(Of DashboardFlatDataColumn) = flatData.GetColumns()
      For colIndex As Integer = 0 To columns.Count - 1
        worksheet.Cells(0, colIndex).Value = columns(colIndex).DisplayName
        worksheet.Cells(0, colIndex).FillColor = Color.LightGreen
        worksheet.Cells(0, colIndex).Font.FontStyle = SpreadsheetFontStyle.Bold
        Dim headerOffset As Integer = 1
        For rowIndex As Integer = 0 To flatData.Count - 1
          worksheet.Cells(rowIndex + headerOffset, colIndex).Value = flatData.GetDisplayText(columns(colIndex).Name, rowIndex)
        Next rowIndex
      Next colIndex
      workbook.SaveDocument(e.Stream, DocumentFormat.Xlsx)
    End If
  End If
End Sub

The following image demonstrates the resulting document:

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetItemData(String) 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#L44

MultiDimensionalData itemData = e.GetItemData(e.ItemComponentName);
CustomItemData customItemData = new CustomItemData(item, itemData);

VB.NET

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

Dim itemData As MultiDimensionalData = e.GetItemData(e.ItemComponentName)
Dim customItemData As New CustomItemData(item, itemData)