DgsComboBoxSetSelectedItem

From Multi Theft Auto: Wiki

This function sets the selected item from a dgs combobox.

Syntax

bool dgsComboBoxSetSelectedItem ( element comboBox, int itemIndex )

Required Arguments

  • comboBox: the dgs combobox you want to select an item from
  • itemIndex: the item you want to select (item 1 is the first item). 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.

Example

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

DGS = exports.dgs
function drawGUI()
	dgsWindow = DGS:dgsCreateWindow(100,100,200,100,"ComboBox test area",false,false) -- create the container window
	combobox = DGS:dgsCreateComboBox(20,30,150,20,"Checked ComboBox",false,dgsWindow) -- note the parameter after header, it will create a ComboBox
	DGS:dgsComboBoxAddItem(combobox,"Selected") --Add items to combobox
	DGS:dgsComboBoxAddItem(combobox,"UnSelected")
	DGS:dgsComboBoxSetSelectedItem(combobox,1)--set the first row which is the selected row Selected.
	DGS:dgsSetVisible(dgsWindow,false) -- set it invisible just in case
end

addCommandHandler("combobox",function()
	if not dgsWindow then -- if it hasn't been declared yet
		drawGUI() -- we draw the gui window
		DGS:dgsSetVisible(dgsWindow,true) -- we set it visible again. Strictly speaking it's not necessary, could have omitted both this and the upper dgsSetVisible, 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 dgsWindow
		DGS:dgsSetVisible(dgsWindow, not guiGetVisible(dgsWindow)) -- 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)

See Also

Multi Language Supports

Animation

3D Interface

3D Text

Arrow List

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Ellipse Detect Area

Detect Area

Grid List

Image

Memo

Label

Progress Bar

Radio Button

Scroll Bar

Scroll Pane

Switch Button

Tab Panel

Window

Plugin

Media Browser

Rounded Rectangle

Color Picker

Blur Box

Effect 3D

Nine Slice