Description

Deletes an item in the list box user control that is specified by userControlID.

To delete an item, either provide the index of the item to delete, or a string of the item to delete (but not both). The string must exactly match for it to be deleted.

Functional area

User Window

Command syntax

Syntax

deleteListBoxItem userControlID itemIndex or "itemString"

Arguments

Name	Type	Required	Comments
`itemString`	int	yes	Matching string of the item to delete. Either an index should be provided, or a string, but not both.
`index`	int	yes	Zero based index of the item to delete. Either an index should be provided, or a string, but not both.
`userControlId`	int	yes	ID of user control to operate on.

Flags

None

Return value

integer

Examples

// Delete an item in a List Box User Control.
int $windowId;
int $controlId;
// First create a User Window to place the Control on
$windowId = `createWindow "MyWindow"`;
// Create the User Control on the Window. 
$controlId = `createListBox $windowId`;
 
// Add some items to the List Box.
addListBoxItem $controlId "Item 1";
addListBoxItem $controlId "Item 2";
addListBoxItem $controlId "Item 3";
addListBoxItem $controlId "Item 4";
 
// Delete the second and third items.
deleteListBoxItem $controlId 1;
deleteListBoxItem $controlId "Item 3";

Shogun 1.12 Documentation

deleteListBoxItem