List List Item (PRIM_LIST.ListItem)

List Item

Ancestors - Object (PRIM_OBJT)

Details

All LANSA visual list controls manange a collection of items.
 
Items are created and destroyed whenever entries are added to or deleted from the underlying data list.
 
Items are the means by which the visual side of the list can be manipulated.

Properties

Name Description
CheckBoxes Show or hide a check box for the item
Checked Checked state of the time
CheckEnabled Enabled or disable the checkbox for the item
CheckReadOnly Set the checkbox to be readonly on input capable
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)
Entry Entry number of the item in the underlying data list
Expanded Item is expanded or collapsed
Focus True if this item is the focus item in the list
FocusedInactiveStyle Style to be applied to the focus item when the control is not focus
FocusedInactiveStyles Collection of styles to be applied to the focus item when the control is not focus
FocusedStyle Style applied to the item when focus
FocusedStyles Collection of styles to be applied to the item when focus
HasChildren Controls the appearance of the expand and collapse image for the item
Image Repository enrolled image to show in the control
ItemCount Number of items with a parent of this item
Items Collection of all items parented to this time
Level Numeric level of the item.
List Reference to the parent List
MarginBottom Bottom margin in pixels
MarginTop Top margin in pixels
Modified Used to determine whether the item content has been changed by the user
MouseOverStyle Style applied to the item when mouse over
MouseOverStyles Collection of styles to be applied to the item when mouse over
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 Inherited from Object (PRIM_OBJT)
ParentItem Reference to the parent item of the list item. Items at the root have a parentitem of null.
ParentItems Collection of all items in the level above the item
Position Position of the item in the component list
RelatedReference Reference to an object instance to be stored for this item
RowHeight Height of the row in pixels
ScrollLeft Left position of a scrolled child control relative to its parent control
ScrollTop Top position of a scrolled child control relative to its parent control
Selected True if this item is currently selected
SelectedInactiveStyle Style to be applied to the item when selected but the control is not focus
SelectedInactiveStyles Collection of styles to be applied to the item when selected but the control is not focus
SelectedStyle Style applied to the item when selected
SelectedStyles Collection of styles to be applied to the item when selected
Style Styles to be applied to the item
Styles Collection of styles to be applied to the item
ThemeDrawStyle Name of the Theme DrawStyle to be applied to the list item
Visible Show or hide the item

Events

Name Description
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from List List Item (PRIM_LIST.ListItem)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from List List Item (PRIM_LIST.ListItem)
ItemCollapsed A list item has collapsed, hiding all child items
Item
ItemExpanding A list item has expanded, showing all child items
Item
ItemGotFocus Fired when an item receives the focus
Item
ItemGotParent A parent has been assigned to the list item
Item
ItemGotSelection Fired when an item in the list becomes selected
Item
ItemLostFocus Fired when the item loses focus
Item
ItemLostSelection ItemLostSelection happens when another item is selected
Item
ItemRealizing Fired when an item design instance is realized, typically when the it comes in to the view port
Item

Methods

Name Description
Collapse Collapse the item
Delete Delete the item
DeleteAll Delete all items in the list
Expand Expand the item

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020