VP Cell

Home

4D v19

VP Cell


VP Cell ( vpAreaName ; column ; row {; sheet} ) -> Function result

Parameter	Type	Description
vpAreaName	Text	4D View Pro area form object name
column	Longint	Column index
row	Longint	Row index
sheet	Longint	Sheet index (current sheet if omitted)
Function result	Object	Range object of a single cell

Description

The VP Cell command returns a new range object referencing a specific cell.

Note: This command is intended for ranges of a single cell. To create a range object for multiple cells, use the VP Cells command.

In vpAreaName, pass the name of the 4D View Pro area. If you pass a name that does not exist, an error is returned.

The column parameter defines the column of the cell range's position. Pass the column index (counting begins at 0) in this parameter.

The row parameter defines the row of the cell range's position. Pass the row index (counting begins at 0) in this parameter.

In the optional sheet parameter, you can designate a specific spreadsheet where the range will be defined (counting begins at 0). If omitted, the current spreadsheet is used by default. You can explicitly select the current spreadsheet with the following constant:

Constant	Type	Value	Comment
vk current sheet	Longint	-1	Designates current sheet of the 4D View Pro area (default)

Example

You want to define a range object for the cell shown below (on the current spreadsheet):

The code would be:

$cell:=VP Cell("ViewProArea";2;4) // C5