BarToggleSwitchItem Class

A bar item with toggle switch functionality.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public class BarToggleSwitchItem :
    BarItem,
    ISupportCommandBinding,
    ISupportUICommand

VB.NET

Public Class BarToggleSwitchItem
    Inherits BarItem
    Implements ISupportCommandBinding,
               ISupportUICommand

Related API Members

The following members return BarToggleSwitchItem objects:

• BarToggleSwitchItemLink.Item

Remarks

BarToggleSwitchItem is a bar item that displays a toggle switch button.

The bar item link for a BarToggleSwitchItem is a BarToggleSwitchItemLink.

Main Settings

API	Description
Checked	Specifies the item’s check state.
CheckedChanged	Handle this event to respond to check state changes.
Caption	Specifies item text.
ImageOptions	Gives access to options that specify an item image.
EditorToThumbWidthRatio	Specifies the width ratio between the toggle switch editor and its thumb.
ItemAppearance	Specifies appearance settings for the item in different states.

Important

If you create a bar item in code, associate the bar item with the BarManager or RibbonControl. Use the constructor with the BarManager parameter. To display the bar item within the Ribbon Control, pass the RibbonControl.Manager object as the BarManager parameter.

Inheritance

Object

MarshalByRefObject

Component

BarItem

BarToggleSwitchItem