DgsLabelGetTextExtent: Difference between revisions

Latest revision as of 16:37, 16 March 2022

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

Syntax

float dgsLabelGetTextExtent ( element theLabel )

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.

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

-- create the label
local myLabel = DGS:dgsCreateLabel ( 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
DGS:dgsSetSize ( myLabel, DGS:dgsLabelGetTextExtent ( myLabel ), DGS:dgsLabelGetFontHeight ( myLabel ), false )

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

dgsCreateBrowser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

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

dgsCreateCanvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

@@ Line 1: / Line 1: @@
-#REDIRECT [[dgsLabelGetTextSize]]
+{{Client function}}
+__NOTOC__
+This function returns the extent, or width, of the current text inside a DGS text label.
+==Syntax==
+<syntaxhighlight lang="lua">
+float dgsLabelGetTextExtent ( element theLabel )
+</syntaxhighlight>
+===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.
+<syntaxhighlight lang="lua">
+DGS = exports.dgs
+-- create the window (the container for our label)
+local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )
+-- create the label
+local myLabel = DGS:dgsCreateLabel ( 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
+DGS:dgsSetSize ( myLabel, DGS:dgsLabelGetTextExtent ( myLabel ), DGS:dgsLabelGetFontHeight ( myLabel ), false )
+</syntaxhighlight>
+==See Also==
+{{DGSFUNCTIONS}}