ctrlText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(no need for locality info)
m (template:command argument fix)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


|p1= idc: [[Number]] - control ID |= Parameter 1
|p1= idc: [[Number]] - control ID |PARAMETER1=


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


|s2= '''ctrlText''' controlName |= Alternative Syntax
|s2= '''ctrlText''' controlName |= Alternative Syntax


|p21= controlName: [[Control]] |= Parameter 1
|p21= controlName: [[Control]] |PARAMETER1=


|r2= [[String]] - (as above). |= Return value
|r2= [[String]] - (as above). |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>_text = [[ctrlText]] 100</code> |= Example 1
|x1= <code>_text = [[ctrlText]] 100</code> |EXAMPLE1=


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


| [[ctrlTextSecondary]], [[ctrlSetText]], [[Dialog Control]] |= See also
| [[ctrlTextSecondary]], [[ctrlSetText]], [[Dialog Control]] |SEEALSO=


}}
}}

Revision as of 14:37, 7 April 2019

Logo A0.png1.5
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:
Uncategorised

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

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

Retrieved from "https://community.bistudio.com/wiki?title=ctrlText&oldid=121296"