ToolStripItem.BackColor Property


Gets or sets the background color for the item.

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

Public Overridable Property BackColor As Color

Property Value

Type: System.Drawing.Color

A Color that represents the background color of the item. The default is the value of the DefaultBackColor property.

The BackColor property does not support transparent colors unless the SupportsTransparentBackColor value of System.Windows.Forms.ControlStyles is set to true.

The BackColor property is an ambient property. An ambient property is a control property that, if not set, is retrieved from the parent control. For example, a Button has the same BackColor as its parent Form by default. For more information about ambient properties, see the AmbientProperties class or the Control class overview.

Notes to Inheritors:

When overriding the BackColor property in a derived class, use the base class's BackColor property to extend the base implementation. Otherwise, you must provide all the implementation. You are not required to override both the get and set accessors of the BackColor property; you can override only one if needed.

The following code example demonstrates how to use the BackColor property for custom rendering. This code example is part of a larger example provided for the ToolStripItem class.

Protected Overrides Sub OnRenderItemImage(ByVal e As ToolStripItemImageRenderEventArgs)

    Dim item As RolloverItem = CType(e.Item, RolloverItem)

    ' If the ToolSTripItem is of type RolloverItem, 
    ' perform custom rendering for the image.
    If (item IsNot Nothing) Then
        If item.Clicked Then
            ' The item is in the clicked state, so 
            ' draw the image as usual.
            e.Graphics.DrawImage(e.Image, e.ImageRectangle.X, e.ImageRectangle.Y)
            ' In the unclicked state, gray out the image.
            ControlPaint.DrawImageDisabled(e.Graphics, e.Image, e.ImageRectangle.X, e.ImageRectangle.Y, item.BackColor)
        End If
    End If
End Sub

.NET Framework
Available since 2.0
Return to top