ctrlSetText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Dialog Control" to "Arma: GUI Configuration")
m (Fix description)
Line 14: Line 14:


Read [[Arma: GUI Configuration]] for more information about user dialogs and controls.
Read [[Arma: GUI Configuration]] for more information about user dialogs and controls.
 
{{Warning | <tt>[[ctrlSetText]] [idc, text]</tt> syntax does not support [[CT_SHORTCUTBUTTON]], but the alternative syntax <tt>control [[ctrlSetText]] text</tt> does.}} |DESCRIPTION=
<br><br>{{Warning | <tt>[[ctrlSetText]] [idc, text]</tt> syntax does not support [[CT_SHORTCUTBUTTON]], but the alternative syntax <tt>control [[ctrlSetText]] text</tt> does. }} |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''ctrlSetText''' [idc, text] |SYNTAX=  
| [[ctrlSetText]] [idc, text] |SYNTAX=  


|p1= [idc, text]: [[Array]] |PARAMETER1=
|p1= [idc, text]: [[Array]] |PARAMETER1=


|p2= idc: [[Integer]] - control ID |PARAMETER2=
|p2= idc: [[Number]] - control ID |PARAMETER2=


|p3= text: [[String]] - text or image path, depending on the control type |PARAMETER3=
|p3= text: [[String]] - text or image path, depending on the control type |PARAMETER3=
Line 29: Line 28:
____________________________________________________________________________________________
____________________________________________________________________________________________


|s2= control '''ctrlSetText''' text |Alternative Syntax=
|s2= control [[ctrlSetText]] text |Alternative Syntax=


|p21=  control: [[Control]] |PARAMETER21=
|p21=  control: [[Control]] |PARAMETER21=


|p22= text: [[String]] |=
|p22= text: [[String]] |PARAMETER22=


|r2= [[Nothing]] |RETURNVALUE2=
|r2= [[Nothing]] |RETURNVALUE2=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>[[ctrlSetText]] [100, "Hello world"]; // for Dialogs</code> |EXAMPLE1=
|x1= <code>[[ctrlSetText]] [100, "Hello world"]; {{cc|for Dialogs}}</code> |EXAMPLE1=


|x2= <code>_control [[ctrlSetText]] "Hello world."; // for Displays</code> |EXAMPLE2=
|x2= <code>_control [[ctrlSetText]] "Hello world."; {{cc|for Displays}}</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[ctrlText]] |SEEALSO=
| [[ctrlText]] |SEEALSO=
}}
}}


Line 55: Line 53:
<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>


[[Category:Scripting Commands|CTRLSETTEXT]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|CTRLSETTEXT]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|CTRLSETTEXT]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|CTRLSETTEXT]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: GUI Control|{{uc:{{PAGENAME}}}}]]

Revision as of 20:19, 11 March 2020

Hover & click on the images for description

Description

Description:
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. Read Arma: GUI Configuration for more information about user dialogs and controls.
ctrlSetText [idc, text] syntax does not support CT_SHORTCUTBUTTON, but the alternative syntax control ctrlSetText text does.
Groups:
Uncategorised

Syntax

Syntax:
ctrlSetText [idc, text]
Parameters:
[idc, text]: Array
idc: Number - control ID
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

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

Notes

Bottom Section