ObjectDCL Banner

ListBox_SetAnchorIndex Method

Description

This method will set the anchor list item in a multiple selection ListBox to begin an extended 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.
nIndex
Integer specifying the index of the item.

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_ListBox_SetAnchorIndex 
		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_SetAnchorIndex
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		nIndex [as Integer]
	)

Applies For

DwgList, ListBox.

Example

CopyCode imageCopy Code
; Set the anchor item as the third one
(Odcl_ListBox_SetAnchorIndex MyProject_MyForm_MyControl 2)

See Also

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