RevealBrush RevealBrush RevealBrush RevealBrush Class

Definition

Base class for brushes that use composition effects and lighting to implement the reveal visual design treatment.

public : class RevealBrush : XamlCompositionBrushBase, IRevealBrushpublic class RevealBrush : XamlCompositionBrushBase, IRevealBrushPublic Class RevealBrush Inherits XamlCompositionBrushBase Implements IRevealBrush// You can use this class in JavaScript.
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Inherited Members

Inherited methods

Inherited properties

Constructors

RevealBrush() RevealBrush() RevealBrush() RevealBrush()

Provides base class initialization behavior for RevealBrush-derived classes.

protected : RevealBrush()protected RevealBrush()Protected Sub New()// You can use this method in JavaScript.

Properties

AlwaysUseFallback AlwaysUseFallback AlwaysUseFallback AlwaysUseFallback

Gets or sets a value that specifies whether the brush is forced to the solid fallback color.

public : PlatForm::Boolean AlwaysUseFallback { get; set; }public bool AlwaysUseFallback { get; set; }Public ReadWrite Property AlwaysUseFallback As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

true to always replace the reveal effect with the solid fallback color. Otherwise, false. The default is false.

Remarks

By default, the reveal effect is replaced with a solid color and default ambient lighting when one of the fallback conditions is met (such as entering battery saver mode). You can set this property to true to always replace the reveal effect with the fallback values. Setting this property will synchronously trigger a transition animation between the normal look and fallback color.

AlwaysUseFallbackProperty AlwaysUseFallbackProperty AlwaysUseFallbackProperty AlwaysUseFallbackProperty

Identifies the AlwaysUseFallback dependency property.

public : static DependencyProperty AlwaysUseFallbackProperty { get; }public static DependencyProperty AlwaysUseFallbackProperty { get; }Public Static ReadOnly Property AlwaysUseFallbackProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the AlwaysUseFallback dependency property.

Color Color Color Color

Gets or sets a value that specifies the base background color for the brush.

public : Color Color { get; set; }public Color Color { get; set; }Public ReadWrite Property Color As Color// You can use this property in JavaScript.
Value
Color Color Color Color

The base background color for the brush. The default value is transparent white (0x00FFFFFF).

ColorProperty ColorProperty ColorProperty ColorProperty

Identifies the Color dependency property.

public : static DependencyProperty ColorProperty { get; }public static DependencyProperty ColorProperty { get; }Public Static ReadOnly Property ColorProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Color dependency property.

StateProperty StateProperty StateProperty StateProperty

Identifies the RevealBrush.State attached property

public : static DependencyProperty StateProperty { get; }public static DependencyProperty StateProperty { get; }Public Static ReadOnly Property StateProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the RevealBrush.State attached property.

TargetTheme TargetTheme TargetTheme TargetTheme

Gets or sets a value that specifies the theme used to draw the brush and light, to ensure that the correct composition effect recipe is used for the desired theme.

public : ApplicationTheme TargetTheme { get; set; }public ApplicationTheme TargetTheme { get; set; }Public ReadWrite Property TargetTheme As ApplicationTheme// You can use this property in JavaScript.

TargetThemeProperty TargetThemeProperty TargetThemeProperty TargetThemeProperty

Identifies the TargetTheme dependency property.

public : static DependencyProperty TargetThemeProperty { get; }public static DependencyProperty TargetThemeProperty { get; }Public Static ReadOnly Property TargetThemeProperty As DependencyProperty// You can use this property in JavaScript.
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the TargetTheme dependency property.

Methods

GetState(UIElement) GetState(UIElement) GetState(UIElement) GetState(UIElement)

Gets the value of the RevealBrush.State XAML attached property for the target element.

public : static RevealBrushState GetState(UIElement element)public static RevealBrushState GetState(UIElement element)Public Static Function GetState(element As UIElement) As RevealBrushState// You can use this method in JavaScript.
Parameters
element
UIElement UIElement UIElement UIElement

The object from which the property value is read.

Returns

The RevealBrush.State XAML attached property value of the specified object.

SetState(UIElement, RevealBrushState) SetState(UIElement, RevealBrushState) SetState(UIElement, RevealBrushState) SetState(UIElement, RevealBrushState)

Sets the value of the RevealBrush.State XAML attached property for a target element.

public : static void SetState(UIElement element, RevealBrushState value)public static void SetState(UIElement element, RevealBrushState value)Public Static Function SetState(element As UIElement, value As RevealBrushState) As void// You can use this method in JavaScript.
Parameters
element
UIElement UIElement UIElement UIElement

The object to which the property value is written.