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, IHasKey, IHasTag, IHasVariantImages
Inheritance:
object ObservableObjectBase BarKeyedObjectViewModelBase object
Implements:
IHasKey IHasTag IHasVariantImages

Constructors

RibbonGroupViewModel()

Initializes an instance of the class.

public RibbonGroupViewModel()

RibbonGroupViewModel(string?)

Initializes an 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 an 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 key if null.

RibbonGroupViewModel(string?, string?, string?)

Initializes an 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 key if null.
collapsedButtonKeyTipText string

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

Properties

CanAutoCollapse

Indicates 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 is true.

CanCloneToRibbonQuickAccessToolBar

Indicates 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 is true.

ChildOverflowTarget

A RibbonGroupChildOverflowTarget indicating where items overflow when in a Simplified layout mode.

public RibbonGroupChildOverflowTarget ChildOverflowTarget { get; set; }

Property Value

RibbonGroupChildOverflowTarget:

The default value is Tab.

CollapsedButtonDescription

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

CollapsedButtonKeyTipText

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

IsVisible

Indicates whether the control is currently visible.

public bool IsVisible { get; set; }

Property Value

bool:

The default value is true.

Items

The collection of items in the control.

public ObservableCollection<object> Items { get; }

Property Value

ObservableCollection<object>

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

LauncherButton

A RibbonGroupLauncherButtonViewModel for the optional launcher button.

public RibbonGroupLauncherButtonViewModel? LauncherButton { get; set; }

Property Value

RibbonGroupLauncherButtonViewModel

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

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