Skip to main content
.NET Framework Class Library
UIElementOpacityMask Property

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)
Syntax
Public Property OpacityMask As [%$TOPIC/ms588745_en-us_VS_110_2_0_0_0_0%]
public [%$TOPIC/ms588745_en-us_VS_110_2_0_1_0_0%] OpacityMask { get; set; }
public:
property [%$TOPIC/ms588745_en-us_VS_110_2_0_2_0_0%]^ OpacityMask {
	[%$TOPIC/ms588745_en-us_VS_110_2_0_2_0_1%]^ get ();
	void set ([%$TOPIC/ms588745_en-us_VS_110_2_0_2_0_2%]^ value);
}
member OpacityMask : [%$TOPIC/ms588745_en-us_VS_110_2_0_3_0_0%] with get, set

Property Value

Type: System.Windows.MediaBrush
The brush to use for opacity masking.
Dependency Property Information

Identifier field

OpacityMaskProperty

Metadata properties set to true

None

Remarks

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.

Examples

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

<!-- With the Opacity Mask-->
<Image
  Height="150"
  Width="200"
  Source="sampleImages/Waterlilies.jpg"
  HorizontalAlignment="Left"
  Margin="10"
  Grid.Column="2" Grid.Row="1">
  <Image.OpacityMask>
    <ImageBrush ImageSource="sampleImages/tornedges.png"/>
  </Image.OpacityMask>
</Image>
Version Information

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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