ctrlText: 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 7: Line 6:


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


| Returns the text of a control of the currently active user dialog. This command can be used on static texts, buttons, edit lines and active texts as well as for images, where it returns the image path. Does not work on HTML control and returns empty string "". |DESCRIPTION=
| Returns the text of a control of the currently active user dialog. This command can be used on static texts, buttons, edit lines and active texts as well as for images, where it returns the image path. Does not work on HTML control and returns empty string "". |DESCRIPTION=
____________________________________________________________________________________________


| '''ctrlText''' idc |SYNTAX=
| '''ctrlText''' idc |SYNTAX=
Line 17: Line 14:


| [[String]] - The text or image path is returned, dependent on the control type. |RETURNVALUE=
| [[String]] - The text or image path is returned, dependent on the control type. |RETURNVALUE=
____________________________________________________________________________________________


|s2= '''ctrlText''' controlName |Alternative Syntax=
|s2= '''ctrlText''' controlName |Alternative Syntax=
Line 24: Line 20:


|r2= [[String]] - (as above). |RETURNVALUE2=
|r2= [[String]] - (as above). |RETURNVALUE2=
____________________________________________________________________________________________
   
   
|x1= <code>_text = [[ctrlText]] 100</code> |EXAMPLE1=
|x1= <code>_text = [[ctrlText]] 100</code> |EXAMPLE1=


|x2= <code>_text = [[ctrlText]] _control</code> |EXAMPLE2=
|x2= <code>_text = [[ctrlText]] _control</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[ctrlTextSecondary]], [[ctrlSetText]], [[Arma: GUI Configuration]] |SEEALSO=
| [[ctrlTextSecondary]], [[ctrlSetText]], [[Arma: GUI Configuration]] |SEEALSO=

Revision as of 00:39, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns the text of a control of the currently active user dialog. This command can be used on static texts, buttons, edit lines and active texts as well as for images, where it returns the image path. Does not work on HTML control and returns empty string "".
Groups:
GUI Control

Syntax

Syntax:
ctrlText idc
Parameters:
idc: Number - control ID
Return Value:
String - The text or image path is returned, dependent on the control type.

Alternative Syntax

Syntax:
ctrlText controlName
Parameters:
controlName: Control
Return Value:
String - (as above).

Examples

Example 1:
_text = ctrlText 100
Example 2:
_text = ctrlText _control

Additional Information

See also:
ctrlTextSecondaryctrlSetTextArma: GUI Configuration

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