DgsEditSetMaxLength: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function sets the maximum text length that can be typed into an edit box. ==Syntax== <syntaxhighlight lang="lua"> bool guiEditSetMaxLengt...")
 
 
(5 intermediate revisions by 2 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiEditSetMaxLength ( element Edit, int length )
bool dgsEditSetMaxLength ( element theElement, int length )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  


*'''theElement:''' The dgs-dxedit to be changed.
*'''theElement:''' The dgs-dxedit to be changed.
*'''length:''' An integer indicating the maximum number of characters that can be typed into the box.
*'''length:''' An integer indicating the maximum number of characters that can be typed into the box.


Line 17: Line 17:


==Example==  
==Example==  
DGS = exports.dgs
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 Chat Box.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- create our button
-- create our button
button = DGS:dgsDxCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
-- create an edit box and define it as "editBox".
-- create an edit box and define it as "editBox".
editBox = DGS:dgsDxCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- set a maximum text length of 128 characters
-- set a maximum text length of 128 characters
DGS:dgsDxEditSetMaxLength ( editBox, 128 )
DGS:dgsEditSetMaxLength ( editBox, 128 )


</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 14:56, 18 January 2018

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

Syntax

bool dgsEditSetMaxLength ( element theElement, int length )

Required Arguments

  • theElement: The dgs-dxedit 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 Chat Box. 

DGS = exports.dgs
-- create our button
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
-- create an edit box and define it as "editBox".
editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- set a maximum text length of 128 characters
DGS:dgsEditSetMaxLength ( editBox, 128 )

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsEditSetMaxLength?oldid=53519"