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 different repository field as the source.
Example
Setting a column to be the primary sort.
#Column.SortPosition := 1
Properties
Name | Description |
|---|---|
Text to be displayed in the column heading | |
CaptionAlign determines the position of caption | |
Text as displayed in the column caption at runtime | |
CaptionType determines the type of caption | |
Reference to a cell in the column | |
Determines when the cell will allow user input | |
Alignment of the contents of the column | |
ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT) | |
ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT) | |
ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT) | |
Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT) | |
ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT) | |
ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT) | |
Reference to a repository field or fundamental product data class used to control data entry | |
Specifies how the column will be displayed when readonly with reference to the visualizations of the column source field | |
DisplayPosition determines the order of columns in the list | |
Specifies how the column will be displayed when updating with reference to the visualizations of the column source field | |
Reference to the editor manager used by the grid to manage a reusable part | |
Reference to a resuable part used to edit the column | |
Scroll a list so that the item is within the visible area | |
True if this item is the focus item in the list | |
Hint is a brief description for component | |
Repository enrolled image to show in the control | |
MinimumWidth sets the minimum width of a column | |
Name identifies the component Inherited from Object (PRIM_OBJT) | |
Owner owns this component Inherited from Object (PRIM_OBJT) | |
The component instance to which this instance is attached. The visual container for a control or the collector of a set of child instances | |
Reference to a popup menu shown on a right click | |
The position of the column as a member component of the grid. Visual position is controlled by DisplayPosition | |
ReadOnly controls whether the column can be used for input | |
Alignment of the cell content within the column | |
True if this item is currently selected | |
SelectOnClick controls whether the column is selected | |
Specifies an alternate column to use to sort the data | |
SortDirection controls how list is sorted | |
Sort the column when the column header is clicked | |
SortPosition determines the place of this column in the sort order | |
SortType controls how a column is sorted. | |
Name of the repository field used to define and store the data for this column | |
TabStop controls the use of TAB key | |
Controls whether the values in the picklist are enforced | |
Value at the specified location | |
Show or hide the column | |
VisualStyle sets the appearance | |
Width of the column. See WidthType | |
WidthType controls how the physical width is derived based on the width |
Events
Name | Description |
|---|---|
Fired when the mouse is clicked on the control | |
CreateInstance is signalled when an instance of a component is created Inherited from Grid Column (PRIM_GDCL) | |
DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Grid Column (PRIM_GDCL) | |
Fired when the user double clicks | |
GotFocus event is triggered when the focus is moved to this column | |
GotFocusAccept is fired when the column gets focus Accept, Reason | |
GotSelection event is triggered when the selection is moved to this column | |
GotSelectionAccept happens when item gets focused Accept, Reason | |
LostFocus event is triggered when the focus is moved away from this column | |
LostFocusAccept happens when the item gets focused Accept, Reason | |
LostSelection event is triggered when the selection is moved away from this column | |
LostSelectionAccept happens when the item gets focused Accept, Reason |
Methods
Name | Description |
|---|---|
Get the current value Result | |
Set the value of a cell at the specified row Result, Row, Value |