RibbonBarItemCheckBox

Namespace: Wisej.Web.Ext.RibbonBar

Assembly: Wisej.Web.Ext.RibbonBar (4.1.0.0)

• Component
  • Component
    • RibbonBarItem
      • RibbonBarItemCheckBox

Represents a checkbox in a RibbonBarGroup.

C#

public class RibbonBarItemCheckBox : RibbonBarItem

VB.NET

Public Class RibbonBarItemCheckBox
    Inherits RibbonBarItem

The check state is toggled on the client when the user clicks the item; the new value is then sent to the server and assigned to Checked.

Constructors

RibbonBarItemCheckBox()

Initializes a new instance of RibbonBarItemCheckBox.

Properties

Checked

Boolean: Returns or sets whether the RibbonBarItemCheckBox is in the checked state. (Default: False)

Value: true if the RibbonBarItemCheckBox is in the checked state; otherwise, false. The default is false.

Changing the value fires the CheckedChanged event. When the user clicks the checkbox, the value is updated first, then the Click and ItemClick events are fired.

Example:

Showing or hiding a panel when the user toggles the check box:

private void checkBoxRuler_CheckedChanged(object sender, EventArgs e)
{
    this.panelRuler.Visible = this.checkBoxRuler.Checked;
}

Methods

OnCheckedChanged(e)

Fires the CheckedChanged event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnWebEvent(e)

Processes the event from the client.

Parameter	Type	Description
e	WisejEventArgs	Event arguments.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

Events

CheckedChanged

EventHandler Fired when the value of the Checked property changes.

Implements

Name	Description
IUserData
IWisejComponent
IWisejSerializable