ObjectDCL Banner

ListBox_GetSel Method

Description

This method is used to determine if an item in the list box is currently selected.   This method is useful in a multiple selection ListBox.

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 element to check.

Return Values

Returns the following according to the situation:

  • Boolean indicating whether the element is selected.
  • 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_GetSel 
		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_ListBox_GetSel
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer]
	)

Applies For

DwgList, ListBox.

Example

CopyCode imageCopy Code
; Check if fourth item is selected
(setq rValue (Odcl_ListBox_GetSel MyProject_MyForm_MyControl 3))

See Also

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