Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 3.22 KB

control_borderbrush.md

File metadata and controls

48 lines (34 loc) · 3.22 KB
Raw
-api-id -api-type
P:Windows.UI.Xaml.Controls.Control.BorderBrush
winrt property

Windows.UI.Xaml.Controls.Control.BorderBrush

-description

Gets or sets a brush that describes the border fill of a control.

-xaml-syntax

<control Background="{StaticResource resourceName}"/>
- or -
<control Background="colorString"/>
- or -
<control>
  <control.Background>singleBrush</control.Background>
</control>

-xaml-values

resourceName
resourceNameThe resource name (x:Key attribute value) of an existing XAML resource that defines a brush. This is the recommended way to specify Brush values in XAML if you have any intention of using the same colors or brushes in more than one part of your UI. See Remarks in Brush or ResourceDictionary and XAML resource references.
colorString
colorStringThe Color for a SolidColorBrush expressed as an attribute string. This can be a named color, an RGB value, or an ScRGB value. RGB or ScRGB may also specify alpha information. See the XAML Values section in Color.
singleBrush
singleBrushWithin opening and closing property elements, exactly one object element for an object that derives from Brush. This is typically one of the following classes: LinearGradientBrush, ImageBrush, SolidColorBrush.
## -property-value The brush that is used to fill the control's border. The default is **null**, (a null brush) which is evaluated as [Transparent](../windows.ui/colors_transparent.md) for rendering.

-remarks

Each control might apply this property differently based on its visual template. This property only affects a control whose template uses the BorderBrush property as an input for the template's UI properties. On other controls, this property has no effect. Typically, if it wants to display a border, a control uses a {TemplateBinding} markup extension to bind its BorderBrush value to the BorderBrush of a Border that is the root element of the control template. For more info about visual templates and control templating, see Styling controls or the reference page for the Template property.

Starting in Windows 10, version 1607 (Windows Software Development Kit (SDK) version 10.0.14393.0), generic.xaml includes resources that you can use to modify the colors of a control in different visual states without modifying the control template. In apps that target this software development kit (SDK) or later, modifying these resources is preferred to setting properties such as Background, Foreground, and BorderBrush. For more info, see the Light-weight styling section of the XAML styles article.

The BorderThickness value must be greater than 0 in order to see the BorderBrush value take effect.

-examples

-see-also

Border, Use brushes