ctrlSetText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.5|Game version=
|1.5


|arg= local |Multiplayer Arguments=
|arg= local


|eff= local |Multiplayer Effects=
|eff= local


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


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


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


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


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


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


|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


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


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


|p21=  control: [[Control]] |PARAMETER21=
|p21=  control: [[Control]] |PARAMETER21=
Line 32: Line 32:
|p22= text: [[String]] |PARAMETER22=
|p22= text: [[String]] |PARAMETER22=


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


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


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



Revision as of 00:28, 18 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