Version: Next

VP Get column attributes

History

Release	Changes
19 R7	Added

VP Get table column attributes ( vpAreaName : Text ; tableName : Text ; column : Integer {; sheet : Integer } ) : Object

Parameter	Type		Description
vpAreaName	Text	->	4D View Pro area form object name
tableName	Text	->	Table name
column	Integer	->	Index of the column in the table
sheet	Integer	->	Sheet index (current sheet if omitted)
Result	Object	<-	Attributes of the column

The VP Get table column attributes command returns the current attributes of the specified column in the tableName.

In vpAreaName, pass the name of the 4D View Pro area.

In sheet, pass the index of the target sheet. If no index is specified or if you pass -1, the command applies to the current sheet.

Indexing starts at 0.

The command returns an object describing the current attributes of the column:

Property	Type	Description
dataField	text	Table column's property name in the data context. Not returned if the table is displayed automatically
name	text	Table column's name.
footerText	text	Column footer value.
footerFormula	text	Column footer formula.
filterButtonVisible	boolean	True if the table column's filter button is displayed, False otherwise.

If tableName is not found or if column index is higher than the number of columns, the command returns null.

var $attributes : Object
$attributes:=VP Get table column attributes("ViewProArea"; $tableName; 1)
If ($attributes.dataField#"")
     ...
End if