GuiGridListGetItemData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
{{Client function}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl
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==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string guiGridListGetItemData ( element gridList, int rowIndex, int columnIndex )
string guiGridListGetItemData ( element gridList, int rowIndex, int columnIndex )
Line 10: Line 9:


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''gridList:''' the grid list containing the item you're interested in
*'''argumentName:''' description
*'''rowIndex:''' the row index of the item
 
*'''columnIndex:''' the column index of the item
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns a string with the item data of the specified item if succesful, ''false'' if one of the arguments was invalid.
Returns ''true'' if blah, ''false'' otherwise.


==Example==  
==Example==  

Revision as of 15:38, 18 August 2007

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 does... 

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

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=10658"