ObjectDCL Banner

ListBox_GetSelectedItems Method

Description

This method will return a list of all selected items in the ListBox. This method is useful only for ListBoxes with multiple selection.

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:

  • List of strings indicating the text of all the selected elements.
  • 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_GetSelectedItems 
		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_GetSelectedItems
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
	)

Applies For

DwgList, ListBox.

Example

CopyCode imageCopy Code
; Get the whole list of selected items
(setq rValue (Odcl_ListBox_GetSelectedItems MyProject_MyForm_MyControl))

See Also

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