RichEditControl.DeselectAll() Method

Specifies that no content is selected in the control.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v19.1.dll

Declaration

C#

public void DeselectAll()

VB.NET

Public Sub DeselectAll

Example

The following code resets document selection and sets the caret to the end of the former selection.

The RichEditControl instance is passed to the BarItem.ItemClick event handler using the BarItem.Tag property.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-the-richeditcontrols-common-api-t210437

RichEditControlActions.cs

static void buttonCustomAction_ItemClick_Deselect(object sender, ItemClickEventArgs e) {
    RichEditControl richEdit = e.Item.Tag as RichEditControl;
    DocumentPosition endOfSelection = richEdit.Document.Selection.End;
    richEdit.DeselectAll();
    richEdit.Document.CaretPosition = endOfSelection;
}

RichEditControlActions.vb

Private Shared Sub buttonCustomAction_ItemClick_Deselect(ByVal sender As Object, ByVal e As ItemClickEventArgs)
    Dim richEdit As RichEditControl = TryCast(e.Item.Tag, RichEditControl)
    Dim endOfSelection As DocumentPosition = richEdit.Document.Selection.End
    richEdit.DeselectAll()
    richEdit.Document.CaretPosition = endOfSelection
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DeselectAll() method.

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#

winforms-the-richeditcontrols-common-api-t210437/CS/RichEditAPISample/CodeExamples/RichEditControlActions.cs#L438

DocumentPosition endOfSelection = richEdit.Document.Selection.End;
richEdit.DeselectAll();
richEdit.Document.CaretPosition = endOfSelection;

VB.NET

winforms-the-richeditcontrols-common-api-t210437/VB/RichEditAPISample/CodeExamples/RichEditControlActions.vb#L446

Dim endOfSelection As DocumentPosition = richEdit.Document.Selection.End
richEdit.DeselectAll()
richEdit.Document.CaretPosition = endOfSelection