Control.Background Property (System.Windows.Controls)

Background Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework 3.0

.NET Framework Class Library

Control..::.Background Property

Updated: November 2007

Gets or sets a brush that describes the background of a control. This is a dependency property.

Namespace: System.Windows.Controls
Assembly: PresentationFramework (in PresentationFramework.dll)

Syntax

Visual Basic (Declaration)

<BindableAttribute(True)> _
Public Property Background As Brush

Visual Basic (Usage)

Dim instance As Control
Dim value As Brush

value = instance.Background

instance.Background = value

[BindableAttribute(true)]
public Brush Background { get; set; }

Visual C++

[BindableAttribute(true)]
public:
property Brush^ Background {
    Brush^ get ();
    void set (Brush^ value);
}

/** @property */
/** @attribute BindableAttribute(true) */
public Brush get_Background()
/** @property */
/** @attribute BindableAttribute(true) */
public  void set_Background(Brush value)

JScript

public function get Background () : Brush
public function set Background (value : Brush)

XAML

For XAML information, see the Brush type.

Property Value

Type: System.Windows.Media..::.Brush

The brush that is used to fill the background of the control. The default is Brushes..::.Transparent.

Dependency Property Information

Identifier field	BackgroundProperty
Metadata properties set to true	AffectsRender, SubPropertiesDoNotAffectRender

Remarks

The Background property applies only to the resting state of a control. The default style of the control specifies its appearance when the state of the control changes. For example, if you set the Background property on a Button, the button has that value only when it is not pressed or disabled. If you want to create a control that has a more advanced customization of the background, you must define the control's style.

This property only affects a control whose template uses the Background property as a parameter. On other controls, this property has no impact.

Examples

The following example shows how to set the background property of a control.

<Button Name="btn" Background="Red" 
        Click="ChangeBackground">
  Background
</Button>

Visual Basic

Private Sub ChangeBackground(ByVal Sender As Object, ByVal e As RoutedEventArgs)

    If (Equals(btn.Background, Brushes.Red)) Then

        btn.Background = New LinearGradientBrush(Colors.LightBlue, Colors.SlateBlue, 90)
        btn.Content = "Control background changes from red to a blue gradient."

    Else

        btn.Background = Brushes.Red
        btn.Content = "Background"

    End If
End Sub

void ChangeBackground(object sender, RoutedEventArgs e)
{
    if (btn.Background == Brushes.Red)
    {
        btn.Background = new LinearGradientBrush(Colors.LightBlue, Colors.SlateBlue, 90);
        btn.Content = "Control background changes from red to a blue gradient.";
    }
    else
    {
        btn.Background = Brushes.Red;
        btn.Content = "Background";
    }
}

The following example shows a template that enables a trigger to change the background of a button when it is pressed.

<Button FontSize="16" FontWeight="Bold">Click the Background
  <Button.Template>
    <ControlTemplate TargetType="{x:Type Button}">
      <Border Background="{TemplateBinding Background}">
         <ContentPresenter/>
      </Border>
    </ControlTemplate>
  </Button.Template>

  <Button.Style>
    <Style TargetType="{x:Type Button}">
      <Setter Property="Background" Value="Blue"/>
      <Style.Triggers>
        <Trigger Property="IsPressed" Value="true">
          <Setter Property="Background" Value="Red"/>
        </Trigger>
      </Style.Triggers>
    </Style>
  </Button.Style>
</Button>

Platforms

Windows Vista

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information