diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 729617714..37af6df73 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -21,8 +21,8 @@ Documentation Links Please check if your PR fulfills the following requirements: - [ ] Correctly picked the right branch to base the change off (`dev` for new features, `master` for typos/improvements) -- [ ] For new pages, used the [provided template](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/rel/7.0.0/docs/.template.md) -- [ ] For new features, added an entry in the [Table of Contents](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/rel/7.0.0/docs/toc.md) +- [ ] For new pages, used the [provided template](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/.template.md) +- [ ] For new features, added an entry in the [Table of Contents](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/toc.md) - [ ] Ran against a spell and grammar checker - [ ] Contains **NO** breaking changes diff --git a/.openpublishing.publish.config.json b/.openpublishing.publish.config.json index 8101ad930..430e3b865 100644 --- a/.openpublishing.publish.config.json +++ b/.openpublishing.publish.config.json @@ -1,6 +1,4 @@ { - "need_generate_pdf": false, - "need_generate_intellisense": false, "docsets_to_publish": [ { "docset_name": "UWPCommunityToolkitDocs", @@ -74,15 +72,17 @@ } ], "notification_subscribers": [], + "sync_notification_subscribers": null, "branches_to_filter": [], - "git_repository_branch_open_to_public_contributors": "master", + "git_repository_branch_open_to_public_contributors": "main", "skip_source_output_uploading": false, "need_preview_pull_request": true, + "contribution_branch_mappings": null, "dependent_repositories": [ { "path_to_root": "_themes", "url": "https://github.com/Microsoft/templates.docs.msft", - "branch": "master", + "branch": "main", "branch_mapping": {} } ], @@ -92,6 +92,8 @@ "Pdf" ] }, + "need_generate_pdf": false, + "need_generate_intellisense": false, "need_generate_pdf_url_template": false, "template_folder": "_themes", "dependent_packages": [ @@ -123,4 +125,4 @@ "docs_build_engine": { "name": "docfx_v3" } -} +} \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78d5aab15..97552ff97 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to the Windows Community Toolkit Documentation -Please visit the [contribution guidelines](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/contributing.md) for the Windows Community Toolkit. +Please visit the [contribution guidelines](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/master/contributing.md) for the Windows Community Toolkit. Documentation is **required** when adding, removing, or updating a control or an API in the Windows Community Toolkit. To update the documentation, you must submit a separate Pull Request in this repository as well (use the *master* branch for typos/improvements and *dev* for new features). @@ -10,5 +10,5 @@ Make sure to update both Pull Requests with a link to each other. If adding a new documentation page: -* Copy the [documentation template](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/rel/7.0.0/docs/.template.md) and follow the same format. -* Update the [Table of Contents](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/rel/7.0.0/docs/toc.md) to point to the new page +* Copy the [documentation template](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/.template.md) and follow the same format. +* Update the [Table of Contents](https://github.com/MicrosoftDocs/WindowsCommunityToolkitDocs/blob/master/docs/toc.md) to point to the new page diff --git a/docs/.template.md b/docs/.template.md index f82b5f401..2cd7f5c17 100644 --- a/docs/.template.md +++ b/docs/.template.md @@ -7,9 +7,12 @@ dev_langs: - csharp --- - + + + + # Title @@ -30,7 +33,7 @@ with the namespace and the class name. Without any country/region 'en-us' identi > Some warning note --> -> **Platform APIs:** Include a comma separated list of links of any APIs used in the document in the following format: [`Class/InterfaceName`](API-Link). +> **Platform APIs:** [`Class/InterfaceName`](API-Link) diff --git a/docs/animations/AnimationBuilder.md b/docs/animations/AnimationBuilder.md index b08a6b02d..cfda956b2 100644 --- a/docs/animations/AnimationBuilder.md +++ b/docs/animations/AnimationBuilder.md @@ -183,4 +183,4 @@ tokenSource.Cancel(); ## Examples -You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp). +You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp). diff --git a/docs/animations/AnimationSet.md b/docs/animations/AnimationSet.md index 32365978a..0abd7808a 100644 --- a/docs/animations/AnimationSet.md +++ b/docs/animations/AnimationSet.md @@ -203,4 +203,4 @@ And here is the final result from the code above, with an image and some text as ## Examples -You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp). +You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp). diff --git a/docs/animations/Blur.md b/docs/animations/Blur.md index 2ccf1eed4..b9cac5f5a 100644 --- a/docs/animations/Blur.md +++ b/docs/animations/Blur.md @@ -113,7 +113,7 @@ Await MyUIElement.Blur(value:=5, duration:=2500, delay:=250).StartAsync() ' B ## Sample Project -[Blur Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Blur). You can [see this in action](uwpct://Animations?sample=Blur) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Blur Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Blur). You can [see this in action](uwpct://Animations?sample=Blur) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -124,7 +124,7 @@ Await MyUIElement.Blur(value:=5, duration:=2500, delay:=250).StartAsync() ' B ## API -- [Blur source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Animations/BlurEffectAnimation.cs) +- [Blur source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Animations/BlurEffectAnimation.cs) ## Related Topics diff --git a/docs/animations/CompositionAnimations.md b/docs/animations/CompositionAnimations.md index 04d90c136..92afba6ab 100644 --- a/docs/animations/CompositionAnimations.md +++ b/docs/animations/CompositionAnimations.md @@ -159,7 +159,7 @@ Now we can add KeyFrames ## Sample Code -[Implicit Composition Animations in XAML sample page source](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Implicit%20Animations/ImplicitAnimationsPage.xaml). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). +[Implicit Composition Animations in XAML sample page source](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Implicit%20Animations/ImplicitAnimationsPage.xaml). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). ## Requirements @@ -170,7 +170,7 @@ Now we can add KeyFrames ## API -- [Composition animations source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/CompositionAnimations) +- [Composition animations source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/CompositionAnimations) ## Related Topics diff --git a/docs/animations/ConnectedAnimations.md b/docs/animations/ConnectedAnimations.md index d43464e59..42916d166 100644 --- a/docs/animations/ConnectedAnimations.md +++ b/docs/animations/ConnectedAnimations.md @@ -194,7 +194,7 @@ In this page, you just need to give the same key. ## Sample Project -[Connected Animations sample page source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Connected%20Animations). You can [see this in action](uwpct://Animations?sample=Connected%20Animations) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Connected Animations sample page source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Connected%20Animations). You can [see this in action](uwpct://Animations?sample=Connected%20Animations) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -205,7 +205,7 @@ In this page, you just need to give the same key. ## API -* [Connected animations source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/ConnectedAnimations) +* [Connected animations source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/ConnectedAnimations) ## Related Topics diff --git a/docs/animations/Expressions.md b/docs/animations/Expressions.md index 074ae118a..447f5aaa6 100644 --- a/docs/animations/Expressions.md +++ b/docs/animations/Expressions.md @@ -116,7 +116,7 @@ Thus, the ExpressionBuilder classes were created to help alleviate these challen ## Using the ExpressionBuilder classes -For full documentation on how to use the ExpressionBuilder classes, please refer to the [Word document](https://github.com/Microsoft/WindowsUIDevLabs/tree/rel/7.0.0/ExpressionBuilder/Docs) from the composition team. +For full documentation on how to use the ExpressionBuilder classes, please refer to the [Word document](https://github.com/Microsoft/WindowsUIDevLabs/tree/rel/7.1.0/ExpressionBuilder/Docs) from the composition team. Before we highlight how to use the classes, let's reiterate the core components that make up an Expression: @@ -227,7 +227,7 @@ If you are familiar with how Expressions were built with strings, there are a fe ## Intro -### What are Expressions? +### What are Expressions? ExpressionAnimations (or Expressions, for short) are a new type of animation introduced to Windows App developers in Windows 10 to provide a more expressive animation model than what is provided from traditional KeyFrameAnimations and XAML Storyboards. @@ -244,7 +244,7 @@ The documentation below assumes you are familiar with the Composition and Compos - [ExpressionAnimation MSDN Documentation](/uwp/api/Windows.UI.Composition.ExpressionAnimation) -### Why ExpressionBuilder? +### Why ExpressionBuilder? To use ExpressionAnimations today, developers are required to write their mathematical equation/relationship in a string (example shown below). @@ -879,7 +879,7 @@ There is an assumption that the reader has a general understanding of what Expre ### Parallaxing Listing Items -([Github Link](https://github.com/Microsoft/WindowsUIDevLabs/tree/rel/7.0.0/SampleGallery/Samples/SDK%2010586/ParallaxingListItems)) +([Github Link](https://github.com/Microsoft/WindowsUIDevLabs/tree/rel/7.1.0/SampleGallery/Samples/SDK%2010586/ParallaxingListItems)) The first example we will walk through is the Parallaxing List Item sample found on the Windows UI Dev Labs Github Sample Gallery project. In this sample, we want to create a UI experience such that the background image for each list item parallax as the user scrolls through the list. @@ -985,7 +985,7 @@ visual.StartAnimation("Offset.Y", parallaxExpression); ## PropertySets -([Github Project](https://github.com/Microsoft/WindowsUIDevLabs/tree/rel/7.0.0/SampleGallery/Samples/SDK%2010586/PropertySets)) +([Github Project](https://github.com/Microsoft/WindowsUIDevLabs/tree/rel/7.1.0/SampleGallery/Samples/SDK%2010586/PropertySets)) The second example we will walk through is the PropertySets sample on the Windows UI Dev Labs Sample Gallery Github project. In this sample, we want to make a UI experience where we want to have a colored ball orbit another that is moving up and down. @@ -1057,7 +1057,7 @@ var orbitExp = visual.GetReference().Offset + centerPointOffset + ### Curtain -([Github Project](https://github.com/Microsoft/WindowsUIDevLabs/tree/rel/7.0.0/SampleGallery/Samples/SDK%2014393/Curtain)) +([Github Project](https://github.com/Microsoft/WindowsUIDevLabs/tree/rel/7.1.0/SampleGallery/Samples/SDK%2014393/Curtain)) The third example we will walk through is the Curtain sample on the Windows UI Dev Labs Sample Gallery Github project. Although there are a few instances where Expressions are used, we will focus on the Expression that defines the Spring motion of the curtain (the function named ActivateSpringForce()). @@ -1146,4 +1146,4 @@ _tracker.ConfigurePositionYInertiaModifiers( ## API -- [Expressions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/Expressions) +- [Expressions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/Expressions) diff --git a/docs/animations/Fade.md b/docs/animations/Fade.md index d6b45f166..0ec45e64c 100644 --- a/docs/animations/Fade.md +++ b/docs/animations/Fade.md @@ -111,7 +111,7 @@ You can change the way how the animation interpolates between keyframes by defin ## Sample Project -[Fade Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Fade). You can [see this in action](uwpct://Animations?sample=Fade) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Fade Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Fade). You can [see this in action](uwpct://Animations?sample=Fade) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -122,7 +122,7 @@ You can change the way how the animation interpolates between keyframes by defin ## API -- [Fade source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/Behaviors/Fade.cs) +- [Fade source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/Behaviors/Fade.cs) ## Related Topics diff --git a/docs/animations/FadeHeader.md b/docs/animations/FadeHeader.md index feb743586..1305cc2e8 100644 --- a/docs/animations/FadeHeader.md +++ b/docs/animations/FadeHeader.md @@ -85,7 +85,7 @@ Microsoft.Xaml.Interactivity.Interaction.GetBehaviors(MyListView).Add(New FadeHe ## Sample Project -[FadeHeader Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/FadeHeader). You can [see this in action](uwpct://Animations?sample=FadeHeader) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[FadeHeader Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/FadeHeader). You can [see this in action](uwpct://Animations?sample=FadeHeader) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -96,7 +96,7 @@ Microsoft.Xaml.Interactivity.Interaction.GetBehaviors(MyListView).Add(New FadeHe ## API -* [FadeHeader source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Behaviors/Headers/FadeHeaderBehavior.cs) +* [FadeHeader source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Behaviors/Headers/FadeHeaderBehavior.cs) ## Related Topics diff --git a/docs/animations/ImplicitAnimationSet.md b/docs/animations/ImplicitAnimationSet.md index 0791cab08..5d602696a 100644 --- a/docs/animations/ImplicitAnimationSet.md +++ b/docs/animations/ImplicitAnimationSet.md @@ -53,4 +53,4 @@ This code results in the following, when tested in one of the sample pages in th ## Examples -You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp). +You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp). diff --git a/docs/animations/ImplicitAnimations.md b/docs/animations/ImplicitAnimations.md index dd7310f97..4b6c0c341 100644 --- a/docs/animations/ImplicitAnimations.md +++ b/docs/animations/ImplicitAnimations.md @@ -145,7 +145,7 @@ You can [see this in action](uwpct://Animations?sample=Implicit%20Animations) in ## API -- [Implicit animations source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/Implicit.cs) +- [Implicit animations source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/Implicit.cs) ## Related Topics diff --git a/docs/animations/ItemsReorderAnimation.md b/docs/animations/ItemsReorderAnimation.md index b875e1fd5..690ddbeed 100644 --- a/docs/animations/ItemsReorderAnimation.md +++ b/docs/animations/ItemsReorderAnimation.md @@ -38,4 +38,4 @@ Here is the visual result when using a `GridView` to display some images in a wi ## Examples -You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp). +You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp). diff --git a/docs/animations/Light.md b/docs/animations/Light.md index 4c1147bd0..0268faa88 100644 --- a/docs/animations/Light.md +++ b/docs/animations/Light.md @@ -98,7 +98,7 @@ Await MyUIElement.Light(distance:=5, duration:=2500, delay:=250, color:=Colors.R ## Sample Project -[Light Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Light). You can [see this in action](uwpct://Animations?sample=Light) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Light Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Light). You can [see this in action](uwpct://Animations?sample=Light) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -109,7 +109,7 @@ Await MyUIElement.Light(distance:=5, duration:=2500, delay:=250, color:=Colors.R ## API -- [Light source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/Behaviors/Light.cs) +- [Light source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/Behaviors/Light.cs) ## Related Topics diff --git a/docs/animations/Lottie.md b/docs/animations/Lottie.md index a59132919..7346fc6f2 100644 --- a/docs/animations/Lottie.md +++ b/docs/animations/Lottie.md @@ -14,7 +14,7 @@ Lottie simplifies the design-to-code workflow for bringing engaging, interactive ![Lottie Gif](../resources/images/Animations/Lottie/LottieDocs_Intro.gif) > [!div class="nextstepaction"] -> [Try it in the sample app](uwpct://Animations?sample=Lottie) +> [Try it in the sample app](https://aka.ms/lottiesamples) ## Key Concepts @@ -38,7 +38,7 @@ The following documents help you get started with Lottie-Windows and provide sim ## Sample Code -* [Code Samples for Lottie-Windows](https://github.com/windows-toolkit/Lottie-Windows/tree/rel/7.0.0/samples) +* [Code Samples for Lottie-Windows](https://github.com/windows-toolkit/Lottie-Windows/tree/rel/7.1.0/samples) * [Lottie Samples application](https://aka.ms/lottiesamples) ## Requirements diff --git a/docs/animations/Offset.md b/docs/animations/Offset.md index 457a678ff..dcd891ba9 100644 --- a/docs/animations/Offset.md +++ b/docs/animations/Offset.md @@ -152,7 +152,7 @@ You can change the way how the animation interpolates between keyframes by defin ## Sample Project -[Offset Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Offset). You can [see this in action](uwpct://Animations?sample=Offset) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Offset Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Offset). You can [see this in action](uwpct://Animations?sample=Offset) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -163,7 +163,7 @@ You can change the way how the animation interpolates between keyframes by defin ## API -- [Offset source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/Xaml/Default/OffsetAnimation.cs) +- [Offset source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/Xaml/Default/OffsetAnimation.cs) ## Related Topics diff --git a/docs/animations/ReorderGrid.md b/docs/animations/ReorderGrid.md index 88f2958d7..6d199e3db 100644 --- a/docs/animations/ReorderGrid.md +++ b/docs/animations/ReorderGrid.md @@ -47,7 +47,7 @@ MyGridView.SetValue(ReorderGridAnimation.DurationProperty, 250) ## Sample Project -[ReorderGridAnimation Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ReorderGridAnimation). You can [see this in action](uwpct://Animations?sample=ReorderGridAnimation) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ReorderGridAnimation Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ReorderGridAnimation). You can [see this in action](uwpct://Animations?sample=ReorderGridAnimation) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -58,4 +58,4 @@ MyGridView.SetValue(ReorderGridAnimation.DurationProperty, 250) ## API -- [ReorderGridAnimation source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/ItemsReorderAnimation.cs) +- [ReorderGridAnimation source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/ItemsReorderAnimation.cs) diff --git a/docs/animations/Rotate.md b/docs/animations/Rotate.md index a2ae6e8d0..bb0e53b26 100644 --- a/docs/animations/Rotate.md +++ b/docs/animations/Rotate.md @@ -115,7 +115,7 @@ You can change the way how the animation interpolates between keyframes by defin ## Sample Project -[Rotate Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Rotate). You can [see this in action](uwpct://Animations?sample=Rotate) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Rotate Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Rotate). You can [see this in action](uwpct://Animations?sample=Rotate) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -126,7 +126,7 @@ You can change the way how the animation interpolates between keyframes by defin ## API -- [Rotate source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Animations/HueRotationEffectAnimation.cs) +- [Rotate source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Animations/HueRotationEffectAnimation.cs) ## Related Topics diff --git a/docs/animations/Saturation.md b/docs/animations/Saturation.md index b9a64f81c..dedb5d049 100644 --- a/docs/animations/Saturation.md +++ b/docs/animations/Saturation.md @@ -121,7 +121,7 @@ ToolkitLogo.Saturation(value:=0, duration:=500, delay:=250) ## Sample Project -[Saturation Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Saturation). You can [see this in action](uwpct://Animations?sample=Saturation) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Saturation Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Saturation). You can [see this in action](uwpct://Animations?sample=Saturation) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -132,7 +132,7 @@ ToolkitLogo.Saturation(value:=0, duration:=500, delay:=250) ## API -- [Saturation source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Animations/SaturationEffectAnimation.cs) +- [Saturation source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Animations/SaturationEffectAnimation.cs) ## Related Topics diff --git a/docs/animations/Scale.md b/docs/animations/Scale.md index 344247048..e11cea4a1 100644 --- a/docs/animations/Scale.md +++ b/docs/animations/Scale.md @@ -149,7 +149,7 @@ You can change the way how the animation interpolates between keyframes by defin ## Sample Project -[Scale Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Scale). You can [see this in action](uwpct://Animations?sample=Scale) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Scale Behavior Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Scale). You can [see this in action](uwpct://Animations?sample=Scale) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -160,7 +160,7 @@ You can change the way how the animation interpolates between keyframes by defin ## API -- [Scale source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Animations/Behaviors/Scale.cs) +- [Scale source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Animations/Behaviors/Scale.cs) ## Related Topics diff --git a/docs/animations/ScrollViewerExtensions.md b/docs/animations/ScrollViewerExtensions.md index c13251315..022c910b7 100644 --- a/docs/animations/ScrollViewerExtensions.md +++ b/docs/animations/ScrollViewerExtensions.md @@ -69,4 +69,4 @@ listScrollViewer.StartExpressionAnimation(shapesPanel, Axis.X, Axis.Y, VisualPro ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/animations/lottie-scenarios/async_play.md b/docs/animations/lottie-scenarios/async_play.md index d564b7fa4..446d83f77 100644 --- a/docs/animations/lottie-scenarios/async_play.md +++ b/docs/animations/lottie-scenarios/async_play.md @@ -66,7 +66,7 @@ If your scenario doesn’t require you to `await` the completion of PlayAsync, y ## Resources -* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.0.0/samples/LottieSamples/Scenarios/AsyncPage.xaml.cs) for sample: the asynchronous play method +* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.1.0/samples/LottieSamples/Scenarios/AsyncPage.xaml.cs) for sample: the asynchronous play method * The resulting page in the [Lottie Samples application](https://aka.ms/lottiesamples) * [PlayAsync](/uwp/api/microsoft.ui.xaml.controls.animatedvisualplayer.playasync) method * [Help + feedback](https://github.com/windows-toolkit/Lottie-Windows/issues) diff --git a/docs/animations/lottie-scenarios/fallback.md b/docs/animations/lottie-scenarios/fallback.md index 9fa912acc..c3057cb17 100644 --- a/docs/animations/lottie-scenarios/fallback.md +++ b/docs/animations/lottie-scenarios/fallback.md @@ -35,7 +35,7 @@ In the example below, we use an Image as fallback for the Lottie animation: ## Resources -* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.0.0/samples/LottieSamples/Scenarios/FallbackPage.xaml) for sample: handling failure and down-level +* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.1.0/samples/LottieSamples/Scenarios/FallbackPage.xaml) for sample: handling failure and down-level * The resulting page in the [Lottie Samples application](https://aka.ms/lottiesamples) * [FallbackContent](/uwp/api/microsoft.ui.xaml.controls.animatedvisualplayer.fallbackcontent) property * [Help + feedback](https://github.com/windows-toolkit/Lottie-Windows/issues) diff --git a/docs/animations/lottie-scenarios/getting_started_codegen.md b/docs/animations/lottie-scenarios/getting_started_codegen.md index 3dcc8afef..453c1217f 100644 --- a/docs/animations/lottie-scenarios/getting_started_codegen.md +++ b/docs/animations/lottie-scenarios/getting_started_codegen.md @@ -61,7 +61,7 @@ This should result in a looping Lottie animation that is visually identical to o ## Resources -* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.0.0/samples/LottieSamples/Scenarios/CodegenPage.xaml) for sample: getting started with Codegen +* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.1.0/samples/LottieSamples/Scenarios/CodegenPage.xaml) for sample: getting started with Codegen * The resulting page in the [Lottie Samples application](https://aka.ms/lottiesamples) * [LottieGen](https://aka.ms/lottiegen) CLI tool * [Lottie Viewer](https://aka.ms/lottieviewer) application for codegen and previewing JSON files diff --git a/docs/animations/lottie-scenarios/getting_started_json.md b/docs/animations/lottie-scenarios/getting_started_json.md index eef6888f3..7c570502d 100644 --- a/docs/animations/lottie-scenarios/getting_started_json.md +++ b/docs/animations/lottie-scenarios/getting_started_json.md @@ -32,7 +32,7 @@ You probably have a JSON file that was exported from [Adobe AfterEffects](https: * Add _LottieLogo1.json_ to the /AnimatedVisuals folder and include by right-clicking > Add > Existing Item. * Set its [Build Action](/visualstudio/ide/build-actions) to **Content** in the Properties window. - BuildAction + BuildAction 5. Instantiate the [AnimatedVisualPlayer](/uwp/api/microsoft.ui.xaml.controls.animatedvisualplayer) element and configure the [LottieVisualSource](/dotnet/api/microsoft.toolkit.uwp.ui.lottie.lottievisualsource) to be consumed: @@ -52,7 +52,7 @@ Since the [AutoPlay](/uwp/api/microsoft.ui.xaml.controls.animatedvisualplayer.au ## Resources -* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.0.0/samples/LottieSamples/Scenarios/JsonPage.xaml) for sample: getting started with a JSON file +* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.1.0/samples/LottieSamples/Scenarios/JsonPage.xaml) for sample: getting started with a JSON file * The resulting page in the [Lottie Samples application](https://aka.ms/lottiesamples) * [LottieVisualSource](/dotnet/api/microsoft.toolkit.uwp.ui.lottie.lottievisualsource) API reference * [Lottie Viewer application](https://aka.ms/lottieviewer) for previewing JSON files diff --git a/docs/animations/lottie-scenarios/json_codegen.md b/docs/animations/lottie-scenarios/json_codegen.md index 436f5377b..6640e5f93 100644 --- a/docs/animations/lottie-scenarios/json_codegen.md +++ b/docs/animations/lottie-scenarios/json_codegen.md @@ -16,4 +16,4 @@ The tradeoffs between using JSON and Codegen are as follows: | JSON | Codegen | | -------- | ----------- | | Can be loaded from a URI at run-time — this enables Lottie animations to be updated over the network, without updating the application. | Better performance: there is no need to parse and translate JSON at run-time on the application’s UI thread, and, since the resulting Windows.UI.Composition tree is generated ahead of time, it can be better optimized. | -| | Allows dynamic modification of Lottie animations by editing the generated Windows.UI.Composition Visual tree. This is useful for theming, branding, accessibility, etc. (see [related scenario sample](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.0.0/samples/LottieSamples/Scenarios/ModifyPage.xaml)). +| | Allows dynamic modification of Lottie animations by editing the generated Windows.UI.Composition Visual tree. This is useful for theming, branding, accessibility, etc. (see [related scenario sample](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.1.0/samples/LottieSamples/Scenarios/ModifyPage.xaml)). diff --git a/docs/animations/lottie-scenarios/playback.md b/docs/animations/lottie-scenarios/playback.md index 2ff365557..07c261baf 100644 --- a/docs/animations/lottie-scenarios/playback.md +++ b/docs/animations/lottie-scenarios/playback.md @@ -100,7 +100,7 @@ Now, let's introduce Pause, Stop, and Reverse Buttons and update the method abov ## Resources -* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.0.0/samples/LottieSamples/Scenarios/PlaybackPage.xaml.cs) for sample: configuring animation playback +* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.1.0/samples/LottieSamples/Scenarios/PlaybackPage.xaml.cs) for sample: configuring animation playback * The resulting page in the [Lottie Samples application](https://aka.ms/lottiesamples) * [AnimatedVisualPlayer](/uwp/api/microsoft.ui.xaml.controls.animatedvisualplayer) API reference * [Help + feedback](https://github.com/windows-toolkit/Lottie-Windows/issues) diff --git a/docs/animations/lottie-scenarios/segments.md b/docs/animations/lottie-scenarios/segments.md index 06f3ea41c..e012ac55d 100644 --- a/docs/animations/lottie-scenarios/segments.md +++ b/docs/animations/lottie-scenarios/segments.md @@ -86,7 +86,7 @@ This results in the following interactive animated ToggleButton icon: ## Resources -* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.0.0/samples/LottieSamples/Scenarios/SegmentPage.xaml.cs) for sample: interactive segments on an animation timeline +* [Source code](https://github.com/windows-toolkit/Lottie-Windows/blob/rel/7.1.0/samples/LottieSamples/Scenarios/SegmentPage.xaml.cs) for sample: interactive segments on an animation timeline * The resulting page in the [Lottie Samples application](https://aka.ms/lottiesamples) * [AnimatedVisualPlayer](/uwp/api/microsoft.ui.xaml.controls.animatedvisualplayer) API reference * [Help + feedback](https://github.com/windows-toolkit/Lottie-Windows/issues) diff --git a/docs/archive/Bing.md b/docs/archive/Bing.md index 2a89d868b..e2b2c2af0 100644 --- a/docs/archive/Bing.md +++ b/docs/archive/Bing.md @@ -120,7 +120,7 @@ ListView.ItemsSource = Await BingService.Instance.RequestAsync(searchConfig, 50) ## Sample Code -[Bing Service Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Bing%20Service). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). +[Bing Service Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Bing%20Service). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). ## Requirements diff --git a/docs/archive/HamburgerMenu.md b/docs/archive/HamburgerMenu.md index 77aea3c04..6c9ec6667 100644 --- a/docs/archive/HamburgerMenu.md +++ b/docs/archive/HamburgerMenu.md @@ -265,12 +265,12 @@ There are several HamburgerMenu properties that have no effect when the Hamburge ## Sample Code -[HamburgerMenu Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HamburgerMenu) +[HamburgerMenu Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HamburgerMenu) . You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). ## Default Template -[HamburgerMenu XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/HamburgerMenu/HamburgerMenu.xaml) is the XAML template used in the toolkit for the default styling. +[HamburgerMenu XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/HamburgerMenu/HamburgerMenu.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -281,4 +281,4 @@ There are several HamburgerMenu properties that have no effect when the Hamburge ## API -- [HamburgerMenu source code archive](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/HamburgerMenu) +- [HamburgerMenu source code archive](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/HamburgerMenu) diff --git a/docs/archive/ParallaxService.md b/docs/archive/ParallaxService.md index effb541ab..3536e655d 100644 --- a/docs/archive/ParallaxService.md +++ b/docs/archive/ParallaxService.md @@ -60,7 +60,7 @@ MyUIElement.SetValue(ParallaxService.HorizontalMultiplierProperty, 0.5) ## Sample Project -[ParallaxService Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ParallaxService). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ) +[ParallaxService Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ParallaxService). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ) ## Moving to ParallaxView diff --git a/docs/archive/PullToRefreshListview.md b/docs/archive/PullToRefreshListview.md index a2b242448..2a20c3b40 100644 --- a/docs/archive/PullToRefreshListview.md +++ b/docs/archive/PullToRefreshListview.md @@ -72,7 +72,7 @@ be raised and the *RefreshIntentCanceledCommand*, if any, will be executed. ## Sample Code -[PullToRefreshListView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PullToRefreshListView). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). +[PullToRefreshListView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PullToRefreshListView). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). ## Moving to RefreshContainer @@ -112,7 +112,7 @@ There are several PullToRefreshListView properties that have no effect when the ## Default Template -[PullToRefreshListView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/PullToRefreshListView/PullToRefreshListView.xaml) is the XAML template used in the toolkit for the default styling. +[PullToRefreshListView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/PullToRefreshListView/PullToRefreshListView.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements diff --git a/docs/archive/SlidableListItem.md b/docs/archive/SlidableListItem.md index 93fa0ba4c..9e548de20 100644 --- a/docs/archive/SlidableListItem.md +++ b/docs/archive/SlidableListItem.md @@ -174,11 +174,11 @@ There are several SlidableListItem properties that have no effect when the Slida ## Sample Code -[SlidableListItem Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/SlidableListItem). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). +[SlidableListItem Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/SlidableListItem). You can see this in action in [Windows Community Toolkit Sample App](https://www.microsoft.com/store/apps/9NBLGGH4TLCQ). ## Default Template -[SlidableListItem XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/SlidableListItem/SlidableListItem.xaml) is the XAML template used in the toolkit for the default styling. +[SlidableListItem XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/SlidableListItem/SlidableListItem.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements diff --git a/docs/archive/graph/AadLogin.md b/docs/archive/graph/AadLogin.md index ad326daab..43620ee49 100644 --- a/docs/archive/graph/AadLogin.md +++ b/docs/archive/graph/AadLogin.md @@ -33,7 +33,7 @@ The [AadLogin Control](/dotnet/api/microsoft.toolkit.uwp.ui.controls.graph.aadlo | -- | -- | -- | | RequiredDelegatedPermissions | String[] | Gets required delegated permissions for Graph API access | | DefaultImage | BitmapImage | The default image displayed when no user is signed in | -| View | [ViewType](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/ProfileCard/ViewType.cs) | The visual layout of the control. Default is `PictureOnly` | +| View | [ViewType](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/ProfileCard/ViewType.cs) | The visual layout of the control. Default is `PictureOnly` | | AllowSignInAsDifferentUser | Boolean | Whether or not the menu item for `Sign in as a different user` is enabled, default value is true | | SignInDefaultText | String | Default text for sign in button | | SignOutDefaultText | String | Default text for sign out button | @@ -69,11 +69,11 @@ MicrosoftGraphService.Instance.Initialize( ); ``` -[AadLogin Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AadLogin). You can [see this in action](uwpct://Controls?sample=AadLogin) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[AadLogin Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AadLogin). You can [see this in action](uwpct://Controls?sample=AadLogin) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[AadLogin XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/AadLogin/AadLogin.xaml) is the XAML template used in the toolkit for the default styling. +[AadLogin XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/AadLogin/AadLogin.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements diff --git a/docs/archive/graph/PeoplePicker.md b/docs/archive/graph/PeoplePicker.md index d7d0a0b82..9ec6d3898 100644 --- a/docs/archive/graph/PeoplePicker.md +++ b/docs/archive/graph/PeoplePicker.md @@ -57,11 +57,11 @@ The sign in will be processed by the [AadLogin](AadLogin.md) control, however, y await MicrosoftGraphService.Instance.LoginAsync(); ``` -[PeoplePicker Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PeoplePicker). You can [see this in action](uwpct://Controls?sample=PeoplePicker) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[PeoplePicker Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PeoplePicker). You can [see this in action](uwpct://Controls?sample=PeoplePicker) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[PeoplePicker XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/PeoplePicker/PeoplePicker.xaml) is the XAML template used in the toolkit for the default styling. +[PeoplePicker XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/PeoplePicker/PeoplePicker.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements diff --git a/docs/archive/graph/PlannerTaskList.md b/docs/archive/graph/PlannerTaskList.md index 54590ff10..ae70a25bd 100644 --- a/docs/archive/graph/PlannerTaskList.md +++ b/docs/archive/graph/PlannerTaskList.md @@ -59,11 +59,11 @@ The sign in will be processed by the [AadLogin](AadLogin.md) control, however, y await MicrosoftGraphService.Instance.LoginAsync(); ``` -[PlannerTaskList Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PlannerTaskList). You can [see this in action](uwpct://Controls?sample=PlannerTaskList) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[PlannerTaskList Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PlannerTaskList). You can [see this in action](uwpct://Controls?sample=PlannerTaskList) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[PlannerTaskList XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/PlannerTaskList/PlannerTaskList.xaml) is the XAML template used in the toolkit for the default styling. +[PlannerTaskList XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/PlannerTaskList/PlannerTaskList.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements diff --git a/docs/archive/graph/PowerBIEmbedded.md b/docs/archive/graph/PowerBIEmbedded.md index 86f694fba..fe61bc3da 100644 --- a/docs/archive/graph/PowerBIEmbedded.md +++ b/docs/archive/graph/PowerBIEmbedded.md @@ -72,11 +72,11 @@ The [PowerBIEmbedded Control](/dotnet/api/microsoft.toolkit.uwp.ui.controls.grap ## Sample Project -[PowerBIEmbedded Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PowerBIEmbedded). You can [see this in action](uwpct://Controls?sample=PowerBIEmbedded) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[PowerBIEmbedded Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PowerBIEmbedded). You can [see this in action](uwpct://Controls?sample=PowerBIEmbedded) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[PowerBIEmbedded XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/PowerBIEmbedded/PowerBIEmbedded.xaml) is the XAML template used in the toolkit for the default styling. +[PowerBIEmbedded XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/PowerBIEmbedded/PowerBIEmbedded.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements diff --git a/docs/archive/graph/ProfileCard.md b/docs/archive/graph/ProfileCard.md index 37fabe33c..89ce2ef1d 100644 --- a/docs/archive/graph/ProfileCard.md +++ b/docs/archive/graph/ProfileCard.md @@ -33,7 +33,7 @@ The [ProfileCard Control](/dotnet/api/microsoft.toolkit.uwp.ui.controls.graph.pr | -- | -- | -- | | RequiredDelegatedPermissions | String[] | Gets required delegated permissions for Graph API access | | UserId | String | Identifier of the user being displayed, this user id can come from the Graph APIs like `/me/people`, `/users`, etc. | -| DisplayMode | [ViewType](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/ProfileCard/ViewType.cs) | The visual layout of the control. Default is `PictureOnly` | +| DisplayMode | [ViewType](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/ProfileCard/ViewType.cs) | The visual layout of the control. Default is `PictureOnly` | | DefaultImage | BitmapImage | The default image displayed when no user is signed in | | LargeProfileTitleDefaultText | String | Default title text in LargeProfilePhotoLeft mode or LargeProfilePhotoRight mode when no user is signed in | | LargeProfileMailDefaultText | String | Default secondary mail text in LargeProfilePhotoLeft mode or LargeProfilePhotoRight mode when no user is signed in | @@ -59,11 +59,11 @@ The sign in will be processed by the [AadLogin](AadLogin.md) control, however, y await MicrosoftGraphService.Instance.LoginAsync(); ``` -[ProfileCard Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ProfileCard). You can [see this in action](uwpct://Controls?sample=ProfileCard) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ProfileCard Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ProfileCard). You can [see this in action](uwpct://Controls?sample=ProfileCard) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[ProfileCard XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/ProfileCard/ProfileCard.xaml) is the XAML template used in the toolkit for the default styling. +[ProfileCard XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/ProfileCard/ProfileCard.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements diff --git a/docs/archive/graph/SharePointFileList.md b/docs/archive/graph/SharePointFileList.md index 206933319..6f8e40d15 100644 --- a/docs/archive/graph/SharePointFileList.md +++ b/docs/archive/graph/SharePointFileList.md @@ -33,7 +33,7 @@ The [SharePointFileList Control](/dotnet/api/microsoft.toolkit.uwp.ui.controls.g | -- | -- | -- | | RequiredDelegatedPermissions | String[] | Gets required delegated permissions for Graph API access | | DriveUrl | String | Full URL of the Drive being displayed | -| DetailPane | [DetailPaneDisplayMode](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/SharePointFileList/DetailPaneDisplayMode.cs) | Determines whether file details are displayed, when a file is selected | +| DetailPane | [DetailPaneDisplayMode](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/SharePointFileList/DetailPaneDisplayMode.cs) | Determines whether file details are displayed, when a file is selected | | PageSize | Int | Page size of each request | | ShareLinkCopiedMessage | String | The message when share link copied | | AllFilesMessage | String | The label of All Files | @@ -74,11 +74,11 @@ The sign in will be processed by the [AadLogin](AadLogin.md) control, however, y await MicrosoftGraphService.Instance.LoginAsync(); ``` -[SharePointFileList Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/SharePointFileList). You can [see this in action](uwpct://Controls?sample=SharePointFileList) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[SharePointFileList Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/SharePointFileList). You can [see this in action](uwpct://Controls?sample=SharePointFileList) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[SharePointFileList XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/SharePointFileList/SharePointFileList.xaml) is the XAML template used in the toolkit for the default styling. +[SharePointFileList XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Graph/SharePointFileList/SharePointFileList.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements diff --git a/docs/archive/graph/providers/InteractiveProviderBehavior.md b/docs/archive/graph/providers/InteractiveProviderBehavior.md index e607af663..daf782716 100644 --- a/docs/archive/graph/providers/InteractiveProviderBehavior.md +++ b/docs/archive/graph/providers/InteractiveProviderBehavior.md @@ -51,8 +51,8 @@ Add this behavior to your application's main page. It only needs to be added to ## API -* [InteractiveProviderBehavior source code](https://github.com/windows-toolkit/Graph-Controls/blob/rel/7.0.0/Microsoft.Toolkit.Graph.Controls/Providers/InteractiveProviderBehavior.cs) -* [InteractiveProviderBehavior usage in XAML Islands Sample](https://github.com/windows-toolkit/Graph-Controls/blob/rel/7.0.0/Samples/XAML%20Islands/WPF-Core-GraphApp/MainWindow.xaml) +* [InteractiveProviderBehavior source code](https://github.com/windows-toolkit/Graph-Controls/blob/rel/7.1.0/Microsoft.Toolkit.Graph.Controls/Providers/InteractiveProviderBehavior.cs) +* [InteractiveProviderBehavior usage in XAML Islands Sample](https://github.com/windows-toolkit/Graph-Controls/blob/rel/7.1.0/Samples/XAML%20Islands/WPF-Core-GraphApp/MainWindow.xaml) ## Related Topics diff --git a/docs/archive/graph/providers/MockProviderBehavior.md b/docs/archive/graph/providers/MockProviderBehavior.md index de06b7dcd..dfe0c3b4a 100644 --- a/docs/archive/graph/providers/MockProviderBehavior.md +++ b/docs/archive/graph/providers/MockProviderBehavior.md @@ -40,4 +40,4 @@ Add this behavior to your application's main page. It only needs to be added to ## API -* [MockProviderBehavior source code](https://github.com/windows-toolkit/Graph-Controls/blob/rel/7.0.0/Microsoft.Toolkit.Graph.Controls/Providers/MockProviderBehavior.cs) +* [MockProviderBehavior source code](https://github.com/windows-toolkit/Graph-Controls/blob/rel/7.1.0/Microsoft.Toolkit.Graph.Controls/Providers/MockProviderBehavior.cs) diff --git a/docs/behaviors/FocusBehaviors.md b/docs/behaviors/FocusBehaviors.md index f79b7772e..13d803770 100644 --- a/docs/behaviors/FocusBehaviors.md +++ b/docs/behaviors/FocusBehaviors.md @@ -30,11 +30,11 @@ In this example using the `AutoFocusBehavior` the button will automatically rece ## Sample Project -[Focus behavior sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/FocusBehavior). You can [see this in action](uwpct://Helpers?sample=FocusBehavior) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Focus behavior sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/FocusBehavior). You can [see this in action](uwpct://Helpers?sample=FocusBehavior) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Source Code -- [Focus behaviors source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Behaviors/Focus) +- [Focus behaviors source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Behaviors/Focus) ## Related Topics diff --git a/docs/behaviors/HeaderBehaviors.md b/docs/behaviors/HeaderBehaviors.md index 041f7ffb4..ac11894a7 100644 --- a/docs/behaviors/HeaderBehaviors.md +++ b/docs/behaviors/HeaderBehaviors.md @@ -74,11 +74,11 @@ This is an example using the `FadeHeaderBehavior` the header will fade in and ou ## Sample Project -[ScrollHeader](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ScrollHeader). You can [see this in action](uwpct://Controls?sample=ScrollHeader) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ScrollHeader](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ScrollHeader). You can [see this in action](uwpct://Controls?sample=ScrollHeader) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Source Code -- [Header behaviors source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Behaviors/Headers) +- [Header behaviors source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Behaviors/Headers) ## Related Topics diff --git a/docs/behaviors/KeyDownTriggerBehavior.md b/docs/behaviors/KeyDownTriggerBehavior.md new file mode 100644 index 000000000..c965b800c --- /dev/null +++ b/docs/behaviors/KeyDownTriggerBehavior.md @@ -0,0 +1,46 @@ +--- +title: Key Down Trigger Behavior +author: XAML-Knight +description: Add a new behavior that listens to a key press event on the associated UIElement and triggers the set of actions. +keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, textbox, behaviors, interactivity, KeyDownTrigger, key down trigger +dev_langs: + - csharp +--- + +# Key Down Trigger Behavior + +Add a new behavior that listens to a key press event on the associated UIElement and triggers the set of actions. + +> **Platform APIs:** [`KeyDownTriggerBehavior`](/dotnet/api/microsoft.toolkit.uwp.ui.behaviors.keydowntriggerbehavior) + +> [!div class="nextstepaction"] +> [Try it in the sample app](uwpct://Helpers?sample=KeyDownTriggerBehavior) + +## Example + +In this example setting up the `KeyDownTriggerBehavior` to start the animation: + +```xaml + + + + + + + +``` + +## Sample Project + +[Key Down Trigger behavior sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/main/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/KeyDownTriggerBehavior). You can [see this in action](uwpct://Helpers?sample=KeyDownTriggerBehavior) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). + +## Source Code + +- [Key Down Trigger behavior source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/main/Microsoft.Toolkit.Uwp.UI.Behaviors/Keyboard) + +## Related Topics + +- [XAML Behaviors](https://github.com/microsoft/XamlBehaviors/wiki) diff --git a/docs/brushes/AcrylicBrush.md b/docs/brushes/AcrylicBrush.md index e3108a557..58cc3d2ee 100644 --- a/docs/brushes/AcrylicBrush.md +++ b/docs/brushes/AcrylicBrush.md @@ -55,7 +55,7 @@ Brush brush = PipelineBuilder.FromBackdropAcrylic( ## Sample Project -[AcrylicBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AcrylicBrush). You can [see this in action](uwpct://Brushes?sample=AcrylicBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[AcrylicBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AcrylicBrush). You can [see this in action](uwpct://Brushes?sample=AcrylicBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -66,8 +66,8 @@ Brush brush = PipelineBuilder.FromBackdropAcrylic( ## API -* [AcrylicBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/AcrylicBrush.cs) -* [PipelineBuilder source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Pipelines/PipelineBuilder.cs) +* [AcrylicBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/AcrylicBrush.cs) +* [PipelineBuilder source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Pipelines/PipelineBuilder.cs) ## Related Topics diff --git a/docs/brushes/BackdropBlurBrush.md b/docs/brushes/BackdropBlurBrush.md index fbe932950..16b75a588 100644 --- a/docs/brushes/BackdropBlurBrush.md +++ b/docs/brushes/BackdropBlurBrush.md @@ -34,7 +34,7 @@ The [BackdropBlurBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.backdropblurb ## Sample Project -[BackdropBlurBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropBlurBrush). You can [see this in action](uwpct://Brushes?sample=BackdropBlurBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[BackdropBlurBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropBlurBrush). You can [see this in action](uwpct://Brushes?sample=BackdropBlurBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -45,7 +45,7 @@ The [BackdropBlurBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.backdropblurb ## API -* [BackdropBlurBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropBlurBrush.cs) +* [BackdropBlurBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropBlurBrush.cs) ## Related Topics diff --git a/docs/brushes/BackdropGammaTransferBrush.md b/docs/brushes/BackdropGammaTransferBrush.md index c4a6753df..151ddbfa6 100644 --- a/docs/brushes/BackdropGammaTransferBrush.md +++ b/docs/brushes/BackdropGammaTransferBrush.md @@ -36,7 +36,7 @@ All Amplitude, Disable, Exponent, and Offset properties are available for the Al ## Sample Code -[BackdropGammaTransferBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropGammaTransferBrush). You can [see this in action](uwpct://Brushes?sample=BackdropGammaTransferBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[BackdropGammaTransferBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropGammaTransferBrush). You can [see this in action](uwpct://Brushes?sample=BackdropGammaTransferBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -47,7 +47,7 @@ All Amplitude, Disable, Exponent, and Offset properties are available for the Al ## API -* [BackdropGammaTransferBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropGammaTransferBrush.cs) +* [BackdropGammaTransferBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropGammaTransferBrush.cs) ## Related Topics diff --git a/docs/brushes/BackdropInvertBrush.md b/docs/brushes/BackdropInvertBrush.md index 5da922c68..cae199e47 100644 --- a/docs/brushes/BackdropInvertBrush.md +++ b/docs/brushes/BackdropInvertBrush.md @@ -28,7 +28,7 @@ The [BackdropInvertBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.backdropinv ## Sample Project -[BackdropInvertBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropInvertBrush). You can [see this in action](uwpct://Brushes?sample=BackdropInvertBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[BackdropInvertBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropInvertBrush). You can [see this in action](uwpct://Brushes?sample=BackdropInvertBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -39,7 +39,7 @@ The [BackdropInvertBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.backdropinv ## API -* [BackdropInvertBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropInvertBrush.cs) +* [BackdropInvertBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropInvertBrush.cs) ## Related Topics diff --git a/docs/brushes/BackdropSaturationBrush.md b/docs/brushes/BackdropSaturationBrush.md index e5c599957..b15aa3333 100644 --- a/docs/brushes/BackdropSaturationBrush.md +++ b/docs/brushes/BackdropSaturationBrush.md @@ -34,7 +34,7 @@ The [BackdropSaturationBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.backdro ## Sample Project -[BackdropSaturationBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropSaturationBrush). You can [see this in action](uwpct://Brushes?sample=BackdropSaturationBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[BackdropSaturationBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropSaturationBrush). You can [see this in action](uwpct://Brushes?sample=BackdropSaturationBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -45,7 +45,7 @@ The [BackdropSaturationBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.backdro ## API -* [BackdropSaturationBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropSaturationBrush.cs) +* [BackdropSaturationBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropSaturationBrush.cs) ## Related Topics diff --git a/docs/brushes/BackdropSepiaBrush.md b/docs/brushes/BackdropSepiaBrush.md index 98d45568b..530b754ea 100644 --- a/docs/brushes/BackdropSepiaBrush.md +++ b/docs/brushes/BackdropSepiaBrush.md @@ -34,7 +34,7 @@ The [BackdropSepiaBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.backdropsepi ## Sample Project -[BackdropSepiaBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropSepiaBrush). You can [see this in action](uwpct://Brushes?sample=BackdropSepiaBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[BackdropSepiaBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BackdropSepiaBrush). You can [see this in action](uwpct://Brushes?sample=BackdropSepiaBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -45,7 +45,7 @@ The [BackdropSepiaBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.backdropsepi ## API -* [BackdropSepiaBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropSepiaBrush.cs) +* [BackdropSepiaBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/BackdropSepiaBrush.cs) ## Related Topics diff --git a/docs/brushes/ImageBlendBrush.md b/docs/brushes/ImageBlendBrush.md index 9144a4213..4d047da8f 100644 --- a/docs/brushes/ImageBlendBrush.md +++ b/docs/brushes/ImageBlendBrush.md @@ -39,7 +39,7 @@ The [ImageBlendBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.imageblendbrush ## Sample Project -[ImageBlendBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ImageBlendBrush). You can [see this in action](uwpct://Brushes?sample=ImageBlendBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ImageBlendBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ImageBlendBrush). You can [see this in action](uwpct://Brushes?sample=ImageBlendBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -50,7 +50,7 @@ The [ImageBlendBrush](/dotnet/api/microsoft.toolkit.uwp.ui.media.imageblendbrush ## API -* [ImageBlendBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/ImageBlendBrush.cs) +* [ImageBlendBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/ImageBlendBrush.cs) ## Related Topics diff --git a/docs/brushes/PipelineBrush.md b/docs/brushes/PipelineBrush.md index 3381bbe80..94283063c 100644 --- a/docs/brushes/PipelineBrush.md +++ b/docs/brushes/PipelineBrush.md @@ -69,7 +69,7 @@ Brush brush = ## Sample Project -[PipelineBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PipelineBrush). You can [see this in action](uwpct://Brushes?sample=PipelineBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[PipelineBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/PipelineBrush). You can [see this in action](uwpct://Brushes?sample=PipelineBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -80,8 +80,8 @@ Brush brush = ## API -* [PipelineBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/PipelineBrush.cs) -* [PipelineBuilder source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Pipelines/PipelineBuilder.cs) +* [PipelineBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/PipelineBrush.cs) +* [PipelineBuilder source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Pipelines/PipelineBuilder.cs) ## Related Topics diff --git a/docs/brushes/PipelineVisualFactory.md b/docs/brushes/PipelineVisualFactory.md index 3e20fd407..54d627110 100644 --- a/docs/brushes/PipelineVisualFactory.md +++ b/docs/brushes/PipelineVisualFactory.md @@ -44,4 +44,4 @@ The [`PipelineVisualFactory`](/dotnet/api/microsoft.toolkit.uwp.ui.media.Pipelin ## Examples -You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp). +You can find more examples in the [sample app](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp). diff --git a/docs/brushes/RadialGradientBrush.md b/docs/brushes/RadialGradientBrush.md index 19f32e957..f6a301e5b 100644 --- a/docs/brushes/RadialGradientBrush.md +++ b/docs/brushes/RadialGradientBrush.md @@ -67,7 +67,7 @@ The Animation or Binding of *GradientStop* `Offset` and `Color` properties is no ## Sample Project -[RadialGradientBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RadialGradientBrush). You can [see this in action](uwpct://Brushes?sample=RadialGradientBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[RadialGradientBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RadialGradientBrush). You can [see this in action](uwpct://Brushes?sample=RadialGradientBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -78,7 +78,7 @@ The Animation or Binding of *GradientStop* `Offset` and `Color` properties is no ## API -- [RadialGradientBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/RadialGradientBrush.cs) +- [RadialGradientBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/RadialGradientBrush.cs) ## Related Topics diff --git a/docs/brushes/TilesBrush.md b/docs/brushes/TilesBrush.md index 95a82242f..dd2e88d00 100644 --- a/docs/brushes/TilesBrush.md +++ b/docs/brushes/TilesBrush.md @@ -43,7 +43,7 @@ Brush brush = PipelineBuilder.FromTiles("/Assets/BrushAssets/NoiseTexture.png".T ## Sample Project -[TilesBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TilesBrush). You can [see this in action](uwpct://Brushes?sample=TilesBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[TilesBrush sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TilesBrush). You can [see this in action](uwpct://Brushes?sample=TilesBrush) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -54,8 +54,8 @@ Brush brush = PipelineBuilder.FromTiles("/Assets/BrushAssets/NoiseTexture.png".T ## API -* [TilesBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/TilesBrush.cs) -* [PipelineBuilder source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Media/Pipelines/PipelineBuilder.cs) +* [TilesBrush source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Brushes/TilesBrush.cs) +* [PipelineBuilder source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Media/Pipelines/PipelineBuilder.cs) ## Related Topics diff --git a/docs/collections/ObservableGroups.md b/docs/collections/ObservableGroups.md index af16c249c..c7bafddfd 100644 --- a/docs/collections/ObservableGroups.md +++ b/docs/collections/ObservableGroups.md @@ -106,7 +106,7 @@ It extends [INotifyPropertyChanged](/dotnet/api/system.componentmodel.inotifypro ## Sample Project -[Observable group Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ObservableGroup). +[Observable group Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ObservableGroup). You can [see this in action](uwpct://Helpers?sample=ObservableGroup) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). @@ -119,7 +119,7 @@ You can [see this in action](uwpct://Helpers?sample=ObservableGroup) in the [Win ## API -- [Observable group source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit/Collections) +- [Observable group source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit/Collections) ## Related Topics diff --git a/docs/controls/AdaptiveGridView.md b/docs/controls/AdaptiveGridView.md index b59703fa5..058c01cac 100644 --- a/docs/controls/AdaptiveGridView.md +++ b/docs/controls/AdaptiveGridView.md @@ -143,7 +143,7 @@ There are 3 ways to use this Control: ## Sample Project -[AdaptiveGridView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AdaptiveGridView). You can [see this in action](uwpct://Controls?sample=AdaptiveGridView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[AdaptiveGridView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AdaptiveGridView). You can [see this in action](uwpct://Controls?sample=AdaptiveGridView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -154,7 +154,7 @@ There are 3 ways to use this Control: ## API -- [AdaptiveGridView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/AdaptiveGridView) +- [AdaptiveGridView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/AdaptiveGridView) ## Related Topics diff --git a/docs/controls/BladeView.md b/docs/controls/BladeView.md index c3901a6f6..65a8092c3 100644 --- a/docs/controls/BladeView.md +++ b/docs/controls/BladeView.md @@ -10,7 +10,7 @@ dev_langs: # BladeView -The [BladeView](/dotnet/api/microsoft.toolkit.uwp.ui.controls.bladeview) control provides a container to host [BladeItem](/dotnet/api/microsoft.toolkit.uwp.ui.controls.bladeitem) as extra detail pages in, for example, a master-detail scenario. The control is based on how the Azure Portal works. +The [BladeView](/dotnet/api/microsoft.toolkit.uwp.ui.controls.bladeview) control provides a horizontal collection of [BladeItems](/dotnet/api/microsoft.toolkit.uwp.ui.controls.bladeitem) for drilling into detailed scenarios. The control is based on how the Azure Portal works. > [!div class="nextstepaction"] > [Try it in the sample app](uwpct://Controls?sample=BladeView) @@ -95,11 +95,11 @@ The [BladeView](/dotnet/api/microsoft.toolkit.uwp.ui.controls.bladeview) control ## Sample Project -[BladeView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BladeView). You can [see this in action](uwpct://Controls?sample=BladeView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[BladeView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/BladeView). You can [see this in action](uwpct://Controls?sample=BladeView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[BladeView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/BladeView/BladeView.xaml) is the XAML template used in the toolkit for the default styling. +[BladeView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/BladeView/BladeView.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -110,4 +110,4 @@ The [BladeView](/dotnet/api/microsoft.toolkit.uwp.ui.controls.bladeview) control ## API -- [BladeView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/BladeView) +- [BladeView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/BladeView) diff --git a/docs/controls/CameraPreview.md b/docs/controls/CameraPreview.md index c7b258583..64c0e971f 100644 --- a/docs/controls/CameraPreview.md +++ b/docs/controls/CameraPreview.md @@ -94,7 +94,7 @@ private void CameraPreviewControl_PreviewFailed(object sender, PreviewFailedEven Demonstrates using the camera control and camera helper to preview video from a specific media frame source group. ```csharp -var availableFrameSourceGroups = = await CameraHelper.GetFrameSourceGroupsAsync(); +var availableFrameSourceGroups = await CameraHelper.GetFrameSourceGroupsAsync(); if(availableFrameSourceGroups != null) { CameraHelper cameraHelper = new CameraHelper() { FrameSourceGroup = availableFrameSourceGroups.FirstOrDefault() }; @@ -119,7 +119,7 @@ if(availableFrameSourceGroups != null) ## Sample Project -[CameraPreview Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/CameraPreview). You can [see this in action](uwpct://Controls?sample=CameraPreview) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[CameraPreview Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/CameraPreview). You can [see this in action](uwpct://Controls?sample=CameraPreview) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -130,4 +130,4 @@ if(availableFrameSourceGroups != null) ## API -* [CameraPreview source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/CameraPreview) +* [CameraPreview source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/CameraPreview) diff --git a/docs/controls/Carousel.md b/docs/controls/Carousel.md index e92771688..abbef6787 100644 --- a/docs/controls/Carousel.md +++ b/docs/controls/Carousel.md @@ -67,11 +67,11 @@ The `Carousel` control works fine with mouse, touch, mouse and keyboard as well. ## Sample Project -[Carousel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Carousel). You can [see this in action](uwpct://Controls?sample=Carousel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Carousel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Carousel). You can [see this in action](uwpct://Controls?sample=Carousel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[Carousel XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/Carousel/Carousel.xaml) is the XAML template used in the toolkit for the default styling. +[Carousel XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/Carousel/Carousel.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -82,4 +82,4 @@ The `Carousel` control works fine with mouse, touch, mouse and keyboard as well. ## API -* [Carousel source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/Carousel) +* [Carousel source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/Carousel) diff --git a/docs/controls/ColorPicker.md b/docs/controls/ColorPicker.md index 950cc9466..fa6cb0d12 100644 --- a/docs/controls/ColorPicker.md +++ b/docs/controls/ColorPicker.md @@ -32,11 +32,11 @@ There is also a `DropDownButton` version of the control named `ColorPickerButton ## Sample Project -[ColorPicker sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ColorPicker). You can [see this in action](uwpct://Controls?sample=ColorPicker) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ColorPicker sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ColorPicker). You can [see this in action](uwpct://Controls?sample=ColorPicker) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Source Code -- [ColorPicker source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/ColorPicker) +- [ColorPicker source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/ColorPicker) diff --git a/docs/controls/ConstrainedBox.md b/docs/controls/ConstrainedBox.md new file mode 100644 index 000000000..ef0bfba5e --- /dev/null +++ b/docs/controls/ConstrainedBox.md @@ -0,0 +1,58 @@ +--- +title: ConstrainedBox +author: michael-hawker +description: Constrain a child element by aspect ratio, scale, or multiple. +keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, viewbox, content decorator, ConstrainedBox +dev_langs: + - csharp +--- + +# ConstrainedBox + +The [ConstrainedBox](/dotnet/api/microsoft.toolkit.uwp.ui.controls.constrainedbox) is a simple `FrameworkElement` content decorator control which allows the developer to constrain its child content by one or more various properties including aspect ratio, scale, and aligning to a multiple boundary. + +> [!NOTE] +> For technical reasons this control inherits from `ContentPresenter`; however, it should be treated as a `FrameworkElement` and its border and template properties should not be used for compatibility in the future when it can inherit from FrameworkElement directly. + +> **Platform APIs:** [`ConstrainedBox`](/dotnet/api/microsoft.toolkit.uwp.ui.controls.constrainedbox), [`AspectRatio`](/dotnet/api/microsoft.toolkit.uwp.ui.controls.aspectratio) + +> [!div class="nextstepaction"] +> [Try it in the sample app](uwpct://controls?sample=constrainedbox) + +The three constraints provided by the `ConstrainedBox` control can be used individually & independently or combined to provide a wide-variety of responsive layout options. When used in combination, for the properties used, they are always applied in the following order: + +1. `ScaleX`/`ScaleY`: Scaling is applied first to restrict the overall available size in each axis from the parent container based on a percentage value from 0.0-1.0. The default value is 1.0 to use all available size. + +2. `MultipleX`/`MultipleY`: The multiple values allow a developer to snap the layout size of the child to a specific multiple value. For instance, by providing a value of 4, you would ensure the child element is closest to the size of 16, 20, 24, etc... The floor is taken so the child element is always smaller within the bounds of its parent. By default this value is not set so that no extra layout rounding occurs. + +3. `AspectRatio`: The aspect ratio can be provided by a double value or a colon separated aspect (e.g. "16:9") and will restrict the layout of the child element to that available space. Therefore if you stretch your child element you can ensure it maintains the desired aspect ratio. By default, no aspect ratio constraint is applied. + +If a `ConstrainedBox` is placed in a container which doesn't restrict its size in both the horizontal and vertical directions, it will try to determine its constraints based on the desired size of its child element. If only one direction has infinite size, the control will attempt to use the fixed dimension to measure all constraints against. + +The Min/Max and Alignment properties of the `ConstrainedBox` itself and its child can also be set to provide other constraints on how layout is performed with the control, as with any regular XAML layout. + +## Example + +The following example shows how to align a 16:9 view of an image with the top of its container (like a page) and center on the image's content: + +```xaml + + + +``` + +## Sample Project + +[ConstrainedBox sample page Source](https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Primitives/ConstrainedBox.bind). You can [see this in action](uwpct://controls?sample=constrainedbox) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). + +## Source Code + +- [ConstrainedBox source code](https://github.com/CommunityToolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/ConstrainedBox) + +## Related Topics + +- [UseLayoutRounding](/uwp/api/windows.ui.xaml.uielement.uselayoutrounding) +- [FrameworkElement](/uwp/api/windows.ui.xaml.frameworkelement) +- [Viewbox](/uwp/api/windows.ui.xaml.controls.viewbox) diff --git a/docs/controls/DataGrid.md b/docs/controls/DataGrid.md index ad437660c..6e9f3bdf8 100644 --- a/docs/controls/DataGrid.md +++ b/docs/controls/DataGrid.md @@ -37,7 +37,7 @@ The following guidance sections describe the additional concepts and techniques See the [DataGrid in action](uwpct://Controls?sample=DataGrid) from the **[Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp)**. -Here's the [DataGrid sample source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid). +Here's the [DataGrid sample source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid). If you have the **XAML Controls Gallery** app installed, [open the app and see the DataGrid in action](xamlcontrolsgallery:/item/DataGrid). @@ -52,5 +52,5 @@ If you have the **XAML Controls Gallery** app installed, [open the app and see t ## API -* [DataGrid source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.DataGrid/DataGrid) +* [DataGrid source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.DataGrid/DataGrid) * [Silverlight DataGrid API](/previous-versions/windows/silverlight/dotnet-windows-silverlight/cc189753(v=vs.95)) diff --git a/docs/controls/DockPanel.md b/docs/controls/DockPanel.md index 0132fadba..01add8f78 100644 --- a/docs/controls/DockPanel.md +++ b/docs/controls/DockPanel.md @@ -42,7 +42,7 @@ You can set DockPanel LastChildFill property to true if you want the last item a ## Sample Project -[DockPanel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DockPanel). You can [see this in action](uwpct://Controls?sample=DockPanel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[DockPanel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DockPanel). You can [see this in action](uwpct://Controls?sample=DockPanel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -53,4 +53,4 @@ You can set DockPanel LastChildFill property to true if you want the last item a ## API Source Code -* [DockPanel source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/DockPanel) +* [DockPanel source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/DockPanel) diff --git a/docs/controls/DropShadowPanel.md b/docs/controls/DropShadowPanel.md index 1e5c582cf..6f5884920 100644 --- a/docs/controls/DropShadowPanel.md +++ b/docs/controls/DropShadowPanel.md @@ -10,6 +10,9 @@ dev_langs: # DropShadowPanel +> [!WARNING] +> This control has been deprecated in the Windows Community Toolkit and will be removed in a future release. Please use the new [Attached Shadow](../Helpers/AttachedShadows.md) helpers instead. + The [DropShadowPanel](/dotnet/api/microsoft.toolkit.uwp.ui.controls.dropshadowpanel) control allows the creation of a drop shadow effect for any Xaml FrameworkElement in the markup. > [!div class="nextstepaction"] @@ -62,11 +65,11 @@ The [DropShadowPanel](/dotnet/api/microsoft.toolkit.uwp.ui.controls.dropshadowpa ## Sample Project -[DropShadowPanel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DropShadowPanel). You can [see this in action](uwpct://Controls?sample=DropShadowPanel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[DropShadowPanel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DropShadowPanel). You can [see this in action](uwpct://Controls?sample=DropShadowPanel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[DropShadowPanel XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/DropShadowPanel/DropShadowPanel.xaml) is the XAML template used in the toolkit for the default styling. +[DropShadowPanel XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/DropShadowPanel/DropShadowPanel.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -77,4 +80,4 @@ The [DropShadowPanel](/dotnet/api/microsoft.toolkit.uwp.ui.controls.dropshadowpa ## API -- [DropShadowPanel source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/DropShadowPanel) +- [DropShadowPanel source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/DropShadowPanel) diff --git a/docs/controls/Expander.md b/docs/controls/Expander.md index 5d0a32b88..480d2fa87 100644 --- a/docs/controls/Expander.md +++ b/docs/controls/Expander.md @@ -95,11 +95,11 @@ For instance to remove the header entirely from the Expander: ## Sample Project -[Expander Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Expander). You can [see this in action](uwpct://Controls?sample=Expander) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Expander Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Expander). You can [see this in action](uwpct://Controls?sample=Expander) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[Expander XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/Expander/Expander.xaml) is the XAML template used in the toolkit for the default styling. +[Expander XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/Expander/Expander.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -110,7 +110,7 @@ For instance to remove the header entirely from the Expander: ## API -* [Expander source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/Expander) +* [Expander source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/Expander) ## Related Topics diff --git a/docs/controls/Eyedropper.md b/docs/controls/Eyedropper.md index 8dd766c66..15f24bfb0 100644 --- a/docs/controls/Eyedropper.md +++ b/docs/controls/Eyedropper.md @@ -107,11 +107,11 @@ Dim color = Await eyedropper.Open() ## Sample Project -[Eyedropper Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Eyedropper). You can [see this in action](uwpct://Controls?sample=Eyedropper) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Eyedropper Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Eyedropper). You can [see this in action](uwpct://Controls?sample=Eyedropper) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[Eyedropper XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Media/Eyedropper/Eyedropper.xaml) is the XAML template used in the toolkit for the default styling. +[Eyedropper XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Media/Eyedropper/Eyedropper.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -122,4 +122,4 @@ Dim color = Await eyedropper.Open() ## API -- [Eyedropper source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Media/Eyedropper) +- [Eyedropper source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Media/Eyedropper) diff --git a/docs/controls/GridSplitter.md b/docs/controls/GridSplitter.md index a76f381a0..593d38779 100644 --- a/docs/controls/GridSplitter.md +++ b/docs/controls/GridSplitter.md @@ -101,11 +101,11 @@ The following sample demonstrates how to add Grid Splitter Control ## Sample Code -[GridSplitter Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/GridSplitter). You can [see this in action](uwpct://Controls?sample=GridSplitter) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[GridSplitter Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/GridSplitter). You can [see this in action](uwpct://Controls?sample=GridSplitter) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[GridSplitter XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/GridSplitter/GridSplitter.xaml) is the XAML template used in the toolkit for the default styling. +[GridSplitter XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/GridSplitter/GridSplitter.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -116,4 +116,4 @@ The following sample demonstrates how to add Grid Splitter Control ## API -* [GridSplitter source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/GridSplitter) +* [GridSplitter source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/GridSplitter) diff --git a/docs/controls/HeaderedContentControl.md b/docs/controls/HeaderedContentControl.md index 527c9e6b2..4379086f8 100644 --- a/docs/controls/HeaderedContentControl.md +++ b/docs/controls/HeaderedContentControl.md @@ -70,11 +70,11 @@ The [HeaderedContentControl](/dotnet/api/microsoft.toolkit.uwp.ui.controls.heade ## Sample Project -[HeaderedContentControl Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HeaderedContentControl). You can [see this in action](uwpct://Controls?sample=HeaderedContentControl) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[HeaderedContentControl Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HeaderedContentControl). You can [see this in action](uwpct://Controls?sample=HeaderedContentControl) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[HeaderedContentControl XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/HeaderedContentControl/HeaderedContentControl.xaml) is the XAML template used in the toolkit for the default styling. +[HeaderedContentControl XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/HeaderedContentControl/HeaderedContentControl.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -85,4 +85,4 @@ The [HeaderedContentControl](/dotnet/api/microsoft.toolkit.uwp.ui.controls.heade ## API -- [HeaderedContentControl source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/HeaderedContentControl) +- [HeaderedContentControl source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/HeaderedContentControl) diff --git a/docs/controls/HeaderedItemsControl.md b/docs/controls/HeaderedItemsControl.md index f5cd464e0..e2664143b 100644 --- a/docs/controls/HeaderedItemsControl.md +++ b/docs/controls/HeaderedItemsControl.md @@ -72,11 +72,11 @@ The [HeaderedItemsControl](/dotnet/api/microsoft.toolkit.uwp.ui.controls.headere ## Sample Project -[HeaderedItemsControl Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HeaderedItemsControl). You can [see this in action](uwpct://Controls?sample=HeaderedItemsControl) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[HeaderedItemsControl Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HeaderedItemsControl). You can [see this in action](uwpct://Controls?sample=HeaderedItemsControl) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[HeaderedItemsControl XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/HeaderedItemsControl/HeaderedItemsControl.xaml) is the XAML template used in the toolkit for the default styling. +[HeaderedItemsControl XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/HeaderedItemsControl/HeaderedItemsControl.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -87,4 +87,4 @@ The [HeaderedItemsControl](/dotnet/api/microsoft.toolkit.uwp.ui.controls.headere ## API -- [HeaderedItemsControl source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/HeaderedItemsControl) +- [HeaderedItemsControl source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/HeaderedItemsControl) diff --git a/docs/controls/HeaderedTextBlock.md b/docs/controls/HeaderedTextBlock.md index 1eadae61b..a9a522945 100644 --- a/docs/controls/HeaderedTextBlock.md +++ b/docs/controls/HeaderedTextBlock.md @@ -39,11 +39,11 @@ The [HeaderedTextBlock](/dotnet/api/microsoft.toolkit.uwp.ui.controls.headeredte ## Sample Project -[HeaderedTextBlock Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HeaderedTextBlock). You can [see this in action](uwpct://Controls?sample=HeaderedTextBlock) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[HeaderedTextBlock Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/HeaderedTextBlock). You can [see this in action](uwpct://Controls?sample=HeaderedTextBlock) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[HeaderedTextBlock XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/HeaderedTextBlock/HeaderedTextBlock.xaml) is the XAML template used in the toolkit for the default styling. +[HeaderedTextBlock XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/HeaderedTextBlock/HeaderedTextBlock.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -54,4 +54,4 @@ The [HeaderedTextBlock](/dotnet/api/microsoft.toolkit.uwp.ui.controls.headeredte ## API -* [HeaderedTextBlock source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/HeaderedTextBlock) +* [HeaderedTextBlock source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/HeaderedTextBlock) diff --git a/docs/controls/ImageCropper.md b/docs/controls/ImageCropper.md index a93824575..aabcb51be 100644 --- a/docs/controls/ImageCropper.md +++ b/docs/controls/ImageCropper.md @@ -121,11 +121,11 @@ ImageCropper.AspectRatio = Nothing ## Sample Project -[ImageCropper Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ImageCropper). You can [see this in action](uwpct://Controls?sample=ImageCropper) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ImageCropper Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ImageCropper). You can [see this in action](uwpct://Controls?sample=ImageCropper) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[ImageCropper XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/ImageCropper/ImageCropper.xaml) is the XAML template used in the toolkit for the default styling. +[ImageCropper XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/ImageCropper/ImageCropper.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -136,4 +136,4 @@ ImageCropper.AspectRatio = Nothing ## API -* [ImageCropper source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Media/ImageCropper) +* [ImageCropper source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Media/ImageCropper) diff --git a/docs/controls/ImageEx.md b/docs/controls/ImageEx.md index 92f287d2e..b7487d420 100644 --- a/docs/controls/ImageEx.md +++ b/docs/controls/ImageEx.md @@ -37,15 +37,11 @@ The [ImageEx](/dotnet/api/microsoft.toolkit.uwp.ui.controls.imageex) control dow ## Sample Project -[ImageExControl Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ImageEx). You can [see this in action](uwpct://Controls?sample=ImageEx) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ImageExControl Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ImageEx). You can [see this in action](uwpct://Controls?sample=ImageEx) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -ImageEx control supports use of Progress Indicator. This can be enabled by adding ImageEx template from previous release of the control. - -- [ImageEx Control with Progress Indicator XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/ImageEx/ImageEx.xaml) is the XAML template used in v.7.0.0 of toolkit. - -- [ImageEx Control XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/ImageEx/ImageEx.xaml) is the XAML template used in the toolkit for the default styling. +- [ImageEx Control XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/ImageEx/ImageEx.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -56,4 +52,4 @@ ImageEx control supports use of Progress Indicator. This can be enabled by addin ## API -- [ImageEx source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/ImageEx) +- [ImageEx source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/ImageEx) diff --git a/docs/controls/InAppNotification.md b/docs/controls/InAppNotification.md index aedb5e5c0..05d16b669 100644 --- a/docs/controls/InAppNotification.md +++ b/docs/controls/InAppNotification.md @@ -204,11 +204,11 @@ You can change this behavior with one of these values: Here is the list of existing styles : - - [Microsoft Edge notification style](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/InAppNotification/Styles/MSEdgeNotificationStyle.xaml) + - [Microsoft Edge notification style](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/InAppNotification/Styles/MSEdgeNotificationStyle.xaml) ![Microsoft Edge notification style](../resources/images/Controls/InAppNotification/MicrosoftEdge-Notification-Style.png) - - [Visual Studio Code notification style](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/InAppNotification/Styles/VSCodeNotificationStyle.xaml) + - [Visual Studio Code notification style](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/InAppNotification/Styles/VSCodeNotificationStyle.xaml) ![Visual Studio Code notification style](../resources/images/Controls/InAppNotification/VisualStudioCode-Notification-style.png) @@ -238,18 +238,18 @@ You can change this behavior with one of these values: If you want to add styles to the Toolkit, please follow these steps : -1. Create a `ResourceDictionary` file in [Microsoft.Toolkit.Uwp.UI.Controls/InAppNotification/Styles/](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/InAppNotification/Styles) folder +1. Create a `ResourceDictionary` file in [Microsoft.Toolkit.Uwp.UI.Controls/InAppNotification/Styles/](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/InAppNotification/Styles) folder 2. Create a new `Style` with `TargetType="local:InAppNotification"` 3. Create a new `ControlTemplate` with `TargetType="local:InAppNotification"` and add a `ContentPresenter` inside the Template 4. Do not forget to set the `Template` property inside your `Style` resource ## Sample Project -[InAppNotification Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/InAppNotification). You can [see this in action](uwpct://Controls?sample=InAppNotification) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[InAppNotification Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/InAppNotification). You can [see this in action](uwpct://Controls?sample=InAppNotification) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[InAppNotification XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/InAppNotification/InAppNotification.xaml) is the XAML template used in the toolkit for the default styling. +[InAppNotification XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/InAppNotification/InAppNotification.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -260,4 +260,4 @@ If you want to add styles to the Toolkit, please follow these steps : ## API -- [InAppNotification source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/InAppNotification) +- [InAppNotification source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/InAppNotification) diff --git a/docs/controls/InfiniteCanvas.md b/docs/controls/InfiniteCanvas.md index 58e3883f2..66b3a57e6 100644 --- a/docs/controls/InfiniteCanvas.md +++ b/docs/controls/InfiniteCanvas.md @@ -67,11 +67,11 @@ The following sample demonstrates how to add InfiniteCanvas Control ## Sample Project -[InfiniteCanvas Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/InfiniteCanvas). You can [see this in action](uwpct://Controls?sample=InfiniteCanvas) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[InfiniteCanvas Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/InfiniteCanvas). You can [see this in action](uwpct://Controls?sample=InfiniteCanvas) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[InfiniteCanvas XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/InfiniteCanvas/InfiniteCanvas.xaml) is the XAML template used in the toolkit for the default styling. +[InfiniteCanvas XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/InfiniteCanvas/InfiniteCanvas.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -82,4 +82,4 @@ The following sample demonstrates how to add InfiniteCanvas Control ## API -* [InfiniteCanvas source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Media/InfiniteCanvas) +* [InfiniteCanvas source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Media/InfiniteCanvas) diff --git a/docs/controls/LayoutTransformControl.md b/docs/controls/LayoutTransformControl.md index d57991c51..f8d0bd7ab 100644 --- a/docs/controls/LayoutTransformControl.md +++ b/docs/controls/LayoutTransformControl.md @@ -51,7 +51,7 @@ The transformations that can be applied are one of the following: ## Sample Project -[LayoutTransformControl Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/LayoutTransformControl). You can [see this in action](uwpct://Controls?sample=LayoutTransformControl) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[LayoutTransformControl Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/LayoutTransformControl). You can [see this in action](uwpct://Controls?sample=LayoutTransformControl) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -62,7 +62,7 @@ The transformations that can be applied are one of the following: ## API -*-* [LayoutTransformControl](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/LayoutTransformControl) +*-* [LayoutTransformControl](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/LayoutTransformControl) ## Related Topics diff --git a/docs/controls/Loading.md b/docs/controls/Loading.md index fa81974d3..b5dc17d01 100644 --- a/docs/controls/Loading.md +++ b/docs/controls/Loading.md @@ -68,11 +68,11 @@ LoadingControl.IsLoading = true ## Sample Project -[Loading Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Loading). You can [see this in action](uwpct://Controls?sample=Loading) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Loading Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Loading). You can [see this in action](uwpct://Controls?sample=Loading) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[Loading XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/Loading/Loading.xaml) is the XAML template used in the toolkit for the default styling. +[Loading XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/Loading/Loading.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -83,4 +83,4 @@ LoadingControl.IsLoading = true ## API -- [Loading source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/Loading) +- [Loading source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/Loading) diff --git a/docs/controls/MarkdownTextBlock.md b/docs/controls/MarkdownTextBlock.md index 3ff374402..b6b539077 100644 --- a/docs/controls/MarkdownTextBlock.md +++ b/docs/controls/MarkdownTextBlock.md @@ -212,16 +212,16 @@ block.SetRenderer(); This will likely require intimate knowledge of the implementation of the `MarkdownRenderer`, take a look at the following: -- [MarkdownRenderer and Helpers](https://github.com/windows-toolkit/WindowsCommunityToolit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Markdown/MarkdownTextBlock/Render) -- [Sample App custom markdown renderer](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/Controls/SampleAppMarkdownRenderer) +- [MarkdownRenderer and Helpers](https://github.com/windows-toolkit/WindowsCommunityToolit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Markdown/MarkdownTextBlock/Render) +- [Sample App custom markdown renderer](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/Controls/SampleAppMarkdownRenderer) ## Sample Project -[MarkdownTextBlock Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/MarkdownTextBlock). You can [see this in action](uwpct://Controls?sample=MarkdownTextBlock) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[MarkdownTextBlock Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/MarkdownTextBlock). You can [see this in action](uwpct://Controls?sample=MarkdownTextBlock) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[MarkdownTextBlock XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/MarkdownTextBlock/MarkdownTextBlock.xaml) is the XAML template used in the toolkit for the default styling. +[MarkdownTextBlock XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/MarkdownTextBlock/MarkdownTextBlock.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -232,7 +232,7 @@ This will likely require intimate knowledge of the implementation of the `Markdo ## API -- [MarkdownTextBlock source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Markdown/MarkdownTextBlock) +- [MarkdownTextBlock source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Markdown/MarkdownTextBlock) ## Related Topics diff --git a/docs/controls/MasterDetailsView.md b/docs/controls/MasterDetailsView.md index 1f1f1818e..e0fbb227e 100644 --- a/docs/controls/MasterDetailsView.md +++ b/docs/controls/MasterDetailsView.md @@ -22,13 +22,18 @@ The [ListDetailsView](/dotnet/api/microsoft.toolkit.uwp.ui.controls.listdetailsv ItemTemplate="{StaticResource ListTemplate}" DetailsTemplate="{StaticResource DetailsTemplate}" NoSelectionContentTemplate="{StaticResource NoSelectionContentTemplate}" - CompactModeThresholdWidth="720" /> + CompactModeThresholdWidth="640" /> ``` ## Sample Output ![ListDetailsView animation](../resources/images/Controls/ListDetailsView.gif) +## Multi Screen Devices + +This control is spanning-aware and adapts it self for multi screen devices. +For this internally the [Two-pane view](/windows/uwp/design/controls-and-patterns/two-pane-view) is used. + ## BackButtonBehavior When in compact mode, the `ListDetailsView` will either show the List or the Details view, not both. If an item is selected, the control will *navigate* forward to the Details view. If the CurrentItem is set to `null`, the control will navigate *back* to the List view. @@ -47,12 +52,12 @@ To help with back navigation, The ListDetailsView can handle back button visibil ## Sample Project -[ListDetailsView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ListDetailsView). You can [see this in action](uwpct://Controls?sample=ListDetailsView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ListDetailsView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ListDetailsView). You can [see this in action](uwpct://Controls?sample=ListDetailsView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[ListDetailsView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/ListDetailsView/ListDetailsView.xaml) is the XAML template used in the toolkit for the default styling. +[ListDetailsView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/ListDetailsView/ListDetailsView.xaml) is the XAML template used in the toolkit for the default styling. ## API -- [ListDetailsView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/ListDetailsView) +- [ListDetailsView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/ListDetailsView) diff --git a/docs/controls/Menu.md b/docs/controls/Menu.md index b2bf2ccad..20a5f1568 100644 --- a/docs/controls/Menu.md +++ b/docs/controls/Menu.md @@ -145,11 +145,11 @@ internal class NewProjectCommand : ICommand ## Sample Project -[Menu Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Menu). You can [see this in action](uwpct://Controls?sample=Menu) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Menu Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Menu). You can [see this in action](uwpct://Controls?sample=Menu) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[Menu XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/Menu/Menu.xaml) is the XAML template used in the toolkit for the default styling. +[Menu XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/Menu/Menu.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -160,4 +160,4 @@ internal class NewProjectCommand : ICommand ## API -* [Menu source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/Menu) +* [Menu source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/Menu) diff --git a/docs/controls/MetadataControl.md b/docs/controls/MetadataControl.md new file mode 100644 index 000000000..69793dbdb --- /dev/null +++ b/docs/controls/MetadataControl.md @@ -0,0 +1,68 @@ +--- +title: MetadataControl +author: vgromfeld +description: The MetadataControl control displays a list of labels and hyper-links separated by a bullet. +keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, metadata, metadatacontrol +dev_langs: + - csharp +--- + +# MetadataControl + +The [MetadataControl](/dotnet/api/microsoft.toolkit.uwp.ui.controls.metadatacontrol) control displays a +list of labels and hyper-links separated by a bullet. +It also generates an accessible string representing its content. + +The bullet separator can be customized using the `Separator` property. +`AccessibleSeparator` is used as a replacement for `Separator` to generate the accessible string. + +The control needs a list of [MediadataItem](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/main/Microsoft.Toolkit.Uwp.UI.Controls.Core/MetadataControl/MetadataItem.cs). +Each item will be displayed either as a text or as an hyper-link (if the `Command`property is set). + +The default control template is using on a `TextBlock`. The style of this `TextBlock` can be customized using the `TextBlockStyle` property. + +> [!div class="nextstepaction"] +> [Try it in the sample app](uwpct://CategoryName?sample=MetadataControl) + +## Example + +Add the control in the page: + +```xaml + +``` + +Add items to control: + +```cs +metadataControl.Items = new[] +{ + new MetadataItem { Label = "Hello" }, + new MetadataItem { Label = "World", Command = myCommand }, +}; +``` + +## MediadataItem + +A `MediadataItem` contains the information about one entry which will be displayed in the `MetadataControl` + +| Property | Type | Description | +| -- | -- | -- | +| Label | String | Gets or sets the label of the item | +| AccessibleLabel | String | Gets or sets the automation name that will be set on the item. If not set, `Label` will be used. | +| Command | ICommand | Gets or sets the command associated to the item. If null, the item will be displayed as a text field. If set, the item will be displayed as an hyperlink. | +| CommandParameter | Object | Gets or sets the parameter that will be provided to the `Command`| + +## Sample Project + + +[MetadataControl sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/main/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/MetadataControl). + +You can [see this in action](uwpct://CategoryName?sample=MetadataControl) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). + +## Source Code + +[MetadataControl name source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/main/Microsoft.Toolkit.Uwp.UI.Controls.Core/MetadataControl) diff --git a/docs/controls/OrbitView.md b/docs/controls/OrbitView.md index 7f2396883..f0ee2b775 100644 --- a/docs/controls/OrbitView.md +++ b/docs/controls/OrbitView.md @@ -133,11 +133,11 @@ The following sample demonstrates how to add OrbitView Control. ## Sample Project -[Carousel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/OrbitView).You can [see this in action](uwpct://Controls?sample=OrbitView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Carousel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/OrbitView).You can [see this in action](uwpct://Controls?sample=OrbitView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[OrbitView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/OrbitView/OrbitView.xaml) is the XAML template used in the toolkit for the default styling. +[OrbitView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/OrbitView/OrbitView.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -148,4 +148,4 @@ The following sample demonstrates how to add OrbitView Control. ## API -* [OrbitView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/OrbitView) +* [OrbitView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/OrbitView) diff --git a/docs/controls/RadialGauge.md b/docs/controls/RadialGauge.md index 34e0aaca6..e7fe05d6d 100644 --- a/docs/controls/RadialGauge.md +++ b/docs/controls/RadialGauge.md @@ -65,7 +65,7 @@ The Radial Gauge supports animated transitions between configuration states. The ## Control style and template -You can modify the default [Style](/uwp/api/windows.ui.xaml.style) and [ControlTemplate](/uwp/api/windows.ui.xaml.controls.controltemplate) to give the control a unique appearance. For information about modifying a control's style and template, see [Styling controls](/windows/uwp/design/controls-and-patterns/xaml-styles). The default style, template, and resources that define the look of the control are included in the RadialGauge.xaml file. For design purposes, RadialGauge.xaml is available on [GitHub](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/RadialGauge/RadialGauge.xaml). Styles and resources from different versions of the SDK might have different values. +You can modify the default [Style](/uwp/api/windows.ui.xaml.style) and [ControlTemplate](/uwp/api/windows.ui.xaml.controls.controltemplate) to give the control a unique appearance. For information about modifying a control's style and template, see [Styling controls](/windows/uwp/design/controls-and-patterns/xaml-styles). The default style, template, and resources that define the look of the control are included in the RadialGauge.xaml file. For design purposes, RadialGauge.xaml is available on [GitHub](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/RadialGauge/RadialGauge.xaml). Styles and resources from different versions of the SDK might have different values. Starting in Toolkit version 2.2, RadialGauge.xaml includes resources that you can use to modify the colors of a control in different visual states without modifying the control template. In apps that target this software development kit (SDK) or later, modifying these resources is preferred to setting properties such as Background and Foreground. For more info, see the Light-weight styling section of the Styling controls article. @@ -78,11 +78,11 @@ This table shows the resources used by the [RadialGauge](/dotnet/api/microsoft.t ## Sample Project -[RadialGauge Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RadialGauge). You can [see this in action](uwpct://Controls?sample=RadialGauge) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[RadialGauge Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RadialGauge). You can [see this in action](uwpct://Controls?sample=RadialGauge) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[RadialGauge XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0//Microsoft.Toolkit.Uwp.UI.Controls/RadialGauge/RadialGauge.xaml) is the XAML template used in the toolkit for the default styling. +[RadialGauge XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0//Microsoft.Toolkit.Uwp.UI.Controls/RadialGauge/RadialGauge.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -93,4 +93,4 @@ This table shows the resources used by the [RadialGauge](/dotnet/api/microsoft.t ## API -* [RadialGauge source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/RadialGauge) +* [RadialGauge source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/RadialGauge) diff --git a/docs/controls/RadialProgressBar.md b/docs/controls/RadialProgressBar.md index f8a5e2f1e..a109ec1e1 100644 --- a/docs/controls/RadialProgressBar.md +++ b/docs/controls/RadialProgressBar.md @@ -45,11 +45,11 @@ The control uses the same dependency properties as the standard Progress Bar, wi ## Sample Project -[RadialProgressBar Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RadialProgressBar). You can [see this in action](uwpct://Controls?sample=RadialProgressBar) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[RadialProgressBar Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RadialProgressBar). You can [see this in action](uwpct://Controls?sample=RadialProgressBar) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[RadialProgressBar XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/RadialProgressBar/RadialProgressBar.xaml) is the XAML template used in the toolkit for the default styling. +[RadialProgressBar XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/RadialProgressBar/RadialProgressBar.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -60,4 +60,4 @@ The control uses the same dependency properties as the standard Progress Bar, wi ## API -- [RadialProgressBar source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/RadialProgressBar) +- [RadialProgressBar source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/RadialProgressBar) diff --git a/docs/controls/RangeSelector.md b/docs/controls/RangeSelector.md index b58bda96a..66006a58e 100644 --- a/docs/controls/RangeSelector.md +++ b/docs/controls/RangeSelector.md @@ -73,12 +73,12 @@ End Sub ## Sample Project -[RangeSelector Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RangeSelector). You can [see this in action](uwpct://Controls?sample=RangeSelector) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[RangeSelector Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RangeSelector). You can [see this in action](uwpct://Controls?sample=RangeSelector) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[RangeSelector XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/RangeSelector/RangeSelector.xaml) is the XAML template used in the toolkit for the default styling. +[RangeSelector XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/RangeSelector/RangeSelector.xaml) is the XAML template used in the toolkit for the default styling. ## Source code -* [RangeSelector source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/RangeSelector) +* [RangeSelector source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/RangeSelector) diff --git a/docs/controls/RemoteDevicePicker.md b/docs/controls/RemoteDevicePicker.md index 340ec157a..5dc3ce705 100644 --- a/docs/controls/RemoteDevicePicker.md +++ b/docs/controls/RemoteDevicePicker.md @@ -51,11 +51,11 @@ await new MessageDialog($"You picked {remoteSystems.Count().ToString()} Device(s ## Sample Project -[RemoteDevicePicker Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RemoteDevicePicker). You can [see this in action](uwpct://Controls?sample=RemoteDevicePicker) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[RemoteDevicePicker Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RemoteDevicePicker). You can [see this in action](uwpct://Controls?sample=RemoteDevicePicker) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[RemoteDevicePicker XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/RemoteDevicePicker/RemoteDevicePicker.xaml) is the XAML template used in the toolkit for the default styling. +[RemoteDevicePicker XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/RemoteDevicePicker/RemoteDevicePicker.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -66,12 +66,12 @@ await new MessageDialog($"You picked {remoteSystems.Count().ToString()} Device(s ## API -* [RemoteDevicePicker source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/RemoteDevicePicker) +* [RemoteDevicePicker source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/RemoteDevicePicker) ## Related Topics * [Project Rome](https://developer.microsoft.com/windows/project-rome) -* [Remote Systems Sample](https://github.com/Microsoft/Windows-universal-samples/tree/rel/7.0.0/Samples/RemoteSystems) +* [Remote Systems Sample](https://github.com/Microsoft/Windows-universal-samples/tree/rel/7.1.0/Samples/RemoteSystems) * [Connected apps and devices (Project Rome)](/windows/uwp/launch-resume/connected-apps-and-devices) * [Communicate with a remote app service](/windows/uwp/launch-resume/communicate-with-a-remote-app-service) -* [AppServices Sample](https://github.com/Microsoft/Windows-universal-samples/tree/rel/7.0.0/Samples/AppServices) +* [AppServices Sample](https://github.com/Microsoft/Windows-universal-samples/tree/rel/7.1.0/Samples/AppServices) diff --git a/docs/controls/RichSuggestBox.md b/docs/controls/RichSuggestBox.md new file mode 100644 index 000000000..cdc0a8754 --- /dev/null +++ b/docs/controls/RichSuggestBox.md @@ -0,0 +1,120 @@ +--- +title: RichSuggestBox +author: huynhsontung +description: A rich text input control that auto-suggests and stores token items in a document. +keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, RichSuggestBox +dev_langs: + - csharp +--- + +# RichSuggestBox + +The [RichSuggestBox](/dotnet/api/microsoft.toolkit.uwp.ui.controls.richsuggestbox) is a combination of [AutoSuggestBox](/uwp/api/windows.ui.xaml.controls.autosuggestbox) and [RichEditBox](/uwp/api/windows.ui.xaml.controls.richeditbox) that can provide suggestions based on customizable prefixes. Selected suggestions are embedded and tracked in the document as tokens. + +RichSuggestBox resembles text controls commonly found in social applications where you type "@" to mention people. + +> **Platform APIs:** [`RichSuggestBox`](/dotnet/api/microsoft.toolkit.uwp.ui.controls.richsuggestbox) + +> [!div class="nextstepaction"] +> [Try it in the sample app](uwpct://Controls?sample=RichSuggestBox) + +## Syntax + +```xaml + +``` + +## Example Output + +![RichSuggestBox Example](../resources/images/Controls/RichSuggestBox.gif) + +## Remarks + +When a suggestion is selected, `RichSuggestBox` assigns the selected item a unique [Guid](/dotnet/api/system.guid) and a display text (provided by the developer) to make up a token. The display text is then padded with [Zero Width Space](https://unicode-table.com/200B/)s (ZWSP) and inserted into the document as a hyperlink using the identifier as the link address. These hyperlinks are tracked and validated on every text change. + +The token text inserted into the document has the following layout: ZWSP - Prefix character - Display text - ZWSP. + +For example, a token with "@" as the prefix and "John Doe" as the display text is inserted as: + +```cs +"\u200b@John Doe\u200b" +``` + +> [!IMPORTANT] +> Token text contains [Zero Width Space](https://unicode-table.com/200B/)s, which are Unicode characters. + +> [!NOTE] +> To support Undo/Redo function, `RichSuggestBox` keeps all the tokens in an internal collection even when the token text is deleted from the document. These token are marked as inactive and are not included in the `Tokens` collection. Use `ClearUndoRedoSuggestionHistory()` method to clear inactive tokens or `Clear()` method to clear all tokens. + +## Examples + +### Handle multiple token types + +The example below creates a `RichSuggestBox` that can tokenize both mentions (query starts with `@`) and hashtags (query starts with `#`). + +```xaml + +``` + +```cs +private void OnSuggestionChosen(RichSuggestBox sender, SuggestionChosenEventArgs args) +{ + if (args.Prefix == "#") + { + // User selected a hashtag item + args.DisplayText = ((SampleHashtagDataType)args.SelectedItem).Text; + } + else + { + // User selected a mention item + args.DisplayText = ((SampleEmailDataType)args.SelectedItem).DisplayName; + } +} + +private void OnSuggestionRequested(RichSuggestBox sender, SuggestionRequestedEventArgs args) +{ + sender.ItemsSource = args.Prefix == "#" + ? _hashtags.Where(x => x.Text.Contains(args.QueryText, StringComparison.OrdinalIgnoreCase)) + : _emails.Where(x => x.DisplayName.Contains(args.QueryText, StringComparison.OrdinalIgnoreCase)); +} +``` + +### Plain text only + +The example below creates a `RichSuggestBox` that only allows users to enter plain text. The only formatted texts in the document are tokens. + +```xaml + +``` + +## Sample Project + +[RichSuggestBox sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RichSuggestBox). You can [see this in action](uwpct://Controls?sample=RichSuggestBox) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). + +## Requirements + +| Device family | Universal, 10.0.17763.0 or higher | +| -- | -- | +| Namespace | Microsoft.Toolkit.Uwp.UI.Controls | +| NuGet package | [Microsoft.Toolkit.Uwp.UI.Controls](https://www.nuget.org/packages/Microsoft.Toolkit.Uwp.UI.Controls/) | + +## Source Code + +- [RichSuggestBox source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/RichSuggestBox) + +## Related Topics + +- [AutoSuggestBox](/uwp/api/windows.ui.xaml.controls.autosuggestbox) +- [RichEditBox](/uwp/api/windows.ui.xaml.controls.richeditbox) +- [TokenizingTextBox](TokenizingTextBox.md) diff --git a/docs/controls/RotatorTile.md b/docs/controls/RotatorTile.md index 356054ed9..0b6cb4959 100644 --- a/docs/controls/RotatorTile.md +++ b/docs/controls/RotatorTile.md @@ -43,11 +43,11 @@ The [Rotator Tile Control](/dotnet/api/microsoft.toolkit.uwp.ui.controls.rotator ## Sample Project -[RotatorTile Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RotatorTile). You can [see this in action](uwpct://Controls?sample=RotatorTile) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[RotatorTile Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/RotatorTile). You can [see this in action](uwpct://Controls?sample=RotatorTile) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[RotatorTile XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/RotatorTile/RotatorTile.xaml) is the XAML template used in the toolkit for the default styling. +[RotatorTile XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/RotatorTile/RotatorTile.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -58,4 +58,4 @@ The [Rotator Tile Control](/dotnet/api/microsoft.toolkit.uwp.ui.controls.rotator ## API -* [RotatorTile source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/RotatorTile) +* [RotatorTile source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/RotatorTile) diff --git a/docs/controls/ScrollHeader.md b/docs/controls/ScrollHeader.md index db96decb8..775166880 100644 --- a/docs/controls/ScrollHeader.md +++ b/docs/controls/ScrollHeader.md @@ -52,11 +52,11 @@ The [ScrollHeader](/dotnet/api/microsoft.toolkit.uwp.ui.controls.scrollheader) c ## Sample Project -[ScrollHeader Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ScrollHeader). You can [see this in action](uwpct://Controls?sample=ScrollHeader) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[ScrollHeader Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/ScrollHeader). You can [see this in action](uwpct://Controls?sample=ScrollHeader) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[ScrollHeader XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/ScrollHeader/ScrollHeader.xaml) is the XAML template used in the toolkit for the default styling. +[ScrollHeader XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/ScrollHeader/ScrollHeader.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -67,4 +67,4 @@ The [ScrollHeader](/dotnet/api/microsoft.toolkit.uwp.ui.controls.scrollheader) c ## API -* [ScrollHeader source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/ScrollHeader) +* [ScrollHeader source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/ScrollHeader) diff --git a/docs/controls/StaggeredPanel.md b/docs/controls/StaggeredPanel.md index 35f7b941f..a4f6001f2 100644 --- a/docs/controls/StaggeredPanel.md +++ b/docs/controls/StaggeredPanel.md @@ -44,11 +44,11 @@ The [StaggeredPanel](/dotnet/api/microsoft.toolkit.uwp.ui.controls.staggeredpane ## Sample Project -[StaggeredPanel Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/StaggeredPanel). You can [see this in action](uwpct://Controls?sample=StaggeredPanel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[StaggeredPanel Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/StaggeredPanel). You can [see this in action](uwpct://Controls?sample=StaggeredPanel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[StaggeredPanel XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/StaggeredPanel/StaggeredPanel.xaml) is the XAML template used in the toolkit for the default styling. +[StaggeredPanel XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/StaggeredPanel/StaggeredPanel.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -59,4 +59,4 @@ The [StaggeredPanel](/dotnet/api/microsoft.toolkit.uwp.ui.controls.staggeredpane ## API -- [StaggeredPanel](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/StaggeredPanel) +- [StaggeredPanel](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/StaggeredPanel) diff --git a/docs/controls/SwitchPresenter.md b/docs/controls/SwitchPresenter.md index 6789346ff..da507c8ff 100644 --- a/docs/controls/SwitchPresenter.md +++ b/docs/controls/SwitchPresenter.md @@ -54,7 +54,7 @@ Unlike traditional approaches of showing/hiding components within a page, the `S ## Sample Project -[SwitchPresenter sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Primitives/SwitchPresenter.bind). You can [see this in action](uwpct://Controls?sample=SwitchPresenter) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[SwitchPresenter sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Primitives/SwitchPresenter.bind). You can [see this in action](uwpct://Controls?sample=SwitchPresenter) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -65,7 +65,7 @@ Unlike traditional approaches of showing/hiding components within a page, the `S ## API -* [SwitchPresenter source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/SwitchPresenter) +* [SwitchPresenter source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/SwitchPresenter) ## Related Topics diff --git a/docs/controls/TabView.md b/docs/controls/TabView.md index 76c524cf7..e880c6f99 100644 --- a/docs/controls/TabView.md +++ b/docs/controls/TabView.md @@ -133,11 +133,11 @@ The TabView supports data binding as well. The following example shows binding ## Sample Project -[TabView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TabView). You can [see this in action](uwpct://Controls?sample=TabView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[TabView Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TabView). You can [see this in action](uwpct://Controls?sample=TabView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[TabView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/TabView/TabView.xaml) is the XAML template used in the toolkit for the default styling. +[TabView XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/TabView/TabView.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -148,7 +148,7 @@ The TabView supports data binding as well. The following example shows binding ## API -- [TabView source code](https://github.com/microsoft/microsoft-ui-xaml/tree/rel/7.0.0/dev/TabView) +- [TabView source code](https://github.com/microsoft/microsoft-ui-xaml/tree/rel/7.1.0/dev/TabView) ## Related Topics diff --git a/docs/controls/TabbedCommandBar.md b/docs/controls/TabbedCommandBar.md index 17c8d83db..1e625f82b 100644 --- a/docs/controls/TabbedCommandBar.md +++ b/docs/controls/TabbedCommandBar.md @@ -224,11 +224,11 @@ The following setup demos contextual tabs, and binding to their visibility: ## Sample Project -[TabbedCommandBar Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TabbedCommandBar). You can [see this in action](uwpct://Controls?sample=TabbedCommandBar) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[TabbedCommandBar Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TabbedCommandBar). You can [see this in action](uwpct://Controls?sample=TabbedCommandBar) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[TabbedCommandBar XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/TabbedCommandBar/TabbedCommandBar.xaml) is the XAML template used in the toolkit for the default styling. +[TabbedCommandBar XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/TabbedCommandBar/TabbedCommandBar.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -239,7 +239,7 @@ The following setup demos contextual tabs, and binding to their visibility: ## API -- [TabbedCommandBar source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/TabbedCommandBar) +- [TabbedCommandBar source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/TabbedCommandBar) ## Related Topics diff --git a/docs/controls/TextToolbar.md b/docs/controls/TextToolbar.md index b79d46ff7..954ab59c2 100644 --- a/docs/controls/TextToolbar.md +++ b/docs/controls/TextToolbar.md @@ -53,13 +53,13 @@ When you create the Class, you will need to override the `DefaultButtons` Proper If you want to use a Common Button Template, such as Bold, Italics, etc. You can get those by Instantiating a `CommonButtons` Instance in your Formatter Class, however, you will need to implement the **ButtonActions** Class, and Instantiate it in your Formatter's `ButtonActions` property, or replace the `Action`/`Shift Action` Property on each button you use. _See the MarkDownFormatter Class for reference on how to create a Formatter:_ -[MarkDownFormatter Code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/TextToolbar/Formats/MarkDown) +[MarkDownFormatter Code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/TextToolbar/Formats/MarkDown) _See the Sample Formatter Class from the Sample App:_ -[SampleFormatter Code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TextToolbar/SampleFormatter.cs) +[SampleFormatter Code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TextToolbar/SampleFormatter.cs) _Available CommonButtons:_ -[CommonButton Definitions](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/TextToolbar/ToolbarItems/Common) +[CommonButton Definitions](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/TextToolbar/ToolbarItems/Common) ## Examples @@ -111,7 +111,7 @@ Toolbar.CustomButtons.Add(New ToolbarSeparator With {.Position = 2}) ## Sample Project -[TextToolbar Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TextToolbar). You can [see this in action](uwpct://Controls?sample=TextToolbar) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[TextToolbar Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TextToolbar). You can [see this in action](uwpct://Controls?sample=TextToolbar) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -122,4 +122,4 @@ Toolbar.CustomButtons.Add(New ToolbarSeparator With {.Position = 2}) ## API -* [TextToolbar source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/TextToolbar) +* [TextToolbar source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/TextToolbar) diff --git a/docs/controls/TileControl.md b/docs/controls/TileControl.md index b00fcce1a..896160d09 100644 --- a/docs/controls/TileControl.md +++ b/docs/controls/TileControl.md @@ -48,11 +48,11 @@ The [TileControl](/dotnet/api/microsoft.toolkit.uwp.ui.controls.tilecontrol) is ## Sample Project -[TileControl Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TileControl). You can [see this in action](uwpct://Controls?sample=TileControl) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[TileControl Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TileControl). You can [see this in action](uwpct://Controls?sample=TileControl) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Default Template -[TileControl XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls/TileControl/TileControl.xaml) is the XAML template used in the toolkit for the default styling. +[TileControl XAML File](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls/TileControl/TileControl.xaml) is the XAML template used in the toolkit for the default styling. ## Requirements @@ -63,4 +63,4 @@ The [TileControl](/dotnet/api/microsoft.toolkit.uwp.ui.controls.tilecontrol) is ## API -* [TileControl source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/TileControl) +* [TileControl source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Core/TileControl) diff --git a/docs/controls/TokenizingTextBox.md b/docs/controls/TokenizingTextBox.md index 0ebb2eabc..7b10b8d09 100644 --- a/docs/controls/TokenizingTextBox.md +++ b/docs/controls/TokenizingTextBox.md @@ -72,7 +72,7 @@ The [TokenizingTextBox](/dotnet/api/microsoft.toolkit.uwp.ui.controls.tokenizing ## Sample Project -[TokenizingTextBox sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TokenizingTextBox). You can [see this in action](uwpct://Controls?sample=TokenizingTextBox) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[TokenizingTextBox sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TokenizingTextBox). You can [see this in action](uwpct://Controls?sample=TokenizingTextBox) in [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -83,7 +83,7 @@ The [TokenizingTextBox](/dotnet/api/microsoft.toolkit.uwp.ui.controls.tokenizing ## API -* [TokenizingTextBox source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox) +* [TokenizingTextBox source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Input/TokenizingTextBox) ## Related Topics diff --git a/docs/controls/UniformGrid.md b/docs/controls/UniformGrid.md index 778012e25..2475a4979 100644 --- a/docs/controls/UniformGrid.md +++ b/docs/controls/UniformGrid.md @@ -176,7 +176,7 @@ In addition to `FlowDirection` to layout items from Right-to-Left. The UWP Unif ## Sample Project -[UniformGrid Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/UniformGrid). You can [see this in action](uwpct://Controls?sample=UniformGrid) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[UniformGrid Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/UniformGrid). You can [see this in action](uwpct://Controls?sample=UniformGrid) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements (Windows 10 Device Family) @@ -187,7 +187,7 @@ In addition to `FlowDirection` to layout items from Right-to-Left. The UWP Unif ## API -- [UniformGrid source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/UniformGrid) +- [UniformGrid source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/UniformGrid) ## Related Topics diff --git a/docs/controls/WrapPanel.md b/docs/controls/WrapPanel.md index 37db1edb5..df6d17c75 100644 --- a/docs/controls/WrapPanel.md +++ b/docs/controls/WrapPanel.md @@ -75,7 +75,7 @@ The following example of adding WrapPanel Control. ## Sample Project -[WrapPanel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/WrapPanel). You can [see this in action](uwpct://Controls?sample=WrapPanel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[WrapPanel Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/WrapPanel). You can [see this in action](uwpct://Controls?sample=WrapPanel) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -86,4 +86,4 @@ The following example of adding WrapPanel Control. ## API -* [WrapPanel source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/WrapPanel) +* [WrapPanel source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Primitives/WrapPanel) diff --git a/docs/controls/datagrid_guidance/customize_autogenerated_columns.md b/docs/controls/datagrid_guidance/customize_autogenerated_columns.md index 7ced9da9c..2853fa219 100644 --- a/docs/controls/datagrid_guidance/customize_autogenerated_columns.md +++ b/docs/controls/datagrid_guidance/customize_autogenerated_columns.md @@ -88,4 +88,4 @@ if (e.PropertyType == GetType(Boolean)) * [Add a DataGrid control to a page](datagrid_basics.md) * [Customize the DataGrid control using styling and formatting options](styling_formatting_options.md) * [Sizing options in the DataGrid control](sizing_options.md) -* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) +* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) diff --git a/docs/controls/datagrid_guidance/datagrid_basics.md b/docs/controls/datagrid_guidance/datagrid_basics.md index 6724d3067..3de8ed5f4 100644 --- a/docs/controls/datagrid_guidance/datagrid_basics.md +++ b/docs/controls/datagrid_guidance/datagrid_basics.md @@ -279,4 +279,4 @@ The following code example demonstrates how to specify and configure a DataGridT * [Configure Auto-generated columns in the DataGrid control](customize_autogenerated_columns.md) * [Group, sort and filter data using LINQ and the DataGrid control](group_sort_filter.md) * [Editing and input validation in the DataGrid control](editing_inputvalidation.md) -* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) +* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) diff --git a/docs/controls/datagrid_guidance/editing_inputvalidation.md b/docs/controls/datagrid_guidance/editing_inputvalidation.md index 9302fabb3..84449a9f3 100644 --- a/docs/controls/datagrid_guidance/editing_inputvalidation.md +++ b/docs/controls/datagrid_guidance/editing_inputvalidation.md @@ -53,11 +53,11 @@ DataGrid control supports input validation through **INotifyDataErrorInfo** in y ![Sample UI with INotifyDataErrorInfo](../../resources/images/Controls/DataGrid/validation.png) -See [DataGrid Sample](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) for an example of how to handle input validation in the DataGrid control. +See [DataGrid Sample](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) for an example of how to handle input validation in the DataGrid control. ## See Also * [Add a DataGrid control to a page](datagrid_basics.md) * [Customize the DataGrid control through UI formatting options](styling_formatting_options.md) * [Keyboard navigation and selection](keyboard_navigation_selection.md) -* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) +* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) diff --git a/docs/controls/datagrid_guidance/group_sort_filter.md b/docs/controls/datagrid_guidance/group_sort_filter.md index 1580d7769..9f5d77a73 100644 --- a/docs/controls/datagrid_guidance/group_sort_filter.md +++ b/docs/controls/datagrid_guidance/group_sort_filter.md @@ -11,7 +11,7 @@ It is often useful to view data in a DataGrid in different ways by grouping, sor The following walk-throughs demonstrate how to implement grouping, sorting and filtering for the DataGrid control through examples. -See [DataGrid Sample](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) for the complete sample code and running app. +See [DataGrid Sample](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) for the complete sample code and running app. ## 1. Grouping @@ -228,7 +228,7 @@ The DataGrid control does not support any built-in filtering capabilities. The f ## Example app -For the complete example of all the capabilities in this section in a running application, see [DataGrid Sample](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid). +For the complete example of all the capabilities in this section in a running application, see [DataGrid Sample](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid). ## See Also diff --git a/docs/controls/datagrid_guidance/keyboard_navigation_selection.md b/docs/controls/datagrid_guidance/keyboard_navigation_selection.md index 555ac5c7d..1f270c52c 100644 --- a/docs/controls/datagrid_guidance/keyboard_navigation_selection.md +++ b/docs/controls/datagrid_guidance/keyboard_navigation_selection.md @@ -101,4 +101,4 @@ Double-tap a row group header | Expands or collapses the group. * [Sizing options in the DataGrid control](sizing_options.md) * [Group, sort and filter data using LINQ and the DataGrid control](group_sort_filter.md) * [Editing and input validation in the DataGrid control](editing_inputvalidation.md) -* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) +* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) diff --git a/docs/controls/datagrid_guidance/rowdetails.md b/docs/controls/datagrid_guidance/rowdetails.md index a7c0c7fd4..4caad5ea1 100644 --- a/docs/controls/datagrid_guidance/rowdetails.md +++ b/docs/controls/datagrid_guidance/rowdetails.md @@ -96,4 +96,4 @@ Set the **AreRowDetailsFrozen** property to true. * [Add a DataGrid control to a page](datagrid_basics.md) * [Customize the DataGrid control using styling and formatting options](styling_formatting_options.md) * [Sizing options in the DataGrid control](sizing_options.md) -* [DataGrid Sample](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid). +* [DataGrid Sample](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid). diff --git a/docs/controls/datagrid_guidance/sizing_options.md b/docs/controls/datagrid_guidance/sizing_options.md index 48e5024fd..4647bf1f3 100644 --- a/docs/controls/datagrid_guidance/sizing_options.md +++ b/docs/controls/datagrid_guidance/sizing_options.md @@ -88,4 +88,4 @@ Users can resize DataGrid columns by dragging the column header dividers with mo * [Add a DataGrid control to a page](datagrid_basics.md) * [Customize the DataGrid control using styling and formatting options](styling_formatting_options.md) -* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) +* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) diff --git a/docs/controls/datagrid_guidance/styling_formatting_options.md b/docs/controls/datagrid_guidance/styling_formatting_options.md index 1ee852017..1662f7694 100644 --- a/docs/controls/datagrid_guidance/styling_formatting_options.md +++ b/docs/controls/datagrid_guidance/styling_formatting_options.md @@ -124,4 +124,4 @@ You can allow users to: * [Configure Auto-generated columns in the DataGrid control](customize_autogenerated_columns.md) * [Group, sort and filter data using LINQ and the DataGrid control](group_sort_filter.md) * [Editing and input validation in the DataGrid control](editing_inputvalidation.md) -* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) +* [DataGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/DataGrid) diff --git a/docs/controls/layout/StaggeredLayout.md b/docs/controls/layout/StaggeredLayout.md index 0a123aad5..4ea2cecac 100644 --- a/docs/controls/layout/StaggeredLayout.md +++ b/docs/controls/layout/StaggeredLayout.md @@ -42,7 +42,7 @@ The [StaggeredLayout](/dotnet/api/microsoft.toolkit.uwp.ui.controls.StaggeredLay ## Sample Project -[StaggeredLayout Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/StaggeredLayout). You can [see this in action](uwpct://Controls?sample=StaggeredLayout) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[StaggeredLayout Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/StaggeredLayout). You can [see this in action](uwpct://Controls?sample=StaggeredLayout) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -53,4 +53,4 @@ The [StaggeredLayout](/dotnet/api/microsoft.toolkit.uwp.ui.controls.StaggeredLay ## API -- [StaggeredLayout](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/StaggeredLayout) +- [StaggeredLayout](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/StaggeredLayout) diff --git a/docs/controls/layout/WrapLayout.md b/docs/controls/layout/WrapLayout.md index 929ae16c8..b9c380b20 100644 --- a/docs/controls/layout/WrapLayout.md +++ b/docs/controls/layout/WrapLayout.md @@ -88,7 +88,7 @@ The following example of adding the WrapLayout layout panel. ## Sample Project -[WrapLayout Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/WrapLayout). You can [see this in action](uwpct://Controls?sample=WrapLayout) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[WrapLayout Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/WrapLayout). You can [see this in action](uwpct://Controls?sample=WrapLayout) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -99,4 +99,4 @@ The following example of adding the WrapLayout layout panel. ## API -* [WrapLayout source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/WrapLayout) +* [WrapLayout source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI.Controls.Layout/WrapLayout) diff --git a/docs/developer-tools/AlignmentGrid.md b/docs/developer-tools/AlignmentGrid.md index 6a4a1985e..656c6a14c 100644 --- a/docs/developer-tools/AlignmentGrid.md +++ b/docs/developer-tools/AlignmentGrid.md @@ -35,7 +35,7 @@ You can control the grid's steps with `HorizontalStep` and `VerticalStep` proper ## Sample Project -[AlignmentGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AlignmentGrid). You can [see this in action](uwpct://Controls?sample=AlignmentGrid) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[AlignmentGrid Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AlignmentGrid). You can [see this in action](uwpct://Controls?sample=AlignmentGrid) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -46,4 +46,4 @@ You can control the grid's steps with `HorizontalStep` and `VerticalStep` proper ## API -* [AlignmentGrid source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.DeveloperTools/AlignmentGrid) +* [AlignmentGrid source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.DeveloperTools/AlignmentGrid) diff --git a/docs/developer-tools/FocusTracker.md b/docs/developer-tools/FocusTracker.md index 5387d605a..b99717b85 100644 --- a/docs/developer-tools/FocusTracker.md +++ b/docs/developer-tools/FocusTracker.md @@ -37,7 +37,7 @@ FocusTracker will display the following information (when available) about the c ## Sample Project -[FocusTracker Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/FocusTracker). You can [see this in action](uwpct://Controls?sample=FocusTracker) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[FocusTracker Sample Page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/FocusTracker). You can [see this in action](uwpct://Controls?sample=FocusTracker) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -48,4 +48,4 @@ FocusTracker will display the following information (when available) about the c ## API -- [FocusTracker source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.DeveloperTools/FocusTracker) +- [FocusTracker source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.DeveloperTools/FocusTracker) diff --git a/docs/developer-tools/Guard.md b/docs/developer-tools/Guard.md index 031e6b91d..01cfb7a05 100644 --- a/docs/developer-tools/Guard.md +++ b/docs/developer-tools/Guard.md @@ -120,7 +120,7 @@ There are dozens of different APIs and overloads in the `Guard` class, here are ## Sample Code -You can find more examples in our [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/UnitTests/Diagnostics/Test_Guard.cs) +You can find more examples in our [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/UnitTests/UnitTests.Shared/Diagnostics/Test_Guard.cs) ## Requirements @@ -133,4 +133,4 @@ The Guard class supports .NET Standard ## API -- [Guard source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Diagnostics) +- [Guard source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Diagnostics) diff --git a/docs/developer-tools/ThrowHelper.md b/docs/developer-tools/ThrowHelper.md index fd0696815..60d7c1a5b 100644 --- a/docs/developer-tools/ThrowHelper.md +++ b/docs/developer-tools/ThrowHelper.md @@ -35,11 +35,11 @@ int result = text switch { "cat" => 0, "dog" => 1, - _ => ThrowHelper.ThrowArgumentException(nameof(text)) + _ => ThrowHelper.ThrowArgumentException(nameof(text)) }; ``` -Here we're using `ThrowHelper` within an expression that requires a return type of type `string`, so we can use the generic overload of `ThrowArgumentException` to make this possible. This also works with patterns such as ternary operators (`x ? a : b`), null-coalescing operators (`x = a ?? b`) null-coalescing assignment operators (`x ??= y`), and more. +Here we're using `ThrowHelper` within an expression that requires a return type of type `int`, so we can use the generic overload of `ThrowArgumentException` to make this possible. This also works with patterns such as ternary operators (`x ? a : b`), null-coalescing operators (`x = a ?? b`) null-coalescing assignment operators (`x ??= y`), and more. ## Methods @@ -158,7 +158,7 @@ The ThrowHelper class supports .NET Standard ## API -- [ThrowHelper source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Diagnostics/ThrowHelper.cs) +- [ThrowHelper source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Diagnostics/ThrowHelper.cs) ## Related Topics diff --git a/docs/diagnostics/Introduction.md b/docs/diagnostics/Introduction.md index a1f29d938..d79412d2d 100644 --- a/docs/diagnostics/Introduction.md +++ b/docs/diagnostics/Introduction.md @@ -26,7 +26,7 @@ Follow these steps to install the Diagnostics package: - .NET Core (>= 1.0) - Any other framework supporting .NET Standard 1.4 and up -2. In Solution Explorer panel, right click on your project name and select **Manage NuGet Packages**. Search for **Microsoft.Toolkit.HighPerformance** and install it. +2. In Solution Explorer panel, right click on your project name and select **Manage NuGet Packages**. Search for **Microsoft.Toolkit.Diagnostics** and install it. ![NuGet Packages](../resources/images/ManageNugetPackages.png "Manage NuGet Packages Image") @@ -36,4 +36,4 @@ Follow these steps to install the Diagnostics package: using Microsoft.Toolkit.Diagnostics; ``` -4. If you want so see some code samples, you can either read through the other docs pages for the Diagnostics package, or have a look at the various [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests/UnitTests.Shared/Diagnostics) for the project. +4. If you want so see some code samples, you can either read through the other docs pages for the Diagnostics package, or have a look at the various [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests/UnitTests.Shared/Diagnostics) for the project. diff --git a/docs/docfx.json b/docs/docfx.json index a89596106..004cad89e 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -47,7 +47,7 @@ "keywords": "windows uwp community toolkit", "author": "michael-hawker", "ms.author": "mhawker", - "ms.date": "03/11/2021", + "ms.date": "09/23/2021", "breadcrumb_path": "/windows/communitytoolkit/breadcrumb/toc.json", "extendBreadcrumb": true }, diff --git a/docs/extensions/ArrayExtensions.md b/docs/extensions/ArrayExtensions.md index 99fdf7da3..56a6f2ac6 100644 --- a/docs/extensions/ArrayExtensions.md +++ b/docs/extensions/ArrayExtensions.md @@ -53,4 +53,4 @@ The Array Extensions supports .NET Standard ## API -* [ArrayExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit/Extensions/ArrayExtensions.cs) +* [ArrayExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit/Extensions/ArrayExtensions.cs) diff --git a/docs/extensions/DependencyObjectExtensions.md b/docs/extensions/DependencyObjectExtensions.md index 299dabfe9..8e8546153 100644 --- a/docs/extensions/DependencyObjectExtensions.md +++ b/docs/extensions/DependencyObjectExtensions.md @@ -66,4 +66,4 @@ control = uiElement.FindAscendant(Of ScrollViewer)() ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/DispatcherQueueExtensions.md b/docs/extensions/DispatcherQueueExtensions.md index 961572764..d132a7ae5 100644 --- a/docs/extensions/DispatcherQueueExtensions.md +++ b/docs/extensions/DispatcherQueueExtensions.md @@ -11,7 +11,7 @@ dev_langs: The [`DispatcherQueueExtensions`](/dotnet/api/microsoft.toolkit.uwp.DispatcherQueueExtensions) type provides a collection of extensions methods for [`DispatcherQueue`](/uwp/api/windows.system.dispatcherqueue) objects that makes it easier to execute code on a specific UI thread. A `DispatcherQueue` instance can be retrieved and cached for later use, and then used through any of the available helper methods to dispatch a delegate invocation on it. -> **Platform APIs:** [`DispatcherQueueExtensions`](/dotnet/api/microsoft.toolkit.uwp.ui.DependencyObjectExtensions) +> **Platform APIs:** [`DispatcherQueueExtensions`](/dotnet/api/microsoft.toolkit.uwp.DispatcherQueueExtensions) ## Syntax @@ -78,4 +78,4 @@ Task.Run(() => ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/UnitTests/UnitTests.UWP/Extensions/Test_DispatcherQueueExtensions.cs). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/UnitTests/UnitTests.UWP/Extensions/Test_DispatcherQueueExtensions.cs). diff --git a/docs/extensions/EnumValuesExtension.md b/docs/extensions/EnumValuesExtension.md index 68072326e..0371838fd 100644 --- a/docs/extensions/EnumValuesExtension.md +++ b/docs/extensions/EnumValuesExtension.md @@ -27,4 +27,28 @@ In this example we're just relying on the default `ComboBox` item template, that ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +Binding to an enum property can be accomplished like so: + +```xaml + +``` + +```csharp +private Animal selectedAnimal = Animal.Dog; + +public Animal SelectedAnimal +{ + get => selectedAnimal; + set + { + selectedAnimal = value; + OnPropertyChanged(nameof(SelectedAnimal)); + } +} +``` + +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/FrameworkElementExtensions.md b/docs/extensions/FrameworkElementExtensions.md index 767c3c899..f3bba0ca8 100644 --- a/docs/extensions/FrameworkElementExtensions.md +++ b/docs/extensions/FrameworkElementExtensions.md @@ -126,11 +126,54 @@ Here is how you can easily set a custom cursor type for a target `FrameworkEleme ``` > [!NOTE] -> Even though Microsoft recommends in [UWP Design guidelines](/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](/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`](/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. +## CanDragElement + +The `CanDragElement` attached property enables repositions the element +in response to mouse drag gestures on the element. + +Here is how you can easily set this for a target `FrameworkElement` instance: +```xaml + + + + + +``` + +## ConstrainDragToParentBounds + +The `ConstrainDragToParentBounds` attached property allows you to constrain the dragged element +to stay within the bounds of its parent container. +Not necessary. The default value is false. + +## DragX + +The `DragX` attached property allows you to get/set the X position of the dragged element, +relative to the left of the root element. + +## DragY + +The `DragY` attached property allows you to get/set the Y position of the dragged element, +relative to the top of the root element. + ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/Hyperlink.md b/docs/extensions/Hyperlink.md index 7eaa9c845..7e69c9cf1 100644 --- a/docs/extensions/Hyperlink.md +++ b/docs/extensions/Hyperlink.md @@ -35,4 +35,4 @@ The **Hyperlink extension** allows for a Hyperlink element to invoke the execute ## API -* [Hyperlink source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/Hyperlink) +* [Hyperlink source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/Hyperlink) diff --git a/docs/extensions/HyperlinkExtensions.md b/docs/extensions/HyperlinkExtensions.md index 3ac406056..bde96866b 100644 --- a/docs/extensions/HyperlinkExtensions.md +++ b/docs/extensions/HyperlinkExtensions.md @@ -29,4 +29,4 @@ Using the `HyperlinkExtensions` attached properties simply requires you to assig ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/UnitTests/UnitTests.UWP/Extensions/Test_EnumValuesExtension.cs). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/UnitTests/UnitTests.UWP/Extensions/Test_EnumValuesExtension.cs). diff --git a/docs/extensions/IconMarkupExtensions.md b/docs/extensions/IconMarkupExtensions.md index 5b5142725..31a176ca7 100644 --- a/docs/extensions/IconMarkupExtensions.md +++ b/docs/extensions/IconMarkupExtensions.md @@ -124,4 +124,4 @@ All the values returned by these markup extensions belong to the `Windows.UI.Xam ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/ListViewBase.md b/docs/extensions/ListViewBase.md index bc3fff974..50576db15 100644 --- a/docs/extensions/ListViewBase.md +++ b/docs/extensions/ListViewBase.md @@ -72,4 +72,4 @@ The StretchItemContainerDirection property provides a way to stretch the ItemCon ## API -* [ListViewBase source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/ListViewBase) +* [ListViewBase source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/ListViewBase) diff --git a/docs/extensions/ListViewExtensions.md b/docs/extensions/ListViewExtensions.md index 5cef526b1..7d3d67317 100644 --- a/docs/extensions/ListViewExtensions.md +++ b/docs/extensions/ListViewExtensions.md @@ -1,101 +1,215 @@ ---- -title: ListViewExtensions -author: nmetulev -description: ListViewExtensions extensions provide a lightweight way to extend every control that inherits the ListViewBase class with attached properties. -keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, ListViewBase, extensions ---- - -# ListViewExtensions - -The [`ListViewExtensions`](/dotnet/api/microsoft.toolkit.uwp.ui.listviewextensions) class provide a lightweight way to extend every control that inherits the [`ListViewBase`](/uwp/api/Windows.UI.Xaml.Controls.ListViewBase) class with attached properties. This means that all the extensions in this class can apply to both [`ListView`](/uwp/api/windows.ui.xaml.controls.listview), [`GridView`](/uwp/api/windows.ui.xaml.controls.gridview) and other controls. - -> **Platform APIs:** [`ListViewExtensions`](/dotnet/api/microsoft.toolkit.uwp.ui.listviewextensions), [`ItemContainerStretchDirection`](/dotnet/api/microsoft.toolkit.uwp.ui.ItemContainerStretchDirection) - -## AlternateColor - -The `AlternateColor` property provides a way to assign a background color to every other item. - -> [!WARNING] -> The [`ContainerContentChanging`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_ContainerContentChanging) event used for this extension to work, will not be raised when the [`ItemsPanel`](/uwp/api/windows.ui.xaml.controls.itemscontrol.itemspanel) is replaced with another type of panel than [`ItemsStackPanel`](/uwp/api/windows.ui.xaml.controls.itemsstackpanel) or [`ItemsWrapGrid`](/uwp/api/windows.ui.xaml.controls.itemswrapgrid). - -Here is how this property can be used in XAML: - -```xaml - - - -``` - -## AlternateItemTemplate - -The `AlternateItemTemplate` property provides a way to assign an alternate [`DataTemplate`](/uwp/api/windows.ui.xaml.datatemplate) to every other item. It is also possible to combine with the `AlternateColor` property. - -> [!WARNING] -> The [`ContainerContentChanging`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_ContainerContentChanging) event used for this extension to work, will not be raised when the [`ItemsPanel`](/uwp/api/windows.ui.xaml.controls.itemscontrol.itemspanel) is replaced with another type of panel than [`ItemsStackPanel`](/uwp/api/windows.ui.xaml.controls.itemsstackpanel) or [`ItemsWrapGrid`](/uwp/api/windows.ui.xaml.controls.itemswrapgrid). - -Here is how this property can be used in XAML: - -```xaml - - - - - - - - - - - - - -``` - -## Command - -`ListViewExtensions` provides extension method that allow attaching an [`ICommand`](/uwp/api/Windows.UI.Xaml.Input.ICommand) to handle `ListViewBase` item interaction by means of [`ItemClick`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_ItemClick) event. - -> [!IMPORTANT] -> ListViewBase [`IsItemClickEnabled`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_IsItemClickEnabled) must be set to `true`. - -Here is how this property can be used in XAML: - -```xaml - - - -``` - -## StretchItemContainerDirection - -The `ItemContainerStretchDirection` property provides a way to stretch the `ItemContainer` in horizontal, vertical or both ways. The allowed values are items from the `ItemContainerStretchDirection` type. - -> [!WARNING] -> The [`ContainerContentChanging`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_ContainerContentChanging) event used for this extension to work, will not be raised when the [`ItemsPanel`](/uwp/api/windows.ui.xaml.controls.itemscontrol.itemspanel) is replaced with another type of panel than [`ItemsStackPanel`](/uwp/api/windows.ui.xaml.controls.itemsstackpanel) or [`ItemsWrapGrid`](/uwp/api/windows.ui.xaml.controls.itemswrapgrid). - -Here is how this property can be used from XAML: - -```xaml - - - -``` - -## Examples - -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +--- +title: ListViewExtensions +author: nmetulev +description: ListViewExtensions extensions provide a lightweight way to extend every control that inherits the ListViewBase class with attached properties. +keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, ListViewBase, extensions +--- + +# ListViewExtensions + +The [`ListViewExtensions`](/dotnet/api/microsoft.toolkit.uwp.ui.listviewextensions) class provide a lightweight way to extend every control that inherits the [`ListViewBase`](/uwp/api/Windows.UI.Xaml.Controls.ListViewBase) class with attached properties. This means that all the extensions in this class can apply to both [`ListView`](/uwp/api/windows.ui.xaml.controls.listview), [`GridView`](/uwp/api/windows.ui.xaml.controls.gridview) and other controls. + +> **Platform APIs:** [`ListViewExtensions`](/dotnet/api/microsoft.toolkit.uwp.ui.listviewextensions), [`ItemContainerStretchDirection`](/dotnet/api/microsoft.toolkit.uwp.ui.ItemContainerStretchDirection) + +> [!div class="nextstepaction"] +> [Try it in the sample app](uwpct://Extensions?sample=ListViewExtensions) + +## ListViewBase Extensions + +- [AlternateColor](#alternatecolor) +- [AlternateItemTemplate](#alternateitemtemplate) +- [Command](#command) +- [StretchItemContainerDirection](#stretchitemcontainerdirection) +- [SmoothScrollIntoView](#smoothscrollintoview) + +## AlternateColor + +The `AlternateColor` property provides a way to assign a background color to every other item. + +> [!WARNING] +> The [`ContainerContentChanging`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_ContainerContentChanging) event used for this extension to work, will not be raised when the [`ItemsPanel`](/uwp/api/windows.ui.xaml.controls.itemscontrol.itemspanel) is replaced with another type of panel than [`ItemsStackPanel`](/uwp/api/windows.ui.xaml.controls.itemsstackpanel) or [`ItemsWrapGrid`](/uwp/api/windows.ui.xaml.controls.itemswrapgrid). + +Here is how this property can be used in XAML: + +```xaml + + + +``` + +## AlternateItemTemplate + +The `AlternateItemTemplate` property provides a way to assign an alternate [`DataTemplate`](/uwp/api/windows.ui.xaml.datatemplate) to every other item. It is also possible to combine with the `AlternateColor` property. + +> [!WARNING] +> The [`ContainerContentChanging`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_ContainerContentChanging) event used for this extension to work, will not be raised when the [`ItemsPanel`](/uwp/api/windows.ui.xaml.controls.itemscontrol.itemspanel) is replaced with another type of panel than [`ItemsStackPanel`](/uwp/api/windows.ui.xaml.controls.itemsstackpanel) or [`ItemsWrapGrid`](/uwp/api/windows.ui.xaml.controls.itemswrapgrid). + +Here is how this property can be used in XAML: + +```xaml + + + + + + + + + + + + + +``` + +## Command + +`ListViewExtensions` provides extension method that allow attaching an [`ICommand`](/uwp/api/Windows.UI.Xaml.Input.ICommand) to handle `ListViewBase` item interaction by means of [`ItemClick`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_ItemClick) event. + +> [!IMPORTANT] +> ListViewBase [`IsItemClickEnabled`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_IsItemClickEnabled) must be set to `true`. + +Here is how this property can be used in XAML: + +```xaml + + + +``` + +## StretchItemContainerDirection + +The `ItemContainerStretchDirection` property provides a way to stretch the `ItemContainer` in horizontal, vertical or both ways. The allowed values are items from the `ItemContainerStretchDirection` type. + +> [!WARNING] +> The [`ContainerContentChanging`](/uwp/api/windows.ui.xaml.controls.listviewbase#Windows_UI_Xaml_Controls_ListViewBase_ContainerContentChanging) event used for this extension to work, will not be raised when the [`ItemsPanel`](/uwp/api/windows.ui.xaml.controls.itemscontrol.itemspanel) is replaced with another type of panel than [`ItemsStackPanel`](/uwp/api/windows.ui.xaml.controls.itemsstackpanel) or [`ItemsWrapGrid`](/uwp/api/windows.ui.xaml.controls.itemswrapgrid). + +Here is how this property can be used from XAML: + +```xaml + + + +``` + +## SmoothScrollIntoView + +Use SmoothScrollIntoView helps to scroll the item into the view with animation. Specify the ItemPosition property to align the item. + +### Syntax + +```csharp +// Scrolling with index +await MyGridView.SmoothScrollIntoViewWithIndexAsync(index: int, itemPlacement: ItemPlacement, disableAnimation: bool, scrollIfVisibile: bool, additionalHorizontalOffset: int, additionalVerticalOffset: int); + +// Scrolling with item +await MyGridView.SmoothScrollIntoViewWithItemAsync(item: object, itemPlacement: ItemPlacement, disableAnimation: bool, scrollIfVisibile: bool, additionalHorizontalOffset: int, additionalVerticalOffset: int); +``` + +```vb +' Scrolling with index +Await MyGridView.SmoothScrollIntoViewWithItemAsync(index:=Integer, itemPlacement:=ItemPlacement.Bottom, disableAnimation:=Boolean, scrollIfVisibile:=Boolean, additionalHorizontalOffset:=Integer, additionalVerticalOffset:=Integer) + +' Scrolling with item +Await MyGridView.SmoothScrollIntoViewWithItemAsync(item:=Object, itemPlacement:=ItemPlacement.Bottom, disableAnimation:=Boolean, scrollIfVisibile:=Boolean, additionalHorizontalOffset:=Integer, additionalVerticalOffset:=Integer) +``` + +### Sample Output + +![SmoothScrollIntoView Helper](../resources/images/Extensions/SmoothScrollIntoView.gif) + +### Methods + +| Methods | Return Type | Description | +| -- | -- | -- | +| SmoothScrollIntoViewWithIndexAsync(int, ScrollItemPlacement, bool, bool, int, int) | Task | Smooth scroll item into view With index number | +| SmoothScrollIntoViewWithItemAsync(object, ScrollItemPlacement, bool, bool, int, int) | Task | Smooth scroll item into view With item object | + +### Method params + +| Properties | Type | Description | +|------------|------|-------------| +| intex | int | Intex of the item to be scrolled. Index can be negative | +| item | int | Intex of the item to be scrolled | +| itemPosition | ScrollItemPlacement | Specify the position of the Item after scrolling | +| disableAnimation | bool | To disable the scrolling animation | +| scrollIfVisibile | bool | Set `true` to scroll even if the scroll to item is visible so that the item will be aligned depend upon `itemPosition` | +| additionalHorizontalOffset | bool | Give addition horizontal offset | +| additionalVerticalOffset | bool | Give addition vertical offset | + +### ItemPosition + +| ScrollItemPlacement | Description | +|--------------|-------------| +| Default | If visible then it will not scroll, if not then item will be aligned to the nearest edge | +| Left | Aligned left | +| Top | Aligned top | +| Center | Aligned center | +| Right | Aligned right | +| Bottom | Aligned bottom | + +### Examples + +- We can use this extension to make the selected item always centered. + + **Sample Code** + + ```xaml + + + + + + + + + + + + + ``` + + ```csharp + private async void ListView_SelectionChanged(object sender, SelectionChangedEventArgs e) + { + var listView = (sender as ListView); + await listView.SmoothScrollIntoViewWithIndexAsync(listView.SelectedIndex, ScrollItemPlacement.Center, false, true); + } + ``` + + ```vb + Private Async Sub ListView_SelectionChanged(ByVal sender As Object, ByVal e As SelectionChangedEventArgs) + Dim listView = (TryCast(sender, ListView)) + Await listView.SmoothScrollIntoViewWithIndexAsync(listView.SelectedIndex, ScrollItemPlacement.Center, False, True) + End Sub + ``` + + **Sample Output** + + ![Use Case 1 Output](../resources/images/Extensions/SmoothScrollIntoView-CenterSelected.gif) + +## Requirements + +| Device family | Universal, 10.0.16299.0 or higher | +| --- | --- | +| Namespace | Microsoft.Toolkit.Uwp.UI.Extensions | +| NuGet package | [Microsoft.Toolkit.Uwp.UI](https://www.nuget.org/packages/Microsoft.Toolkit.Uwp.UI/) | + +## API + +- [ListViewExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/ListViewBase) diff --git a/docs/extensions/LogicalTree.md b/docs/extensions/LogicalTree.md index d211a6918..0e2cbb097 100644 --- a/docs/extensions/LogicalTree.md +++ b/docs/extensions/LogicalTree.md @@ -94,7 +94,7 @@ Dim content = uiElement.GetContentControl() ## API -* [LogicalTree extensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/Tree/LogicalTree.cs) +* [LogicalTree extensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/Tree/LogicalTree.cs) ## Related Topics diff --git a/docs/extensions/MatrixExtensions.md b/docs/extensions/MatrixExtensions.md index 7332849e2..ccd01322d 100644 --- a/docs/extensions/MatrixExtensions.md +++ b/docs/extensions/MatrixExtensions.md @@ -35,7 +35,7 @@ The [`MatrixExtensions`](/dotnet/api/microsoft.toolkit.uwp.ui.matrixextensions) ## API Source Code -- [MatrixExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit/Extensions/Media/MatrixExtensions.cs) +- [MatrixExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit/Extensions/Media/MatrixExtensions.cs) ## Related Topics diff --git a/docs/extensions/MatrixHelperEx.md b/docs/extensions/MatrixHelperEx.md index 1c8912be3..c97bb10a1 100644 --- a/docs/extensions/MatrixHelperEx.md +++ b/docs/extensions/MatrixHelperEx.md @@ -31,7 +31,7 @@ dev_langs: ## API Source Code -- [MatrixHelperEx source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit/Extensions/Media/MatrixHelperEx.cs) +- [MatrixHelperEx source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit/Extensions/Media/MatrixHelperEx.cs) ## Related Topics diff --git a/docs/extensions/MouseCursor.md b/docs/extensions/MouseCursor.md index 5d862ccad..57bb70fe3 100644 --- a/docs/extensions/MouseCursor.md +++ b/docs/extensions/MouseCursor.md @@ -54,7 +54,7 @@ Because the UWP framework does not support metadata on Attached Properties, spec ## Sample Project -[Mouse Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Mouse). You can [see this in action](uwpct://Extensions?sample=Mouse) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[Mouse Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/Mouse). You can [see this in action](uwpct://Extensions?sample=Mouse) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -65,4 +65,4 @@ Because the UWP framework does not support metadata on Attached Properties, spec ## API -* [Mouse.Cursor source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/Mouse) +* [Mouse.Cursor source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/Mouse) diff --git a/docs/extensions/NullableBoolExtension.md b/docs/extensions/NullableBoolExtension.md index 1e133f3bf..87c567b84 100644 --- a/docs/extensions/NullableBoolExtension.md +++ b/docs/extensions/NullableBoolExtension.md @@ -49,4 +49,4 @@ namespace MyApp.Helpers ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/NullableBoolMarkup.md b/docs/extensions/NullableBoolMarkup.md index d2ab4c535..ea25e0de7 100644 --- a/docs/extensions/NullableBoolMarkup.md +++ b/docs/extensions/NullableBoolMarkup.md @@ -49,7 +49,7 @@ The [NullableBool Markup Extension](/dotnet/api/microsoft.toolkit.uwp.ui.extensi ## API Source Code -- [NullableBool source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/Markup/NullableBool.cs) +- [NullableBool source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/Markup/NullableBool.cs) ## Related Topics diff --git a/docs/extensions/OnDeviceMarkup.md b/docs/extensions/OnDeviceMarkup.md index 56b0901fb..04a841bf4 100644 --- a/docs/extensions/OnDeviceMarkup.md +++ b/docs/extensions/OnDeviceMarkup.md @@ -42,7 +42,7 @@ The [OnDevice Markup Extension](/dotnet/api/microsoft.toolkit.uwp.ui.extensions. ## API -* [OnDevice source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/Markup/OnDeviceExtension.cs) +* [OnDevice source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/Markup/OnDeviceExtension.cs) ## Related Topics diff --git a/docs/extensions/ScrollViewerExtensions.md b/docs/extensions/ScrollViewerExtensions.md index 74e1ad77f..56840bb4e 100644 --- a/docs/extensions/ScrollViewerExtensions.md +++ b/docs/extensions/ScrollViewerExtensions.md @@ -111,7 +111,7 @@ This code results in the following UI: #### Using Existing Resource File -1. Download [MiddleClickScrolling-CursorType.res](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/ScrollViewer/MiddleClickScrolling-CursorType.res) file +1. Download [MiddleClickScrolling-CursorType.res](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/ScrollViewer/MiddleClickScrolling-CursorType.res) file 2. Move this file into your project's folder 3. Open .csproj file of your project in [Visual Studio Code](https://code.visualstudio.com/) or in any other code editor 4. Add `MiddleClickScrolling-CursorType.res` in the first `` @@ -127,4 +127,4 @@ You can easily edit the existing resource file to customize the cursor depending ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/StringExtensions.md b/docs/extensions/StringExtensions.md index 6d742b960..a2a6e449d 100644 --- a/docs/extensions/StringExtensions.md +++ b/docs/extensions/StringExtensions.md @@ -40,4 +40,4 @@ bool isvalid = str.IsDecimal(); //Returns false ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/SurfaceDialTextboxHelper.md b/docs/extensions/SurfaceDialTextboxHelper.md index 4805d08f3..34249887b 100644 --- a/docs/extensions/SurfaceDialTextboxHelper.md +++ b/docs/extensions/SurfaceDialTextboxHelper.md @@ -64,7 +64,7 @@ The [SurfaceDialTextbox XAML Property](/dotnet/api/microsoft.toolkit.uwp.ui.exte ## Sample Project -[SurfaceDialTextbox Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/SurfaceDialTextbox). You can [see this in action](uwpct://Extensions?sample=SurfaceDialTextbox) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[SurfaceDialTextbox Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/SurfaceDialTextbox). You can [see this in action](uwpct://Extensions?sample=SurfaceDialTextbox) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -75,4 +75,4 @@ The [SurfaceDialTextbox XAML Property](/dotnet/api/microsoft.toolkit.uwp.ui.exte ## API -* [SurfaceDialTextbox source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/SurfaceDialTextbox) +* [SurfaceDialTextbox source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/SurfaceDialTextbox) diff --git a/docs/extensions/TextBoxExtensions.md b/docs/extensions/TextBoxExtensions.md index 3ad4c2eff..a5ca6b94b 100644 --- a/docs/extensions/TextBoxExtensions.md +++ b/docs/extensions/TextBoxExtensions.md @@ -152,4 +152,4 @@ Here is an example of the visual result when scrolling on a Surface Dial over a ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/TextBoxMask.md b/docs/extensions/TextBoxMask.md index d5b8ab604..b3e079346 100644 --- a/docs/extensions/TextBoxMask.md +++ b/docs/extensions/TextBoxMask.md @@ -140,7 +140,7 @@ The following sample demonstrates how to add TextBoxMask property. ## Sample Code -[TextBoxMask Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TextBoxMask). You can [see this in action](uwpct://Extensions?sample=TextBoxMask) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[TextBoxMask Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TextBoxMask). You can [see this in action](uwpct://Extensions?sample=TextBoxMask) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -151,4 +151,4 @@ The following sample demonstrates how to add TextBoxMask property. ## API -* [TextBoxMask source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/TextBoxMask) +* [TextBoxMask source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/TextBoxMask) diff --git a/docs/extensions/TextBoxRegex.md b/docs/extensions/TextBoxRegex.md index 4be0bd64a..228c8b4fc 100644 --- a/docs/extensions/TextBoxRegex.md +++ b/docs/extensions/TextBoxRegex.md @@ -168,7 +168,7 @@ The following sample demonstrates how to add TextBoxRegex property. ## Sample Project -[TextBoxRegex Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TextBoxRegex). You can [see this in action](uwpct://Extensions?sample=TextBoxRegex) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[TextBoxRegex Sample Page](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/TextBoxRegex). You can [see this in action](uwpct://Extensions?sample=TextBoxRegex) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -179,4 +179,4 @@ The following sample demonstrates how to add TextBoxRegex property. ## API -* [TextBoxRegex source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/TextBoxRegEx) +* [TextBoxRegex source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/TextBoxRegEx) diff --git a/docs/extensions/TransformExtensions.md b/docs/extensions/TransformExtensions.md index 1a8f6e334..50bb60e5d 100644 --- a/docs/extensions/TransformExtensions.md +++ b/docs/extensions/TransformExtensions.md @@ -26,10 +26,10 @@ The Transform Extensions ([RotateTransformExtensions](/dotnet/api/microsoft.tool ## API Source Code -- [RotateTransformExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit/Extensions/Media/RotateTransformExtensions.cs) -- [ScaleTransformExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit/Extensions/Media/ScaleTransformExtensions.cs) -- [SkewTransformExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit/Extensions/Media/SkewTransformExtensions.cs) -- [TranslateTransformExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit/Extensions/Media/TranslateTransformExtensions.cs) +- [RotateTransformExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit/Extensions/Media/RotateTransformExtensions.cs) +- [ScaleTransformExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit/Extensions/Media/ScaleTransformExtensions.cs) +- [SkewTransformExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit/Extensions/Media/SkewTransformExtensions.cs) +- [TranslateTransformExtensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit/Extensions/Media/TranslateTransformExtensions.cs) ## Related Topics diff --git a/docs/extensions/UIElementExtensions.md b/docs/extensions/UIElementExtensions.md index bbebe72d1..226f5355e 100644 --- a/docs/extensions/UIElementExtensions.md +++ b/docs/extensions/UIElementExtensions.md @@ -39,4 +39,4 @@ The `ClipToBounds` property allows you to indicate whether to clip the content o ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/ViewExtensions.md b/docs/extensions/ViewExtensions.md index 2c13da844..cb11037d1 100644 --- a/docs/extensions/ViewExtensions.md +++ b/docs/extensions/ViewExtensions.md @@ -39,4 +39,4 @@ These attached properties all target a [`Page`](/uwp/api/windows.ui.xaml.control ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/VisualEx.md b/docs/extensions/VisualEx.md index a0be56724..6ad465bb3 100644 --- a/docs/extensions/VisualEx.md +++ b/docs/extensions/VisualEx.md @@ -87,4 +87,4 @@ The point about which rotation or scaling occurs, normalized between the values ## API -* [Visual extensions source code](https://github.com/Microsoft/UWPCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/Visual/VisualEx.cs) +* [Visual extensions source code](https://github.com/Microsoft/UWPCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/Visual/VisualEx.cs) diff --git a/docs/extensions/VisualExtensions.md b/docs/extensions/VisualExtensions.md index 91d520050..ce3fd71cc 100644 --- a/docs/extensions/VisualExtensions.md +++ b/docs/extensions/VisualExtensions.md @@ -27,7 +27,7 @@ Here is an example of how the `VisualExtensions` type can be used to directly se ui:VisualExtensions.Opacity="0.5" ui:VisualExtensions.RotationAngleInDegrees="80" ui:VisualExtensions.Scale="2, 0.5, 1" - ui:VisualExtensions.NormalizedCenterPoint="0.5, 0.5, 0" /> + ui:VisualExtensions.NormalizedCenterPoint="0.5, 0.5" /> ``` > [!NOTE] @@ -35,4 +35,4 @@ Here is an example of how the `VisualExtensions` type can be used to directly se ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/extensions/VisualTree.md b/docs/extensions/VisualTree.md index f72f93e0f..fa05d1d3c 100644 --- a/docs/extensions/VisualTree.md +++ b/docs/extensions/VisualTree.md @@ -82,7 +82,7 @@ control = uiElement.FindAscendant(Of ScrollViewer)() ## API -* [VisualTree extensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/Tree/VisualTree.cs) +* [VisualTree extensions source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/blob/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/Tree/VisualTree.cs) ## Related Topics diff --git a/docs/extensions/WebView.md b/docs/extensions/WebView.md index 4d769dd43..5da4284c0 100644 --- a/docs/extensions/WebView.md +++ b/docs/extensions/WebView.md @@ -30,4 +30,4 @@ The **WebViewExtensions** allows attaching HTML content to a WebView. ## API -* [WebViewExtensions source code](https://github.com/Microsoft/UWPCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/Extensions/WebView) +* [WebViewExtensions source code](https://github.com/Microsoft/UWPCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/Extensions/WebView) diff --git a/docs/extensions/WebViewExtensions.md b/docs/extensions/WebViewExtensions.md index a778001d0..c9567a478 100644 --- a/docs/extensions/WebViewExtensions.md +++ b/docs/extensions/WebViewExtensions.md @@ -32,4 +32,4 @@ Here is how the `WebViewExtensions` properties can be used in XAML: ## Examples -You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/UnitTests). +You can find more examples in the [unit tests](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/UnitTests). diff --git a/docs/gaze/GazeInteractionLibrary.md b/docs/gaze/GazeInteractionLibrary.md index 40316e63d..e2e72be8e 100644 --- a/docs/gaze/GazeInteractionLibrary.md +++ b/docs/gaze/GazeInteractionLibrary.md @@ -33,7 +33,7 @@ To use the gaze input APIs, you must register the gazeInput capability in the ap The Gaze Interaction Library currently supports the following features: -* Dwell based activation of XAML controls, like buttons, toggle buttons, check boxes, etc. +* Dwell based activation of XAML button and toggle button controls * Enabling gaze interactions for the entire XAML page or for a portion of it (like a single control) * Customizing the dwell times associated with specific controls * Controlling repetition of the dwell invocation of controls @@ -194,7 +194,7 @@ private void OnInvokeProgress(object sender, DwellProgressEventArgs e) ## Sample Project -[GazeInteractionPage](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/GazeInteraction/). You can [see this in action](uwpct://Gaze?sample=GazeInteraction) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[GazeInteractionPage](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/GazeInteraction/). You can [see this in action](uwpct://Gaze?sample=GazeInteraction) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -205,7 +205,7 @@ private void OnInvokeProgress(object sender, DwellProgressEventArgs e) ## API -* [Gaze Interaction Library source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.Input.GazeInteraction) +* [Gaze Interaction Library source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.Input.GazeInteraction) ## Related Topics diff --git a/docs/graph/authentication/ProviderManager.md b/docs/graph/authentication/ProviderManager.md index 34ea2f7ad..5f2597548 100644 --- a/docs/graph/authentication/ProviderManager.md +++ b/docs/graph/authentication/ProviderManager.md @@ -11,15 +11,14 @@ dev_langs: The ProviderManager manages access to the globally configured [IProvider](./custom.md) instance and any state change events as users sign in and out. -> Available in the `CommunityToolkit.Authentication` package. - -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). +Available in the `CommunityToolkit.Authentication` package. ## Properties | Property | Type | Description | | -- | -- | -- | +| ClientName | string | (*Static*) Gets the name of the toolkit client to identify self in Graph calls. | +| Instance | ProviderManager | (*Static*) Get or set the instance of the globally configured IProvider. | | State | ProviderState | Gets the current authentication state of the provider. | ## Events diff --git a/docs/graph/authentication/custom.md b/docs/graph/authentication/custom.md index 8321aeb21..6273027b1 100644 --- a/docs/graph/authentication/custom.md +++ b/docs/graph/authentication/custom.md @@ -1,5 +1,5 @@ --- -title: IProvider +title: Custom authentication providers author: shweaver-MSFT description: IProvider interface defines the basic functions of an authentication provider in the Graph toolkit. keywords: uwp, wpf, netstandard, windows, community, toolkit, graph, login, authentication, provider, providers, identity @@ -7,18 +7,15 @@ dev_langs: - csharp --- -# Custom provider +# Custom authentication providers If you have existing authentication code in your application, you can create a custom provider to enable authentication and access to Microsoft Graph for the toolkit's Graph based controls and helpers. To bring your own authentication provider logic, start by extending `IProvider`. ## IProvider -`IProvider` is the base interface for creating authentication providers that work with the various controls and helpers in the toolkit. Handle authenticaiton with one of our premade `IProvider` implementations or create your own. +`IProvider` is the base interface for creating authentication providers that work with the various controls and helpers in the toolkit. Handle authentication with one of our premade `IProvider` implementations or create your own. -> Available in the `CommunityToolkit.Authentication` package. - -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). +Available in the `CommunityToolkit.Authentication` package. ```csharp using CommunityToolkit.Authentication; @@ -47,7 +44,7 @@ ProviderManager.Instance.GlobalProvider = customProvider; | Method | Arguments | Returns | Description | | -- | -- | -- | -- | | AuthenticateRequestAsync | HttpRequestMessage | Task | Authenticate an outgoing request. | -| GetTokenAsync | bool silentOnly = false, string[] scopes = null | Task<string> | Retrieve a token for the authenticated user. | +| GetTokenAsync | bool silentOnly = false | Task<string> | Retrieve a token for the authenticated user. | | SignInAsync | | Task | Sign in a user. | | SignOutAsync | | Task | Sign out the current user. | | TrySilentSignInAsync | | Task<bool> | Try signing in silently, without prompts. | diff --git a/docs/graph/authentication/msal.md b/docs/graph/authentication/msal.md index 2a6b7e2ba..59dcf7609 100644 --- a/docs/graph/authentication/msal.md +++ b/docs/graph/authentication/msal.md @@ -11,10 +11,7 @@ dev_langs: The MsalProvider is an [IProvider](./custom.md) implementation built on the official Microsoft Authentication Library (MSAL). It is NetStandard 2.0 so it works in both UWP and WPF apps. -> Available in the `CommunityToolkit.Authentication.Msal` package. - -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). +Available in the `CommunityToolkit.Authentication.Msal` package. ```csharp using CommunityToolkit.Authentication; diff --git a/docs/graph/authentication/overview.md b/docs/graph/authentication/overview.md index fdd09cf86..764afa434 100644 --- a/docs/graph/authentication/overview.md +++ b/docs/graph/authentication/overview.md @@ -9,9 +9,6 @@ dev_langs: # Authentication Providers Overview -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). - Authentication is always the first step to working with Microsoft Graph. The toolkit providers enable your application to authenticate with Microsoft Identity and access Microsoft Graph in only few lines of code. Each provider handles user authentication and acquiring access tokens to call Microsoft Graph APIs, so that you don't have to write this code yourself. You can use the providers on their own, without components, to quickly implement authentication for your app and make calls to Microsoft Graph via the Microsoft Graph .NET SDK. @@ -22,9 +19,9 @@ The toolkit includes the following providers: | Providers | Description | | -- | -- | -| [Msal](./msal.md) | Uses MSAL for .NET to sign in users and acquire tokens to use with Microsoft Graph in a NetStandard 2.0 application. | -| [Windows](./windows.md) | Uses native WebAccountManager (WAM) APIs to sign in users and acquire tokens to use with Microsoft Graph in a UWP application. | -| [Custom](./custom.md)Custom | Create a custom provider to enable authentication and access to Microsoft Graph with your application's existing authentication code. | +| [Msal](./msal.md) | Uses MSAL for .NET to sign in users and acquire tokens to use with Microsoft Graph in NetStandard 2.0 applications. | +| [Windows](./windows.md) | Uses native WebAccountManager (WAM) APIs to sign in users and acquire tokens to use with Microsoft Graph in UWP applications. | +| [Custom](./custom.md) | Create a custom provider to enable authentication and access to Microsoft Graph with your application's existing authentication code. | ## Initializing the GlobalProvider @@ -69,6 +66,8 @@ public enum ProviderState } ``` +## Respond to changes in the GlobalProvider state + In some scenarios, you will want to show certain functionality or perform an action only after a user has successfully signed in. You can access and check the provider state as shown in the following example: ```csharp @@ -79,7 +78,7 @@ if (ProviderManager.Instance.GlobalProvider?.State === ProviderState.SignedIn) { } ``` -You can also use the `ProviderUpdated` and `ProviderStateChanged` events to get notified whenever provider is set or changes state. +Use the `ProviderUpdated` and `ProviderStateChanged` events to get notified whenever provider is set or changes state. ```csharp using CommunityToolkit.Authentication; @@ -98,6 +97,43 @@ void OnProviderStateChanged(object sender, ProviderUpdatedEventArgs args) } ``` +### ProviderStateTrigger + +To respond to provider state changes from XAML, try out the `ProviderStateTrigger` state trigger. + +Available in the `CommunityToolkit.Graph.Uwp` package. + +```xml + + + + + + + + + + + + + + + + +``` + +### FrameworkElement.IsVisibleWhen + +The `FrameworkElement.IsVisibleWhen` attached property makes it easy to toggle visibility for any `FrameworkElement`. + +Available in the `CommunityToolkit.Graph.Uwp` package. + +```xml + + + +``` + ## Getting an access token Each provider exposes a function called `getTokenAsync` that can retrieve the current access token or retrieve a new access token for the provided scopes. The following example shows how to get a new access token or the currently signed in user: @@ -113,14 +149,14 @@ string token = await provider.GetTokenAsync(silentOnly: false); ## Call Microsoft Graph APIs -Once authenticated, you can now make API calls to Microsoft Graph using the Graph SDK or without. +Once authenticated, you can now make API calls to Microsoft Graph using the Graph SDK or without. See the [Extensions](../helpers/extensions.md) page for an example of how to authenticate an outbound request directly. ### Use the Graph SDK -Access APIs using the Graph SDK through a preconfigured `GraphServiceClient` available through an extension method on `IProvider` called, `GetClient()`. +Access APIs using the Graph SDK through a preconfigured `GraphServiceClient` available through an extension method on `IProvider` called `GetClient()` and `GetBetaClient()`. See [Microsoft Graph Extensions](../helpers/extensions.md) for more details. -This is the easiest way to get started because all of the Graph types are available and the `GraphServiceClient` offers a convenient way of building requests. +It's possible to authenticate and make all Graph requests manually, without the Graph SDK. This can reduce package size significantly. However, using the Graph SDK is certainly the easiest way to work with Graph in .NET because the `GraphServiceClient` offers a convenient way of building requests and includes all of the object types ready to use. Available in the `CommunityToolkit.Graph` package. @@ -133,50 +169,3 @@ GraphServiceClient graphClient = provider.GetClient(); var me = await graphClient.Me.Request().GetAsync(); ``` - -### Handle Graph requests manually - -Access APIs by managing requests to Microsoft Graph yourself. This is helpful for projects with existing systems for managing web requests, or for keeping package sizes minimal by excluding the Graph SDK. - -To make Graph API calls manually, use the `IProvider.AuthenticateRequestAsync(HttpRequestMessage)` method to authenticate an outgoing request. - -```csharp -using CommunityToolkit.Authentication; -using Newtonsoft.Json; -using Newtonsoft.Json.Linq; - -private async Task> GetDefaultTaskListAsync() -{ - return await GetResponseAsync>("https://graph.microsoft.com/v1.0/me/todo/lists/tasks/tasks"); -} - -private async Task GetResponseAsync(string requestUri) -{ - // Build the request - HttpRequestMessage getRequest = new HttpRequestMessage(HttpMethod.Get, requestUri); - - // Authenticate the request - await ProviderManager.Instance.GlobalProvider.AuthenticateRequestAsync(getRequest); - - var httpClient = new HttpClient(); - using (httpClient) - { - // Send the request - var response = await httpClient.SendAsync(getRequest); - - if (response.IsSuccessStatusCode) - { - // Handle the request response - var jsonResponse = await response.Content.ReadAsStringAsync(); - var jObject = JObject.Parse(jsonResponse); - if (jObject.ContainsKey("value")) - { - var result = JsonConvert.DeserializeObject(jObject["value"].ToString()); - return result; - } - } - } - - return default; -} -``` diff --git a/docs/graph/authentication/windows.md b/docs/graph/authentication/windows.md index 3510765cb..a706ecf5e 100644 --- a/docs/graph/authentication/windows.md +++ b/docs/graph/authentication/windows.md @@ -12,10 +12,7 @@ dev_langs: The WindowsProvider is an authentication provider for accessing locally configured accounts on Windows. It extends [IProvider](./custom.md) and uses the native Windows AccountManager (WAM) APIs and AccountsSettingsPane for sign in. -> Available in the `CommunityToolkit.Authentication.Uwp` package. - -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). +Available in the `CommunityToolkit.Authentication.Uwp` package. ## Prerequisite Windows Store Association in Visual Studio @@ -30,27 +27,25 @@ To get valid tokens and complete sign in, the app will need to be associated wit > [!NOTE] > You must have a Windows Developer account to use the WindowsProvider in your UWP app. You can [register a Microsoft developer account](https://developer.microsoft.com/store/register) if you don't already have one. - ## Syntax @@ -64,9 +59,8 @@ using CommunityToolkit.Authentication; ProviderManager.Instance.GlobalProvider = new WindowsProvider(new string[] { "User.Read", "Tasks.ReadWrite" }); ``` -The WindowsProvider can also be configured to disabled auto-signin or show custom content in the `AccountsSettingsPane`. -Additional configuration for account types will be available via the `WebAccountProviderConfig` object in the future. -Currently, only consumer MSA accounts are supported. +The WindowsProvider can also be configured to disable auto-login or show custom content in the `AccountsSettingsPane`. +Configuration for specifying supported account types (such as AAD) is available via the `WebAccountProviderConfig` object. ```CSharp using CommunityToolkit.Authentication; @@ -82,9 +76,11 @@ void OnSettingsCommandInvoked(IUICommand command) System.Diagnostics.Debug.WriteLine("AccountsSettingsPane command invoked: " + command.Id); } -// Configure which types accounts should be available to choose from. The default is MSA, but AAD will come in the future. -// ClientId is only required for approving admin level consent in AAD tenants. -var webAccountProviderConfig = new WebAccountProviderConfig(WebAccountProviderType.MSA, "YOUR_CLIENT_ID_HERE"); +// Configure which types of accounts should be available to choose from. The default is MSA, but AAD is also supported. +var webAccountProviderConfig = new WebAccountProviderConfig(WebAccountProviderType.Msa); + +// ClientId is only required for approving admin level consent in AAD tenants or for supporting advanced authentication scenarios like SSO. +//var webAccountProviderConfig = new WebAccountProviderConfig(WebAccountProviderType.Aad, "YOUR_CLIENT_ID_HERE"); // Configure details to present in the AccountsSettingsPane, such as custom header text and links. var accountsSettingsPaneConfig = new AccountsSettingsPaneConfig( diff --git a/docs/graph/controls/GraphPresenter.md b/docs/graph/controls/GraphPresenter.md new file mode 100644 index 000000000..aab0bb88a --- /dev/null +++ b/docs/graph/controls/GraphPresenter.md @@ -0,0 +1,93 @@ +--- +title: GraphPresenter XAML Control +author: shweaver +description: The GraphPresenter control enables adhoc visualization of any Graph API. +keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, presenter, graphpresenter, graph +dev_langs: + - csharp +--- + +# (Experimental) GraphPresenter XAML Control + +The GraphPresenter is a flexible XAML control for visualizing Graph API data. Provide an `IBaseRequestBuilder` implementation and the GraphPresenter will automatically fetch the data from the proper Graph endpoint, ready for visualization. Because every Graph entity is different, this control has no default UI of it's own. It is up to the developer to decide how the data should be presented by setting the control's `ContentTemplate`. This control is great for prototyping and experimentation purposes, but we suggest creating your own user controls for production scenarios. + +Available in the `CommunityToolkit.Graph.Uwp` package. + +## Syntax + +### XAML + +```xml + + + + + + + + + + + + + + + + + +``` + +### Code-behind + +```csharp +public IBaseRequestBuilder RecentDriveItemsRequestBuilder { get; set; } + +public GraphPresenterSamplePage() +{ + InitializeComponent(); + + ProviderManager.Instance.ProviderStateChanged += (s, e) => UpdateRequestBuilder(); + UpdateRequestBuilder(); +} + +private void UpdateRequestBuilder() +{ + var provider = ProviderManager.Instance.GlobalProvider; + switch (provider?.State) + { + case ProviderState.SignedIn: + RecentDriveItemsRequestBuilder = provider.GetClient().Me.Drive.Recent(); + break; + + default: + RecentDriveItemsRequestBuilder = null; + break; + } +} +``` + +## Properties + +| Property | Type | Description | +| -- | -- | -- | +| RequestBuilder | IBaseRequestBuilder | Used to make a request to the graph. The results will be automatically populated to the `ContentPresenter.ContentTemplate` property. Use a `ContentPresenter.ContentTemplate` to change the presentation of the data. | +| ResponseType | Type | The type of item returned by the `RequestBuilder`. | +| IsCollection | bool | A value indicating whether the returned data from the `RequestBuilder` is a collection. | +| QueryOptions | List<QueryOption> | A list of `QueryOption` values to pass into the request built by the `RequestBuilder`. | +| OrderBy | string | A string to indicate a sorting order for the `RequestBuilder`. This is a helper to add this specific request option to the `QueryOptions`. + +## Requirements + +* **Namespace:** CommunityToolkit.Graph.Uwp.Controls +* **NuGet package:** [CommunityToolkit.Graph.Uwp](https://www.nuget.org/packages/CommunityToolkit.Graph.Uwp) + +## API + +* [GraphPresenter source code](https://github.com/windows-toolkit/Graph-Controls/tree/main/CommunityToolkit.Graph.Uwp/Controls/GraphPresenter) + +## Related Topics + +* [MGT Get Component](/graph/toolkit/components/get) diff --git a/docs/graph/controls/LoginButton.md b/docs/graph/controls/LoginButton.md index 7a04eb2ef..e826eff05 100644 --- a/docs/graph/controls/LoginButton.md +++ b/docs/graph/controls/LoginButton.md @@ -7,17 +7,14 @@ dev_langs: - csharp --- -# (Preview) LoginButton XAML Control +# LoginButton XAML Control The LoginButton is both a button and flyout control to facilitate Microsoft identity platform authentication. It provides two states: * When the user is not signed in, the control is a simple button to initiate the sign in process. * When the user is signed in, the control displays the current signed in user name, profile image, and email. When clicked, a flyout is opened with a command to sign out. -> Available in the `CommunityToolkit.Graph.Uwp` package. - -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). +Available in the `CommunityToolkit.Graph.Uwp` package. ## Syntax @@ -50,10 +47,9 @@ The LoginButton is both a button and flyout control to facilitate Microsoft iden ## Requirements -| Device family | Universal, MinVersion or higher | -| -- | -- | -| Namespace | CommunityToolkit.Graph.Uwp.Controls | -| NuGet package | [CommunityToolkit.Graph.Uwp](https://www.nuget.org/packages/CommunityToolkit.Graph.Uwp) | +* **Namespace:** CommunityToolkit.Graph.Uwp.Controls +* **NuGet package:** [CommunityToolkit.Graph.Uwp](https://www.nuget.org/packages/CommunityToolkit.Graph.Uwp) +* **Scope:** `User.Read` ## API diff --git a/docs/graph/controls/PeoplePicker.md b/docs/graph/controls/PeoplePicker.md index dc0b15a98..10143cbdc 100644 --- a/docs/graph/controls/PeoplePicker.md +++ b/docs/graph/controls/PeoplePicker.md @@ -7,14 +7,11 @@ dev_langs: - csharp --- -# (Preview) PeoplePicker XAML Control +# PeoplePicker XAML Control The PeoplePicker searches for people and renders the list of results from Microsoft Graph. By default, the component will search across all people. -> Available in the `CommunityToolkit.Graph.Uwp` package. - -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). +Available in the `CommunityToolkit.Graph.Uwp` package. ## Syntax @@ -37,10 +34,8 @@ The PeoplePicker searches for people and renders the list of results from Micros ## Requirements -| Device family | Universal, MinVersion or higher | -| -- | -- | -| Namespace | CommunityToolkit.Graph.Uwp.Controls | -| NuGet package | [CommunityToolkit.Graph.Uwp](https://www.nuget.org/packages/CommunityToolkit.Graph.Uwp) | +* **Namespace:** CommunityToolkit.Graph.Uwp.Controls +* **NuGet package:** [CommunityToolkit.Graph.Uwp](https://www.nuget.org/packages/CommunityToolkit.Graph.Uwp) ## API diff --git a/docs/graph/controls/PersonView.md b/docs/graph/controls/PersonView.md index 91e41b20f..d89a2cb89 100644 --- a/docs/graph/controls/PersonView.md +++ b/docs/graph/controls/PersonView.md @@ -11,10 +11,7 @@ dev_langs: The PersonView control is used to display a person or contact by using their photo, name, and/or email address. -> Available in the `CommunityToolkit.Graph.Uwp` package. - -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). +Available in the `CommunityToolkit.Graph.Uwp` package. ## Syntax @@ -42,10 +39,8 @@ The PersonView control is used to display a person or contact by using their pho ## Requirements -| Device family | Universal, MinVersion or higher | -| -- | -- | -| Namespace | CommunityToolkit.Graph.Uwp.Controls | -| NuGet package | [CommunityToolkit.Graph.Uwp](https://www.nuget.org/packages/CommunityToolkit.Graph.Uwp) | +* **Namespace:** CommunityToolkit.Graph.Uwp.Controls +* **NuGet package:** [CommunityToolkit.Graph.Uwp](https://www.nuget.org/packages/CommunityToolkit.Graph.Uwp) ## API diff --git a/docs/graph/getting-started.md b/docs/graph/getting-started.md index 32ff15d3e..8d0aa6547 100644 --- a/docs/graph/getting-started.md +++ b/docs/graph/getting-started.md @@ -1,19 +1,16 @@ --- -title: Getting started with WCT Graph Helpers and Controls +title: Getting started with WCT Graph helpers and controls author: shweaver-MSFT -description: Get started using authentication providers and Graph powered helpers from the Windows Community Toolkit. +description: Get started using authentication providers and Graph powered controls and helpers from the Windows Community Toolkit. keywords: uwp, wpf, netstandard, windows, community, toolkit, graph, login, authentication, provider, providers, identity dev_langs: - csharp --- -# Getting Started +# Getting started To get started using Graph data in your application, you'll first need to enable authentication. -> [!IMPORTANT] -> These packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). - ## Set the global authentication provider ### Authenticate with MSAL @@ -37,7 +34,7 @@ Leverage the official Microsoft Authentication Library (MSAL) to enable authenti ProviderManager.Instance.GlobalProvider = new MsalProvider(clientId, scopes); ``` -> Note: You can use the `Scopes` property to preemptively request permissions from the user of your app for data your app needs to access from Microsoft Graph. +> Note: Use the `Scopes` property to preemptively request permissions from the user of your app for data your app needs to access from Microsoft Graph. ### Authenticate with WindowsProvider @@ -93,39 +90,3 @@ ProviderManager.Instance.ProviderStateChanged += (s, e) } } ``` - -### Use the Beta API - -You can use the `ProviderManager.Instance` to listen to changes in authentication status with the `ProviderUpdated` event or get direct access to the [.NET Graph Beta API](https://github.com/microsoftgraph/msgraph-beta-sdk-dotnet) through `ProviderManager.Instance.GlobalProvider.GetBetaClient()`, just be sure to check if the `GlobalProvider` has been set first and its `State` is `SignedIn`: - -```csharp -using CommunityToolkit.Authentication; -using CommunityToolkit.Graph.Extensions; - -public ImageSource GetMyPhoto() -{ - IProvider provider = ProviderManager.Instance.GlobalProvider; - - if (provider?.State == ProviderState.SignedIn) - { - // Get the beta client - GraphServiceClient betaGraphClient = provider.GetBetaClient(); - - try - { - // Make a request to the beta endpoint for the current user's photo. - var photoStream = await betaGraphClient.Me.Photo.Content.Request().GetAsync(); - - using var ras = photoStream.AsRandomAccessStream(); - var bitmap = new BitmapImage(); - await bitmap.SetSourceAsync(ras); - - return bitmap; - } - catch - { - return null; - } - } -} -``` diff --git a/docs/graph/helpers/extensions.md b/docs/graph/helpers/extensions.md index 9bb08f748..f245f668a 100644 --- a/docs/graph/helpers/extensions.md +++ b/docs/graph/helpers/extensions.md @@ -11,9 +11,6 @@ dev_langs: Use toolkit extensions to help you make calls to Graph APIs using the global authentication provider. Available in the `CommunityToolkit.Graph` package, `CommunityToolkit.Graph.Extensions` namespace. -> [!IMPORTANT] -> Windows Community Toolkit - Graph Controls and Helpers packages are in preview. To get started using WCT preview packages visit the [WCT Preview Packages wiki page](https://aka.ms/wct/wiki/previewpackages). - ## Call Microsoft Graph APIs Once authenticated, you can make API calls to Microsoft Graph using a preconfigured `GraphServiceClient` instance. Access to the client is enabled through an extension method on [IProvider](../authentication/custom.md) called, `GetClient()`. @@ -71,7 +68,7 @@ public ImageSource GetMyPhoto() } ``` -## Extension methods +## IProvider extension methods The following extension methods are available on `IProvider` via the `CommunityToolkit.Graph.Extensions` namespace. @@ -79,3 +76,59 @@ The following extension methods are available on `IProvider` via the `CommunityT | -- | -- | -- | -- | | GetClient | | GraphServiceClient | Retrieve pre-configured GraphServiceClient instance for making authenticated Graph calls, using the v1 endpoint. | | GetBetaClient | | GraphServiceClient | Retrieve pre-configured GraphServiceClient instance for making authenticated Graph calls, using the beta endpoint. | + +## Handle Graph requests manually + +Access APIs by managing requests to Microsoft Graph yourself. This is helpful for projects with existing systems for managing web requests, or for keeping package sizes minimal by excluding the Graph SDK. + +To make Graph API calls manually, use the `HttpRequestMessage.AuthenticateAsync()` extension method to authenticate any outgoing requests. + +```csharp +using CommunityToolkit.Authentication; +using CommunityToolkit.Authentication.Extensions; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; + +private async Task> GetDefaultTaskListAsync() +{ + return await GetResponseAsync>("https://graph.microsoft.com/v1.0/me/todo/lists/tasks/tasks"); +} + +private async Task GetResponseAsync(string requestUri) +{ + // Build the request + var getRequest = new HttpRequestMessage(HttpMethod.Get, requestUri); + + // Authenticate the request using an extension on HttpRequestMessage. + await getRequest.AuthenticateAsync(); + + var httpClient = new HttpClient(); + using (httpClient) + { + // Send the request + var response = await httpClient.SendAsync(getRequest); + + if (response.IsSuccessStatusCode) + { + // Handle the request response + var jsonResponse = await response.Content.ReadAsStringAsync(); + var jObject = JObject.Parse(jsonResponse); + if (jObject.ContainsKey("value")) + { + var result = JsonConvert.DeserializeObject(jObject["value"].ToString()); + return result; + } + } + } + + return default; +} +``` + +## HttpRequestMessage extension methods + +The extension methods are available on `HttpRequestMessage` via the `CommunityToolkit.Authenticaiton.Extensions` namespace. + +| Method | Arguments | Returns | Description | +| -- | -- | -- | -- | +| AuthenticateAsync | | HttpRequestMessage | Authenticate an http request using the current GlobalProvider instance. | diff --git a/docs/graph/helpers/roaming-settings.md b/docs/graph/helpers/roaming-settings.md new file mode 100644 index 000000000..a5250c857 --- /dev/null +++ b/docs/graph/helpers/roaming-settings.md @@ -0,0 +1,164 @@ +--- +title: Roaming settings +author: shweaver-MSFT +description: Roam user settings across experiences using WCT's Graph powered storage helpers. +keywords: uwp, wpf, netstandard, windows, community, toolkit, graph, roaming, settings, storage, files +dev_langs: + - csharp +--- + +# Roaming settings + +Store and roam user settings/files across experiences and devices using Microsoft Graph powered storage helpers. These Graph storage helpers implement the `Microsoft.Toolkit.Helpers.IFileStorageHelper` and `Microsoft.Toolkit.Helpers.ISettingsStorageHelper` interfaces and work well in conjunction with the `Microsoft.Toolkit.Uwp.Helpers.ApplicationDataStorageHelper` for migrating local data to roaming storage locations. + +## OneDriveStorageHelper + +The `OneDriveStorageHelper` is a storage helper for handling files and folders in a user's OneDrive AppSpecial folder. This helper is purposed for storing app specific values and does not support freely navigating the user's OneDrive root folder or other app's settings folders. + +Available in the `CommunityToolkit.Uwp.Graph` package. + +```csharp +var filePath = "TestFile.txt"; +var fileContents = "this is a test"; +var fileContents2 = "this is also a test"; +var storageHelper = await OneDriveStorageHelper.CreateForCurrentUserAsync(); + +// Create a file +await storageHelper.CreateFileAsync(filePath, fileContents); + +// Read a file +var readContents = await storageHelper.ReadFileAsync(filePath); +Assert.AreEqual(fileContents, readContents); + +// Update a file +await storageHelper.CreateFileAsync(filePath, fileContents2); +var readContents2 = await storageHelper.ReadFileAsync(filePath); +Assert.AreEqual(fileContents2, readContents2); + +// Delete a file +var itemDeleted = await storageHelper.TryDeleteItemAsync(filePath); +Assert.IsTrue(itemDeleted); +``` + +Sub-folders are also supported: + +```csharp +var folderName = "TestFolder"; +var subfolderName = "TestSubFolder"; +var subfolderPath = $"{folderName}/{subfolderName}"; +var fileName = "TestFile.txt"; +var filePath = $"{folderName}/{fileName}"; +var fileContents = "this is a test"; +var storageHelper = await OneDriveStorageHelper.CreateForCurrentUserAsync(); + +// Test preparation +await storageHelper.TryDeleteItemAsync(folderName); +await storageHelper.CreateFolderAsync(folderName); + +// Create a subfolder +await storageHelper.CreateFolderAsync(subfolderName, folderName); + +// Create a file in a folder +await storageHelper.CreateFileAsync(filePath, fileContents); + +// Read a file from a folder +var readContents = await storageHelper.ReadFileAsync(filePath); +Assert.AreEqual(fileContents, readContents); + +// List folder contents +var folderItems = await storageHelper.ReadFolderAsync(folderName); +var folderItemsList = folderItems.ToList(); +Assert.AreEqual(2, folderItemsList.Count()); +Assert.AreEqual(subfolderName, folderItemsList[0].Name); +Assert.AreEqual(DirectoryItemType.Folder, folderItemsList[0].ItemType); +Assert.AreEqual(fileName, folderItemsList[1].Name); +Assert.AreEqual(DirectoryItemType.File, folderItemsList[1].ItemType); + +// Delete a subfolder +var itemDeleted = await storageHelper.TryDeleteItemAsync(subfolderPath); +Assert.IsTrue(itemDeleted); +``` + +## UserExtensionStorageHelper + +The `UserExtensionStorageHelper` is a storage helper that leverages open extensions on the Graph User entity to store data. Use this helper for storing user specific settings as key-value-pairs. + +Available in the `CommunityToolkit.Uwp.Graph` package. + +```csharp +// Create a new storage helper for the current user. +var storageHelper = await UserExtensionStorageHelper.CreateForCurrentUserAsync("my-storage-extension-id"); + +// Save a value +storageHelper["PreferredTheme"] = "Dark"; + +// Sync with Graph to update the remote. +await storageHelper.Sync(); +``` + +### Syncing with Graph + +The `UserExtensionStorageHelper` uses synchronous methods to interop and does not automatically sync data back to Graph. Use the `Sync()` method to push changes up to Graph and retrieve any new settings. + +Common sync opportunities: + +1. On application startup, when ready to fetch values and hydrate the cache. +1. On application suspend/resume. +1. After changing one or more settings values. + +There is a known limitation with open extensions that does not allow deletion of a specific key. We suggest using a unique value to represent when a key has been deleted. To truly remove keys, the entire extension must be cleared and synced to delete the extension, then rehydrated with values and synced again. + +#### Sample 1. Set a default value + +```csharp +// Create a new storage helper for the current user. +var storageHelper = await UserExtensionStorageHelper.CreateForCurrentUserAsync("my-storage-extension-id"); + +// Individual key deletion is not supported by open extensions. +// As a workaround, save a unique value like "KEY_DELETED" on deleted keys to pseudo remove them. +storageHelper["PreferredTheme"] = "KEY_DELETED"; + +// Check for a preferred theme, if not set the default. +if (!storageHelper.TryRead("PreferredTheme", out string preferredTheme) || preferredTheme == "KEY_DELETED") +{ + // Set the default theme. + preferredTheme = "Light"; + + // Save a value to the storage helper cache. + // Changes must be explicitly synced. + storageHelper["preferredTheme"] = preferredTheme; + + // Sync with Graph push changes back up. + await storageHelper.Sync(); +} +``` + +#### Sample 2. Delete a key + +```csharp +// Create a new storage helper for the current user. +var storageHelper = await UserExtensionStorageHelper.CreateForCurrentUserAsync("my-storage-extension-id"); + +// Sync to hydrate. +await storageHelper.Sync(); + +// Get the cache and remove the target item. +Dictionary cache = storageHelper.Cache.ToDictionary(kvp => kvp.Key, kvp => kvp.Value); +cache.Remove("PreferredTheme"); + +// Call clear to mark the extension ready for deletion/recreation +storageHelper.Clear(); + +// Reapply the cached values +foreach (var setting in cache) +{ + storageHelper[setting.Key] = setting.Value; +} + +// Sync deletion to Graph and preserve other settings values. +await storageHelper.Sync(); +``` + +## Related Topics + +* [Add custom data to users using open extensions](/graph/extensibility-open-users) diff --git a/docs/graph/overview.md b/docs/graph/overview.md index f7b788d62..1d65cd5a0 100644 --- a/docs/graph/overview.md +++ b/docs/graph/overview.md @@ -1,5 +1,5 @@ --- -title: Windows Community Toolkit - Graph Helpers and Controls +title: Windows Community Toolkit - Authentication and Graph author: shweaver-MSFT description: Authentication providers and Graph powered helpers that make it easy to work with Microsoft Graph APIs. keywords: uwp, wpf, netstandard, windows, community, toolkit, graph, login, authentication, provider, providers, identity @@ -7,24 +7,13 @@ dev_langs: - csharp --- -# Windows Community Toolkit - Graph Helpers and Controls +# Windows Community Toolkit - Authentication and Graph -The Graph helpers and controls are a sub-project of the [Windows Community Toolkit](https://aka.ms/wct) focused on [Microsoft Graph](https://developer.microsoft.com/en-us/graph/) and providing a set of Authentication providers and Graph powered Helpers/Controls that make it easy to work with Microsoft Graph APIs. +The authentication and Graph helpers and controls are a part of the [Windows Community Toolkit](https://aka.ms/wct), focused on enabling quick and easy Windows authentication and [Microsoft Graph](https://developer.microsoft.com/en-us/graph/) powered experiences. These controls and helpers make it easy to get users authenticated and start calling Microsoft Graph APIs! -Note: This new library replaces the `Microsoft.Toolkit.Uwp.UI.Controls.Graph` package; however, it is not backwards compatible nor does it provide all the same features at this time. +> Note: This new library replaces the `Microsoft.Toolkit.Uwp.UI.Controls.Graph` package; however, it is not backwards compatible nor does it provide all the same features at this time. -If you need similar controls for the Web, please use the [Microsoft Graph Toolkit](https://aka.ms/mgt). - -## What's new? - -We've overhauled our approach and introduced some big improvements: - -- The new WindowsProvider enables basic consumer login without AAD configuration 🎊 -- Authentication packages are now split per provider 🎉 -- Access to the GraphServiceClient now lives in a separate package. This means no dependency on the Graph SDK for simple auth scenarios and apps that perform Graph requests manually (sans SDK) 🥳 -- Removed Beta Graph SDK, but enabled access with V1 SDK types. This is so our controls and helpers can be based on the stable Graph endpoint, while also allowing for requests to the beta endpoint in some circumstances (Such as retrieving a user's photo) 🎠- -For more info on our roadmap, check out the current [Release Plan](https://github.com/windows-toolkit/Graph-Controls/issues/81) +If you need similar controls for the web, check out the [Microsoft Graph Toolkit](https://aka.ms/mgt). ## Supported SDKs @@ -33,23 +22,27 @@ For more info on our roadmap, check out the current [Release Plan](https://githu | `CommunityToolkit.Authentication` | NetStandard 2.0 | | `CommunityToolkit.Authentication.Msal` | NetStandard 2.0 | | `CommunityToolkit.Authentication.Uwp` | UWP Windows 10 17134 | -| `CommunityTookit.Graph` | NetStandard 2.0 | +| `CommunityToolkit.Graph` | NetStandard 2.0 | | `CommunityToolkit.Graph.Uwp` | UWP Windows 10 17763 | -## Getting Started +## Getting started Check out the [Getting Started](./getting-started.md) guide for details on how to get authenticated and start calling Graph APIs. ## Learn More -### Authentication Providers +### Authentication providers Hook into a lightweight framework for authenticating users and responding to login state changes: [Authentication Providers Overview](./authentication/overview.md) -### Graph Helpers +### Extensions See [Microsoft Graph Extensions](./helpers/extensions.md) to learn how to get access to a preconfigured GraphServiceClient and make adhoc API calls using the Graph SDK. -### Graph Controls +### Roaming settings + +Roam settings across experiences with the Graph using [Graph powered storage helpers](./helpers/roaming-settings.md). Store simple settings with open extensions on the Graph User or try the `OneDriveStorageHelper` for roaming files via OneDrive. + +### XAML controls -Build Graph experiences with XAML controls and helpers made for UWP, such as [LoginButton](./controls/LoginButton.md) or [PersonView](./controls/PersonView.md). +Build Graph experiences with XAML controls made for UWP, such as [LoginButton](./controls/LoginButton.md) or [PersonView](./controls/PersonView.md). diff --git a/docs/helpers/AdvancedCollectionView.md b/docs/helpers/AdvancedCollectionView.md index e21af0177..9efbc3393 100644 --- a/docs/helpers/AdvancedCollectionView.md +++ b/docs/helpers/AdvancedCollectionView.md @@ -208,7 +208,7 @@ End Using ' acv.Refresh() gets called here ## Sample Project -[AdvancedCollectionView sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AdvancedCollectionView). You can [see this in action](uwpct://Helpers?sample=AdvancedCollectionView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). +[AdvancedCollectionView sample page Source](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.SampleApp/SamplePages/AdvancedCollectionView). You can [see this in action](uwpct://Helpers?sample=AdvancedCollectionView) in the [Windows Community Toolkit Sample App](https://aka.ms/windowstoolkitapp). ## Requirements @@ -219,4 +219,4 @@ End Using ' acv.Refresh() gets called here ## API -* [AdvancedCollectionView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.0.0/Microsoft.Toolkit.Uwp.UI/AdvancedCollectionView) +* [AdvancedCollectionView source code](https://github.com/windows-toolkit/WindowsCommunityToolkit/tree/rel/7.1.0/Microsoft.Toolkit.Uwp.UI/AdvancedCollectionView) diff --git a/docs/helpers/AttachedShadows.md b/docs/helpers/AttachedShadows.md new file mode 100644 index 000000000..6834435e7 --- /dev/null +++ b/docs/helpers/AttachedShadows.md @@ -0,0 +1,174 @@ +--- +title: Attached Shadows +author: michael-hawker +description: Attached Shadows allow you to easily create shadow effects on elements. +keywords: windows 10, uwp, windows community toolkit, uwp community toolkit, uwp toolkit, shadow, shadows, dropshadow, dropshadowpanel, attachedshadow, attacheddropshadow, attachedcardshadow +dev_langs: + - csharp +--- + +# Attached Shadows + +Attached Shadows allow you to more easily create beautiful shadow effects within your app with little to no modification of the visual tree required, unlike our previous [`DropShadowPanel`](../controls/DropShadowPanel.md) control. + +> **Platform APIs:** [`AttachedCardShadow`](/dotnet/api/microsoft.toolkit.uwp.ui.media.attachedcardshadow), [`AttachedDropShadow`](/dotnet/api/microsoft.toolkit.uwp.ui.attacheddropshadow) + +## Introduction + +There are two types of attached shadows available today, the `AttachedCardShadow` and the `AttachedDropShadow`. It is recommended to use the `AttachedCardShadow` where possible, if you don't mind the dependency on Win2D. The `AttachedCardShadow` provides an easier to use experience that is more performant and easier to apply across an entire set of elements, assuming those elements are rounded-rectangular in shape. The `AttachedDropShadow` provides masking support and can be leveraged in any UWP app without adding an extra dependency. + +### Capability Comparison + +The following table outlines the various capabilities of each shadow type in addition to comparing to the previous `DropShadowPanel` implementation: + +| Capability | AttachedCardShadow | AttachedDropShadow | DropShadowPanel (deprecated) | +|-------------------------------|--------------------------------------------------------------------|-----------------------------------------------------------------|-----------------------------------------------------------------------------------------| +| Dependency/NuGet Package | 🟡 Win2D via
`Microsoft.Toolkit.Uwp.UI.Media` | âś… UWP Only (Composition Effect)
`Microsoft.Toolkit.Uwp.UI` | âś… UWP Only (Composition Effect)
`Microsoft.Toolkit.Uwp.UI` | +| Layer | Inline Composition +
Win2D Clip Geometry | Composition via
Target Element Backdrop | Composition via
`ContentControl` Container | +| Modify Visual Tree | ✅ No | 🟡 Usually requires single target element, even for multiple shadows | ❌ Individually wrap each element needing shadow | +| Extra Visual Tree Depth | ✅ 0 | 🟡 1 per sibling element to cast one or more shadows to | ❌ _**4** per Shadowed Element_ | +| Masking/Geometry | 🟡 Rectangular/Rounded-Rectangles only | ✅ Can mask images, text, and shapes (performance penalty) | ✅ Can mask images, text, and shapes (performance penalty) | +| Performance | ✅ Fast, applies rectangular clipped geometry | 🟡 Slower, especially when masking (default);
can use rounded-rectangles optimization | ❌ Slowest, no optimization for rounded-rectangles | +| ResourceDictionary Support | ✅ Yes | ✅ Yes | ❌ Limited, via complete custom control style +
still need to wrap each element to apply | +| Usable in Styles | ✅ Yes, anywhere, including app-level | 🟡 Yes, but limited in scope due to element target | ❌ No | +| Supports Transparent Elements | ✅ Yes, shadow is clipped and not visible | ❌ No, shadow shows through transparent element | ❌ No, shadow shows through transparent element | +| Animation Support | ✅ Yes, in XAML via [`AnimationSet`](../animations/AnimationSet.md) | 🟡 Partial, translating/moving element may desync shadow | ❌ No | + +## AttachedCardShadow (Win2D) + +The `AttachedCardShadow` is the easiest to use and most performant shadow. It is recommended to use it where possible, if taking a Win2D dependency is not a concern. It's only drawbacks are the extra dependency required and that it only supports rectangular and rounded-rectangular geometries (as described in the table above). + +> [!div class="nextstepaction"] +> [Try it in the sample app](uwpct://controls?sample=attachedcardshadow%20%28win2d%29) + +The great benefit to the `AttachedCardShadow` is that no extra surface or element is required to add the shadow. This reduces the complexity required in development and allows shadows to easily be added at any point in the development process. It also supports transparent elements, without displaying the shadow behind them! + +### Example + +The example shows how easy it is to not only apply an `AttachedCardShadow` to an element, but use it in a style to apply to multiple elements as well: + +```xaml + xmlns:ui="using:Microsoft.Toolkit.Uwp.UI" + xmlns:media="using:Microsoft.Toolkit.Uwp.UI.Media"/> + + + + + + + + +