ReportFiltering.FilterDescription Property

Gets or sets a textual description for the filter parameters used in the criteria specified by the Parameters Object.

Namespace: DevExpress.ExpressApp.Reports

Assembly: DevExpress.Persistent.Base.v18.2.dll

Declaration

[Browsable(true)]
[SettingsBindable(true)]
public string FilterDescription { get; set; }
<Browsable(True)>
<SettingsBindable(True)>
Public Property FilterDescription As String

Property Value

Type Description
String

A string that is the description of the filter parameters used in the criteria specified by the Parameters Object, whose type is set to the ReportFiltering.ParametersObjectType property.

Remarks

When implementing a ParametersObject, which is then set to the ReportFiltering.ParametersObjectType property, you can add public properties to it and use their values as filter parameters in the criteria. With such a ParametersObject, a detail form with the corresponding Property Editors will be invoked when trying to preview the report. This will allow end-users to specify the filter parameters. To provide a description for end-users on what parameters they should specify, use the FilterDescription property. For details, refer to the Filter Report Data Source using the ParametersObjectType Property topic.

This property is only considered when you set a filter with user-oriented parameters using the ReportFiltering.ParametersObjectType property.

See Also