GridViewExtension.ExportToRtf(GridViewSettings, Object, String, Boolean, RtfExportOptions) Method

Exports the grid’s data to RTF format, based on the provided settings.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v24.1.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public static ActionResult ExportToRtf(
    GridViewSettings settings,
    object dataObject,
    string fileName,
    bool saveAsFile,
    RtfExportOptions exportOptions
)

VB.NET

Public Shared Function ExportToRtf(
    settings As GridViewSettings,
    dataObject As Object,
    fileName As String,
    saveAsFile As Boolean,
    exportOptions As RtfExportOptions
) As ActionResult

Parameters

Name	Type	Description
settings	GridViewSettings	A GridViewSettings object that contains GridView settings.
dataObject	Object	An object representing the GridView’s data source.
fileName	String	A String value that specifies the target file name.
saveAsFile	Boolean	true to display the File Download dialog; false to display the file with exported data within a page.
exportOptions	RtfExportOptions	A RtfExportOptions object that provides export options.

Returns

Type	Description
ActionResult	A ActionResult encapsulating the result of the grid data export operation.

Remarks

DevExpress controls require the DevExpress.RichEdit.v24.1.Export.dll library to export their content to DOCX or RTF format.