Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed remaining Microsoft Learn doc warnings #410

Merged
merged 2 commits into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/Converters/samples/Converters.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Converts a source string from the App resources and returns its value, if found.

## StringFormatConverter

This allows you to format a string property upon binding wrapping [string.Format](https://learn.microsoft.com/dotnet/api/system.string.format?view=netstandard-2.0).
This allows you to format a string property upon binding wrapping [string.Format](https://learn.microsoft.com/dotnet/api/system.string.format?view=netstandard-2.0&preserve-view=true).
It only allows for a single input value (the binding string), but can be formatted with the regular string.Format
methods.

Expand Down
2 changes: 1 addition & 1 deletion components/Extensions/samples/DispatcherQueueExtensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ int someOtherValue = await dispatcherQueue.EnqueueAsync(async () =>
});
```

## Migrating from [`DispatcherHelper`](..\helpers\DispatcherHelper.md)
## Migrating from DispatcherHelper

The [`CoreDispatcher`](https://learn.microsoft.com/uwp/api/windows.ui.core.coredispatcher) is being deprecated (and it will no longer work with XAML Islands or WinUI 3) and should no longer be used, as it had a number of limitations. Specifically, it relied on the assumption that each window had its own UI thread tied to it, which is not always the case. The new `DispatcherQueue` instead can be used going forwards, and it requires some changes in code that was previously relying on `CoreDispatcher` and `DispatcherHelper`. Specifically, a background thread can no longer retrieve the `CoreDispatcher` by just accessing the dispatcher associated to the "main window" for the application, because this concept does not apply anymore. Instead, a `DispatcherQueue` instance needs to be retrieved on the UI thread and cached for later use in a background thread.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Here is how you can easily set a custom cursor type for a target `FrameworkEleme
```

> [!NOTE]
> Even though Microsoft recommends in [UWP Design guidelines](https://learn.microsoft.com/uwp/input-and-devices/mouse-interactions#cursors) hover effects instead of custom cursors over interactive elements, custom cursors can be useful in some specific scenarios.
> Even though Microsoft recommends in [UWP Design guidelines](https://learn.microsoft.com/windows/apps/design/input/mouse-interactions#cursors) hover effects instead of custom cursors over interactive elements, custom cursors can be useful in some specific scenarios.

> [!WARNING]
> Because the UWP framework does not support metadata on attached properties, specifically the [`FrameworkPropertyMetadata.Inherits`](https://learn.microsoft.com/dotnet/api/system.windows.frameworkpropertymetadata.-ctor#System_Windows_FrameworkPropertyMetadata__ctor_System_Object_System_Windows_FrameworkPropertyMetadataOptions_System_Windows_PropertyChangedCallback_System_Windows_CoerceValueCallback_) flag, the `Cursor` property might not work properly in some very specific XAML layout scenarios when combining nested `FrameworkElement`-s with different `CoreCursorType` values set on them.
Expand Down
2 changes: 1 addition & 1 deletion components/Extensions/samples/ShadowAnimations.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ issue-id: 0
icon: Assets/ShadowAnimation.png
---

Either type of Attached Shadow can be easily animated using the Toolkit's [`AnimationSet`](../animations/AnimationSet.md) api. These provide an easy XAML based way to animate a wide variety of elements, including a variety of shadow properties. They can also be animated with any other composition animation technique in code-behind as well using either the [`AnimationBuilder`](../animations/AnimationBuilder.md) or built-in composition animations.
Either type of Attached Shadow can be easily animated using the Toolkit's [`AnimationSet`](../animations/AnimationSet.md) api. These provide an easy XAML based way to animate a wide variety of elements, including a variety of shadow properties. They can also be animated with any other composition animation technique in code-behind as well using either the [`AnimationBuilder`](../Behaviors/AnimationSet.md) or built-in composition animations.
Arlodotexe marked this conversation as resolved.
Show resolved Hide resolved

> **Platform APIs:** `BlurRadiusDropShadowAnimation`, `ColorDropShadowAnimation`, `OffsetDropShadowAnimation`, `OpacityDropShadowAnimation`

Expand Down
2 changes: 1 addition & 1 deletion components/Sizers/samples/GridSplitter.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: GridSplitter
author: michael-hawker
description:The GridSplitter control provides an easy-to-use Splitter that redistributes space between columns or rows of a Grid Control.
description: The GridSplitter control provides an easy-to-use Splitter that redistributes space between columns or rows of a Grid Control.
keywords: ContentSizer, SizerBase, Control, Layout, Expander
dev_langs:
- csharp
Expand Down
Loading