ctrlText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(game[0-9]|version[0-9]|gr[0-9]|serverExec|mp|pr|descr|s[0-9]|p[0-9]{1,3}|r[0-9]|x1?[0-9]|seealso) *= +" to " |$1= ")
(43 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| ofp |= Game name
|game1= ofp
|version1= 1.75


|1.5|= Game version
|game2= ofpe
|version2= 1.00


|arg= local |= Arguments in MP
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| 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.
|game4= arma2
|version4= 1.00


Read [[Dialog Control]] for more information about user dialogs and controls. |= Description
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| [[String]] <nowiki>=</nowiki>  '''ctrlText''' idc |= Syntax
|game6= tkoh
|version6= 1.00


|p1= idc: [[Number]] - control ID |= Parameter 1
|game7= arma3
|version7= 0.50


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


|s2= [[String]] <nowiki>=</nowiki>  '''ctrlText''' controlName |= Alternative Syntax
|descr= 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 "". Since Arma 3 v2.05.147765 supported control types are:
* [[CT_STATIC]]
* [[CT_EDIT]]
* [[CT_XKEYDESC]]
* [[CT_XBUTTON]]
* [[CT_SHORTCUTBUTTON]]
* [[CT_STRUCTURED_TEXT]]
* [[CT_BUTTON]]
* [[CT_ACTIVETEXT]]


|p21= controlName: [[Control]] |= Parameter 1
|s1= [[ctrlText]] idc


|r2= [[String]] - (as above). |= Return value
|p1= idc: [[Number]] - control ID
____________________________________________________________________________________________
 
|x1= <pre>_text = ctrlText 100</pre> |= Example 1


|x2= <pre>_text = ctrlText _control</pre> |= Example 2
|r1= [[String]] - The text or image path is returned, dependent on the control type
____________________________________________________________________________________________


| [[ctrlSetText]] |= See also
|s2= [[ctrlText]] controlName


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


<h3 style="display:none">Notes</h3>
|r2= [[String]] - The text or image path is returned, dependent on the control type
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <code>_text = [[ctrlText]] 100;</code>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <code>_text = [[ctrlText]] _control;</code>


[[Category:Scripting Commands|CTRLTEXT]]
|seealso= [[ctrlTextSecondary]], [[ctrlSetText]], [[Arma: GUI Configuration]]
[[Category:Scripting Commands OFP 1.96|CTRLTEXT]]
}}
[[Category:Scripting Commands ArmA|CTRLTEXT]]
[[Category:Command_Group:_GUI_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 23:04, 19 June 2021

Logo A0.png1.75ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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 "". Since Arma 3 v2.05.147765 supported control types are:
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 - The text or image path is returned, dependent on the control type

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
Retrieved from "https://community.bistudio.com/wiki?title=ctrlText&oldid=283889"