ToolStripItem.BackColor Property

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the background color for the item.

public:
 virtual property System::Drawing::Color BackColor { System::Drawing::Color get(); void set(System::Drawing::Color value); };

public virtual System.Drawing.Color BackColor { get; set; }

member this.BackColor : System.Drawing.Color with get, set

Public Overridable Property BackColor As Color

Property Value

Color

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

Examples

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 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);
        }
    }
}

Protected Overrides Sub OnRenderItemImage(ByVal e As ToolStripItemImageRenderEventArgs)
    MyBase.OnRenderItemImage(e)

    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)
        Else
            ' 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

Remarks

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.

Applies to

Share via