ctrlText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " 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


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


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


| '''ctrlText''' idc |SYNTAX=
| '''ctrlText''' idc


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


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


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


|p21= controlName: [[Control]] |PARAMETER21=
|p21= controlName: [[Control]] |PARAMETER21=


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


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


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


}}
}}

Revision as of 01:30, 18 January 2021

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

Bottom Section

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