Interface IListBase<T>
Base interface for PowerBuilder list objects.
Namespace: HP.LFT.SDK.PowerBuilder
Assembly: HP.LFT.SDK.dll
Syntax
public interface IListBase<T>Type Parameters
| Name | Description |
|---|---|
| T |
Properties
Items
The collection of items in the list as a read-only collection object.
Declaration
ReadOnlyCollection<T> Items { get; }Property Value
| Type | Description |
|---|---|
| ReadOnlyCollection<T> |
SelectedItems
The collection of all selected items in the list as a read-only collection object.
Declaration
ReadOnlyCollection<T> SelectedItems { get; }Property Value
| Type | Description |
|---|---|
| ReadOnlyCollection<T> |
Methods
ActivateItem(int, MouseButton)
Activates (double-clicks) the specified item in the list by item index.
Declaration
void ActivateItem(int itemIndex, MouseButton button = MouseButton.Left)Parameters
| Type | Name | Description |
|---|---|---|
| int | itemIndex | The item index to activate. |
| MouseButton | button | Optional. The mouse button used to select the list item. Possible values: MouseButton Default value: MouseButton.Left |
ActivateItem(string, MouseButton)
Activates (double-clicks) the specified item in the list by item text.
Declaration
void ActivateItem(string item, MouseButton button = MouseButton.Left)Parameters
| Type | Name | Description |
|---|---|---|
| string | item | The specified item to activate from the list. |
| MouseButton | button | Optional. The mouse button used to select the list item. Possible values: MouseButton Default value: MouseButton.Left |
ActivateItem(T, MouseButton)
Activates (double-clicks) the specified generic item in the list.
Declaration
void ActivateItem(T item, MouseButton button = MouseButton.Left)Parameters
| Type | Name | Description |
|---|---|---|
| T | item | The specified item to activate from the list. |
| MouseButton | button | Optional. The mouse button used to select the list item. Possible values: MouseButton Default value: MouseButton.Left |
Deselect(params int[])
Deselects a list of items by item indices.
Declaration
void Deselect(params int[] itemIndices)Parameters
| Type | Name | Description |
|---|---|---|
| int[] | itemIndices | The item indices to deselect from the list. |
Deselect(params string[])
Deselects a list of items by item text.
Declaration
void Deselect(params string[] items)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | items | The item names to deselect from the list. |
Deselect(params T[])
Deselects a list of items according to a generic list.
Declaration
void Deselect(params T[] items)Parameters
| Type | Name | Description |
|---|---|---|
| T[] | items | The items to deselect from the list. |
ExtendSelect(params int[])
Selects additional items from the multi-selection list.
Declaration
void ExtendSelect(params int[] itemIndices)Parameters
| Type | Name | Description |
|---|---|---|
| int[] | itemIndices | The indices of the items to add to the selection. |
Remarks
This method is applicable only to lists that allow multiple selection.
ExtendSelect(params string[])
Selects additional items from the multi-selection list.
Declaration
void ExtendSelect(params string[] itemNames)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | itemNames | The names of the items to add to the selection. |
Remarks
This method is applicable only to lists that allow multiple selection.
ExtendSelect(params T[])
Selects additional items from the multi-selection list.
Declaration
void ExtendSelect(params T[] items)Parameters
| Type | Name | Description |
|---|---|---|
| T[] | items | The items to add to the selection. |
Remarks
This method is applicable only to lists that allow multiple selection.
GetItem(string)
Returns an item with the given text.
Declaration
T GetItem(string text)Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text of the specified item. |
Returns
| Type | Description |
|---|---|
| T |
Select(params int[])
Selects a list of items by item indices.
Declaration
void Select(params int[] itemIndices)Parameters
| Type | Name | Description |
|---|---|---|
| int[] | itemIndices | The item indices to select from the list. |
Select(params string[])
Selects a list of items.
Declaration
void Select(params string[] items)Parameters
| Type | Name | Description |
|---|---|---|
| string[] | items | The item names to select from the list. |
Select(params T[])
Selects a list of items according to a generic list.
Declaration
void Select(params T[] items)Parameters
| Type | Name | Description |
|---|---|---|
| T[] | items | The items to select from the list. |
SelectRange(int)
Selects all list items between an already selected item and the specified item with index passed as the argument.
Declaration
void SelectRange(int indexTo)Parameters
| Type | Name | Description |
|---|---|---|
| int | indexTo | The 0-based index of the last item in the range. |
Remarks
This method is applicable only to lists that allow multiple selection.
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 in the range. |
SelectRange(string)
Selects all list items between an already selected item and the specified item with text passed as the argument.
Declaration
void SelectRange(string itemTo)Parameters
| Type | Name | Description |
|---|---|---|
| string | itemTo | the text of the last item of the range. |
Remarks
This method is applicable only to lists that allow multiple selection.