Uno.Windows-universal-samples/Samples/SimpleInk/README.md

3.4 KiB

Simple inking sample

Shows how to use ink functionality (such as capturing ink from user input and performing handwriting recognition on ink strokes) in Universal Windows apps using C#.

Note: This sample is part of a large collection of UWP feature samples. If you are unfamiliar with Git and GitHub, you can download the entire collection as a ZIP file, but be sure to unzip everything to access shared dependencies. For more info on working with the ZIP file, the samples collection, and GitHub, see Get the UWP samples from GitHub. For more samples, see the Samples portal on the Windows Dev Center.

Specifically, this sample covers using the Windows.UI.Input.Inking APIs to do the following:

  • Capture user input and render as ink strokes
  • Create an ink toolbar which is associated with an ink canvas
  • Add custom buttons to the ink toolbar
  • Create an ink toolbar with only specified buttons
  • Control multiple ink canvases with a single ink toolbar
  • Save and load ink strokes
  • Erase ink strokes
  • Create and select different types of pens
  • Change which input types (Mouse/Touch/Pen) are used for inking
  • Recognize handwriting from ink strokes
  • Select ink strokes
  • Create a ruler and protractor, show them, hide them, customize them, and reposition them
  • Manipulate wet ink strokes
    • make strokes follow a shape
    • complete a stroke prematurely if conditions are met
  • Use ink stroke timestamps to replay ink strokes
  • Use a png as the background of an InkToolbarCustomPenButton and bind its color to the SelectedBrush property of the buttons
  • Change the rendering of the strokes and the color palette change by changing the high contrast adjustment mode
  • Enable pencil tilt

Samples

ComplexInk
Family Notes sample
Coloring Book app sample

Reference

Windows.UI.Input.Inking

Operating system requirements

Client: Windows 10 build 14295

Server: Windows Server 2016 Technical Preview

Phone: Windows 10 build 14295

Build the sample

  1. If you download the samples ZIP, be sure to unzip the entire archive, not just the folder with the sample you want to build.
  2. Start Microsoft Visual Studio 2017 and select File > Open > Project/Solution.
  3. Starting in the folder where you unzipped the samples, go to the Samples subfolder, then the subfolder for this specific sample, then the subfolder for your preferred language (C++, C#, or JavaScript). Double-click the Visual Studio Solution (.sln) file.
  4. Press Ctrl+Shift+B, or select Build > Build Solution.

Run the sample

The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it.

Deploying the sample

  • Select Build > Deploy Solution.

Deploying and running 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 selectDebug > Start Without Debugging.