Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ToolStripItem Class

 

Represents the abstract base class that manages events and layout for all the elements that a ToolStrip or ToolStripDropDown can contain.

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.ToolStripButton
        System.Windows.Forms.ToolStripControlHost
        System.Windows.Forms.ToolStripDropDownItem
        System.Windows.Forms.ToolStripLabel
        System.Windows.Forms.ToolStripSeparator

public abstract class ToolStripItem : Component, IDropTarget, 
	IComponent, IDisposable

NameDescription
System_CAPS_protmethodToolStripItem()

Initializes a new instance of the ToolStripItem class.

System_CAPS_protmethodToolStripItem(String, Image, EventHandler)

Initializes a new instance of the ToolStripItem class with the specified name, image, and event handler.

System_CAPS_protmethodToolStripItem(String, Image, EventHandler, String)

Initializes a new instance of the ToolStripItem class with the specified display text, image, event handler, and name.

NameDescription
System_CAPS_pubpropertyAccessibilityObject

Gets the AccessibleObject assigned to the control.

System_CAPS_pubpropertyAccessibleDefaultActionDescription

Gets or sets the default action description of the control for use by accessibility client applications.

System_CAPS_pubpropertyAccessibleDescription

Gets or sets the description that will be reported to accessibility client applications.

System_CAPS_pubpropertyAccessibleName

Gets or sets the name of the control for use by accessibility client applications.

System_CAPS_pubpropertyAccessibleRole

Gets or sets the accessible role of the control, which specifies the type of user interface element of the control.

System_CAPS_pubpropertyAlignment

Gets or sets a value indicating whether the item aligns towards the beginning or end of the ToolStrip.

System_CAPS_pubpropertyAllowDrop

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

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.

System_CAPS_pubpropertyAutoSize

Gets or sets a value indicating whether the item is automatically sized.

System_CAPS_pubpropertyAutoToolTip

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

System_CAPS_pubpropertyAvailable

Gets or sets a value indicating whether the ToolStripItem should be placed on a ToolStrip.

System_CAPS_pubpropertyBackColor

Gets or sets the background color for the item.

System_CAPS_pubpropertyBackgroundImage

Gets or sets the background image displayed in the item.

System_CAPS_pubpropertyBackgroundImageLayout

Gets or sets the background image layout used for the ToolStripItem.

System_CAPS_pubpropertyBounds

Gets the size and location of the item.

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 item can be selected.

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.

System_CAPS_protpropertyDefaultAutoToolTip

Gets a value indicating whether to display the ToolTip that is defined as the default.

System_CAPS_protpropertyDefaultDisplayStyle

Gets a value indicating what is displayed on the ToolStripItem.

System_CAPS_protpropertyDefaultMargin

Gets the default margin of an item.

System_CAPS_protpropertyDefaultPadding

Gets the internal spacing characteristics of the item.

System_CAPS_protpropertyDefaultSize

Gets the default size of the item.

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.

System_CAPS_pubpropertyDisplayStyle

Gets or sets whether text and images are displayed on a ToolStripItem.

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.

System_CAPS_pubpropertyDoubleClickEnabled

Gets or sets a value indicating whether the ToolStripItem can be activated by double-clicking the mouse.

System_CAPS_pubpropertyEnabled

Gets or sets a value indicating whether the parent control of the ToolStripItem is enabled.

System_CAPS_protpropertyEvents

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

System_CAPS_pubpropertyFont

Gets or sets the font of the text displayed by the item.

System_CAPS_pubpropertyForeColor

Gets or sets the foreground color of the item.

System_CAPS_pubpropertyHeight

Gets or sets the height, in pixels, of a ToolStripItem.

System_CAPS_pubpropertyImage

Gets or sets the image that is displayed on a ToolStripItem.

System_CAPS_pubpropertyImageAlign

Gets or sets the alignment of the image on a ToolStripItem.

System_CAPS_pubpropertyImageIndex

Gets or sets the index value of the image that is displayed on the item.

System_CAPS_pubpropertyImageKey

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

System_CAPS_pubpropertyImageScaling

Gets or sets a value indicating whether an image on a ToolStripItem is automatically resized to fit in a container.

System_CAPS_pubpropertyImageTransparentColor

Gets or sets the color to treat as transparent in a ToolStripItem image.

