Delen via


RevealBackgroundBrush Class

Definition

Important

RevealBackgroundBrush is available for use in the operating systems specified in the Requirements section. However, we do not recommend its use as it may be altered or unavailable in subsequent versions.

Paints a control background with a reveal effect using composition brush and light effects.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.RevealBackgroundBrush (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[WebHostHidden]
class RevealBackgroundBrush : RevealBrush
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 327680)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class RevealBackgroundBrush : RevealBrush
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 327680)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class RevealBackgroundBrush : RevealBrush
function RevealBackgroundBrush()
Public Class RevealBackgroundBrush
Inherits RevealBrush
Inheritance
Attributes

Windows requirements

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

Examples

Constructors

RevealBackgroundBrush()

Initializes a new instance of the RevealBackgroundBrush class.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.RevealBackgroundBrush.-ctor (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

Properties

AlwaysUseFallback

Important

RevealBrush is available for use in the operating systems specified in the Requirements section. However, we do not recommend its use as it may be altered or unavailable in subsequent versions.

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

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.RevealBrush.AlwaysUseFallback (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

(Inherited from RevealBrush)
Color

Important

RevealBrush is available for use in the operating systems specified in the Requirements section. However, we do not recommend its use as it may be altered or unavailable in subsequent versions. Gets or sets a value that specifies the base background color for the brush.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.RevealBrush.Color (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

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

Important

RevealBrush is available for use in the operating systems specified in the Requirements section. However, we do not recommend its use as it may be altered or unavailable in subsequent versions.

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.

Equivalent WinUI 2 API for UWP: Microsoft.UI.Xaml.Media.RevealBrush.TargetTheme (for WinUI in the Windows App SDK, see the Windows App SDK namespaces).

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