Grid Column (PRIM_GDCL)
Defines the data class and behavior of a column in a grid
Ancestors - Object (PRIM_OBJT)
Details
A column defines the data class and appearance of data in a list. Columns control the sort order, caption, column headings and many other visual features of the control. Lists are comprised of one or more columns, each using a diffent repository field as the source.
Example
Setting a column to be the primary sort.
#Column.SortPosition := 1
Properties
| Name | Description |
|---|---|
| Caption | Text to be displayed in the column heading |
| CaptionAlign | CaptionAlign determines the position of caption |
| CaptionText | Text as displayed in the column caption at runtime |
| CaptionType | CaptionType determines the type of caption |
| Cell | Reference to a cell in the column |
| CellReadOnly | Determines when the cell will allow user input |
| ColumnAlign | Alignment of the contents of the column |
| ComponentClassName | ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) |
| ComponentMembers | ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) |
| ComponentPatternName | ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) |
| ComponentTag | Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) |
| ComponentType | ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) |
| ComponentTypeName | ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) |
| DataClass | Reference to a repository field or fundamental product data class used to control data entry |
| DisplayAppearance | Specifies how the column will be displayed when readonly with reference to the visualizations of the column source field |
| DisplayPosition | DisplayPosition determines the order of columns in the list |
| EditAppearance | Specifies how the column will be displayed when updating with reference to the visualizations of the column source field |
| Editor | Reference to the editor manager used by the grid to manage a reusable part |
| EditorPart | Reference to a resuable part used to edit the column |
| EnsureVisible | Scroll a list so that the item is within the visible area |
| Focus | True if this item is the focus item in the list |
| Hint | Hint is a brief description for component |
| Image | Repository enrolled image to show in the control |
| MinimumWidth | MinimumWidth sets the minimum width of a column |
| Name | Name identifies the component Inherited from Object (PRIM_OBJT) |
| Owner | Owner owns this component Inherited from Object (PRIM_OBJT) |
| Parent | The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances |
| PopupMenu | Reference to a popup menu shown on a right click |
| Position | The position of the column as a member component of the grid. Visual position is controlled by DisplayPosition |
| ReadOnly | ReadOnly controls whether the column can be used for input |
| RowAlign | Alignment of the cell content within the column |
| Selected | True if this item is currently selected |
| SelectOnClick | SelectOnClick controls whether the column is selected |
| SortAsColumn | Specifies an alternate column to use to sort the data |
| SortDirection | SortDirection controls how list is sorted |
| SortOnClick | Sort the column when the column header is clicked |
| SortPosition | SortPosition determines the place of this column in the sort order |
| SortType | SortType controls how a column is sorted. |
| Source | Name of the repository field used to define and store the data for this column |
| TabStop | TabStop controls the use of TAB key |
| UsePicklist | Controls whether the values in the picklist are enforced |
| ValueAt | Value at the specified location |
| Visible | Show or hide the column |
| VisualStyle | VisualStyle sets the appearance |
| Width | Width of the column. See WidthType |
| WidthType | WidthType controls how the physical width is derived based on the width |
Events
| Name | Description |
|---|---|
| Click | Fired when the mouse is clicked on the control |
| CreateInstance | CreateInstance is signalled when an instance of a component is created Inherited from Grid Column (PRIM_GDCL) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Grid Column (PRIM_GDCL) |
| DoubleClick | Fired when the user double clicks |
| GotFocus | GotFocus event is triggered when the focus is moved to this column |
| GotFocusAccept | GotFocusAccept is fired when the column gets focus
Accept, Reason |
| GotSelection | GotSelection event is triggered when the selection is moved to this column |
| GotSelectionAccept | GotSelectionAccept happens when item is gets focus
Accept, Reason |
| LostFocus | LostFocus event is triggered when the focus is moved away from this column |
| LostFocusAccept | LostFocusAccept happens when item is gets focus
Accept, Reason |
| LostSelection | LostSelection event is triggered when the selection is moved away from this column |
| LostSelectionAccept | LostSelectionAccept happens when item is gets focus
Accept, Reason |
Methods
| Name | Description |
|---|---|
| GetValue | Get the current value
Result |
| SetValueAt | Set the value of a cell at the specified row
Result, Row, Value |
See also
LANSA Version 15, April 2020