System_CAPS_pubpropertyIsDisposed

Gets a value indicating whether the object has been disposed of.

System_CAPS_pubpropertyIsOnDropDown

Gets a value indicating whether the container of the current Control is a ToolStripDropDown.

System_CAPS_pubpropertyIsOnOverflow

Gets a value indicating whether the Placement property is set to Overflow.

System_CAPS_pubpropertyMargin

Gets or sets the space between the item and adjacent items.

System_CAPS_pubpropertyMergeAction

Gets or sets how child menus are merged with parent menus.

System_CAPS_pubpropertyMergeIndex

Gets or sets the position of a merged item within the current ToolStrip.

System_CAPS_pubpropertyName

Gets or sets the name of the item.

System_CAPS_pubpropertyOverflow

Gets or sets whether the item is attached to the ToolStrip or ToolStripOverflowButton or can float between the two.

System_CAPS_pubpropertyOwner

Gets or sets the owner of this item.

System_CAPS_pubpropertyOwnerItem

Gets the parent ToolStripItem of this ToolStripItem.

System_CAPS_pubpropertyPadding

Gets or sets the internal spacing, in pixels, between the item's contents and its edges.

System_CAPS_protpropertyParent

Gets or sets the parent container of the ToolStripItem.

System_CAPS_pubpropertyPlacement

Gets the current layout of the item.

System_CAPS_pubpropertyPressed

Gets a value indicating whether the state of the item is pressed.

System_CAPS_pubpropertyRightToLeft

Gets or sets a value indicating whether items are to be placed from right to left and text is to be written from right to left.

System_CAPS_pubpropertyRightToLeftAutoMirrorImage

Mirrors automatically the ToolStripItem image when the RightToLeft property is set to Yes.

System_CAPS_pubpropertySelected

Gets a value indicating whether the item is selected.

System_CAPS_protpropertyShowKeyboardCues

Gets a value indicating whether to show or hide shortcut keys.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertySize

Gets or sets the size of the item.

System_CAPS_pubpropertyTag

Gets or sets the object that contains data about the item.

System_CAPS_pubpropertyText

Gets or sets the text that is to be displayed on the item.

System_CAPS_pubpropertyTextAlign

Gets or sets the alignment of the text on a ToolStripLabel.

System_CAPS_pubpropertyTextDirection

Gets the orientation of text used on a ToolStripItem.

System_CAPS_pubpropertyTextImageRelation

Gets or sets the position of ToolStripItem text and image relative to each other.

System_CAPS_pubpropertyToolTipText

Gets or sets the text that appears as a ToolTip for a control.

System_CAPS_pubpropertyVisible

Gets or sets a value indicating whether the item is displayed.

System_CAPS_pubpropertyWidth

Gets or sets the width in pixels of a ToolStripItem.

NameDescription
System_CAPS_protmethodCreateAccessibilityInstance()

Creates a new accessibility object for the ToolStripItem.

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 ToolStripItem and optionally releases the managed resources.(Overrides Component.Dispose(Boolean).)

System_CAPS_pubmethodDoDragDrop(Object, DragDropEffects)

Begins a drag-and-drop operation.

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_pubmethodGetCurrentParent()

Retrieves the ToolStrip that is the container of the current 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 fit.

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.

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.

System_CAPS_protmethodIsInputChar(Char)

Determines whether a character is an input character that the item recognizes.

System_CAPS_protmethodIsInputKey(Keys)

Determines whether the specified key is a regular input key or a special key that requires preprocessing.

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.

System_CAPS_protmethodOnBackColorChanged(EventArgs)

Raises the BackColorChanged event.

System_CAPS_protmethodOnBoundsChanged()

Occurs when the Bounds property changes.

System_CAPS_protmethodOnClick(EventArgs)

Raises the Click event.

System_CAPS_protmethodOnDisplayStyleChanged(EventArgs)

Raises the DisplayStyleChanged event.

System_CAPS_protmethodOnDoubleClick(EventArgs)

Raises the DoubleClick event.

System_CAPS_protmethodOnDragDrop(DragEventArgs)

Raises the DragDrop event.

System_CAPS_protmethodOnDragEnter(DragEventArgs)

Raises the DragEnter event.

System_CAPS_protmethodOnDragLeave(EventArgs)

Raises the DragLeave event.

