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

RibbonTabViewModel Class

Namespace:
ActiproSoftware.UI.Avalonia.Controls.Bars.Mvvm
Assembly:
ActiproSoftware.Avalonia.Bars.Mvvm.dll

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

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

Constructors

RibbonTabViewModel()

Initializes a new instance of the class.

public RibbonTabViewModel()

RibbonTabViewModel(string?)

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

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

A string that uniquely identifies the control.

RibbonTabViewModel(string?, string?)

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

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

RibbonTabViewModel(string?, string?, string?)

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

public RibbonTabViewModel(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

ContextualTabGroupKey

The string key of the related contextual tab group, if this should be a contextual tab.

public string? ContextualTabGroupKey { get; set; }

Property Value

string

ControlVariants

The collection of variant size transitions to apply to all controls within the tab when the ribbon is in Simplified layout mode.

public VariantCollection? ControlVariants { get; set; }

Property Value

VariantCollection

Description

The text description to display in screen tips.

public string? Description { get; set; }

Property Value

string

GroupVariants

The collection of variant size transitions to apply to all groups within the tab when the ribbon is in Classic layout mode.

public VariantCollection? GroupVariants { get; set; }

Property Value

VariantCollection

Groups

The collection of group view models within the tab.

public ObservableCollection<RibbonGroupViewModel> Groups { get; }

Property Value

ObservableCollection<RibbonGroupViewModel>

IsVisible

Indicates whether the control is currently visible.

public bool IsVisible { get; set; }

Property Value

bool:

The default value is true.

Remarks

This property should not be set to control the visibility of contextual tabs.

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

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

Methods

ToString()

Returns the string representation of this object.

public override string ToString()

Returns

string:

The string representation of this object.

Inherited Members

Extension Methods