ToolStripControlHost Class
TOC
Collapse the table of content
Expand the table of content

ToolStripControlHost Class

 

Hosts custom controls or Windows Forms controls.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Windows.Forms.ToolStripItem
        System.Windows.Forms.ToolStripControlHost
          System.Windows.Forms.ToolStripComboBox
          System.Windows.Forms.ToolStripProgressBar
          System.Windows.Forms.ToolStripTextBox

public class ToolStripControlHost : ToolStripItem

NameDescription
System_CAPS_pubmethodToolStripControlHost(Control)

Initializes a new instance of the ToolStripControlHost class that hosts the specified control.

System_CAPS_pubmethodToolStripControlHost(Control, String)

Initializes a new instance of the ToolStripControlHost class that hosts the specified control and that has the specified name.

NameDescription
System_CAPS_pubpropertyAccessibilityObject

Gets the AccessibleObject assigned to the control.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAccessibleDefaultActionDescription

Gets or sets the default action description of the control for use by accessibility client applications.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAccessibleDescription

Gets or sets the description that will be reported to accessibility client applications.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAccessibleName

Gets or sets the name of the control for use by accessibility client applications.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAccessibleRole

Gets or sets the accessible role of the control, which specifies the type of user interface element of the control.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAlignment

Gets or sets a value indicating whether the item aligns towards the beginning or end of the ToolStrip.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAllowDrop

Gets or sets a value indicating whether drag-and-drop and item reordering are handled through events that you implement.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAnchor

Gets or sets the edges of the container to which a ToolStripItem is bound and determines how a ToolStripItem is resized with its parent.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAutoSize

Gets or sets a value indicating whether the item is automatically sized.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyAutoToolTip

Gets or sets a value indicating whether to use the Text property or the ToolTipText property for the ToolStripItem ToolTip. (Inherited from ToolStripItem.)

System_CAPS_pubpropertyAvailable

Gets or sets a value indicating whether the ToolStripItem should be placed on a ToolStrip.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyBackColor

Gets or sets the background color for the control.(Overrides ToolStripItem.BackColor.)

System_CAPS_pubpropertyBackgroundImage

Gets or sets the background image displayed in the control.(Overrides ToolStripItem.BackgroundImage.)

System_CAPS_pubpropertyBackgroundImageLayout

Gets or sets the background image layout as defined in the ImageLayout enumeration.(Overrides ToolStripItem.BackgroundImageLayout.)

System_CAPS_pubpropertyBounds

Gets the size and location of the item.(Inherited from ToolStripItem.)

System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyCanSelect

Gets a value indicating whether the control can be selected.(Overrides ToolStripItem.CanSelect.)

System_CAPS_pubpropertyCausesValidation

Gets or sets a value indicating whether the hosted control causes and raises validation events on other controls when the hosted control receives focus.

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyContentRectangle

Gets the area where content, such as text and icons, can be placed within a ToolStripItem without overwriting background borders.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyControl

Gets the Control that this ToolStripControlHost is hosting.

System_CAPS_pubpropertyControlAlign

Gets or sets the alignment of the control on the form.

System_CAPS_protpropertyDefaultAutoToolTip

Gets a value indicating whether to display the ToolTip that is defined as the default.(Inherited from ToolStripItem.)

System_CAPS_protpropertyDefaultDisplayStyle

Gets a value indicating what is displayed on the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_protpropertyDefaultMargin

Gets the default margin of an item.(Inherited from ToolStripItem.)

System_CAPS_protpropertyDefaultPadding

Gets the internal spacing characteristics of the item.(Inherited from ToolStripItem.)

System_CAPS_protpropertyDefaultSize

Gets the default size of the control.(Overrides ToolStripItem.DefaultSize.)

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_protpropertyDismissWhenClicked

Gets a value indicating whether items on a ToolStripDropDown are hidden after they are clicked.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyDisplayStyle

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.

System_CAPS_pubpropertyDock

Gets or sets which ToolStripItem borders are docked to its parent control and determines how a ToolStripItem is resized with its parent.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyDoubleClickEnabled

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.

System_CAPS_pubpropertyEnabled

Gets or sets a value indicating whether the parent control of the ToolStripItem is enabled.(Overrides ToolStripItem.Enabled.)

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyFocused

Gets a value indicating whether the control has input focus.

System_CAPS_pubpropertyFont

