XRRichText.Rtf Property

Bindable. Gets or sets the text of the XRRichText control, including all the Rich Text Format (RTF) codes.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public override string Rtf { get; set; }

VB.NET

Public Overrides Property Rtf As String

Property Value

Type	Description
String	A String value which represents the control’s text in RTF format.

Remarks

The Rtf property can be used to set the RTF formatted text displayed in the control or to get the RTF formatted text in the XRRichText control.

Note

The Rtf property is bindable, which means that it can be bound to a data field in a report’s data source. To learn more, see the Binding Report Controls to Data section.

Note

When the Rtf property is bound to a data field, the control’s content is obtained from the data source with all text formatting. So, changes applied to the text formatting at the control’s level aren’t in effect.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Rtf 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-an-editor-for-the-xrrichtext-with-dragdrop-from-the-field-list-e526/CS/CustomControlDesigner.cs#L35

frm.richTextBox1.Rtf = (this.Component as XRRichText).Rtf;
frm.Owner = (this.ReportDesigner.RootReport.Tag as System.Windows.Forms.Form);

Reporting_how-to-create-a-report-from-a-text-document-via-richeditdocumentserver-e4489/CS/CreateReportFromRichEdit/Form1.cs#L38

using (XtraReport1 report = new XtraReport1()) {
    report.RichText.Rtf = reds.RtfText;
    report.ShowPreviewDialog();

Reporting_how-to-display-values-of-several-rtf-fields-in-a-single-xrrichtext-control-e3416/CS/XtraReport1.cs#L25

    xrRichText1.Rtf = richEditDocumentServer.RtfText;
}

reporting-winforms-change-formatting-xrrichtext-rtf-content/CS/XtraReport1.cs#L30

    ApplyRTFModification(richEditDocumentServer);
    xrRichText1.Rtf = richEditDocumentServer.RtfText;
}

Reporting_how-to-load-an-rtf-file-into-the-documentpreview-e4464/CS/MinimalisticReportPreviewDemo/MainWindow.xaml.cs#L22

Report report = new Report();
report.xrRichText1.Rtf = File.ReadAllText(ofd.FileName);

VB.NET

Reporting_how-to-implement-an-editor-for-the-xrrichtext-with-dragdrop-from-the-field-list-e526/VB/CustomControlDesigner.vb#L37

frm.richTextBox1.Rtf = (TryCast(Me.Component, XRRichText)).Rtf
frm.Owner = (TryCast(Me.ReportDesigner.RootReport.Tag, System.Windows.Forms.Form))

Reporting_how-to-create-a-report-from-a-text-document-via-richeditdocumentserver-e4489/VB/CreateReportFromRichEdit/Form1.vb#L40

Using report As New XtraReport1()
    report.RichText.Rtf = reds.RtfText
    report.ShowPreviewDialog()

Reporting_how-to-display-values-of-several-rtf-fields-in-a-single-xrrichtext-control-e3416/VB/XtraReport1.vb#L28

    xrRichText1.Rtf = richEditDocumentServer.RtfText
End Sub

reporting-winforms-change-formatting-xrrichtext-rtf-content/VB/XtraReport1.vb#L31

    ApplyRTFModification(richEditDocumentServer)
    xrRichText1.Rtf = richEditDocumentServer.RtfText
End Sub

Reporting_how-to-load-an-rtf-file-into-the-documentpreview-e4464/VB/MinimalisticReportPreviewDemo/MainWindow.xaml.vb#L24

Dim report As New Report()
report.xrRichText1.Rtf = File.ReadAllText(ofd.FileName)