ctrlSetText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Command|Comments=
{{Command|Comments=
____________________________________________________________________________________________


| ofp |Game name=
| ofp |Game name=
Line 11: Line 10:


|gr1= GUI Control |GROUP1=
|gr1= GUI Control |GROUP1=
____________________________________________________________________________________________


| 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.
| 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.
Line 17: Line 15:
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=
{{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=  
Line 28: Line 25:


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________


|s2= control [[ctrlSetText]] text |Alternative Syntax=
|s2= control [[ctrlSetText]] text |Alternative Syntax=
Line 37: Line 33:


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


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


| [[ctrlText]] [[ctrlTextSelection]] [[ctrlSetTextSelection]] |SEEALSO=
| [[ctrlText]] [[ctrlTextSelection]] [[ctrlSetTextSelection]] |SEEALSO=

Revision as of 01:40, 17 January 2021

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:
GUI Control

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 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

Notes

Bottom Section