GuiGetProperties: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: {{Client function}} __NOTOC__ This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://www.c...)
 
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://www.cegui.org.uk/wiki/index.php/SetProperty_(WindowsLook) CEGUI properties wiki page].
This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the [http://static.cegui.org.uk/static/WindowsLookProperties.html CEGUI properties page].


==Syntax==
==Syntax==
Line 7: Line 7:
table guiGetProperties ( element guiElement )
table guiGetProperties ( element guiElement )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]]:getProperties|properties|}}


===Required Arguments===
===Required Arguments===
Line 12: Line 13:


===Returns===
===Returns===
If the function succeeds, the return value is a table. Its keys are property names, the corresponding values are the values of the properties. If the function fails, it returns ''false''.
If the function succeeds, the return value is a table. Its keys are property names, the corresponding values are the values of the properties (both names and values are always strings). If the function fails, it returns ''false''.


==Example==
==Example==
Line 28: Line 29:
)
)
</syntaxhighlight>
</syntaxhighlight>
==See Also==
{{GUI functions}}
{{GUI_events}}

Latest revision as of 17:17, 21 November 2018

This function gets a list of the CEGUI property names and values of a GUI element. To find out what the different properties mean, check out the CEGUI properties page.

Syntax

table guiGetProperties ( element guiElement )

OOP Syntax Help! I don't understand this!

Method: GuiElement:getProperties(...)
Variable: .properties


Required Arguments

  • guiElement: the GUI element you wish to get the properties of.

Returns

If the function succeeds, the return value is a table. Its keys are property names, the corresponding values are the values of the properties (both names and values are always strings). If the function fails, it returns false.

Example

The following example code will create a button and lists its properties in the console if the /btn command is entered. 

addCommandHandler("btn",
    function()
        local btn = guiCreateButton(20, 200, 150, 30, "Test", false)
        local props = guiGetProperties(btn)
        for propName,propVal in pairs(props) do
            outputConsole(propName .. " = " .. propVal)
        end
    end
)

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/GuiGetProperties?oldid=60849"