ToolStripButton.CheckOnClick Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets a value indicating whether the ToolStripButton should automatically appear pressed in and not pressed in when clicked.

public:
 property bool CheckOnClick { bool get(); void set(bool value); };

public bool CheckOnClick { get; set; }

member this.CheckOnClick : bool with get, set

Public Property CheckOnClick As Boolean

Property Value

Boolean

true if the ToolStripButton should automatically appear pressed in and not pressed in when clicked; otherwise, false. The default is false.

Examples

The following code example sets the CheckOnClick property to true and uses the Checked property in a CheckedChanged event to change the font of the button text to bold when the button is clicked.

ToolStripButton^ boldButton;

void InitializeBoldButton()
{
    boldButton = gcnew ToolStripButton;
    boldButton->Text = "B";
    boldButton->CheckOnClick = true;
    boldButton->CheckedChanged  += gcnew EventHandler(this, 
        &Form1::boldButtonCheckedChanged);
    toolStrip1->Items->Add(boldButton);
}

void boldButtonCheckedChanged(Object^ sender, EventArgs^ e)
{
    if (boldButton->Checked)
    { 
        this->Font= gcnew System::Drawing::Font(this->Font, 
            FontStyle::Bold);
    }
    else
    { 
        this->Font = gcnew System::Drawing::Font(this->Font, 
            FontStyle::Regular);
    }
}


//   internal:

internal ToolStripButton boldButton;

private void InitializeBoldButton()
{
    boldButton = new ToolStripButton();
    boldButton.Text = "B";
    boldButton.CheckOnClick = true;
    toolStrip1.Items.Add(boldButton);
}

private void boldButton_CheckedChanged(object sender, EventArgs e)
{
    if (boldButton.Checked)
    {
        this.Font = new Font(this.Font, FontStyle.Bold);
    }
    else
    {
        this.Font = new Font(this.Font, FontStyle.Regular);
    }
}

Friend WithEvents boldButton As ToolStripButton

Private Sub InitializeBoldButton()
    boldButton = New ToolStripButton()
    boldButton.Text = "B"
    boldButton.CheckOnClick = True
    toolStrip1.Items.Add(boldButton)

End Sub

Private Sub boldButton_CheckedChanged(ByVal sender As [Object], _
    ByVal e As EventArgs) Handles boldButton.CheckedChanged
    If boldButton.Checked Then
        Me.Font = New Font(Me.Font, FontStyle.Bold)
    Else
        Me.Font = New Font(Me.Font, FontStyle.Regular)
    End If

End Sub