GuiGridListGetColumnCount: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Example)
 
(2 intermediate revisions by 2 users not shown)
Line 6: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int guiGridListGetColumnCount ( element gridList )
int guiGridListGetColumnCount ( element gridList )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:getColumnCount|columnCount}}


===Required Arguments===  
===Required Arguments===  
Line 14: Line 15:
Returns an integer with the amount of columns in the gridlist, false otherwise.
Returns an integer with the amount of columns in the gridlist, false otherwise.


==Example==
This example outputs number of columns in gridList to chatBox when player uses command ''getColumns''.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler("getColumns",
-- create the grid list
function(command)
local list = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
 
-- add three columns to the grid list
local columns = guiGridListGetColumnCount(theGridList)
guiGridListAddColumn(list, "Column 1", 0.33)
 
guiGridListAddColumn(list, "Column 2", 0.33)
if columns < 1 then
guiGridListAddColumn(list, "Column 3", 0.33)
outputChatBox("There are no columns.")
elseif columns >= 1 then
outputChatBox("There are " .. tostring(columns) .. " columns.")
else
outputChatBox("Unable to get number of columns.")
end
end)


-- display the number of columns in the grid list in the debug or server console (/debugscript 3)
print("Number of columns: " .. guiGridListGetColumnCount(list))
</syntaxhighlight>
</syntaxhighlight>


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

Latest revision as of 18:05, 22 December 2022

This allows you to get the count of existing columns in a gridlist.

Syntax

int guiGridListGetColumnCount ( element gridList )

OOP Syntax Help! I don't understand this!

Method: GuiGridList:getColumnCount(...)
Variable: .columnCount


Required Arguments

  • gridList: The grid list you want to add a column to

Returns

Returns an integer with the amount of columns in the gridlist, false otherwise.

-- create the grid list
local list = guiCreateGridList(0.80, 0.40, 0.15, 0.35, true)
-- add three columns to the grid list
guiGridListAddColumn(list, "Column 1", 0.33)
guiGridListAddColumn(list, "Column 2", 0.33)
guiGridListAddColumn(list, "Column 3", 0.33)

-- display the number of columns in the grid list in the debug or server console (/debugscript 3)
print("Number of columns: " .. guiGridListGetColumnCount(list))

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