ControlBarView.remove

Syntax

remove (key: Number, isDispose: Boolean);

Parameters

key. Key of the control to be removed.

isDispose. Determines whether the removed element will be deleted: True - it will, False - it will not be deleted.

Description

The remove method removes a regular report element by its key.

Example

To execute this example, the HTML page must contain the ReportBox component named reportBox (see Example of the ReportBox Component Layout). Controls must be configured for the first sheet of the regular report. Remove the first control of the first report sheet:

        controlBar = reportBox.getDataView().getControlBar();
        ctrl = controlBar.getControlAt(0);
        key = controlBar.getSheetControls()[0].getMetadata().k;
        controlBar.remove(key);

After executing the example the first control in the first regular report sheet is removed.