Command PV Get range property

PV Get range property

version 6.8

PV Get range property (area; left; top; right; bottom; property) Longint

Parameter	Type		Description
area	Longint		4D View area
left	Longint		Left cell column number
top	Longint		Top cell row number
right	Longint		Right cell column number
bottom	Longint		Bottom cell row number
property	Longint		Property number

Function result Longint Property value

The PV Get range property command returns the value of the property for the selected cells defined using left, top, right and bottom parameters. For more information on cell ranges, refer to the PV Selection, Introduction section.

To define the property parameter, use the constants of the PV Style properties and PV Cell properties themes. For more information on these constants, see the description of the PV SET RANGE PROPERTY command.

For some properties, the PV Get range property may return the values 65535 or 255, which correspond to the "mixed" type constants of the PV Style values theme.

For instance, the statement :

   $value:=PV Get range property(area; column; row; pv style color back even) 

will return 65535 if the cells of the even-numbered rows in the range do not all have the same background color. This value corresponds to the pv value format mixed constant of the PV Style values theme. If the cells of the even-numbered rows in the range all have the same background color, the actual color number is returned.

This principle applies to the following properties:

See the example for the PV Get cell property command.

PV Get cell property, PV SET CELL PROPERTY, PV SET RANGE PROPERTY.

PV Style properties and PV Cell properties themes.