Interface IListBase<T>

Namespace

HP.LFT.SDK.WinForms

Assembly

HP.LFT.SDK.dll

Base interface for some .NET Windows Forms list controls.

public interface IListBase<T>

Type Parameters

T

Properties

Items

Returns the items in this list.

ReadOnlyCollection<T> Items { get; }

Property Value

ReadOnlyCollection<T>

SelectedItems

Returns the selected items in this list.

ReadOnlyCollection<T> SelectedItems { get; }

Property Value

ReadOnlyCollection<T>

Methods

ActivateItem(int, MouseButton)

Activates (double-clicks) the specified item in this list by item index.

void ActivateItem(int itemIndex, MouseButton button = MouseButton.Left)

Parameters

itemIndex int

The index of the item to activate.

button MouseButton

Optional. The mouse button used to activate the item. Possible values: MouseButton Default value: MouseButton.Left

ActivateItem(string, MouseButton)

Activates (double-clicks) the specified item in this list.

void ActivateItem(string item, MouseButton button = MouseButton.Left)

Parameters

item string

The item to activate.

button MouseButton

Optional. The mouse button used to activate the item. Possible values: MouseButton Default value: MouseButton.Left

ActivateItem(T, MouseButton)

Activates (double-clicks) the specified item in this list.

void ActivateItem(T item, MouseButton button = MouseButton.Left)

Parameters

item T

The specified item to activate from this list.

button MouseButton

Optional. The mouse button used to activate the item. Possible values: MouseButton Default value: MouseButton.Left

Deselect(params int[])

Deselects a list of items by items indices.

void Deselect(params int[] itemIndices)

Parameters

itemIndices int[]

The specified item indices collection to deselect.

Deselect(params string[])

Deselects a list of items.

void Deselect(params string[] items)

Parameters

items string[]

The specified item collection to deselect.

Deselect(params T[])

Deselects a list of items.

void Deselect(params T[] items)

Parameters

items T[]

The item collection to deselect.

ExtendSelect(params int[])

Selects additional items from the multi-selection list, by indices.

void ExtendSelect(params int[] itemIndices)

Parameters

itemIndices int[]

The item indices to add to the selection.

ExtendSelect(params string[])

Selects additional items from the multi-selection list, by name.

void ExtendSelect(params string[] items)

Parameters

items string[]

The item names to add to the selection.

ExtendSelect(params T[])

Selects additional items from the multi-selection list, by items.

void ExtendSelect(params T[] items)

Parameters

items T[]

The items to add to the selection.

GetItem(string)

Returns the item with the specified text.

T GetItem(string text)

Parameters

text string

The text of the item to return.

Returns

T

Select(params int[])

Selects a list of items by items indices.

void Select(params int[] itemIndices)

Parameters

itemIndices int[]

The specified item indices collection to select.

Select(params string[])

Selects a list of items.

void Select(params string[] items)

Parameters

items string[]

The specified item collection to select.

Select(params T[])

Selects a list of items.

void Select(params T[] items)

Parameters

items T[]

The item collection to select.

SelectRange(int)

Selects all list items between the currently selected item and the specified last item index.

void SelectRange(int itemIndexLast)

Parameters

itemIndexLast int

The index of the last item to select.

SelectRange(int, int)

Selects all list items between (and including) the two specified items.

void SelectRange(int indexFrom, int indexTo)

Parameters

indexFrom int

The 0-based index of the first item in the range.

indexTo int

The 0-based index of the last item of the range.

SelectRange(string)

Selects all list items between the currently selected item and the specified item.

void SelectRange(string itemNameLast)

Parameters

itemNameLast string

The name of the last item to select.

SelectRange(string, string)

Selects all list items between (and including) the two specified item names.

void SelectRange(string itemNameFrom, string itemNameTo)

Parameters

itemNameFrom string

The name of the first item in the range.

itemNameTo string

The name of the last item of the range.

SelectRange(T)

Selects all list items between the currently selected item and the specified last item.

void SelectRange(T itemLast)

Parameters

itemLast T

The last item to select.

SelectRange(T, T)

Selects all list items between (and including) the two specified list items.

void SelectRange(T itemFrom, T itemTo)

Parameters

itemFrom T

The first item in the range.

itemTo T

The last item of the range.