RevealBrush
RevealBrush
RevealBrush
RevealBrush
Class
Definition
Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Prerelease APIs are identified by a Prerelease label.
[Contains prerelease APIs.]
Base class for brushes that use composition effects and lighting to implement the reveal visual design treatment.
public : class RevealBrush : XamlCompositionBrushBase, IRevealBrushpublic class RevealBrush : XamlCompositionBrushBase, IRevealBrushPublic Class RevealBrush Inherits XamlCompositionBrushBase Implements IRevealBrush// You can use this class in JavaScript.
- Inheritance
- Attributes
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Inherited Members
Inherited methods
Inherited properties
Constructors
Properties
AlwaysUseFallback AlwaysUseFallback AlwaysUseFallback AlwaysUseFallback
Prerelease. Gets or sets a value that specifies whether the brush is forced to the solid fallback color.
public : PlatForm::Boolean AlwaysUseFallback { get; set; }public bool AlwaysUseFallback { get; set; }Public ReadWrite Property AlwaysUseFallback As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean 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
Prerelease. Identifies the AlwaysUseFallback dependency property.
public : static DependencyProperty AlwaysUseFallbackProperty { get; }public static DependencyProperty AlwaysUseFallbackProperty { get; }Public Static ReadOnly Property AlwaysUseFallbackProperty As DependencyProperty// You can use this property in JavaScript.
The identifier for the AlwaysUseFallback dependency property.
Color Color Color Color
Prerelease. Gets or sets a value that specifies the base background color for the brush.
public : Color Color { get; set; }public Color Color { get; set; }Public ReadWrite Property Color As Color// You can use this property in JavaScript.
ColorProperty ColorProperty ColorProperty ColorProperty
Prerelease. Identifies the Color dependency property.
public : static DependencyProperty ColorProperty { get; }public static DependencyProperty ColorProperty { get; }Public Static ReadOnly Property ColorProperty As DependencyProperty// You can use this property in JavaScript.
The identifier for the Color dependency property.
StateProperty StateProperty StateProperty StateProperty
Prerelease. Identifies the RevealBrush.State attached property
public : static DependencyProperty StateProperty { get; }public static DependencyProperty StateProperty { get; }Public Static ReadOnly Property StateProperty As DependencyProperty// You can use this property in JavaScript.
The identifier for the RevealBrush.State attached property.
TargetTheme TargetTheme TargetTheme TargetTheme
Prerelease. 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; }public ApplicationTheme TargetTheme { get; set; }Public ReadWrite Property TargetTheme As ApplicationTheme// You can use this property in JavaScript.
An ApplicationTheme value.
TargetThemeProperty TargetThemeProperty TargetThemeProperty TargetThemeProperty
Prerelease. Identifies the TargetTheme dependency property.
public : static DependencyProperty TargetThemeProperty { get; }public static DependencyProperty TargetThemeProperty { get; }Public Static ReadOnly Property TargetThemeProperty As DependencyProperty// You can use this property in JavaScript.
The identifier for the TargetTheme dependency property.
Methods
GetState(UIElement) GetState(UIElement) GetState(UIElement) GetState(UIElement)
Prerelease. Gets the value of the RevealBrush.State XAML attached property for the target element.
public : static RevealBrushState GetState(UIElement element)public static RevealBrushState GetState(UIElement element)Public Static Function GetState(element As UIElement) As RevealBrushState// You can use this method in JavaScript.
The RevealBrush.State XAML attached property value of the specified object.
SetState(UIElement, RevealBrushState) SetState(UIElement, RevealBrushState) SetState(UIElement, RevealBrushState) SetState(UIElement, RevealBrushState)
Prerelease. Sets the value of the RevealBrush.State XAML attached property for a target element.
public : static void SetState(UIElement element, RevealBrushState value)public static void SetState(UIElement element, RevealBrushState value)Public Static Function SetState(element As UIElement, value As RevealBrushState) As void// You can use this method in JavaScript.
The value to set.