BeforeExportDocumentEventArgs.HideItem(Predicate<DashboardItem>) Method

Hides the dashboard item matching the specified predicate in the exported dashboard.

Namespace: DevExpress.DashboardCommon

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

NuGet Package: DevExpress.Dashboard.Core

Declaration

C#

public void HideItem(
    Predicate<DashboardItem> match
)

VB.NET

Public Sub HideItem(
    match As Predicate(Of DashboardItem)
)

Parameters

Name	Type	Description
match	Predicate<DashboardItem>	A System.Predicate that specifies the condition used to determine whether to hide the dashboard item.

Example

This example demonstrates how to hide dashboard filter items when a dashboard is exported to PDF and the ExportFilters export option is set to false.

This method can be the used to handle the following events:

• DashboardDesigner.BeforeExportDocument
• DashboardViewer.BeforeExportDocument
• ASPxDashboard.BeforeExportDocument
• DashboardControl.BeforeExportDocument
• DashboardConfigurator.BeforeExportDocument

C#

using DevExpress.DashboardCommon;
// ...
        dashboardDesigner1.BeforeExportDocument += DashboardDesigner1_BeforeExportDocument;
// ...
    private void DashboardDesigner1_BeforeExportDocument(object sender, BeforeExportDocumentEventArgs e)
    {
        if (e.ExportAction == DashboardExportAction.ExportToPdf &&
            e.PdfExportOptions.ExportFilters == false)
        {
            e.HideItem(item => item is FilterElementDashboardItem ||
            item is DateFilterDashboardItem);
        }
    }

VB.NET

Imports DevExpress.DashboardCommon
' ...
        AddHandler dashboardDesigner1.BeforeExportDocument, AddressOf DashboardDesigner1_BeforeExportDocument
' ...
    Private Sub DashboardDesigner1_BeforeExportDocument(ByVal sender As Object, ByVal e As BeforeExportDocumentEventArgs)
        If e.ExportAction = DashboardExportAction.ExportToPdf AndAlso e.PdfExportOptions.ExportFilters = False Then
            e.HideItem(Function(item) TypeOf item Is FilterElementDashboardItem OrElse TypeOf item Is DateFilterDashboardItem)
        End If
    End Sub