IChartCorridors.Remove

Syntax

Remove(Index: Integer): Boolean;

Parameters

Index. Corridor index in the collection. Numeration starts from zero.

Description

The Remove property allows to delete a specified corridor from a chart. The property returns the True value, if the corridor has been successfully removed. If not, the property returns False.

Example

To execute this example, there should be a regular report sheet with a bar chart on it. The chart should have corridors specified.

Sub Cor;

Var

ActiveReport: IPrxReport;

Sheet: IPrxSheet;

PrxTable: IPrxTable;

TabSheet: ITabSheet;

C: IChart;

Corridor: IChartCorridors;

R: Boolean;

Begin

ActiveReport := PrxReport.ActiveReport;

Sheet := ActiveReport.Sheets.Item(0);

PrxTable := Sheet As IPrxTable;

TabSheet := PrxTable.TabSheet;

C := TabSheet.Objects.Item(0).Extension As IChart;

Corridor := C.Corridors;

R := Corridor.Remove(0);

End Sub Cor;

After executing the example the first corridor is to be removed from the chart. The R variable contains the result of deletion.

See also:

IChartCorridors