System_CAPS_protmethodOnDragOver(DragEventArgs)

Raises the DragOver event.

System_CAPS_protmethodOnEnabledChanged(EventArgs)

Raises the EnabledChanged event.

System_CAPS_protmethodOnFontChanged(EventArgs)

Raises the FontChanged event.

System_CAPS_protmethodOnForeColorChanged(EventArgs)

Raises the ForeColorChanged event.

System_CAPS_protmethodOnGiveFeedback(GiveFeedbackEventArgs)

Raises the GiveFeedback event.

System_CAPS_protmethodOnLayout(LayoutEventArgs)

Raises the Layout event.

System_CAPS_protmethodOnLocationChanged(EventArgs)

Raises the LocationChanged event.

System_CAPS_protmethodOnMouseDown(MouseEventArgs)

Raises the MouseDown event.

System_CAPS_protmethodOnMouseEnter(EventArgs)

Raises the MouseEnter event.

System_CAPS_protmethodOnMouseHover(EventArgs)

Raises the MouseHover event.

System_CAPS_protmethodOnMouseLeave(EventArgs)

Raises the MouseLeave event.

System_CAPS_protmethodOnMouseMove(MouseEventArgs)

Raises the MouseMove event.

System_CAPS_protmethodOnMouseUp(MouseEventArgs)

Raises the MouseUp event.

System_CAPS_protmethodOnOwnerChanged(EventArgs)

Raises the OwnerChanged event.

System_CAPS_protmethodOnOwnerFontChanged(EventArgs)

Raises the FontChanged event when the Font property has changed on the parent of the ToolStripItem.

System_CAPS_protmethodOnPaint(PaintEventArgs)

Raises the Paint event.

System_CAPS_protmethodOnParentBackColorChanged(EventArgs)

Raises the BackColorChanged event.

System_CAPS_protmethodOnParentChanged(ToolStrip, ToolStrip)

Raises the ParentChanged event.

System_CAPS_protmethodOnParentEnabledChanged(EventArgs)

Raises the EnabledChanged event when the Enabled property value of the item's container changes.

System_CAPS_protmethodOnParentForeColorChanged(EventArgs)

Raises the ForeColorChanged event.

System_CAPS_protmethodOnParentRightToLeftChanged(EventArgs)

Raises the RightToLeftChanged event.

System_CAPS_protmethodOnQueryContinueDrag(QueryContinueDragEventArgs)

Raises the QueryContinueDrag event.

System_CAPS_protmethodOnRightToLeftChanged(EventArgs)

Raises the RightToLeftChanged event.

System_CAPS_protmethodOnTextChanged(EventArgs)

Raises the TextChanged event.

System_CAPS_protmethodOnVisibleChanged(EventArgs)

Raises the VisibleChanged event.

System_CAPS_pubmethodPerformClick()

Generates a Click event for a ToolStripItem.

System_CAPS_protmethodProcessCmdKey(Message, Keys)

Processes a command key.

System_CAPS_protmethodProcessDialogKey(Keys)

Processes a dialog key.

System_CAPS_protmethodProcessMnemonic(Char)

Processes a mnemonic character.

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.

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.

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.

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.

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.

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.

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.

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.

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.

System_CAPS_pubmethodSelect()

Selects the item.

System_CAPS_protmethodSetBounds(Rectangle)

Sets the size and location of the item.

System_CAPS_protmethodSetVisibleCore(Boolean)

Sets the ToolStripItem to the specified visible state.

System_CAPS_pubmethodToString()

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

NameDescription
System_CAPS_pubeventAvailableChanged

Occurs when the value of the Available property changes.

System_CAPS_pubeventBackColorChanged

Occurs when the value of the BackColor property changes.

System_CAPS_pubeventClick

Occurs when the ToolStripItem is clicked.

System_CAPS_pubeventDisplayStyleChanged

Occurs when the DisplayStyle has changed.

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.

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.

System_CAPS_pubeventDragEnter

Occurs when the user drags an item into the client area of this item.

System_CAPS_pubeventDragLeave

Occurs when the user drags an item and the mouse pointer is no longer over the client area of this item.

System_CAPS_pubeventDragOver

Occurs when the user drags an item over the client area of this item.

System_CAPS_pubeventEnabledChanged

Occurs when the Enabled property value has changed.

System_CAPS_pubeventForeColorChanged

