ObjectDCL Banner

ComboBox_FindString Method

Description

This method  finds the first string in a ComboBox that contains a list item with the specified prefix or partial match without changing the ComboBox selection. A search for "Text" will find "Example Text". Use the ComboBox_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:

CopyCode imageCopy Code
(Odcl_ComboBox_FindString 
		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_ComboBox_FindString
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		sSearchString [as String]
	)

Remarks

This method does not work for directory picker style.

Applies For

ComboBox.

Example

CopyCode imageCopy Code
; Search this in the list
(setq rValue (Odcl_ComboBox_FindString MyProject_MyForm_MyControl "grape"))

See Also

ComboBox_FindStringExact, ComboBox_SelectString