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

RibbonBackstageTabViewModel Class

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

Represents a view model for a tab control within a ribbon backstage.

public class RibbonBackstageTabViewModel : BarKeyedObjectViewModelBase, IHasKey
Inheritance:
object ObservableObjectBase BarKeyedObjectViewModelBase object
Implements:
IHasKey

Constructors

RibbonBackstageTabViewModel()

Initializes a new instance of the class.

public RibbonBackstageTabViewModel()

RibbonBackstageTabViewModel(string)

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

public RibbonBackstageTabViewModel(string key)
Parameter Type Description
key string

A string that uniquely identifies the control.

RibbonBackstageTabViewModel(string, string)

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

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

RibbonBackstageTabViewModel(string, string, string)

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

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

Properties

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.

HeaderAlignment

Gets or sets a RibbonBackstageHeaderAlignment indicating the alignment of the control within the ribbon Backstage header.

public RibbonBackstageHeaderAlignment HeaderAlignment { get; set; }

Property Value

RibbonBackstageHeaderAlignment:

A RibbonBackstageHeaderAlignment indicating the alignment of the control within the ribbon Backstage header. The default value is Top.

IsVisible

Gets or sets whether the control is currently visible.

public bool IsVisible { get; set; }

Property Value

bool:

The default value is true.

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.

public string Label { get; set; }

Property Value

string:

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.

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.

public string Title { get; set; }

Property Value

string:

The string title.

VariantSize

Gets or sets the variant size of the tab.

public VariantSize VariantSize { get; set; }

Property Value

VariantSize:

One of the VariantSize value. The default value is Medium.

Inherited Members