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, IRevealBrush
public class RevealBrush : XamlCompositionBrushBase, IRevealBrush
Public Class RevealBrush Inherits XamlCompositionBrushBase Implements IRevealBrush
var revealBrush = new revealBrush();
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Constructors

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

Provides base class initialization behavior for RevealBrush-derived classes.

protected : RevealBrush()
protected RevealBrush()
Protected Sub New()
var revealBrush = new revealBrush();

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
var bool = revealBrush.alwaysUseFallback;
revealBrush.alwaysUseFallback = bool;
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
var dependencyProperty = Windows.UI.Xaml.Media.RevealBrush.alwaysUseFallbackProperty;
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
var color = revealBrush.color;
revealBrush.color = color;
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
var dependencyProperty = Windows.UI.Xaml.Media.RevealBrush.colorProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the Color dependency property.

CompositionBrush CompositionBrush CompositionBrush CompositionBrush

Inherited from XamlCompositionBrushBase

Dispatcher Dispatcher Dispatcher Dispatcher

Inherited from DependencyObject

FallbackColor FallbackColor FallbackColor FallbackColor

Inherited from XamlCompositionBrushBase

FallbackColorProperty FallbackColorProperty FallbackColorProperty FallbackColorProperty

Inherited from XamlCompositionBrushBase

Opacity Opacity Opacity Opacity

Inherited from Brush

OpacityProperty OpacityProperty OpacityProperty OpacityProperty

Inherited from Brush

RelativeTransform RelativeTransform RelativeTransform RelativeTransform

Inherited from Brush

RelativeTransformProperty RelativeTransformProperty RelativeTransformProperty RelativeTransformProperty

Inherited from Brush

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
var dependencyProperty = Windows.UI.Xaml.Media.RevealBrush.stateProperty;
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
var applicationTheme = revealBrush.targetTheme;
revealBrush.targetTheme = applicationTheme;

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
var dependencyProperty = Windows.UI.Xaml.Media.RevealBrush.targetThemeProperty;
Value
DependencyProperty DependencyProperty DependencyProperty DependencyProperty

The identifier for the TargetTheme dependency property.

Transform Transform Transform Transform

Inherited from Brush

TransformProperty TransformProperty TransformProperty TransformProperty

Inherited from Brush

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Inherited from DependencyObject

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Inherited from DependencyObject

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
var revealBrushState = Windows.UI.Xaml.Media.RevealBrush.getState(element);
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.

GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Inherited from DependencyObject

OnConnected OnConnected OnConnected OnConnected

Inherited from XamlCompositionBrushBase

OnDisconnected OnDisconnected OnDisconnected OnDisconnected

Inherited from XamlCompositionBrushBase

ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Inherited from DependencyObject

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Inherited from DependencyObject

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
Windows.UI.Xaml.Media.RevealBrush.setState(element, value);
Parameters
element
UIElement UIElement UIElement UIElement

The object to which the property value is written.

SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Inherited from DependencyObject

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Inherited from DependencyObject

See Also