PreferredSizeOnRibbon Property

Gets or sets the default size of the ToolBase instance when sited in a RibbonGroup.

Syntax

Visual Basic

'Declaration
 
Public Property PreferredSizeOnRibbon As RibbonToolSize

C#

public RibbonToolSize PreferredSizeOnRibbon {get; set;}

Property Value

The default size of the ToolBase instance when sited in a RibbonGroup.

Exceptions

Exception	Description
System.NotSupportedException	The property is modified at design-time for a tool in an UltraToolbarsManager defined on a base Form or UserControl. Inherited tools must be modified at run-time or at design-time through the designer of the Form or UserControl they were created on.
System.ComponentModel.InvalidEnumArgumentException	The value assigned is not defined in the RibbonToolSize enumeration.

Remarks

The preferred size will indicates what size the tool should be when it has enough room to display large enough. Therefore, it also serves as a maximum size for the tool. Given enough space, each tool will display as large as possible, up to the preferred size.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, 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