StandaloneGallery.RefreshContextButtons(GalleryItem) Method

Redraws context buttons in the specified gallery item.

Namespace: DevExpress.XtraBars.Ribbon.Gallery

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public void RefreshContextButtons(
    GalleryItem item
)

VB.NET

Public Sub RefreshContextButtons(
    item As GalleryItem
)

Parameters

Name	Type	Description
item	GalleryItem	Gallery item for which to redraw context buttons.

Remarks

The RefreshContextButtons method raises the GalleryControl.Gallery.ContextButtonCustomize event, and redraws context buttons in the specified gallery item.

The code below shows how to update a context button’s check state when a galery item’s check state changes, and vice versa. It is assumed that gallery items are associated with data items using the Tag property.

C#

using DevExpress.Utils;
using DevExpress.XtraBars.Ribbon;
using DevExpress.XtraBars.Ribbon.Gallery;

galleryControl1.Gallery.ItemCheckedChanged += Gallery_ItemCheckedChanged;
galleryControl1.Gallery.ContextButtonCustomize += galleryControl1_Gallery_ContextButtonCustomize;
galleryControl1.Gallery.ContextButtonClick += galleryControl1_Gallery_ContextButtonClick;

private void Gallery_ItemCheckedChanged(object sender, GalleryItemEventArgs e) {
    ((DataItem)e.Item.Tag).IsChecked = e.Item.Checked;
    (e.Gallery as GalleryControlGallery).RefreshContextButtons(e.Item);
}
private void galleryControl1_Gallery_ContextButtonClick(object sender, ContextItemClickEventArgs e) {
    GalleryItem galleryItem = e.DataItem as GalleryItem;
    galleryItem.Checked = !galleryItem.Checked;
}
private void galleryControl1_Gallery_ContextButtonCustomize(object sender, GalleryContextButtonCustomizeEventArgs e) {
    CheckContextButton check = e.Item as CheckContextButton;
    if (check == null) return;
    DataItem data = (DataItem)e.GalleryItem.Tag;
    check.Checked = data.IsChecked;
}
public class DataItem {
    public bool IsChecked { get; set; }
}

VB.NET

Imports DevExpress.Utils
Imports DevExpress.XtraBars.Ribbon
Imports DevExpress.XtraBars.Ribbon.Gallery

AddHandler galleryControl1.Gallery.ItemCheckedChanged, AddressOf Gallery_ItemCheckedChanged
AddHandler galleryControl1.Gallery.ContextButtonCustomize, AddressOf galleryControl1_Gallery_ContextButtonCustomize
AddHandler galleryControl1.Gallery.ContextButtonClick, AddressOf galleryControl1_Gallery_ContextButtonClick

Private Sub Gallery_ItemCheckedChanged(ByVal sender As Object, ByVal e As GalleryItemEventArgs)
    DirectCast(e.Item.Tag, DataItem).IsChecked = e.Item.Checked
    TryCast(e.Gallery, GalleryControlGallery).RefreshContextButtons(e.Item)
End Sub

Private Sub galleryControl1_Gallery_ContextButtonClick(ByVal sender As Object, ByVal e As ContextItemClickEventArgs)
    Dim galleryItem As GalleryItem = TryCast(e.DataItem, GalleryItem)
    galleryItem.Checked = Not galleryItem.Checked
End Sub

Private Sub galleryControl1_Gallery_ContextButtonCustomize(ByVal sender As Object, ByVal e As GalleryContextButtonCustomizeEventArgs)
    Dim check As CheckContextButton = TryCast(e.Item, CheckContextButton)
    If check Is Nothing Then
        Return
    End If
    Dim data As DataItem = DirectCast(e.GalleryItem.Tag, DataItem)
    check.Checked = data.IsChecked
End Sub

Public Class DataItem
    Public Property IsChecked() As Boolean
End Class