ctrlSetText: Difference between revisions

Latest revision as of 17:15, 26 April 2026

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:

Since

2.22 CT_PROGRESS is also supported.

Groups:

GUI Control

Syntax

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

Alternative Syntax

Syntax:: control ctrlSetText text
Parameters:: control: Control - control
: text: String - text or image path or texture, depending on the control type
Return Value:: Nothing

Examples

Example 1:: ctrlSetText [100, "Hello world"]; // for Dialogs
Example 2:: _control ctrlSetText "Hello world."; // for Displays
Example 3:: Since Arma 3 2.22:
with uiNamespace do { bar = findDisplay 46 ctrlCreate ["RscProgress", -1]; bar ctrlSetText "\A3\Data_F\Flags\Flag_red_CO.paa"; bar ctrlSetPosition [0,0,1,0.25]; bar ctrlCommit 0; bar progressSetPosition 0.7; };

Additional Information

See also:: ctrlText ctrlTextSelection ctrlSetTextSelection

Notes

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| ofp |= Game name
+|game1= ofp
+|version1= 1.75
-|1.5|= Game version
+|game2= ofpe
+|version2= 1.00
-|arg= local |= Arguments in MP
+|game3= arma1
+|version3= 1.00
-|eff= local |= Effects in MP
+|game4= arma2
-____________________________________________________________________________________________
+|version4= 1.00
-| Set 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.
+|game5= arma2oa
+|version5= 1.50
-Read [[Dialog Control]] for more information about user dialogs and controls. |= Description
+|game6= tkoh
-____________________________________________________________________________________________
+|version6= 1.00
-| '''ctrlSetText''' [idc, text] |= Syntax
+|game7= arma3
+|version7= 0.50
-|p1= [idc, text]: [[Array]] |= Parameter 1
+|arg= local
-|p2= idc: [[Integer]] - control ID |= Parameter 2
+|eff= local
-|p3= text: [[String]] - text or image path, depending on the control type |= Parameter 3
+|gr1= GUI Control
-| [[Nothing]] |= Return value
+|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.
-|s2= controlName '''ctrlSetText''' text |= Alternative Syntax
+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]]
+}}
+Since {{GVI|arma3|2.22|size= 0.75}} [[CT_PROGRESS]] is also supported.
+|s1= [[ctrlSetText]] [idc, text]
+|p1= idc: [[Number]] - control IDC
-|p21=  controlName: [[Control]] |=
+|p2= text: [[String]] - text or image path or texture, depending on the control type
-|p22= text: [[String]] |=
+|r1= [[Nothing]]
-|r2= [[Nothing]] |= Return value
+|s2= control [[ctrlSetText]] text
-____________________________________________________________________________________________
-|x1= <pre>ctrlSetText [100, "Hello world"];//for Dialogs</pre> |= Example 1
-|x2= <pre>_control ctrlSetText "Hello world.";// for Displays</pre> |= Example 2
+|p21= control: [[Control]] - control
-____________________________________________________________________________________________
-| [[ctrlText]] |= See also
+|p22= text: [[String]] - text or image path or texture, depending on the control type
-}}
+|r2= [[Nothing]]
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>ctrlSetText [100, "Hello world"]; // for Dialogs</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x2= <sqf>_control ctrlSetText "Hello world."; // for Displays</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x3= Since Arma 3 2.22:
+<sqf>with uiNamespace do
+{
+ bar = findDisplay 46 ctrlCreate ["RscProgress", -1];
+ bar ctrlSetText "\A3\Data_F\Flags\Flag_red_CO.paa";
+ bar ctrlSetPosition [0,0,1,0.25];
+ bar ctrlCommit 0;
+ bar progressSetPosition 0.7;
+};
+</sqf>
-[[Category:Scripting Commands|CTRLSETTEXT]]
+|seealso= [[ctrlText]] [[ctrlTextSelection]] [[ctrlSetTextSelection]]
-[[Category:Scripting Commands OFP 1.96|CTRLSETTEXT]]
+}}
-[[Category:Scripting Commands ArmA|CTRLSETTEXT]]
-[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]