ObjectDCL Banner

ComboBox_GetLBText Method

Description

This method gets the text in the control's internal list box. Particularly useful for some style of ComboBox that are pre-filled.

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.
nIndex
Integer identifying the index of the item.

Return Values

Returns the following according to the situation:

  • String indicating the text.
  • 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_GetLBText 
		MyControlReference [as Reference]
		nIndex [as Integer]
	)

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

Remarks

This method does not work for directory picker style.

Applies For

ComboBox.

Example

CopyCode imageCopy Code
; Get the text of the fifth item
(setq rValue (Odcl_ComboBox_GetLBText MyProject_MyForm_MyControl 5))