Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 2.64 KB

systembackdrop_getdefaultsystembackdropconfiguration_1632097551.md

File metadata and controls

45 lines (26 loc) · 2.64 KB
-api-id -api-type
M:Microsoft.UI.Xaml.Media.SystemBackdrop.GetDefaultSystemBackdropConfiguration(Microsoft.UI.Composition.ICompositionSupportsSystemBackdrop,Microsoft.UI.Xaml.XamlRoot)
winrt method

Microsoft.UI.Xaml.Media.SystemBackdrop.GetDefaultSystemBackdropConfiguration(Microsoft.UI.Composition.ICompositionSupportsSystemBackdrop,Microsoft.UI.Xaml.XamlRoot)

-description

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

-parameters

-param target

The target of the backdrop.

-param xamlRoot

The XAML root of the backdrop target.

-returns

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.

-see-also

OnDefaultSystemBackdropConfigurationChanged

-examples