ctrlTextSelection: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 2.00


|2.00 |Game version=
|gr1= GUI Control


|gr1= GUI Control |GROUP1=
|descr=Returns edit control text selection in format [start, length, selectedText].
____________________________________________________________________________________________
{{Feature|informative|''length'' can be negative if text selection is made from right to left. Use [[abs]] with ''length'' or [[count]] with {{hl|selectedText}} if string length is required. ''start'' always indicates at what position in text the selection is started. The cursor position will always be at the end of the selection. So if selection is made from right to left the cursor position will be at the left end of the selection. In order to find cursor position add ''start'' and ''length'' together (see {{Link|#Example 3}}).}}


|Returns edit control text selection in format [start, length, selectedText].
|s1= [[ctrlTextSelection]] control
{{Informative|<tt>length</tt> could be negative if text selection is made from right to left. Use [[abs]] with <tt>length</tt> or [[count]] with <tt>selectedText</tt> if string length is required. <tt>start</tt> always indicates at what position in text selection is started. The cursor position will always be at the end of the selection. So if selection is made from right to left the cursor position will be at the left end of the selection. In order to find cursor position add <tt>start</tt> and <tt>length</tt> together (see example 3)}}
|DESCRIPTION=
____________________________________________________________________________________________


| [[ctrlTextSelection]] control |SYNTAX=
|p1= control: [[Control]]


|p1= control: [[Control]] |PARAMETER1=
|r1= [[Array]] in format [start, length, selectedText] where:
 
| [[Array]] in format [start, length, selectedText] where:
* start: [[Number]] - position in text selection started
* start: [[Number]] - position in text selection started
* length: [[Number]] - number of the highlighted characters (this number could be negative, see description)
* length: [[Number]] - number of the highlighted characters (this number could be negative, see description)
* selectedText: [[String]] - selected text
* selectedText: [[String]] - selected text
|RETURNVALUE=


____________________________________________________________________________________________
|x1= Selection is made from left to right:
<sqf>ctrlTextSelection _control; //[0, 11, "Hello World"];</sqf>


|x1= Selection is made from left to right:<code>[[ctrlTextSelection]] _control; //[0, 11, "Hello World"]</code>|EXAMPLE1=
|x2= Selection is made from right to left:
|x2= Selection is made from right to left:<code>[[ctrlTextSelection]] _control; //[11, -11, "Hello World"]</code>|EXAMPLE2=
<sqf>ctrlTextSelection _control; //[11, -11, "Hello World"];</sqf>
|x3= Find cursor position:<code>[[ctrlTextSelection]] _control [[params]] ["_start", "_length"];
[[private]] _cursorPos = _start + _length;</code>|EXAMPLE3=
____________________________________________________________________________________________


| [[ctrlSetTextSelection]] |SEEALSO=
|x3= Find cursor position:
<sqf>
ctrlTextSelection _control params ["_start", "_length"];
private _cursorPos = _start + _length;
</sqf>


|seealso= [[ctrlSetTextSelection]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
{{GameCategory|arma3|Scripting Commands}}

Latest revision as of 00:25, 2 February 2024

Arma 3 logo black.png2.00
Hover & click on the images for description

Description

Description:
Returns edit control text selection in format [start, length, selectedText].
ⓘ
length can be negative if text selection is made from right to left. Use abs with length or count with selectedText if string length is required. start always indicates at what position in text the selection is started. The cursor position will always be at the end of the selection. So if selection is made from right to left the cursor position will be at the left end of the selection. In order to find cursor position add start and length together (see Example 3).
Groups:
GUI Control

Syntax

Syntax:
ctrlTextSelection control
Parameters:
control: Control
Return Value:
Array in format [start, length, selectedText] where:
  • start: Number - position in text selection started
  • length: Number - number of the highlighted characters (this number could be negative, see description)
  • selectedText: String - selected text

Examples

Example 1:
Selection is made from left to right:
ctrlTextSelection _control; //[0, 11, "Hello World"];
Example 2:
Selection is made from right to left:
ctrlTextSelection _control; //[11, -11, "Hello World"];
Example 3:
Find cursor position:
ctrlTextSelection _control params ["_start", "_length"]; private _cursorPos = _start + _length;

Additional Information

See also:
ctrlSetTextSelection

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=ctrlTextSelection&oldid=352154"