ctrlTextWidth: Difference between revisions

Latest revision as of 13:26, 9 July 2023

1.78

Hover & click on the images for description

Description

Description:

Returns the width of the control text including left and right margins (0.008 each). Supported control types are:

ⓘ

For control-independent text width estimate see getTextWidth.

Groups:

GUI Control

Syntax

Syntax:: ctrlTextWidth control
Parameters:: control: Control
Return Value:: Number

Examples

Example 1:: private _w = ctrlTextWidth _ctrl;

Additional Information

See also:: getTextWidth ctrlTextHeight ctrlSetText ctrlType Arma: GUI Configuration

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

R3vo - c: Posted on Oct 28, 2020 - 22:10 (UTC)
: When working with multiline controls ctrlTextWidth or getTextWidth will not return a proper value since the text will be treated as one long line.
Solution (Execute in Eden Editor):
disableSerialization; private _display = findDisplay 313 createDisplay "RscDisplayEmpty"; private _edit = _display ctrlCreate ["RscEditMulti", -1]; _edit ctrlSetPosition [0,0,1,1]; _edit ctrlSetBackgroundColor [0,0,0,1]; _edit ctrlSetFont "EtelkaMonospacePro"; _edit ctrlSetFontHeight 0.03; _edit ctrlCommit 0; private _longestLineWidth = 0; private _exampleString = "abcdefghijklmnopqrstuvxyz0134567890"; private _text = ""; for "_lines" from 1 to 400 do // loop through all lines and find the longest one { _lineText = _exampleString select [round random 35]; _longestLineWidth = _longestLineWidth max (_lineText getTextWidth ["EtelkaMonospacePro", 0.03]); _text = _text + _lineText + endl; }; _edit ctrlSetPositionW (_longestLineWidth + 2 * 0.008); // width of longest line + left and right margin set in engine _edit ctrlCommit 0; _edit ctrlSetText _text;

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| arma3
+|game1= arma3
+|version1= 1.78
-|1.78
 |gr1= GUI Control
-| Returns the width of the control text including left and right margins (0.008 each). Supported control [[ctrlType|types]] are:
+|descr= Returns the width of the control text including left and right margins (0.008 each). Supported control [[ctrlType|types]] are:
-* [[DialogControls-Text|CT_STATIC]] 0
+{{Columns|2|
+* [[CT_STATIC]] 0
 * [[CT_EDIT]] 2
-* [[DialogControls-Text|CT_STRUCTURED_TEXT]] 13
+* [[CT_STRUCTURED_TEXT]] 13
-{{Feature | Informative | For control-independent text width estimate see [[getTextWidth]]}}
+* {{GVI|arma3|2.06|size= 0.75}} [[CT_XKEYDESC]] 40
+* {{GVI|arma3|2.06|size= 0.75}} [[CT_XBUTTON]] 41
+* {{GVI|arma3|2.06|size= 0.75}} [[CT_SHORTCUTBUTTON]] 16
+* {{GVI|arma3|2.06|size= 0.75}} [[CT_BUTTON]] 1
+* {{GVI|arma3|2.06|size= 0.75}} [[CT_ACTIVETEXT]] 11
+}}
+{{Feature|informative|For control-independent text width estimate see [[getTextWidth]].}}
-| '''ctrlTextWidth''' control
+|s1= [[ctrlTextWidth]] control
 |p1= control: [[Control]]
-| [[Number]]
+|r1= [[Number]]
-|x1= <code>_w = [[ctrlTextWidth]] _ctrl;</code>
+|x1= <sqf>private _w = ctrlTextWidth _ctrl;</sqf>
-| [[getTextWidth]], [[ctrlTextHeight]], [[ctrlSetText]], [[ctrlType]], [[Arma: GUI Configuration]]
+|seealso= [[getTextWidth]] [[ctrlTextHeight]] [[ctrlSetText]] [[ctrlType]] [[Arma: GUI Configuration]]
 }}
+{{Note
+|user= R3vo
+|timestamp= 20201028221000
+|text= When working with multiline controls [[ctrlTextWidth]] or [[getTextWidth]] will not return a proper value since the text will be treated as one long line.<br>
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+'''Solution (Execute in [[:Category:Eden Editor|Eden Editor]]):'''
-{{GameCategory|arma3|New Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
+<sqf>
+disableSerialization;
-<!-- CONTINUE Notes -->
+private _display = findDisplay 313 createDisplay "RscDisplayEmpty";
-<dl class="command_description">
-<dd class="notedate">Posted on October 28, 2020 - 22:10 (UTC)</dd>
-<dt class="note">[[User:R3vo|R3vo]]</dt>
-<dd class="note">
-When working with multiline controls [[ctrlTextWidth]] or [[getTextWidth]] will not return a proper value since the text will be treated as one long line.</br>
-'''Solution (Execute in [[Eden Editor]]):'''
+private _edit = _display ctrlCreate ["RscEditMulti", -1];
+_edit ctrlSetPosition [0,0,1,1];
+_edit ctrlSetBackgroundColor [0,0,0,1];
+_edit ctrlSetFont "EtelkaMonospacePro";
+_edit ctrlSetFontHeight 0.03;
+_edit ctrlCommit 0;
-<code> [[disableSerialization]];
+private _longestLineWidth = 0;
+private _exampleString = "abcdefghijklmnopqrstuvxyz0134567890";
- [[private]] _display {{=}} [[findDisplay]] 313 [[createDisplay]] "RscDisplayEmpty";
+private _text = "";
- [[private]] _edit {{=}} _display [[ctrlCreate]] ["RscEditMulti", -1];
+for "_lines" from 1 to 400 do // loop through all lines and find the longest one
- _edit [[ctrlSetPosition]] [0,0,1,1];
+{
- _edit [[ctrlSetBackgroundColor]] [0,0,0,1];
+	_lineText = _exampleString select [round random 35];
- _edit [[ctrlSetFont]] "EtelkaMonospacePro";
+	_longestLineWidth = _longestLineWidth max (_lineText getTextWidth ["EtelkaMonospacePro", 0.03]);
- _edit [[ctrlSetFontHeight]] 0.03;
+	_text = _text + _lineText + endl;
- _edit [[ctrlCommit]] 0;
+};
- [[private]] _longestLineWidth {{=}} 0;
+_edit ctrlSetPositionW (_longestLineWidth + 2 * 0.008); // width of longest line + left and right margin set in engine
- [[private]] _exampleString {{=}} "abcdefghijklmnopqrstuvxyz0134567890";
+_edit ctrlCommit 0;
- [[private]] _text {{=}} "";
+_edit ctrlSetText _text;
+</sqf>
- [[for]] "_lines" [[from]] 1 [[to]] 400 [[do]] {{cc|Loop through all lines and find the longest one}}
+}}
- {
-    _lineText {{=}} _exampleString [[select]] [<nowiki/>[[round]] [[random]] 35];
-    _longestLineWidth {{=}} _longestLineWidth [[max]] (_lineText [[getTextWidth]] ["EtelkaMonospacePro", 0.03]);
-    _text {{=}} _text [[+]] _lineText [[+]] [[endl]];
- };
- _edit [[ctrlSetPositionW]] (_longestLineWidth [[+]] 2 * 0.008); {{cc|Width of longest line + left and right margin set in engine}}
- _edit [[ctrlCommit]] 0;
- _edit [[ctrlSetText]] _text;</code>
-</dd>