Gets or sets the font to be used on the hosted control.(Overrides ToolStripItem.Font.)

System_CAPS_pubpropertyForeColor

Gets or sets the foreground color of the hosted control.(Overrides ToolStripItem.ForeColor.)

System_CAPS_pubpropertyHeight

Gets or sets the height, in pixels, of a ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyImage

This API supports the product infrastructure and is not intended to be used directly from your code. The image associated with the object.(Overrides ToolStripItem.Image.)

System_CAPS_pubpropertyImageAlign

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.

System_CAPS_pubpropertyImageIndex

Gets or sets the index value of the image that is displayed on the item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyImageKey

Gets or sets the key accessor for the image in the ImageList that is displayed on a ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyImageScaling

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.

System_CAPS_pubpropertyImageTransparentColor

This property is not relevant to this class.

System_CAPS_pubpropertyIsDisposed

Gets a value indicating whether the object has been disposed of.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyIsOnDropDown

Gets a value indicating whether the container of the current Control is a ToolStripDropDown. (Inherited from ToolStripItem.)

System_CAPS_pubpropertyIsOnOverflow

Gets a value indicating whether the Placement property is set to Overflow.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyMargin

Gets or sets the space between the item and adjacent items.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyMergeAction

Gets or sets how child menus are merged with parent menus. (Inherited from ToolStripItem.)

System_CAPS_pubpropertyMergeIndex

Gets or sets the position of a merged item within the current ToolStrip.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyName

Gets or sets the name of the item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyOverflow

Gets or sets whether the item is attached to the ToolStrip or ToolStripOverflowButton or can float between the two.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyOwner

Gets or sets the owner of this item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyOwnerItem

Gets the parent ToolStripItem of this ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyPadding

Gets or sets the internal spacing, in pixels, between the item's contents and its edges.(Inherited from ToolStripItem.)

System_CAPS_protpropertyParent

Gets or sets the parent container of the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyPlacement

Gets the current layout of the item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyPressed

Gets a value indicating whether the state of the item is pressed. (Inherited from ToolStripItem.)

System_CAPS_pubpropertyRightToLeft

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

System_CAPS_pubpropertyRightToLeftAutoMirrorImage

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.

System_CAPS_pubpropertySelected

Gets a value indicating whether the item is selected.(Overrides ToolStripItem.Selected.)

System_CAPS_protpropertyShowKeyboardCues

Gets a value indicating whether to show or hide shortcut keys.(Inherited from ToolStripItem.)

System_CAPS_pubpropertySite

Gets or sets the site of the hosted control.(Overrides Component.Site.)

System_CAPS_pubpropertySize

Gets or sets the size of the ToolStripItem.(Overrides ToolStripItem.Size.)

System_CAPS_pubpropertyTag

Gets or sets the object that contains data about the item.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyText

Gets or sets the text to be displayed on the hosted control.(Overrides ToolStripItem.Text.)

System_CAPS_pubpropertyTextAlign

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.

System_CAPS_pubpropertyTextDirection

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.(Overrides ToolStripItem.TextDirection.)

System_CAPS_pubpropertyTextImageRelation

This API supports the product infrastructure and is not intended to be used directly from your code. This property is not relevant to this class.

System_CAPS_pubpropertyToolTipText

Gets or sets the text that appears as a ToolTip for a control.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyVisible

Gets or sets a value indicating whether the item is displayed.(Inherited from ToolStripItem.)

System_CAPS_pubpropertyWidth

Gets or sets the width in pixels of a ToolStripItem.(Inherited from ToolStripItem.)

NameDescription
System_CAPS_protmethodCreateAccessibilityInstance()

Creates a new accessibility object for the control.(Overrides ToolStripItem.CreateAccessibilityInstance().)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the ToolStripControlHost and optionally releases the managed resources.(Overrides ToolStripItem.Dispose(Boolean).)

System_CAPS_pubmethodDoDragDrop(Object, DragDropEffects)

Begins a drag-and-drop operation.(Inherited from ToolStripItem.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodFocus()

Gives the focus to a control.

System_CAPS_pubmethodGetCurrentParent()

Retrieves the ToolStrip that is the container of the current ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetPreferredSize(Size)

Retrieves the size of a rectangular area into which a control can be fitted.(Overrides ToolStripItem.GetPreferredSize(Size).)

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodInvalidate()

Invalidates the entire surface of the ToolStripItem and causes it to be redrawn.(Inherited from ToolStripItem.)

System_CAPS_pubmethodInvalidate(Rectangle)

Invalidates the specified region of the ToolStripItem by adding it to the update region of the ToolStripItem, which is the area that will be repainted at the next paint operation, and causes a paint message to be sent to the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_protmethodIsInputChar(Char)

Determines whether a character is an input character that the item recognizes.(Inherited from ToolStripItem.)

System_CAPS_protmethodIsInputKey(Keys)

Determines whether the specified key is a regular input key or a special key that requires preprocessing.(Inherited from ToolStripItem.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodOnAvailableChanged(EventArgs)

Raises the AvailableChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnBackColorChanged(EventArgs)

Raises the BackColorChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnBoundsChanged()

Occurs when the Bounds property changes.(Overrides ToolStripItem.OnBoundsChanged().)

System_CAPS_protmethodOnClick(EventArgs)

Raises the Click event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDisplayStyleChanged(EventArgs)

Raises the DisplayStyleChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDoubleClick(EventArgs)

Raises the DoubleClick event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDragDrop(DragEventArgs)

Raises the DragDrop event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDragEnter(DragEventArgs)

Raises the DragEnter event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDragLeave(EventArgs)

Raises the DragLeave event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnDragOver(DragEventArgs)

Raises the DragOver event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnEnabledChanged(EventArgs)

Raises the EnabledChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnEnter(EventArgs)

Raises the Enter event.

System_CAPS_protmethodOnFontChanged(EventArgs)

Raises the FontChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnForeColorChanged(EventArgs)

Raises the ForeColorChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnGiveFeedback(GiveFeedbackEventArgs)

Raises the GiveFeedback event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnGotFocus(EventArgs)

Raises the GotFocus event.

System_CAPS_protmethodOnHostedControlResize(EventArgs)

Synchronizes the resizing of the control host with the resizing of the hosted control.

System_CAPS_protmethodOnKeyDown(KeyEventArgs)

Raises the KeyDown event.

System_CAPS_protmethodOnKeyPress(KeyPressEventArgs)

Raises the KeyPress event.

System_CAPS_protmethodOnKeyUp(KeyEventArgs)

Raises the KeyUp event.

System_CAPS_protmethodOnLayout(LayoutEventArgs)

Raises the Layout event.(Overrides ToolStripItem.OnLayout(LayoutEventArgs).)

System_CAPS_protmethodOnLeave(EventArgs)

Raises the Leave event.

System_CAPS_protmethodOnLocationChanged(EventArgs)

Raises the LocationChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnLostFocus(EventArgs)

Raises the LostFocus event.

System_CAPS_protmethodOnMouseDown(MouseEventArgs)

Raises the MouseDown event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseEnter(EventArgs)

Raises the MouseEnter event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseHover(EventArgs)

Raises the MouseHover event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseLeave(EventArgs)

Raises the MouseLeave event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseMove(MouseEventArgs)

Raises the MouseMove event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnMouseUp(MouseEventArgs)

Raises the MouseUp event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnOwnerChanged(EventArgs)

Raises the OwnerChanged event. (Inherited from ToolStripItem.)

System_CAPS_protmethodOnOwnerFontChanged(EventArgs)

Raises the FontChanged event when the Font property has changed on the parent of the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnPaint(PaintEventArgs)

Raises the Paint event.(Overrides ToolStripItem.OnPaint(PaintEventArgs).)

System_CAPS_protmethodOnParentBackColorChanged(EventArgs)

Raises the BackColorChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnParentChanged(ToolStrip, ToolStrip)
System_CAPS_protmethodOnParentEnabledChanged(EventArgs)

Raises the EnabledChanged event when the Enabled property value of the item's container changes.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnParentForeColorChanged(EventArgs)

Raises the ForeColorChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnParentRightToLeftChanged(EventArgs)

Raises the RightToLeftChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnQueryContinueDrag(QueryContinueDragEventArgs)

Raises the QueryContinueDrag event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnRightToLeftChanged(EventArgs)

Raises the RightToLeftChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnSubscribeControlEvents(Control)

Subscribes events from the hosted control.

System_CAPS_protmethodOnTextChanged(EventArgs)

Raises the TextChanged event.(Inherited from ToolStripItem.)

System_CAPS_protmethodOnUnsubscribeControlEvents(Control)

Unsubscribes events from the hosted control.

System_CAPS_protmethodOnValidated(EventArgs)

Raises the Validated event.

System_CAPS_protmethodOnValidating(CancelEventArgs)

Raises the Validating event.

System_CAPS_protmethodOnVisibleChanged(EventArgs)

Raises the VisibleChanged event.(Inherited from ToolStripItem.)

System_CAPS_pubmethodPerformClick()

Generates a Click event for a ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_protmethodProcessCmdKey(Message, Keys)

Processes a command key.(Overrides ToolStripItem.ProcessCmdKey(Message, Keys).)

System_CAPS_protmethodProcessDialogKey(Keys)

Processes a dialog key.(Overrides ToolStripItem.ProcessDialogKey(Keys).)

System_CAPS_protmethodProcessMnemonic(Char)

Processes a mnemonic character.(Overrides ToolStripItem.ProcessMnemonic(Char).)

System_CAPS_pubmethodResetBackColor()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Overrides ToolStripItem.ResetBackColor().)

System_CAPS_pubmethodResetDisplayStyle()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetFont()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetForeColor()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Overrides ToolStripItem.ResetForeColor().)

