WPF › Ribbon › BinaryRibbonGallery

BinaryRibbonGallery

class.NET 6 / 8 / 10.NET Framework 4.8Binarymission.WPF.Controls.Office

A custom scrollable container class that allows you to host numerous child items, typically images and thumbnails.

public partial class BinaryRibbonGallery : Selector, IBinaryRibbonComponent, IBinaryRibbonComponentAlwaysRenderLarge, IBinaryRibbonComponentActAsGallery, IBinaryRibbonKeyTipControl

Inherits from / implements: Selector, IBinaryRibbonComponent, IBinaryRibbonComponentAlwaysRenderLarge, IBinaryRibbonComponentActAsGallery, IBinaryRibbonKeyTipControl

Members at a glance

`BinaryRibbonGallery`	Initializes a new instance of the `BinaryRibbonGallery` class.
`ActualColumns`	Gets the actual number of columns of child items that gets finally set by the gallery.
`BinaryRibbonTag`	Gets or sets a generic tag.
`Columns`	Gets or sets the number of columns in the main display view (not the drop-down view) the gallery will organise its children objects into.
`DropDownColumns`	Gets or sets the number of columns in the drop-down display view (not the main gallery view) the gallery will organise its children objects into.
`DropDownMaximumSize`	Gets or sets the maximum size of the drop-down window.
`DropDownWidth`	Gets or sets the width of the drop-down window.
`FooterContent`	Gets or sets the content for the gallery footer.
`FooterDataTemplate`	Gets or sets the `DataTemplate` for the footer content.
`HeaderContent`	Gets or sets the content for the gallery header.
`HeaderDataTemplate`	Gets or sets the `DataTemplate` for the header content.
`IsCollapsed`	Gets or sets a value indicating whether this instance is collapsed.
`IsDropDownOpen`	Gets or sets a value indicating whether the gallery drop-down window is currently open/showing.
`IsLivePreviewEnabled`	Gets or sets whether this gallery offers a live preview.
`IsVirtualizing`	Gets or sets a value indicating whether this instance is virtualizing its child items generation.
`LargeImage`	Gets or sets the large image.
`MouseOverItem`	Gets or sets the item over which the mouse pointer is currently on.
`MouseOverThumbnail`	Gets or sets the thumbnail over which the mouse pointer is currently on.
`ScrollAnimationDuration`	Gets or sets the duration for the scroll animation.
`ScrollViewer`	—
`ThumbnailSize`	Gets or sets the size of the thumbnail.
`Thumbnails`	Gets or sets the thumbnail objects for this gallery instance.
`TitleText`	Gets or sets the title text.
`VerticalScrollOffset`	Gets or sets the vertical scroll offset.
`DropDownOpenChanged`	—
`GetContainerForItemOverride`	—
`GetRenderableGalleryColumns`	Gets the renderable gallery columns.
`GetStretch`	Gets the stretch aspect.
`IsItemItsOwnContainerOverride`	—
`MeasureOverride`	—
`OnApplyTemplate`	When overridden in a derived class, is invoked whenever application code or internal processes call `ApplyTemplate`.
`OnColumnsChanged`	—
`OnItemsChanged`	—
`OnMouseLeave`	Raises the MouseLeave event.
`OnMouseOverThumbnailPropertyChangedCallback`	—
`OnPopupOpen`	—
`OnPreviewKeyDown`	Raises the PreviewKeyDown event.
`OnSelectionChanged`	—
`PrepareContainerForItemOverride`	—
`ScrollDown`	Scrolls down content.
`ScrollUp`	Scrolls up content.
`SetRenderableGalleryColumns`	Sets the renderable gallery columns.
`SetStretch`	Sets the stretch aspect.
`MouseOverThumbnailChanged`	Occurs when "mouse over" thumbnail changes.
`ColumnsProperty`	ColumnsProperty property.
`DropDownColumnsProperty`	DropDownColumnsProperty property.
`DropDownMaximumSizeProperty`	DropDownMaximumSizeProperty property.
`DropDownWidthProperty`	DropDownWidthProperty property.
`FooterContentProperty`	FooterContentProperty property.
`FooterDataTemplateProperty`	FooterDataTemplateProperty property.
`HeaderContentProperty`	HeaderContentProperty property.
`HeaderDataTemplateProperty`	HeaderDataTemplateProperty property.
`IsCollapsedProperty`	IsCollapsedProperty property.
`IsDropDownOpenProperty`	IsDropDownOpenProperty property.
`IsLivePreviewEnabledProperty`	Identifies the `IsLivePreviewEnabled` dependency property.
`IsVirtualizingProperty`	IsVirtualizingProperty property.
`LargeImageProperty`	LargeImageProperty property.
`MouseOverItemProperty`	MouseOverItemProperty property.
`MouseOverThumbnailChangedEvent`	A routed event that fires when the underlying thumbnail changes vis-a-vis the mouse pointer.
`MouseOverThumbnailProperty`	MouseOverThumbnailProperty property.
`RenderableGalleryColumnsProperty`	RenderableGalleryColumnsProperty attached property.
`ScrollAnimationDurationProperty`	ScrollAnimationDurationProperty property.
`ScrollDownCommand`	Scrolldown command object.
`ScrollUpCommand`	Scrollup command object.
`StretchProperty`	StretchProperty property.
`ThumbnailSizeProperty`	ThumbnailSizeProperty property.
`ThumbnailsProperty`	ThumbnailsProperty property.
`TitleTextProperty`	TitleTextProperty property.
`VerticalScrollOffsetProperty`	VerticalScrollOffsetProperty property.

