ObjectDCL Banner

ComboBox_AddString Method

Description

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

Return Values

Returns the following according to the situation:

  • Integer indicating the index of the added item.
  • 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_AddString 
		MyControlReference [as Reference]
		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_AddString
		ProjectFile [as String]
		DialogName [as String]
		ControlName [as String]
		sNewString [as String]
	)

Remarks

This method does not work for directory picker style.

Applies For

ComboBox.

Example

CopyCode imageCopy Code
; Add to the combobox
(Odcl_ComboBox_AddString MyProject_MyForm_MyControl "Grapefruit")

See Also

ComboBox_AddList, ComboBox_Clear, ComboBox_DeleteString, ComboBox_GetCount, ComboBox_GetItemData, ComboBox_InsertString, ComboBox_SetItemData