ASPxClientCustomizeExportOptionsEventArgs.GetExportOptionsModel(Object) Method

Returns the export options model for the specified export format.

Namespace: DevExpress.XtraReports.Web.Scripts

Assembly: DevExpress.XtraReports.v18.2.Web.Scripts.dll

Declaration

C#

public object GetExportOptionsModel(
    object format
)

VB.NET

Public Function GetExportOptionsModel(
    format As Object
) As Object

Parameters

Name	Type	Description
format	Object	An object that specifies the export format whose model should be returned.

Returns

Type	Description
Object	An export options model.

Remarks

You can use the obtained model to customize various export options, for instance, change a specific option’s default value.

ASPX

<script type="text/javascript">
    function customizeExportOptions(s, e) {
        var model = e.GetExportOptionsModel(DevExpress.Report.Preview.ExportFormatID.XLS);
        model.exportHyperlinks(false);
    }
</script>

<dx:ASPxWebDocumentViewer ID="ASPxWebDocumentViewer1" runat="server">
    <ClientSideEvents CustomizeExportOptions="customizeExportOptions"/>
</dx:ASPxWebDocumentViewer>

To pass a required format to this method, use the DevExpress.Report.Preview.ExportFormatID enumeration values: CSV, DOCX, HTML, Image, MHT, PDF, RTF, Text, XLS or XLSX.