RibbonGroupViewModel Class
Represents a view model for a group within a ribbon tab.
public class RibbonGroupViewModel : BarKeyedObjectViewModelBase, IHasKey
- Inheritance:
- object ObservableObjectBase BarKeyedObjectViewModelBase object
- Implements:
- IHasKey
Constructors
RibbonGroupViewModel()
Initializes a new instance of the class.
public RibbonGroupViewModel()
RibbonGroupViewModel(string)
Initializes a new instance of the class with the specified key. The label and collapsed button key tip text are auto-generated.
public RibbonGroupViewModel(string key)
Parameter | Type | Description |
---|---|---|
key | string | A string that uniquely identifies the control. |
RibbonGroupViewModel(string, string)
Initializes a new instance of the class with the specified key and label. The collapsed button key tip text is auto-generated.
public RibbonGroupViewModel(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 |
RibbonGroupViewModel(string, string, string)
Initializes a new instance of the class with the specified key, label, and key tip text.
public RibbonGroupViewModel(string key, string label, string collapsedButtonKeyTipText)
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 |
collapsedButtonKeyTipText | string | The collapsed button key tip text, which is auto-generated from the |
Properties
CanAutoCollapse
Gets or sets whether the group can auto-collapse.
public bool CanAutoCollapse { get; set; }
Property Value
- bool:
true
if the group can auto-collapse; otherwise,false
. The default value istrue
.
CanCloneToRibbonQuickAccessToolBar
Gets or sets whether the control can be cloned to the ribbon quick-access toolbar.
public bool CanCloneToRibbonQuickAccessToolBar { get; set; }
Property Value
- bool:
true
if the control can be cloned to the ribbon quick-access toolbar; otherwise,false
. The default value istrue
.
ChildOverflowTarget
Gets or sets a RibbonGroupChildOverflowTarget indicating where items overflow when in a Simplified layout mode.
public RibbonGroupChildOverflowTarget ChildOverflowTarget { get; set; }
Property Value
- RibbonGroupChildOverflowTarget:
A RibbonGroupChildOverflowTarget indicating where items overflow when in a Simplified layout mode. The default value is Tab.
CollapsedButtonDescription
Gets or sets the text description to display in screen tips for the group when it is rendered as a collapsed button.
public string CollapsedButtonDescription { get; set; }
Property Value
- string:
The text description to display in screen tips for the group when it is rendered as a collapsed button.
CollapsedButtonKeyTipText
Gets or sets the key tip text used to access the group when it is rendered as a collapsed button.
public string CollapsedButtonKeyTipText { get; set; }
Property Value
- string:
The key tip text used to access the group when it is rendered as a collapsed button.
IsVisible
Gets or sets whether the control is currently visible.
Items
Gets the collection of items in the control.
public ObservableCollection<object> Items { get; }
Property Value
- ObservableCollection<object>:
The collection of items in the control.
Label
Gets or sets 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.
LauncherButton
Gets or sets a RibbonGroupLauncherButtonViewModel for the optional launcher button.
public RibbonGroupLauncherButtonViewModel LauncherButton { get; set; }
Property Value
- RibbonGroupLauncherButtonViewModel:
A RibbonGroupLauncherButtonViewModel for the optional launcher button.
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.
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()