XRLabel.Multiline Property

Gets or sets a value specifying whether carriage returns (CRLF) stored in a label’s text should be processed.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

[SRCategory(ReportStringId.CatBehavior)]
[DefaultValue(false)]
public bool Multiline { get; set; }

VB.NET

<SRCategory(ReportStringId.CatBehavior)>
<DefaultValue(False)>
Public Property Multiline As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true if carriage returns should be processed; otherwise, false.

Remarks

Set this property’s value to true (process carriage returns) to display more than one line of text in the XRLabel control.

The following can be used as newline characters:

• NewLine.
• ControlChars.CrLf.
• vbCrLf (Visual Basic only).

Example

This example demonstrates how to create an XRLabel object, bind it to data and specify some of its properties. You should bind your report to the Products table of the Northwind database for this example to work properly.

To learn about the events available for a report and its controls, see Report Events.

C#

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

public partial class XtraReport1 : XtraReport {

    public XRLabel CreateXRLabel() {
        // Create a new label object.
        XRLabel label = new XRLabel();

        // Bind the label to the UnitPrice data field. 
        // Change the label's foreground color depending on the UnitPrice data field value.
        label.ExpressionBindings.AddRange(new ExpressionBinding[] {
        new ExpressionBinding("BeforePrint", "Text", "[UnitPrice]"),
        new ExpressionBinding("BeforePrint", "ForeColor", "Iif([UnitPrice]>20, \'Red\', \'Green\')")});

        // Apply a currency format to the label's text.
        label.TextFormatString = "{0:c2}";

        // Automatically adjust the label's width to its content.
        label.AutoWidth = true;

        // Align the label's text to the bottom right corner.
        label.TextAlignment = TextAlignment.BottomRight;

        return label;
    }

    public XtraReport1() {
        // ...
        // Add the label to the report's Detail band.
        XRLabel label = CreateXRLabel();
        this.Detail.Controls.Add(label);
    }
}

VB.NET

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

Public Partial Class XtraReport1
    Inherits XtraReport

    Public Function CreateXRLabel() As XRLabel
        ' Create a new label object.
        Dim label As New XRLabel()

        ' Bind the label to the UnitPrice data field. 
        ' Change the label's foreground color depending on the UnitPrice data field value.
        label.ExpressionBindings.AddRange(New ExpressionBinding() {
        New ExpressionBinding("BeforePrint", "Text", "[UnitPrice]"),
        New ExpressionBinding("BeforePrint", "ForeColor", "Iif([UnitPrice]>20, 'Red', 'Green')")})

        ' Apply a currency format to the label's text.
        label.TextFormatString = "{0:c2}"

        ' Automatically adjust the label's width to its content.
        label.AutoWidth = True

        ' Align the label's text to the bottom right corner.
        label.TextAlignment = TextAlignment.BottomRight

        Return label
    End Function

    Public Sub New()
        ' ...
        ' Add the label to the report's Detail band.
        Dim label As XRLabel = CreateXRLabel()
        Me.Detail.Controls.Add(label)
    End Sub
End Class

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Multiline 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-implement-a-custom-authorization-service-t488888/CS/AuthorizationService/Reports/CategoriesReport.cs#L392

this.xrLabel10.LocationFloat = new DevExpress.Utils.PointFloat(6F, 6F);
this.xrLabel10.Multiline = true;
this.xrLabel10.Name = "xrLabel10";

VB.NET

Reporting_how-to-implement-a-custom-authorization-service-t488888/VB/AuthorizationService/Reports/CategoriesReport.vb#L375

Me.xrLabel10.LocationFloat = New DevExpress.Utils.PointFloat(6.0!, 6.0!)
Me.xrLabel10.Multiline = True
Me.xrLabel10.Name = "xrLabel10"