System_CAPS_pubmethodResetImage()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetMargin()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetPadding()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetRightToLeft()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodResetTextDirection()

This API supports the product infrastructure and is not intended to be used directly from your code. This method is not relevant to this class.(Inherited from ToolStripItem.)

System_CAPS_pubmethodSelect()

Selects the item.(Inherited from ToolStripItem.)

System_CAPS_protmethodSetBounds(Rectangle)

Sets the size and location of the item.(Inherited from ToolStripItem.)

System_CAPS_protmethodSetVisibleCore(Boolean)

Sets the ToolStripItem to the specified visible state. (Overrides ToolStripItem.SetVisibleCore(Boolean).)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from ToolStripItem.)

NameDescription
System_CAPS_pubeventAvailableChanged

Occurs when the value of the Available property changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventBackColorChanged

Occurs when the value of the BackColor property changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventClick

Occurs when the ToolStripItem is clicked.(Inherited from ToolStripItem.)

System_CAPS_pubeventDisplayStyleChanged

This API supports the product infrastructure and is not intended to be used directly from your code. This event is not relevant to this class.

System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

System_CAPS_pubeventDoubleClick

Occurs when the item is double-clicked with the mouse.(Inherited from ToolStripItem.)

System_CAPS_pubeventDragDrop

Occurs when the user drags an item and the user releases the mouse button, indicating that the item should be dropped into this item.(Inherited from ToolStripItem.)

System_CAPS_pubeventDragEnter

Occurs when the user drags an item into the client area of this item.(Inherited from ToolStripItem.)

System_CAPS_pubeventDragLeave

Occurs when the user drags an item and the mouse pointer is no longer over the client area of this item.(Inherited from ToolStripItem.)

System_CAPS_pubeventDragOver

Occurs when the user drags an item over the client area of this item.(Inherited from ToolStripItem.)

System_CAPS_pubeventEnabledChanged

Occurs when the Enabled property value has changed.(Inherited from ToolStripItem.)

System_CAPS_pubeventEnter

Occurs when the hosted control is entered.

System_CAPS_pubeventForeColorChanged

Occurs when the ForeColor property value changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventGiveFeedback

Occurs during a drag operation.(Inherited from ToolStripItem.)

System_CAPS_pubeventGotFocus

Occurs when the hosted control receives focus.

System_CAPS_pubeventKeyDown

Occurs when a key is pressed and held down while the hosted control has focus.

System_CAPS_pubeventKeyPress

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

System_CAPS_pubeventKeyUp

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

System_CAPS_pubeventLeave

Occurs when the input focus leaves the hosted control.

System_CAPS_pubeventLocationChanged

Occurs when the location of a ToolStripItem is updated.(Inherited from ToolStripItem.)

System_CAPS_pubeventLostFocus

Occurs when the hosted control loses focus.

System_CAPS_pubeventMouseDown

Occurs when the mouse pointer is over the item and a mouse button is pressed.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseEnter

Occurs when the mouse pointer enters the item.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseHover

Occurs when the mouse pointer hovers over the item.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseLeave

Occurs when the mouse pointer leaves the item.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseMove

