RevealBrush Class

Definition

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

[WebHostHidden]
public ref class RevealBrush : XamlCompositionBrushBase
public ref class RevealBrush : XamlCompositionBrushBase
[WebHostHidden]
class RevealBrush : XamlCompositionBrushBase
class RevealBrush : XamlCompositionBrushBase
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Media.IRevealBrushFactory), Windows.Foundation.Metadata.CompositionType.Protected, 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Media.IRevealBrushStatics), 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class RevealBrush : XamlCompositionBrushBase
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Media.IRevealBrushFactory), Windows.Foundation.Metadata.CompositionType.Protected, 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Windows.UI.Xaml.Media.IRevealBrushStatics), 327680, "Windows.Foundation.UniversalApiContract")]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class RevealBrush : XamlCompositionBrushBase
Public Class RevealBrush
Inherits XamlCompositionBrushBase
Inheritance
Derived
Attributes

Windows 10 requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

Examples

Tip

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.

Remarks

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.

Constructors

RevealBrush()

Provides base class initialization behavior for RevealBrush-derived classes.

Properties

AlwaysUseFallback

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

AlwaysUseFallbackProperty

Identifies the AlwaysUseFallback dependency property.

Color

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

ColorProperty

Identifies the Color dependency property.

CompositionBrush

Gets or sets the CompositionBrush used by this XAML brush.

(Inherited from XamlCompositionBrushBase)
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

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

(Inherited from XamlCompositionBrushBase)
Opacity

Gets or sets the degree of opacity of a Brush.

(Inherited from Brush)
RelativeTransform

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

(Inherited from Brush)
StateProperty

Identifies the RevealBrush.State attached property

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

Identifies the TargetTheme dependency property.

Transform

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

(Inherited from Brush)

Methods

ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)
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)

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

GetValue(DependencyProperty)

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

(Inherited from DependencyObject)
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()

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)

Defines a property that can be animated.

(Inherited from Brush)
PopulatePropertyInfoOverride(String, AnimationPropertyInfo)

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

(Inherited from Brush)
ReadLocalValue(DependencyProperty)

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

(Inherited from DependencyObject)
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)

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

SetValue(DependencyProperty, Object)

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

(Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

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

(Inherited from DependencyObject)

Applies to