ctrlText: Difference between revisions

Latest revision as of 15:50, 8 November 2023

1.75

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:

Returns the text of a control of the currently active user dialog. This command can be used on static texts, buttons, edit lines and active texts as well as for images, where it returns the image path. Does not work on HTML control and returns empty string "". Since Arma 3 v2.05.147765 supported control types are:

Groups:

GUI Control

Syntax

Syntax:: ctrlText idc
Parameters:: idc: Number - control ID
Return Value:: String - the text or image path is returned, dependent on the control type

Alternative Syntax

Syntax:: ctrlText controlName
Parameters:: controlName: Control
Return Value:: String - the text or image path is returned, dependent on the control type

Examples

Example 1:: _text = ctrlText 100;
Example 2:: _text = ctrlText _control;

Additional Information

See also:: ctrlTextSecondary ctrlSetText 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

@@ Line 1: / Line 1: @@
-[[Category:Scripting Commands]]
+{{RV|type=command
-[[Category:Scripting Commands OFP 1.97]]
-[[Category:Scripting Commands ArmA]]
-back to [[Scripting_Reference#C|COMREF]]
+|game1= ofp
+|version1= 1.75
-<h2 style="color:#000066"> '''ctrlText ''idc'''''</h2>
+|game2= ofpe
+|version2= 1.00
+|game3= arma1
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2
+|version4= 1.00
-'''idc:''' [[Number]]
+|game5= arma2oa
+|version5= 1.50
-'''Type of returned value:'''
+|game6= tkoh
+|version6= 1.00
-[[String]]
+|game7= arma3
+|version7= 0.50
-'''Compatibility:'''
+|gr1= GUI Control
-Added in version '''1.50'''
+|descr= Returns the text of a control of the currently active user dialog. This command can be used on static texts, buttons, edit lines and active texts as well as for images, where it returns the image path. Does not work on HTML control and returns empty string "". Since Arma 3 v2.05.147765 supported control types are:
+* [[CT_STATIC]]
+* [[CT_EDIT]]
+* [[CT_XKEYDESC]]
+* [[CT_XBUTTON]]
+* [[CT_SHORTCUTBUTTON]]
+* [[CT_STRUCTURED_TEXT]]
+* [[CT_BUTTON]]
+* [[CT_ACTIVETEXT]]
-'''Description:'''
+|s1= [[ctrlText]]  idc
-Return text shown in control with id '''idc''' of topmost user [[dialog]].
+|p1= idc: [[Number]] - control ID
-Can be used for static texts, buttons, edit lines and active texts.
+|r1= [[String]] - the text or image path is returned, dependent on the control type
+|s2= [[ctrlText]]  controlName
-'''Example:'''
+|p21= controlName: [[Control]]
-_message = '''ctrlText''' 100
+|r2= [[String]] - the text or image path is returned, dependent on the control type
+|x1= <sqf>_text = ctrlText 100;</sqf>
+|x2= <sqf>_text = ctrlText _control;</sqf>
+|seealso= [[ctrlTextSecondary]] [[ctrlSetText]] [[Arma: GUI Configuration]]
+}}