ObjectDCL Banner

ComboBox_DeleteString Method

Description

This method will delete a list item from the ComboBox.

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 entry to remove.

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

Remarks

This method does not work for directory picker style.

Applies For

ComboBox.

Example

CopyCode imageCopy Code
; Delete the fifth entry
(Odcl_ComboBox_DeleteString MyProject_MyForm_MyControl 4)

See Also

ComboBox_AddList, ComboBox_AddString, ComboBox_Clear, ComboBox_GetCount, ComboBox_GetItemData, ComboBox_InsertString, ComboBox_SetItemData