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

object

EvasObject

AccessibleObject

Widget

Container

Layout

List

Implements

IAccessibleObject

Constructors

List(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.

See Also

GenList

GenGrid

Properties

Mode

Gets or sets which mode to be used for the list.

Declaration

public ListMode Mode { get; set; }

Property Value

Type	Description
ListMode

See Also

GenList

GenGrid

SelectedItem

Gets the selected item.

Declaration

public ListItem SelectedItem { get; }

Property Value

Type	Description
ListItem

See Also

GenList

GenGrid

Methods

Append(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

ListItem

Append(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

ListItem

Clear()

Removes all the items from a given list widget. To delete just one item, use Delete().

Declaration

public void Clear()

See Also

GenList

GenGrid

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

protected override IntPtr CreateHandle(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	Parent EvasObject.

Returns

Type	Description
System.IntPtr	Handle IntPtr.

Overrides

Layout.CreateHandle(EvasObject)

See Also

GenList

GenGrid

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.

See Also

GenList

GenGrid

Prepend(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.

See Also

GenList

GenGrid

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()

See Also

GenList

GenGrid

Events

ItemActivated

ItemActivated is raised when a new list item is double-clicked or pressed (enter|return|spacebar).

Declaration

public event EventHandler<ListItemEventArgs> ItemActivated

Event Type

Type	Description
System.EventHandler<TEventArgs><ListItemEventArgs>

See Also

GenList

GenGrid

ItemDoubleClicked

ItemDoubleClicked is raised when a new list item is double-clicked.

Declaration

public event EventHandler<ListItemEventArgs> ItemDoubleClicked

Event Type

Type	Description
System.EventHandler<TEventArgs><ListItemEventArgs>

See Also

GenList

GenGrid

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> ItemLongPressed

Event Type

Type	Description
System.EventHandler<TEventArgs><ListItemEventArgs>

See Also

GenList

GenGrid

ItemSelected

ItemSelected is raised when a new list item is selected.

Declaration

public event EventHandler<ListItemEventArgs> ItemSelected

Event Type

Type	Description
System.EventHandler<TEventArgs><ListItemEventArgs>

See Also

GenList

GenGrid

ItemUnselected

ItemUnselected is raised when a list item is Unselected.

Declaration

public event EventHandler<ListItemEventArgs> ItemUnselected

Event Type

Type	Description
System.EventHandler<TEventArgs><ListItemEventArgs>

See Also

GenList

GenGrid

Implements

IAccessibleObject

Extension Methods

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Deactivate(EvasObject)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)

See Also

GenList

GenGrid