Skip to main content

XRRichText.SaveFile(String, XRRichTextStreamType) Method

Saves the contents of the XRRichText control to the specified type of file.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

public void SaveFile(
    string path,
    XRRichTextStreamType streamType
)

Parameters

Name Type Description
path String

A String containing the name and location of the file to save the control’s contents to.

streamType XRRichTextStreamType

An XRRichTextStreamType enumeration value that defines the type of stream to use for saving the XRRichText control’s contents to a file.

Remarks

Using different types of streams allows a user to save the contents of the XRRichText control into different types of files. If a file pointed to by the path parameter already exists in the specified directory, it will be overwritten without warning.

Example

The following code snippet creates the XRRichText object, specifies certain properties, and saves its contents to a file.

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

public XRRichText CreateXRRichText(){
    // Create a Rich Text Box control.
    XRRichText xrRichText1 = new XRRichText();

    // Set automatic height calculation,
    // and make the borders visible.
    xrRichText1.CanGrow = true;
    xrRichText1.CanShrink = true;         
    xrRichText1.Borders = DevExpress.XtraPrinting.BorderSide.All;

    // Add lines of text to the document.
    // The XRRichText control converts an array of strings into paragraphs.
    string[] boxLines = new String[3];
    boxLines[0] = "Line 1";
    boxLines[1] = "Line 2";
    boxLines[2] = "Line 3";
    xrRichText1.Lines = boxLines;

    // Export XRRichText contents to Microsoft Office Word OpenXml format (DOCX).
    xrRichText1.SaveFile("output.docx", XRRichTextStreamType.XmlText);

    return xrRichText1;
}
See Also