Occurs when the ForeColor property value changes.

System_CAPS_pubeventGiveFeedback

Occurs during a drag operation.

System_CAPS_pubeventLocationChanged

Occurs when the location of a ToolStripItem is updated.

System_CAPS_pubeventMouseDown

Occurs when the mouse pointer is over the item and a mouse button is pressed.

System_CAPS_pubeventMouseEnter

Occurs when the mouse pointer enters the item.

System_CAPS_pubeventMouseHover

Occurs when the mouse pointer hovers over the item.

System_CAPS_pubeventMouseLeave

Occurs when the mouse pointer leaves the item.

System_CAPS_pubeventMouseMove

Occurs when the mouse pointer is moved over the item.

System_CAPS_pubeventMouseUp

Occurs when the mouse pointer is over the item and a mouse button is released.

System_CAPS_pubeventOwnerChanged

Occurs when the Owner property changes.

System_CAPS_pubeventPaint

Occurs when the item is redrawn.

System_CAPS_pubeventQueryAccessibilityHelp

Occurs when an accessibility client application invokes help for the 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.

System_CAPS_pubeventRightToLeftChanged

Occurs when the RightToLeft property value changes.

System_CAPS_pubeventTextChanged

Occurs when the value of the Text property changes.

System_CAPS_pubeventVisibleChanged

Occurs when the value of the Visible property changes.

A ToolStripItem is an element such as a button, combo box, text box, or label that can be contained in a ToolStrip control or a ToolStripDropDown control, which is similar to a Windows shortcut menu. The ToolStrip class manages the painting and keyboard and mouse input, including drag-and-drop input, for these elements, and the ToolStripItem class manages events and layout within the elements themselves.

ToolStripItem classes either inherit directly from ToolStripItem, or they inherit indirectly from ToolStripItem through ToolStripControlHost or ToolStripDropDownItem.

ToolStripItem controls must be contained in a ToolStrip, MenuStrip, StatusStrip, or ContextMenuStrip and cannot be added directly to a form. The various container classes are designed to contain an appropriate subset of ToolStripItem controls.

Note   A given ToolStripItem cannot have more than one parent ToolStrip. You must copy of the ToolStripItem and add it to other ToolStrip controls.

The following table shows the elements that derive from the ToolStripItem class and which therefore can be hosted in a ToolStrip or ToolStripDropDown.

Element

Description

ToolStripButton

A toolbar button that supports images and text.

ToolStripLabel

A text label typically used in a status bar or ToolStrip as a comment or title.

ToolStripSeparator

A non-selectable space or space with a vertical bar that visually groups elements.

ToolStripControlHost

A ToolStripItem that hosts a ToolStripComboBox, ToolStripTextBox, ToolStripProgressBar, other Windows Forms controls, or custom controls.

A ToolStripComboBox is a text box in which the user can enter text, along with a list from which the user can select text to fill the text box.

A ToolStripTextBox enables the user to enter text.

A ToolStripProgressBar represents a Windows progress bar control contained in a StatusStrip.

ToolStripDropDownItem

A ToolStripItem that hosts a ToolStripMenuItem, ToolStripSplitButton, and ToolStripDropDownButton.

A ToolStripMenuItem is a selectable option displayed on a menu or context menu.

A ToolStripSplitButton is a combination of a regular button and a drop-down button.

A ToolStripDropDownButton is a button that supports drop-down functionality.

ToolStripStatusLabel

A panel in a StatusStrip control.

The following code example demonstrates how to implement a custom ToolStripItem control.

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Drawing.Drawing2D;
using System.Windows.Forms;

namespace RolloverItemDemoLib
{
    // This class implements a ToolStripItem that highlights
    // its border and text when the mouse enters its
    // client rectangle. It has a clickable state which is
    // exposed through the Clicked property and displayed
    // by highlighting or graying out the item's image. 
    public class RolloverItem : ToolStripItem
    {
        private bool clickedValue = false;
        private bool rolloverValue = false;

        private Rectangle imageRect;
        private Rectangle textRect;

        // For brevity, this implementation limits the possible 
        // TextDirection values to ToolStripTextDirection.Horizontal. 
        public override ToolStripTextDirection TextDirection
        {
            get
            {
                return base.TextDirection;
            }
            set
            {
                if (value == ToolStripTextDirection.Horizontal)
                {
                    base.TextDirection = value;
                }
                else
                {
                    throw new ArgumentException(
                        "RolloverItem supports only horizontal text.");
                }
            }
        }

