XLSCellAreas5: Class TCellArea

# Class TCellArea

Description | Hierarchy | Fields | Methods | Properties

## Unit

XLSCellAreas5

## Declaration

`type TCellArea = class(TObject)`

## Description

Represents a cell area.

## Hierarchy

- TObject
- TCellArea

## Overview

### Methods

| `procedure Normalize;`
| `procedure Assign(Source: TCellArea);`
| `procedure SetSize(const C,R: integer); overload;`
| `procedure SetSize(const C1,R1,C2,R2: integer); overload;`
| `function InArea(const C1,R1,C2,R2: integer): boolean;`
| `function CornerInArea(const C1,R1,C2,R2: integer): boolean; overload;`
| `function CornerInArea(AArea: TCellArea): boolean; overload;`
| `function CellCount: integer;`
| `function CellInArea(const Col,Row: integer): boolean;`
| `function Equal(const C1,R1,C2,R2: integer): boolean;`

### Properties

| `property AsRecArea: TXLSCellArea read GetAsRecArea write SetAsRecArea;`
| `property Edges[constCol,Row:integer]: TCellEdges read GetEdges;`
| `property Col1: integer read GetCol1 write SetCol1;`
| `property Row1: integer read GetRow1 write SetRow1;`
| `property Col2: integer read GetCol2 write SetCol2;`
| `property Row2: integer read GetRow2 write SetRow2;`
| `property AsString: AxUCString read GetAsString;`
| `property Id: integer read FId;`
| `property Obj: TObject read FObject write FObject;`

## Description

### Methods

| `procedure Normalize;`
Normalizes the area; Checks so that Col1 <= Col2 and Row1 <= Row2.

| `procedure Assign(Source: TCellArea);`
Assignes another TCellArea to this area. ˜param Source The source TCellArea.

| `procedure SetSize(const C,R: integer); overload;`
Sets the size of the area. Same as setting the ˜[link Col1], ˜[link Row1], ˜[link Col2] and ˜[link Row2] properties. ˜param C1 Left column. ˜param R1 Top row. ˜param C2 Right column. ˜param R2 Bottom row.

| `procedure SetSize(const C1,R1,C2,R2: integer); overload;`

| `function InArea(const C1,R1,C2,R2: integer): boolean;`
True if the area is fully inside C1,R1,C2,R2.

| `function CornerInArea(const C1,R1,C2,R2: integer): boolean; overload;`
True if any of the area corners is inside C1,R1,C2,R2.

| `function CornerInArea(AArea: TCellArea): boolean; overload;`

| `function CellCount: integer;`

| `function CellInArea(const Col,Row: integer): boolean;`
Check if a position is in the area. ˜param Col Column of the porition. ˜param Row Row of the porition. ˜result True if the cell is in the area.

| `function Equal(const C1,R1,C2,R2: integer): boolean;`
Tests if an area is equal to the coordinates of this area. ˜param C1 Left column of the test area. ˜param R1 Top row of the test area. ˜param C2 Right column of the test area. ˜param R2 Bottom row of the test area. ˜result True is the areas are equal.

### Properties

| `property AsRecArea: TXLSCellArea read GetAsRecArea write SetAsRecArea;`
Returns the coordinates of the area as an TRecCellArea object.

| `property Edges[constCol,Row:integer]: TCellEdges read GetEdges;`
Returns the edges in the area that the position given by Col and Row borders to. Col and Row must be inside the area.

| `property Col1: integer read GetCol1 write SetCol1;`
First column in the area.

| `property Row1: integer read GetRow1 write SetRow1;`
First row in the area.

| `property Col2: integer read GetCol2 write SetCol2;`
Last column in the area.

| `property Row2: integer read GetRow2 write SetRow2;`
Last row in the area.

| `property AsString: AxUCString read GetAsString;`

| `property Id: integer read FId;`

| `property Obj: TObject read FObject write FObject;`

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