ToolStripSplitButton Class

Definition

Represents a combination of a standard button on the left and a drop-down button on the right, or the other way around if the value of RightToLeft is Yes.

public ref class ToolStripSplitButton : System::Windows::Forms::ToolStripDropDownItem
[System.Windows.Forms.Design.ToolStripItemDesignerAvailability(System.Windows.Forms.Design.ToolStripItemDesignerAvailability.StatusStrip | System.Windows.Forms.Design.ToolStripItemDesignerAvailability.ToolStrip)]
public class ToolStripSplitButton : System.Windows.Forms.ToolStripDropDownItem
type ToolStripSplitButton = class
    inherit ToolStripDropDownItem
Public Class ToolStripSplitButton
Inherits ToolStripDropDownItem
Inheritance
Attributes

Remarks

ToolStripSplitButton combines button and drop-down button functionality.

Use the DefaultItem property to synchronize the Click event of the chosen drop-down item with the item shown on the button.

Constructors

ToolStripSplitButton()

Initializes a new instance of the ToolStripSplitButton class.

ToolStripSplitButton(Image)

Initializes a new instance of the ToolStripSplitButton class with the specified image.

ToolStripSplitButton(String)

Initializes a new instance of the ToolStripSplitButton class with the specified text.

ToolStripSplitButton(String, Image)

Initializes a new instance of the ToolStripSplitButton class with the specified text and image.

ToolStripSplitButton(String, Image, EventHandler)

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

ToolStripSplitButton(String, Image, EventHandler, String)

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

ToolStripSplitButton(String, Image, ToolStripItem[])

Initializes a new instance of the ToolStripSplitButton class with the specified text, image, and ToolStripItem array.

Properties

AccessibilityObject

Gets the AccessibleObject assigned to the control.

(Inherited from ToolStripItem)
AccessibleDefaultActionDescription

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

(Inherited from ToolStripItem)
AccessibleDescription

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

(Inherited from ToolStripItem)
AccessibleName

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

(Inherited from ToolStripItem)
AccessibleRole

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

(Inherited from ToolStripItem)
Alignment

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

(Inherited from ToolStripItem)
AllowDrop

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

(Inherited from ToolStripItem)
Anchor

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)
AutoSize

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

(Inherited from ToolStripItem)
AutoToolTip

Gets or sets a value indicating whether default or custom ToolTip text is displayed on the ToolStripSplitButton.

Available

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

(Inherited from ToolStripItem)
BackColor

Gets or sets the background color for the item.

(Inherited from ToolStripItem)
BackgroundImage

Gets or sets the background image displayed in the item.

(Inherited from ToolStripItem)
BackgroundImageLayout

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

(Inherited from ToolStripItem)
Bounds

Gets the size and location of the item.

(Inherited from ToolStripItem)
ButtonBounds

Gets the size and location of the standard button portion of a ToolStripSplitButton.

ButtonPressed

Gets a value indicating whether the button portion of the ToolStripSplitButton is in the pressed state.

ButtonSelected

Gets a value indicating whether the standard button portion of a ToolStripSplitButton is selected or the DropDownButtonPressed property is true.

CanRaiseEvents

Gets a value indicating whether the component can raise an event.

(Inherited from Component)
CanSelect

Gets a value indicating whether the item can be selected.

(Inherited from ToolStripItem)
Container

Gets the IContainer that contains the Component.

(Inherited from Component)
ContentRectangle

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

(Inherited from ToolStripItem)
DefaultAutoToolTip

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

DefaultDisplayStyle

Gets a value indicating what is displayed on the ToolStripItem.

(Inherited from ToolStripItem)
DefaultItem

Gets or sets the portion of the ToolStripSplitButton that is activated when the control is first selected.

DefaultMargin

Gets the default margin of an item.

(Inherited from ToolStripItem)
DefaultPadding

Gets the internal spacing characteristics of the item.

(Inherited from ToolStripItem)
DefaultSize

Gets the default size of the item.

(Inherited from ToolStripItem)
DesignMode

