ctrlTextSelection: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "|gr1= GUI Control |GROUP1= ||gr1= GUI Control|GROUP1=" to "|gr1= GUI Control |GROUP1=") |
Killzone Kid (talk | contribs) (example info) |
||
Line 9: | Line 9: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|Returns edit control text selection in format [start, length, selectedText] |DESCRIPTION= | |Returns edit control text selection in format [start, length, selectedText]. | ||
{{Warning|<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= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Line 16: | Line 18: | ||
|p1= control: [[Control]] |PARAMETER1= | |p1= control: [[Control]] |PARAMETER1= | ||
| [[Array]] |RETURNVALUE= | | [[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 | |||
|RETURNVALUE= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>[[ctrlTextSelection]] _control</code>|EXAMPLE1= | |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:<code>[[ctrlTextSelection]] _control; //[11, -11, "Hello World"]</code>|EXAMPLE2= | |||
|x3= Find cursor position:<code>[[ctrlTextSelection]] _control [[params]] ["_start", "_length"]; | |||
[[private]] _cursorPos = _start + _length;</code>|EXAMPLE3= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 00:40, 9 October 2020
Description
- Description:
- Returns edit control text selection in format [start, length, selectedText].
- Groups:
- GUI Control
Syntax
- Syntax:
- ctrlTextSelection control
- Parameters:
- control: Control
- Return Value:
- Array in format [start, length, selectedText] where:
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
[[Category:Introduced with arma3dev version 1.99]][[ Category: arma3dev: New Scripting Commands | CTRLTEXTSELECTION]][[ Category: arma3dev: Scripting Commands | CTRLTEXTSELECTION]]