XLSCellAreas5: Class TBaseCellAreas

# Class TBaseCellAreas

Description | Hierarchy | Fields | Methods | Properties

## Unit

XLSCellAreas5

## Declaration

`type TBaseCellAreas = class(TObjectList)`

## Description

Virtual base class for objects that manipulates cell areas.

## Hierarchy

- TObjectList
- TBaseCellAreas

## Overview

### Methods

| `constructor Create;`
| `procedure Assign(Areas: TBaseCellAreas);`
| `function Add: TCellArea; overload;`
| `function Add(const ARef: AxUCString): TCellArea; overload;`
| `function Add(const AArea: PXLSCellArea): TCellArea; overload;`
| `function Add(const C,R: integer): TCellArea; overload;`
| `function Add(const C1,R1,C2,R2: integer): TCellArea; overload;`
| `procedure Add(const C1,R1,C2,R2: integer; AAreas: TBaseCellAreas); overload;`
| `function CellCount: integer;`
| `function TotExtent: TXLSCellArea;`
| `procedure NormalizeAll;`
| `function AreaInAreas(AArea: TCellArea): boolean; overload;`
| `function AreaInAreas(const Col1,Row1,Col2,Row2: integer): boolean; overload;`
| `function FindArea(const Col1,Row1,Col2,Row2: integer): integer; overload;`
| `function FindArea(const Col,Row: integer): integer; overload;`
| `function CellInAreas(const Col,Row: integer): integer;`
| `procedure Copy(const Col1,Row1,Col2,Row2: integer; const DeltaCol,DeltaRow: integer); virtual;`
| `procedure Delete(const Col1,Row1,Col2,Row2: integer); overload; virtual; abstract;`
| `function Include(const Col1,Row1,Col2,Row2: integer): TCellArea; virtual; abstract;`
| `procedure Move(const DeltaCol,DeltaRow: integer); overload; virtual; abstract;`
| `procedure Move(const Col1,Row1,Col2,Row2: integer; const DeltaCol,DeltaRow: integer); overload; virtual; abstract;`

### Properties

| `property Items[constIndex:integer]: TCellArea read GetItems;`
| `property Delimiter: AxUCChar read FDelimiter;`
| `property DelimitedText: AxUCString read GetDelimitedText write SetDelimitedText;`
| `property Tag: integer read FTag write FTag;`

## Description

### Methods

| `constructor Create;`
˜exclude

| `procedure Assign(Areas: TBaseCellAreas);`
Assigns a TBaseCellAreas to this areas.

| `function Add: TCellArea; overload;`
Add a new cell area. ˜result The added area.

| `function Add(const ARef: AxUCString): TCellArea; overload;`
Add a new cell area. ˜param C1 Left column. ˜param R1 Top row. ˜param C2 Right column. ˜param R2 Bottom row. ˜result The added area.

| `function Add(const AArea: PXLSCellArea): TCellArea; overload;`

| `function Add(const C,R: integer): TCellArea; overload;`

| `function Add(const C1,R1,C2,R2: integer): TCellArea; overload;`

| `procedure Add(const C1,R1,C2,R2: integer; AAreas: TBaseCellAreas); overload;`

| `function CellCount: integer;`

| `function TotExtent: TXLSCellArea;`
Returns the smallest area that all areas in the list fits in. ˜result The area.

| `procedure NormalizeAll;`
Normalizes (i.e. checks that C1 < C2 and R1 < R2).

| `function AreaInAreas(AArea: TCellArea): boolean; overload;`
Checks if an area intersects any of the areas. ˜param Col1 Left column. ˜param Row1 Top row. ˜param Col2 Right column. ˜param Row2 Bottom row. ˜result True if the area given by Col1,Row1,Col2,Row2 intersects any of the areas in the list.

| `function AreaInAreas(const Col1,Row1,Col2,Row2: integer): boolean; overload;`

| `function FindArea(const Col1,Row1,Col2,Row2: integer): integer; overload;`
Searches for an area that is equal to Col1,Row1,Col2,Row2. If a area is found, the index to the area is returned. If not found, -1 is returned. ˜param Col1 Left column. ˜param Row1 Top row. ˜param Col2 Right column. ˜param Row2 Bottom row. ˜result The index of the found area. If not found, -1 is returned.

| `function FindArea(const Col,Row: integer): integer; overload;`

| `function CellInAreas(const Col,Row: integer): integer;`
Check if a cell is in any of the areas. Returns the index of the area that the cell address given by Col and Row is within. If no match is found, -1 is returned. ˜param Col Column of the cell. ˜param Row Row of the cell. ˜result The index of the found area. If not found, -1 is returned.

| `procedure Copy(const Col1,Row1,Col2,Row2: integer; const DeltaCol,DeltaRow: integer); virtual;`
˜exclude

| `procedure Delete(const Col1,Row1,Col2,Row2: integer); overload; virtual; abstract;`
˜exclude

| `function Include(const Col1,Row1,Col2,Row2: integer): TCellArea; virtual; abstract;`
˜exclude

| `procedure Move(const DeltaCol,DeltaRow: integer); overload; virtual; abstract;`
˜exclude

| `procedure Move(const Col1,Row1,Col2,Row2: integer; const DeltaCol,DeltaRow: integer); overload; virtual; abstract;`
˜exclude

### Properties

| `property Items[constIndex:integer]: TCellArea read GetItems;`
The areas in the list.

| `property Delimiter: AxUCChar read FDelimiter;`

| `property DelimitedText: AxUCString read GetDelimitedText write SetDelimitedText;`

| `property Tag: integer read FTag write FTag;`

Generated by PasDoc 0.12.1 on 2013-03-18 12:36:47