Interface IListBase<T>

Namespace

HP.LFT.SDK.PowerBuilder

Assembly

HP.LFT.SDK.dll

Base interface for PowerBuilder list objects.

public interface IListBase<T>

Type Parameters

T

Properties

Items

The collection of items in the list as a read-only collection object.

ReadOnlyCollection<T> Items { get; }

Property Value

ReadOnlyCollection<T>

SelectedItems

The collection of all selected items in the list as a read-only collection object.

ReadOnlyCollection<T> SelectedItems { get; }

Property Value

ReadOnlyCollection<T>

Methods

ActivateItem(int, MouseButton)

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

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

Parameters

itemIndex int

The item index to activate.

button MouseButton

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.

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

Parameters

item string

The specified item to activate from the list.

button MouseButton

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.

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

Parameters

item T

The specified item to activate from the list.

button MouseButton

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.

void Deselect(params int[] itemIndices)

Parameters

itemIndices int[]

The item indices to deselect from the list.

Deselect(params string[])

Deselects a list of items by item text.

void Deselect(params string[] items)

Parameters

items string[]

The item names to deselect from the list.

Deselect(params T[])

Deselects a list of items according to a generic list.

void Deselect(params T[] items)

Parameters

items T[]

The items to deselect from the list.

ExtendSelect(params int[])

Selects additional items from the multi-selection list.

void ExtendSelect(params int[] itemIndices)

Parameters

itemIndices int[]

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.

void ExtendSelect(params string[] itemNames)

Parameters

itemNames string[]

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.

void ExtendSelect(params T[] items)

Parameters

items T[]

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.

T GetItem(string text)

Parameters

text string

The text of the specified item.

Returns

T

Select(params int[])

Selects a list of items by item indices.

void Select(params int[] itemIndices)

Parameters

itemIndices int[]

The item indices to select from the list.

Select(params string[])

Selects a list of items.

void Select(params string[] items)

Parameters

items string[]

The item names to select from the list.

Select(params T[])

Selects a list of items according to a generic list.

void Select(params T[] items)

Parameters

items T[]

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.

void SelectRange(int indexTo)

Parameters

indexTo int

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.

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 in the range.

SelectRange(string)

Selects all list items between an already selected item and the specified item with text passed as the argument.

void SelectRange(string itemTo)

Parameters

itemTo string

the text of the last item of the range.

Remarks

This method is applicable only to lists that allow multiple selection.