ObjectDCL Banner

ComboBox_Clear Method

Description

This method will clear the ComboBox of all its items.

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:

  • 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_Clear 
		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_ComboBox_Clear
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
	)

Applies For

ComboBox.

Example

CopyCode imageCopy Code
; Clear the list
(Odcl_ComboBox_Clear MyProject_MyForm_MyControl)

See Also

ComboBox_AddList, ComboBox_AddString, ComboBox_DeleteString, ComboBox_GetCount, ComboBox_GetItemData, ComboBox_InsertString, ComboBox_SetItemData