Class List

View Source

Definition

Namespace:
ElmSharp
Assembly:
ElmSharp.dll
API Level:
preview

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.


                
C#

                

                    
Copy

                    

                

            
public class List : Layout, IAccessibleObject
Inheritance
System.Object
EvasObject
AccessibleObject
Widget
Container
Layout
List
Implements
IAccessibleObject

Constructors

View Source

List(EvasObject)

Creates and initializes a new instance of the List class.

Declaration

                
C#

                

                    
Copy

                    

                

            
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.
API Level: preview

Properties

View Source

Mode

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public ListMode Mode { get; set; }
Property Value
Type Description
ListMode
API Level: preview
View Source

SelectedItem

Gets the selected item.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ListItem SelectedItem { get; }
Property Value
Type Description
ListItem
API Level: preview

Methods

View Source

Append(String)

Appends a new item with a text to the end of a given list widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ListItem Append(string label)
Parameters
Type Name Description
System.String label

The text for the item.
Returns
Type Description
ListItem

Return a new added list item that contains a text.
See Also
API Level: preview
View Source

Append(String, EvasObject, EvasObject)

Appends a new item with a text and 2 icons to the end of a given list widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ListItem Append(string label, EvasObject leftIcon, EvasObject rightIcon)
Parameters
Type Name Description
System.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
API Level: preview
View Source

Clear()

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Clear()
API Level: preview
View Source

CreateHandle(EvasObject)

Creates a widget handle.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override IntPtr CreateHandle(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

Parent EvasObject.
Returns
Type Description
System.IntPtr

Handle IntPtr.
Overrides
API Level: preview
View Source

Prepend(String)

Prepends a new item with a text to the beginning of a given list widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ListItem Prepend(string label)
Parameters
Type Name Description
System.String label

The text for the item.
Returns
Type Description
ListItem

Return a new added list item that contains a text.
API Level: preview
View Source

Prepend(String, EvasObject, EvasObject)

Prepends a new item with a text and 2 icons to the beginning of a given list widget.

Declaration

                
C#

                

                    
Copy

                    

                

            
public ListItem Prepend(string label, EvasObject leftIcon, EvasObject rigthIcon)
Parameters
Type Name Description
System.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.
API Level: preview
View Source

Update()

Starts the list. Called before running Show() on the list object. If not called, it won't display the list properly.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Update()
API Level: preview

Events

View Source

ItemActivated

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<ListItemEventArgs> ItemActivated
Event Type
Type Description
System.EventHandler<ListItemEventArgs>
API Level: preview
View Source

ItemDoubleClicked

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

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<ListItemEventArgs> ItemDoubleClicked
Event Type
Type Description
System.EventHandler<ListItemEventArgs>
API Level: preview
View Source

ItemLongPressed

ItemLongPressed is raised when a list item is pressed for a certain amount of time. By default, it's 1 second.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<ListItemEventArgs> ItemLongPressed
Event Type
Type Description
System.EventHandler<ListItemEventArgs>
API Level: preview
View Source

ItemSelected

ItemSelected is raised when a new list item is selected.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<ListItemEventArgs> ItemSelected
Event Type
Type Description
System.EventHandler<ListItemEventArgs>
API Level: preview
View Source

ItemUnselected

ItemUnselected is raised when a list item is Unselected.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler<ListItemEventArgs> ItemUnselected
Event Type
Type Description
System.EventHandler<ListItemEventArgs>
API Level: preview

Implements

Extension Methods

See Also