GuiGridListSetItemText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(OOP syntax)
 
(10 intermediate revisions by 9 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This function changes the text of a gridlist item.
This function changes the text of a gridlist item.
Notice: This function doesn't work well with Sorting. If you are using sorting, please use the optional arguments of [[guiGridListAddRow]] as much as possible.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiGridListSetItemText ( element theElement, int rowIndex, int columnIndex, string text, bool section, bool number )
bool guiGridListSetItemText ( element gridList, int rowIndex, int columnIndex, string text, bool section, bool number )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:setItemText}}


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' The grid list element
*'''gridList:''' The grid list element
*'''rowIndex:''' Row ID
*'''rowIndex:''' Row ID
*'''columnIndex:''' Column ID
*'''columnIndex:''' Column ID
*'''text:''' The text you want to put in
*'''text:''' The text you want to put in (does NOT accept numbers, use tostring() for that)
*'''section:''' Determines if the item is a section
*'''section:''' Determines if the item is a section
*'''number:''' Tells whether the text item is a number value or not
*'''number:''' Tells whether the text item is a number value or not (used for sorting)


===Returns===
===Returns===
Returns ''true'' if the function has been successfull, ''false'' otherwise.
Returns ''true'' if the item text was set successfully, ''false'' otherwise.


==Example==  
==Example==  
This example creates a player list on the right of the screen and fills it
This example creates a player list on the right of the screen and fills it
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function createPlayerList ()
function clientsideResourceStart ()
        -- Create the grid list element
         local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) -- Create the grid list
         local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
         local column = guiGridListAddColumn( playerList, "Player", 0.85 ) -- Create a 'players' column in the list
        -- Create a players column in the list
         if ( column ) then -- If the column was successfully created
         local column = guiGridListAddColumn( playerList, "Player", 0.85 )
                 for id, playeritem in ipairs(getElementsByType("player")) do  
         if ( column ) then             -- If the column has been created, fill it with players
                --Loop through all the players, adding them to the table
                 for id, playeritem in ipairs(getElementsByType("player")) do
                         local row = guiGridListAddRow ( playerList )
                         local row = guiGridListAddRow ( playerList )
                         guiGridListSetItemText ( playerList, row, column, getClientName ( playeritem ), false, false )
                         guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
                 end
                 end
         end
         end
end
end
addEventHandler ( "onClientResourceStart", getResourceRootElement(), clientsideResourceStart )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
{{GUI_events}}

Latest revision as of 21:14, 7 November 2018

This function changes the text of a gridlist item.

Notice: This function doesn't work well with Sorting. If you are using sorting, please use the optional arguments of guiGridListAddRow as much as possible.

Syntax

bool guiGridListSetItemText ( element gridList, int rowIndex, int columnIndex, string text, bool section, bool number )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:setItemText(...)


Required Arguments

  • gridList: The grid list element
  • rowIndex: Row ID
  • columnIndex: Column ID
  • text: The text you want to put in (does NOT accept numbers, use tostring() for that)
  • section: Determines if the item is a section
  • number: Tells whether the text item is a number value or not (used for sorting)

Returns

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

Example

This example creates a player list on the right of the screen and fills it 

function clientsideResourceStart ()
        local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) -- Create the grid list
        local column = guiGridListAddColumn( playerList, "Player", 0.85 ) -- Create a 'players' column in the list
        if ( column ) then -- If the column was successfully created
                for id, playeritem in ipairs(getElementsByType("player")) do 
                --Loop through all the players, adding them to the table
                        local row = guiGridListAddRow ( playerList )
                        guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
                end
        end
end
addEventHandler ( "onClientResourceStart", getResourceRootElement(), 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

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGridListSetItemText?oldid=60519"