Gets a value that indicates whether the Component is currently in design mode.

(Inherited from Component)
DismissWhenClicked

Gets a value indicating whether items on a ToolStripSplitButton are hidden after they are clicked.

DisplayStyle

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

(Inherited from ToolStripItem)
Dock

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)
DoubleClickEnabled

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

(Inherited from ToolStripItem)
DropDown

Gets or sets the ToolStripDropDown that will be displayed when this ToolStripDropDownItem is clicked.

(Inherited from ToolStripDropDownItem)
DropDownButtonBounds

Gets the size and location, in screen coordinates, of the drop-down button portion of a ToolStripSplitButton.

DropDownButtonPressed

Gets a value indicating whether the drop-down portion of the ToolStripSplitButton is in the pressed state.

DropDownButtonSelected

Gets a value indicating whether the drop-down button portion of a ToolStripSplitButton is selected.

DropDownButtonWidth

The width, in pixels, of the drop-down button portion of a ToolStripSplitButton.

DropDownDirection

Gets or sets a value indicating the direction in which the ToolStripDropDownItem emerges from its parent container.

(Inherited from ToolStripDropDownItem)
DropDownItems

Gets the collection of items in the ToolStripDropDown that is associated with this ToolStripDropDownItem.

(Inherited from ToolStripDropDownItem)
DropDownLocation

Gets the screen coordinates, in pixels, of the upper-left corner of the ToolStripDropDownItem.

(Inherited from ToolStripDropDownItem)
Enabled

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

(Inherited from ToolStripItem)
Events

Gets the list of event handlers that are attached to this Component.

(Inherited from Component)
Font

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

(Inherited from ToolStripItem)
ForeColor

Gets or sets the foreground color of the item.

(Inherited from ToolStripItem)
HasDropDown

Gets or sets a value that indicates whether the DropDown for the ToolStripDropDownItem has been created.

(Inherited from ToolStripDropDownItem)
HasDropDownItems

Gets a value indicating whether the ToolStripDropDownItem has ToolStripDropDown controls associated with it.

(Inherited from ToolStripDropDownItem)
Height

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

(Inherited from ToolStripItem)
Image

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

(Inherited from ToolStripItem)
ImageAlign

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

(Inherited from ToolStripItem)
ImageIndex

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

(Inherited from ToolStripItem)
ImageKey

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

(Inherited from ToolStripItem)
ImageScaling

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

(Inherited from ToolStripItem)
ImageTransparentColor

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

(Inherited from ToolStripItem)
IsDisposed

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

(Inherited from ToolStripItem)
IsOnDropDown

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

(Inherited from ToolStripItem)
IsOnOverflow

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

(Inherited from ToolStripItem)
Margin

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

(Inherited from ToolStripItem)
MergeAction

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

(Inherited from ToolStripItem)
MergeIndex

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

(Inherited from ToolStripItem)
Name

Gets or sets the name of the item.

(Inherited from ToolStripItem)
Overflow

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

(Inherited from ToolStripItem)
Owner

Gets or sets the owner of this item.

(Inherited from ToolStripItem)
OwnerItem

Gets the parent ToolStripItem of this ToolStripItem.

(Inherited from ToolStripItem)
Padding

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

(Inherited from ToolStripItem)
Parent

Gets or sets the parent container of the ToolStripItem.

(Inherited from ToolStripItem)
Placement

Gets the current layout of the item.

(Inherited from ToolStripItem)
Pressed

Gets a value indicating whether the ToolStripDropDownItem is in the pressed state.

(Inherited from ToolStripDropDownItem)
RightToLeft

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.

(Inherited from ToolStripItem)
RightToLeftAutoMirrorImage

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

(Inherited from ToolStripItem)
Selected

Gets a value indicating whether the item is selected.

(Inherited from ToolStripItem)
ShowKeyboardCues

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

(Inherited from ToolStripItem)
Site

Gets or sets the ISite of the Component.

(Inherited from Component)
Size

Gets or sets the size of the item.

(Inherited from ToolStripItem)
SplitterBounds

