Tree View Column (PRIM_TVCL)
Defines the data class and behavior of a column in a tree view
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 within the column header |
| CaptionText | Text as displayed in the column caption at runtime |
| CaptionType | CaptionType determines the type of caption |
| CheckBoxes | Checkboxes controls the display of check boxes in the column |
| ColumnAlign | ColumnAlign specifies how columns are aligned |
| ColumnImage | Image specifies the image used in a component |
| 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) |
| DisplayAppearance | DisplayAppearance controls how the column is displayed |
| DisplayPosition | DisplayPosition determines the order of columns in the list |
| EditAppearance | EditAppearance controls how the column is displayed |
| Editor | Editor provides access to the EditorManager component |
| EditorPart | EditorPart is the reusable part used to edit the column |
| Hint | Hint is a brief description for component |
| Image | Repository enrolled image to show in the control |
| ImageExpanded | ImageExpanded indicates the status of an item |
| ImageOverlay | ImageOverlay superimposes another image on an icon |
| ImageState | ImageState indicates the status of an item |
| KeyPosition | KeyPosition controls how list is sorted |
| Level | Specifies the level of the column data for levelled trees |
| 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 | Reference to the treeview containing the column |
| PopupMenu | Reference to a popup menu shown on a right click |
| ReadOnly | ReadOnly controls whether the item can be used for input |
| 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 |
| 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 Tree View Column (PRIM_TVCL) |
| DestroyInstance | DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Tree View Column (PRIM_TVCL) |
| DoubleClick | Fired when the user double clicks |
Methods
| Name | Description |
|---|---|
| SetValueAt | Set the value of a cell at the specified row
Result, Row, Value |
| SizeToContents | Set the column width to the widest content |
See also
LANSA Version 15, April 2020