DgsButtonGetTextExtent

From Multi Theft Auto: Wiki
Revision as of 13:51, 3 November 2022 by Thisdp (talk | contribs) (Created page with "{{Client function}} __NOTOC__ This function returns the extent, or width, of the current text inside a DGS button. ==Syntax== <syntaxhighlight lang="lua"> float dgsButtonGetTextExtent ( element theButton ) </syntaxhighlight> ===Required Arguments=== *'''theButton:''' The button to get the text extent from. ===Returns=== Returns the absolute width of the current text inside the button if the function is successful, ''false'' otherwise. ==Example== This example crea...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function returns the extent, or width, of the current text inside a DGS button.

Syntax

float dgsButtonGetTextExtent ( element theButton )

Required Arguments

  • theButton: The button to get the text extent from.

Returns

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

Example

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

DGS = exports.dgs
-- create the window (the container for our button)
local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )

-- create the button
local myButton = DGS:dgsCreateButton ( 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 button
DGS:dgsSetSize ( myButton, DGS:dgsButtonGetTextExtent ( myButton ), DGS:dgsButtonGetFontHeight ( myButton ), false )

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