GuiGridListGetItemData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (added note)
(Changed syntax - it stated, that function returns only "string" types, which is untrue.)
Line 6: Line 6:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string guiGridListGetItemData ( element gridList, int rowIndex, int columnIndex )
var guiGridListGetItemData ( element gridList, int rowIndex, int columnIndex )
</syntaxhighlight>  
</syntaxhighlight>  


Line 15: Line 15:


===Returns===
===Returns===
Returns a [[string]] with the item data of the specified item if succesful, ''false'' if one of the arguments was invalid.
Returns the item data of the specified item if succesful, ''false'' if one of the arguments was invalid.


==Example==
==Example==

Revision as of 23:34, 6 July 2012

With this function you can retrieve the string data associated with an item in a grid list. This is not the text that is displayed on the item, but an internal string that you can use to hold extra information about the item.
Note: This function will only work after you set the item's text using guiGridListSetItemText!

Syntax

var guiGridListGetItemData ( element gridList, int rowIndex, int columnIndex )

Required Arguments

  • gridList: the grid list containing the item you're interested in
  • rowIndex: the row index of the item
  • columnIndex: the column index of the item

Returns

Returns the item data of the specified item if succesful, false if one of the arguments was invalid.

Example

This example displays a random item data from the gridlist. 

function clientsideResourceStart ()
    local numberList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
    local column = guiGridListAddColumn ( numberList, "Column Title", 0.85 )
    if ( column ) then
        local row = guiGridListAddRow ( numberList )
        local myItem = guiGridListSetItemText ( numberList, row, column, tostring( math.random(0, 10) ^ 100 ), false, false )
        local myItemData = guiGridListGetItemData ( numberList, row, column )
        outputChatBox ( "My gridlist item data: " .. myItemData )
    end
end
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGridListGetItemData?oldid=31806"