RibbonControlGroup Class
Represents a control that encapsulates a set of similar controls within a RibbonGroup, altering their variant sizes using a designated behavior.
[TemplatePart(Name = "PART_ExternalHeaderHostPanel", Type = typeof(Panel))]
public class RibbonControlGroup : ItemsControl, IOrientedElement, ISupportsStarSizing
- Inheritance:
- object Visual UIElement FrameworkElement Control ItemsControl object
- Implements:
- IOrientedElement ISupportsStarSizing
Constructors
RibbonControlGroup()
Initializes a new instance of the RibbonControlGroup class.
public RibbonControlGroup()
Properties
CanArrangeVertically
Gets or sets whether the control group can arrange vertically.
public bool CanArrangeVertically { get; set; }
Property Value
- bool:
true
if the control group can arrange vertically; otherwise,false
. The default value isfalse
.
ItemVariantBehavior
Gets or sets an ItemVariantBehavior that indicates how variant sizes should be applied to items.
public ItemVariantBehavior ItemVariantBehavior { get; set; }
Property Value
- ItemVariantBehavior:
An ItemVariantBehavior that indicates how variant sizes should be applied to items. The default value is All.
ItemVariantSize
Gets a VariantSize indicating the variant size for items.
public VariantSize ItemVariantSize { get; }
Property Value
- VariantSize:
A VariantSize indicating the variant size for items.
LayoutMode
Gets a RibbonLayoutMode indicating the layout mode in use.
public RibbonLayoutMode LayoutMode { get; }
Property Value
- RibbonLayoutMode:
A RibbonLayoutMode indicating the layout mode in use.
Orientation
Gets the orientation of the control.
SeparatorMode
Gets or sets a RibbonControlGroupSeparatorMode indicating how separators should be positioned around the control.
public RibbonControlGroupSeparatorMode SeparatorMode { get; set; }
Property Value
- RibbonControlGroupSeparatorMode:
A RibbonControlGroupSeparatorMode indicating how separators should be positioned around the control. The default value is Default.
UserInterfaceDensity
Gets or sets a UserInterfaceDensity that indicates how compact or spacious the UI should appear.
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.
VariantSize
Gets or sets the VariantSize currently assigned to the control. This property should only be manually set when the control is standalone, and not hosted by a bar control.
public VariantSize VariantSize { get; set; }
Property Value
- VariantSize:
The VariantSize currently assigned to the control.
Methods
ClearContainerForItemOverride(DependencyObject, object)
When overridden in a derived class, undoes the effects of the PrepareContainerForItemOverride(DependencyObject, object) method.
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameter | Type | Description |
---|---|---|
element | DependencyObject | The container element. |
item | object | The item. |
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
protected override DependencyObject GetContainerForItemOverride()
Returns
- DependencyObject:
The element that is used to display the given item.
IsItemItsOwnContainerOverride(object)
Determines if the specified item is (or is eligible to be) its own container.
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
.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes call ApplyTemplate().
public override void OnApplyTemplate()
OnCreateAutomationPeer()
Returns class-specific AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.
protected override AutomationPeer OnCreateAutomationPeer()
Returns
- AutomationPeer:
The type-specific AutomationPeer implementation.
PrepareContainerForItemOverride(DependencyObject, object)
Prepares the specified element to display the specified item.
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameter | Type | Description |
---|---|---|
element | DependencyObject | Element used to display the specified item. |
item | object | Specified item. |
ToString()
Returns the string representation of this object.
Fields
CanArrangeVerticallyProperty
Identifies the CanArrangeVertically dependency property. This field is read-only.
public static readonly DependencyProperty CanArrangeVerticallyProperty
ItemVariantBehaviorProperty
Identifies the ItemVariantBehavior dependency property. This field is read-only.
public static readonly DependencyProperty ItemVariantBehaviorProperty
ItemVariantSizeProperty
Identifies the ItemVariantSize dependency property. This field is read-only.
public static readonly DependencyProperty ItemVariantSizeProperty
LayoutModeProperty
Identifies the LayoutMode dependency property. This field is read-only.
public static readonly DependencyProperty LayoutModeProperty
OrientationProperty
Identifies the Orientation dependency property. This field is read-only.
public static readonly DependencyProperty OrientationProperty
SeparatorModeProperty
Identifies the SeparatorMode dependency property. This field is read-only.
public static readonly DependencyProperty SeparatorModeProperty
UserInterfaceDensityProperty
Identifies the UserInterfaceDensity dependency property. This field is read-only.
public static readonly DependencyProperty UserInterfaceDensityProperty
VariantSizeProperty
Identifies the VariantSize dependency property. This field is read-only.
public static readonly DependencyProperty VariantSizeProperty