ctrlSetText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (template:command argument fix)
Line 13: Line 13:
| 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 [[Dialog Control]] for more information about user dialogs and controls. |= Description
Read [[Dialog Control]] for more information about user dialogs and controls. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


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


|p3= text: [[String]] - text or image path, depending on the control type |= Parameter 3
|p3= text: [[String]] - text or image path, depending on the control type |PARAMETER3=


| [[Nothing]] |= Return value
| [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 33: Line 33:
|p22= text: [[String]] |=
|p22= text: [[String]] |=


|r2= [[Nothing]] |= Return value
|r2= [[Nothing]] |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <pre>ctrlSetText [100, "Hello world"];//for Dialogs</pre> |= Example 1
|x1= <pre>ctrlSetText [100, "Hello world"];//for Dialogs</pre> |EXAMPLE1=


|x2= <pre>_control ctrlSetText "Hello world.";// for Displays</pre> |= Example 2
|x2= <pre>_control ctrlSetText "Hello world.";// for Displays</pre> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[ctrlText]] |= See also
| [[ctrlText]] |SEEALSO=


}}
}}

Revision as of 15:37, 7 April 2019

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 Dialog Control for more information about user dialogs and controls.
Groups:
Uncategorised

Syntax

Syntax:
ctrlSetText [idc, text]
Parameters:
[idc, text]: Array
idc: Integer - control ID
text: String - text or image path, depending on the control type
Return Value:
Nothing

Alternative Syntax

Syntax:
controlName ctrlSetText text
Parameters:
controlName: 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

Posted on 16 Nov, 2011
HomerJohnston
For ArmA2 textured "shortcut" buttons (type = 16), you must use the alternative syntax.

Bottom Section

Posted on October 16, 2016 - 22:32 (UTC)
Killzone Kid
When using ctrlSetText with picture control, the path to the texture is cached, so that if the new texture is from the same file as old one, the precious CPU cycles would not be wasted on reloading it.