4D View v14

PV Get range property

Home

 
4D View v14
PV Get range property

PV Get range property 


 

PV Get range property ( area ; left ; top ; right ; bottom ; property ) -> Function result 
Parameter Type   Description
area  Longint in 4D View area
left  Longint in Left cell column number
top  Longint in Top cell row number
right  Longint in Right cell column number
bottom  Longint in Bottom cell row number
property  Longint in Property number
Function result  Longint in 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 :

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:

PropertyValue/Constant returned if mixed selection
pv style format alpha65535 (pv value format mixed)
pv style format num65535 (pv value format mixed)
pv style format bool65535 (pv value format mixed)
pv style format date time65535 (pv value format mixed)
pv style format picture65535 (pv value format mixed)
pv style color back even65535 (pv value format mixed)
pv style color back odd65535 (pv value format mixed)
pv style color text even65535 (pv value format mixed)
pv style color text odd65535 (pv value format mixed)
pv style color zero even65535 (pv value format mixed)
pv style color zero odd65535 (pv value format mixed)
pv style hor alignment255 (pv value hor alignment mixed)
pv style vert alignment255 (pv value vert alignment mixed)
pv style rotation255 (pv value rotation mixed)

Example  

See the example for the PV Get cell property command.

 
PROPERTIES 

Product: 4D View
Theme: PV Cell property
Number: 15924

 
HISTORY 

Created: 4D View 6.8

 
SEE ALSO 

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

 
ARTICLE USAGE

4D View Language ( 4D View v11.4)
4D View Language ( 4D View v12)
4D View Language ( 4D v13)
4D View Language ( 4D View v14 R2)
4D View Language ( 4D View v14)
4D View Language ( 4D View v14 R3)
4D View Language ( 4D View v14 R4)