This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > %ZEN.Auxiliary.gridColumn


class %ZEN.Auxiliary.gridColumn extends %ZEN.Component.object

Defines characteristics for a column within a %ZEN.component.grid.

Property Inventory (Including Private)

Properties (Including Private)

property columnName as %ZEN.Datatype.string;
Logical name of column.
Property methods: columnNameDisplayToLogical(), columnNameGet(), columnNameIsValid(), columnNameLogicalToDisplay(), columnNameLogicalToOdbc(), columnNameNormalize(), columnNameSet()
property format as %ZEN.Datatype.string;
Format to apply to cells in this column.
This is a DeepSee format string: e.g., "###.##" Note that column format overrides row format.
Property methods: formatDisplayToLogical(), formatGet(), formatIsValid(), formatLogicalToDisplay(), formatLogicalToOdbc(), formatNormalize(), formatSet()
property hidden as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, this column is not displayed.
Property methods: hiddenDisplayToLogical(), hiddenGet(), hiddenIsValid(), hiddenLogicalToDisplay(), hiddenLogicalToOdbc(), hiddenLogicalToXSD(), hiddenNormalize(), hiddenSet(), hiddenXSDToLogical()
property label as %ZEN.Datatype.caption;
Label displayed for column. This overrides the value from a data controller.
Property methods: labelDisplayToLogical(), labelGet(), labelIsValid(), labelLogicalToDisplay(), labelLogicalToOdbc(), labelNormalize(), labelSet()
property logicalValue as %ZEN.Datatype.string (XMLPROJECTION = "none");
Optional. Default logical value used for this column. Used by DeepSee worksheets.
Property methods: logicalValueDisplayToLogical(), logicalValueGet(), logicalValueIsValid(), logicalValueLogicalToDisplay(), logicalValueLogicalToOdbc(), logicalValueNormalize(), logicalValueSet()
property lookupSpec as %ZEN.Datatype.string (XMLPROJECTION = "none");
Optional. Information on how to lookup values for this column. Used by DeepSee worksheets.
Property methods: lookupSpecDisplayToLogical(), lookupSpecGet(), lookupSpecIsValid(), lookupSpecLogicalToDisplay(), lookupSpecLogicalToOdbc(), lookupSpecNormalize(), lookupSpecSet()
property priority as %ZEN.Datatype.integer (MAXVAL = 2, MINVAL = 0) [ InitialExpression = 1 ];
Priority of this column.
This lets you control the precedence of column-based attributes (style, format, value). By default (when the priority values are equal) column-based attributes have precedence over row-based attributes. If the column has a higher or equal-valued priority, then it takes precedence.
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property readOnly as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, cells in this column are readOnly.
Property methods: readOnlyDisplayToLogical(), readOnlyGet(), readOnlyIsValid(), readOnlyLogicalToDisplay(), readOnlyLogicalToOdbc(), readOnlyLogicalToXSD(), readOnlyNormalize(), readOnlySet(), readOnlyXSDToLogical()
property style as;
Style to apply to cells in this column.
This is a CSS style string: e.g., "color: red;" Note that column style overrides row style.
Property methods: styleDisplayToLogical(), styleGet(), styleIsValid(), styleLogicalToDisplay(), styleLogicalToOdbc(), styleNormalize(), styleSet()
property title as %ZEN.Datatype.caption;
Help text displayed when mouse hovers over this column. Note that column title overrides row title.
Property methods: titleDisplayToLogical(), titleGet(), titleIsValid(), titleLogicalToDisplay(), titleLogicalToOdbc(), titleNormalize(), titleSet()
property type as %ZEN.Datatype.string (XMLPROJECTION = "none");
Optional. Type of cells in this column. Used by DeepSee worksheets.
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property value as %ZEN.Datatype.string;
Default value to apply to (empty) cells in this column.
This value is applied after the row value.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueListDisplayToLogical(), valueListGet(), valueListIsValid(), valueListLogicalToDisplay(), valueListLogicalToOdbc(), valueListNormalize(), valueListSet(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()
property valueList as %ZEN.Datatype.csv (XMLPROJECTION = "none");
Optional. If the column type is "enum", this is a csv list of allowed values. Used by DeepSee worksheets.
Property methods: valueListDisplayToLogical(), valueListGet(), valueListIsValid(), valueListLogicalToDisplay(), valueListLogicalToOdbc(), valueListNormalize(), valueListSet()
property width as %ZEN.Datatype.length;
Width of column.
Property methods: widthDisplayToLogical(), widthGet(), widthIsValid(), widthLogicalToDisplay(), widthLogicalToOdbc(), widthNormalize(), widthSet()

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window