Class List
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
It inherits Layout. The List is a widget that aims to display a simple list item which has 2 icons, 1 text, and can be selected. For more robust lists, GenList should probably be used.
public class List : Layout, IAccessibleObject- Inheritance
- Implements
Constructors
View SourceList(EvasObject)
Creates and initializes a new instance of the List class.
Declaration
public List(EvasObject parent)Parameters
| Type | Name | Description |
|---|---|---|
| EvasObject | parent | The parent is a given container, which will be attached by the list as a child. It's EvasObject type. |
Properties
View SourceMode
Gets or sets which mode to be used for the list.
Declaration
public ListMode Mode { get; set; }Property Value
| Type | Description |
|---|---|
| ListMode |
SelectedItem
Gets the selected item.
Declaration
public ListItem SelectedItem { get; }Property Value
| Type | Description |
|---|---|
| ListItem |
Methods
View SourceAppend(string)
Appends a new item with a text to the end of a given list widget.
Declaration
public ListItem Append(string label)Parameters
| Type | Name | Description |
|---|---|---|
| string | label | The text for the item. |
Returns
| Type | Description |
|---|---|
| ListItem | Return a new added list item that contains a text. |
See Also
View SourceAppend(string, EvasObject, EvasObject)
Appends a new item with a text and 2 icons to the end of a given list widget.
Declaration
public ListItem Append(string label, EvasObject leftIcon, EvasObject rightIcon)Parameters
| Type | Name | Description |
|---|---|---|
| string | label | The text for the item. |
| EvasObject | leftIcon | The left icon for the item. |
| EvasObject | rightIcon | The right icon for the item. |
Returns
| Type | Description |
|---|---|
| ListItem | Return a new added list item that contains a text and 2 icons. |
See Also
View SourceClear()
Removes all the items from a given list widget. To delete just one item, use Delete().
Declaration
public void Clear()CreateHandle(EvasObject)
Creates a widget handle.
Declaration
protected override IntPtr CreateHandle(EvasObject parent)Parameters
| Type | Name | Description |
|---|---|---|
| EvasObject | parent | Parent EvasObject. |
Returns
| Type | Description |
|---|---|
| IntPtr | Handle IntPtr. |
Overrides
View SourcePrepend(string)
Prepends a new item with a text to the beginning of a given list widget.
Declaration
public ListItem Prepend(string label)Parameters
| Type | Name | Description |
|---|---|---|
| string | label | The text for the item. |
Returns
| Type | Description |
|---|---|
| ListItem | Return a new added list item that contains a text. |
Prepend(string, EvasObject, EvasObject)
Prepends a new item with a text and 2 icons to the beginning of a given list widget.
Declaration
public ListItem Prepend(string label, EvasObject leftIcon, EvasObject rigthIcon)Parameters
| Type | Name | Description |
|---|---|---|
| string | label | The text for the item. |
| EvasObject | leftIcon | The left icon for the item. |
| EvasObject | rigthIcon | The right icon for the item. |
Returns
| Type | Description |
|---|---|
| ListItem | Return a new added list item that contains a text and 2 icons. |
Update()
Starts the list. Called before running Show() on the list object. If not called, it won't display the list properly.
Declaration
public void Update()Events
View SourceItemActivated
ItemActivated is raised when a new list item is double-clicked or pressed (enter|return|spacebar).
Declaration
public event EventHandler<ListItemEventArgs> ItemActivatedEvent Type
| Type | Description |
|---|---|
| EventHandler<ListItemEventArgs> |
ItemDoubleClicked
ItemDoubleClicked is raised when a new list item is double-clicked.
Declaration
public event EventHandler<ListItemEventArgs> ItemDoubleClickedEvent Type
| Type | Description |
|---|---|
| EventHandler<ListItemEventArgs> |
ItemLongPressed
ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default, it's 1 second.
Declaration
public event EventHandler<ListItemEventArgs> ItemLongPressedEvent Type
| Type | Description |
|---|---|
| EventHandler<ListItemEventArgs> |
ItemSelected
ItemSelected is raised when a new list item is selected.
Declaration
public event EventHandler<ListItemEventArgs> ItemSelectedEvent Type
| Type | Description |
|---|---|
| EventHandler<ListItemEventArgs> |
ItemUnselected
ItemUnselected is raised when a list item is Unselected.
Declaration
public event EventHandler<ListItemEventArgs> ItemUnselectedEvent Type
| Type | Description |
|---|---|
| EventHandler<ListItemEventArgs> |