        // For brevity, this implementation limits the possible 
        // TextImageRelation values to ImageBeforeText and TextBeforeImage. 
        public new TextImageRelation TextImageRelation
        {
            get
            {
                return base.TextImageRelation;
            }

            set
            {
                if (value == TextImageRelation.ImageBeforeText || 
                    value == TextImageRelation.TextBeforeImage)
                {
                    base.TextImageRelation = value;
                }
                else
                {
                    throw new ArgumentException(
                        "Unsupported TextImageRelation value.");
                }
            }
        }

        // This property returns true if the mouse is 
        // inside the client rectangle.
        public bool Rollover
        {
            get
            {
                return this.rolloverValue;
            }   
        }

        // This property returns true if the item 
        // has been toggled into the clicked state.
        // Clicking again toggles it to the 
        // unclicked state.
        public bool Clicked
        {
            get
            {
                return this.clickedValue;
            }
        }

        // The method defines the behavior of the Click event.
        // It simply toggles the state of the clickedValue field.
        protected override void OnClick(EventArgs e)
        {
            base.OnClick(e);

            this.clickedValue ^= true;
        }

        // The method defines the behavior of the DoubleClick 
        // event. It shows a MessageBox with the item's text.
        protected override void OnDoubleClick(EventArgs e)
        {
            base.OnDoubleClick(e);

            string msg = String.Format("Item: {0}", this.Text);

            MessageBox.Show(msg);
        }

        // This method defines the behavior of the MouseEnter event.
        // It sets the state of the rolloverValue field to true and
        // tells the control to repaint.
        protected override void OnMouseEnter(EventArgs e)
        {
            base.OnMouseEnter(e);

            this.rolloverValue = true;

            this.Invalidate();
        }

        // This method defines the behavior of the MouseLeave event.
        // It sets the state of the rolloverValue field to false and
        // tells the control to repaint.
        protected override void OnMouseLeave(EventArgs e)
        {
            base.OnMouseLeave(e);

            this.rolloverValue = false;

            this.Invalidate();
        }

        // This method defines the painting behavior of the control.
        // It performs the following operations:
        //
        // Computes the layout of the item's image and text.
        // Draws the item's background image.
        // Draws the item's image.
        // Draws the item's text.
        //
        // Drawing operations are implemented in the 
        // RolloverItemRenderer class.
        protected override void OnPaint(PaintEventArgs e)
        {
            base.OnPaint(e);

            if (this.Owner != null)
            {
                // Find the dimensions of the image and the text 
                // areas of the item. 
                this.ComputeImageAndTextLayout();

                // Draw the background. This includes drawing a highlighted 
                // border when the mouse is in the client area.
                ToolStripItemRenderEventArgs ea = new ToolStripItemRenderEventArgs(
                     e.Graphics,
                     this);
                this.Owner.Renderer.DrawItemBackground(ea);

                // Draw the item's image. 
                ToolStripItemImageRenderEventArgs irea =
                    new ToolStripItemImageRenderEventArgs(
                    e.Graphics,
                    this,
                    imageRect );
                this.Owner.Renderer.DrawItemImage(irea);

                // If the item is on a drop-down, give its
                // text a different highlighted color.
                Color highlightColor = 
                    this.IsOnDropDown ?
                    Color.Salmon : SystemColors.ControlLightLight;

                // Draw the text, and highlight it if the 
                // the rollover state is true.
                ToolStripItemTextRenderEventArgs rea =
                    new ToolStripItemTextRenderEventArgs(
                    e.Graphics,
                    this,
                    base.Text,
                    textRect,
                    this.rolloverValue ? highlightColor : base.ForeColor,
                    base.Font,
                    base.TextAlign);
                this.Owner.Renderer.DrawItemText(rea);
            }
        }

