UIElement.OpacityMask Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets an opacity mask, as a Brush implementation that is applied to any alpha-channel masking for the rendered content of this element. This is a dependency property.

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

public Brush OpacityMask { get; set; }

Property Value

Type: System.Windows.Media.Brush

The brush to use for opacity masking.

This property only uses whatever the alpha channel value is for the supplied Brush. The other channels of the Brush's rendered content (Red, Green, or Blue) are ignored.

The most typical Brush for this purpose is an ImageBrush, which can be used for a variety of photo masking techniques such as a vignette. But any defined Brush (such as LinearGradientBrush) can be used.

In Extensible Application Markup Language (XAML), this property value can use an inline syntax that is specific to each implementation of the Brush abstract class. For more information, see Painting with Solid Colors and Gradients Overview.

Identifier field

OpacityMaskProperty

Metadata properties set to true

None

The following markup example shows an ImageBrush opacity mask applied to another Image.

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: