RevealBackgroundBrush Class
Definition
Paints a control background with a reveal effect using composition brush and light effects.
/// [Windows.Foundation.Metadata.Composable(Windows.UI.Xaml.Media.IRevealBackgroundBrushFactory, Windows.Foundation.Metadata.CompositionType.Public, 327680, "Windows.Foundation.UniversalApiContract")]
/// [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.Composable(Windows.UI.Xaml.Media.IRevealBackgroundBrushFactory, Windows.Foundation.Metadata.CompositionType.Public, 327680, "Windows.Foundation.UniversalApiContract")]
/// [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)]
/// [Windows.Foundation.Metadata.WebHostHidden]
class RevealBackgroundBrush : RevealBrush
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Media.IRevealBackgroundBrushFactory), Windows.Foundation.Metadata.CompositionType.Public, 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.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class RevealBackgroundBrush : RevealBrush
[Windows.Foundation.Metadata.Composable(typeof(Windows.UI.Xaml.Media.IRevealBackgroundBrushFactory), Windows.Foundation.Metadata.CompositionType.Public, 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.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.WebHostHidden]
public class RevealBackgroundBrush : RevealBrush
function RevealBackgroundBrush()
Public Class RevealBackgroundBrush
Inherits RevealBrush
- Inheritance
- 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.
Constructors
RevealBackgroundBrush() |
Initializes a new instance of the RevealBackgroundBrush class. |
Properties
AlwaysUseFallback |
Gets or sets a value that specifies whether the brush is forced to the solid fallback color. (Inherited from RevealBrush) |
Color |
Gets or sets a value that specifies the base background color for the brush. (Inherited from RevealBrush) |
CompositionBrush |
Gets or sets the CompositionBrush used by this XAML brush. Equivalent WinUI property: Microsoft.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush. (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. Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher. (Inherited from DependencyObject) |
FallbackColor |
The color to use for rendering in case the CompositionBrush can't be rendered. Equivalent WinUI property: Microsoft.UI.Xaml.Media.XamlCompositionBrushBase.FallbackColor. (Inherited from XamlCompositionBrushBase) |
Opacity |
Gets or sets the degree of opacity of a Brush. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Brush.Opacity. (Inherited from Brush) |
RelativeTransform |
Gets or sets the transformation that is applied to the brush using relative coordinates. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Brush.RelativeTransform. (Inherited from Brush) |
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. (Inherited from RevealBrush) |
Transform |
Gets or sets the transformation that is applied to the brush. Equivalent WinUI property: Microsoft.UI.Xaml.Media.Brush.Transform. (Inherited from Brush) |
Methods
ClearValue(DependencyProperty) |
Clears the local value of a dependency property. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue. (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. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue. (Inherited from DependencyObject) |
GetValue(DependencyProperty) |
Returns the current effective value of a dependency property from a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue. (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. Equivalent WinUI method: Microsoft.UI.Xaml.Media.XamlCompositionBrushBase.OnConnected. (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. Equivalent WinUI method: Microsoft.UI.Xaml.Media.XamlCompositionBrushBase.OnDisconnected. (Inherited from XamlCompositionBrushBase) |
PopulatePropertyInfo(String, AnimationPropertyInfo) |
Defines a property that can be animated. Equivalent WinUI method: Microsoft.UI.Xaml.Media.Brush.PopulatePropertyInfo. (Inherited from Brush) |
PopulatePropertyInfoOverride(String, AnimationPropertyInfo) |
When overridden in a derived class, defines a property that can be animated. Equivalent WinUI method: Microsoft.UI.Xaml.Media.Brush.PopulatePropertyInfoOverride. (Inherited from Brush) |
ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if a local value is set. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue. (Inherited from DependencyObject) |
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback) |
Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback. (Inherited from DependencyObject) |
SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property on a DependencyObject. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue. (Inherited from DependencyObject) |
UnregisterPropertyChangedCallback(DependencyProperty, Int64) |
Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback. (Inherited from DependencyObject) |