FormattingRule.DataSource Property

Gets or sets a data source containing the list of data fields that can be used in constructing a formatting rule’s FormattingRule.Condition.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Core

Declaration

C#

public override object DataSource { get; set; }

VB.NET

Public Overrides Property DataSource As Object

Property Value

Type	Description
Object	A Object representing a formatting rule’s data source.

Remarks

The DataSource and FormattingRule.DataMember properties together specify the list containing data fields that can participate in constructing the Boolean expression (accessed via the FormattingRule.Condition property).

Note that by default, the DataSource and DataMember properties are set to null (Nothing in Visual Basic), which means that a report’s XtraReportBase.DataSource and XtraReportBase.DataMember properties are used to obtain data fields for the expression.

To learn more, see Conditionally Changing a Control’s Appearance.

Example

This example demonstrates how to conditionally change a control’s appearance at runtime. For this, it is necessary to create an instance of the FormattingRule class, specify its FormattingRule.Condition and FormattingRule.Formatting properties and add this object to a report’s sheet of formatting rules (XtraReport.FormattingRuleSheet) and to the collection of formatting rules of a control or a band, to which it should be applied (XRControl.FormattingRules). Note that the same task can be also solved at design time, as described in the Conditionally Changing a Control’s Appearance topic.

Tip

Online Example: How to conditionally change control appearance

C#

using System.Drawing;
using System.Drawing.Printing;
using DevExpress.XtraReports.UI;
// ...

private void XtraReport1_BeforePrint(object sender, PrintEventArgs e) {
    // Create a new rule and add it to a report.
    FormattingRule rule = new FormattingRule();
    this.FormattingRuleSheet.Add(rule);

    // Specify the rule's properties.
    rule.DataSource = this.DataSource;
    rule.DataMember = this.DataMember;
    rule.Condition = "[UnitPrice] >= 30";
    rule.Formatting.BackColor = Color.WhiteSmoke;
    rule.Formatting.ForeColor = Color.IndianRed;
    rule.Formatting.Font = new Font("Arial", 10, FontStyle.Bold);

    // Apply this rule to the detail band.
    this.Detail.FormattingRules.Add(rule);
}

VB.NET

Imports System.Drawing
Imports System.Drawing.Printing
Imports DevExpress.XtraReports.UI
' ...

Private Sub XtraReport1_BeforePrint(ByVal sender As Object, ByVal e As PrintEventArgs) _
Handles MyBase.BeforePrint
    ' Create a new rule and add it to a report.
    Dim rule As New FormattingRule()
    Me.FormattingRuleSheet.Add(rule)

    ' Specify the rule's properties.
    rule.DataSource = Me.DataSource
    rule.DataMember = Me.DataMember
    rule.Condition = "[UnitPrice] >= 30"
    rule.Formatting.BackColor = Color.WhiteSmoke
    rule.Formatting.ForeColor = Color.IndianRed
    rule.Formatting.Font = New Font("Arial", 10, FontStyle.Bold)

    ' Apply this rule to the detail band.
    Me.Detail.FormattingRules.Add(rule)
End Sub

Related GitHub Examples

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

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_how-to-conditionally-change-control-appearance-e939/CS/XtraReport1.cs#L18

// Specify the rule's properties.
rule.DataSource = this.DataSource;
rule.DataMember = this.DataMember;

Reporting_how-to-conditionally-suppress-summary-footer-cell-painting-by-using-formatting-t211184/CS/dxSample/XtraReport1.cs#L17

FormattingRule rule = new FormattingRule();
rule.DataSource = DataSource;
rule.DataMember = DataMember;

VB.NET

Reporting_how-to-conditionally-change-control-appearance-e939/VB/XtraReport1.vb#L20

' Specify the rule's properties.
rule.DataSource = Me.DataSource
rule.DataMember = Me.DataMember

Reporting_how-to-conditionally-suppress-summary-footer-cell-painting-by-using-formatting-t211184/VB/dxSample/XtraReport1.vb#L19

Dim rule As New FormattingRule()
rule.DataSource = DataSource
rule.DataMember = DataMember