Class ListBoxConceptMetadata

Defines properties and message types for ListBoxConcept.

Property Types

See also PropertyType
ListBoxConceptMetadata.ItemCountProperty

Reports the number of items in the List Box, including virtual items.

ListBoxConceptMetadata.KeepAliveItemCountProperty

Sets the size of the buffer for invisible List Box items. Kanzi returns to the Item Generator those invisible items that do not fit in the buffer.

ListBoxConceptMetadata.SelectedItemIndexProperty

Sets the index of the item that is currently selected in the List Box node. A List Box node updates this property when the user scrolls that List Box node. To select an item in the List Box node, set this property to the index of the item that you want to select. The indexing starts from 0. To update this property with a binding, use a to-source or two-way binding.

ListBoxConceptMetadata.SelectionBehaviorProperty

Sets how the List Box behaves when the user selects an item. 'Bring to Center' sets the List Box to bring an item to the center of the List Box area when the user selects that item.

ListBoxConceptMetadata.ItemGeneratorTypeNameProperty

Sets the name of the item generator type to use to provide items dynamically to the List Box.

ListBoxConceptMetadata.ItemContainerGeneratorTypeNameProperty

Sets the name of the item container generator type to use to provide item containers dynamically for the List Box.

ListBoxConceptMetadata.ItemTemplateProperty

Sets the prefab to use for the List Box items.

ListBoxConceptMetadata.ItemContainerTemplateProperty

Sets the List Box Item Container prefab that sets the appearance and behavior of the List Box items.

Message Types

See also MessageType
ListBoxConceptMetadata.ItemSelectedMessage

Occurs when an item is selected.

Arguments: ListBoxConceptMetadata.ItemSelectedMessageArguments

ListBoxConceptMetadata.ItemVisibleMessage

Occurs when an item is loaded to the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.

Arguments: ListBoxConceptMetadata.ItemVisibleMessageArguments

ListBoxConceptMetadata.ItemHiddenMessage

Occurs when an item is unloaded from the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.

Arguments: ListBoxConceptMetadata.ItemHiddenMessageArguments

Message Arguments

Message arguments classes define message arguments used for different message types. Each class defines a number of property types - arguments - together with getter and setter functions for them.

ListBoxConceptMetadata.ItemHiddenMessageArguments

ListBoxConceptMetadata.ItemMessageArguments

ItemIndexProperty

Reports the index of the List Box item.

Example
local value = arguments:getItemIndexProperty()
arguments:setItemIndexProperty(value)

ListBoxConceptMetadata.ItemSelectedMessageArguments

SelectedItemIndexProperty

Reports the index of the selected List Box item. The value -1 indicates that no item is selected.

Example
local value = arguments:getSelectedItemIndexProperty()
arguments:setSelectedItemIndexProperty(value)
PreviousSelectedItemIndexProperty

Reports the index of the previously selected List Box item. The value -1 indicates that no item was selected.

Example
local value = arguments:getPreviousSelectedItemIndexProperty()
arguments:setPreviousSelectedItemIndexProperty(value)

ListBoxConceptMetadata.ItemVisibleMessageArguments