IChartCorridors.Remove

Syntax

Remove(Index: Integer): Boolean;

Parameters

Index. Index of corridor in the collection. Numbering starts with zero.

Description

The Remove property enables the user to remove the specified chart corridor. The property returns the True if the corridor has been successfully removed, and False if not.

Example

Executing the example requires a regular report sheet with a line chart on it. The chart must 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 must be removed from the chart. The R variable contains the result of removal.