DgsLabelGetTextExtent: Difference between revisions

Revision as of 16:12, 16 March 2022

Redirect to:

@@ Line 1: / Line 1: @@
-{{Client function}}
+#REDIRECT [[dgsLabelGetTextSize]]
-__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}}