ObjectDCL Banner

ImageComboBox_GetItem Method

Description

This method gets the text, image, selected image and indent of the indicated item.

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.
nItemIndex
Integer specifying row index.

Return Values

Returns the following according to the situation:

  • List indicating the text as a string, the image, the selected image and the indent as integers.
  • 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_ImageComboBox_GetItem 
		MyControlReference [as Reference]
		nItemIndex [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_ImageComboBox_GetItem
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nItemIndex [as Integer]
	)

Applies For

ImageCombo.

Example

CopyCode imageCopy Code
; Get the details of the fifth item
(setq rValue (Odcl_ImageComboBox_GetItem MyProject_MyForm_MyControl 4))

See Also

ImageComboBox_SetItem