CheckContextButton Class

A context button displaying a check box that can be checked by an end-user.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.1.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

C#

public class CheckContextButton :
    ContextButtonBase

VB.NET

Public Class CheckContextButton
    Inherits ContextButtonBase

Remarks

The CheckContextButton is a button that displays a glyph that indicates the check state, and allows an end-user to specify a boolean option. See the ContextItem base class for the list of controls that support displaying context buttons. In the figure below, you can see the CheckContextButton displayed in the PictureEdit control.

By default, the CheckContextButton displays the check box to indicate the check state. To specify custom glyphs displayed in the normal and checked states, use the ContextItem.Glyph and CheckContextButton.CheckedGlyph properties, respectively. The CheckContextButton.HoverCheckedGlyph property allows you to provide a custom glyph to be displayed in the checked state when the button is hovered over with the mouse pointer.

To display context buttons in a control, you should add them to the control’s ContextButtons collection. If the control is an item container (e.g., StandaloneGallery), the specified collection is displayed in each item. You can customize the context buttons for each particular item by handling the container’s ContextButtonCustomize event (e.g., StandaloneGallery.ContextButtonCustomize). If the collection contains a CheckContextButton, you should set the button’s check state (see CheckContextButton.Checked) in this event. To store the check state for each item, use a custom collection in your code. To learn when the check state is changed and save it to the collection, use the control’s ContextButtonClick event (e.g., StandaloneGallery.ContextButtonClick). The code below illustrates one way to implement this approach.

C#

private List<GalleryItem> checkedItems = new List<GalleryItem>();
private void galleryControl1_Gallery_ContextButtonCustomize(System.Object sender, DevExpress.XtraBars.Ribbon.Gallery.GalleryContextButtonCustomizeEventArgs e)
{
    CheckContextButton checkItem = e.Item as CheckContextButton;
    if (checkItem != null)
        checkItem.Checked = checkedItems.Contains(e.GalleryItem);
}
private void galleryControl1_Gallery_ContextButtonClick(object sender, DevExpress.Utils.ContextItemClickEventArgs e)
{
    CheckContextButton checkItem = e.Item as CheckContextButton;
    GalleryItem item = (GalleryItem)e.DataItem;
    if (checkItem != null)
    {
        if ((checkItem.Checked && !checkedItems.Contains(item)))
            checkedItems.Add(item);
        else if ((!checkItem.Checked && checkedItems.Contains(item)))
            checkedItems.Remove(item);
    }
}

VB.NET

Dim checkedItems As List(Of GalleryItem) = New List(Of GalleryItem)
Private Sub GalleryControl1_Gallery_ContextButtonClick(sender As System.Object, e As DevExpress.Utils.ContextItemClickEventArgs) Handles GalleryControl1.Gallery.ContextButtonClick
    Dim checkItem As CheckContextButton = TryCast(e.Item, CheckContextButton)
    Dim item As GalleryItem = CType(e.DataItem, GalleryItem)
    If checkItem IsNot Nothing Then
        If (checkItem.Checked AndAlso Not checkedItems.Contains(item)) Then
            checkedItems.Add(item)
        ElseIf (Not checkItem.Checked AndAlso checkedItems.Contains(item)) Then
            checkedItems.Remove(item)
        End If
    End If
End Sub

Private Sub GalleryControl1_Gallery_ContextButtonCustomize(sender As System.Object, e As DevExpress.XtraBars.Ribbon.Gallery.GalleryContextButtonCustomizeEventArgs) Handles GalleryControl1.Gallery.ContextButtonCustomize
    Dim checkItem As CheckContextButton = TryCast(e.Item, CheckContextButton)
    If checkItem IsNot Nothing Then
        checkItem.Checked = checkedItems.Contains(e.GalleryItem)
    End If
End Sub

Tip

Run the Context Buttons for WinExplorerView module in the XtraGrid MainDemo to try out context buttons. Click Open Solution in the ribbon for source codes.

Inheritance

Object

ContextItem

ContextButtonBase

CheckContextButton