RevealBrush 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
struct winrt::Windows::UI::Xaml::Media::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() RevealBrush()

Provides base class initialization behavior for RevealBrush-derived classes.

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

Properties

AlwaysUseFallback 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; }
bool AlwaysUseFallback(); void AlwaysUseFallback(bool alwaysusefallback);
public bool AlwaysUseFallback { get; set; }
Public ReadWrite Property AlwaysUseFallback As bool
var bool = revealBrush.alwaysUseFallback;
revealBrush.alwaysUseFallback = bool;
Value
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 AlwaysUseFallbackProperty

Identifies the AlwaysUseFallback dependency property.

public : static DependencyProperty AlwaysUseFallbackProperty { get; }
static DependencyProperty AlwaysUseFallbackProperty();
public static DependencyProperty AlwaysUseFallbackProperty { get; }
Public Static ReadOnly Property AlwaysUseFallbackProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Media.RevealBrush.alwaysUseFallbackProperty;
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for the AlwaysUseFallback dependency property.

Color Color Color Color Color

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

public : Color Color { get; set; }
Color Color(); void Color(Color color);
public Color Color { get; set; }
Public ReadWrite Property Color As Color
var color = revealBrush.color;
revealBrush.color = color;
Value
Color Color Color

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

ColorProperty ColorProperty ColorProperty ColorProperty ColorProperty

Identifies the Color dependency property.

public : static DependencyProperty ColorProperty { get; }
static DependencyProperty ColorProperty();
public static DependencyProperty ColorProperty { get; }
Public Static ReadOnly Property ColorProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Media.RevealBrush.colorProperty;
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for 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

public : static DependencyProperty StateProperty { get; }
static DependencyProperty StateProperty();
public static DependencyProperty StateProperty { get; }
Public Static ReadOnly Property StateProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Media.RevealBrush.stateProperty;
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for 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.

public : ApplicationTheme TargetTheme { get; set; }
ApplicationTheme TargetTheme(); void TargetTheme(ApplicationTheme targettheme);
public ApplicationTheme TargetTheme { get; set; }
Public ReadWrite Property TargetTheme As ApplicationTheme
var applicationTheme = revealBrush.targetTheme;
revealBrush.targetTheme = applicationTheme;
Value
ApplicationTheme ApplicationTheme ApplicationTheme

An ApplicationTheme value.

TargetThemeProperty TargetThemeProperty TargetThemeProperty TargetThemeProperty TargetThemeProperty

Identifies the TargetTheme dependency property.

public : static DependencyProperty TargetThemeProperty { get; }
static DependencyProperty TargetThemeProperty();
public static DependencyProperty TargetThemeProperty { get; }
Public Static ReadOnly Property TargetThemeProperty As DependencyProperty
var dependencyProperty = Windows.UI.Xaml.Media.RevealBrush.targetThemeProperty;
Value
DependencyProperty DependencyProperty DependencyProperty

The identifier for 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)

Methods

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.

public : static RevealBrushState GetState(UIElement element)
RevealBrushState GetState(UIElement element) const;
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

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) 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)

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.

public : static void SetState(UIElement element, RevealBrushState value)
void SetState(UIElement element, RevealBrushState value) const;
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

The object to which the property value is written.

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)

See Also