Class Index

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

API Level:

preview

The Index widget gives you an index for fast access to whichever group of the other UI items one might have. Inherits Layout.

public class Index : Layout, IAccessibleObject

Inheritance

Object

EvasObject

AccessibleObject

Widget

Container

Layout

Index

Implements

IAccessibleObject

Constructors

Index(EvasObject)

Creates and initializes a new instance of the Index class.

Declaration

public Index(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	The parent is a given container, which will be attached by Index as a child. It's EvasObject type.

API Level: preview

Properties

AutoHide

Sets or gets whether the auto hiding feature is enabled or not for a given index widget.

Declaration

public bool AutoHide { get; set; }

Property Value

Type	Description
Boolean

API Level: preview

Delay

Sets a delay change time for the index object. The delay time is 0.2 seconds by default.

Declaration

public double Delay { get; set; }

Property Value

Type	Description
Double

API Level: preview

IndicatorVisible

Sets or gets a value of the indicator's disabled status.

Declaration

public bool IndicatorVisible { get; set; }

Property Value

Type	Description
Boolean

API Level: preview

IsHorizontal

Sets or gets a value whether the horizontal mode is enabled or not.

Declaration

public bool IsHorizontal { get; set; }

Property Value

Type	Description
Boolean

API Level: preview

Level

Gets or sets the items level for a given index widget.

Declaration

public int Level { get; set; }

Property Value

Type	Description
Int32

API Level: preview

OmitEnabled

Sets or gets whether the omit feature is enabled or not for a given index widget.

Declaration

public bool OmitEnabled { get; set; }

Property Value

Type	Description
Boolean

API Level: preview

Priority

Controls the standard_priority group of the index. Priority group will be shown as many items as it can, and other group will be shown for one character only.

Declaration

public int Priority { get; set; }

Property Value

Type	Description
Int32

API Level: preview

SelectedItem

Gets the last selected item for a given index widget.

Declaration

public IndexItem SelectedItem { get; }

Property Value

Type	Description
IndexItem

API Level: preview

Methods

Append(String)

Appends a new item on a given index widget.

Declaration

public IndexItem Append(string label)

Parameters

Type	Name	Description
String	label	The label for which the item should be indexed.

Returns

Type	Description
IndexItem	An object to the IndexItem if added, or null on errors.

API Level: preview

Clear()

Removes all the items from a given index widget.

Declaration

public void Clear()

API Level: preview

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

Layout.CreateHandle(EvasObject)

API Level: preview

InsertAfter(String, IndexItem)

Inserts a new item into the index object after the item after.

Declaration

public IndexItem InsertAfter(string label, IndexItem after)

Parameters

Type	Name	Description
String	label	The label for which the item should be indexed.
IndexItem	after	The index item to insert after.

Returns

Type	Description
IndexItem	An object to the IndexItem if added, or null on errors.

API Level: preview

InsertBefore(String, IndexItem)

Inserts a new item into the index object before the item before.

Declaration

public IndexItem InsertBefore(string label, IndexItem before)

Parameters

Type	Name	Description
String	label	The label for which the item should be indexed.
IndexItem	before	The index item to insert after.

Returns

Type	Description
IndexItem	An object to the IndexItem if added, or null on errors.

API Level: preview

Prepend(String)

Prepends a new item on a given index widget.

Declaration

public IndexItem Prepend(string label)

Parameters

Type	Name	Description
String	label	The label for which the item should be indexed.

Returns

Type	Description
IndexItem	A handle to the item if added, or null on errors.

API Level: preview

Update(Int32)

Flushes the changes made to the index items so that they work correctly.

Declaration

public void Update(int level)

Parameters

Type	Name	Description
Int32	level	The index level (one of 0 or 1) where the changes were made.

API Level: preview

Events

Changed

Changed will be triggered when the selected index item is changed.

Declaration

public event EventHandler Changed

Event Type

Type	Description
EventHandler

API Level: preview

Implements

IAccessibleObject

Extension Methods

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.Deactivate(EvasObject)