Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

BarButtonViewModel Class

Namespace:
ActiproSoftware.Windows.Controls.Bars.Mvvm
Assembly:
ActiproSoftware.Bars.Mvvm.Wpf.dll

Represents a view model for a regular button control within a bar control.

public class BarButtonViewModel : BarKeyedObjectViewModelBase, IHasKey, IHasTag, IHasVariantImages
Inheritance:
object ObservableObjectBase BarKeyedObjectViewModelBase object
Derived:
BarToggleButtonViewModel
Implements:
IHasKey IHasTag IHasVariantImages

Constructors

BarButtonViewModel()

Initializes an instance of the class.

public BarButtonViewModel()

BarButtonViewModel(string?)

Initializes an instance of the class with the specified key. The label and key tip text are auto-generated.

public BarButtonViewModel(string? key)
Parameter Type Description
key string

A string that uniquely identifies the control.

BarButtonViewModel(string?, string?)

Initializes an instance of the class with the specified key and label. The key tip text is auto-generated.

public BarButtonViewModel(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.

BarButtonViewModel(string?, string?, string?)

Initializes an instance of the class with the specified key, label, and key tip text.

public BarButtonViewModel(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.

BarButtonViewModel(string?, string?, string?, ICommand?)

Initializes an instance of the class with the specified key, label, key tip text, and command.

public BarButtonViewModel(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.

BarButtonViewModel(string?, string?, ICommand?)

Initializes an instance of the class with the specified key, label, and command. The key tip text is auto-generated.

public BarButtonViewModel(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.

BarButtonViewModel(string?, ICommand?)

Initializes an instance of the class with the specified key and command. The label and key tip text are auto-generated.

public BarButtonViewModel(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.

BarButtonViewModel(RoutedCommand?)

Initializes an instance of the class with the specified RoutedCommand, also used to auto-generate a key, label, and key tip text.

public BarButtonViewModel(RoutedCommand? routedCommand)
Parameter Type Description
routedCommand RoutedCommand

The command to attach to the control.

Properties

CanCloneToRibbonQuickAccessToolBar

Indicates 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 is true.

Command

The ICommand to attach to the control.

public ICommand? Command { get; set; }

Property Value

ICommand

CommandParameter

The parameter to pass to the Command property.

public object? CommandParameter { get; set; }

Property Value

object

Description

The text description to display in screen tips.

public string? Description { get; set; }

Property Value

string

InputGestureText

The input gesture text to display in menu items and screen tips, which overrides any auto-generated input gesture text from the Command.

public string? InputGestureText { get; set; }

Property Value

string

InvocationFocusBehavior

Indicates how the button outside of a menu context processes focus when it is clicked.

public InvocationFocusBehavior InvocationFocusBehavior { get; set; }

Property Value

InvocationFocusBehavior:

The default value is Default.

IsInputGestureTextVisible

Indicates whether the input gesture text is allowed to be visible in the user interface.

public bool IsInputGestureTextVisible { get; set; }

Property Value

bool:

true if the input gesture text is allowed to be visible in the user interface; otherwise, false. The default value is true.

IsVisible

Indicates whether the control is currently visible.

public bool IsVisible { get; set; }

Property Value

bool:

The default value is true.

KeyTipText

The key tip text used to access the control.

public string? KeyTipText { get; set; }

Property Value

string

Label

The text label to display.

public string? Label { get; set; }

Property Value

string

LargeImageSource

The ImageSource for a large image, generally 32x32 size.

public ImageSource? LargeImageSource { get; set; }

Property Value

ImageSource

MediumImageSource

The ImageSource for a medium image, generally 24x24 size.

public ImageSource? MediumImageSource { get; set; }

Property Value

ImageSource

SmallImageSource

The ImageSource for a small image, generally 16x16 size.

public ImageSource? SmallImageSource { get; set; }

Property Value

ImageSource

StaysOpenOnClick

Indicates whether menus should try and remain open when the control is clicked.

public bool StaysOpenOnClick { get; set; }

Property Value

bool:

true if menus should try and remain open when the control is clicked; otherwise, false. The default value is false.

Title

The string title, which can override the Label when displayed in screen tips and customization UI.

public string? Title { get; set; }

Property Value

string

ToolBarItemCollapseBehavior

The ItemCollapseBehavior for the control when in a ribbon using Simplified layout mode.

public ItemCollapseBehavior ToolBarItemCollapseBehavior { get; set; }

Property Value

ItemCollapseBehavior:

The default value is Default.

ToolBarItemVariantBehavior

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 default value is AlwaysSmall.

UseLargeMenuItem

Indicates 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 is false.

Inherited Members

Extension Methods