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

RibbonGroupViewModel Class

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

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

public class RibbonGroupViewModel : BarKeyedObjectViewModelBase, INotifyPropertyChanged, IHasKey
Inheritance:
System.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 System.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 System.String

A string that uniquely identifies the control.
label System.String

The text label to display, which is auto-generated from the key if null.

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 System.String

A string that uniquely identifies the control.
label System.String

The text label to display, which is auto-generated from the key if null.
collapsedButtonKeyTipText System.String

The collapsed button key tip text, which is auto-generated from the label if null.

Properties

CanAutoCollapse

Gets or sets whether the group can auto-collapse.

public bool CanAutoCollapse { get; set; }

Property Value

System.Boolean:

true if the group can auto-collapse; otherwise, false. The default value is true.

CanCloneToRibbonQuickAccessToolBar

Gets or sets whether the control can be cloned to the ribbon quick-access toolbar.

public bool CanCloneToRibbonQuickAccessToolBar { get; set; }

Property Value

System.Boolean:

true if the control can be cloned to the ribbon quick-access toolbar; otherwise, false. The default value is true.

CanUseMultiRowLayout

Gets or sets whether the items can be arranged in a multi-row layout.

public bool CanUseMultiRowLayout { get; set; }

Property Value

System.Boolean:

true if the items can be arranged in a multi-row layout; otherwise, false. The default value is false.

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

System.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

System.String:

The key tip text used to access the group when it is rendered as a collapsed button.

Items

Gets the collection of items in the control.

public ObservableCollection<object> Items { get; }

Property Value

System.Collections.ObjectModel.ObservableCollection<System.Object>:

The collection of items in the control.

Label

Gets or sets the text label to display.

public string Label { get; set; }

Property Value

System.String:

The text label to display.

LargeImageSource

Gets or sets the System.Windows.Media.ImageSource for a large image, generally 32x32 size.

public ImageSource LargeImageSource { get; set; }

Property Value

System.Windows.Media.ImageSource:

The System.Windows.Media.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 System.Windows.Media.ImageSource for a small image, generally 16x16 size.

public ImageSource SmallImageSource { get; set; }

Property Value

System.Windows.Media.ImageSource:

The System.Windows.Media.ImageSource for a small image.

ThreeRowItemSortOrder

Gets or sets a collection of integers that indicates the indices of how items should be sorted when in a three-row layout.

public Int32Collection ThreeRowItemSortOrder { get; set; }

Property Value

System.Windows.Media.Int32Collection:

A collection of integers that indicates the indices of how items should be sorted when in a three-row layout.

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

System.String:

The string title.

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

System.String:

A string that represents the current object.

Inherited Members