ASPxClientCustomizeExportOptionsEventArgs.HideFormat(Object) Method

Hides the specified export format from the Export To drop-down list and the corresponding category from the Export Options panel.

Namespace: DevExpress.XtraReports.Web.Scripts

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

Declaration

C#

public void HideFormat(
    object format
)

VB.NET

Public Sub HideFormat(
    format As Object
)

Parameters

Name	Type	Description
format	Object	An object that specifies the export format to hide.

Remarks

The following code snippet demonstrates how to use this method in the ASPxClientWebDocumentViewer.CustomizeExportOptions event handler.

ASPX

<script type="text/javascript">
    function customizeExportOptions(s, e) {
        e.HideFormat(DevExpress.Report.Preview.ExportFormatID.XLS); 
    }
</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.