        // This utility method computes the layout of the 
        // RolloverItem control's image area and the text area.
        // For brevity, only the following settings are 
        // supported:
        //
        // ToolStripTextDirection.Horizontal
        // TextImageRelation.ImageBeforeText 
        // TextImageRelation.ImageBeforeText
        // 
        // It would not be difficult to support vertical text
        // directions and other image/text relationships.
        private void ComputeImageAndTextLayout()
        {
            Rectangle cr = base.ContentRectangle;
            Image img = base.Owner.ImageList.Images[base.ImageKey];

            // Compute the center of the item's ContentRectangle.
            int centerY = (cr.Height - img.Height) / 2;

            // Find the dimensions of the image and the text 
            // areas of the item. The text occupies the space 
            // not filled by the image. 
            if (base.TextImageRelation == TextImageRelation.ImageBeforeText &&
                base.TextDirection == ToolStripTextDirection.Horizontal)
            {
                imageRect = new Rectangle(
                    base.ContentRectangle.Left,
                    centerY,
                    base.Image.Width,
                    base.Image.Height);

                textRect = new Rectangle(
                    imageRect.Width,
                    base.ContentRectangle.Top,
                    base.ContentRectangle.Width - imageRect.Width,
                    base.ContentRectangle.Height);
            }
            else if (base.TextImageRelation == TextImageRelation.TextBeforeImage &&
                     base.TextDirection == ToolStripTextDirection.Horizontal)
            {
                imageRect = new Rectangle(
                    base.ContentRectangle.Right - base.Image.Width,
                    centerY,
                    base.Image.Width,
                    base.Image.Height);

                textRect = new Rectangle(
                    base.ContentRectangle.Left,
                    base.ContentRectangle.Top,
                    imageRect.X,
                    base.ContentRectangle.Bottom);
            }
        }
    }

    #region RolloverItemRenderer

    // This is the custom renderer for the RolloverItem control.
    // It draws a border around the item when the mouse is
    // in the item's client area. It also draws the item's image
    // in an inactive state (grayed out) until the user clicks
    // the item to toggle its "clicked" state.
    internal class RolloverItemRenderer : ToolStripSystemRenderer
    {
        protected override void OnRenderItemImage(
            ToolStripItemImageRenderEventArgs e)
        {
            base.OnRenderItemImage(e);

            RolloverItem item = e.Item as RolloverItem;

            // If the ToolSTripItem is of type RolloverItem, 
            // perform custom rendering for the image.
            if (item != null)
            {
                if (item.Clicked)
                {
                    // The item is in the clicked state, so 
                    // draw the image as usual.
                    e.Graphics.DrawImage(
                        e.Image,
                        e.ImageRectangle.X,
                        e.ImageRectangle.Y);
                }
                else
                {
                    // In the unclicked state, gray out the image.
                    ControlPaint.DrawImageDisabled(
                        e.Graphics,
                        e.Image,
                        e.ImageRectangle.X,
                        e.ImageRectangle.Y,
                        item.BackColor);
                }
            }
        }

        // This method defines the behavior for rendering the
        // background of a ToolStripItem. If the item is a
        // RolloverItem, it paints the item's BackgroundImage 
        // centered in the client area. If the mouse is in the 
        // item's client area, a border is drawn around it.
        // If the item is on a drop-down or if it is on the
        // overflow, a gradient is painted in the background.
        protected override void OnRenderItemBackground(
            ToolStripItemRenderEventArgs e)
        {
            base.OnRenderItemBackground(e);

            RolloverItem item = e.Item as RolloverItem;

            // If the ToolSTripItem is of type RolloverItem, 
            // perform custom rendering for the background.
            if (item != null)
            {
                if (item.Placement == ToolStripItemPlacement.Overflow ||
                    item.IsOnDropDown)
                {
                    using (LinearGradientBrush b = new LinearGradientBrush(
                        item.ContentRectangle,
                        Color.Salmon,
                        Color.DarkRed,
                        0f,
                        false))
                    {
                        e.Graphics.FillRectangle(b, item.ContentRectangle);
                    }
                }

                // The RolloverItem control only supports 
                // the ImageLayout.Center setting for the
                // BackgroundImage property.
                if (item.BackgroundImageLayout == ImageLayout.Center)
                {
                    // Get references to the item's ContentRectangle
                    // and BackgroundImage, for convenience.
                    Rectangle cr = item.ContentRectangle;
                    Image bgi = item.BackgroundImage;

                    // Compute the center of the item's ContentRectangle.
                    int centerX = (cr.Width - bgi.Width) / 2;
                    int centerY = (cr.Height - bgi.Height) / 2;

                    // If the item is selected, draw the background
                    // image as usual. Otherwise, draw it as disabled.
                    if (item.Selected)
                    {
                        e.Graphics.DrawImage(bgi, centerX, centerY);
                    }
                    else
                    {
                        ControlPaint.DrawImageDisabled(
                                e.Graphics,
                                bgi,
                                centerX,
                                centerY,
                                item.BackColor);
                    }
                }

                // If the item is in the rollover state, 
                // draw a border around it.
                if (item.Rollover)
                {
                    ControlPaint.DrawFocusRectangle(
                        e.Graphics,
                        item.ContentRectangle);
                }
            }
        }

