IconElement.Foreground Property

Definition

Namespace:

Windows.UI.Xaml.Controls

Gets or sets a brush that describes the foreground color.

public:
 property Brush ^ Foreground { Brush ^ get(); void set(Brush ^ value); };

Brush Foreground();

void Foreground(Brush value);

public Brush Foreground { get; set; }

var brush = iconElement.foreground;
iconElement.foreground = brush;

Public Property Foreground As Brush

<icon Foreground="{StaticResource resourceName}"/>
- or -
<icon Foreground="colorString"/>

Property Value

Brush

The brush that paints the foreground of the control. The default is null, (a null brush) which is evaluated as Transparent for rendering. However, this value is typically set by a default system resource at runtime, which is tied to the active theme and other settings.

Examples

This example shows an AppBarButton that uses a SymbolIcon with its Foreground set to "Green".

<AppBarButton Label="Accept">
    <AppBarButton.Icon>
        <SymbolIcon Symbol="Accept" Foreground="Green"/>
    </AppBarButton.Icon>
</AppBarButton>

Remarks

You can set the Foreground property on the AppBarButton or on an IconElement derived icon. If you set the Foreground on the AppBarButton, it's applied only to the default visual state. It's not applied to the other visual states defined in the AppBarButton template, like MouseOver. If you set the Foreground on the IconElement derived icon, the color is applied to all visual states.

The only valid Brush type for the Foreground value is SolidColorBrush. If you attempt to use a brush that's not declaring a solid color, the value is ignored at run time and replaced with a SolidColorBrush that is white or black, depending on the current theme.

Foreground replaces the color information from a BitmapIcon.UriSource source file. Any non-transparent pixel in the source image is replaced with the Foreground color.

See also

• UriSource
• SymbolIcon
• Adding app bars
• Use brushes