IPrxDataIslands.RemoveByKey

Syntax

RemoveByKey(Key: Integer): Boolean;

Parameters

Key - data area key.

Description

The RemoveByKey method removes a data area based on its key. Data area key is passed using the Key parameter.

Example

Sub Main;

Var

MB: IMetabase;

MObj: IMetabaseObject;

Report: IPrxReport;

DIs: IPrxDataIslands;

s: String;

Begin

MB := MetabaseClass.Active;

MObj := MB.ItemById("Report").Edit;

Report := MObj As IPrxReport;

DIs := Report.DataIslands;

If DIs.RemoveByKey(3) Then

s:="Remove";

Else

s:="Don't remove";

End If;

MObj.Save;

End Sub Main;

After executing the example the "s" variable contains "Remove" if the data area of the regular report with the 3 identifier has been successfully removed. The identifier of the regular report - Report.