Gets the boundaries of the separator between the standard and drop-down button portions of a ToolStripSplitButton.

Tag

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

(Inherited from ToolStripItem)
Text

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

(Inherited from ToolStripItem)
TextAlign

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

(Inherited from ToolStripItem)
TextDirection

Gets the orientation of text used on a ToolStripItem.

(Inherited from ToolStripItem)
TextImageRelation

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

(Inherited from ToolStripItem)
ToolTipText

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

(Inherited from ToolStripItem)
Visible

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

(Inherited from ToolStripItem)
Width

Gets or sets the width in pixels of a ToolStripItem.

(Inherited from ToolStripItem)

Methods

CreateAccessibilityInstance()

Creates a new accessibility object for the ToolStripSplitButton.

CreateDefaultDropDown()

Creates a generic ToolStripDropDown for which events can be defined.

CreateObjRef(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)
Dispose()

Releases all resources used by the Component.

(Inherited from Component)
Dispose(Boolean)

Releases the unmanaged resources used by the ToolStripDropDownItem and optionally releases the managed resources.

(Inherited from ToolStripDropDownItem)
DoDragDrop(Object, DragDropEffects)

Begins a drag-and-drop operation.

(Inherited from ToolStripItem)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetCurrentParent()

Retrieves the ToolStrip that is the container of the current ToolStripItem.

(Inherited from ToolStripItem)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetPreferredSize(Size)

Retrieves the size of a rectangular area into which a ToolStripSplitButton can be fitted.

GetService(Type)

Returns an object that represents a service provided by the Component or by its Container.

(Inherited from Component)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
HideDropDown()

Makes a visible ToolStripDropDown hidden.

(Inherited from ToolStripDropDownItem)
InitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
Invalidate()

Invalidates the entire surface of the ToolStripItem and causes it to be redrawn.

(Inherited from ToolStripItem)
Invalidate(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)
IsInputChar(Char)

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

(Inherited from ToolStripItem)
IsInputKey(Keys)

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

(Inherited from ToolStripItem)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
OnAvailableChanged(EventArgs)

Raises the AvailableChanged event.

(Inherited from ToolStripItem)
OnBackColorChanged(EventArgs)

Raises the BackColorChanged event.

(Inherited from ToolStripItem)
OnBoundsChanged()

Occurs when the Bounds property changes.

(Inherited from ToolStripDropDownItem)
OnButtonClick(EventArgs)

Raises the ButtonClick event.

OnButtonDoubleClick(EventArgs)

Raises the ButtonDoubleClick event.

OnClick(EventArgs)

Raises the Click event.

(Inherited from ToolStripItem)
OnDefaultItemChanged(EventArgs)

Raises the DefaultItemChanged event.

OnDisplayStyleChanged(EventArgs)

Raises the DisplayStyleChanged event.

(Inherited from ToolStripItem)
OnDoubleClick(EventArgs)

Raises the DoubleClick event.

(Inherited from ToolStripItem)
OnDragDrop(DragEventArgs)

Raises the DragDrop event.

(Inherited from ToolStripItem)
OnDragEnter(DragEventArgs)

Raises the DragEnter event.

(Inherited from ToolStripItem)
OnDragLeave(EventArgs)

Raises the DragLeave event.

(Inherited from ToolStripItem)
OnDragOver(DragEventArgs)

Raises the DragOver event.

(Inherited from ToolStripItem)
OnDropDownClosed(EventArgs)

Raises the DropDownClosed event.

(Inherited from ToolStripDropDownItem)
OnDropDownHide(EventArgs)

Raised in response to the HideDropDown() method.

(Inherited from ToolStripDropDownItem)
OnDropDownItemClicked(ToolStripItemClickedEventArgs)

Raises the DropDownItemClicked event.

(Inherited from ToolStripDropDownItem)
OnDropDownOpened(EventArgs)

Raises the DropDownOpened event.

(Inherited from ToolStripDropDownItem)
OnDropDownShow(EventArgs)

Raised in response to the ShowDropDown() method.

