ObjectDCL Banner

ComboBox_InsertString Method

Description

This method will insert a list item in 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 where to insert.
sNewString
String specifying the text of an entry to add.

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_InsertString 
		MyControlReference [as Reference]
		nIndex [as Integer]
		sNewString [as String]
	)

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

Remarks

This method does not work for directory picker style.

Applies For

ComboBox.

Example

CopyCode imageCopy Code
; Insert in the list in front of the 4th item
(Odcl_ComboBox_InsertString MyProject_MyForm_MyControl 3 "Banana")

See Also

ComboBox_AddList, ComboBox_AddString, ComboBox_Clear, ComboBox_DeleteString, ComboBox_GetCount, ComboBox_GetItemData, ComboBox_SetItemData