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

NameDescription
CaptionText to be displayed in the column heading
CaptionAlignCaptionAlign determines the position of caption
CaptionTextText as displayed in the column caption at runtime
CaptionTypeCaptionType determines the type of caption
CellReference to a cell in the column
CellReadOnlyDetermines when the cell will allow user input
ColumnAlignAlignment of the contents of the column
ComponentClassNameComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembersComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternNameComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTagGeneric space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentTypeComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeNameComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
DataClassReference to a repository field or fundamental product data class used to control data entry
DisplayAppearanceSpecifies how the column will be displayed when readonly with reference to the visualizations of the column source field
DisplayPositionDisplayPosition determines the order of columns in the list
EditAppearanceSpecifies how the column will be displayed when updating with reference to the visualizations of the column source field
EditorReference to the editor manager used by the grid to manage a reusable part
EditorPartReference to a resuable part used to edit the column
EnsureVisibleScroll a list so that the item is within the visible area
FocusTrue if this item is the focus item in the list
HintHint is a brief description for component
ImageRepository enrolled image to show in the control
MinimumWidthMinimumWidth sets the minimum width of a column
NameName identifies the component Inherited from Object (PRIM_OBJT)
OwnerOwner owns this component Inherited from Object (PRIM_OBJT)
ParentThe component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances
PopupMenuReference to a popup menu shown on a right click
PositionThe position of the column as a member component of the grid. Visual position is controlled by DisplayPosition
ReadOnlyReadOnly controls whether the column can be used for input
RowAlignAlignment of the cell content within the column
SelectedTrue if this item is currently selected
SelectOnClickSelectOnClick controls whether the column is selected
SortAsColumnSpecifies an alternate column to use to sort the data
SortDirectionSortDirection controls how list is sorted
SortOnClickSort the column when the column header is clicked
SortPositionSortPosition determines the place of this column in the sort order
SortTypeSortType controls how a column is sorted.
SourceName of the repository field used to define and store the data for this column
TabStopTabStop controls the use of TAB key
UsePicklistControls whether the values in the picklist are enforced
ValueAtValue at the specified location
VisibleShow or hide the column
VisualStyleVisualStyle sets the appearance
WidthWidth of the column. See WidthType
WidthTypeWidthType controls how the physical width is derived based on the width

Events

NameDescription
ClickFired when the mouse is clicked on the control
CreateInstanceCreateInstance is signalled when an instance of a component is created Inherited from Grid Column (PRIM_GDCL)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Grid Column (PRIM_GDCL)
DoubleClickFired when the user double clicks
GotFocusGotFocus event is triggered when the focus is moved to this column
GotFocusAcceptGotFocusAccept is fired when the column gets focus
Accept, Reason
GotSelectionGotSelection event is triggered when the selection is moved to this column
GotSelectionAcceptGotSelectionAccept happens when item is gets focus
Accept, Reason
LostFocusLostFocus event is triggered when the focus is moved away from this column
LostFocusAcceptLostFocusAccept happens when item is gets focus
Accept, Reason
LostSelectionLostSelection event is triggered when the selection is moved away from this column
LostSelectionAcceptLostSelectionAccept happens when item is gets focus
Accept, Reason

Methods

NameDescription
GetValueGet the current value
Result
SetValueAtSet the value of a cell at the specified row
Result, Row, Value

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020