In This Article

RibbonBackstageTabViewModel Class

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

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

Constructors

RibbonBackstageTabViewModel()

Initializes an instance of the class.

public RibbonBackstageTabViewModel()

RibbonBackstageTabViewModel(string?)

Initializes an 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 an 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 an 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

Content

The content for the tab's content area, which can be a UI control, a data object, or even this view model instance.

public object? Content { get; set; }

Property Value

object

ContentTemplate

The DataTemplate for the tab's Content.

public DataTemplate? ContentTemplate { get; set; }

Property Value

DataTemplate

ContentTemplateSelector

The DataTemplateSelector for the tab's Content.

public DataTemplateSelector? ContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector

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.

IsEnabled

Indicates whether the control is currently enabled.

public bool IsEnabled { get; set; }

Property Value

bool:

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

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

VariantSize

The variant size of the tab.

public VariantSize VariantSize { get; set; }

Property Value

VariantSize:

The default value is Medium.

Inherited Members

Extension Methods