Ribbon for WinForms | ComponentOne
C1.Win.Ribbon Namespace / RibbonControlHost Class
Properties Methods Events


In This Topic
    RibbonControlHost Class Members
    In This Topic

    The following tables list the members exposed by RibbonControlHost.

    Public Constructors
     NameDescription
    Public ConstructorRibbonControlHost ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyBackColorGets or sets the background color for the hosted control.  
    Public PropertyBackgroundImageGets or sets the background image displayed in the hosted control.  
    Public PropertyBackgroundImageLayoutGets or sets the background image layout used for the hosted control.  
    Public PropertyCanFocusGets a value indicating whether the hosted control can receive focus.  
    Public PropertyCanSelectGets a value indicating whether the hosted control can be selected.  
    Public PropertyCausesValidationIndicates whether the hosted control raises validation events.  
    Public PropertyContainer (Inherited from System.ComponentModel.Component)
    Public PropertyControlGets or sets the control that this RibbonControlHost is hosting.  
    Public PropertyControlHostNodeNameGets the name of an XML node when serializing the component to XML.  
    Public PropertyDescriptionGets or sets the description for this RibbonItem. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyEnabledGets or sets whether this RibbonItem is enabled. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyFocusedGets a value indicating whether the hosted control has input focus.  
    Public PropertyFontThe font used to display text in the hosted control.  
    Public PropertyForeColorGets or sets the foreground color for the hosted control.  
    Public PropertyGroupGets the RibbonGroup that this RibbonItem belongs to. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyHeightGets or sets the height of the hosted control.  
    Public PropertyIsDisposedGets a value indicating whether the RibbonItem has been disposed of. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyNameGets or sets the unique name for this RibbonItem. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyOwnerCollectionGets the owner collection for this RibbonItem. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyOwnerControlGets the C1Ribbon or C1StatusBar that this RibbonItem belongs to. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyParentGets the object (RibbonItem or RibbonGroup) that this RibbonItem belongs to. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyRibbonGets the C1Ribbon that this RibbonItem belongs to. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyRightToLeftIndicates whether the hosted control should draw right-to-left for RTL languages.  
    Public PropertyShowInMoreGets or sets a value indicating if this RibbonItem can be shown in drop down part of the More button when ribbon is simplified.  
    Public PropertyShowInSimplifiedGets or sets a value indicating whether this RibbonItem can be shown in a simplified view. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertySiteGets or sets the ISite of the RibbonItem. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyStatusBarGets the C1StatusBar that this RibbonItem belongs to. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyTabGets the RibbonTab that this RibbonItem belongs to. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyTagUser-defined data associated with the RibbonItem. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyTextGets or sets the text associated with the hosted control.  
    Public PropertyToolTipGets or sets the ToolTip string. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyVisibleGets or sets whether this RibbonItem is visible. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public PropertyWidthGets or sets the width of the hosted control.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyCanRaiseEvents (Inherited from System.ComponentModel.Component)
    Protected PropertyDesignMode (Inherited from System.ComponentModel.Component)
    Protected PropertyEvents (Inherited from System.ComponentModel.Component)
    Top
    Public Methods
     NameDescription
    Public MethodClearCollectionsOnDesignSurface (Inherited from C1.Win.Ribbon.RibbonItem)
    Public MethodDisposeOverloaded. Clean up any resources being used. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public MethodEqualsDetermines whether the specified RibbonItem is equal to the current RibbonItem. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public MethodFocusGives the focus to the hosted control.  
    Public MethodGetHashCodeServes as a hash function for a particular type. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public MethodGetLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodInitializeLifetimeService (Inherited from System.MarshalByRefObject)
    Public MethodToString (Inherited from System.ComponentModel.Component)
    Top
    Protected Methods
     NameDescription
    Protected MethodFinalize (Inherited from System.ComponentModel.Component)
    Protected MethodGetService (Inherited from System.ComponentModel.Component)
    Protected MethodLoadControlHostPropertiesLoads properties of an RibbonControlHost from the specified XmlNode.  
    Protected MethodMemberwiseCloneOverloaded.  (Inherited from System.MarshalByRefObject)
    Protected MethodOnBackColorChangedRaises the RibbonControlHost.BackColorChanged event.  
    Protected MethodOnClickRaises the RibbonControlHost.Click event.  
    Protected MethodOnDoubleClickRaises the RibbonControlHost.DoubleClick event.  
    Protected MethodOnDragDropRaises the RibbonControlHost.DragDrop event.  
    Protected MethodOnDragEnterRaises the RibbonControlHost.DragEnter event.  
    Protected MethodOnDragLeaveRaises the RibbonControlHost.DragLeave event.  
    Protected MethodOnDragOverRaises the RibbonControlHost.DragOver event.  
    Protected MethodOnEnabledChangedRaises the RibbonControlHost.EnabledChanged event.  
    Protected MethodOnEnterRaises the RibbonControlHost.Enter event.  
    Protected MethodOnForeColorChangedRaises the RibbonControlHost.ForeColorChanged event.  
    Protected MethodOnGiveFeedbackRaises the RibbonControlHost.GiveFeedback event.  
    Protected MethodOnGotFocusRaises the RibbonControlHost.GotFocus event.  
    Protected MethodOnKeyDownRaises the RibbonControlHost.KeyDown event.  
    Protected MethodOnKeyPressRaises the RibbonControlHost.KeyPress event.  
    Protected MethodOnKeyUpRaises the RibbonControlHost.KeyUp event.  
    Protected MethodOnLeaveRaises the RibbonControlHost.Leave event.  
    Protected MethodOnLostFocusRaises the RibbonControlHost.LostFocus event.  
    Protected MethodOnMouseDownRaises the RibbonControlHost.MouseDown event.  
    Protected MethodOnMouseEnterRaises the RibbonItem.MouseEnter event. (Inherited from C1.Win.Ribbon.RibbonItem)
    Protected MethodOnMouseHoverRaises the RibbonControlHost.MouseHover event.  
    Protected MethodOnMouseLeaveRaises the RibbonItem.MouseLeave event. (Inherited from C1.Win.Ribbon.RibbonItem)
    Protected MethodOnMouseMoveRaises the RibbonControlHost.MouseMove event.  
    Protected MethodOnMouseUpRaises the RibbonControlHost.MouseUp event.  
    Protected MethodOnPaintRaises the RibbonControlHost.Paint event.  
    Protected MethodOnQueryContinueDragRaises the RibbonControlHost.QueryContinueDrag event.  
    Protected MethodOnResizeRaises the RibbonControlHost.Resize event.  
    Protected MethodOnRightToLeftChangedRaises the RibbonControlHost.RightToLeftChanged event.  
    Protected MethodOnSubscribeControlEventsSubscribes events from the hosted control.  
    Protected MethodOnTextChangedRaises the RibbonControlHost.TextChanged event.  
    Protected MethodOnUnsubscribeControlEventsUnsubscribes events from the hosted control.  
    Protected MethodOnValidatedRaises the RibbonControlHost.Validated event.  
    Protected MethodOnValidatingRaises the RibbonControlHost.Validating event.  
    Protected MethodOnVisibleChangedRaises the RibbonControlHost.VisibleChanged event.  
    Protected MethodResetBackColorThis member is for internal use only.  
    Protected MethodResetFontThis member is for internal use only.  
    Protected MethodResetForeColorThis member is for internal use only.  
    Protected MethodResetRightToLeftThis member is for internal use only.  
    Protected MethodResetToolTipRestores the default value of the RibbonItem.ToolTip property. (Inherited from C1.Win.Ribbon.RibbonItem)
    Protected MethodSaveControlHostPropertiesSaves properties of an RibbonControlHost to XML using the specified XmlWriter.  
    Protected MethodShouldSerializeBackColorThis member is for internal use only.  
    Protected MethodShouldSerializeFontThis member is for internal use only.  
    Protected MethodShouldSerializeForeColorThis member is for internal use only.  
    Protected MethodShouldSerializeID (Inherited from C1.Win.Ribbon.RibbonItem)
    Protected MethodShouldSerializeName (Inherited from C1.Win.Ribbon.RibbonItem)
    Protected MethodShouldSerializeRightToLeftThis member is for internal use only.  
    Protected MethodShouldSerializeToolTipSpecifies whether to save the value of the RibbonItem.ToolTip property. (Inherited from C1.Win.Ribbon.RibbonItem)
    Top
    Public Events
     NameDescription
    Public EventBackColorChangedFires when the value of the BackColor property changes.  
    Public EventClickFires when the hosted control is clicked.  
    Public EventDisposed (Inherited from System.ComponentModel.Component)
    Public EventDoubleClickFires when the hosted control is double-clicked.  
    Public EventDragDropFires when the user drags an item and the user releases the mouse button, indicating that the item should be dropped into the hosted control.  
    Public EventDragEnterFires when the user drags an item into the client area of the hosted control.  
    Public EventDragLeaveFires when the user drags an item and the mouse pointer is no longer over the client area of the hosted control.  
    Public EventDragOverFires when the user drags an item over the client area of the hosted control.  
    Public EventEnabledChangedFires when the value of the Enabled property changes.  
    Public EventEnterFires when the hosted control is entered.  
    Public EventForeColorChangedFires when the value of the ForeColor property changes.  
    Public EventGiveFeedbackFires during a drag operation.  
    Public EventGotFocusFires when the hosted control receives the focus.  
    Public EventKeyDownFires when a key is pressed while the hosted control has focus.  
    Public EventKeyPressFires when a key is pressed while the hosted control has focus.  
    Public EventKeyUpFires when a key is released while the hosted control has focus.  
    Public EventLeaveFires when the input focus leaves the hosted control.  
    Public EventLostFocusFires when the hosted control loses the focus.  
    Public EventMouseDownFires when the user presses a mouse button on the hosted control.  
    Public EventMouseEnterOccurs when the mouse enters the item. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public EventMouseHoverFires when the mouse pointer hovers over the hosted control.  
    Public EventMouseLeaveOccurs when the mouse leaves the item. (Inherited from C1.Win.Ribbon.RibbonItem)
    Public EventMouseMoveFires when the user moves the mouse over the hosted control.  
    Public EventMouseUpFires when the user releases a mouse button over the hosted control.  
    Public EventPaintFires when the hosted control is redrawn.  
    Public EventQueryContinueDragFires during a drag-and-drop operation and allows the drag source to determine whether the drag-and-drop operation should be canceled.  
    Public EventResizeFires when the hosted control is resized.  
    Public EventRightToLeftChangedFires when the value of the RightToLeft property changes.  
    Public EventTextChangedFires when the value of the RibbonControlHost.Text property changes.  
    Public EventValidatedFires after the contents of the hosted control have been validated.  
    Public EventValidatingFires to validate the contents of the hosted control before it loses focus.  
    Public EventVisibleChangedFires when the value of the Visible property changes.  
    Top
    See Also

    Reference

    RibbonControlHost Class
    C1.Win.Ribbon Namespace