Back to all docs
API Reference / Telerik.Windows.Controls / RadRibbonGallery

Class
RadRibbonGallery

Represents a gallery control designed for use within a ribbon interface, providing a customizable and interactive way to display and select items. The RadRibbonGallery supports features such as compression thresholds, popup menus, and scrolling.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.RibbonView.dll

Syntax:
cs-api-definition
[Themable]
[TelerikToolboxCategory("Navigation")]
public class RadRibbonGallery : RadGallery, IMultiSelector, ISelector, ISelectorInteraction, IAutocomplete, IListControl, ICommandSource, IScrollingServiceCore, IScrollingInfo, IVariantControl

Inheritance: objectItemsControlSelectorListControlRadListBoxRadGalleryRadRibbonGallery

Implements: IAutocompleteICommandSourceIListControlIMultiSelectorIScrollingInfoIScrollingServiceCoreISelectorISelectorInteractionIVariantControl

Inherited Members RadGallery.ItemHeightPropertyRadGallery.ItemWidthPropertyRadGallery.ViewportWidthPropertyRadGallery.ResetTheme()RadGallery.GetContainerForItemOverride()RadGallery.IsItemItsOwnContainerOverride(object)RadGallery.PrepareContainerForItemOverride(DependencyObject, object)RadGallery.CanPerformSelection()RadGallery.ItemHeightRadGallery.ItemWidthRadGallery.ViewportWidthRadGallery.DeactivatePreviewRadGallery.ActivatePreviewRadListBox.DropVisualProviderPropertyRadListBox.DragDropBehaviorPropertyRadListBox.DragVisualProviderPropertyRadListBox.DataConverterPropertyRadListBox.IsItemSelectable(object)RadListBox.OnKeyDown(KeyEventArgs)RadListBox.HandleKeyboardInput(Key)RadListBox.OnTextInput(TextCompositionEventArgs)RadListBox.InitializeTextRetriever()RadListBox.GetDataItem(UIElement)RadListBox.UpdateItems(NotifyCollectionChangedAction, IList, IList)RadListBox.OnItemsChanged(NotifyCollectionChangedEventArgs)RadListBox.DropVisualProviderRadListBox.DragDropBehaviorRadListBox.DragVisualProviderRadListBox.DataConverterListControl.CanAutocompleteSelectItemsPropertyListControl.TextSearchModePropertyListControl.CanAutocompleteSelectPartialMatchesPropertyListControl.TypedTextPropertyListControl.CommandPropertyListControl.CommandParameterPropertyListControl.CommandTargetPropertyListControl.CanKeyboardNavigationSelectItemsPropertyListControl.IsScrollIntoViewEnabledPropertyListControl.ClearContainerForItemOverride(DependencyObject, object)ListControl.OnItemsPanelChanged(ItemsPanelTemplate, ItemsPanelTemplate)ListControl.OnPropertyChanged(DependencyPropertyChangedEventArgs)ListControl.ClearContainerStates(FrameworkElement)ListControl.HighlightedIndexChanged(int, Key)ListControl.OnMatchingItemChanged()ListControl.OnAutocompleteBehaviorTypedTextChanged()ListControl.IsIndexSelectable(int)ListControl.OnSelectionModeChanged()ListControl.ScrollIntoView(object)ListControl.ScrollIntoView(int)ListControl.SelectAllCommandListControl.CanAutocompleteSelectItemsListControl.CanAutocompleteSelectPartialMatchesListControl.TextSearchModeListControl.CanKeyboardNavigationSelectItemsListControl.IsScrollIntoViewEnabledListControl.TypedTextListControl.CommandListControl.CommandParameterListControl.CommandTargetListControl.IsItemsHostVisibleListControl.HighlightedItemListControl.KeyboardNavigationListControl.AutocompleteBehaviorListControl.HighlightedIndexItemsControlSelector.SelectionModePropertyItemsControlSelector.IsSynchronizedWithCurrentItemPropertyItemsControlSelector.SelectedIndexPropertyItemsControlSelector.SelectedItemPropertyItemsControlSelector.SelectedValuePropertyItemsControlSelector.SelectedValuePathPropertyItemsControlSelector.TextPropertyItemsControlSelector.TextPathPropertyItemsControlSelector.EnableSelectionCachingPropertyItemsControlSelector.SelectionChangedEventItemsControlSelector.OnItemsSourceChanged(IEnumerable, IEnumerable)ItemsControlSelector.ChangeVisualState(bool)ItemsControlSelector.OnIsEnabledChanged(DependencyPropertyChangedEventArgs)ItemsControlSelector.InitializeValueRetriever()ItemsControlSelector.InitializeSelectionBehavior()ItemsControlSelector.GetSelectionBehavior()ItemsControlSelector.EndInit()ItemsControlSelector.SelectionModeItemsControlSelector.IsSynchronizedWithCurrentItemItemsControlSelector.SelectedItemsItemsControlSelector.SelectionHelperItemsControlSelector.SelectedIndexItemsControlSelector.SelectedItemItemsControlSelector.SelectedValueItemsControlSelector.SelectedValuePathItemsControlSelector.SelectedValueBindingItemsControlSelector.TextBindingItemsControlSelector.TextItemsControlSelector.TextPathItemsControlSelector.EnableSelectionCachingItemsControlSelector.ItemSearchItemsControlSelector.ValueRetrieverItemsControlSelector.TextRetrieverItemsControlSelector.SelectionChanged

