Edit

Share via

XamlCompositionEffectBrushBase Class

  • Reference

Definition

Namespace:
Microsoft.Toolkit.Uwp.UI.Media
Assembly:
Microsoft.Toolkit.Uwp.UI.Media.dll
Package:
Microsoft.Toolkit.Uwp.UI.Media v6.1.1
Package:
Microsoft.Toolkit.Uwp.UI.Media v7.0.2
Package:
Microsoft.Toolkit.Uwp.UI.Media v7.1.2

A custom Windows.UI.Xaml.Media.XamlCompositionBrushBaseclass that's ready to be used with a custom PipelineBuilder pipeline.

C# 
public abstract class XamlCompositionEffectBrushBase : Windows.UI.Xaml.Media.XamlCompositionBrushBase
Inheritance
Windows.UI.Xaml.Media.XamlCompositionBrushBase
XamlCompositionEffectBrushBase
Derived

Constructors

XamlCompositionEffectBrushBase()

Properties

IsEnabled

Gets or sets a value indicating whether the current brush is using the provided pipeline, or the fallback color.

Methods

OnBrushRequested()

A method that builds and returns the PipelineBuilder pipeline to use in the current instance.

This method can also be used to store any needed EffectSetter<T> or EffectAnimation<T> instances in local fields, for later use (they will need to be called upon Windows.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush).
OnCompositionBrushUpdated()

Invoked whenever the Windows.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush property is updated.
OnConnected()
OnDisconnected()
OnEnabledToggled(Boolean)

Updates the Windows.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush property depending on the input value.
OnPipelineRequested()

A method that builds and returns the PipelineBuilder pipeline to use in the current instance.

This method can also be used to store any needed EffectSetter<T> or EffectAnimation<T> instances in local fields, for later use (they will need to be called upon Windows.UI.Xaml.Media.XamlCompositionBrushBase.CompositionBrush).

Applies to

Product Versions
Windows Community Toolkit 6.1.1, 7.0.0, 7.1.0