CheckButton.Checked Property

Gets or sets the button’s check state.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v25.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(false)]
[DXCategory("Appearance")]
public virtual bool Checked { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue(False)>
Public Overridable Property Checked As Boolean

Property Value

Type	Default	Description
Boolean	false	true if the button is checked; false if the button is unchecked.

Remarks

CheckButton controls have two states: checked (true) and unchecked (false). Use the CheckButton.Toggle method to swap the current check state.

The CheckButton.CheckedChanged event fires when the Checked value changes.

The following code snippet checks a button:

C#

checkButton1.Checked = true;

// Read the button state.
bool isChecked = checkButton1.Checked;

VB.NET

checkButton1.Checked = True

' Read the button state.
Dim isChecked As Boolean = checkButton1.Checked

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Checked 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#

winforms-scheduler-customize-appointment-flyout/CS/CustomAppointmentFlyoutExample/Form1.cs#L104

private void chkBtnTooltips_CheckedChanged(object sender, EventArgs e) {
    if (chkBtnTooltips.Checked) {
        #region #AllowDisplayAppointmentFlyout

how-to-use-docvariable-fields/CS/DocumentVariablesExample/Form1.cs#L127

Document doc = richEdit.Document;
bool showCodes = btn_ShowCodes.Checked;
doc.BeginUpdate();

winforms-richedit-layout-api/CS/Form1.cs#L111

{
    if (checkbtnCustomDraw.Checked)
    {

winforms-scheduler-formatting-services/CS/FormattingServicesExample/Form1.cs#L55

private void checkButton1_CheckedChanged(object sender, EventArgs e) {
    if (checkButton1.Checked) {
        schedulerControl1.RemoveService(typeof(IAppointmentFormatStringService));

winforms-grid-hide-vertical-lines-between-certain-columns/CS/E3647/Form1.cs#L88

{
    helper.Hide = checkButton1.Checked;
}

VB.NET

winforms-scheduler-customize-appointment-flyout/VB/CustomAppointmentFlyoutExample/Form1.vb#L114

        Private Sub chkBtnTooltips_CheckedChanged(ByVal sender As Object, ByVal e As EventArgs)
            If chkBtnTooltips.Checked Then
#Region "#AllowDisplayAppointmentFlyout"

how-to-use-docvariable-fields/VB/DocumentVariablesExample/Form1.vb#L121

Dim doc As Document = richEdit.Document
Dim showCodes As Boolean = btn_ShowCodes.Checked
doc.BeginUpdate()

winforms-richedit-layout-api/VB/Form1.vb#L92

Private Sub checkbtnCustomDraw_CheckedChanged(ByVal sender As Object, ByVal e As EventArgs) Handles checkbtnCustomDraw.CheckedChanged
    If checkbtnCustomDraw.Checked Then
        AddHandler richEditControl1.BeforePagePaint, AddressOf richEditControl1_BeforePagePaint

winforms-scheduler-formatting-services/VB/FormattingServicesExample/Form1.vb#L63

Private Sub checkButton1_CheckedChanged(ByVal sender As Object, ByVal e As EventArgs)
    If checkButton1.Checked Then
        schedulerControl1.RemoveService(GetType(IAppointmentFormatStringService))

winforms-grid-hide-vertical-lines-between-certain-columns/VB/E3647/Form1.vb#L86

If helper IsNot Nothing Then
    helper.Hide = checkButton1.Checked
End If