(Inherited from ToolStripDropDownItem)
OnEnabledChanged(EventArgs)

Raises the EnabledChanged event.

(Inherited from ToolStripItem)
OnFontChanged(EventArgs)

Raises the FontChanged event.

(Inherited from ToolStripDropDownItem)
OnForeColorChanged(EventArgs)

Raises the ForeColorChanged event.

(Inherited from ToolStripItem)
OnGiveFeedback(GiveFeedbackEventArgs)

Raises the GiveFeedback event.

(Inherited from ToolStripItem)
OnLayout(LayoutEventArgs)

Raises the Layout event.

(Inherited from ToolStripItem)
OnLocationChanged(EventArgs)

Raises the LocationChanged event.

(Inherited from ToolStripItem)
OnMouseDown(MouseEventArgs)

Raises the MouseDown event.

OnMouseEnter(EventArgs)

Raises the MouseEnter event.

(Inherited from ToolStripItem)
OnMouseHover(EventArgs)

Raises the MouseHover event.

(Inherited from ToolStripItem)
OnMouseLeave(EventArgs)

Raises the MouseLeave event.

OnMouseMove(MouseEventArgs)

Raises the MouseMove event.

(Inherited from ToolStripItem)
OnMouseUp(MouseEventArgs)

Raises the MouseUp event.

OnOwnerChanged(EventArgs)

Raises the OwnerChanged event.

(Inherited from ToolStripItem)
OnOwnerFontChanged(EventArgs)

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

(Inherited from ToolStripItem)
OnPaint(PaintEventArgs)

Raises the Paint event.

OnParentBackColorChanged(EventArgs)

Raises the BackColorChanged event.

(Inherited from ToolStripItem)
OnParentChanged(ToolStrip, ToolStrip)

Raises the ParentChanged event.

(Inherited from ToolStripItem)
OnParentEnabledChanged(EventArgs)

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

(Inherited from ToolStripItem)
OnParentForeColorChanged(EventArgs)

Raises the ForeColorChanged event.

(Inherited from ToolStripItem)
OnParentRightToLeftChanged(EventArgs)

Raises the RightToLeftChanged event.

(Inherited from ToolStripItem)
OnQueryContinueDrag(QueryContinueDragEventArgs)

Raises the QueryContinueDrag event.

(Inherited from ToolStripItem)
OnRightToLeftChanged(EventArgs)

Raises the RightToLeftChanged event.

OnTextChanged(EventArgs)

Raises the TextChanged event.

(Inherited from ToolStripItem)
OnVisibleChanged(EventArgs)

Raises the VisibleChanged event.

(Inherited from ToolStripItem)
PerformButtonClick()

If the Enabled property is true, calls the OnButtonClick(EventArgs) method.

PerformClick()

Generates a Click event for a ToolStripItem.

(Inherited from ToolStripItem)
ProcessCmdKey(Message, Keys)

Processes a command key.

(Inherited from ToolStripDropDownItem)
ProcessDialogKey(Keys)

Processes a dialog key.

ProcessMnemonic(Char)

Processes a mnemonic character.

ResetBackColor()

This method is not relevant to this class.

(Inherited from ToolStripItem)
ResetDisplayStyle()

This method is not relevant to this class.

(Inherited from ToolStripItem)
ResetDropDownButtonWidth()

This method is not relevant to this class.

ResetFont()

This method is not relevant to this class.

(Inherited from ToolStripItem)
ResetForeColor()

This method is not relevant to this class.

(Inherited from ToolStripItem)
ResetImage()

This method is not relevant to this class.

(Inherited from ToolStripItem)
ResetMargin()

This method is not relevant to this class.

(Inherited from ToolStripItem)
ResetPadding()

This method is not relevant to this class.

(Inherited from ToolStripItem)
ResetRightToLeft()

This method is not relevant to this class.

(Inherited from ToolStripItem)
ResetTextDirection()

This method is not relevant to this class.

(Inherited from ToolStripItem)
Select()

Selects the item.

(Inherited from ToolStripItem)
SetBounds(Rectangle)

