BarPopupButtonViewModel Class
Represents a view model for a popup button control within a bar control.
public class BarPopupButtonViewModel : BarKeyedObjectViewModelBase, IHasKey, IHasVariantImages
- Inheritance:
- object ObservableObjectBase BarKeyedObjectViewModelBase object
- Derived:
- BarSplitButtonViewModel
- Implements:
- IHasKey IHasVariantImages
Constructors
BarPopupButtonViewModel()
Initializes a new instance of the class.
public BarPopupButtonViewModel()
BarPopupButtonViewModel(string)
Initializes a new instance of the class with the specified key. The label and key tip text are auto-generated.
public BarPopupButtonViewModel(string key)
Parameter | Type | Description |
---|---|---|
key | string | A string that uniquely identifies the control. |
BarPopupButtonViewModel(string, string)
Initializes a new instance of the class with the specified key and label. The key tip text is auto-generated.
public BarPopupButtonViewModel(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 |
BarPopupButtonViewModel(string, string, string)
Initializes a new instance of the class with the specified key, label, and key tip text.
public BarPopupButtonViewModel(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 |
keyTipText | string | The key tip text, which is auto-generated from the |
BarPopupButtonViewModel(string, string, string, ICommand)
Initializes a new instance of the class with the specified key, label, key tip text, and command.
protected BarPopupButtonViewModel(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 |
keyTipText | string | The key tip text, which is auto-generated from the |
command | ICommand | The command to attach to the control. |
Properties
CanCloneToRibbonQuickAccessToolBar
Gets or sets whether the control can be cloned to the ribbon quick-access toolbar.
public bool CanCloneToRibbonQuickAccessToolBar { get; set; }
Property Value
- bool:
true
if the control can be cloned to the ribbon quick-access toolbar; otherwise,false
. The default value istrue
.
Command
Gets or sets the ICommand to attach to the control.
public ICommand Command { get; set; }
Property Value
CommandParameter
Gets or sets the parameter to pass to the Command property.
public object CommandParameter { get; set; }
Property Value
Description
Gets or sets the text description to display in screen tips.
public string Description { get; set; }
Property Value
- string:
The text description to display in screen tips.
IsVisible
Gets or sets whether the control is currently visible.
KeyTipText
Gets or sets the key tip text used to access the control.
public string KeyTipText { get; set; }
Property Value
- string:
The key tip text used to access the control.
Label
Gets or sets the text label to display.
LargeImageSource
Gets or sets the ImageSource for a large image, generally 32x32
size.
public ImageSource LargeImageSource { get; set; }
Property Value
- ImageSource:
The ImageSource for a large image.
MediumImageSource
Gets or sets the ImageSource for a medium image, generally 24x24
size.
public ImageSource MediumImageSource { get; set; }
Property Value
- ImageSource:
The ImageSource for a medium image.
MenuItems
Gets the collection of menu items that appear within the popup.
public ObservableCollection<object> MenuItems { get; }
Property Value
- ObservableCollection<object>:
The collection of menu items that appear within the popup.
PopupOpeningCommand
Gets or sets the ICommand that executes before the button's popup is opened, allowing its items to be customized in MVVM scenarios.
public ICommand PopupOpeningCommand { get; set; }
Property Value
SmallImageSource
Gets or sets the ImageSource for a small image, generally 16x16
size.
public ImageSource SmallImageSource { get; set; }
Property Value
- ImageSource:
The ImageSource for a small image.
Title
Gets or sets the string title, which can override the Label when displayed in screen tips and customization UI.
ToolBarItemCollapseBehavior
Gets or sets the ItemCollapseBehavior for the control when in a ribbon using Simplified layout mode.
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
.
ToolBarItemVariantBehavior
Gets or sets the ItemVariantBehavior for the control when in a toolbar, which also applies when in a ribbon using Simplified layout mode.
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
.
UseLargeMenuItem
Gets or sets whether to use a large size when the control is a menu item.
public bool UseLargeMenuItem { get; set; }
Property Value
- bool:
true
if a large size should be used when the control is a menu item; otherwise,false
. The default value isfalse
.
Inherited Members
- BarKeyedObjectViewModelBase.ToString()
- BarKeyedObjectViewModelBase.Key
- ObservableObjectBase.NotifyPropertyChanged(string)
- ObservableObjectBase.OnPropertyChanged(PropertyChangedEventArgs)
- ObservableObjectBase.SetProperty<T>(ref T, T, string)
- ObservableObjectBase.PropertyChanged
- object.GetType()
- object.MemberwiseClone()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()