XRRichText.SaveFile(Stream, XRRichTextStreamType) Method

Saves the contents of the XRRichText control to the specified open data stream.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

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

Declaration

C#

public void SaveFile(
    Stream data,
    XRRichTextStreamType streamType
)

VB.NET

Public Sub SaveFile(
    data As Stream,
    streamType As XRRichTextStreamType
)

Parameters

Name	Type	Description
data	Stream	A Stream of data to which the contents of the XRRichText control will be saved.
streamType	XRRichTextStreamType	An XRRichTextStreamType enumeration value that identifies the type of stream to save the control’s contents to.

Remarks

Different types of streams can be used to save a control’s contents, which can then save the data to different types of files.

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