Version

GroupVariant Class

Provides information that is used to determine the order/priority in which a RibbonGroup will be resized within a RibbonTabItem.
Syntax
'Declaration
 
Public Class GroupVariant 
   Inherits Infragistics.DependencyObjectNotifier
public class GroupVariant : Infragistics.DependencyObjectNotifier 
Remarks

GroupVariants are used to control the order and type of resize actions that can happen for a RibbonGroup. By default, the RibbonGroup.Variants collection of a RibbonGroup is empty. When all of the RibbonGroups within a RibbonTabItem have their Variants collection empty, the default resizing logic will be used to resize the groups when there is no enough room to display the contents of all the RibbonGroups in the tab. The default behavior is to perform each resize action on each RibbonGroup from last to first and then move on to the next resize action. To control the order and type of resize actions that will occur for a RibbonGroup, you would create one or more GroupVariant instances and add it to the Variants collection of the RibbonGroup.

The GroupVariant exposes two properties - Priority and ResizeAction. Priority is used to sort the GroupVariant with respect to the other GroupVariants within the Variants collections of all the RibbonGroups in a RibbonTabItem. The lower priority GroupVariants will be processed before those with higher Priority values.

ResizeAction is used to determine the type of resize action that will occur when the GroupVariant is processed. For example, a value of CollapseRibbonGroup is used to indicate that the RibbonGroup should be collapsed. When a RibbonGroup is collapsed, you will see a button containing the caption of the RibbonGroup. Clicking that button will display the contents of the RibbonGroup within a popup. A value of ReduceImageAndTextLargeTools is used to indicate that all tools whose current ButtonTool.SizingMode is ImageAndTextLarge should be reduced to ImageAndTextNormal. The RibbonGroup.MaximumSizeProperty and RibbonGroup.MinimumSizeProperty can be used to control the minimum and maximum allowable sizes for tools within the RibbonGroup.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also