ObjectDCL Banner

ListBox_GetFocusIndex Method

Description

This method returns the index of the list item that has the focus rectangle in a multiple selection ListBox around it.

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 item in focus.
  • 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_ListBox_GetFocusIndex 
		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_ListBox_GetFocusIndex
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
	)

Applies For

DwgList, ListBox.

Example

CopyCode imageCopy Code
; Get the item in focus
(setq rValue (Odcl_ListBox_GetFocusIndex MyProject_MyForm_MyControl))

See Also

ListBox_GetAnchorIndex, ListBox_GetCurSel, ListBox_GetSel, ListBox_GetSelCount, ListBox_GetSelectedItems, ListBox_GetSelectedNths, ListBox_SelItemRange, ListBox_SetAnchorIndex, ListBox_SetCurSel, ListBox_SetFocusIndex, ListBox_SetSel