C1.Win.Ribbon.C1Ribbon

C1Ribbon Class

The Ribbon control.

Inheritance

object

C1Ribbon

Implements

ISupportInitialize

IExtenderProvider

ISupportUia

ISupportUiaContainer

Namespace: C1.Win.Ribbon

Assembly: C1.Win.Ribbon.4.8.dll

Syntax

[ToolboxBitmap(typeof(C1Ribbon), "C1Ribbon.png")]
[C1Description("C1Ribbon", "Organizes related commands into tabs and groups.")]
[ClassInterface(ClassInterfaceType.AutoDispatch)]
[ComVisible(true)]
public class C1Ribbon : XView, ISupportInitialize, IExtenderProvider, ISupportUia, ISupportUiaContainer

Remarks

The Ribbon control serves as a replacement for the traditional menus and toolbars model and organizes related commands into tabs and groups so that the commands are easier to find.

Constructors

Name	Description
C1Ribbon()	Creates a new instance of C1Ribbon. The C1Ribbon is automatically docked at the top of the parent container.

Properties

Name	Description
AllowContextMenu	Gets or sets whether the special context menu should appear when a user clicks the Ribbon with the right mouse button.
AllowMinimize	Gets or sets whether the Ribbon can be minimized.
AllowSimplifiedView	Gets or sets whether the Ribbon can be simplified.
AltKeyPressDelay	Gets or sets the delay (in milliseconds) after pressing the Alt key before displaying KeyTips.
Anchor	This property has no effect on C1Ribbon.
ApplicationMenu	Gets the object that represents the Application menu at the top-left corner of the Ribbon and allows to control the button's appearance.
AutoSize	This property has no effect on C1Ribbon.
BackstageView	Gets or sets the instance of the attached C1BackstageView to this control.
BottomToolBar	Gets the object that represents a toolbar that appears below the Ribbon.
CaptionAlignment	Gets or sets how the form caption is horizontally aligned.
CaptureAltKeyInTerminalSession	Gets or sets whether the Alt key can be used for displaying KeyTips in terminal server session.
CaptureF10Key	Gets or sets whether the F10 key can be used for displaying KeyTips.
ChildCaptionInSquareBrackets	Gets or sets a value indicating if the title of a maximized MDI child window should appear in square brackets after the main Form's title.
ConfigToolBar	Gets the object that represents the toolbar in the same line with the tab headers.
ContextMenuItems	Gets the collection of menu items displayed with the ShowContextMenu method.
ContextualTabGroups	Gets the collection of contextual tab groups.
Cursor	This property has no effect on C1Ribbon.
Dock	This property has no effect on C1Ribbon.
HeaderWatermark	Gets or sets an image displayed as the header watermark.
HideAppMenuWithTHR	Enables the compatibility mode when the AppMenu button does not appear while the tab header row is invisible.
HideTabHeaderRow	Gets or sets whether the tab header row (including the application menu and config toolbar) is hidden.
KeyTipsVisible	Gets a value indicating whether the KeyTips are visible.
LargeImageList	Gets or sets the ImageList that contains the large images to display on the Ribbon.
Location	Gets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
MaximumSize	This property has no effect on C1Ribbon.
MediumImageList	Gets or sets the ImageList that contains the medium images to display on the Ribbon.
Minimized	Gets or sets whether the Ribbon is in minimized state.
MinimumHeight	Gets or sets the minimum height of Ribbon's parent container.
MinimumSize	This property has no effect on C1Ribbon.
MinimumWidth	Gets or sets the minimum width of Ribbon's parent container.
MoreButton	Gets the properties of the more button from simplified view of ribbon.
NoSysKeyUp	Gets or sets whether the ribbon shouldn't wait for the WM_SYSKEYUP message when showing KeyTips.
Padding	This property has no effect on C1Ribbon.
Qat	Gets the object that represents the Quick Access Toolbar (QAT).
QatItemNames	Gets or sets the string that specifies the list of item names on the QAT. It allows to preserve QAT items added by the user at runtime.
RestrictedGroupSizing	Gets or sets whether the RibbonGroup sizing is limited to the Maximized and Collapsed states.
RibbonStyle	Gets or sets a RibbonStyle object that is used for customization of appearance settings.
Selectable	Gets or sets whether the Ribbon can receive the input focus.
SelectedTab	Gets or sets the selected tab.
SelectedTabIndex	Gets or sets the selected tab index.
ShowContextualGroupsHeaders	Gets or sets a value indicating whether the headers of contextual groups are displayed.
Size	Gets the height and width of the control.
SmallImageList	Gets or sets the ImageList that contains the small images to display on the Ribbon.
SupportDpiAwareness	Gets or sets the dpi awareness support mode.
SupportsKeyTips	Gets or sets whether the Ribbon can show KeyTips.
TabPopupWidth	Gets or sets the maximum width of the tab popup window when the Ribbon is minimized. If -1, the popup window is stretched to the whole width of the owner window.
Tabs	Gets the tabs collection of this C1Ribbon.
TextRenderingHint	Gets or sets the TextRenderingHint that controls text rendering quality.
ToolTipSettings	Gets or sets the properties of the built-in tooltip.
TopToolBar	Gets the object that represents a toolbar at the window title bar, beside the system buttons.
ViewMode	Gets or sets the view mode of C1Ribbon.
Visible	Gets or sets a value indicating whether the control and all its parent controls are displayed.

