1C:Enterprise | 1C:Enterprise Developer's Community

SpreadsheetDocument.Area

Syntax variant: By name

Syntax:

Area(<AreaName>)

Parameters:

<AreaName> (required)

Type: String.
Area name or address in "R1C1:R2C2" format where a number that follows "R" denotes a row number, while a number after "C" denotes a column number by ":" symbol (colon) coordinates of the left-hand top and right-hand bottom area corner are divided. You can also transfer overlapping of two areas as a name that is written as "<Area Name 1> | <Area Name 2>".

Syntax variant: By address

Syntax:

Area(<FirstRowNumber>, <FirstColumnNumber>, <LastRowNumber>, <LastColumnNumber>)

Parameters:

<FirstRowNumber> (optional)

Type: Number.
Number of the first table area row.
If there is no such row, then an area consisting of columns is specified.

<FirstColumnNumber> (optional)

Type: Number.
Number of the first table area column.
If there is no such column, then an area consisting of rows is specified.

<LastRowNumber> (optional)

Type: Number.
Number of the last table area row.
If an area of columns is selected (the <FirstRowNumber> parameter is not specified), then number of row, from which the string format is obtained, is specified.

<LastColumnNumber> (optional)

Type: Number.
Number of the last table area column.

Description of method variant:

If there is no the last row and the last column the area is set by the single cell. If there are no rows or columns the area is set by the range of rows or columns, respectively. If the method is called without parameters, the area is set by the whole table.

Returned value:

Type: SpreadsheetDocumentRange; SpreadsheetDocumentDrawing.

Description:

Obtains a spreadsheet document area as either spreadsheet document cells area or as a picture with a specified name. An area may be composed of several adjoining rows or columns, or can be a rectangular table area.

Availability:

Thin client, web-client, server, thick client, external connection, Mobile application (client), Mobile application (server).

Example:

CalledArea = Spreadsheet.Area("Header");
Cell = Spreadsheet.Area("R2C5");
RectangularAreaOfCells = Spreadsheet.Area("R2C2:R3C5");
RowArea = Spreadsheet.Area("R2");
RowsArea = Spreadsheet.Area("R2:R4");
ColumnArea = Spreadsheet.Area("C4");
ColumnsArea = Spreadsheet.Area("C4:C5");