BitmapIcon markup extension

Microsoft.Toolkit.Uwp.UI/Extensions/Markup/BitmapIconExtension.cs

@@ -0,0 +1,39 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using Windows.UI.Xaml.Controls;
+using Windows.UI.Xaml.Data;
+using Windows.UI.Xaml.Markup;
+
+namespace Microsoft.Toolkit.Uwp.UI.Extensions
+{
+    /// <summary>
+    /// Custom <see cref="MarkupExtension"/> which can provide <see cref="BitmapIcon"/> values.
+    /// </summary>
+    [Bindable]
+    [MarkupExtensionReturnType(ReturnType = typeof(BitmapIcon))]
+    public sealed class BitmapIconExtension : MarkupExtension
+    {
+        /// <summary>
+        /// Gets or sets the <see cref="Uri"/> representing the image to display.
+        /// </summary>
+        public Uri Source { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to display the icon as monochrome.
+        /// </summary>
+        public bool ShowAsMonochrome { get; set; }
+
+        /// <inheritdoc/>
+        protected override object ProvideValue()
+        {
+            return new BitmapIcon
+            {
+                ShowAsMonochrome = ShowAsMonochrome,
+                UriSource = Source
+            };
+        }
+    }
+}

UnitTests/Extensions/Test_BitmapIconExtensionMarkupExtension.cs

@@ -0,0 +1,85 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+using System.Linq;
+using Microsoft.Toolkit.Uwp.UI.Extensions;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Microsoft.VisualStudio.TestTools.UnitTesting.AppContainer;
+using Windows.UI.Xaml;
+using Windows.UI.Xaml.Controls;
+using Windows.UI.Xaml.Markup;
+
+namespace UnitTests.Extensions
+{
+    [TestClass]
+    public class Test_BitmapIconExtensionMarkupExtension
+    {
+        [TestCategory("BitmapIconExtensionMarkupExtension")]
+        [UITestMethod]
+        public void Test_BitmapIconExtension_MarkupExtension_ProvideImage()
+        {
+            var treeroot = XamlReader.Load(@"<Page
+    xmlns=""http://schemas.microsoft.com/winfx/2006/xaml/presentation""
+    xmlns:x=""http://schemas.microsoft.com/winfx/2006/xaml""
+    xmlns:ex=""using:Microsoft.Toolkit.Uwp.UI.Extensions"">
+        <Button x:Name=""RootButton"">
+            <Button.Flyout>
+                <MenuFlyout>
+                    <MenuFlyoutItem Icon=""{ex:BitmapIcon Source=/Assets/StoreLogo.png}"" />
+                </MenuFlyout>
+            </Button.Flyout>
+        </Button>
+</Page>") as FrameworkElement;
+
+            var button = treeroot.FindChildByName("RootButton") as Button;
+
+            Assert.IsNotNull(button, $"Could not find the {nameof(Button)} control in tree.");
+
+            var item = ((MenuFlyout)button.Flyout)?.Items?.FirstOrDefault() as MenuFlyoutItem;
+
+            Assert.IsNotNull(button, $"Could not find the target {nameof(MenuFlyoutItem)} control.");
+
+            var icon = item.Icon as BitmapIcon;
+
+            Assert.IsNotNull(icon, $"Could not find the {nameof(BitmapIcon)} element in button.");
+
+            Assert.AreEqual(icon.UriSource, new Uri("ms-resource:///Files/Assets/StoreLogo.png"), "Expected ms-resource:///Files/Assets/StoreLogo.png uri.");
+            Assert.AreEqual(icon.ShowAsMonochrome, false, "Expected icon not to be monochrome");
+        }
+
+        [TestCategory("BitmapIconExtensionMarkupExtension")]
+        [UITestMethod]
+        public void Test_BitmapIconExtension_MarkupExtension_ProvideImageAndMonochrome()
+        {
+            var treeroot = XamlReader.Load(@"<Page
+    xmlns=""http://schemas.microsoft.com/winfx/2006/xaml/presentation""
+    xmlns:x=""http://schemas.microsoft.com/winfx/2006/xaml""
+    xmlns:ex=""using:Microsoft.Toolkit.Uwp.UI.Extensions"">
+        <Button x:Name=""RootButton"">
+            <Button.Flyout>
+                <MenuFlyout>
+                    <MenuFlyoutItem Icon=""{ex:BitmapIcon Source=/Assets/StoreLogo.png, ShowAsMonochrome=True}"" />
+                </MenuFlyout>
+            </Button.Flyout>
+        </Button>
+</Page>") as FrameworkElement;
+
+            var button = treeroot.FindChildByName("RootButton") as Button;
+
+            Assert.IsNotNull(button, $"Could not find the {nameof(Button)} control in tree.");
+
+            var item = ((MenuFlyout)button.Flyout)?.Items?.FirstOrDefault() as MenuFlyoutItem;
+
+            Assert.IsNotNull(button, $"Could not find the target {nameof(MenuFlyoutItem)} control.");
+
+            var icon = item.Icon as BitmapIcon;
+
+            Assert.IsNotNull(icon, $"Could not find the {nameof(BitmapIcon)} element in button.");
+
+            Assert.AreEqual(icon.UriSource, new Uri("ms-resource:///Files/Assets/StoreLogo.png"), "Expected ms-resource:///Files/Assets/StoreLogo.png uri.");
+            Assert.AreEqual(icon.ShowAsMonochrome, true, "Expected icon to be monochrome");
+        }
+    }
+}

UnitTests/UnitTests.csproj

@@ -136,6 +136,7 @@
     <Compile Include="Diagnostics\Test_Guard.Array.cs" />
     <Compile Include="Diagnostics\Test_Guard.cs" />
     <Compile Include="Extensions\Helpers\ObjectWithNullableBoolProperty.cs" />
+    <Compile Include="Extensions\Test_BitmapIconExtensionMarkupExtension.cs" />
     <Compile Include="Extensions\Test_TypeExtensions.cs" />
     <Compile Include="Extensions\Test_ValueTypeExtensions.cs" />
     <Compile Include="Extensions\Test_ArrayExtensions.cs" />