    #endregion

    }

    // This form tests various features of the RolloverItem
    // control. RolloverItem conrols are created and added
    // to the form's ToolStrip. They are also created and 
    // added to a button's ContextMenuStrip. The behavior
    // of the RolloverItem control differs depending on 
    // the type of parent control.
    public class RolloverItemTestForm : Form
    {
        private System.Windows.Forms.ToolStrip toolStrip1;
        private System.Windows.Forms.Button button1;

        private string infoIconKey = "Information icon";
        private string handIconKey = "Hand icon";
        private string exclIconKey = "Exclamation icon";
        private string questionIconKey = "Question icon";
        private string warningIconKey = "Warning icon ";

        private System.ComponentModel.IContainer components = null;

        public RolloverItemTestForm()
        {
            InitializeComponent();

            // Set up the form's ToolStrip control.
            InitializeToolStrip();

            // Set up the ContextMenuStrip for the button.
            InitializeContextMenu();
        }

        // This utility method initializes the ToolStrip control's 
        // image list. For convenience, icons from the SystemIcons 
        // class are used for this demonstration, but any images
        // could be used.
        private void InitializeImageList(ToolStrip ts)
        {
            if (ts.ImageList == null)
            {
                ts.ImageList = new ImageList();
                ts.ImageList.ImageSize = SystemIcons.Exclamation.Size;

                ts.ImageList.Images.Add(
                    this.infoIconKey,
                    SystemIcons.Information);

                ts.ImageList.Images.Add(
                    this.handIconKey,
                    SystemIcons.Hand);

                ts.ImageList.Images.Add(
                    this.exclIconKey,
                    SystemIcons.Exclamation);

                ts.ImageList.Images.Add(
                    this.questionIconKey,
                    SystemIcons.Question);

                ts.ImageList.Images.Add(
                    this.warningIconKey,
                    SystemIcons.Warning);
            }
        }

        private void InitializeToolStrip()
        {
            this.InitializeImageList(this.toolStrip1);

            this.toolStrip1.Renderer = new RolloverItemRenderer();

            RolloverItem item = this.CreateRolloverItem(
                this.toolStrip1,
                "RolloverItem on ToolStrip",
                this.Font,
                infoIconKey,
                TextImageRelation.ImageBeforeText,
                exclIconKey);

            this.toolStrip1.Items.Add(item);

            item = this.CreateRolloverItem(
                this.toolStrip1,
                "RolloverItem on ToolStrip",
                this.Font,
                infoIconKey,
                TextImageRelation.ImageBeforeText,
                exclIconKey);

            this.toolStrip1.Items.Add(item);
        }

        private void InitializeContextMenu()
        {
            Font f = new System.Drawing.Font(
                "Arial",
                18f,
                FontStyle.Bold);

            ContextMenuStrip cms = new ContextMenuStrip();
            this.InitializeImageList(cms);

            cms.Renderer = new RolloverItemRenderer();
            cms.AutoSize = true;
            cms.ShowCheckMargin = false;
            cms.ShowImageMargin = false;

            RolloverItem item = this.CreateRolloverItem(
                cms,
                "RolloverItem on ContextMenuStrip",
                f,
                handIconKey,
                TextImageRelation.ImageBeforeText,
                exclIconKey);

            cms.Items.Add(item);

            item = this.CreateRolloverItem(
                cms,
                "Another RolloverItem on ContextMenuStrip",
                f,
                questionIconKey,
                TextImageRelation.ImageBeforeText,
                exclIconKey);

            cms.Items.Add(item);

            item = this.CreateRolloverItem(
                cms,
                "And another RolloverItem on ContextMenuStrip",
                f,
                warningIconKey,
                TextImageRelation.ImageBeforeText,
                exclIconKey);

            cms.Items.Add(item);

            cms.Closing += new ToolStripDropDownClosingEventHandler(cms_Closing);

            this.button1.ContextMenuStrip = cms;
        }