Constructors

BinaryRibbonGallery

public BinaryRibbonGallery() : base()

Initializes a new instance of the BinaryRibbonGallery class.

Properties

ActualColumns

public int ActualColumns

Gets the actual number of columns of child items that gets finally set by the gallery.

Value. The actual columns.

BinaryRibbonTag

public object BinaryRibbonTag

Gets or sets a generic tag.

Value. The binary ribbon tag.

Columns

public int Columns

Gets or sets the number of columns in the main display view (not the drop-down view) the gallery will organise its children objects into.

DropDownColumns

public int DropDownColumns

Gets or sets the number of columns in the drop-down display view (not the main gallery view) the gallery will organise its children objects into.

DropDownMaximumSize

public Size DropDownMaximumSize

Gets or sets the maximum size of the drop-down window.

Value. The maximum size of the drop-down.

DropDownWidth

public double DropDownWidth

Gets or sets the width of the drop-down window.

FooterContent

public object FooterContent

Gets or sets the content for the gallery footer.

FooterDataTemplate

public DataTemplate FooterDataTemplate

Gets or sets the DataTemplate for the footer content.

HeaderContent

public object HeaderContent

Gets or sets the content for the gallery header.

HeaderDataTemplate

public DataTemplate HeaderDataTemplate

Gets or sets the DataTemplate for the header content.

IsCollapsed

public bool IsCollapsed

Gets or sets a value indicating whether this instance is collapsed.

Value. true if this instance is collapsed; otherwise, false .

IsDropDownOpen

public bool IsDropDownOpen

Gets or sets a value indicating whether the gallery drop-down window is currently open/showing.

IsLivePreviewEnabled

public bool IsLivePreviewEnabled

Gets or sets whether this gallery offers a live preview.

Value. true to raise the preview events. The default is true .

The events cost nothing when nothing handles them, so this is for a gallery whose preview would be expensive or wrong - one whose items take a moment to apply, say - rather than for turning off something unused.

IsVirtualizing

public bool IsVirtualizing

Gets or sets a value indicating whether this instance is virtualizing its child items generation.

Value. true if this instance is virtualizing; otherwise, false .

LargeImage

public ImageSource LargeImage

Gets or sets the large image.

Value. The large image.

MouseOverItem

public object MouseOverItem

Gets or sets the item over which the mouse pointer is currently on.

MouseOverThumbnail

public BinaryRibbonThumbnailControl MouseOverThumbnail

Gets or sets the thumbnail over which the mouse pointer is currently on.

Value. The mouse over thumbnail.

ScrollAnimationDuration

public double ScrollAnimationDuration

Gets or sets the duration for the scroll animation.

Value. The duration of the scroll animation.

ScrollViewer

protected virtual ScrollViewer ScrollViewer

No summary in the source yet.

ThumbnailSize

public Size ThumbnailSize

Gets or sets the size of the thumbnail.

Value. The size of the thumbnail.

Thumbnails

public object Thumbnails

Gets or sets the thumbnail objects for this gallery instance.

TitleText

public string TitleText

Gets or sets the title text.

Value. The title text.

VerticalScrollOffset

public double VerticalScrollOffset

Gets or sets the vertical scroll offset.

Value. The vertical scroll offset.

Methods

DropDownOpenChanged

protected virtual void DropDownOpenChanged(DependencyPropertyChangedEventArgs e)

No summary in the source yet.

GetContainerForItemOverride

protected override DependencyObject GetContainerForItemOverride()

No summary in the source yet.

GetRenderableGalleryColumns

public static BinaryRibbonGalleryControlColumns GetRenderableGalleryColumns(DependencyObject obj)

Gets the renderable gallery columns.

GetStretch

public static Stretch GetStretch(DependencyObject obj)

Gets the stretch aspect.

IsItemItsOwnContainerOverride

protected override bool IsItemItsOwnContainerOverride(object item)

No summary in the source yet.

MeasureOverride

protected override Size MeasureOverride(Size constraint)

No summary in the source yet.

OnApplyTemplate

public override void OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate.

OnColumnsChanged

protected virtual void OnColumnsChanged(DependencyPropertyChangedEventArgs e)

