RibbonGallery Class

[TemplatePart(Name = "PART_ItemsHost", Type = typeof(ItemsPresenter))]
[TemplatePart(Name = "PART_PopupButton", Type = typeof(PopupButton))]
public class RibbonGallery : GalleryBase, IKeyTipTarget, ILogicalParent, IVariantControl

public RibbonGallery()

public int ColumnCount { get; }

Property Value

int:

The maximum number of columns that are currently displayed in the in-ribbon gallery.

public bool IsCollapsed { get; }

Property Value

bool:

true if the gallery is collapsed to a popup button; otherwise, false.

Remarks

When collapsed, the gallery items can be viewed in a popup by clicking the button that represents the gallery.

public bool IsPopupOpen { get; set; }

Property Value

bool:

true if the a child popup is open; otherwise, false.

public int LargeVariantColumnCount { get; set; }

Property Value

int:

The maximum number of columns that can be displayed in an in-ribbon gallery when in a Group with a Medium variant size, which is also the minimum number of columns that can be displayed when in a Group with a Large variant size. The default value is 5.

Remarks

Set the MediumVariantColumnCount and LargeVariantColumnCount properties to the same value to ensure that an in-ribbon gallery never expands when in a Group with a Medium variant size.

protected override IEnumerator LogicalChildren { get; }

Property Value

IEnumerator:

An enumerator for the logical child objects of the ItemsControl object.

public int MediumVariantColumnCount { get; set; }

Property Value

int:

The minimum number of columns that can be displayed in an in-ribbon gallery when in a Group with a Medium variant size. The default value is 3.

Remarks

Set the MediumVariantColumnCount and LargeVariantColumnCount properties to the same value to ensure that an in-ribbon gallery never expands when in a Group with a Medium variant size.

public object PopupContent { get; set; }

Property Value

object:

The content that is displayed on the popup for the gallery.

Remarks

The popup content must contain a PopupGallery somewhere in it that binds to the same items as the RibbonGallery.

public DataTemplate PopupContentTemplate { get; set; }

Property Value

DataTemplate:

The DataTemplate to use for the PopupContent.

Remarks

This property is only really useful if your popup content is a data object and not a UI element.

public DataTemplateSelector PopupContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector:

The DataTemplateSelector to use for the PopupContent.

Remarks

This property is only really useful if your popup content is a data object and not a UI element.

public ControlResizeMode PopupResizeMode { get; set; }

Property Value

ControlResizeMode:

A ControlResizeMode that specifies the popup's resizing capabilities. The default value is ControlResizeMode.Both.

public RibbonGalleryVariantBehavior VariantBehavior { get; set; }

Property Value

RibbonGalleryVariantBehavior:

A RibbonGalleryVariantBehavior that specifies how the gallery renders itself based on the current value of the VariantSize property. The default value of this property is RibbonGalleryVariantBehavior.Default.

Remarks

See the RibbonGalleryVariantBehavior description for details on how various settings of this property affect the control's layout.

protected override Size MeasureOverride(Size constraint)

Parameter	Type	Description
constraint	Size	The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

Returns

Size:

The size that this element determines it needs during layout, based on its calculations of child element sizes.

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameter	Type	Description
e	NotifyCollectionChangedEventArgs	A NotifyCollectionChangedEventArgs that contains the event data.

protected override bool OnKeyTipAccessed(string keyTipAccessText)

Parameter	Type	Description
keyTipAccessText	string	The key tip access text that was typed.

Returns

bool:

true if an action was executed that should stop key tip mode; otherwise, false.

Remarks

Implementations of this method should either execute the action associated with the control or move focus to the control so that the end user can take further action such as in a menu.

protected virtual void OnPopupClosed()

protected virtual void OnPopupOpened()

protected virtual bool OnPopupOpening()

Returns

bool:

true if the popup opening should be allowed to open; otherwise, false.

protected override void OnSelectedItemChanged(object oldSelectedItem, object newSelectedItem)

Parameter	Type	Description
oldSelectedItem	object	The old SelectedItem value.
newSelectedItem	object	The new SelectedItem value.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The System.Windows.DependencyObject that is the wrapper element.
item	object	The item that is being wrapped.

public event RoutedEventHandler PopupClosed

Event Type

RoutedEventHandler

public event RoutedEventHandler PopupOpened

Event Type

RoutedEventHandler

public event EventHandler<CancelRoutedEventArgs> PopupOpening

Event Type

EventHandler<CancelRoutedEventArgs>

public static readonly DependencyProperty ColumnCountProperty

public static readonly DependencyProperty IsCollapsedProperty

public static readonly DependencyProperty IsPopupOpenProperty

public static readonly DependencyProperty LargeVariantColumnCountProperty

public static readonly DependencyProperty MediumVariantColumnCountProperty

public static readonly RoutedEvent PopupClosedEvent

public static readonly DependencyProperty PopupContentProperty

public static readonly DependencyProperty PopupContentTemplateProperty

public static readonly DependencyProperty PopupContentTemplateSelectorProperty

public static readonly RoutedEvent PopupOpenedEvent

public static readonly RoutedEvent PopupOpeningEvent

public static readonly DependencyProperty PopupResizeModeProperty

public static readonly DependencyProperty VariantBehaviorProperty