TextEdit.SelectionStart Property

Gets or sets the starting point of text selected in the text box.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[Browsable(false)]
public int SelectionStart { get; set; }

VB.NET

<Browsable(False)>
Public Property SelectionStart As Integer

Property Value

Type	Description
Int32	An integer value specifying the starting point of text selected in the text box.

Remarks

If no text is selected within the editor, this property indicates the insertion point for new text (the caret position). If you set this property to a location beyond the length of the text in the control, selection start position will be placed after the last character. If the remaining text in the control after the position indicated by the SelectionStart property is less than the value of the TextEdit.SelectionLength property, the value of the TextEdit.SelectionLength property is automatically decreased. The value of the SelectionStart property never causes an increase in the TextEdit.SelectionLength property.

You can programmatically move the caret within the text box by setting SelectionStart to the position within the text box where you want the caret to move to and set the TextEdit.SelectionLength property to zero.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectionStart property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

mvvm-best-practices-t228317/CS/Messenger/SendingAndReceivingMessagesUserControl.cs#L60

memo.Text += ("String message: " + message + Environment.NewLine);
memo.SelectionStart = memo.Text.Length;
memo.ScrollToCaret();

how-to-create-a-text-editor-to-show-auto-completion-suggestions-in-the-popup-e3055/CS/TextEditPopUp/RepositoryItemTextEditPopUp.cs#L147

    (sender as TextEditPopUp).Focus();
    (sender as TextEditPopUp).SelectionStart = editValue.Length;
}

how-to-create-an-analog-of-gridlookupedit-with-treelist-in-a-popup-window-e4319/CS/TreeListLookUpEdit.cs#L119

AutoSearchText = filterText;
this.SelectionStart = helper.GetCorrectedAutoSearchSelectionStart(Text, pressedKey);
this.SelectionLength = nodeText.Length - this.SelectionStart;

how-to-allow-entering-text-into-the-memoexedit-directly-using-the-popupcontaineredit-control-e2171/CS/WindowsFormsApplication10/Form1.cs#L46

{
    (sender as TextEdit).SelectionStart = 0;
    (sender as TextEdit).SelectionLength = (sender as TextEdit).Text.Length;

how-to-implement-the-path-autocomplete-feature-in-the-comboboxedit-e2639/CS/WindowsApplication1/Form1.cs#L98

{
    editor.SelectionStart = editor.Text.Length;
    e.Handled = true;

VB.NET

mvvm-best-practices-t228317/VB/Messenger/SendingAndReceivingMessagesUserControl.vb#L58

memo.Text += ("String message: " & message & Environment.NewLine)
memo.SelectionStart = memo.Text.Length
memo.ScrollToCaret()

how-to-create-a-text-editor-to-show-auto-completion-suggestions-in-the-popup-e3055/VB/TextEditPopUp/RepositoryItemTextEditPopUp.vb#L145

    TryCast(sender, TextEditPopUp).Focus()
    TryCast(sender, TextEditPopUp).SelectionStart = editValue.Length
Else

how-to-create-an-analog-of-gridlookupedit-with-treelist-in-a-popup-window-e4319/VB/TreeListLookUpEdit.vb#L120

AutoSearchText = filterText
Me.SelectionStart = helper.GetCorrectedAutoSearchSelectionStart(Text, pressedKey)
Me.SelectionLength = nodeText.Length - Me.SelectionStart

how-to-allow-entering-text-into-the-memoexedit-directly-using-the-popupcontaineredit-control-e2171/VB/WindowsFormsApplication10/Form1.vb#L40

Private Sub Properties_CloseUp(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.CloseUpEventArgs)
    TryCast(sender, TextEdit).SelectionStart = 0
    TryCast(sender, TextEdit).SelectionLength = (TryCast(sender, TextEdit)).Text.Length

how-to-implement-the-path-autocomplete-feature-in-the-comboboxedit-e2639/VB/WindowsApplication1/Form1.vb#L87

If e.KeyCode = Keys.End Then
    editor.SelectionStart = editor.Text.Length
    e.Handled = True