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

RibbonBackstageHeaderButtonViewModel Class

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

Represents a view model for a button control within a ribbon backstage header.

public class RibbonBackstageHeaderButtonViewModel : BarKeyedObjectViewModelBase, IHasKey, IHasTag, IHasVariantImages
Inheritance:
object ObservableObjectBase BarKeyedObjectViewModelBase object
Implements:
IHasKey IHasTag IHasVariantImages

Constructors

RibbonBackstageHeaderButtonViewModel()

Initializes an instance of the class.

public RibbonBackstageHeaderButtonViewModel()

RibbonBackstageHeaderButtonViewModel(string?)

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

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

A string that uniquely identifies the control.

RibbonBackstageHeaderButtonViewModel(string?, string?)

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

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

RibbonBackstageHeaderButtonViewModel(string?, string?, string?)

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

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

RibbonBackstageHeaderButtonViewModel(string?, string?, string?, ICommand?)

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

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

RibbonBackstageHeaderButtonViewModel(string?, string?, ICommand?)

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

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

RibbonBackstageHeaderButtonViewModel(string?, ICommand?)

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

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

RibbonBackstageHeaderButtonViewModel(RoutedCommand?)

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

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

The command to attach to the control.

Properties

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

HeaderAlignment

A RibbonBackstageHeaderAlignment indicating the alignment of the control within the ribbon Backstage header.

public RibbonBackstageHeaderAlignment HeaderAlignment { get; set; }

Property Value

RibbonBackstageHeaderAlignment:

The default value is Top.

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

SmallImageSource

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

public ImageSource? SmallImageSource { get; set; }

Property Value

ImageSource

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

Inherited Members

Extension Methods