GuiLabelGetTextExtent: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: {{Client function}} __NOTOC__ This function returns the extent, or width, of the current text inside a GUI text label. ==Syntax== <syntaxhighlight lang="lua"> number guiLabelGetTextExtent ( element the...)
 
m (Added OOP Method + Variable Information)
 
(3 intermediate revisions by 3 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
number guiLabelGetTextExtent ( element theLabel )
float guiLabelGetTextExtent ( element theLabel )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[Element/GUI/Text label|GuiLabel]]:getTextExtent|textExtent}}
===Required Arguments===  
===Required Arguments===  
*'''theLabel:''' The text label to get the text extent from.
*'''theLabel:''' The text label to get the text extent from.
Line 29: Line 29:
==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
{{GUI_events}}

Latest revision as of 11:45, 7 August 2019

This function returns the extent, or width, of the current text inside a GUI text label.

Syntax

float guiLabelGetTextExtent ( element theLabel )

OOP Syntax Help! I don't understand this!

Method: GuiLabel:getTextExtent(...)
Variable: .textExtent


Required Arguments

  • theLabel: The text label to get the text extent from.

Returns

Returns the absolute width of the current text inside the text label if the function is successful, false otherwise.

Example

This example creates a window, a text label, gets the text extent and font height, and sets the text label size according to these values.

-- create the window (the container for our label)
local myWindow = guiCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )

-- create the label
local myLabel = guiCreateLabel ( 10, 10, 0, 0, "This is my text container", false, myWindow )

-- get the (absolute) text extent and font height, and use these to size the label
guiSetSize ( myLabel, guiLabelGetTextExtent ( myLabel ), guiLabelGetFontHeight ( myLabel ), false )

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