        // This method handles the ContextMenuStrip 
        // control's Closing event. It prevents the 
        // RolloverItem from closing the drop-down  
        // when the item is clicked.
        void cms_Closing(object sender, ToolStripDropDownClosingEventArgs e)
        {
            if (e.CloseReason == ToolStripDropDownCloseReason.ItemClicked)
            {
                e.Cancel = true;
            }
        }

        // This method handles the Click event for the button.
        // it selects the first item in the ToolStrip control
        // by using the ToolStripITem.Select method.
        private void button1_Click(object sender, EventArgs e)
        {
            RolloverItem item = this.toolStrip1.Items[0] as RolloverItem;

            if (item != null)
            {
                item.Select();

                this.Invalidate();
            }
        }

        // This utility method creates a RolloverItem 
        // and adds it to a ToolStrip control.
        private RolloverItem CreateRolloverItem(
            ToolStrip owningToolStrip,
            string txt,
            Font f,
            string imgKey,
            TextImageRelation tir,
            string backImgKey)
        {
            RolloverItem item = new RolloverItem();

            item.Alignment = ToolStripItemAlignment.Left;
            item.AllowDrop = false;
            item.AutoSize = true;

            item.BackgroundImage = owningToolStrip.ImageList.Images[backImgKey];
            item.BackgroundImageLayout = ImageLayout.Center;
            item.DisplayStyle = ToolStripItemDisplayStyle.ImageAndText;
            item.DoubleClickEnabled = true;
            item.Enabled = true;
            item.Font = f;

            // These assignments are equivalent. Each assigns an
            // image from the owning toolstrip's image list.
            item.ImageKey = imgKey;
            //item.Image = owningToolStrip.ImageList.Images[infoIconKey];
            //item.ImageIndex = owningToolStrip.ImageList.Images.IndexOfKey(infoIconKey);
            item.ImageScaling = ToolStripItemImageScaling.None;

            item.Owner = owningToolStrip;
            item.Padding = new Padding(2);
            item.Text = txt;
            item.TextAlign = ContentAlignment.MiddleLeft;
            item.TextDirection = ToolStripTextDirection.Horizontal;
            item.TextImageRelation = tir;

            return item;
        }

        protected override void Dispose(bool disposing)
        {
            if (disposing && (components != null))
            {
                components.Dispose();
            }
            base.Dispose(disposing);
        }

        #region Windows Form Designer generated code

        private void InitializeComponent()
        {
            this.toolStrip1 = new System.Windows.Forms.ToolStrip();
            this.button1 = new System.Windows.Forms.Button();
            this.SuspendLayout();
            // 
            // toolStrip1
            // 
            this.toolStrip1.AllowItemReorder = true;
            this.toolStrip1.Location = new System.Drawing.Point(0, 0);
            this.toolStrip1.Name = "toolStrip1";
            this.toolStrip1.Size = new System.Drawing.Size(845, 25);
            this.toolStrip1.TabIndex = 0;
            this.toolStrip1.Text = "toolStrip1";
            // 
            // button1
            // 
            this.button1.Location = new System.Drawing.Point(12, 100);
            this.button1.Name = "button1";
            this.button1.Size = new System.Drawing.Size(86, 23);
            this.button1.TabIndex = 1;
            this.button1.Text = "Click to select";
            this.button1.UseVisualStyleBackColor = true;
            this.button1.Click += new System.EventHandler(this.button1_Click);
            // 
            // RolloverItemTestForm
            // 
            this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 14F);
            this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
            this.AutoSize = true;
            this.ClientSize = new System.Drawing.Size(845, 282);
            this.Controls.Add(this.button1);
            this.Controls.Add(this.toolStrip1);
            this.Font = new System.Drawing.Font("Arial", 8.25F, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, ((byte)(0)));
            this.Name = "RolloverItemTestForm";
            this.Text = "Form1";
            this.ResumeLayout(false);
            this.PerformLayout();

        }

        #endregion
    }

    static class Program
    {   
        [STAThread]
        static void Main()
        {
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            Application.Run(new RolloverItemTestForm());
        }
    }

}

.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