GuiGridListGetItemText

This function retrieves the text from a specific grid list item.

Syntax

string guiGridListGetItemText ( element theElement, int rowIndex, int columnIndex )

Required Arguments

• theElement: the gridlist containing the item you're interested in
• rowIndex: row id of the item
• columnIndex: column id of the item

Returns

Returns the text of the item if the arguments are right, false otherwise.

Example

This example creates a gridlist with entries "Hello" and "World!" and chooses randomly which of these two grid list items it will retrieve.

Click to expand [+]

Click to Expand

function clientsideResourceStart ()
        --Create a gridlist
    	local numberList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) 
    	        --Create columnA on the gridlist
		local columnA = guiGridListAddColumn ( numberList, "columnA Title", 0.85 ) 
    	        --Add 2 rows to the grid list
		rowA = guiGridListAddRow ( numberList )
    	rowB = guiGridListAddRow ( numberList )
                --Create the text "Hello" for rowA, columnA
		guiGridListSetItemText ( numberList, rowA, columnA, "Hello", false, false )   	
    	        --Create the text "World!" for rowB, columnA
		guiGridListSetItemText ( numberList, rowB, columnA, "World!", false, false )
    	--Choose randomly which grid list item text to retrieve
        getRandomItem = math.random ( 1, 2 )       
		if getRandomItem == 1 then 
                randomItemData = guiGridListGetItemText ( numberList, rowA, columnA )
        elseif getRandomItem == 2 then
                randomItemData = guiGridListGetItemText ( numberList, rowB, columnA )
        end
        --Output the randomly retrieved item text
        outputChatBox ( "My gridlist item text: "..randomItemData ) 
end
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )

Example 2

This example creates a player list on resource start, clicking on it will output the selected player name to the chatbox.

Click to expand [+]

Click to Expand

function createPlayerList ()
        -- Create the grid list
        playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
        -- Create a players column in the list
        local column = guiGridListAddColumn( playerList, "Player", 0.85 )
        if ( column ) then         -- If the column has been created, fill it with players
                for id, playeritem in ipairs(getElementsByType("player")) do
                        local row = guiGridListAddRow ( playerList )
                        guiGridListSetItemText ( playerList, row, column, getPlayerName ( playeritem ), false, false )
                end
                addEventHandler ( "onClientClick", playerList, click )
        end
end
addEventHandler ( "onClientResourceStart", getRootElement(), createPlayerList )

function click ( button, state, sx, sy, x, y, z, elem, gui )
        -- if state is down ( not to trigger the function twice on mouse button up/down), clicked gui and the element is our player list
        if ( ( state == "down" ) and ( gui == true ) and ( source == playerList ) ) then
                -- get the player name from the selected row, first column 
                local playerName = guiGridListGetItemText ( playerList, guiGridListGetSelectedItem ( playerList ), 1 )
                outputChatBox ( playerName )     -- output it to chat box
        end
end

See Also

General functions

• guiBringToFront
• getChatboxLayout
• getChatboxCharacterLimit
• guiCreateFont
• guiBlur
• guiFocus
• guiGetAlpha
• guiGetCursorType
• guiGetEnabled
• guiGetFont
• guiGetInputEnabled
• guiGetInputMode
• guiGetPosition
• guiGetProperties
• guiGetProperty
• guiGetScreenSize
• guiGetSize
• guiGetText
• guiGetVisible
• guiMoveToBack
• guiSetAlpha
• guiSetEnabled
• guiSetFont
• guiSetInputEnabled
• guiSetInputMode
• guiSetPosition
• guiSetProperty
• guiSetSize
• guiSetText
• guiSetVisible
• isChatBoxInputActive
• isConsoleActive
• isDebugViewActive
• isMainMenuActive
• isMTAWindowActive
• isTransferBoxActive
• setChatboxCharacterLimit
• setDebugViewActive

Browsers

• guiCreateBrowser
• guiGetBrowser

Buttons

• guiCreateButton

Checkboxes

• guiCheckBoxGetSelected
• guiCheckBoxSetSelected
• guiCreateCheckBox

Comboboxes

• guiCreateComboBox
• guiComboBoxAddItem
• guiComboBoxClear
• guiComboBoxGetItemCount
• guiComboBoxGetItemText
• guiComboBoxGetSelected
• guiComboBoxIsOpen
• guiComboBoxRemoveItem
• guiComboBoxSetItemText
• guiComboBoxSetOpen
• guiComboBoxSetSelected

Edit Boxes

• guiCreateEdit
• guiEditGetCaretIndex
• guiEditGetMaxLength
• guiEditIsMasked
• guiEditIsReadOnly
• guiEditSetCaretIndex
• guiEditSetMasked
• guiEditSetMaxLength
• guiEditSetReadOnly

Gridlists

• guiCreateGridList
• guiGridListAddColumn
• guiGridListAddRow
• guiGridListAutoSizeColumn
• guiGridListClear
• guiGridListGetColumnCount
• guiGridListGetColumnTitle
• guiGridListGetColumnWidth
• guiGridListGetHorizontalScrollPosition
• guiGridListGetItemColor
• guiGridListGetItemData
• guiGridListGetItemText
• guiGridListGetRowCount
• guiGridListGetSelectedCount
• guiGridListGetSelectedItem
• guiGridListGetSelectedItems
• guiGridListGetSelectionMode
• guiGridListIsSortingEnabled
• guiGridListGetVerticalScrollPosition
• guiGridListInsertRowAfter
• guiGridListRemoveColumn
• guiGridListRemoveRow
• guiGridListSetColumnTitle
• guiGridListSetColumnWidth
• guiGridListSetHorizontalScrollPosition
• guiGridListSetItemColor
• guiGridListSetItemData
• guiGridListSetItemText
• guiGridListSetScrollBars
• guiGridListSetSelectedItem
• guiGridListSetSelectionMode
• guiGridListSetSortingEnabled
• guiGridListSetVerticalScrollPosition

Memos

• guiCreateMemo
• guiMemoGetCaretIndex
• guiMemoGetVerticalScrollPosition
• guiMemoSetVerticalScrollPosition
• guiMemoIsReadOnly
• guiMemoSetCaretIndex
• guiMemoSetReadOnly

Progressbars

• guiCreateProgressBar
• guiProgressBarGetProgress
• guiProgressBarSetProgress

Radio Buttons

• guiCreateRadioButton
• guiRadioButtonGetSelected
• guiRadioButtonSetSelected

Scrollbars

• guiCreateScrollBar
• guiScrollBarGetScrollPosition
• guiScrollBarSetScrollPosition

Scrollpanes

• guiCreateScrollPane
• guiScrollPaneGetHorizontalScrollPosition
• guiScrollPaneGetVerticalScrollPosition
• guiScrollPaneSetHorizontalScrollPosition
• guiScrollPaneSetScrollBars
• guiScrollPaneSetVerticalScrollPosition

Static Images

• guiCreateStaticImage
• guiStaticImageGetNativeSize
• guiStaticImageLoadImage

Tab Panels

• guiCreateTabPanel
• guiGetSelectedTab
• guiSetSelectedTab

Tabs

• guiCreateTab
• guiDeleteTab

Text Labels

• guiCreateLabel
• guiLabelGetColor
• guiLabelGetFontHeight
• guiLabelGetTextExtent
• guiLabelSetColor
• guiLabelSetHorizontalAlign
• guiLabelSetVerticalAlign

Windows

• guiCreateWindow
• guiWindowIsMovable
• guiWindowIsSizable
• guiWindowSetMovable
• guiWindowSetSizable