guiComboBoxSetSelected

Client-side

Server-side

Shared

This function sets the selected item of a combo box.

OOP Syntax Help! I don't understand this!

Method:gui-combobox:setSelected(...)
Variable: .selected

Syntax

bool guiComboBoxSetSelected ( gui-combobox comboBox, int itemIndex )

Required arguments

comboBox: The combobox you want to select an item in.
itemIndex: The item you want to select (indexing starts at 0). If -1 is specified, then the combo box text is set to it's caption.

Returns

Returns true if the selected item has been changed successfully, false otherwise.

bool: result

Code Examples

client

This example creates a GUI window with a checked and an unchecked combo box and adds a command to toggle their visibility.

local guiWindow

function drawGUI()
    guiWindow = guiCreateWindow(100, 100, 200, 100, "ComboBox test area", false, false) -- create the container window
    local combobox = guiCreateComboBox(20, 30, 150, 20, "Checked ComboBox", false, guiWindow) -- note the parameter after header, it will create a ComboBox
    guiComboBoxAddItem(combobox, "Selected") -- Add items to combobox
    guiComboBoxAddItem(combobox, "UnSelected")

    guiComboBoxSetSelected(combobox, 0) -- set the first row which is the selected row Selected.
    guiSetVisible(guiWindow, false) -- set it invisible just in case
end

addCommandHandler("combobox", function()
    if not guiWindow then -- if it hasn't been declared yet
        drawGUI() -- we draw the gui window
        guiSetVisible(guiWindow, true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper guiSetVisible, but this is needed if you want to cache a window without actually showing it
    else -- if we actually have run this function before and declared guiWindow
        guiSetVisible(guiWindow, not guiGetVisible(guiWindow)) -- we just toggle the visibility. If it was visible, not visible returns false and thus sets it's visibility false, effectivly hiding it
    end
    showCursor(not isCursorShowing()) -- similar to above visibility
end)

guiComboBoxSetSelected

OOP Syntax Help! I don't understand this!

Syntax

Required arguments

Returns

Code Examples

See Also

GUI Functions

GUI Elements

Reference