Interface IListBase<T>
Base interface for some .NET Windows Forms list controls.
Namespace: HP.LFT.SDK.WinForms
Assembly: HP.LFT.SDK.dll
Syntax
public interface IListBase<T>Type Parameters
| Name | Description |
|---|---|
| T |
Properties
Items
Returns the items in this list.
Declaration
ReadOnlyCollection<T> Items { get; }Property Value
| Type | Description |
|---|---|
| ReadOnlyCollection<T> |
SelectedItems
Returns the selected items in this list.
Declaration
ReadOnlyCollection<T> SelectedItems { get; }Property Value
| Type | Description |
|---|---|
| ReadOnlyCollection<T> |
Methods
ActivateItem(int, MouseButton)
Activates (double-clicks) the specified item in this list by item index.
Declaration
void ActivateItem(int itemIndex, MouseButton button = MouseButton.Left)Parameters
| Type | Name | Description |
|---|---|---|
| int | itemIndex | The index of the item to activate. |
| MouseButton | button | 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.
Declaration
void ActivateItem(string item, MouseButton button = MouseButton.Left)Parameters
| Type | Name | Description |
|---|---|---|
| string | item | The item to activate. |
| MouseButton | button | 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.
Declaration
void ActivateItem(T item, MouseButton button = MouseButton.Left)Parameters
| Type | Name | Description |
|---|---|---|
| T | item | The specified item to activate from this list. |
| MouseButton | button | 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.
Declaration
void Deselect(params int[] itemIndices)Parameters
| Type | Name | Description |
|---|---|---|
| int[] | itemIndices | The specified item indices collection to deselect. |
Deselect(params string[])
Deselects a list of items.
Declaration
void Deselect(params string[] items)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | items | The specified item collection to deselect. |
Deselect(params T[])
Deselects a list of items.
Declaration
void Deselect(params T[] items)Parameters
| Type | Name | Description |
|---|---|---|
| T[] | items | The item collection to deselect. |
ExtendSelect(params int[])
Selects additional items from the multi-selection list, by indices.
Declaration
void ExtendSelect(params int[] itemIndices)Parameters
| Type | Name | Description |
|---|---|---|
| int[] | itemIndices | The item indices to add to the selection. |
ExtendSelect(params string[])
Selects additional items from the multi-selection list, by name.
Declaration
void ExtendSelect(params string[] items)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | items | The item names to add to the selection. |
ExtendSelect(params T[])
Selects additional items from the multi-selection list, by items.
Declaration
void ExtendSelect(params T[] items)Parameters
| Type | Name | Description |
|---|---|---|
| T[] | items | The items to add to the selection. |
GetItem(string)
Returns the item with the specified text.
Declaration
T GetItem(string text)Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text of the item to return. |
Returns
| Type | Description |
|---|---|
| T |
Select(params int[])
Selects a list of items by items indices.
Declaration
void Select(params int[] itemIndices)Parameters
| Type | Name | Description |
|---|---|---|
| int[] | itemIndices | The specified item indices collection to select. |
Select(params string[])
Selects a list of items.
Declaration
void Select(params string[] items)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | items | The specified item collection to select. |
Select(params T[])
Selects a list of items.
Declaration
void Select(params T[] items)Parameters
| Type | Name | Description |
|---|---|---|
| T[] | items | The item collection to select. |
SelectRange(int)
Selects all list items between the currently selected item and the specified last item index.
Declaration
void SelectRange(int itemIndexLast)Parameters
| Type | Name | Description |
|---|---|---|
| int | itemIndexLast | The index of the last item to select. |
SelectRange(int, int)
Selects all list items between (and including) the two specified items.
Declaration
void SelectRange(int indexFrom, int indexTo)Parameters
| Type | Name | Description |
|---|---|---|
| int | indexFrom | The 0-based index of the first item in the range. |
| int | indexTo | 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.
Declaration
void SelectRange(string itemNameLast)Parameters
| Type | Name | Description |
|---|---|---|
| string | itemNameLast | The name of the last item to select. |
SelectRange(string, string)
Selects all list items between (and including) the two specified item names.
Declaration
void SelectRange(string itemNameFrom, string itemNameTo)Parameters
| Type | Name | Description |
|---|---|---|
| string | itemNameFrom | The name of the first item in the range. |
| string | itemNameTo | 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.
Declaration
void SelectRange(T itemLast)Parameters
| Type | Name | Description |
|---|---|---|
| T | itemLast | The last item to select. |
SelectRange(T, T)
Selects all list items between (and including) the two specified list items.
Declaration
void SelectRange(T itemFrom, T itemTo)Parameters
| Type | Name | Description |
|---|---|---|
| T | itemFrom | The first item in the range. |
| T | itemTo | The last item of the range. |