ObjectDCL Banner

ImageComboBox_SetTopIndex Method

Description

This method ensures that the indicated ImageCombo item is visible. If it's not the ImageCombo is scrolled to ensure the item is visible.

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 specifying the index of the item to see at the top of the list.

Return Values

Returns the following according to the situation:

  • T when successful.
  • 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_SetTopIndex 
		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_ImageComboBox_SetTopIndex
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer]
	)

Applies For

ImageCombo.

Example

CopyCode imageCopy Code
; Scroll the list so that the 6th item is the first visible one
(Odcl_ImageComboBox_SetTopIndex MyProject_MyForm_MyControl 5)

See Also

ImageComboBox_GetTopIndex