No summary in the source yet.

OnItemsChanged

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

No summary in the source yet.

OnMouseLeave

protected override void OnMouseLeave(MouseEventArgs e)

Raises the MouseLeave event.

e: The data for the event.

The pointer leaving the gallery altogether ends the preview: the item it was last over does not always raise a change of its own on the way out.

OnMouseOverThumbnailPropertyChangedCallback

protected virtual void OnMouseOverThumbnailPropertyChangedCallback(DependencyPropertyChangedEventArgs e)

No summary in the source yet.

OnPopupOpen

protected virtual void OnPopupOpen(object sender, RoutedEventArgs e)

No summary in the source yet.

OnPreviewKeyDown

protected override void OnPreviewKeyDown(KeyEventArgs e)

Raises the PreviewKeyDown event.

e: The data for the event.

Escape ends a preview without choosing, which is how a user backs out of one.

OnSelectionChanged

protected override void OnSelectionChanged(SelectionChangedEventArgs e)

No summary in the source yet.

PrepareContainerForItemOverride

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

No summary in the source yet.

ScrollDown

public void ScrollDown()

Scrolls down content.

ScrollUp

public void ScrollUp()

Scrolls up content.

SetRenderableGalleryColumns

public static void SetRenderableGalleryColumns(DependencyObject obj, BinaryRibbonGalleryControlColumns value)

Sets the renderable gallery columns.

SetStretch

public static void SetStretch(DependencyObject obj, Stretch value)

Sets the stretch aspect.

Events

MouseOverThumbnailChanged

public event RoutedEventHandler MouseOverThumbnailChanged

Occurs when "mouse over" thumbnail changes.

Fields

ColumnsProperty

public static readonly DependencyProperty ColumnsProperty

ColumnsProperty property.

DropDownColumnsProperty

public static readonly DependencyProperty DropDownColumnsProperty

DropDownColumnsProperty property.

DropDownMaximumSizeProperty

public static readonly DependencyProperty DropDownMaximumSizeProperty

DropDownMaximumSizeProperty property.

DropDownWidthProperty

public static readonly DependencyProperty DropDownWidthProperty

DropDownWidthProperty property.

FooterContentProperty

public static readonly DependencyProperty FooterContentProperty

FooterContentProperty property.

FooterDataTemplateProperty

public static readonly DependencyProperty FooterDataTemplateProperty

FooterDataTemplateProperty property.

HeaderContentProperty

public static readonly DependencyProperty HeaderContentProperty

HeaderContentProperty property.

HeaderDataTemplateProperty

public static readonly DependencyProperty HeaderDataTemplateProperty

HeaderDataTemplateProperty property.

IsCollapsedProperty

public static readonly DependencyProperty IsCollapsedProperty

IsCollapsedProperty property.

IsDropDownOpenProperty

public static readonly DependencyProperty IsDropDownOpenProperty

IsDropDownOpenProperty property.

IsLivePreviewEnabledProperty

public static readonly DependencyProperty IsLivePreviewEnabledProperty

Identifies the IsLivePreviewEnabled dependency property.

IsVirtualizingProperty

public static readonly DependencyProperty IsVirtualizingProperty

IsVirtualizingProperty property.

LargeImageProperty

public static readonly DependencyProperty LargeImageProperty

LargeImageProperty property.

MouseOverItemProperty

public static readonly DependencyProperty MouseOverItemProperty

MouseOverItemProperty property.

MouseOverThumbnailChangedEvent

public static readonly RoutedEvent MouseOverThumbnailChangedEvent

A routed event that fires when the underlying thumbnail changes vis-a-vis the mouse pointer.

MouseOverThumbnailProperty

public static readonly DependencyProperty MouseOverThumbnailProperty

MouseOverThumbnailProperty property.

RenderableGalleryColumnsProperty

public static readonly DependencyProperty RenderableGalleryColumnsProperty

RenderableGalleryColumnsProperty attached property.

ScrollAnimationDurationProperty

public static readonly DependencyProperty ScrollAnimationDurationProperty

ScrollAnimationDurationProperty property.

ScrollDownCommand

public static RoutedUICommand ScrollDownCommand

Scrolldown command object.

ScrollUpCommand

public static RoutedUICommand ScrollUpCommand

Scrollup command object.

StretchProperty

public static readonly DependencyProperty StretchProperty

StretchProperty property.

ThumbnailSizeProperty

public static readonly DependencyProperty ThumbnailSizeProperty

ThumbnailSizeProperty property.

ThumbnailsProperty

public static readonly DependencyProperty ThumbnailsProperty

ThumbnailsProperty property.

TitleTextProperty

public static readonly DependencyProperty TitleTextProperty

TitleTextProperty property.

VerticalScrollOffsetProperty

public static readonly DependencyProperty VerticalScrollOffsetProperty

VerticalScrollOffsetProperty property.