ExpressionBindingDescriptor.SetPropertyDescription(Type, String, ExpressionBindingDescription) Method

Adds a new specified property description for the specified control to the Properties panel’s Expresssions tab.

Namespace: DevExpress.XtraReports.Expressions

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public static void SetPropertyDescription(
    Type componentType,
    string propertyName,
    ExpressionBindingDescription description
)

VB.NET

Public Shared Sub SetPropertyDescription(
    componentType As Type,
    propertyName As String,
    description As ExpressionBindingDescription
)

Parameters

Name	Type	Description
componentType	Type	A Type object that specifies the control type for which to add the property.
propertyName	String	A string that specifies the property name to add.
description	ExpressionBindingDescription	A ExpressionBindingDescription object that specifies the property description.

Remarks

To add a new property description to the End-User Report Designer’s Expressions tab, create a new ExpressionBindingDescription instance with the required settings and use the SetPropertyDescription method. Each description object contains information about the list of events in which the property is available (ExpressionBindingDescription.EventNames), the property category (ExpressionBindingDescription.ScopeName), the collection of inner properties in a case of the complex property (ExpressionBindingDescription.BindableProperties) and other settings.

The following code sample demonstrates how to add the Value property to a new custom category at the tab’s first position.

C#

using DevExpress.XtraReports.Expressions;
// ...

ExpressionBindingDescription myDescription = new ExpressionBindingDescription(
    new string[] { "BeforePrint" }, 0, new string[0], "My category");
ExpressionBindingDescriptor.SetPropertyDescription(typeof(XRLabel), "Value", myDescription);

VB.NET

Imports DevExpress.XtraReports.Expressions
' ...

Dim myDescription As ExpressionBindingDescription = New ExpressionBindingDescription(
    New String() {"BeforePrint"}, 0, New String((0) - 1) {}, "My category")
ExpressionBindingDescriptor.SetPropertyDescription(GetType(XRLabel), "Value", myDescription)

See the ExpressionBindingDescriptor class topic for more information.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetPropertyDescription(Type, String, ExpressionBindingDescription) 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#

reporting-wpf-report-designer-customize-controls-smart-tag/CS/MainWindow.xaml.cs#L16

public MainWindow() {
    ExpressionBindingDescriptor.SetPropertyDescription(typeof(XRProgressBar), "Progress", new ExpressionBindingDescription(new[] { "BeforePrint" }, -1, new string[0], null));
    InitializeComponent();

reporting-winforms-custom-progress-bar-control/CS/ProgressBar.cs#L38

ExpressionBindingDescriptor.SetPropertyDescription(
    typeof(ProgressBar), nameof(Position), description

reporting-winforms-custom-control-numeric-label/CS/NumericLabel.cs#L50

ExpressionBindingDescriptor.SetPropertyDescription(
    typeof(NumericLabel), nameof(Number), description

VB.NET

reporting-wpf-report-designer-customize-controls-smart-tag/VB/MainWindow.xaml.vb#L18

Public Sub New()
    ExpressionBindingDescriptor.SetPropertyDescription(GetType(XRProgressBar), "Progress", New ExpressionBindingDescription( { "BeforePrint" }, -1, New String(){}, Nothing))
    InitializeComponent()

reporting-winforms-custom-progress-bar-control/VB/ProgressBar.vb#L38

    ExpressionBindingDescriptor.SetPropertyDescription(GetType(ProgressBar), nameof(Position), description)
End Sub

reporting-winforms-custom-control-numeric-label/VB/NumericLabel.vb#L49

    ExpressionBindingDescriptor.SetPropertyDescription(GetType(NumericLabel), NameOf(Number), description)
End Sub