Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


selection

Gets or sets the character range of the selected text within the string currently being edited.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Property
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public RangeInt selection { get; set; }

Remarks

For example: if the keyboard is editing a TouchScreenKeyboard.text "abcdef" and the "cde" substring is selected, the return value is a RangeInt with the RangeInt.start value set to 2 and a RangeInt.length value of 3. Similarly, setting selection to a RangeInt with the RangeInt.start value set to 2 and a RangeInt.length value of 3 will select "cde" of the string "abcdef".
If the caret is between two characters and no text is selected, then the RangeInt.length property is 0.
This always returns an empty range (start 0, length 0) if TouchScreenKeyboard.canGetSelection is false.