ComboBox.setActiveId

Changes the active row of combo_box to the one that has an ID equal to active_id, or unsets the active row if active_id is NULL. Rows having a NULL ID string cannot be made active by this function.

If the id-column property of combo_box is unset or if no row has the given ID then the function does nothing and returns FALSE.

class ComboBox
bool
setActiveId
(
string activeId
)

Parameters

activeId string

the ID of the row to select, or NULL

Return Value

Type: bool

TRUE if a row with a matching ID was found. If a NULL active_id was given to unset the active row, the function always returns TRUE.

Meta