FilterControlPropertiesEventArgs Class

Provides data for the XtraReport.FilterControlProperties event.

Namespace: DevExpress.XtraReports.UserDesigner

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public class FilterControlPropertiesEventArgs :
    EventArgs

VB.NET

Public Class FilterControlPropertiesEventArgs
    Inherits EventArgs

Remarks

The XtraReport.FilterControlProperties event occurs every time a PropertyGrid refreshes its list of items in the End-User Designer. The FilterControlPropertiesEventArgs class introduces the FilterControlPropertiesEventArgs.Control property, which provides access to a control whose properties can be filtered, and the FilterControlPropertiesEventArgs.Properties collection which contains a control’s properties, which can be hidden from the Property Grid.

Note

FilterControlPropertiesEventArgs objects are automatically created, initialized and passed to the XtraReport.FilterControlProperties event handlers.

Example

This sample illustrates how to hide properties of a report and its controls from the End-User Report Designer‘s Properties panel.

Handle the static XtraReport.FilterComponentProperties event to remove items from the Properties tab.

Use the ExpressionBindingDescriptor.HidePropertyDescriptions method to remove properties from the Expressions tab available when the UserDesignerOptions.DataBindingMode is set to DataBindingMode.Expressions or DataBindingMode.ExpressionsAdvanced.

Program.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.UserDesigner;
using System.ComponentModel;
using DevExpress.XtraReports.Expressions;
// ...
static class Program {
    [STAThread]
    static void Main() {
        Application.EnableVisualStyles();
        Application.SetCompatibleTextRenderingDefault(false);

        // Handle the static FilterComponentProperties event to filter the Property Grid. 
        XtraReport.FilterComponentProperties += XtraReport_FilterComponentProperties;

        // For the XRLabel control, hide the Background Color and Tag properties from the Expressions tab.
        ExpressionBindingDescriptor.HidePropertyDescriptions(typeof(XRLabel), "BackColor", "Tag");
        Application.Run(new Form1());
    }

    static void XtraReport_FilterComponentProperties(object sender, 
        FilterComponentPropertiesEventArgs e) {
        // Hide the Scripts property for all report elements.
        HideProperty("Scripts", e);

        // Hide the ReportSource and ReportSourceUrl properties for subreports.
        if (e.Component is XRSubreport) {
            HideProperty("ReportSource", e);     
            HideProperty("ReportSourceUrl", e);    
        }  

        // Hide the Name property for a specific label control.
        if (sender is XtraReport1 && e.Component is XRControl && 
            ((XRControl)e.Component).Name == "label1") {
            HideProperty("Name", e);
        }

    }

    static void HideProperty(String propertyName, 
        FilterComponentPropertiesEventArgs filterComponentProperties) {
        PropertyDescriptor oldPropertyDescriptor = 
            filterComponentProperties.Properties[propertyName] as PropertyDescriptor;
        if (oldPropertyDescriptor != null) {
            // Substitute the current property descriptor 
            // with a custom one with the BrowsableAttribute.No attribute.
            filterComponentProperties.Properties[propertyName] = TypeDescriptor.CreateProperty(
                oldPropertyDescriptor.ComponentType,
                oldPropertyDescriptor,
                new Attribute[] { BrowsableAttribute.No });
        }
        else {
            // If the property descriptor cannot be substituted, 
            // remove it from the Properties collection.
            filterComponentProperties.Properties.Remove(propertyName);
        }
    }
}

Program.vb

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.UserDesigner
Imports System.ComponentModel
Imports DevExpress.XtraReports.Expressions
' ...
Friend NotInheritable Class Program

    Private Sub New()
    End Sub

    <STAThread> _
    Shared Sub Main()
        Application.EnableVisualStyles()
        Application.SetCompatibleTextRenderingDefault(False)

        ' Handle the static FilterComponentProperties event to filter the Property Grid. 
        AddHandler XtraReport.FilterComponentProperties, AddressOf XtraReport_FilterComponentProperties

        ' For the XRLabel control, hide the Background Color and Tag properties from the Expressions tab.
        ExpressionBindingDescriptor.HidePropertyDescriptions(GetType(XRLabel), "BackColor", "Tag")
        Application.Run(New Form1())
    End Sub

    Private Shared Sub XtraReport_FilterComponentProperties(ByVal sender As Object, ByVal e As FilterComponentPropertiesEventArgs)
        ' Hide the Scripts property for all report elements.
        HideProperty("Scripts", e)

        ' Hide the ReportSource and ReportSourceUrl properties for subreports.
        If TypeOf e.Component Is XRSubreport Then
            HideProperty("ReportSource", e)
            HideProperty("ReportSourceUrl", e)
        End If

        ' Hide the Name property for a specific label control.
        If TypeOf sender Is XtraReport1 AndAlso TypeOf e.Component Is XRControl AndAlso CType(e.Component, XRControl).Name = "label1" Then
            HideProperty("Name", e)
        End If

    End Sub

    Private Shared Sub HideProperty(ByVal propertyName As String, ByVal filterComponentProperties As FilterComponentPropertiesEventArgs)
        Dim oldPropertyDescriptor As PropertyDescriptor = TryCast(filterComponentProperties.Properties(propertyName), PropertyDescriptor)
        If oldPropertyDescriptor IsNot Nothing Then
            ' Substitute the current property descriptor 
            ' with a custom one with the BrowsableAttribute.No attribute.
            filterComponentProperties.Properties(propertyName) = TypeDescriptor.CreateProperty(oldPropertyDescriptor.ComponentType, oldPropertyDescriptor, New Attribute() { BrowsableAttribute.No })
        Else
            ' If the property descriptor cannot be substituted, 
            ' remove it from the Properties collection.
            filterComponentProperties.Properties.Remove(propertyName)
        End If
    End Sub
End Class

Inheritance

Object

EventArgs

FilterControlPropertiesEventArgs