4D Doc Center : PV Get document property

Home

4D View v14

PV Get document property


PV Get document property ( area ; option ) -> Function result

Parameter	Type	Description
area	Longint	4D View area
option	Longint	Property number
Function result	Longint	Property value

Description

The PV Get document property command returns the current value of the option parameter for the document in area.

The PV Document properties constants are used to define the option parameter:

Constant	Type	Value	Comment
pv column count	Longint	0	Allows setting or reading of the number of columns displayed in the area.
pv document modified	Longint	4	Allows setting or reading of the "modified" attribute of area. Associated values: pv value on or pv value off. When this constant is used in write mode ( PV SET DOCUMENT PROPERTY command), passing pv value on in the value parameter will cause a warning dialog box to be displayed when the area is closed indicating that it has been modified. If the value parameter contains pv value off, and if the document is not modified subsequently by the user or by programming, this dialog box does not appear. When this constant is used in read mode, using the PV Get document property command, the value returned is 1 if the document has been modified, and 0 otherwise.
pv no external call	Longint	3	Allows forbidding of calls to 4D variables, methods and commands in the formulas of the area. Associated values: pv value on or pv value off. pv value on: calls to 4D variables, methods and commands are forbidden in the formulas (in this case, it is possible to use “PV Allows Input” theme commands to define which 4D objects can be called). pv value off: calls to all 4D variables, methods and commands are allowed in the formulas (default value).
pv picture count	Longint	2	This constant is read-only ( PV Get document property command). It returns the number of pictures pasted into the area.
pv row count	Longint	1	Allows setting or reading of the number of rows displayed in the area.

Example

Build a method that updates variables containing both the number of columns and the number of rows of the 4D View area passed in the first parameter.

 C_LONGINT($ColNum) `Number of columns

 C_LONGINT($RowNum) `Number of rows

 C_LONGINT($PicNum) `Number of pictures

 

 $ColNum:=PV Get document property(Area;pv column coun)

 $RowNum:=PV Get document property(Area;pv row coun)

 $PicNum:=PV Get document property(Area;pv picture count)

 

 ALERT(" The 4D View area contains "+String($ColNum)+" column"+("s"*Num($ColNum>1))

 +" and "+String($RowNum)+" row"+("s"*Num($RowNum>1))

 +". It contains "+String($PicNum)+" picture"+("s"*Num($PicNum>1))+".")