XRRichText.SaveFile(String) Method

Saves the contents of the XRRichText control to a Rich Text Format (RTF) file.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

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

Declaration

C#

public void SaveFile(
    string path
)

VB.NET

Public Sub SaveFile(
    path As String
)

Parameters

Name	Type	Description
path	String	A String containing a path to the file, which the contents of the XRRichText control will be saved to.

Remarks

This method enables a user to save the entire contents of the control to an RTF file that can be used by other programs such as Microsoft Word and Windows WordPad. If a file pointed to by the path parameter already exists in the specified directory, the existing file will be overwritten without warning.

Example

The following method demonstrates how to create an XRRichText object, set some of its properties, and then save its contents to a text file.

C#

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

public XRRichText CreateXRRichText(){
    // Create an XRRichText object.
    XRRichText xrRichText1 = new XRRichText();

    // Set its height to be calculated automatically,
    // and make its borders visible.
    xrRichText1.CanGrow = true;
    xrRichText1.CanShrink = true;         
    xrRichText1.Borders = DevExpress.XtraPrinting.BorderSide.All;

    // Create an array of lines and assign it to the rich text.
    string[] boxLines = new String[3];
    boxLines[0] = "Line 1";
    boxLines[1] = "Line 2";
    boxLines[2] = "Line 3";
    xrRichText1.Lines = boxLines;

    // Export its contents to a text file.
    xrRichText1.SaveFile("output.txt", XRRichTextStreamType.PlainText);

    return xrRichText1;
}

VB.NET

Imports System
Imports DevExpress.XtraReports.UI
' ...

Public Function CreateXRRichText() As XRRichText
    ' Create an XRRichText object.
    Dim XrRichText1 As New XRRichText()

    ' Set its height to be calculated automatically,
    ' and make its borders visible.
    XrRichText1.CanGrow = True
    XrRichText1.CanShrink = True 
    XrRichText1.Borders = DevExpress.XtraPrinting.BorderSide.All

    ' Create an array of lines and assign it to the rich text.
    Dim BoxLines() As String = New String(2) {}
    BoxLines(0) = "Line 1"
    BoxLines(1) = "Line 2"
    BoxLines(2) = "Line 3"
    XrRichText1.Lines = BoxLines

    ' Export its contents to a text file.
    XrRichText1.1SaveFile("output.txt", XRRichTextStreamType.PlainText)

    Return XrRichText1
End Function