ListBox_FindStringExact Method
Description
This method finds the first string in a ListBox that contains a list item with the exact string match without changing the ListBox selection. A search for "Example Text" will find "Example Text". Use the ListBox_SelectString function instead to both find and select a string.
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 search.
Return Values
Returns the following according to the situation:
- Integer indicating the index of the matching element.
- Nil if the control is not found or does not support this function.
AutoLISP Syntax
The recommended convention is passing the control identifier directly:
 Copy Code |
|---|
(Odcl_ListBox_FindStringExact 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:
| Copy Code |
|---|
(Odcl_ListBox_FindStringExact ProjectFile [as String] DialogName [as String] ControlName [as String] sSearchString [as String] ) |
Applies For
Example
| Copy Code |
|---|
; Search this exact string in the list (setq rValue (Odcl_ListBox_FindStringExact MyProject_MyForm_MyControl "Grape")) |