TextBlock.GetAlphaMask TextBlock.GetAlphaMask TextBlock.GetAlphaMask TextBlock.GetAlphaMask Method

Definition

Returns a mask that represents the alpha channel of the text as a CompositionBrush.

public : CompositionBrush GetAlphaMask()
CompositionBrush GetAlphaMask() const;
public CompositionBrush GetAlphaMask()
Public Function GetAlphaMask() As CompositionBrush

Returns

A mask that represents the alpha channel of the text in a TextBlock.

Additional features and requirements

Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Remarks

This method gets an alpha mask from the text as a CompositionBrush that you can use as an input to composition shadows and effects. The alpha mask CompositionBrush has the same alignment and stretch property values that the source XAML element applies to its rendered content so that you can use those values to correctly position shadows or effects relative to the XAML element.

Version compatibility

The GetAlphaMask method is not available prior to Windows 10, version 1607. If your app’s 'minimum platform version' setting in Microsoft Visual Studio is less than the 'introduced version' shown in the Requirements block later in this page, you must design and test your app to account for this. For more info, see Version adaptive code.

To avoid exceptions when your app runs on previous versions of Windows 10, do not call this method without first performing a runtime check. This example shows how to use the ApiInformation class to check for the presence of this method before you use it.

if (ApiInformation.IsMethodPresent("Windows.UI.Xaml.Controls.TextBlock", "GetAlphaMask"))
{
    var compositionBrush = textBlock1.GetAlphaMask();
}