ctrlText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(misleading note implying that as of latest version command doesnt work for HTML control. It was always the case. Added this to the description. see also)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


| [[String]] <nowiki>=</nowiki>  '''ctrlText''' idc |= Syntax
| '''ctrlText''' idc |= Syntax


|p1= idc: [[Number]] - control ID |= Parameter 1
|p1= idc: [[Number]] - control ID |= Parameter 1
Line 21: Line 21:
____________________________________________________________________________________________
____________________________________________________________________________________________


|s2= [[String]] <nowiki>=</nowiki>  '''ctrlText''' controlName |= Alternative Syntax
|s2= '''ctrlText''' controlName |= Alternative Syntax


|p21= controlName: [[Control]] |= Parameter 1
|p21= controlName: [[Control]] |= Parameter 1
Line 28: Line 28:
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <pre>_text = ctrlText 100</pre> |= Example 1
|x1= <code>_text = [[ctrlText]] 100</code> |= Example 1


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


| [[ctrlSetText]] |= See also
| [[ctrlTextSecondary]], [[ctrlSetText]] |= See also


}}
}}
Line 54: Line 54:
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on October 25, 2018 - 05:41 (UTC)</dd>
<dt class="note">[[User:demellion|demellion]]</dt>
<dd class="note">
As of '''Arma 3 1.84''' this command will always return empty string from [[HTML-Files|RscHTML]] controls type.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 09:58, 25 October 2018

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

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