ctrlSetText: Difference between revisions

From Bohemia Interactive Community
mNo edit summary
No edit summary
 
(69 intermediate revisions by 15 users not shown)
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. 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 [[Dialog Control]] for more information about user dialogs and controls. |= Description
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| '''ctrlSetText''' [idc, text] |= Syntax
|game6= tkoh
|version6= 1.00


|p1= idc: [[Integer]] - control ID |= Parameter 1
|game7= arma3
|version7= 0.50


|p2= text: [[String]] - text or image path, depending on the control type |= Parameter 2
|arg= local


| [[Nothing]] |= Return value
|eff= local
____________________________________________________________________________________________
 
|x1= ctrlSetText [100, "Hello world"] |= Example 1
____________________________________________________________________________________________


| [[ctrlText]] |= See also
|gr1= GUI Control


|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.
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]]
}}
}}


<h3 style="display:none">Notes</h3>
Since {{GVI|arma3|2.22|size= 0.75}} [[CT_PROGRESS]] is also supported.
<dl class="command_description">
 
<!-- Note Section BEGIN -->
|s1= [[ctrlSetText]] [idc, text]
 
|p1= idc: [[Number]] - control IDC
 
|p2= text: [[String]] - text or image path or texture, depending on the control type


<!-- Note Section END -->
|r1= [[Nothing]]
</dl>


<h3 style="display:none">Bottom Section</h3>
|s2= control [[ctrlSetText]] text


[[Category:Scripting Commands|CTRLSETTEXT]]
|p21= control: [[Control]] - control
[[Category:Scripting Commands OFP 1.96|CTRLSETTEXT]]
 
[[Category:Scripting Commands ArmA|CTRLSETTEXT]]
|p22= text: [[String]] - text or image path or texture, depending on the control type
 
|r2= [[Nothing]]
 
|x1= <sqf>ctrlSetText [100, "Hello world"]; // for Dialogs</sqf>
 
|x2= <sqf>_control ctrlSetText "Hello world."; // for Displays</sqf>
 
|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>
 
|seealso= [[ctrlText]] [[ctrlTextSelection]] [[ctrlSetTextSelection]]
}}

Latest revision as of 17:15, 26 April 2026

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 Arma 3 logo black.png 2.06 supported control types are: Since Arma 3 logo black.png 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