The requested page is not available for the requested platform. You are viewing the content for Default platform.

Formatting Class

A container of values, which are applied to a control when its owner Formatting Rule's condition is true.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

Declaration

public class Formatting :
    XRControlStyle
Public Class Formatting
    Inherits XRControlStyle

Remarks

The formatting which is defined by the current formatting rule is specified by its FormattingRule.Formatting property. The Formatting object, which is returned by this property, contains a set of appearance options (e.g. BackColor, ForeColor, Font, etc.), as well as the Formatting.Visible property, that can be used to conditionally suppress report elements.

Note

If any of the Formatting object's properties is not set, the corresponding property of a control isn't changed when this formatting rule is applied.

For more information on using this property, refer to Conditionally Changing a Control's Appearance.

Note

Formatting rules are only available in the legacy binding mode (when the UserDesignerOptions.DataBindingMode is set to DataBindingMode.Bindings). See Shaping Data using Expression Bindings to learn about the recommended approach to shaping report data.

Examples

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.

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);
}

Inheritance

See Also