Class BinaryRibbonGallery
A custom scrollable container class that allows you to host numerous child items, typically images and thumbnails.
Implements
Namespace: Binarymission.WPF.Controls.Office
Assembly: Binarymission.WPF.Controls.BinaryRibbon.dll
Syntax
public class BinaryRibbonGallery : Selector, IBinaryRibbonComponentAlwaysRenderLarge, IBinaryRibbonComponentActAsGallery, IBinaryRibbonComponent, IBinaryRibbonKeyTipControl
Constructors
BinaryRibbonGallery()
Initializes a new instance of the BinaryRibbonGallery class.
Declaration
public BinaryRibbonGallery()
Fields
MouseOverThumbnailChangedEvent
A routed event that fires when the underlying thumbnail changes vis-a-vis the mouse pointer.
Declaration
public static readonly RoutedEvent MouseOverThumbnailChangedEvent
Field Value
Type | Description |
---|---|
RoutedEvent |
ScrollDownCommand
Scrolldown command object.
Declaration
public static RoutedUICommand ScrollDownCommand
Field Value
Type | Description |
---|---|
RoutedUICommand |
ScrollUpCommand
Scrollup command object.
Declaration
public static RoutedUICommand ScrollUpCommand
Field Value
Type | Description |
---|---|
RoutedUICommand |
Properties
ActualColumns
Gets the actual number of columns of child items that gets finally set by the gallery.
Declaration
public int ActualColumns { get; }
BinaryRibbonTag
Gets or sets a generic tag.
Declaration
public object BinaryRibbonTag { get; set; }
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.
Declaration
public int Columns { get; set; }
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.
Declaration
public int DropDownColumns { get; set; }
DropDownMaximumSize
Gets or sets the maximum size of the drop-down window.
Declaration
public Size DropDownMaximumSize { get; set; }
DropDownWidth
Gets or sets the width of the drop-down window.
Declaration
public double DropDownWidth { get; set; }
FooterContent
Gets or sets the content for the gallery footer.
Declaration
public object FooterContent { get; set; }
FooterDataTemplate
Gets or sets the DataTemplate for the footer content.
Declaration
public DataTemplate FooterDataTemplate { get; set; }
HeaderContent
Gets or sets the content for the gallery header.
Declaration
public object HeaderContent { get; set; }
HeaderDataTemplate
Gets or sets the DataTemplate for the header content.
Declaration
public DataTemplate HeaderDataTemplate { get; set; }
IsCollapsed
Gets or sets a value indicating whether this instance is collapsed.
Declaration
public bool IsCollapsed { get; set; }
IsDropDownOpen
Gets or sets a value indicating whether the gallery drop-down window is currently open/showing.
Declaration
public bool IsDropDownOpen { get; set; }
IsVirtualizing
Gets or sets a value indicating whether this instance is virtualizing its child items generation.
Declaration
public bool IsVirtualizing { get; set; }
LargeImage
Gets or sets the large image.
Declaration
public ImageSource LargeImage { get; set; }
MouseOverItem
Gets or sets the item over which the mouse pointer is currently on.
Declaration
public object MouseOverItem { get; }
MouseOverThumbnail
Gets or sets the thumbnail over which the mouse pointer is currently on.
Declaration
public BinaryRibbonThumbnailControl MouseOverThumbnail { get; }
ScrollAnimationDuration
Gets or sets the duration for the scroll animation.
Declaration
public double ScrollAnimationDuration { get; set; }
ScrollViewer
Declaration
protected virtual ScrollViewer ScrollViewer { get; }
Thumbnails
Gets or sets the thumbnail objects for this gallery instance.
Declaration
public object Thumbnails { get; set; }
ThumbnailSize
Gets or sets the size of the thumbnail.
Declaration
public Size ThumbnailSize { get; set; }
TitleText
Gets or sets the title text.
Declaration
public string TitleText { get; set; }
VerticalScrollOffset
Gets or sets the vertical scroll offset.
Declaration
public double VerticalScrollOffset { get; set; }
Methods
DropDownOpenChanged(DependencyPropertyChangedEventArgs)
Declaration
protected virtual void DropDownOpenChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
DependencyPropertyChangedEventArgs | e |
GetContainerForItemOverride()
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
Type | Description |
---|---|
DependencyObject |
GetRenderableGalleryColumns(DependencyObject)
Gets the renderable gallery columns.
Declaration
public static BinaryRibbonGalleryControlColumns GetRenderableGalleryColumns(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj |
Returns
Type | Description |
---|---|
BinaryRibbonGalleryControlColumns |
GetStretch(DependencyObject)
Gets the stretch aspect.
Declaration
public static Stretch GetStretch(DependencyObject obj)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj |
Returns
Type | Description |
---|---|
Stretch |
IsItemItsOwnContainerOverride(Object)
Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
Type | Name | Description |
---|---|---|
Object | item |
Returns
Type | Description |
---|---|
Boolean |
MeasureOverride(Size)
Declaration
protected override Size MeasureOverride(Size constraint)
Parameters
Type | Name | Description |
---|---|---|
Size | constraint |
Returns
Type | Description |
---|---|
Size |
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().
Declaration
public override void OnApplyTemplate()
OnColumnsChanged(DependencyPropertyChangedEventArgs)
Declaration
protected virtual void OnColumnsChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
DependencyPropertyChangedEventArgs | e |
OnItemsChanged(NotifyCollectionChangedEventArgs)
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
NotifyCollectionChangedEventArgs | e |
OnMouseOverThumbnailPropertyChangedCallback(DependencyPropertyChangedEventArgs)
Declaration
protected virtual void OnMouseOverThumbnailPropertyChangedCallback(DependencyPropertyChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
DependencyPropertyChangedEventArgs | e |
OnPopupOpen(Object, RoutedEventArgs)
Declaration
protected virtual void OnPopupOpen(object sender, RoutedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
Object | sender | |
RoutedEventArgs | e |
OnSelectionChanged(SelectionChangedEventArgs)
Declaration
protected override void OnSelectionChanged(SelectionChangedEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
SelectionChangedEventArgs | e |
PrepareContainerForItemOverride(DependencyObject, Object)
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | element | |
Object | item |
ScrollDown()
Scrolls down content.
Declaration
public void ScrollDown()
ScrollUp()
Scrolls up content.
Declaration
public void ScrollUp()
SetRenderableGalleryColumns(DependencyObject, BinaryRibbonGalleryControlColumns)
Sets the renderable gallery columns.
Declaration
public static void SetRenderableGalleryColumns(DependencyObject obj, BinaryRibbonGalleryControlColumns value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | |
BinaryRibbonGalleryControlColumns | value |
SetStretch(DependencyObject, Stretch)
Sets the stretch aspect.
Declaration
public static void SetStretch(DependencyObject obj, Stretch value)
Parameters
Type | Name | Description |
---|---|---|
DependencyObject | obj | |
Stretch | value |
Events
MouseOverThumbnailChanged
Occurs when "mouse over" thumbnail changes.
Declaration
public event RoutedEventHandler MouseOverThumbnailChanged
Event Type
Type | Description |
---|---|
RoutedEventHandler |
Explicit Interface Implementations
IBinaryRibbonComponentActAsGallery.SetDropDownColumns(Int32)
Declaration
void IBinaryRibbonComponentActAsGallery.SetDropDownColumns(int columns)
Parameters
Type | Name | Description |
---|---|---|
Int32 | columns |
IBinaryRibbonKeyTipControl.PerformKeyTipExecute()
Performs custom logic for the method PerformKeyTipExecute().
Declaration
void IBinaryRibbonKeyTipControl.PerformKeyTipExecute()