ColsMeta object

Previous Next

This object contains a collection of columns and can be used the extract the meta data of a column.

When calling $.udb(), you can refer to columns with arrays or simple strings, using the selection techniques below:

 

 

collapseSelecting by column ID

A column ID is the combination of a '$' symbol and a number. Refer to it simply by using the column ID itself:

column-id
collapseSelecting by name

A column name is the name defined for the column in USoft Web Designer. If the column is in the current data source, refer to it simply by using the column name itself:

column-name

 

If the column is in an embedded data source, refer to it by naming the embedded data source, followed by a forward slash ('/'), followed by the column name:

embedded-data-source-name / column-name
collapseSelecting by column type

You can select a column by its type, using one of the meta selectors listed here. You cannot combine these meta selectors with other ways of selecting columns.

Meta selector

Columns selected

:key

All key columns

:mandatory

All mandatory columns

Functions

This object exposes the following functions:

Function

Description

.alias()

Function that returns the alias of a column.

.altInputFormats()

Function that returns the alternative input formats of a column.

.defValue()

Function that returns the default value of a column.

.displayLength()

Function that returns the default value of a column.

.domain()

Function that returns the domain name of the column

.getForeignKey()

Function that returns the foreign key information of the lookup column, or undefined if its data source is not a lookup data source

.ioFormat()

Function that returns the IO format of the first item.

.isEmbeddedColumn()

Function that returns true if the first item is of an embedded data source.

.isGroupBy()

Function that returns true if the column is part of a GROUP BY clause, false if not

.isInputAllowed()

Function that returns whether the user may enter input for the first column in the collection

.isKey()

Function that returns true if the column is a key column, false if not

.isMandatory()

Function that returns whether a column is mandatory.

.isPrimaryKey()

Function that returns true if the column is a primary key column (and not part of a relation object), false if not

.isUpdatable()

Function that returns whether a column is updatable.

.label()

Function that returns the label of a column.

.name()

Function that returns the name of a column.

.sortOrder()

Function that returns, sets or removes a sort definition.

.type()

Function that returns the type of the column

.valueList()

Function that returns the allowed values of the column