RibbonControlHost Class

Represents a control host in a C1Ribbon control.

Inheritance

object

MarshalByRefObject

Component

RibbonItem

RibbonControlHost

Implements

IComponent

IDisposable

Namespace: C1.Win.Ribbon

Assembly: C1.Win.Ribbon.10.dll

Syntax

public class RibbonControlHost : RibbonItem, IComponent, IDisposable

Public Class RibbonControlHost
    Inherits RibbonItem
    Implements IComponent, IDisposable

Examples

The following code example shows how to support keyboard navigation for a custom RibbonControlHost.

public class CustomControlHost : RibbonControlHost
{
	public CustomControlHost() : base(new MyTextBox()) { }

	private class MyTextBox : TextBox
	{
		protected override bool IsInputKey(Keys keyData)
		{
			if (Parent is C1Ribbon ribbon)
            	return ribbon.IsInputKey(this, keyData);
            return base.IsInputKey(keyData);
		}
	}
}

Constructors

Name	Description
RibbonControlHost()	Initializes a new instance of an RibbonControlHost.
RibbonControlHost(Control)	Initializes a new instance of an RibbonControlHost.

Properties

Name	Description
BackColor	Gets or sets the background color for the hosted control.
BackgroundImage	Gets or sets the background image displayed in the hosted control.
BackgroundImageLayout	Gets or sets the background image layout used for the hosted control.
CanFocus	Gets a value indicating whether the hosted control can receive focus.
CanSelect	Gets a value indicating whether the hosted control can be selected.
CausesValidation	Indicates whether the hosted control raises validation events.
Control	Gets or sets the control that this RibbonControlHost is hosting.
ControlHostNodeName	Gets the name of an XML node when serializing the component to XML.
Focused	Gets a value indicating whether the hosted control has input focus.
Font	The font used to display text in the hosted control.
ForeColor	Gets or sets the foreground color for the hosted control.
Height	Gets or sets the height of the hosted control.
RightToLeft	Indicates whether the hosted control should draw right-to-left for RTL languages.
ShowInMore	Gets or sets a value indicating if this RibbonItem can be shown in drop down part of the More button when ribbon is simplified.
Text	Gets or sets the text associated with the hosted control.
Width	Gets or sets the width of the hosted control.

Methods

Name	Description
Focus()	Gives the focus to the hosted control.
LoadControlHostProperties(XmlNode)	Loads properties of an RibbonControlHost from the specified XmlNode.
OnBackColorChanged(EventArgs)	Raises the BackColorChanged event.
OnClick(EventArgs)	Raises the Click event.
OnDoubleClick(EventArgs)	Raises the DoubleClick event.
OnDragDrop(DragEventArgs)	Raises the DragDrop event.
OnDragEnter(DragEventArgs)	Raises the DragEnter event.
OnDragLeave(EventArgs)	Raises the DragLeave event.
OnDragOver(DragEventArgs)	Raises the DragOver event.
OnEnabledChanged(EventArgs)	Raises the EnabledChanged event.
OnEnter(EventArgs)	Raises the Enter event.
OnForeColorChanged(EventArgs)	Raises the ForeColorChanged event.
OnGiveFeedback(GiveFeedbackEventArgs)	Raises the GiveFeedback event.
OnGotFocus(EventArgs)	Raises the GotFocus event.
OnKeyDown(KeyEventArgs)	Raises the KeyDown event.
OnKeyPress(KeyPressEventArgs)	Raises the KeyPress event.
OnKeyUp(KeyEventArgs)	Raises the KeyUp event.
OnLeave(EventArgs)	Raises the Leave event.
OnLostFocus(EventArgs)	Raises the LostFocus event.
OnMouseDown(MouseEventArgs)	Raises the MouseDown event.
OnMouseHover(EventArgs)	Raises the MouseHover event.
OnMouseMove(MouseEventArgs)	Raises the MouseMove event.
OnMouseUp(MouseEventArgs)	Raises the MouseUp event.
OnPaint(PaintEventArgs)	Raises the Paint event.
OnQueryContinueDrag(QueryContinueDragEventArgs)	Raises the QueryContinueDrag event.
OnResize(EventArgs)	Raises the Resize event.
OnRightToLeftChanged(EventArgs)	Raises the RightToLeftChanged event.
OnSubscribeControlEvents(Control)	Subscribes events from the hosted control.
OnTextChanged(EventArgs)	Raises the TextChanged event.
OnUnsubscribeControlEvents(Control)	Unsubscribes events from the hosted control.
OnValidated(EventArgs)	Raises the Validated event.
OnValidating(CancelEventArgs)	Raises the Validating event.
OnVisibleChanged(EventArgs)	Raises the VisibleChanged event.
ResetBackColor()	This member is for internal use only.
ResetFont()	This member is for internal use only.
ResetForeColor()	This member is for internal use only.
ResetRightToLeft()	This member is for internal use only.
SaveControlHostProperties(XmlWriter)	Saves properties of an RibbonControlHost to XML using the specified XmlWriter.
ShouldSerializeBackColor()	This member is for internal use only.
ShouldSerializeFont()	This member is for internal use only.
ShouldSerializeForeColor()	This member is for internal use only.
ShouldSerializeRightToLeft()	This member is for internal use only.

Events

Name	Description
BackColorChanged	Fires when the value of the BackColor property changes.
Click	Fires when the hosted control is clicked.
DoubleClick	Fires when the hosted control is double-clicked.
DragDrop	Fires when the user drags an item and the user releases the mouse button, indicating that the item should be dropped into the hosted control.
DragEnter	Fires when the user drags an item into the client area of the hosted control.
DragLeave	Fires when the user drags an item and the mouse pointer is no longer over the client area of the hosted control.
DragOver	Fires when the user drags an item over the client area of the hosted control.
EnabledChanged	Fires when the value of the Enabled property changes.
Enter	Fires when the hosted control is entered.
ForeColorChanged	Fires when the value of the ForeColor property changes.
GiveFeedback	Fires during a drag operation.
GotFocus	Fires when the hosted control receives the focus.
KeyDown	Fires when a key is pressed while the hosted control has focus.
KeyPress	Fires when a key is pressed while the hosted control has focus.
KeyUp	Fires when a key is released while the hosted control has focus.
Leave	Fires when the input focus leaves the hosted control.
LostFocus	Fires when the hosted control loses the focus.
MouseDown	Fires when the user presses a mouse button on the hosted control.
MouseHover	Fires when the mouse pointer hovers over the hosted control.
MouseMove	Fires when the user moves the mouse over the hosted control.
MouseUp	Fires when the user releases a mouse button over the hosted control.
Paint	Fires when the hosted control is redrawn.
QueryContinueDrag	Fires during a drag-and-drop operation and allows the drag source to determine whether the drag-and-drop operation should be canceled.
Resize	Fires when the hosted control is resized.
RightToLeftChanged	Fires when the value of the RightToLeft property changes.
TextChanged	Fires when the value of the Text property changes.
Validated	Fires after the contents of the hosted control have been validated.
Validating	Fires to validate the contents of the hosted control before it loses focus.
VisibleChanged	Fires when the value of the Visible property changes.