Skip to content

Commit a375cbc

Browse files
authored
Revise SystemBackdropHost specifications and examples
Updated spec notes and clarified usage instructions for SystemBackdropHost.
1 parent ddf4acf commit a375cbc

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

specs/SystemBackdropHost Spec.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ You can place the host behind header content while keeping the rest of the page
7676

7777
The same pattern works from code:
7878

79+
* C#:
7980
```csharp
8081
var host = new SystemBackdropHost
8182
{
@@ -85,6 +86,7 @@ var host = new SystemBackdropHost
8586
rootGrid.Children.Add(host);
8687
```
8788

89+
* C++:
8890
```cpp
8991
winrt::Microsoft::UI::Xaml::Controls::SystemBackdropHost host;
9092
host.SystemBackdrop(winrt::Microsoft::UI::Xaml::Media::MicaBackdrop());
@@ -96,17 +98,15 @@ In both snippets, `rootGrid` represents the panel that hosts the backdrop surfac
9698
9799
### Remarks
98100
99-
* _Spec note: This type is currently marked `[MUX_PREVIEW]`; the API surface may still change before it is finalized._
100-
* The host creates a `ContentExternalBackdropLink` when it is loaded and a `SystemBackdrop` is assigned. When you
101-
remove the backdrop or the element unloads, the host releases the composition resources.
102-
* The element does not render visuals of its own. Place it behind other content (for example as the first child inside a
103-
panel) to expose the backdrop surface.
101+
* _Spec note: This API is currently `experimental`; the API surface may still change before it is finalized._
102+
* The element have to be placed as first element in the container (for example as the first child inside a
103+
panel) for having the backdrop below the contents.
104104
* The host only connects to a backdrop while it has a `XamlRoot`. If the element is not in the live tree, the backdrop
105105
remains disconnected until it is loaded again.
106106
107107
## SystemBackdropHost.SystemBackdrop property
108108
109-
Gets or sets the `SystemBackdrop` instance that renders within this host. The default value is `null`.
109+
Gets or sets the `SystemBackdrop` instance that renders in the host area. The default value is `null`.
110110
111111
* When you assign a non-null backdrop and the host is loaded, it calls `SystemBackdrop.OnTargetConnected` with a
112112
`ContentExternalBackdropLink` that matches the element's arranged size. If the host is not yet loaded, the connection

0 commit comments

Comments
 (0)