Sets the size and location of the item.

(Inherited from ToolStripItem)
SetVisibleCore(Boolean)

Sets the ToolStripItem to the specified visible state.

(Inherited from ToolStripItem)
ShowDropDown()

Displays the ToolStripDropDownItem control associated with this ToolStripDropDownItem.

(Inherited from ToolStripDropDownItem)
ToString()

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

(Inherited from ToolStripItem)

Events

AvailableChanged

Occurs when the value of the Available property changes.

(Inherited from ToolStripItem)
BackColorChanged

Occurs when the value of the BackColor property changes.

(Inherited from ToolStripItem)
ButtonClick

Occurs when the standard button portion of a ToolStripSplitButton is clicked.

ButtonDoubleClick

Occurs when the standard button portion of a ToolStripSplitButton is double-clicked.

Click

Occurs when the ToolStripItem is clicked.

(Inherited from ToolStripItem)
DefaultItemChanged

Occurs when the DefaultItem has changed.

DisplayStyleChanged

Occurs when the DisplayStyle has changed.

(Inherited from ToolStripItem)
Disposed

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

(Inherited from Component)
DoubleClick

Occurs when the item is double-clicked with the mouse.

(Inherited from ToolStripItem)
DragDrop

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)
DragEnter

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

(Inherited from ToolStripItem)
DragLeave

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

(Inherited from ToolStripItem)
DragOver

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

(Inherited from ToolStripItem)
DropDownClosed

Occurs when the ToolStripDropDown closes.

(Inherited from ToolStripDropDownItem)
DropDownItemClicked

Occurs when the ToolStripDropDown is clicked.

(Inherited from ToolStripDropDownItem)
DropDownOpened

Occurs when the ToolStripDropDown has opened.

(Inherited from ToolStripDropDownItem)
DropDownOpening

Occurs as the ToolStripDropDown is opening.

(Inherited from ToolStripDropDownItem)
EnabledChanged

Occurs when the Enabled property value has changed.

(Inherited from ToolStripItem)
ForeColorChanged

Occurs when the ForeColor property value changes.

(Inherited from ToolStripItem)
GiveFeedback

Occurs during a drag operation.

(Inherited from ToolStripItem)
LocationChanged

Occurs when the location of a ToolStripItem is updated.

(Inherited from ToolStripItem)
MouseDown

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

(Inherited from ToolStripItem)
MouseEnter

Occurs when the mouse pointer enters the item.

(Inherited from ToolStripItem)
MouseHover

Occurs when the mouse pointer hovers over the item.

(Inherited from ToolStripItem)
MouseLeave

Occurs when the mouse pointer leaves the item.

(Inherited from ToolStripItem)
MouseMove

Occurs when the mouse pointer is moved over the item.

(Inherited from ToolStripItem)
MouseUp

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

(Inherited from ToolStripItem)
OwnerChanged

Occurs when the Owner property changes.

(Inherited from ToolStripItem)
Paint

Occurs when the item is redrawn.

(Inherited from ToolStripItem)
QueryAccessibilityHelp

Occurs when an accessibility client application invokes help for the ToolStripItem.

(Inherited from ToolStripItem)
QueryContinueDrag

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)
RightToLeftChanged

Occurs when the RightToLeft property value changes.

(Inherited from ToolStripItem)
TextChanged

Occurs when the value of the Text property changes.

(Inherited from ToolStripItem)
VisibleChanged

Occurs when the value of the Visible property changes.

(Inherited from ToolStripItem)

Explicit Interface Implementations

IDropTarget.OnDragDrop(DragEventArgs)

Raises the DragDrop event.

(Inherited from ToolStripItem)
IDropTarget.OnDragEnter(DragEventArgs)

Raises the DragEnter event.

(Inherited from ToolStripItem)
IDropTarget.OnDragLeave(EventArgs)

Raises the DragLeave event.

(Inherited from ToolStripItem)
IDropTarget.OnDragOver(DragEventArgs)

Raises the DragOver event.

(Inherited from ToolStripItem)

Applies to

See also