Share via

SystemBackdrop.GetDefaultSystemBackdropConfiguration Method

  • Reference

Definition

Namespace:
Microsoft.UI.Xaml.Media
Edit

Retrieves a default SystemBackdropConfiguration object that can be passed to ISystemBackdropControllerWithTargets.SetSystemBackdropConfiguration.

public:
 virtual SystemBackdropConfiguration ^ GetDefaultSystemBackdropConfiguration(ICompositionSupportsSystemBackdrop ^ target, XamlRoot ^ xamlRoot) = GetDefaultSystemBackdropConfiguration;
SystemBackdropConfiguration GetDefaultSystemBackdropConfiguration(ICompositionSupportsSystemBackdrop const& target, XamlRoot const& xamlRoot);
public SystemBackdropConfiguration GetDefaultSystemBackdropConfiguration(ICompositionSupportsSystemBackdrop target, XamlRoot xamlRoot);
function getDefaultSystemBackdropConfiguration(target, xamlRoot)
Public Function GetDefaultSystemBackdropConfiguration (target As ICompositionSupportsSystemBackdrop, xamlRoot As XamlRoot) As SystemBackdropConfiguration

Parameters

target
ICompositionSupportsSystemBackdrop

The target of the backdrop.

xamlRoot
XamlRoot

The XAML root of the backdrop target.

Returns

SystemBackdropConfiguration

A default SystemBackdropConfiguration object.

Remarks

The default SystemBackdropConfiguration object that's returned is set and maintained automatically for each SystemBackdrop usage context (connectedTarget), and can be passed to ISystemBackdropControllerWithTargets.SetSystemBackdropConfiguration. The values of the properties on the SystemBackdropConfiguration that you receive might change over time:

  • Theme: set based on the ElementTheme of the target element (obtained from xamlRoot.Content).

    If FallbackColor, LuminosityOpacity, TintColor, or TintOpacity are modified by the material's implementation, changes to associated SystemBackdropConfiguration.Theme will no longer automatically toggle the controller's theme (because the default Dark and Light configurations are no longer appropriate). In this case, the material's appearance properties need to be manually updated to match the new theme in SystemBackdrop.OnDefaultSystemBackdropConfigurationChanged.

  • IsInputActive: true if the target of the SystemBackdrop is in the active window; otherwise, false.

  • IsHighContrast: true if the target of the SystemBackdrop is in high contrast mode; otherwise, false.

Applies to

See also