Constructors

RadRibbonGallery()

Initializes a new instance of the RadRibbonGallery class.

Declaration

cs-api-definition
public RadRibbonGallery()

Fields

CompressedThresholdProperty

Identifies the CompressedThreshold property.

Declaration

cs-api-definition
public static readonly DependencyProperty CompressedThresholdProperty

Field Value

DependencyProperty

IconProperty

Identifies the Icon property.

Declaration

cs-api-definition
public static readonly DependencyProperty IconProperty

Field Value

DependencyProperty

IsCompressedProperty

Identifies the IsCompressed property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsCompressedProperty

Field Value

DependencyProperty

IsOpenChangedEvent

Identifies the IsOpenChangedEvent routed event.

Declaration

cs-api-definition
public static readonly RoutedEvent IsOpenChangedEvent

Field Value

RoutedEvent

IsOpenProperty

Identifies the IsOpen property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsOpenProperty

Field Value

DependencyProperty

LayoutModeProperty

Identifies the LayoutMode property.

Declaration

cs-api-definition
public static readonly DependencyProperty LayoutModeProperty

Field Value

DependencyProperty

MoreButtonTitleProperty

Identifies the MoreButtonTitle property.

Declaration

cs-api-definition
public static readonly DependencyProperty MoreButtonTitleProperty

Field Value

DependencyProperty

PopupContentProperty

Identifies the popup content property.

Declaration

cs-api-definition
public static readonly DependencyProperty PopupContentProperty

Field Value

DependencyProperty

PopupLaunchButtonVisibilityProperty

Identifies a PopupLaunchButtonVisibility property.

Declaration

cs-api-definition
public static readonly DependencyProperty PopupLaunchButtonVisibilityProperty

Field Value

DependencyProperty

PopupMenuItemsProperty

Identifies the PopupMenuItems property.

Declaration

cs-api-definition
public static readonly DependencyProperty PopupMenuItemsProperty

Field Value

DependencyProperty

PopupViewportHeightProperty

Identifies the PopupViewportHeight property.

Declaration

cs-api-definition
public static readonly DependencyProperty PopupViewportHeightProperty

Field Value

DependencyProperty

PopupViewportWidthProperty

Identifies the PopupViewportWidth property.

Declaration

cs-api-definition
public static readonly DependencyProperty PopupViewportWidthProperty

Field Value

DependencyProperty

ScrollViewerPositionDependencyProperty

Identifies a ScrollViewerPosition property.

Declaration

cs-api-definition
public static readonly DependencyProperty ScrollViewerPositionDependencyProperty

Field Value

DependencyProperty

TitleProperty

Identifies the Title property.

Declaration

cs-api-definition
public static readonly DependencyProperty TitleProperty

Field Value

DependencyProperty

UpDownButtonTitleProperty

Identifies the UpDownButtonTitle property.

Declaration

cs-api-definition
public static readonly DependencyProperty UpDownButtonTitleProperty

Field Value

DependencyProperty

Properties

CompressedThreshold

Gets or sets the compressed threshold.

Declaration

cs-api-definition
public CollapseThreshold CompressedThreshold { get; set; }

Property Value

CollapseThreshold

The compressed threshold.

Icon

Gets or sets the icon.

Declaration

cs-api-definition
public ImageSource Icon { get; set; }

Property Value

ImageSource

The icon.

IsCompressed

Gets a value indicating whether this instance is compressed.

Declaration

cs-api-definition
public bool IsCompressed { get; }

Property Value

bool

True if this instance is compressed; otherwise, false.

IsOpen

Gets or sets a value indicating whether the group is open.

