IPrxTableIslands.RemoveByKey

Syntax

RemoveByKey(Key: Integer): Boolean;

Parameters

Key - key of a relational data area.

Description

The RemoveByKey method removes a relational data area by the specified key. If the removal is successful, the method returns True, otherwise it returns False.

Example

Sub Main;

Var

MB: IMetabase;

MObj : IMetabaseObject;

Report : IPrxReport;

TabIs : IPrxTableIslands;

Begin

MB := MetabaseClass.Active;

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

Report := MObj As IPrxReport;

TabIs := Report.TableIslands;

If TabIs.RemoveByKey(2) Then

Debug.WriteLine("Yes");

Else

Debug.WriteLine("No");

End If;

MObj.Save;

End Sub Main;

After executing the example the relational data area is removed, and the console window displays a message corresponding to the value returned by the method. Report - identifier of a regular report.