RibbonTabViewModel Class
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 |
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 |
keyTipText | string | The key tip text, which is auto-generated from the |
Properties
ContextualTabGroupKey
Gets or sets the string key of the related contextual tab group, if this should be a contextual tab.
public string ContextualTabGroupKey { get; set; }
Property Value
- string:
The string key of the related contextual tab group, if this should be a contextual tab.
ControlVariants
Gets or sets 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:
The collection of variant size transitions to apply to all controls within the tab when the ribbon is in Simplified layout mode.
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.
GroupVariants
Gets or sets 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:
The collection of variant size transitions to apply to all groups within the tab when the ribbon is in Classic layout mode.
Groups
Gets the collection of group view models within the tab.
public ObservableCollection<RibbonGroupViewModel> Groups { get; }
Property Value
- ObservableCollection<RibbonGroupViewModel>:
The collection of group view models within the tab.
IsVisible
Gets or sets 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
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.
Title
Gets or sets the string title, which can override the Label when displayed in screen tips and customization UI.
Methods
ToString()
Returns the string representation of this object.
Inherited Members
- BarKeyedObjectViewModelBase.Key
- ObservableObjectBase.NotifyPropertyChanged(string)
- ObservableObjectBase.OnPropertyChanged(PropertyChangedEventArgs)
- ObservableObjectBase.SetProperty<T>(ref T, T, string)
- ObservableObjectBase.PropertyChanged
- object.GetType()
- object.MemberwiseClone()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()