Declaration

cs-api-definition
public bool IsOpen { get; set; }

Property Value

bool

True if this instance is open; otherwise, false.

LayoutMode

Gets or sets a value indicating the layout render mode of the control.

Declaration

cs-api-definition
public RibbonLayout LayoutMode { get; set; }

Property Value

RibbonLayout

MoreButtonTitle

Gets or sets the MoreButton title.

Declaration

cs-api-definition
public string MoreButtonTitle { get; set; }

Property Value

string

The title.

PopupContent

Gets or sets content to be shown when the Gallery popup is opened.

Declaration

cs-api-definition
public object PopupContent { get; set; }

Property Value

object

PopupLaunchButtonVisibility

Gets or sets the popup launch button visibility.

Declaration

cs-api-definition
public Visibility PopupLaunchButtonVisibility { get; set; }

Property Value

Visibility

The popup launch button visibility.

PopupMenuItems

Gets or sets the popup menu items.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")]
public ObservableCollection<UIElement> PopupMenuItems { get; set; }

Property Value

ObservableCollection<UIElement>

The popup menu items.

PopupViewportHeight

Gets or sets the height of the popup viewport.

Declaration

cs-api-definition
public double PopupViewportHeight { get; set; }

Property Value

double

The height of the popup viewport.

PopupViewportWidth

Gets or sets the width of the popup viewport.

Declaration

cs-api-definition
public double PopupViewportWidth { get; set; }

Property Value

double

The width of the popup viewport.

Title

Gets or sets the title.

Declaration

cs-api-definition
public string Title { get; set; }

Property Value

string

The title.

UpDownButtonTitle

Gets or sets the UpDownButtons title.

Declaration

cs-api-definition
public string UpDownButtonTitle { get; set; }

Property Value

string

The title.

Methods

ChangeVisualState()

Changes the visual state of the control using transitions.

Declaration

cs-api-definition
protected void ChangeVisualState()

GetScrollViewerPart()

Called on initializing the ScrollViewer on template applied. It's mandatory to get the ScrollViewer in order to perform selection.

Declaration

cs-api-definition
protected override ScrollViewer GetScrollViewerPart()

Returns

ScrollViewer

Overrides ListControl.GetScrollViewerPart()

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call .

Declaration

cs-api-definition
public override void OnApplyTemplate()

Overrides RadListBox.OnApplyTemplate()

OnCreateAutomationPeer()

Creates an appropriate GalleryAutomationPeer for this control as part of the WPF/Silverlight infrastructure.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

Overrides RadGallery.OnCreateAutomationPeer()

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

The RoutedEventArgs that contains the event data.

Overrides RadGallery.OnInitialized(EventArgs)

OnSelectionChanged(SelectionChangedEventArgs)

Called when the selection changes.

Declaration

cs-api-definition
protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameters

e

SelectionChangedEventArgs

The event data.

Overrides RadListBox.OnSelectionChanged(SelectionChangedEventArgs)

SetVariant(RibbonGroupVariant)

Sets the variant.

Declaration

cs-api-definition
public void SetVariant(RibbonGroupVariant variant)

Parameters

variant

RibbonGroupVariant

Implements IVariantControl.SetVariant(RibbonGroupVariant)

Events

IsOpenChanged

Occurs on mouse leave.

Declaration

cs-api-definition
public event EventHandler<RadRoutedEventArgs> IsOpenChanged

Event Value

EventHandler<RadRoutedEventArgs>

In this article
DefinitionConstructorsRadRibbonGallery()FieldsCompressedThresholdPropertyIconPropertyIsCompressedPropertyIsOpenChangedEventIsOpenPropertyLayoutModePropertyMoreButtonTitlePropertyPopupContentPropertyPopupLaunchButtonVisibilityPropertyPopupMenuItemsPropertyPopupViewportHeightPropertyPopupViewportWidthPropertyScrollViewerPositionDependencyPropertyTitlePropertyUpDownButtonTitlePropertyPropertiesCompressedThresholdIconIsCompressedIsOpenLayoutModeMoreButtonTitlePopupContentPopupLaunchButtonVisibilityPopupMenuItemsPopupViewportHeightPopupViewportWidthTitleUpDownButtonTitleMethodsChangeVisualState()GetScrollViewerPart()OnApplyTemplate()OnCreateAutomationPeer()OnInitialized(EventArgs)OnSelectionChanged(SelectionChangedEventArgs)SetVariant(RibbonGroupVariant)EventsIsOpenChanged
Not finding the help you need?
Contact Support