GuiGridListGetItemData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
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.
With this function you can retrieve the [[string]] data associated with an item in a [[Element/GUI/Gridlist|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.


==Syntax==  
==Syntax==  
Line 14: Line 14:


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


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
This example displays a random item data from the gridlist.
 
<syntaxhighlight lang="lua">
This example displays a random item data from the gridlist
function clientsideResourceStart ()
<syntaxhighlight lang="lua">function clientsideResourceStart ()
     local numberList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
     local numberList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
     local column = guiGridListAddColumn( numberList, "Column Title", 0.85 )
     local column = guiGridListAddColumn ( numberList, "Column Title", 0.85 )
     if ( column ) then
     if ( column ) then
         row = guiGridListAddRow ( numberList )
         local row = guiGridListAddRow ( numberList )
         myItem = guiGridListSetItemText ( numberList, row, column, tostring(math.random(0, 10) ^ 100), false, false )
         local myItem = guiGridListSetItemText ( numberList, row, column, tostring( math.random(0, 10) ^ 100 ), false, false )
         myItemData = guiGridListGetItemData ( numberList, row, column )
         local myItemData = guiGridListGetItemData ( numberList, row, column )
outputChatBox ( "My gridlist item data: "..myItemData )
        outputChatBox ( "My gridlist item data: " .. myItemData )
     end
     end
end
end
Line 34: Line 33:


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{GUI functions}}
{{GUI functions}}
[[Category:Incomplete]]

Revision as of 20:41, 25 March 2009

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.

Syntax

string 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 a string with 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