ObjectDCL Banner

ListBox_SelectString Method

Description

This method finds the first string in a ListBox that contains the specified prefix and selects this list item in the ListBox.

Parameters

MyControlReference
Reference to the control in the form of MyProject_MyForm_MyControl.
ProjectFile
String identifying the project as it was passed in LoadProject.
DialogName
String identifying the dialog by name.
ControlName
String identifying the control by name.
sSearchString
String specifying the text to look for.

Return Values

Returns the following according to the situation:

  • T when successful.
  • Nil if the control is not found or does not support this function.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_ListBox_SelectString 
		MyControlReference [as Reference]
		sSearchString [as String]
	)

An alternative convention is to identify the control by providing the project file, the dialog name and the control name:

CopyCode imageCopy Code
(Odcl_ListBox_SelectString
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		sSearchString [as String]
	)

Applies For

ListBox.

Example

CopyCode imageCopy Code
; Search and select this item
(Odcl_ListBox_SelectString MyProject_MyForm_MyControl "Grapefruit")

See Also

ListBox_FindString, ListBox_FindStringExact