New to Telerik UI for WPF? Start a free 30-day trial

RadRibbonGallery

Class

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.

The RadRibbonGallery is a specialized gallery control that adapts its layout based on the available space and the specified CompressedThreshold. It supports both in-ribbon and popup display modes, allowing users to interact with items in a compact or expanded view. This control is themable and integrates seamlessly with Telerik's ribbon components. It provides properties for customizing its appearance and behavior, such as Icon, Title, and PopupMenuItems. Additionally, it supports scrolling and dynamic layout adjustments to accommodate different screen sizes and user interactions. The control raises the IsOpenChanged event when the popup state changes, allowing developers to handle state transitions.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.RibbonView.dll

Syntax:

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

Inheritance: objectItemsControlSelectorListControlRadListBoxRadGalleryRadRibbonGallery...

Implements: IAutocompleteICommandSourceIListControlIMultiSelectorIScrollingInfoIScrollingServiceCoreISelectorISelectorInteractionIVariantControl...

Constructors

RadRibbonGallery()

Initializes a new instance of the RadRibbonGallery class.

public RadRibbonGallery()

Fields

CompressedThresholdProperty

DependencyProperty

Identifies the CompressedThreshold property.

public static readonly DependencyProperty CompressedThresholdProperty

IconProperty

DependencyProperty

Identifies the Icon property.

public static readonly DependencyProperty IconProperty

IsCompressedProperty

DependencyProperty

Identifies the IsCompressed property.

public static readonly DependencyProperty IsCompressedProperty

IsOpenChangedEvent

RoutedEvent

Identifies the IsOpenChangedEvent routed event.

public static readonly RoutedEvent IsOpenChangedEvent

IsOpenProperty

DependencyProperty

Identifies the IsOpen property.

public static readonly DependencyProperty IsOpenProperty

LayoutModeProperty

DependencyProperty

Identifies the LayoutMode property.

public static readonly DependencyProperty LayoutModeProperty

MoreButtonTitleProperty

DependencyProperty

Identifies the MoreButtonTitle property.

public static readonly DependencyProperty MoreButtonTitleProperty

PopupContentProperty

DependencyProperty

Identifies the popup content property.

public static readonly DependencyProperty PopupContentProperty

PopupLaunchButtonVisibilityProperty

DependencyProperty

Identifies a PopupLaunchButtonVisibility property.

public static readonly DependencyProperty PopupLaunchButtonVisibilityProperty

PopupMenuItemsProperty

DependencyProperty

Identifies the PopupMenuItems property.

public static readonly DependencyProperty PopupMenuItemsProperty

PopupViewportHeightProperty

DependencyProperty

Identifies the PopupViewportHeight property.

public static readonly DependencyProperty PopupViewportHeightProperty

PopupViewportWidthProperty

DependencyProperty

Identifies the PopupViewportWidth property.

public static readonly DependencyProperty PopupViewportWidthProperty

ScrollViewerPositionDependencyProperty

DependencyProperty

Identifies a ScrollViewerPosition property.

public static readonly DependencyProperty ScrollViewerPositionDependencyProperty

TitleProperty

DependencyProperty

Identifies the Title property.

public static readonly DependencyProperty TitleProperty

UpDownButtonTitleProperty

DependencyProperty

Identifies the UpDownButtonTitle property.

public static readonly DependencyProperty UpDownButtonTitleProperty

Properties

CompressedThreshold

CollapseThreshold

Gets or sets the compressed threshold.

public CollapseThreshold CompressedThreshold { get; set; }

Property Value:

The compressed threshold.

Icon

ImageSource

Gets or sets the icon.

public ImageSource Icon { get; set; }

Property Value:

The icon.

IsCompressed

bool

Gets a value indicating whether this instance is compressed.

public bool IsCompressed { get; }

Property Value:

True if this instance is compressed; otherwise, false.

IsOpen

bool

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

public bool IsOpen { get; set; }

Property Value:

True if this instance is open; otherwise, false.

LayoutMode

RibbonLayout

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

public RibbonLayout LayoutMode { get; set; }

MoreButtonTitle

string

Gets or sets the MoreButton title.

public string MoreButtonTitle { get; set; }

Property Value:

The title.

PopupContent

object

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

public object PopupContent { get; set; }

PopupLaunchButtonVisibility

Visibility

Gets or sets the popup launch button visibility.

public Visibility PopupLaunchButtonVisibility { get; set; }

Property Value:

The popup launch button visibility.

PopupMenuItems

ObservableCollection<UIElement>

Gets or sets the popup menu items.

public ObservableCollection<UIElement> PopupMenuItems { get; set; }

Property Value:

The popup menu items.

PopupViewportHeight

double

Gets or sets the height of the popup viewport.

public double PopupViewportHeight { get; set; }

Property Value:

The height of the popup viewport.

PopupViewportWidth

double

Gets or sets the width of the popup viewport.

public double PopupViewportWidth { get; set; }

Property Value:

The width of the popup viewport.

Title

string

Gets or sets the title.

public string Title { get; set; }

Property Value:

The title.

UpDownButtonTitle

string

Gets or sets the UpDownButtons title.

public string UpDownButtonTitle { get; set; }

Property Value:

The title.

Methods

ChangeVisualState()

Changes the visual state of the control using transitions.

protected void ChangeVisualState()

GetScrollViewerPart()

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

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 .

public override void OnApplyTemplate()

Overrides: RadListBox.OnApplyTemplate()

OnCreateAutomationPeer()

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

protected override AutomationPeer OnCreateAutomationPeer()

Returns:

AutomationPeer

Overrides: RadGallery.OnCreateAutomationPeer()

OnInitialized(EventArgs)

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

protected override void OnInitialized(EventArgs e)

Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

Overrides: RadGallery.OnInitialized(EventArgs)

OnSelectionChanged(SelectionChangedEventArgs)

Called when the selection changes.

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

Parameters:eSelectionChangedEventArgs

The event data.

Overrides: RadListBox.OnSelectionChanged(SelectionChangedEventArgs)

SetVariant(RibbonGroupVariant)

Sets the variant.

public void SetVariant(RibbonGroupVariant variant)

Parameters:variantRibbonGroupVariant

Implements: IVariantControl.SetVariant(RibbonGroupVariant)

Events

IsOpenChanged

EventHandler<RadRoutedEventArgs>

Occurs on mouse leave.

public event EventHandler<RadRoutedEventArgs> IsOpenChanged