Skip to main content
Version: Next

VP Get column attributes

History
ReleaseChanges
19 R7Added

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

ParameterTypeDescription
vpAreaNameText->4D View Pro area form object name
tableNameText->Table name
columnInteger->Index of the column in the table
sheetInteger->Sheet index (current sheet if omitted)
ResultObject<-Attributes of the column

Description

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:

PropertyTypeDescription
dataFieldtextTable column's property name in the data context. Not returned if the table is displayed automatically
nametextTable column's name.
footerTexttextColumn footer value.
footerFormulatextColumn footer formula.
filterButtonVisiblebooleanTrue 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.

Example

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

See also

VP CREATE TABLE
VP Find table
VP SET TABLE COLUMN ATTRIBUTES
VP RESIZE TABLE