Methods

Name	Description
BeginInit()
BeginUpdate()	Maintains performance while items are being added or removed from the C1Ribbon.
CloseAllPopups()	Closes all popup windows, such as menus, collapsed groups and tabs.
CreateHandle()	Creates the handle for the C1Ribbon control.
Dispose(bool)	Clean up any resources being used.
EndInit()
EndUpdate()	Resumes processing after it has been suspended by a call to BeginUpdate().
GetHostRibbonItem(Control)	Returns the RibbonItem that contains the specified control.
GetItemAt(Point)	Returns the item located at the specified point in the client area of the C1Ribbon.
GetItemAt(int, int)	Returns the item located at the specified x- and y-coordinates of the C1Ribbon client area.
GetItemBounds(Component)	Returns the size and location of the given item, in pixels, relative to the parent C1Ribbon.
GetItemByName(string)	Searches for the RibbonTab, RibbonGroup, or RibbonItem with the specified name through the whole C1Ribbon.
GetItemImage(RibbonItem)	Gets an image rendered from the actual icon of the ribbon component.
GetPresetImage(string, int)	Returns a bitmap image from build-in C1Ribbon presets for the current theme lightness.
GetPresetImage(string, int, bool)	Returns a bitmap image from build-in C1Ribbon presets.
IsMouseInsideXView()	Returns True if the mouse pointer is inside the C1Ribbon control.
Load(Stream)	Loads a Ribbon definition from a Stream.
Load(string)	Loads a Ribbon definition from an XML file.
Load(XmlDocument)	Loads a Ribbon definition from an XmlDocument.
OnContextMenuCollapse(EventArgs)	Raises the ContextMenuCollapse event.
OnContextMenuPopup(ContextMenuPopupEventArgs)	Raises the ContextMenuPopup event.
OnControlHostFromXmlNode(ControlHostFromXmlNodeEventArgs)	Raises the ControlHostFromXmlNode event.
OnEnabledChanged(EventArgs)	Raises the EnabledChanged event.
OnFontChanged(EventArgs)	Raises the FontChanged event.
OnGroupDeserialized(GroupDeserializedEventArgs)	Raises the GroupDeserialized event.
OnInvalidated(InvalidateEventArgs)	Raises the Invalidated event.
OnItemDeserialized(ItemDeserializedEventArgs)	Raises the ItemDeserialized event.
OnLeave(EventArgs)	Raises the Leave event.
OnMinimizedChanged(EventArgs)	Raises the MinimizedChanged event.
OnMouseUp(MouseEventArgs)	Raises the MouseUp event.
OnMouseWheel(MouseEventArgs)	Raises the MouseWheel event.
OnPaint(PaintEventArgs)	Paints the control. Raises the Paint event.
OnPaintBackground(PaintEventArgs)	Paints the background of the control.
OnParentChanged(EventArgs)	Raises the ParentChanged event and performs additional handling.
OnPopupToolTip(ToolTipPositionEventArgs)	Raises the PopupToolTip event.
OnRibbonDeserialized(EventArgs)	Raises the RibbonDeserialized event.
OnRibbonEvent(RibbonEventArgs)	Raises the RibbonEvent event.
OnRightToLeftChanged(EventArgs)	Raises the RightToLeftChanged event.
OnSelectedTabChanged(EventArgs)	Raises the SelectedTabChanged event.
OnTabDeserialized(TabDeserializedEventArgs)	Raises the TabDeserialized event.
OnTabGroupDeserialized(TabGroupDeserializedEventArgs)	Raises the TabGroupDeserialized event.
OnToolTipLinkClicked(ToolTipLinkClickedEventArgs)	Raises the ToolTipLinkClicked event.
OnUpdatingItemFont(UpdatingItemFontEventArgs)	Raises the UpdatingItemFont event.
OnUpdatingItemStyle(UpdatingItemStyleEventArgs)	Raises the UpdatingItemStyle event.
OnViewChanged(EventArgs)	Raises the ViewChanged event.
OnVisibleChanged(EventArgs)	Raises the VisibleChanged event.
ProcessMnemonic(char)	Processes a mnemonic character.
RescaleConstantsForDpi(int, int)
ResubscribeTooltip(C1SuperTooltipBase, C1SuperTooltipBase)
Save(Stream)	Saves a Ribbon definition into a Stream.
Save(string)	Saves a Ribbon definition into an XML file.
Save(XmlTextWriter)	Saves a Ribbon definition into an XmlWriter.
SelectTab(int, bool)	Makes the tab with the specified index the current tab.
SetBoundsCore(int, int, int, int, BoundsSpecified)
ShouldSerializeContextMenuItems()
ShouldSerializeContextualTabGroups()
ShouldSerializeMoreButton()
ShouldSerializeTabs()
ShouldSerializeToolTipSettings()
ShowContextMenu(Point, RibbonItem)	Displays the contextual menu at the specified screen position.
ShowContextMenu(Point, LeftRightAlignment, RibbonItem)	Displays the contextual menu at the specified screen position.
ShowContextMenu(Control)	Displays the contextual menu at the center of the specified control.
WndProc(ref Message)	Processes Windows messages.

Events

Name	Description
ContextMenuCollapse	Occurs when the contextual menu collapses.
ContextMenuPopup	Occurs before the contextual menu is displayed.
ControlHostFromXmlNode	Occurs before a RibbonControlHost starts loading from XML.
GroupDeserialized	Occurs when a RibbonGroup is loaded from XML.
ItemDeserialized	Occurs when a RibbonItem is loaded from XML.
MinimizedChanged	Occurs when the value of the Minimized property changes.
PopupToolTip	Occurs before a tooltip is displayed.
RibbonDeserialized	Occurs when the C1Ribbon control is loaded from XML.
RibbonEvent	Occurs when other Ribbon events occur.
SelectedTabChanged	Occurs when the tab selection changes.
TabDeserialized	Occurs when a RibbonTab is loaded from XML.
TabGroupDeserialized	Occurs when a RibbonContextualTabGroup is loaded from XML.
ToolTipLinkClicked	Event that fires when the user clicks a hyperlink within a tooltip.
UpdatingItemFont	Occurs before a font is applied to a ribbon item.
UpdatingItemStyle	Occurs before a style is applied to a ribbon item.
ViewChanged	Occurs when the ViewMode changes.