GuiComboBoxSetItemText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Added example)
No edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function changes the text of a combobox item.
This function changes the text of a dgs combobox item.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiComboBoxSetItemText ( element comboBox, int itemId, string text )
bool guiComboBoxSetItemText ( element comboBox, int itemId, string/number text )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''comboBox:''' The combobox containing the item you're interested in
*'''comboBox:''' The dgs combobox containing the item you're interested in
*'''itemId:''' The index of the item
*'''itemId:''' The index of the item
*'''text:''' The text you want to put in (does NOT accept numbers, use tostring() for that)
*'''text:''' The text you want to put in (Can accept numbers, which is different from gui-combobox!)


===Returns===
===Returns===
Line 19: Line 19:
This changes the text of the selected item using command ''setText''.  
This changes the text of the selected item using command ''setText''.  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler("setText",
DGS = exports.dgs
function(cmd, text)
 
local item = guiComboBoxGetSelected(comboBox)
guiComboBoxSetItemText(comboBox, item, text)


comboBox = DGS:dgsDxCreateComboBox(200,200,100,30,false)
for i=1,5 do
    DGS:dgsDxComboBoxAddItem(comboBox,i)
end
addCommandHandler("setText",function(cmd, text)
    local item = guiComboBoxGetSelected(comboBox)
    if item ~= -1 then
        guiComboBoxSetItemText(comboBox, item, text)
    end
end)
end)


Line 30: Line 35:


==See Also==
==See Also==
{{GUI functions}}
{{DGSFUNCTIONS}}

Revision as of 07:56, 11 August 2017

This function changes the text of a dgs combobox item.

Syntax

bool guiComboBoxSetItemText ( element comboBox, int itemId, string/number text )

Required Arguments

  • comboBox: The dgs combobox containing the item you're interested in
  • itemId: The index of the item
  • text: The text you want to put in (Can accept numbers, which is different from gui-combobox!)

Returns

Returns true if the text was set successfully, false otherwise.

Example

This changes the text of the selected item using command setText.

DGS = exports.dgs

comboBox = DGS:dgsDxCreateComboBox(200,200,100,30,false)
for i=1,5 do
    DGS:dgsDxComboBoxAddItem(comboBox,i)
end
addCommandHandler("setText",function(cmd, text)
    local item = guiComboBoxGetSelected(comboBox)
    if item ~= -1 then
        guiComboBoxSetItemText(comboBox, item, text)
    end
end)

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips