RevealBrush RevealBrush RevealBrush RevealBrush RevealBrush Class


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

public : class RevealBrush : XamlCompositionBrushBase
struct winrt::Windows::UI::Xaml::Media::RevealBrush : XamlCompositionBrushBase
public class RevealBrush : XamlCompositionBrushBase
Public Class RevealBrush Inherits XamlCompositionBrushBase
var revealBrush = new revealBrush();

Windows 10 requirements

Device family
Windows 10 Fall Creators Update (introduced v10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)



For more info, design guidance, and code examples, see Reveal Highlight.

If you have the XAML Controls Gallery app installed, click here to open the app and see Reveal in action.


XAML attached properties

RevealBrush is the host service class for a XAML attached property.

In order to support XAML processor access to the attached properties, and also to expose equivalent get and set operations to code, each XAML attached property has a pair of Get and Set accessor methods. Another way to get or set the value in code is to use the dependency property system, calling either GetValue or SetValue and passing the identifier field as the dependency property identifier.

Attached property Description
State Gets or sets a value that indicates the pointer state of the element that this brush is used on.


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

Provides base class initialization behavior for RevealBrush-derived classes.


AlwaysUseFallback AlwaysUseFallback AlwaysUseFallback AlwaysUseFallback AlwaysUseFallback

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

AlwaysUseFallbackProperty AlwaysUseFallbackProperty AlwaysUseFallbackProperty AlwaysUseFallbackProperty AlwaysUseFallbackProperty

Identifies the AlwaysUseFallback dependency property.

Color Color Color Color Color

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

ColorProperty ColorProperty ColorProperty ColorProperty ColorProperty

Identifies the Color dependency property.

CompositionBrush CompositionBrush CompositionBrush CompositionBrush CompositionBrush

Gets or sets the CompositionBrush used by this XAML brush.

(Inherited from XamlCompositionBrushBase)
Dispatcher Dispatcher Dispatcher Dispatcher Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

(Inherited from DependencyObject)
FallbackColor FallbackColor FallbackColor FallbackColor FallbackColor

The color to use for rendering in case the CompositionBrush can't be rendered.

(Inherited from XamlCompositionBrushBase)
FallbackColorProperty FallbackColorProperty FallbackColorProperty FallbackColorProperty FallbackColorProperty

Identifies the FallbackColor dependency property.

(Inherited from XamlCompositionBrushBase)
Opacity Opacity Opacity Opacity Opacity

Gets or sets the degree of opacity of a Brush.

(Inherited from Brush)
OpacityProperty OpacityProperty OpacityProperty OpacityProperty OpacityProperty

Identifies the Opacity dependency property.

(Inherited from Brush)
RelativeTransform RelativeTransform RelativeTransform RelativeTransform RelativeTransform

Gets or sets the transformation that is applied to the brush using relative coordinates.

(Inherited from Brush)
RelativeTransformProperty RelativeTransformProperty RelativeTransformProperty RelativeTransformProperty RelativeTransformProperty

Identifies the RelativeTransform dependency property.

(Inherited from Brush)
StateProperty StateProperty StateProperty StateProperty StateProperty

Identifies the RevealBrush.State attached property

TargetTheme 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.

TargetThemeProperty TargetThemeProperty TargetThemeProperty TargetThemeProperty TargetThemeProperty

Identifies the TargetTheme dependency property.

Transform Transform Transform Transform Transform

Gets or sets the transformation that is applied to the brush.

(Inherited from Brush)
TransformProperty TransformProperty TransformProperty TransformProperty TransformProperty

Identifies the Transform dependency property.

(Inherited from Brush)


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

Clears the local value of a dependency property.

(Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

(Inherited from DependencyObject)
GetState(UIElement) GetState(UIElement) GetState(UIElement) GetState(UIElement) GetState(UIElement)

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

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

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)
OnConnected OnConnected OnConnected OnConnected OnConnected

Invoked when a brush is first used on screen to paint an element.

When implemented in a derived class, you can create a CompositionBrush instance and provide it to the framework by setting the CompositionBrush property.

OnDisconnected will be called when the brush is no longer being used to paint any elements.

(Inherited from XamlCompositionBrushBase)
OnDisconnected OnDisconnected OnDisconnected OnDisconnected OnDisconnected

Invoked when the brush is no longer being used to paint any elements.

When implemented in a derived class, you can safely dispose of the compostion brush and other composition resources.

OnConnected will be called again if the brush is later used to paint any elements after being disconnected.

(Inherited from XamlCompositionBrushBase)
PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo) PopulatePropertyInfo(String,AnimationPropertyInfo)

Defines a property that can be animated.

(Inherited from Brush)
PopulatePropertyInfoOverride(String,AnimationPropertyInfo) PopulatePropertyInfoOverride(String,AnimationPropertyInfo) PopulatePropertyInfoOverride(String,AnimationPropertyInfo) PopulatePropertyInfoOverride(String,AnimationPropertyInfo) PopulatePropertyInfoOverride(String,AnimationPropertyInfo)

When overridden in a derived class, defines a property that can be animated.

(Inherited from Brush)
ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

(Inherited from DependencyObject)
SetState(UIElement, RevealBrushState) 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.

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

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)