Merge pull request #27 from Azure-Samples/xinyzhou/update_wpf_sample

update wpf sample for code style and readme

Author: xinyzhou

dotnet/InkRecognition/wpf-app/README.md

@@ -5,35 +5,28 @@ languages:
 products:
   - WPF
   - azure
-  - windows
 ---
 
-# Ink Intelligence Cognitive Service C# WPF Sample
+# Ink Recognizer Cognitive Service C# WPF Sample
 
 ![Build passing](https://img.shields.io/badge/build-passing-brightgreen.svg) ![License](https://img.shields.io/badge/license-MIT-green.svg)
 
-Ink Recognizer Cognitive Service provides recognition of digital ink. It takes the digital ink stroke data as input and provides a document tree with individual recognition units as output. This project has sample code to demonstrate a few ways developers can take advantage of the service.
+Ink Recognizer Cognitive Service provides recognition of digital ink. It takes the digital ink stroke data as input and provides a document tree with individual recognition units as output. This project has sample code to demonstrate a few ways developers can take advantage of the service. This sample also shows use case for [Xaml Island](https://docs.microsoft.com/en-us/windows/uwp/xaml-platform/xaml-host-controls) on InkCanvas, which import UWP controls into desktop applications.
 
 ## Features
 
-This project framework provides the following features:
+This sample provides the following features:
 
-* Capturing very basic inking input.
-
-* Creating the JSON payload using the JSON schema used by Ink Recognizer.
-
-* Calling the Ink Recognizer REST APIs with the JSON payload
-
-* Parsing the JSON response from the service, build the document tree and parse it.
+* Collect ink strokes from Xaml Island InkCanvas
+* Create JSON request following InkRecognizer service's schema.
+* Call the InkRecognizer REST API
+* Parse the JSON reponse to build the document tree
 
 ## Contents
 
 | File/folder | Description |
 |-------------|-------------|
 | `src`       | Sample source code. |
-| `.gitignore` | Define what to ignore at commit time. |
-| `CHANGELOG.md` | List of changes to the sample. |
-| `CONTRIBUTING.md` | Guidelines for contributing to the sample. |
 | `README.md` | This README file. |
 | `LICENSE`   | The license for the sample. |
 
@@ -42,17 +35,36 @@ This project framework provides the following features:
 ### Prerequisites
 
 * [Visual Studio](https://docs.microsoft.com/en-us/visualstudio/install/install-visual-studio)
-* Windows SDK Version >= 10.0.18362. You can install it from Visual Studio Installer under **Indivial components** tab, or download from [Windows Insider Preview SDK](https://www.microsoft.com/en-us/software-download/windowsinsiderpreviewSDK)
-  * If you install the Windows SDK into a customized path, please edit **src\NoteTaker.csproj** to change the HintPath of **Windows.winmd** to the correct path 
-* Requires subscription key from [Azure Cognitive Services](https://docs.microsoft.com/en-us/azure/cognitive-services/authentication) 
-
-## Build the Sample
-
-1. Clone or download this sample repository `git clone https://github.com/Azure-Samples/cognitive-services-csharp-wpf-ink-recognition.git` 
-2. Start Visual Studio and select **File > Open > Project/Solution** and open "NoteTaker.sln" 
-3. Replace "[YOUR SUBSCRIPTION KEY]" in MainWindows.xaml.cs with valid subscription key
-4. Press Ctrl+Shift+B, or select **Build > Build Solution**
-
-## Run the sample
-
-To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or select Debug > Start Without Debugging.
+* [.Net Framework >= 4.7.2](https://dotnet.microsoft.com/download/dotnet-framework)
+* Windows SDK Version >= 10.0.18362. You can install it from Visual Studio Installer under **Indivial components** tab, or download from [Windows 10 SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk)
+  * If you install the Windows SDK into a customized path, please edit **src\NoteTaker.csproj** to change the HintPath of **Windows.winmd** to the correct path
+* Nuget Packages
+  * [Newtonsoft.JSON](https://www.newtonsoft.com/json)
+  * [Microsoft.Net.Http](https://www.nuget.org/packages/Microsoft.Net.Http/)
+  * [Xaml Island for WPF](https://www.nuget.org/packages/Microsoft.Toolkit.Wpf.UI.Controls)
+* Subscription key from [Azure Cognitive Services](https://docs.microsoft.com/en-us/azure/cognitive-services/authentication)
+* Windows Build 1903 or higher is required for Xaml island features
+
+### Build the Sample
+
+1. Clone or download this sample repository `git clone https://github.com/Azure-Samples/cognitive-services-csharp-wpf-ink-recognition.git`
+2. Start Visual Studio and select **File > Open > Project/Solution** and open **src\NoteTaker.sln**
+3. Replace "[YOUR SUBSCRIPTION KEY]" in **src\MainWindows.xaml.cs** with valid subscription key
+4. Select **Build > Build Solution**
+
+### Run the sample
+
+* To debug the sample and then run it, select **Debug > Start Debugging**. To run the sample without debugging, select **Debug > Start Without Debugging**.
+* Write down something on the upper region of the app
+* After one second of inactivity, the ink will be recognized and the result will be visible in the lower region of the app
+
+## Resources
+
+Additional resources related the project are located below
+
+* [Learn more about Ink Recognizer](http://go.microsoft.com/fwlink/?LinkID=2084782)
+* [Ink Recognizer API Reference](http://go.microsoft.com/fwlink/?LinkID=2085147)
+* [Ink Recognizer JavaScript sample](https://github.com/Azure-Samples/cognitive-services-REST-api-samples/tree/master/javascript/InkRecognition/javascript-app)
+* [Ink Recognizer UWP sample](https://github.com/Azure-Samples/cognitive-services-REST-api-samples/tree/master/dotnet/InkRecognition/uwp-app)
+* [Ink Recognizer Java sample](https://github.com/Azure-Samples/cognitive-services-REST-api-samples/tree/master/java/InkRecognition/android-sample-app)
+* [Ink Recognizer Swift sample](https://github.com/Azure-Samples/cognitive-services-REST-api-samples/tree/master/swift/InkRecognition)

dotnet/InkRecognition/wpf-app/src/HTTP/HttpManager.cs

@@ -1,5 +1,4 @@
 using Contoso.NoteTaker.JSON;
-using Contoso.NoteTaker.JSON.Format;
 using System;
 using System.Net;
 using System.Net.Http;
@@ -23,23 +22,24 @@ public HttpManager(string appKey, string baseAddress, string destinationUrl)
 
         public async Task<HttpResponseMessage> PutAsync(string jsonRequest)
         {
-            var httpContent = new StringContent(jsonRequest, Encoding.UTF8, "application/json");
-            var httpResponse = await httpClient.PutAsync(destinationUrl, httpContent);
-
-            // Throw exception for malformed/unauthorized http requests
-            if (httpResponse.StatusCode == HttpStatusCode.BadRequest || httpResponse.StatusCode == HttpStatusCode.NotFound || httpResponse.StatusCode == HttpStatusCode.Unauthorized)
+            try
             {
-                var errorJson = await httpResponse.Content.ReadAsStringAsync();
+                var httpContent = new StringContent(jsonRequest, Encoding.UTF8, "application/json");
+                var httpResponse = await httpClient.PutAsync(destinationUrl, httpContent);
 
-                var errDetail = JSONProcessor.ParseInkRecognitionError(errorJson);
-                ThrowExceptionForHttpError(errDetail);
+                // Throw exception for malformed/unauthorized http requests
+                if (httpResponse.StatusCode == HttpStatusCode.BadRequest || httpResponse.StatusCode == HttpStatusCode.Unauthorized)
+                {
+                    var errorJson = await httpResponse.Content.ReadAsStringAsync();
+                    var errDetail = JSONProcessor.ParseInkRecognitionError(errorJson);
+                    throw new HttpRequestException(errDetail.ToString());
+                }
+                return httpResponse;
+            }
+            catch(Exception e)
+            {
+                throw e;
             }
-            return httpResponse;
-        }
-
-        private void ThrowExceptionForHttpError(HttpErrorDetails httpError)
-        {
-            throw new HttpRequestException(httpError.ToString());
         }
     }
 }

dotnet/InkRecognition/wpf-app/src/Helpers/InkPointHelper.cs

@@ -1,20 +1,22 @@
 using Newtonsoft.Json;
-using Contoso.NoteTaker.Helpers;
 using System;
 using System.Collections.Generic;
 using Windows.UI.Input.Inking;
+using System.Linq;
+using System.Reflection;
 
 namespace Contoso.NoteTaker.JSON.Converter
 {
     public class InkPointsToStringConverter : JsonConverter
     {
         public override bool CanConvert(Type objectType)
         {
-            throw new NotImplementedException();
+            return typeof(IReadOnlyList<InkPoint>).IsAssignableFrom(objectType);
         }
 
         public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
         {
+            // Since CanRead flag is false, this function will not be called
             throw new NotImplementedException();
         }
 
@@ -23,7 +25,10 @@ public override void WriteJson(JsonWriter writer, object value, JsonSerializer s
             var points = value as IReadOnlyList<InkPoint>;
             if (points != null)
             {
-                var pointsStr = InkPointHelper.InkPointsToString(points);
+                var pointsStr = string.Join(",",
+                                    points.Select(p => Convert.ToSingle(p.Position.X) + "," +
+                                                        Convert.ToSingle(p.Position.Y))
+                                );
                 serializer.Serialize(writer, pointsStr);
             }
             else

dotnet/InkRecognition/wpf-app/src/JSON/Converter/InkPointsToStringConverter.cs

@@ -15,6 +15,7 @@ public override bool CanConvert(Type objectType)
 
         public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
         {
+            // Since CanWrite flag is false, this function will not be called
             throw new NotImplementedException();
         }
 

dotnet/InkRecognition/wpf-app/src/JSON/Converter/InkRecognitionResponseConverter.cs

@@ -19,20 +19,9 @@ public class HttpErrorDetails
         public override string ToString()
         {
             string msg = "";
-            if (ErrorCode != null)
-            {
-                msg += "Http Error code: " + ErrorCode;
-            }
-
-            if (Target != null)
-            {
-                msg += " Target: " + Target;
-            }
-
-            if (Message != null)
-            {
-                msg += " Message : " + Message;
-            }
+            msg += (ErrorCode != null) ? " Http Error code : " + ErrorCode : "";
+            msg += (Target != null) ? " Target : " + Target : "";
+            msg += (Message != null) ? " Message : " + Message : "";
 
             if (Details != null)
             {

dotnet/InkRecognition/wpf-app/src/JSON/Format/HttpErrorDetails.cs

@@ -1,9 +1,7 @@
 using Newtonsoft.Json;
-using Contoso.NoteTaker.JSON.Converter;
+using System;
 using System.Collections.Generic;
 using System.Runtime.Serialization;
-using Windows.Foundation;
-using System;
 
 namespace Contoso.NoteTaker.JSON.Format
 {

dotnet/InkRecognition/wpf-app/src/JSON/Format/InkRecognitionUnit.cs

@@ -1,21 +1,20 @@
-
-using Contoso.NoteTaker.Helpers;
-using Contoso.NoteTaker.JSON.Converter;
+using Contoso.NoteTaker.JSON.Converter;
 using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
 using System.Runtime.Serialization;
+using Windows.Foundation;
 using Windows.UI.Input.Inking;
 
 namespace Contoso.NoteTaker.JSON.Format
 {
     public class InkRecognizerStroke
     {
         [JsonIgnore]
-        private InkStroke InkStroke { get; set; }
+        private InkStroke inkStrokeInternal { get; set; }
 
         [JsonProperty(PropertyName = "id")]
-        public UInt64 Id { get { return InkStroke.Id; } }
+        public UInt64 Id { get { return inkStrokeInternal.Id; } }
 
         [JsonProperty(PropertyName = "language", NullValueHandling = NullValueHandling.Ignore)]
         public string Language { get; set; } = null;
@@ -26,20 +25,31 @@ public class InkRecognizerStroke
         [JsonProperty(PropertyName = "points"), JsonConverter(typeof(InkPointsToStringConverter))]
         public IReadOnlyList<InkPoint> Points { get; protected set; }
 
-        [JsonProperty(PropertyName = "drawingAttributes")]
-        public InkDrawingAttributes DrawingAttributes { get { return InkStroke.DrawingAttributes; } }
-
         public InkRecognizerStroke(InkStroke stroke, float DpiX, float DpiY)
         {
-            InkStroke = stroke;
+            inkStrokeInternal = stroke;
 
-            var pointsInPixels = GetInkPoints();
-            Points = InkPointHelper.ConvertPixelsToMillimeters(pointsInPixels, DpiX, DpiY).AsReadOnly();
+            var pointsInPixels = inkStrokeInternal.GetInkPoints();
+            Points = ConvertPixelsToMillimeters(pointsInPixels, DpiX, DpiY).AsReadOnly();
         }
 
-        public IReadOnlyList<InkPoint> GetInkPoints()
+        private List<InkPoint> ConvertPixelsToMillimeters(IReadOnlyList<InkPoint> pointsInPixels, float DpiX, float DpiY)
         {
-            return InkStroke.GetInkPoints();
+            var transformedInkPoints = new List<InkPoint>();
+            const float inchToMillimeterFactor = 25.4f;
+
+
+            foreach (var point in pointsInPixels)
+            {
+                var transformedX = (point.Position.X / DpiX) * inchToMillimeterFactor;
+                var transformedY = (point.Position.Y / DpiY) * inchToMillimeterFactor;
+                var transformedPoint = new Point(transformedX, transformedY);
+                var transformedInkPoint = new InkPoint(transformedPoint, point.Pressure);
+
+                transformedInkPoints.Add(transformedInkPoint);
+            }
+
+            return transformedInkPoints;
         }
     }
 

dotnet/InkRecognition/wpf-app/src/JSON/Format/InkRecognizerStroke.cs

@@ -5,13 +5,13 @@ namespace Contoso.NoteTaker.JSON.Format
     public enum RecognitionUnitKind
     {
         [EnumMember(Value = "writingRegion")]
-        InkWritingRegion,
+        WritingRegion,
 
         [EnumMember(Value = "paragraph")]
-        InkParagraph,
+        Paragraph,
 
         [EnumMember(Value = "line")]
-        InkLine,
+        Line,
 
         [EnumMember(Value = "inkWord")]
         InkWord,
@@ -20,7 +20,7 @@ public enum RecognitionUnitKind
         InkDrawing,
 
         [EnumMember(Value = "listItem")]
-        InkListItem,
+        ListItem,
 
         [EnumMember(Value = "inkBullet")]
         InkBullet,

dotnet/InkRecognition/wpf-app/src/JSON/Format/RecognitionUnitKind.cs

@@ -5,15 +5,15 @@ namespace Contoso.NoteTaker.JSON.Format
     public class Rectangle
     {
         [JsonProperty(PropertyName = "topX")]
-        public float topX { get; set; }
+        public float TopX { get; set; }
 
         [JsonProperty(PropertyName = "topY")]
-        public float topY { get; set; }
+        public float TopY { get; set; }
 
         [JsonProperty(PropertyName = "width")]
-        public float width { get; set; }
+        public float Width { get; set; }
 
         [JsonProperty(PropertyName = "height")]
-        public float height { get; set; }
+        public float Height { get; set; }
     }
 }