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

NameDescription
CaptionText to be displayed within the column header
CaptionTextText as displayed in the column caption at runtime
CaptionTypeCaptionType determines the type of caption
CheckBoxesCheckboxes controls the display of check boxes in the column
ColumnAlignColumnAlign specifies how columns are aligned
ColumnImageImage specifies the image used in a component
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)
DisplayAppearanceDisplayAppearance controls how the column is displayed
DisplayPositionDisplayPosition determines the order of columns in the list
EditAppearanceEditAppearance controls how the column is displayed
EditorEditor provides access to the EditorManager component
EditorPartEditorPart is the reusable part used to edit the column
HintHint is a brief description for component
ImageRepository enrolled image to show in the control
ImageExpandedImageExpanded indicates the status of an item
ImageOverlayImageOverlay superimposes another image on an icon
ImageStateImageState indicates the status of an item
KeyPositionKeyPosition controls how list is sorted
LevelSpecifies the level of the column data for levelled trees
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)
ParentReference to the treeview containing the column
PopupMenuReference to a popup menu shown on a right click
ReadOnlyReadOnly controls whether the item can be used for input
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
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 Tree View Column (PRIM_TVCL)
DestroyInstanceDestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Tree View Column (PRIM_TVCL)
DoubleClickFired when the user double clicks

Methods

NameDescription
SetValueAtSet the value of a cell at the specified row
Result, Row, Value
SizeToContentsSet the column width to the widest content

See also

All Component Classes

Technical Reference

Febuary 18 V14SP2