Class RibbonControlAdv

RibbonControl advanced.

Inheritance
System.Object
RibbonControlAdv
SpreadsheetRibbon
Implements
System.ComponentModel.IExtenderProvider
System.ComponentModel.ISupportInitialize
System.Windows.Forms.IMessageFilter
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class RibbonControlAdv : ContainerControl, IThemeProvider, IVisualStyle, IOffice12Settings, IDockExtended, IExtenderProvider, ISupportInitialize, IMessageFilter, IRibbonStyleNotifier

Constructors

RibbonControlAdv()

Creates and initializes new instance of RibbonControlAdv.

Declaration
public RibbonControlAdv()

RibbonControlAdv(Size)

Creates and initializes new instance of RibbonControlAdv.

Declaration
public RibbonControlAdv(Size size)
Parameters
Type Name Description
System.Drawing.Size size

Control's initial size.

Properties

ActivateOnFirstClick

Indicates whether user can activate ToolStripItem(Button) on first click.

Declaration
public bool ActivateOnFirstClick { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

AllowCollapse

Indicates whether the user can expand or collapse the RibbonPanel.

Declaration
public bool AllowCollapse { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

AutoLayoutToolStrip

Gets or Sets the value indicating whether the toolstrip items can be arranged with defined size and layout.

Declaration
public bool AutoLayoutToolStrip { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.
Remarks

This property changes the layout and size of Toolstrip items like ToolstripButton, ToolstripDropDownButton, ToolstripGallery etc.

AutoSize

Gets/sets the AutoSize property for the control.

Declaration
public override bool AutoSize { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

BackColor

Gets or sets the background color for the control.

Declaration
public override Color BackColor { get; set; }
Property Value
Type Description
System.Drawing.Color

A System.Drawing.Color that represents the background color of the control. The default is the value of the System.Windows.Forms.Control.DefaultBackColor property.

BackStageButtonAlignment

To align the BackStage Arrow button

Declaration
public BackButtonAlignment BackStageButtonAlignment { get; set; }
Property Value
Type Description
BackButtonAlignment

The default value is BackButtonAlignment.Left.

BackStageNavigationButtonEnabled

Gets or sets a value indicating whether the Menu button can respond to user interaction.

Declaration
public bool BackStageNavigationButtonEnabled { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

BackStageNavigationButtonStyle

Gets/Sets the BackStage Navigation button style.

Declaration
public BackStageNavigationButtonStyles BackStageNavigationButtonStyle { get; set; }
Property Value
Type Description
BackStageNavigationButtonStyles

The default value is BackStageNavigationButtonStyles.Touch.

BackStageView

Gets or sets the BackStageView associated with the MenuButton.

Declaration
public BackStageView BackStageView { get; set; }
Property Value
Type Description
BackStageView

The default value is Null.

BorderStyle

Gets or sets the border style for the control.

Declaration
public virtual ToolStripBorderStyle BorderStyle { get; set; }
Property Value
Type Description
ToolStripBorderStyle

The default value is ToolStripBorderStyle.Etched.

CanApplyTheme

Gets or sets a value indicating whether a SkinManager theme style has been applied to the control.

Declaration
public bool CanApplyTheme { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

CanOverrideStyle

Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

Declaration
public bool CanOverrideStyle { get; set; }
Property Value
Type Description
System.Boolean

Default value is false.
Remarks

By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

CanReduceCaptionLength

Gets or Sets value that enables resizing of form by truncate its caption text fit into the caption bar, if caption length is greater than form's width.

Declaration
public bool CanReduceCaptionLength { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

CaptionAlignment

Gets or sets the alignment of caption.

Declaration
public virtual CaptionAlignment CaptionAlignment { get; set; }
Property Value
Type Description
CaptionAlignment

The default value is CaptionAlignment.Center.

CaptionFont

Gets or sets the caption font.

Declaration
public virtual Font CaptionFont { get; set; }
Property Value
Type Description
System.Drawing.Font

The System.Drawing.Font to apply to the text displayed by the control. The default is the value of the DefaultFont property.

CaptionMinHeight

Gets or sets the minimum height of the caption.

Declaration
public virtual int CaptionMinHeight { get; set; }
Property Value
Type Description
System.Int32

The default value is 0.

CaptionStyle

Gets or sets the caption should be aligned to top or bottom.

Declaration
public virtual CaptionStyle CaptionStyle { get; set; }
Property Value
Type Description
CaptionStyle

The default value is CaptionStyle.Bottom.

CaptionTextStyle

Gets or sets the caption text should be drawn etched, plain or with shadow.

Declaration
public virtual CaptionTextStyle CaptionTextStyle { get; set; }
Property Value
Type Description
CaptionTextStyle

The default value is CaptionTextStyle.Plain.

CloseButton

Gets or sets the customized close button of the Ribbon Form

Declaration
public RibbonTitleButton CloseButton { get; set; }
Property Value
Type
RibbonTitleButton

CollapseBehavior

Determines the Resizing behavior of the ToolStripEx in RibbonControlAdv.

Declaration
public CollapseBehavior CollapseBehavior { get; set; }
Property Value
Type
CollapseBehavior

CollapsePanel

Indicates whether the Minimized RibbonPanel will be shown on mouse hover.

Declaration
public bool CollapsePanel { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

ColorTable

Declaration
protected Office12ColorTable ColorTable { get; }
Property Value
Type
Office12ColorTable

CreateParams

Declaration
protected override CreateParams CreateParams { get; }
Property Value
Type
System.Windows.Forms.CreateParams

CustomRibbonHeaderImage

Gets or Sets the image Layout of QuickPanelImage.

Declaration
public Image CustomRibbonHeaderImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is Null.

DefaultMinimumSize

Gets or sets a value indicating whether RibbonForm has defaultMinimumSize.

Declaration
public bool DefaultMinimumSize { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

DisplayOption

Gets or sets a value indicating whether to show the state of the Ribbon in Auto hide mode, Show tabs or in Normal mode.

Declaration
public RibbonDisplayOption DisplayOption { get; set; }
Property Value
Type Description
RibbonDisplayOption

The default value is RibbonDisplayOption.ShowTabsAndCommands.
Remarks

"This property can be used to change the state of the Ribbon at the startup of application by setting in the Form Load"

DisplayRectangle

Overrides DisplayRectangle property. It helps to gets the rectangle that represents the display area of the control.

Declaration
public override Rectangle DisplayRectangle { get; }
Property Value
Type Description
System.Drawing.Rectangle

A System.Drawing.Rectangle that represents the display area of the control.

Dock

Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent.

Declaration
public DockStyleEx Dock { get; set; }
Property Value
Type Description
DockStyleEx

The default value is DockStyleEx.TopMost

EnableHighContrastTheme

Specifies whether to use default High Contrast theme color or customized color.

Declaration
public bool EnableHighContrastTheme { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

EnableQATCustomization

Gets or Sets a value indicating whether Customize Quick Access Toolbar to be displayed.

Declaration
public bool EnableQATCustomization { get; set; }
Property Value
Type
System.Boolean

EnableRibbonCustomization

Gets or sets a value indicating whether Customize Ribbon needs to be displayed

Declaration
public bool EnableRibbonCustomization { get; set; }
Property Value
Type
System.Boolean

EnableRibbonStateAccelerator

Gets or sets value whether the key tip support to the corresponding Ribbon item to be displayed.

Declaration
public bool EnableRibbonStateAccelerator { get; set; }
Property Value
Type
System.Boolean

EnableSimplifiedLayoutMode

Gets or sets the value that indicates whether the Ribbon will switch between its various LayoutMode values when clicking the ribbon minimize button. In mode, ribbon will arrange its items in single line allowing more screen space.

Declaration
public bool EnableSimplifiedLayoutMode { get; set; }
Property Value
Type Description
System.Boolean

The System.Boolean value that is used to set the EnableSimplifiedLayoutMode. When set to true, you can switch between normal and simplified mode by clicking on the ribbon minimize button. When set to false, you can switch between normal and hidden state. Default value is False.
Examples
RibbonControlAdv myRibbon = new RibbonControlAdv();
myRibbon. EnableSimplifiedLayoutMode = true;

Font

Gets or sets the default font settings of RibbonControlAdv

Declaration
public override Font Font { get; set; }
Property Value
Type Description
System.Drawing.Font

The default font family is "Segoe UI" and the font size is 8.25F

ForeColor

Gets or sets the foreground color of the control.

Declaration
public override Color ForeColor { get; set; }
Property Value
Type Description
System.Drawing.Color

The foreground System.Drawing.Color of the control. The default is the value of the System.Windows.Forms.Control.DefaultForeColor property.

Header

Gets Ribbon header.

Declaration
public IRibbonHeader Header { get; }
Property Value
Type
IRibbonHeader

HideMenuButtonToolTip

Gets or sets value HideMenuButtonToolTip.

Declaration
public bool HideMenuButtonToolTip { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

HideToolTip

Gets or sets the value for HideToolTip.

Declaration
public bool HideToolTip { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

IsFormManager

Gets or Sets whether the form title bar should be removed and replaced with built in RibbonControlAdv system buttons

Declaration
public bool IsFormManager { get; set; }
Property Value
Type Description
System.Boolean

true if form title bar should be visible; otherwise, false.

IsVisualStyleEnabled

Gets a value indicating whether the visual style based theme is applied to the RibbonControlAdv. This also indicates whether the theme files are referred from external assemblies or not.

Declaration
public bool IsVisualStyleEnabled { get; }
Property Value
Type Description
System.Boolean

Return true, if the visual style based theme is applied to RibbonControlAdv. Otherwise returns false.

LauncherStyle

Gets or sets style of the launcher.

Declaration
public LauncherStyle LauncherStyle { get; set; }
Property Value
Type
LauncherStyle

LayoutEngine

Overrides the LayoutEngine property.

Declaration
public override LayoutEngine LayoutEngine { get; }
Property Value
Type
System.Windows.Forms.Layout.LayoutEngine

LayoutMode

Gets or sets the LayoutMode property that indicates whether the Ribbon is in normal or simplified mode. When set to Simplified the Ribbon items will be arranged in a single line allowing more screen space.

Declaration
public RibbonLayoutMode LayoutMode { get; set; }
Property Value
Type Description
RibbonLayoutMode

The RibbonLayoutMode value that specifies whether the item is in Simplified or Normal mode. Default value is Normal and Simplfied.

MaximizeButton

Gets or sets the customized maximize button of the Ribbon Form

Declaration
public RibbonTitleButton MaximizeButton { get; set; }
Property Value
Type
RibbonTitleButton

MaximizeToolTip

Gets or sets MinimizeButton ToolTip.

Declaration
public string MaximizeToolTip { get; set; }
Property Value
Type Description
System.String

The default value is "Maximize Ribbon".

MenuButtonAutoSize

Gets or Sets the size of the menu button based on the size of the text

Declaration
public bool MenuButtonAutoSize { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

MenuButtonDropDown

Gets or sets the ToolStripDropDown to be displayed when menu button is clicked.

Declaration
public ToolStripDropDown MenuButtonDropDown { get; set; }
Property Value
Type
System.Windows.Forms.ToolStripDropDown

MenuButtonDropDownItems

Gets the MenuButton DropDownItems if the Ribbon Header.

Declaration
public ToolStripItemCollection MenuButtonDropDownItems { get; }
Property Value
Type
System.Windows.Forms.ToolStripItemCollection

MenuButtonEnabled

Gets or Sets the Menu button enabled or disabled.

Declaration
public bool MenuButtonEnabled { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

MenuButtonFont

Gets or Sets the font in the menu button.

Declaration
public Font MenuButtonFont { get; set; }
Property Value
Type Description
System.Drawing.Font

The default value is Null.

MenuButtonImage

Gets or Sets the image to be displayed in the menu button.

Declaration
public Image MenuButtonImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is Null.

MenuButtonText

Gets or Sets the image to be displayed in the menu button.

Declaration
public string MenuButtonText { get; set; }
Property Value
Type Description
System.String

The default value is Null.

MenuButtonVisible

Gets or sets visibility of menu button.

Declaration
public bool MenuButtonVisible { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

MenuButtonWidth

Gets or sets width of menu button.

Declaration
public int MenuButtonWidth { get; set; }
Property Value
Type Description
System.Int32

The default value is DEF_MENU_BUTTON_WIDTH (40).

MenuColor

Gets or sets the Menu color.

Declaration
public Color MenuColor { get; set; }
Property Value
Type
System.Drawing.Color

MergeDuplicateTab

Gets or sets a value indicating whether to merge the duplicate tab

Declaration
public bool MergeDuplicateTab { get; set; }
Property Value
Type
System.Boolean

MinimizeButton

Gets or sets the customized minimize button of the Ribbon Form

Declaration
public RibbonTitleButton MinimizeButton { get; set; }
Property Value
Type
RibbonTitleButton

MinimizeButtonBounds

Gets or sets the MinimizeButton active area bounds.

Declaration
public Size MinimizeButtonBounds { get; set; }
Property Value
Type Description
System.Drawing.Size

The default width and heights are 30, 20.

MinimizePanel

Gets or sets panel's minimized status

Declaration
public bool MinimizePanel { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

MinimizeToolTip

Gets or sets MinimizeButton ToolTip.

Declaration
public string MinimizeToolTip { get; set; }
Property Value
Type Description
System.String

The default value is "Minimize Ribbon".

MinimumSize

Gets or sets the size that is the lower limit that System.Windows.Forms.Control.GetPreferredSize(System.Drawing.Size) can specify. Overrides MinimumSize property.

Declaration
public override Size MinimumSize { get; set; }
Property Value
Type Description
System.Drawing.Size

An ordered pair of type System.Drawing.Size representing the width and height of a rectangle.

MouseWheelSupport

Indicates whether user can scroll TabItems by mouse wheel.

Declaration
public bool MouseWheelSupport { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

OccupiedHeight

Occupied control height. Occupied height is the control height with or without height of RibbonPanel, it depends on MinimizePanel property.

Declaration
[Obsolete("Use Height property instead")]
public int OccupiedHeight { get; }
Property Value
Type
System.Int32

Office2013ColorScheme

Gets/Sets the Office2013ColorScheme

Declaration
public Office2013ColorScheme Office2013ColorScheme { get; set; }
Property Value
Type Description
Office2013ColorScheme

The default value is Office2013ColorScheme.White.

Office2013ColorTable

Gets / sets the value of Office2013ColorTable

Declaration
public Office2013ColorTable Office2013ColorTable { get; set; }
Property Value
Type Description
Office2013ColorTable

The default value is Null.
Remarks

"This property is applicable when RibbonStyle is set as Office2013"

Office2016ColorScheme

Gets/Sets the Office2016ColorScheme

Declaration
public Office2016ColorScheme Office2016ColorScheme { get; set; }
Property Value
Type Description
Office2016ColorScheme

The default value is Office2016ColorScheme.White.

Office2016ColorTable

Gets or sets the value for the ColorTable of Office2016 style RibbonControlAdv.

Declaration
public BindingList<Office2016ColorTable> Office2016ColorTable { get; }
Property Value
Type Description
System.ComponentModel.BindingList<Office2016ColorTable>

The default value is Null.

OfficeColorScheme

Gets or sets whether the Office color scheme should be Silver or Blue.

Declaration
public virtual ToolStripEx.ColorScheme OfficeColorScheme { get; set; }
Property Value
Type Description
ToolStripEx.ColorScheme

The default value is ToolStripEx.ColorScheme.Default.

OfficeMenu

Gets the MenuDropDown to be displayed when menu button is clicked.

Declaration
public MenuDropDown OfficeMenu { get; }
Property Value
Type
MenuDropDown

OfficeStyle2013ColorTable

Declaration
public BindingList<Office2013ColorTable> OfficeStyle2013ColorTable { get; }
Property Value
Type
System.ComponentModel.BindingList<Office2013ColorTable>

OverFlowButtonToolTip

Gets or sets OverFlowButton ToolTip.

Declaration
public string OverFlowButtonToolTip { get; set; }
Property Value
Type Description
System.String

The default value is "Show DropDown".

QuickDropDownToolTipText

Gets or sets QuickDropDown ToolTip Text.

Declaration
public string QuickDropDownToolTipText { get; set; }
Property Value
Type Description
System.String

The default value is "Customize Quick Access Toolbar".

QuickPanelAlignment

Specifies where QuickItemsDropDownButton need to be shown,applicable only for Touch style.

Declaration
public QuickPanelAlignment QuickPanelAlignment { get; set; }
Property Value
Type Description
QuickPanelAlignment

The default value is QuickPanelAlignment.Left.

QuickPanelImage

Gets or Sets the image to be displayed in the menu button.

Declaration
public Image QuickPanelImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is Null.

QuickPanelImageLayout

Gets or Sets the image Layout of QuickPanelImage.

Declaration
public PictureBoxSizeMode QuickPanelImageLayout { get; set; }
Property Value
Type Description
System.Windows.Forms.PictureBoxSizeMode

The default value is Null.

QuickPanelVisible

Gets or sets visibility of quick panel.

Declaration
public bool QuickPanelVisible { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

RestoreButton

Gets or sets the customized restore button of the Ribbon Form

Declaration
public RibbonTitleButton RestoreButton { get; set; }
Property Value
Type
RibbonTitleButton

RibbonDisplayOptionToolTip

Gets or sets value RibbonDisplayOptionToolTip.

Declaration
public string RibbonDisplayOptionToolTip { get; set; }
Property Value
Type Description
System.String

The default value is "Ribbon Display Option".

RibbonHeaderImage

Gets or sets the image of the ribbon.

Declaration
public RibbonHeaderImage RibbonHeaderImage { get; set; }
Property Value
Type Description
RibbonHeaderImage

The default value is RibbonHeaderImage.Birds

RibbonStyle

Gets or sets the style of the ribbon.

Declaration
public RibbonStyle RibbonStyle { get; set; }
Property Value
Type Description
RibbonStyle

The default value is RibbonStyle.Office2007.

RibbonTitleButtonSize

Gets or sets the size of the custom button.

Declaration
public Size RibbonTitleButtonSize { get; set; }
Property Value
Type
System.Drawing.Size

RibbonTouchModeEnabled

Gets or sets value RibbonTouchModeEnabled.

Declaration
public bool RibbonTouchModeEnabled { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

RibbonTouchStyleColorTable

Gets or sets the value for the ColorTable to the Touchstyle of ribbon.

Declaration
public BindingList<TouchStyleColorTable> RibbonTouchStyleColorTable { get; }
Property Value
Type
System.ComponentModel.BindingList<TouchStyleColorTable>

RightToLeft

Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts. Overrides.

Declaration
public override RightToLeft RightToLeft { get; set; }
Property Value
Type Description
System.Windows.Forms.RightToLeft

One of the System.Windows.Forms.RightToLeft values. The default is System.Windows.Forms.RightToLeft.Inherit.

ScaleMenuButtonImage

Gets or sets a value indicating whether menu button image should be scaled.

Declaration
public bool ScaleMenuButtonImage { get; set; }
Property Value
Type Description
System.Boolean

true if menu button image should be scaled; otherwise, false. The default value is true.
Remarks

This property should be set for images whose size is less than Menu Button size.

SelectedTab

Gets or sets the selected ToolStripTabItem in the RibbonControlAdv.

Declaration
public ToolStripTabItem SelectedTab { get; set; }
Property Value
Type
ToolStripTabItem

Show2010CustomizeQuickItemDialog

Gets or Sets the value for Showing 2010 Quick Items Dialog

Declaration
public bool Show2010CustomizeQuickItemDialog { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

ShowCaption

Gets or sets whether caption should be shown.

Declaration
public virtual bool ShowCaption { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

ShowContextMenu

Gets or sets value indicating whether should show the context menu in Ribbon header.

Declaration
public bool ShowContextMenu { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

ShowLauncher

Gets or sets a value indicating whether the launcher buttons are visible.

Declaration
public virtual bool ShowLauncher { get; set; }
Property Value
Type Description
System.Boolean

true, if Launcher buttons are visible, false otherwise. The default value is true.

ShowMinimizeButton

Gets or sets the visibility of MinimizeButton of the RibbonPanel.

Declaration
public bool ShowMinimizeButton { get; set; }
Property Value
Type
System.Boolean

ShowPanel

Gets or sets whether the panel should be shown for the ToolStripTabItem.

Declaration
public bool ShowPanel { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

ShowPanelOnMouseHover

Indicates whether the Minimized RibbonPanel will be shown on mouse hover.

Declaration
public bool ShowPanelOnMouseHover { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

ShowQuickItemsDropDownButton

Specifies whether QuickItemsDropDownButton need to be shown.

Declaration
public bool ShowQuickItemsDropDownButton { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

ShowQuickPanelBelowRibbon

Gets or sets value indicating whether quick access toolbar should be shown below ribbon.

Declaration
public bool ShowQuickPanelBelowRibbon { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

ShowRibbonDisplayOptionButton

Gets or sets the visibility of RibbonDisplayOptionButton of the RibbonControlAdv

Declaration
public bool ShowRibbonDisplayOptionButton { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

SortTabItems

Gets or sets a value indicating whether ToolStripTabItems need to be sorted.

Declaration
public bool SortTabItems { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

SuperAccelerator

Gets/ Sets the SuperAccelerator.

Declaration
public SuperAccelerator SuperAccelerator { get; set; }
Property Value
Type Description
SuperAccelerator

The default value is Null.

SystemText

Specifies the text for the items in the Quick Access Toolbar Editor.

Declaration
public RibbonSystemText SystemText { get; }
Property Value
Type
RibbonSystemText

TabGroups

Gets collection of tab groups.

Declaration
public TabGroupCollection TabGroups { get; }
Property Value
Type
TabGroupCollection

TabStop

Gets / Sets the TabStop property needs to enabled or disabled.

Declaration
public bool TabStop { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

ThemeName

Gets or sets the theme name of the RibbonControlAdv control.

Declaration
public string ThemeName { get; set; }
Property Value
Type
System.String

ThemeStyle

Declaration
public RibbonControlAdvVisualStyle ThemeStyle { get; set; }
Property Value
Type
RibbonControlAdvVisualStyle

TitleAlignment

Gets or sets the form title alignment in RibbonControlAdv header.

Declaration
public TextAlignment TitleAlignment { get; set; }
Property Value
Type Description
TextAlignment

The default value is TextAlignment.Center.

TitleColor

Specifies the color of the TittleText in the RibbonControlAdv header.

Declaration
public Color TitleColor { get; set; }
Property Value
Type Description
System.Drawing.Color

The default value is SystemColors.ActiveCaptionText.

TitleFont

Gets or sets the font settings of the title.

Declaration
public Font TitleFont { get; set; }
Property Value
Type
System.Drawing.Font

TouchMode

Gets or sets value for TouchMode.

Declaration
public bool TouchMode { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

UpdateUIOnAppIdle

Indicates whether the UpdateUI event should be fired in the next application idle event.

Declaration
public bool UpdateUIOnAppIdle { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.

UseDefaultHighlightColor

Gets or Sets whether default highlight color should be used

Declaration
public bool UseDefaultHighlightColor { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

UseTouchStyleArrowColor

Gets or sets whether the MenuButton is customized by using MenuButtonArrowColor/MenuButtonHoverArrowColor property of the TouchStyleColorTable in BackStageView.

Declaration
public bool UseTouchStyleArrowColor { get; set; }
Property Value
Type Description
System.Boolean

The default value is false.
Remarks

This property is only applicable when using RibbonStyle as TouchStyle

Methods

ApplyTouchStyleColorTable(TouchStyleColorTable)

Apply the TouchStyleColorTable for RibbonControlAdv.

Declaration
public void ApplyTouchStyleColorTable(TouchStyleColorTable TouchStyleColorTable)
Parameters
Type Name Description
TouchStyleColorTable TouchStyleColorTable

ApplyTouchStyleColorTable(TouchStyleColorTable, ToolStripExSplitterStyle)

Apply the TouchStyleColorTable for RibbonControlAdv with Splitter style

Declaration
public void ApplyTouchStyleColorTable(TouchStyleColorTable TouchStyleColorTable, ToolStripExSplitterStyle splitter)
Parameters
Type Name Description
TouchStyleColorTable TouchStyleColorTable

color table
ToolStripExSplitterStyle splitter

ToolStripSplitter style

BeginInit()

Performs starting of RibbonControl initialization.

Declaration
public void BeginInit()

CanExtend(Object)

Gets a value indicating whether a control can be extended.

Declaration
public bool CanExtend(object extendee)
Parameters
Type Name Description
System.Object extendee

The control which need to be extended.
Returns
Type
System.Boolean

CreateAccessibilityInstance()

Provided accessibility to the control.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type
System.Windows.Forms.AccessibleObject

Dispose(Boolean)

Releases the unmanaged resources used by the System.Windows.Forms.Control and its child controls and optionally releases the managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

EndInit()

Performs completing of RibbonControl initialization.

Declaration
public void EndInit()

FireQATCustomizationMenuClicked(Control.ControlCollection)

This Event will be triggered when Customize QAT is selected from ContextMenu

Declaration
public bool FireQATCustomizationMenuClicked(Control.ControlCollection controls)
Parameters
Type Name Description
System.Windows.Forms.Control.ControlCollection controls

The argument contains the collection of the control objects.
Returns
Type
System.Boolean

FireRibbonCustomizationMenuClicked(Control.ControlCollection)

This Event will be triggered when Customize Ribbon is selected from ContextMenu

Declaration
public bool FireRibbonCustomizationMenuClicked(Control.ControlCollection controls)
Parameters
Type Name Description
System.Windows.Forms.Control.ControlCollection controls

The argument contains the collection of the control objects.
Returns
Type
System.Boolean

GetActiveThemeName()

Declaration
public string GetActiveThemeName()
Returns
Type
System.String

GetDescription(Component)

Gets or sets text displayed with component in quick panel customizing dialog.

Declaration
public string GetDescription(Component component)
Parameters
Type Name Description
System.ComponentModel.Component component

The components displayed in Quick panel.
Returns
Type
System.String

GetDisplayMode(Component)

Gets the RibbonItemDisplayMode value from the ribbon item which is added in the RibbonControlAdv.

Declaration
public RibbonItemDisplayMode GetDisplayMode(Component component)
Parameters
Type Name Description
System.ComponentModel.Component component

The component which used to get the RibbonItemDisplayMode value.
Returns
Type Description
RibbonItemDisplayMode

The RibbonItemDisplayMode value based on the component.

GetPreferredSize(Size)

Retrieves the size of a rectangular area into which a control can be fitted.

Declaration
public override Size GetPreferredSize(Size proposedSize)
Parameters
Type Name Description
System.Drawing.Size proposedSize

The custom-sized area for a control.
Returns
Type Description
System.Drawing.Size

An ordered pair of type System.Drawing.Size representing the width and height of a rectangle.

GetUseInCustomQuickAccessDialog(Component)

Indicates whether component should be available in custom quick access dialog.

Declaration
public bool GetUseInCustomQuickAccessDialog(Component component)
Parameters
Type Name Description
System.ComponentModel.Component component

The components displayed in Quick panel.
Returns
Type
System.Boolean

GetUseInQuickAccessMenu(Component)

Indicates whether component should be available in quick access menu.

Declaration
public bool GetUseInQuickAccessMenu(Component component)
Parameters
Type Name Description
System.ComponentModel.Component component

The components displayed in Quick panel.
Returns
Type
System.Boolean

LoadState()

Reads the persisted state information from the Isolated Storage.

Declaration
public void LoadState()

LoadState(AppStateSerializer)

Reads the persisted state information from the specified AppStateSerializer.

Declaration
public void LoadState(AppStateSerializer serializer)
Parameters
Type Name Description
AppStateSerializer serializer

Provides a mechanism for coordinating the serialization behavior of multiple components.

LoadState(AppStateSerializer, RibbonControlAdv.DeserializationOptions)

Reads the persisted state information based on the specified Stream with RibbonControlAdv.DeserializationOptions from the specified AppStateSerializer.

Declaration
public void LoadState(AppStateSerializer serializer, RibbonControlAdv.DeserializationOptions options)
Parameters
Type Name Description
AppStateSerializer serializer

Provides a mechanism for coordinating the serialization behavior of multiple components.
RibbonControlAdv.DeserializationOptions options

Decides the type of operations to be deserialized.

OnAllowCollapseChanged()

Declaration
protected virtual void OnAllowCollapseChanged()

OnControlAdded(ControlEventArgs)

Raises the System.Windows.Forms.Control.ControlAdded event.

Declaration
protected override void OnControlAdded(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

A System.Windows.Forms.ControlEventArgs that contains the event data.

OnControlRemoved(ControlEventArgs)

Raises the System.Windows.Forms.Control.ControlRemoved event.

Declaration
protected override void OnControlRemoved(ControlEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.ControlEventArgs e

A System.Windows.Forms.ControlEventArgs that contains the event data.

OnHandleCreated(EventArgs)

Declaration
protected override void OnHandleCreated(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnHandleDestroyed(EventArgs)

Declaration
protected override void OnHandleDestroyed(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnLocationChanged(EventArgs)

Declaration
protected override void OnLocationChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnMinimizePanelChanged()

Declaration
protected virtual void OnMinimizePanelChanged()

OnPaddingChanged(EventArgs)

Declaration
protected override void OnPaddingChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnPaint(PaintEventArgs)

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

OnParentChanged(EventArgs)

Declaration
protected override void OnParentChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnParentFontChanged(EventArgs)

Declaration
protected override void OnParentFontChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnResize(EventArgs)

Declaration
protected override void OnResize(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnShowPanelChanged()

Declaration
protected virtual void OnShowPanelChanged()

OnSizeChanged(EventArgs)

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnVisiblePanelChanged()

Declaration
protected virtual void OnVisiblePanelChanged()

PerformUpdateUI()

Forces the RibbonControlAdv to fire an UpdateUI event.

Declaration
public void PerformUpdateUI()

ResetBackStageNavigationButtonEnabled()

Resets the BackStageNavigationButtonEnabled property to it's default value.

Declaration
public void ResetBackStageNavigationButtonEnabled()

ResetCollapsePanel()

To Reset CollapsePanel

Declaration
public void ResetCollapsePanel()

ResetFont()

Resets the RibbonControlAdv default font.

Declaration
public void ResetFont()

ResetMenuButtonAutoSize()

To reset MenuButtonAutoSize

Declaration
public void ResetMenuButtonAutoSize()

ResetSuperAccelerator()

To Reset SuperAccelerator

Declaration
public void ResetSuperAccelerator()

ResetUseTouchStyleArrowColor()

Resets the UseTouchStyleArrowColor property to it's default value.

Declaration
public void ResetUseTouchStyleArrowColor()

SaveState()

Saves the current state information to Isolated Storage.

Declaration
public void SaveState()

SaveState(AppStateSerializer)

Saves the current state information to the specified AppStateSerializer.

Declaration
public void SaveState(AppStateSerializer serializer)
Parameters
Type Name Description
AppStateSerializer serializer

Provides a mechanism for coordinating the serialization behavior of multiple components.

SaveState(AppStateSerializer, RibbonControlAdv.SerializationOptions)

Saves the current state information based on the specified Stream with RibbonControlAdv.SerializationOptions from the specified AppStateSerializer.

Declaration
public void SaveState(AppStateSerializer serializer, RibbonControlAdv.SerializationOptions options)
Parameters
Type Name Description
AppStateSerializer serializer

Provides a mechanism for coordinating the serialization behavior of multiple components.
RibbonControlAdv.SerializationOptions options

Decides the type of operations to be serialized.

SetBackColorForCustomizedQATButtons(Color)

Sets the BackColor for QATDialogBoxButtons

Declaration
public void SetBackColorForCustomizedQATButtons(Color QATDialogBoxButtonsForeColor)
Parameters
Type Name Description
System.Drawing.Color QATDialogBoxButtonsForeColor

SetDescription(Component, String)

Gets or sets text displayed with component in quick panel customizing dialog.

Declaration
public void SetDescription(Component component, string value)
Parameters
Type Name Description
System.ComponentModel.Component component

The components displayed in Quick panel.
System.String value

The value of the component.

SetDisplayMode(Component, RibbonItemDisplayMode)

Sets the RibbonItemDisplayMode value for the items added in the RibbonControlAdv.

Declaration
public void SetDisplayMode(Component component, RibbonItemDisplayMode displayMode)
Parameters
Type Name Description
System.ComponentModel.Component component

The component which RibbonItemDisplayMode will be set.
RibbonItemDisplayMode displayMode

The RibbonItemDisplayMode value.

SetRibbon2013OptionValues(ControlItems, String, String, Font, Font)

Specifies the SetRibbon2013OptionValues.

Declaration
public void SetRibbon2013OptionValues(ControlItems ControlItem, string ItemHeaderText, string ItemMainText, Font ItemHeaderFont, Font ItemMainFont)
Parameters
Type Name Description
ControlItems ControlItem

The ControlItems value that contains the event data.
System.String ItemHeaderText

The item header text
System.String ItemMainText

The main item text.
System.Drawing.Font ItemHeaderFont

The item header font.
System.Drawing.Font ItemMainFont

The main item font.

SetUseInCustomQuickAccessDialog(Component, Boolean)

Indicates whether component should be available in Custom quick access dialog.

Declaration
public void SetUseInCustomQuickAccessDialog(Component component, bool value)
Parameters
Type Name Description
System.ComponentModel.Component component

The components displayed in Quick panel.
System.Boolean value

The indicates whether the component is need to be displayed in quick panel.

SetUseInQuickAccessMenu(Component, Boolean)

Indicates whether component should be available in quick access menu.

Declaration
public void SetUseInQuickAccessMenu(Component component, bool value)
Parameters
Type Name Description
System.ComponentModel.Component component

The components displayed in Quick panel.
System.Boolean value

The indicates whether the component is need to be displayed in quick panel.

ShouldSerializeBackStageNavigationButtonEnabled()

Indicates whether the current value of the BackStageNavigationButtonEnabled property is to be serialized.

Declaration
public bool ShouldSerializeBackStageNavigationButtonEnabled()
Returns
Type
System.Boolean

ShouldSerializeCollapsePanel()

Indicates whether the current value of the CollapsePanel property is to be serialized.

Declaration
public bool ShouldSerializeCollapsePanel()
Returns
Type
System.Boolean

ShouldSerializeDisplayMode(Component)

Indicates whether the current value of the DisplayMode property is to be serialized.

Declaration
public bool ShouldSerializeDisplayMode(Component component)
Parameters
Type Name Description
System.ComponentModel.Component component
Returns
Type
System.Boolean

ShouldSerializeEnableSimplifiedLayoutMode()

Indicates whether the current value of the EnableSimplifiedLayoutMode property is to be serialized.

Declaration
public bool ShouldSerializeEnableSimplifiedLayoutMode()
Returns
Type
System.Boolean

ShouldSerializeFont()

Indicates whether the current value of the RibbonControlAdv's Font property is to be serialized.

Declaration
public bool ShouldSerializeFont()
Returns
Type
System.Boolean

ShouldSerializeLayoutMode()

Indicates whether the current value of the LayoutMode property is to be serialized.

Declaration
public bool ShouldSerializeLayoutMode()
Returns
Type
System.Boolean

ShouldSerializeMenuButtonAutoSize()

To Specify MenuButtonAutoSize to be serialized or not

Declaration
public bool ShouldSerializeMenuButtonAutoSize()
Returns
Type
System.Boolean

ShouldSerializeSuperAccelerator()

To Indicate whether to serialize SuperAccelerator

Declaration
public bool ShouldSerializeSuperAccelerator()
Returns
Type
System.Boolean

ShouldSerializeUseTouchStyleArrowColor()

Indicates whether the current value of the UseTouchStyleArrowColor property is to be serialized.

Declaration
public bool ShouldSerializeUseTouchStyleArrowColor()
Returns
Type
System.Boolean

ShowCustomizeDialog()

Shows QickItems customizing dialog.

Declaration
public void ShowCustomizeDialog()

ShowCustomizeRibbonDialog()

Shows the Customize Ribbon item dialog box.

Declaration
public void ShowCustomizeRibbonDialog()

WndProc(ref Message)

Processes Windows messages.

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m

The Windows System.Windows.Forms.Message to process.

Events

AfterCustomizeDropDownPopup

Occurs after the DropDown of QuickItemsDropDownButton is shown.

Declaration
public event EventHandler AfterCustomizeDropDownPopup
Event Type
Type
System.EventHandler

BeforeContextMenuOpen

Occurs when right clicked on the Ribbon control and before context menu opens

Declaration
public event RibbonControlAdv.OnRightClick BeforeContextMenuOpen
Event Type
Type
RibbonControlAdv.OnRightClick

BeforeCustomizeDropDownPopup

Occurs before the DropDown of QuickItemsDropDownButton is shown.

Declaration
public event DropDownEventHandler BeforeCustomizeDropDownPopup
Event Type
Type
DropDownEventHandler

Click

Hiding Click event

Declaration
public event EventHandler Click
Event Type
Type
System.EventHandler

ColorSchemeChanged

Occurs when ColorScheme is changed.

Declaration
public event ColorSchemeChanged ColorSchemeChanged
Event Type
Type
ColorSchemeChanged

DisplayOptionChanged

Occurs when the DisplayOption is changed in the RibbonControlAdv.

Declaration
public event EventHandler<DisplayOptionChangedEventArgs> DisplayOptionChanged
Event Type
Type
System.EventHandler<DisplayOptionChangedEventArgs>
Remarks

The DisplayOptionChanged event occurs only when the end user selects the DisplayOption from the display option popup.

KeyDown

Occurs when a key is pressed while the control has focus.

Declaration
public event KeyEventHandler KeyDown
Event Type
Type
System.Windows.Forms.KeyEventHandler

KeyPress

Occurs when a key is pressed while the control has focus.

Declaration
public event KeyPressEventHandler KeyPress
Event Type
Type
System.Windows.Forms.KeyPressEventHandler

KeyUp

Occurs when a key is released while the control has focus.

Declaration
public event KeyEventHandler KeyUp
Event Type
Type
System.Windows.Forms.KeyEventHandler

MenuButtonClick

Occurs when the user clicks the Menu button.

Declaration
public event EventHandler MenuButtonClick
Event Type
Type
System.EventHandler

MenuButtonDoubleClick

Occurs when the user double-clicks the Menu button.

Declaration
public event EventHandler MenuButtonDoubleClick
Event Type
Type
System.EventHandler

MenuButtonHover

Occurs when the mouse pointer hovers over the Menu button.

Declaration
public event EventHandler MenuButtonHover
Event Type
Type
System.EventHandler

MenuColorChanged

Occurs when MenuColor is changed.

Declaration
public event MenuColorChanged MenuColorChanged
Event Type
Type
MenuColorChanged

MouseCaptureChanged

Occurs when the Mouse capture changed on the RibbonControlAdv.

Declaration
public event EventHandler MouseCaptureChanged
Event Type
Type
System.EventHandler

MouseClick

Hiding MouseClick event

Declaration
public event MouseEventHandler MouseClick
Event Type
Type
System.Windows.Forms.MouseEventHandler

MouseDoubleClick

Occurs when the user double clicks the RibbonControlAdv.

Declaration
public event MouseEventHandler MouseDoubleClick
Event Type
Type
System.Windows.Forms.MouseEventHandler

MouseDown

Occurs when the Mouse down on the RibbonControlAdv.

Declaration
public event MouseEventHandler MouseDown
Event Type
Type
System.Windows.Forms.MouseEventHandler

MouseEnter

Occurs when the Mouse enter on the RibbonControlAdv.

Declaration
public event EventHandler MouseEnter
Event Type
Type
System.EventHandler

MouseHover

Occurs when the Mouse hover on the RibbonControlAdv.

Declaration
public event EventHandler MouseHover
Event Type
Type
System.EventHandler

MouseLeave

Occurs when the Mouse leave on the RibbonControlAdv.

Declaration
public event EventHandler MouseLeave
Event Type
Type
System.EventHandler

MouseMove

Occurs when the Mouse move on the RibbonControlAdv.

Declaration
public event MouseEventHandler MouseMove
Event Type
Type
System.Windows.Forms.MouseEventHandler

MouseUp

Occurs when the Mouse up on the RibbonControlAdv.

Declaration
public event MouseEventHandler MouseUp
Event Type
Type
System.Windows.Forms.MouseEventHandler

MouseWheel

Occurs when the Mouse wheel on the RibbonControlAdv.

Declaration
public event MouseEventHandler MouseWheel
Event Type
Type
System.Windows.Forms.MouseEventHandler

PanelStateChanged

Occurs when MinimizePanel has changed.

Declaration
public event EventHandler PanelStateChanged
Event Type
Type
System.EventHandler

QATCustomizationMenuClicked

This Event will be triggered when Customize QAT is selected from ContextMenu

Declaration
public event BeforeQATHandler QATCustomizationMenuClicked
Event Type
Type
BeforeQATHandler

RibbonCustomizationMenuClicked

This Event will be triggered when Customize Ribbon is selected from ContextMenu

Declaration
public event BeforeCustomizeRibbonHandler RibbonCustomizationMenuClicked
Event Type
Type
BeforeCustomizeRibbonHandler

RibbonStyleChanged

Occurs when RibbonStyle is changed.

Declaration
public event RibbonStyleChanged RibbonStyleChanged
Event Type
Type
RibbonStyleChanged

SelectedTabItemChanged

Occurs when selected(checked) ToolStripTabItem has changed.

Declaration
public event SelectedTabChangedEventHandler SelectedTabItemChanged
Event Type
Type
SelectedTabChangedEventHandler

ThemeNameChanged

Occurs when theme name of the RibbonControlAdv has changed.

Declaration
public event ThemeChangedEventHandler ThemeNameChanged
Event Type
Type
ThemeChangedEventHandler

UpdateUI

Occurs if either the UpdateUIOnAppIdle is on.

Declaration
public event EventHandler UpdateUI
Event Type
Type
System.EventHandler

Explicit Interface Implementations

IVisualStyle.VisualTheme

Declaration
string IVisualStyle.VisualTheme { get; set; }
Returns
Type
System.String

IThemeProvider.BaseThemeName

Gets or sets the BaseTheme name of the theme

Declaration
string IThemeProvider.BaseThemeName { get; set; }
Returns
Type
System.String

IThemeProvider.ControlName

Gets the name of the control.

Declaration
string IThemeProvider.ControlName { get; }
Returns
Type
System.String

Implements

System.ComponentModel.IExtenderProvider
System.ComponentModel.ISupportInitialize
System.Windows.Forms.IMessageFilter