GuiEditSetMaxLength: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
m (t)
 
(4 intermediate revisions by 4 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiEditSetMaxLength ( element theElement, int length )
bool guiEditSetMaxLength ( element guiEdit, int length )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Edit_field|GuiEdit]]:setMaxLength|maxLength|guiEditGetMaxLength}}


===Required Arguments===  
===Required Arguments===  
Line 17: Line 18:


==Example==  
==Example==  
This example creates an edit box with a limit on text length, alongside an "Output!" button.  When the button is clicked, it will output the message in the edit box into the Chat Box.
This example creates an edit box with a limit on text length, alongside an "Output!" button.  When the button is clicked, it will output the message in the edit box into the chatbox.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- create our button
-- create our button
Line 36: Line 37:
==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}
[[RU:guiEditSetMaxLength]]

Latest revision as of 21:53, 12 December 2020

This function sets the maximum text length that can be typed into an edit box.

Syntax

bool guiEditSetMaxLength ( element guiEdit, int length )

OOP Syntax Help! I don't understand this!

Method: GuiEdit:setMaxLength(...)
Variable: .maxLength
Counterpart: guiEditGetMaxLength


Required Arguments

  • theElement: The edit box to be changed.
  • length: An integer indicating the maximum number of characters that can be typed into the box.

Returns

Returns true if the max length was set successfully, false otherwise.

Example

This example creates an edit box with a limit on text length, alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the chatbox. 

-- create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
-- create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- set a maximum text length of 128 characters
guiEditSetMaxLength ( editBox, 128 )

-- setup our function to output the message to the chatbox
function outputEditBox ()
        local text = guiGetText ( editBox )   -- get the text from the edit box
        outputChatBox ( text )                -- output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )

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/GuiEditSetMaxLength?oldid=68009"