ctrlSetText: Difference between revisions

Latest revision as of 00:08, 4 April 2024

1.75

1.00

Hover & click on the images for description

Description

Description:

Sets the text of a control of the currently active user dialog or display. This command can be used for static texts, buttons, edit lines and active texts as well as for images, where you can use it to set the image path.
Read Arma: GUI Configuration for more information about user dialogs and controls.
Use endl to insert line breaks. Since

2.06 supported control types are:

Groups:

GUI Control

Syntax

Syntax:: ctrlSetText [idc, text]
Parameters:: idc: Number - control IDC
: text: String - text or image path, depending on the control type
Return Value:: Nothing

Alternative Syntax

Syntax:: control ctrlSetText text
Parameters:: control: Control
: text: String
Return Value:: Nothing

Examples

Example 1:: ctrlSetText [100, "Hello world"]; // for Dialogs
Example 2:: _control ctrlSetText "Hello world."; // for Displays

Additional Information

See also:: ctrlText ctrlTextSelection ctrlSetTextSelection

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: @@
-back to [[Scripting_Reference#C|COMREF]]
+{{RV|type=command
-<h2 style="color:#000066"> '''ctrlSetText [''idc'', ''text'']'''</h2>
+|game1= ofp
+|version1= 1.75
+|game2= ofpe
+|version2= 1.00
-'''Operand types:'''
+|game3= arma1
+|version3= 1.00
-'''[idc, text]:''' [[Array]]
+|game4= arma2
+|version4= 1.00
-'''Type of returned value:'''
+|game5= arma2oa
+|version5= 1.50
-[[Nothing]]
+|game6= tkoh
+|version6= 1.00
-'''Description:'''
+|game7= arma3
+|version7= 0.50
-Set '''text''' will be shown in control with id '''idc''' of topmost user [[dialog]].
+|arg= local
-Can be used for static texts, buttons, edit lines and active texts.
+|eff= local
+|gr1= GUI Control
-'''Example:'''
+|descr= Sets the text of a control of the currently active user dialog or display.
+This command can be used for static texts, buttons, edit lines and active texts as well as for images, where you can use it to set the image path.
+<br>
+Read [[Arma: GUI Configuration]] for more information about user dialogs and controls.<br>
+Use [[endl]] to insert line breaks.
-'''ctrlSetText''' [100, "Hello world"]
+Since {{GVI|arma3|2.06|size= 0.75}} supported control types are:
+{{Columns|4|
+* [[CT_STATIC]]
+* [[CT_EDIT]]
+* [[CT_XKEYDESC]]
+* [[CT_XBUTTON]]
+* [[CT_SHORTCUTBUTTON]]
+* [[CT_STRUCTURED_TEXT]]
+* [[CT_BUTTON]]
+* [[CT_ACTIVETEXT]]
+}}
+|s1= [[ctrlSetText]] [idc, text]
+|p1= idc: [[Number]] - control IDC
+|p2= text: [[String]] - text or image path, depending on the control type
+|r1= [[Nothing]]
+|s2= control [[ctrlSetText]] text
+|p21= control: [[Control]]
+|p22= text: [[String]]
+|r2= [[Nothing]]
+|x1= <sqf>ctrlSetText [100, "Hello world"]; // for Dialogs</sqf>
+|x2= <sqf>_control ctrlSetText "Hello world."; // for Displays</sqf>
+|seealso= [[ctrlText]] [[ctrlTextSelection]] [[ctrlSetTextSelection]]
+}}