CheckEdit.Toggle() Method

Toggles the editor’s check state.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v26.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public override void Toggle()

VB.NET

Public Overrides Sub Toggle

Remarks

Use the Toggle method to programmatically cycle the editor through its states.

CheckEdit supports two modes:

Two-state mode

The editor can be in the Checked or Unchecked state.

Three-state mode

The editor can be in the following states: Checked, Unchecked, or Indeterminate (grayed). Set the AllowGrayed property to true to enable three-state mode.

CheckEdit changes its states in the following order: Indeterminate → Unchecked → Checked.

Set the DefaultStateAfterIndeterminate property to Checked to change the order to Indeterminate → Checked → Unchecked.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Toggle() 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-grid-toggle-checkbox-state-with-one-click/CS/Form1.cs#L68

if (edit == null) return;
edit.Toggle();
DXMouseEventArgs.GetMouseArgs(e).Handled = true;

winforms-grid-change-checkbox-state-single-click-in-multi-select-mode/CS/Form1.cs#L49

if (edit == null) return;
edit.Toggle();
DXMouseEventArgs.GetMouseArgs(e).Handled = true;

VB.NET

winforms-grid-toggle-checkbox-state-with-one-click/VB/Form1.vb#L61

If edit Is Nothing Then Return
edit.Toggle()
DXMouseEventArgs.GetMouseArgs(e).Handled = True

winforms-grid-change-checkbox-state-single-click-in-multi-select-mode/VB/Form1.vb#L43

If edit Is Nothing Then Return
edit.Toggle()
DXMouseEventArgs.GetMouseArgs(e).Handled = True