RibbonGroup Class

[TemplatePart(Name = "PART_CollapsedButton", Type = typeof(RibbonGroupCollapsedButton))]
[TemplatePart(Name = "PART_LauncherButtonPresenter", Type = typeof(ContentPresenter))]
public class RibbonGroup : ItemsControl

public RibbonGroup()

public bool CanAutoCollapse { get; set; }

Property Value

bool:

true if the group can be automatically collapsed when the ribbon has limited available space; otherwise, false. The default value is true.

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.

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.

[Localizability(LocalizationCategory.Label)]
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.

public object CollapsedButtonToolTip { get; set; }

Property Value

object:

The tooltip for the collapsed button.

public CornerRadius CornerRadius { get; set; }

Property Value

CornerRadius:

The corner radius of the control's border.

public RibbonGroupLabelMode GroupLabelMode { get; }

Property Value

RibbonGroupLabelMode:

The RibbonGroupLabelMode that specifies when the group is labeled. The default value is Default.

public bool IsAnimationEnabled { get; set; }

Property Value

bool:

true if animation is enabled; otherwise, false. The default value is true.

public bool IsOverflowButtonVisible { get; }

Property Value

bool:

true if the overflow button is visible; otherwise, false.

public bool IsPopupOpen { get; set; }

Property Value

bool:

true if the popup is open; otherwise, false.

public bool IsPopupPresenterAnimationEnabled { get; }

Property Value

bool:

true if popup presenter animation is enabled; otherwise, false.

[Localizability(LocalizationCategory.NeverLocalize)]
public string Key { get; set; }

Property Value

string:

A string that uniquely identifies the control.

[Localizability(LocalizationCategory.Label)]
public string Label { get; set; }

Property Value

string:

The text label to display.

public ImageSource LargeImageSource { get; set; }

Property Value

ImageSource:

The ImageSource for a large image.

public object LauncherButtonContent { get; set; }

Property Value

object:

The launcher button, which can either be a launcher button view model that uses ItemContainerTemplateSelector for its UI, or a RibbonGroupLauncherButton control instance.

public RibbonLayoutMode LayoutMode { get; }

Property Value

RibbonLayoutMode:

A RibbonLayoutMode indicating the layout mode in use.

public object OverflowButtonToolTip { get; set; }

Property Value

object:

The tooltip for the overflow button.

public Brush SeparatorBrush { get; set; }

Property Value

Brush:

The Brush to render separators.

public ImageSource SmallImageSource { get; set; }

Property Value

ImageSource:

The ImageSource for a small image.

[Localizability(LocalizationCategory.Title)]
public string Title { get; set; }

Property Value

string:

The string title.

public UserInterfaceDensity UserInterfaceDensity { get; set; }

Property Value

UserInterfaceDensity:

A UserInterfaceDensity that indicates how compact or spacious the UI should appear. The default value is Compact.

public VariantSize VariantSize { get; set; }

Property Value

VariantSize:

The VariantSize currently assigned to the control.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	The container element.
item	object	The item.

protected override DependencyObject GetContainerForItemOverride()

Returns

DependencyObject:

The element that is used to display the given item.

protected override bool IsItemItsOwnContainerOverride(object item)

Parameter	Type	Description
item	object	The item to check.

Returns

bool:

true if the item is (or is eligible to be) its own container; otherwise, false.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected virtual void OnKeyTipInvoked(KeyTipInvokedEventArgs e)

Parameter	Type	Description
e	KeyTipInvokedEventArgs	The KeyTipInvokedEventArgs containing data related to this event.

protected virtual void OnKeyTipOpening(KeyTipOpeningEventArgs e)

Parameter	Type	Description
e	KeyTipOpeningEventArgs	The KeyTipOpeningEventArgs containing data related to this event.

protected virtual void OnVariantSizeChanged(VariantSize oldValue, VariantSize newValue)

Parameter	Type	Description
oldValue	VariantSize	The old value.
newValue	VariantSize	The new value.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameter	Type	Description
element	DependencyObject	Element used to display the specified item.
item	object	Specified item.

public override string ToString()

Returns

string:

The string representation of this object.

public static readonly DependencyProperty CanAutoCollapseProperty

public static readonly DependencyProperty CanCloneToRibbonQuickAccessToolBarProperty

public static readonly DependencyProperty ChildOverflowTargetProperty

public static readonly DependencyProperty CollapsedButtonKeyTipTextProperty

public static readonly DependencyProperty CollapsedButtonToolTipProperty

public static readonly DependencyProperty CornerRadiusProperty

public static readonly DependencyProperty GroupLabelModeProperty

public static readonly DependencyProperty IsAnimationEnabledProperty

public static readonly DependencyProperty IsOverflowButtonVisibleProperty

public static readonly DependencyProperty IsPopupOpenProperty

public static readonly DependencyProperty IsPopupPresenterAnimationEnabledProperty

public static readonly DependencyProperty KeyProperty

public static readonly DependencyProperty LabelProperty

public static readonly DependencyProperty LargeImageSourceProperty

public static readonly DependencyProperty LauncherButtonContentProperty

public static readonly DependencyProperty LayoutModeProperty

public static readonly DependencyProperty OverflowButtonToolTipProperty

public static readonly DependencyProperty SeparatorBrushProperty

public static readonly DependencyProperty SmallImageSourceProperty

public static readonly DependencyProperty TitleProperty

public static readonly DependencyProperty UserInterfaceDensityProperty

public static readonly DependencyProperty VariantSizeProperty