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

RibbonControlGroup Class

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

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, DUCE.IResource, IAnimatable, IFrameworkInputElement, IInputElement, ISupportInitialize, IHaveResources, IQueryAmbient, IAddChild, IGeneratorHost, IContainItemStorage, IOrientedElement, ISupportsStarSizing
Inheritance:
System.Object System.Windows.Threading.DispatcherObject System.Windows.DependencyObject System.Windows.Media.Visual System.Windows.UIElement System.Windows.FrameworkElement System.Windows.Controls.Control System.Windows.Controls.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

System.Boolean:

true if the control group can arrange vertically; otherwise, false. The default value is false.

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.

public Orientation Orientation { get; }

Property Value

System.Windows.Controls.Orientation:

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 System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject, System.Object) method.

protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameter Type Description
element System.Windows.DependencyObject

The container element.
item System.Object

The item.

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

protected override DependencyObject GetContainerForItemOverride()

Returns

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

The item to check.

Returns

System.Boolean:

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 System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer:

The type-specific System.Windows.Automation.Peers.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 System.Windows.DependencyObject

Element used to display the specified item.
item System.Object

Specified item.

Explicit Interface Implementations

ISupportsStarSizing.IsStarSizingAllowed

Gets whether star-sizing is allowed.

bool ISupportsStarSizing.IsStarSizingAllowed { get; }

Returns

System.Boolean:

true if star-sizing is allowed; otherwise, false.

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

Inherited Members

  • System.Object.ToString()
  • System.Object.Equals(System.Object)
  • System.Object.Equals(System.Object, System.Object)
  • System.Object.ReferenceEquals(System.Object, System.Object)
  • System.Object.GetHashCode()
  • System.Object.GetType()
  • System.Object.MemberwiseClone()

Extension Methods