Occurs when the mouse pointer is moved over the item.(Inherited from ToolStripItem.)

System_CAPS_pubeventMouseUp

Occurs when the mouse pointer is over the item and a mouse button is released.(Inherited from ToolStripItem.)

System_CAPS_pubeventOwnerChanged

Occurs when the Owner property changes. (Inherited from ToolStripItem.)

System_CAPS_pubeventPaint

Occurs when the item is redrawn.(Inherited from ToolStripItem.)

System_CAPS_pubeventQueryAccessibilityHelp

Occurs when an accessibility client application invokes help for the ToolStripItem.(Inherited from ToolStripItem.)

System_CAPS_pubeventQueryContinueDrag

Occurs during a drag-and-drop operation and allows the drag source to determine whether the drag-and-drop operation should be canceled.(Inherited from ToolStripItem.)

System_CAPS_pubeventRightToLeftChanged

Occurs when the RightToLeft property value changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventTextChanged

Occurs when the value of the Text property changes.(Inherited from ToolStripItem.)

System_CAPS_pubeventValidated

Occurs after the hosted control has been successfully validated.

System_CAPS_pubeventValidating

Occurs while the hosted control is validating.

System_CAPS_pubeventVisibleChanged

Occurs when the value of the Visible property changes.(Inherited from ToolStripItem.)

ToolStripControlHost is the abstract base class for ToolStripComboBox, ToolStripTextBox, and ToolStripProgressBar. ToolStripControlHost can host other controls, including custom controls, in two ways:

  • Construct a ToolStripControlHost with a class that derives from Control. To fully access the hosted control and properties, you must cast the Control property back to the actual class it represents.

  • Extend ToolStripControlHost, and in the inherited class's default constructor, call the base class constructor passing a class that derives from Control. This option lets you wrap common control methods and properties for easy access in a ToolStrip.

Use the ToolStripControlHost class to host your customized controls or any other Windows Forms control.

To customize a ToolStripItem, derive from ToolStripControlHost and create a custom implementation. You can override methods such as OnSubscribeControlEvents to handle events raised by the hosted controls, and you can put custom functionality into properties to enhance the hosted control.

The following code example demonstrates constructing a ToolStripControlHost with a MonthCalendar control, using OnSubscribeControlEvents to handle events, and exposing some of its members to the ToolStripControlHost.

//Declare a class that inherits from ToolStripControlHost.
public class ToolStripMonthCalendar : ToolStripControlHost
{
	// Call the base constructor passing in a MonthCalendar instance.
	public ToolStripMonthCalendar() : base (new MonthCalendar()) { }

	public MonthCalendar MonthCalendarControl
	{
		get
		{
			return Control as MonthCalendar;
		}
	}

	// Expose the MonthCalendar.FirstDayOfWeek as a property.
	public Day FirstDayOfWeek
	{
		get
		{
			return MonthCalendarControl.FirstDayOfWeek;
		}
		set { MonthCalendarControl.FirstDayOfWeek = value; }
	}

	// Expose the AddBoldedDate method.
	public void AddBoldedDate(DateTime dateToBold)
	{
		MonthCalendarControl.AddBoldedDate(dateToBold);
	}

	// Subscribe and unsubscribe the control events you wish to expose.
	protected override void OnSubscribeControlEvents(Control c)
	{
		// Call the base so the base events are connected.
		base.OnSubscribeControlEvents(c);

		// Cast the control to a MonthCalendar control.
		MonthCalendar monthCalendarControl = (MonthCalendar) c;

		// Add the event.
		monthCalendarControl.DateChanged +=
			new DateRangeEventHandler(OnDateChanged);
	}

	protected override void OnUnsubscribeControlEvents(Control c)
	{
		// Call the base method so the basic events are unsubscribed.
		base.OnUnsubscribeControlEvents(c);

		// Cast the control to a MonthCalendar control.
		MonthCalendar monthCalendarControl = (MonthCalendar) c;

		// Remove the event.
		monthCalendarControl.DateChanged -=
			new DateRangeEventHandler(OnDateChanged);
	}

	// Declare the DateChanged event.
	public event DateRangeEventHandler DateChanged;

	// Raise the DateChanged event.
	private void OnDateChanged(object sender, DateRangeEventArgs e)
	{
		if (DateChanged != null)
		{
			DateChanged(this, e);
		}
	}
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft