class sap.ui.export.ExportBase

Control sample: sap.ui.export.ExportBase
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/export/ExportBase
Application Component: CA-UI5-TBL

Constructor

new sap.ui.export.ExportBase()

Events Overview

Event Description
beforeExport

The beforeExport event is fired just before the export process is started.

Since: 1.96.

beforeExport

The beforeExport event is fired just before the export process is started.

Since: 1.96.

Param Type Description
oEvent sap.ui.base.Event
getSource sap.ui.base.EventProvider
getParameters object

Methods Overview

Method Description
attachBeforeExport

Attaches event handler fnFunction to the sap.ui.export.ExportBase#event:beforeExport event of this sap.ui.export.ExportBase.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.export.ExportBase itself.
This event is fired just before the export process is started.

build

Triggers the export process of the specific format.

cancel

Cancels the current export process.

detachBeforeExport

Detaches event handler fnFunction from the sap.ui.export.ExportBase#event:beforeExport event of this sap.ui.export.ExportBase.
The passed function and listener object must match the ones used for event registration.

sap.ui.export.ExportBase.extend

Creates a new subclass of class sap.ui.export.ExportBase with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.EventProvider.extend.

sap.ui.export.ExportBase.getMetadata

Returns a metadata object for class sap.ui.export.ExportBase.

processDataSource

Sets the data source configuration that will be used for exporting the data. If the passed parameter is null, the call will be ignored.

attachBeforeExport

Attaches event handler fnFunction to the sap.ui.export.ExportBase#event:beforeExport event of this sap.ui.export.ExportBase.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.export.ExportBase itself.
This event is fired just before the export process is started.

Param Type DefaultValue Description
oData object

An application-specific payload object that will be passed to the event handler along with the event object when firing the event

fnHandler function

The function to be called when the event occurs

oListener object

Context object to call the event handler with. Defaults to the sap.ui.export.ExportBase instance itself

build

Triggers the export process of the specific format.

cancel

Cancels the current export process.

detachBeforeExport

Detaches event handler fnFunction from the sap.ui.export.ExportBase#event:beforeExport event of this sap.ui.export.ExportBase.
The passed function and listener object must match the ones used for event registration.

Param Type DefaultValue Description
fnHandler function

The function to be called when the event occurs

oListener object

Context object on which the given function had to be called

sap.ui.export.ExportBase.extend

Creates a new subclass of class sap.ui.export.ExportBase with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.base.EventProvider.extend.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

sap.ui.export.ExportBase.getMetadata

Returns a metadata object for class sap.ui.export.ExportBase.

processDataSource

Sets the data source configuration that will be used for exporting the data. If the passed parameter is null, the call will be ignored.

Param Type DefaultValue Description
oDataSource Object sap.ui.model.ListBinding sap.ui.model.TreeBinding

Possible types are a data source configuration, a sap.ui.model.ListBinding or sap.ui.model.TreeBinding