XtraReport.FilterComponentProperties Event

Occurs every time the Properties window refreshes its item list in the End-User Designer.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public static event EventHandler<FilterComponentPropertiesEventArgs> FilterComponentProperties

VB.NET

Public Shared Event FilterComponentProperties As EventHandler(Of FilterComponentPropertiesEventArgs)

Event Data

The FilterComponentProperties event's data class is FilterComponentPropertiesEventArgs. The following properties provide information specific to this event:

Property	Description
Component	Gets a component for which an event has occurred.
Properties	Provides access to properties of the current component.

Remarks

Handle the FilterComponentProperties event to hide some of the properties of either a particular control, or a group of controls in the End-User Designer. When a specific property is hidden, it disappears from both the Properties window and the control’s smart tag.

This event is raised only for report controls (i.e., the XRControl class descendants).

Because this is a static event, you will need to write an event handler common to all End-User Designer forms used in your application. The best way of handling a static event is to handle it only once in a static constructor of a class, or in the application’s entry point static procedure (e.g., Main).

See the following documents for code samples:

• WinForms - Hide Properties from End-User Report Designer
• WPF - Hide Properties from the Report Designer

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FilterComponentProperties event.

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#

wpf-reporting-hide-properties-in-designer/CS/MainWindow.xaml.cs#L15

// Handle the static FilterComponentProperties event to filter the Properties panel.
XtraReport.FilterComponentProperties += XtraReport_FilterComponentProperties;
reportDesigner.OpenDocument(report);

reporting-wpf-customize-property-grid-in-the-report-designer/CS/MainWindow.xaml.cs#L14

InitializeComponent();
XtraReport.FilterComponentProperties += XtraReport_FilterComponentProperties;
designer.OpenDocument(new XtraReport());

VB.NET

wpf-reporting-hide-properties-in-designer/VB/MainWindow.xaml.vb#L16

' Handle the static FilterComponentProperties event to filter the Properties panel.
AddHandler XtraReport.FilterComponentProperties, AddressOf HidePropertiesExample.MainWindow.XtraReport_FilterComponentProperties
Me.reportDesigner.OpenDocument(report)

reporting-wpf-customize-property-grid-in-the-report-designer/VB/MainWindow.xaml.vb#L15

InitializeComponent()
AddHandler XtraReport.FilterComponentProperties, AddressOf XtraReport_FilterComponentProperties
designer.OpenDocument(New XtraReport())