Skip to content
pCon.configurator onlineDocumentation
Esc
↑↓navigate↵open⌘Jpreview
On this page

BasketColumn

Synopsis

struct BasketColumn {
    string name,
    string title,
    string defaultValue
    string id,
    ColumnType type,
    BasketItemAttrId itemAttrId,
    boolean removable,
    boolean editable,
    string defaultColumn,
    int minWidth,
    double weight,
    boolean readOnly
}

See also: ColumnType, BasketItemAttrId

This complex type describes a single basket column. It has the following attributes and elements:

id (attribute)

The UUID that identifies the column. Predefined columns always have the same ID. See BasketItemAttrId (§BasketItemAttrId) for the values of predefined column IDs.

type (attribute)

The type of user-defined columns, or Builtin for predefined columns.

itemAttrId (attribute)

Type of predefined columns, or UserDefined for user-defined columns.

removable (attribute)

True if the column can be removed with operation removeBasketColumns (§removeBasketColumns)

editable (attribute)

True if the column configuration can be changed with operation setBasketColumnProperties (§setBasketColumnProperties)

defaultColumn (attribute)

The ID of a column that provides the default value for this column

minWidth (attribute)

Exists for P-BK compatibility; In P-BK, this property contains the minimum width of the article table column in pixel. If used by other applications, the value should be interpreted relative to the font size used in the article table. The actual column width should be chosen so it allows display of about the same number of characters as an 8 point Arial font assuming 96 DPI and the given number of pixels.

weight (attribute)

Exists for P-BK compatibility; In P-BK, the value of this property determines the initial width of columns relative to each other.

readOnly (attribute)

True if the column is read-only (i.e. operations setItemFields (§setItemFields) and resetItemFields (§resetItemFields) cannot be used with this column)

name (element)

The name of the column

title (element)

The title of the column to be displayed in the header of the article table

defaultValue (element)

Optional default value. Default values may contain variable references. See description of complex type ItemField (§ItemField) for more information about variable references.

Except for the id attribute, all attributes and elements are optional. For more information, see documentation of operations getBasketColumns (§getBasketColumns), addBasketColumns (§addBasketColumns), and setBasketColumnProperties (§setBasketColumnProperties).