A5.ListBoxItem Object
Description
Definition of a custom item.
Discussion
Custom items can be used in the list by adding the "a5-item" attribute to an element in the list. This attribute should contain the name of the custom item to call when the user interacts with the element. It can also include arguments to be passed to the item events by including a ":" after the item name, followed by arguments specific to the item.
Example
<!--
in this example when the user interactions with the button, the "showDetails" custom item will be used
assuming the list data has a column named "CustomerID", and that this HTML was inserted into the list row layout,
the argument for the "showDetails" custom item events would be that value.
-->
<button a5-item="showDetails:{CustomerID}">View</button>Properties
- selectableboolean
Whether or not the custom item allows the list row to be selected.
- onClickfunction(index,value,arguments,item,element,event)
Event fired when a custom item is clicked.
- indexnumberboolean
The tender index of the list row. If the custom item is not in a row, the "index" will be "false".
- valuestring
The value of the list row.
- argumentsstring
Any arguments specific to the custom item.
- itemobject
The item definition object.
- elementelement
The element event happend on.
- eventeventboolean
The event object.
- onDblClickfunction(index,value,arguments,item,element,event)
Event fired when a custom item is double clicked.
- indexnumberboolean
The tender index of the list row. If the custom item is not in a row, the "index" will be "false".
- valuestring
The value of the list row.
- argumentsstring
Any arguments specific to the custom item.
- itemobject
The item definition object.
- elementelement
The element event happend on.
- eventeventboolean
The event object.
- onRightClickfunction(index,value,arguments,item,element,event)
Event fired when a custom item is context clicked.
- indexnumberboolean
The tender index of the list row. If the custom item is not in a row, the "index" will be "false".
- valuestring
The value of the list row.
- argumentsstring
Any arguments specific to the custom item.
- itemobject
The item definition object.
- elementelement
The element event happend on.
- eventeventboolean
The event object.
- onDownfunction(index,value,arguments,item,element,event)
Event fired when the user presses down on a custom item.
- indexnumberboolean
The tender index of the list row. If the custom item is not in a row, the "index" will be "false".
- valuestring
The value of the list row.
- argumentsstring
Any arguments specific to the custom item.
- itemobject
The item definition object.
- elementelement
The element event happend on.
- eventeventboolean
The event object.
- onUpfunction(index,value,arguments,item,element,event)
Event fired when the user releases after having presses down on a custom item.
- indexnumberboolean
The tender index of the list row. If the custom item is not in a row, the "index" will be "false".
- valuestring
The value of the list row.
- argumentsstring
Any arguments specific to the custom item.
- itemobject
The item definition object.
- elementelement
The element event happend on.
- eventeventboolean
The event object.