GenericObject.ExportDataAsync Method (NxExportFileType, String, String, NxExportState, AsyncHandle)

GenericObjectExportDataAsync Method (NxExportFileType, String, String, NxExportState, AsyncHandle)

Exports the data of any generic object to an Excel file or a open XML file.

If the object contains excluded values, those excluded values are not exported.

Namespace: Qlik.Engine
Assembly: Qlik.Engine (in Qlik.Engine.dll) Version: 1.1.0.0 (1.1.0.0)

Syntax

public Task<string> ExportDataAsync(
	NxExportFileType fileType,
	string path = null,
	string fileName = null,
	NxExportState exportState = NxExportState.EXPORT_POSSIBLE,
	AsyncHandle asyncHandle = null
)

Public Function ExportDataAsync ( 
	fileType As NxExportFileType,
	Optional path As String = Nothing,
	Optional fileName As String = Nothing,
	Optional exportState As NxExportState = NxExportState.EXPORT_POSSIBLE,
	Optional asyncHandle As AsyncHandle = Nothing
) As Task(Of String)

Parameters

fileType: Type: Qlik.EngineNxExportFileType
Type of the file to export. This parameter is mandatory.
path (Optional): Type: SystemString
Path to the definition of the object to be exported. For example, /qHyperCubeDef. This parameter is mandatory if the file type is CSV_C or CSV_T.
fileName (Optional): Type: SystemString
Name of the exported file after download from browser. This parameter is optional.
exportState (Optional): Type: Qlik.EngineNxExportState
Defines the values to be exported. This parameter is optional. The default value is A.
asyncHandle (Optional): Type: Qlik.EngineAsyncHandle
Handle to asyncronous method request

Parameters

Return Value

Implements

Reference