ObjectDCL Banner

ComboBox_GetCurSel Method

Description

This method will return the index of the currently selected list item in a single selection ComboBox.

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.

Return Values

Returns the following according to the situation:

  • Integer indicating the index of the selected item. -1 will be returned if nothing is selected.
  • Nil if the control is not found, does not support this function or if there is no such row.

AutoLISP Syntax

The recommended convention is passing the control identifier directly:

CopyCode imageCopy Code
(Odcl_ComboBox_GetCurSel 
		MyControlReference [as Reference])

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_GetCurSel
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String])

Applies For

ComboBox.

Example

CopyCode imageCopy Code
; Get the currently selected item
(setq rValue (Odcl_ComboBox_GetCurSel MyProject_MyForm_MyControl))

See Also

ComboBox_SetCurSel, OnSelChanged (ComboBox)