BarGalleryViewModel Class

public class BarGalleryViewModel : BarGalleryViewModelBase, IHasKey, IHasTag, IHasVariantImages

public BarGalleryViewModel()

public BarGalleryViewModel(string key)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.

public BarGalleryViewModel(string key, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarGalleryViewModel(string key, string label)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the key if null.

public BarGalleryViewModel(string key, string label, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the key if null.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarGalleryViewModel(string key, string label, string keyTipText)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the key if null.
keyTipText	string	The key tip text, which is auto-generated from the label if null.

public BarGalleryViewModel(string key, string label, string keyTipText, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the key if null.
keyTipText	string	The key tip text, which is auto-generated from the label if null.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarGalleryViewModel(string key, string label, string keyTipText, ICommand command)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the command or key if null.
keyTipText	string	The key tip text, which is auto-generated from the command or label if null.
command	ICommand	The command to attach to the control.

public BarGalleryViewModel(string key, string label, string keyTipText, ICommand command, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the command or key if null.
keyTipText	string	The key tip text, which is auto-generated from the command or label if null.
command	ICommand	The command to attach to the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarGalleryViewModel(string key, string label, ICommand command)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the command or key if null.
command	ICommand	The command to attach to the control.

public BarGalleryViewModel(string key, string label, ICommand command, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
label	string	The text label to display, which is auto-generated from the command or key if null.
command	ICommand	The command to attach to the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarGalleryViewModel(string key, ICommand command)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
command	ICommand	The command to attach to the control.

public BarGalleryViewModel(string key, ICommand command, IEnumerable items)

Parameter	Type	Description
key	string	A string that uniquely identifies the control.
command	ICommand	The command to attach to the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public BarGalleryViewModel(RoutedCommand routedCommand)

Parameter	Type	Description
routedCommand	RoutedCommand	The command to attach to the control.

public BarGalleryViewModel(RoutedCommand routedCommand, IEnumerable items)

Parameter	Type	Description
routedCommand	RoutedCommand	The command to attach to the control.
items	IEnumerable	The collection of gallery items, where the items are typically of type IBarGalleryItemViewModel.

public ObservableCollection<object> AboveMenuItems { get; }

Property Value

ObservableCollection<object>:

The collection of menu items that appear above the menu gallery in a popup.

public ObservableCollection<object> BelowMenuItems { get; }

Property Value

ObservableCollection<object>:

The collection of menu items that below above the menu gallery in a popup.

public bool CanCategorize { get; set; }

Property Value

bool:

true if the gallery sorts and displays items by category when an System.ComponentModel.ICollectionView is set to the ItemsSource; otherwise, false. The default value is true.

public bool CanFilter { get; set; }

Property Value

bool:

true if the gallery supports filtering of items by category; otherwise, false. The default value is false.

public bool CanRibbonAutoScrollToSelectedItem { get; set; }

Property Value

bool:

true if the ribbon gallery selected item should automatically be scrolled into view on selection changes; otherwise, false. The default value is false.

public DataTemplate CategoryHeaderTemplate { get; set; }

Property Value

DataTemplate:

A DataTemplate for category headers when categorization is enabled.

public string CollapsedButtonDescription { get; set; }

Property Value

string:

The text description to display in screen tips for the gallery when it is rendered as a collapsed button.

public bool HasCategoryHeaders { get; set; }

Property Value

bool:

true if the gallery has category headers when categorizing; otherwise, false. The default value is true.

public bool IsSelectionSupported { get; set; }

Property Value

bool:

true if selection is supported by the gallery; otherwise, false. The default value is true.

public bool? IsSynchronizedWithCurrentItem { get; set; }

Property Value

bool?:

true if the SelectedItem is always synchronized with the current item in the Items; false if the SelectedItem is never synchronized with the current item; null if the SelectedItem is synchronized with the current item only if the gallery uses a CollectionView. The default value is null.

public IEnumerable Items { get; set; }

Property Value

IEnumerable:

The collection of gallery items.

public string KeyTipText { get; set; }

Property Value

string:

The key tip text used to access the control.

public ImageSource LargeImageSource { get; set; }

Property Value

ImageSource:

The ImageSource for a large image.

public int MaxMenuColumnCount { get; set; }

Property Value

int:

The maximum number of columns when in a menu. The default value is MaxValue.

public double MaxMenuGalleryHeight { get; set; }

Property Value

double:

The maximum popup height. The default value is 1000.0.

public int MaxRibbonColumnCount { get; set; }

Property Value

int:

The maximum number of columns when in-ribbon. The default value is 15.

public ImageSource MediumImageSource { get; set; }

Property Value

ImageSource:

The ImageSource for a medium image.

public ControlResizeMode MenuResizeMode { get; set; }

Property Value

ControlResizeMode:

A ControlResizeMode that indicates how the popup menu can resize. The default value is None.

public int MinLargeRibbonColumnCount { get; set; }

Property Value

int:

The minimum number of columns to use when in-ribbon with a Large variant size. The default value is 5.

public int MinMediumRibbonColumnCount { get; set; }

Property Value

int:

The minimum number of columns to use when in-ribbon with a Medium variant size. The default value is 3.

public int MinMenuColumnCount { get; set; }

Property Value

int:

The minimum number of columns when in a menu. The default value is 1.

public ICommand PopupOpeningCommand { get; set; }

Property Value

ICommand:

The ICommand that executes before the gallery's popup is opened, allowing its items to be customized in MVVM scenarios.

public string SelectedFilterCategory { get; set; }

Property Value

string:

The selected filter category.

public IBarGalleryItemViewModel SelectedItem { get; set; }

Property Value

IBarGalleryItemViewModel:

The selected item.

public ItemCollapseBehavior ToolBarItemCollapseBehavior { get; set; }

Property Value

ItemCollapseBehavior:

The ItemCollapseBehavior for the control when in a ribbon using Simplified layout mode. The default value is Default.

public ItemVariantBehavior ToolBarItemVariantBehavior { get; set; }

Property Value

ItemVariantBehavior:

The ItemVariantBehavior for the control when in a toolbar, which also applies when in a ribbon using Simplified layout mode. The default value is AlwaysSmall.

public bool UseAccentedItemBorder { get; set; }

Property Value

bool:

true if an accented item border should be used for gallery items; otherwise, false. The default value is false.

public bool UseMenuItemAppearance { get; set; }

Property Value

bool:

true if gallery items should use a menu item appearance; otherwise, false. The default value is false.

public bool UseMenuItemIndent { get; set; }

Property Value

bool:

true if gallery items should be indented past the menu's icon column; otherwise, false. The default value is false.

public static CollectionViewSource CreateCollectionViewSource(IEnumerable<IBarGalleryItemViewModel> items, bool categorize)

Parameter	Type	Description
items	IEnumerable<IBarGalleryItemViewModel>	The collection of gallery item view models to include in the collection view.
categorize	bool	Whether the collection view source should support categorization by including a group description based on Category property values.

Returns

CollectionViewSource:

The CollectionViewSource of gallery item view models that was created.

public virtual T SelectItemByValueMatch<T>(Func<T, bool> predicate) where T : IBarGalleryItemViewModel

Type Parameters:

T -

The type of IBarGalleryItemViewModel to examine.

Parameter	Type	Description
predicate	Func<T, bool>	A predicate that determines when an item matches criteria.

Returns

T:

The BarGalleryViewModelBase that was selected.