TreeListExtension.ExportToDocx(TreeListSettings, TreeListVirtualModeCreateChildrenMethod, TreeListVirtualModeNodeCreatingMethod, String, Boolean, DocxExportOptions) Method

Exports the TreeList, which operates in virtual mode, to DOCX, 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 ExportToDocx(
    TreeListSettings settings,
    TreeListVirtualModeCreateChildrenMethod createChildrenMethod,
    TreeListVirtualModeNodeCreatingMethod nodeCreatingMethod,
    string fileName,
    bool saveAsFile,
    DocxExportOptions exportOptions
)

VB.NET

Public Shared Function ExportToDocx(
    settings As TreeListSettings,
    createChildrenMethod As TreeListVirtualModeCreateChildrenMethod,
    nodeCreatingMethod As TreeListVirtualModeNodeCreatingMethod,
    fileName As String,
    saveAsFile As Boolean,
    exportOptions As DocxExportOptions
) As ActionResult

Parameters

Name	Type	Description
settings	TreeListSettings	A TreeListSettings object that contains Tree List settings.
createChildrenMethod	TreeListVirtualModeCreateChildrenMethod	A delegate method of the TreeListVirtualModeCreateChildrenMethod type that enables you to create a list of business objects that correspond to the child nodes owned by the processed node.
nodeCreatingMethod	TreeListVirtualModeNodeCreatingMethod	A delegate method of the TreeListVirtualModeNodeCreatingMethod type that enables you to specify the node’s key value and cell values.
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	DocxExportOptions	A DocxExportOptions object that provides export options.

Returns

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