RibbonToggleButtonItem Class

A ribbon item used to display the toggle button functionality.

Assembly : DevExpress.Web.v25.2.dll

Declaration

C#
VB.NET

csharp

public class RibbonToggleButtonItem :
    RibbonButtonItem

Public Class RibbonToggleButtonItem
    Inherits RibbonButtonItem

Remarks

The RibbonToggleButtonItem object is a ribbon item that implements the toggle button functionality. The item check state can be specified using the RibbonToggleButtonItem.Checked property.

When the RibbonToggleButtonItem is clicked, the client-side ASPxClientRibbon.CommandExecuted event is raised. You can use the ASPxClientRibbonCommandExecutedEventArgs.item argument property to determine the clicked item. The ASPxClientRibbonCommandExecutedEventArgs.parameter argument property returns the textual representation of the item’s RibbonToggleButtonItem.Checked property value (i.e., “true” or “false”).

ASPX

aspx

<dx:RibbonToggleButtonItem Name="Bold">
     <SmallImage IconID="format_bold_16x16">
     </SmallImage>
</dx:RibbonToggleButtonItem>
<dx:RibbonToggleButtonItem Name="Italic" Checked="True">
     <SmallImage IconID="format_italic_16x16">
     </SmallImage>
</dx:RibbonToggleButtonItem>
<dx:RibbonToggleButtonItem Name="Underline" Checked="True">
     <SmallImage IconID="format_underline_16x16">
     </SmallImage>
</dx:RibbonToggleButtonItem>
<dx:RibbonToggleButtonItem Name="Strikeout">
     <SmallImage IconID="format_strikeout_16x16">
     </SmallImage>
</dx:RibbonToggleButtonItem>

To learn more about ribbon item types, see the Item Types topic.