GuiGetText: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
{{Client function}}
__NOTOC__
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function is used to get text from GUI elements like edit boxes, labels, buttons, etc.
This function is used to get the text of GUI elements like edit boxes, labels, buttons etc.


==Syntax==  
==Syntax==  
Line 22: Line 23:
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function test ()
-- We create a dummy gui label to get text of
--we create a dummy gui label to get text of
local dummyGuiElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
local dummyGuiElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
-- Output the text of the label to chat box
--output the text of the label to chat box
outputChatBox ( "Text in the GUI label: " .. guiGetText ( dummyGuiElement ) )
outputChatBox ( "Text in the GUI label: "..guiGetText ( dummyGuiElement ) )
end
</syntaxhighlight>
</syntaxhighlight>



Revision as of 15:05, 18 August 2007

This function is used to get the text of GUI elements like edit boxes, labels, buttons etc.

Syntax

string guiGetText ( element guiElement )

Required Arguments

  • guiElement: element you wish to get text of.

Returns

Returns a string containing the requested element's text, or false if the gui element passed to the function is invalid.

Example

This example gets the text of a pre-made gui element and outputs it to chat box.

-- We create a dummy gui label to get text of
local dummyGuiElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true )
-- Output the text of the label to chat box
outputChatBox ( "Text in the GUI label: " .. guiGetText ( dummyGuiElement ) )

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