Added Windows Desktop (WPF) platform implementation #1079

peterfoot · 2020-02-03T17:16:56Z

Description of Change

Adds platform support for Windows desktop (WPF) apps.

Bugs Fixed

Related to issue Additional Platform Support #662

Adds the following platform implementations

API Changes

Added DevicePlatform.WindowsDesktop

Behavioral Changes

N/A

PR Checklist

Has tests (if omitted, state reason in description)
Has samples (if omitted, state reason in description)
Rebased on top of master at time of PR
Changes adhere to coding standard
Updated documentation (see walkthrough)

…plication and tested available features.

msftclas · 2020-02-03T17:17:09Z

All CLA requirements met.

mattleibow

We will need to think about how we do this... What happens if we install this into a GTK app or some other macOS thing. We may need to implement a "desktop" set of files (instead of win32) and then based on what the running OS is, do the p/invokes and things. Basically, net461 will also install into GTK and that is going to cause issues. If we want to do a GTK platform, we need to think about how we know where we are running, before running anything.

Also, how does this play in the new netcoreapp world? (similar a future net5 world) At the end of the day, anything under the net* will install on pretty much everything not Xamarin. But, I think we can be safe with the fact that this will mostly be "desktop" worlds and the non-net* are all specific.

But, after all that said, this looks really good. This is not a little set of APIs, but something that will add value to all desktop apps.

mattleibow · 2020-02-03T19:20:09Z

Xamarin.Essentials/Preferences/Preferences.win32.cs

+{
+    public static partial class Preferences
+    {
+        static Dictionary<string, object> preferences = new Dictionary<string, object>();


Is this not actually saved to disk at all?

Need some discussion over the implementation of this. This is temporary and required for the code to build and allow the sample app to run. There isn't a native API we can use (unless taking a dependency on the Windows 10 UWP API). A simple implementation would be to persist the dictionary(s) to a file but that may require a dependency on Newtonsoft.Json or similar. I think that will be the easiest option for now and we can discuss further the pros/cons.

No need for newtonsoft, BinarySerializer etc. are all available and fit the scenario. Persistance is IMHO necessary for this to be considered workable.

You could have a look here: https://docs.microsoft.com/en-us/dotnet/standard/serialization/

Thanks, I'll rework this and use one of the built-in options.

Going the file route comes with another set of problems:
We definitely have to have a lazy mechanism to store and retrieve settings. Loading all properties on first acess would increse the working set unnecessarily. Also, we do need fast key existance checks. Not only for Key enumeration but also for insertion. I am currently hooking up some different benchmarks for a couple of potential solutions, but this all seems very icky to me. Are there any usbale storage technologies available with winapi we could use? or even com perhaps

Okay this could be a stupid idea but how about the registry? Fast key existance checks, key value store just as we like it and as persistent as it can be

I think that's frowned upon, we can't control how much it gets used for and unless the app is installed via Centennial it'll get dumped into the main registry.

Xamarin.Essentials/Email/Email.win32.cs

mattleibow · 2020-02-03T19:22:58Z

Xamarin.Essentials/Xamarin.Essentials.csproj

+    </Reference>
+    <Reference Include="WindowsBase" />
+    <Reference Include="PresentationCore" />
+    <Reference Include="PresentationFramework" />


Just checking to see if we actually use the presentation bits for this project? We shouldn't be using any of the Xaml-related things. Also, this should work for winforms without this?

At the moment it uses WPF dependencies for MainThread, to support either WinForms or WPF will require some reworking but this is a sensible point. I will investigate alternative methods of identifying the thread.

mattleibow · 2020-02-03T19:25:55Z

Xamarin.Essentials/Xamarin.Essentials.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="MSBuild.Sdk.Extras/2.0.54">
  <PropertyGroup>
-    <TargetFrameworks>netstandard1.0;netstandard2.0;Xamarin.iOS10;Xamarin.TVOS10;Xamarin.WatchOS10;MonoAndroid60;MonoAndroid70;MonoAndroid71;MonoAndroid80;MonoAndroid81;MonoAndroid90;MonoAndroid10.0;tizen40;</TargetFrameworks>
+    <TargetFrameworks>netstandard1.0;netstandard2.0;Xamarin.iOS10;Xamarin.TVOS10;Xamarin.WatchOS10;MonoAndroid60;MonoAndroid70;MonoAndroid71;MonoAndroid80;MonoAndroid81;MonoAndroid90;MonoAndroid10.0;tizen40;net461</TargetFrameworks>


We will need to think about how we do this... net461 works in too many places.

I assume this will work with some more detailed tweaking to create multiple net461 dlls in the runtimes folder of the NuGet.

we should also add .Net Core WPF

Mrnikbobjeff · 2020-02-16T19:56:01Z

Geolocation and coding is available via the com interfaces in locationapi.h as far as I know. Magnetometers are available in the sensorapi,h header via correspoding com objects
https://docs.microsoft.com/en-us/windows/win32/api/sensorsapi/
Cameras are available via WIA https://docs.microsoft.com/de-de/windows/win32/wia/-wia-wia-tutorial?redirectedfrom=MSDN
I know there are other com api's for missing features but these were the ones I knew of.

…ences.

DamianMehers · 2020-02-18T16:31:37Z

Xamarin.Essentials/Preferences/Preferences.win32.cs

@@ -1,43 +1,63 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
-using Newtonsoft.Json;
+using System.Runtime.Serialization;
+using System.Runtime.Serialization.Formatters.Binary;

 namespace Xamarin.Essentials
 {
    public static partial class Preferences
    {
        static readonly string settingsPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), AppInfo.Name, "settings.dat");



Any chance that AppInfo.Name may contain invalid chars for win32 file names, such as a ":" ?

You could sanitize it by first removing any chars returned by Path.GetInvalidFileNameChars

Good catch, the documentation for the attribute says "The assembly title is a friendly name, which can include spaces" but that's not particularly informative.

It could also be blank ... perhaps fallback to using the file name of the launching assembly if the sanitized name is blank?

Path.GetFileNameWithoutExtension(Assembly.GetEntryAssembly().CodeBase);

Xamarin.Essentials/Preferences/Preferences.win32.cs

mattleibow · 2020-02-19T01:23:39Z

Xamarin.Essentials/Preferences/Preferences.win32.cs

+            {
+                if (preferences[CleanSharedName(sharedName)].ContainsKey(key))
+                {
+                    return (T)preferences[CleanSharedName(sharedName)][key];


Maybe a if (prefs.TryGetValue() && inner.TryGetValue())

Xamarin.Essentials/Preferences/Preferences.win32.cs

Mrnikbobjeff · 2020-02-19T12:14:28Z

Xamarin.Essentials/Preferences/Preferences.win32.cs

 using System.Runtime.Serialization;
 using System.Runtime.Serialization.Formatters.Binary;
+using PreferencesDictionary = System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, object>>;


Something to consider would be using IStrongBox as value container, as we can ellide boxing/unboxing some of the time this way: IStrongBox {public T Value;}
When reading a key we can instead do (value as IStrongBox).Value. This pattern is common in storing value types without boxing as often.

Mrnikbobjeff · 2020-02-21T00:05:19Z

An easy grab is Telephone and sms, simply invoke the launcher with the corresponding url. Same goes for sms. An improvement to launcher can be made by checking the registry for a corrsponding HKEY_CLASSES_ROOT%protocol%\shell\open\command registry key to check whether launching said url is supported

Mrnikbobjeff · 2020-02-29T18:29:48Z

Xamarin.Essentials/Geolocation/Geolocation.win32.cs

+
+namespace Xamarin.Essentials
+{
+    public static partial class Geolocation


Consider using the com interfaces for this, we can avoid having a dependency that way. The actual implementation uses the COM service as well. Very Optional though as the C# wrapper is quite a lot easier to deal with.

@Mrnikbobjeff The System.Devices dll is a built in part of the .NET framework so doesn't introduce a dependency, using the COM interfaces will require more code to achieve the same result.

Redth · 2020-04-14T15:28:40Z

A few notes as @mattleibow and I have been discussing:

Preferences should really serialize to json or some text format, as binary serialization has some dragons especially moving to .net 5
SecureStorage - we might be able to do something on a per user basis here, Potentially using CNG-DPAPI
We should consider how to handle Local vs Roaming profiles for preferences, and Secure Storage, etc.

peterfoot · 2020-04-14T15:38:13Z

@Redth Thanks, Json was rejected before because Json.net adds a dependency and System.Text.Json not available on older .NET versions. The only consistently available text format in-box is XML...

DPAPI/ProtectedData for SecureStorage makes sense, again physical storage is an issue.

I assume all of these will be non-roaming as the other platforms don't roam their preferences?

Redth · 2020-04-15T00:26:24Z

What about DataContractJsonSerializer? Or yeah System.Text.Json.

Other platforms implicitly can ‘roam’ their data depending on where it’s stored

peterfoot · 2020-04-15T11:33:16Z

@Redth - yes DataContractJsonSerializer looks like a good option.

Looking at the current implementations for Essentials they are all using private/local storage. I assume for WPF we want to match the behaviour of the existing UWP implementation where possible.

mattleibow · 2020-04-25T17:39:27Z

System.Text.Json does work on netstandard2.0 and net4.6.1

https://www.nuget.org/packages/System.Text.Json

peterfoot · 2020-04-26T11:48:48Z

@mattleibow Given the simple use-case here is it worth using System.Text.Json (introducing a NuGet dependency) or stick with the built-in DataContractJsonFormatter?

mattleibow · 2020-04-26T12:01:32Z

@peterfoot I would just use the contract serializer for now. Just wanted to say that it should work... But as I type this, I somehow feel that there was some issue with the serializer... Like dates... Not sure if anyone knows... Maybe it was around deserialization. But since we serialize and deserialize ourselves, we should be good.

Mrnikbobjeff · 2020-04-27T08:36:08Z

@mattleibow as we specify which types we accept (and all types we support are sealed) we do not encounter most serialisation issues such as ignoring validation when deserializing objects or expecting different types upon deserialization. Any text format should work without problems.

peterfoot · 2020-10-12T10:34:22Z

@Mrnikbobjeff yes, but my question was that if we can use the already written UWP API for Windows 10, is it worth writing the Win32 ones. It would really be only a subset of tablets/laptops with the hardware and how many would be running Windows 7/8?
The macOS implementation doesn't have sensors as I don't think they are as relevant for desktop apps.

Mrnikbobjeff · 2020-10-12T10:40:21Z

The macOS implementation doesn't have sensors as I don't think they are as relevant for desktop apps.

MacOs does not offer an abstraction over general p&p devices which device drivers can target for these sensors. That is the limiting factor IMHO. Also, writing new sensors once the base implementation is done is achieved in less than 20 loc up to and including BarometerSensor

peterfoot · 2020-10-12T21:07:42Z

@Mrnikbobjeff I'm not against implementing sensor APIs, I just wonder how many devices will be able to take advantage of them

Mrnikbobjeff · 2020-10-13T09:17:09Z

@Mrnikbobjeff I'm not against implementing sensor APIs, I just wonder how many devices will be able to take advantage of them

Very few at best, the most common sensors appear to be biometrics and luminosity sensors. My work device seems to have them both, and biometrics seem to be supported by other devices (primarily laptops) as well.

…rently running even if it contains references to the other.

follesoe · 2020-12-08T08:21:30Z

Just want to say this would be highly appreciated if it made it into Xamarin.Essentials.

Given that WPF is part of Xamarin.Forms (even if only as preview) it makes perfect sense to get Essentials supported on WPF as well. At Blueye we are using WPF over UWP due to limitations in some third-party libraries which prevents us from using Store Distribution, and side-loading of UWP is not as nice/trivial as with WPF.

I would be glad to help out with the implementation of some of the missing pieces. Would be great with some guidance on what would be required in order to have this merged (i.e. does all APIs need to be ported)?

Thank you for your effort so far @peterfoot! It has already been of value as we have adopted parts of your implementation already while awaiting the merge of this PR.

arivera12 · 2021-05-21T03:00:39Z

Oh yes! Xamarin essentials is coming to WPF! When this is planned to be released?

acffordyce973 · 2021-07-13T16:44:35Z

Are there any updates for Xamarin Essentials supporting WPF?

peterfoot · 2021-07-13T17:19:37Z

@acffordyce973 the PR was a bit stale so I've updated against the latest main branch so it should unblock the conflicts at least.

peterfoot added 2 commits February 2, 2020 18:35

Added WPF/Win32 platform implementation for key features.

0cbb71c

Added device, display and speech implementations. Added WPF sample ap…

9917325

…plication and tested available features.

mattleibow reviewed Feb 3, 2020

View reviewed changes

Preferences persisted to file. Email provider added

eed2900

Removed Json.NET dependency and used BinarySerializer to store prefer…

7bec9af

…ences.

DamianMehers reviewed Feb 18, 2020

View reviewed changes

mattleibow reviewed Feb 19, 2020

View reviewed changes

Mrnikbobjeff reviewed Feb 19, 2020

View reviewed changes

Xamarin.Essentials/Preferences/Preferences.win32.cs Outdated Show resolved Hide resolved

Improved preferences following feedback

a9f4c40

Mrnikbobjeff reviewed Feb 19, 2020

View reviewed changes

peterfoot added 2 commits February 27, 2020 22:57

Added Maps and Geolocation. Serialization improvements to Preferences

a132e57

Added phonedialer support for completeness

41f2cad

Mrnikbobjeff reviewed Feb 29, 2020

View reviewed changes

jfversluis mentioned this pull request Mar 15, 2020

Add Essentials dependency xamarin/Xamarin.Forms#9926

Closed

2 tasks

peterfoot added 2 commits April 15, 2020 22:06

Changed preferences serialization to Json. Added SecureStorage for Win32

9783b27

Code clean up

9f6173a

jamesmontemagno mentioned this pull request Apr 25, 2020

Additional Platform Support #662

Closed

11 tasks

peterfoot added 2 commits May 31, 2020 15:12

added Win32 placeholder

00937e5

Merge branch 'pr/2'

70dd965

peterfoot added 9 commits October 18, 2020 18:15

Cleared code formatting error

b1ba61f

Merge branch 'main' into master

bed4929

Fix IsSupported to throw expected exception

857dc87

Merge branch 'master' of https://github.com/inthehand/Essentials

9b9be61

Merge branch 'main' of https://github.com/xamarin/Essentials into main

c03c6bf

merged

307559e

Fixed FilePickerFileTypes and added new ones to the Win32 implementation

d8e4ed5

MainThread supports both WinForms and WPF and can detect which is cur…

01a36d0

…rently running even if it contains references to the other.

Fixed build warnings (macOS API change)

a0ae8ed

peterfoot requested a review from mattleibow March 8, 2021 17:02

arivera12 mentioned this pull request May 21, 2021

Hybrid Windows crash when using IJSRuntime early on page load dotnet/MobileBlazorBindings#259

Open

arivera12 mentioned this pull request Jun 12, 2021

Redirecting back from third party website app not loaded in app tag dotnet/MobileBlazorBindings#372

Closed

Added WinForms sample

c4969ea

peterfoot closed this Jul 13, 2021

peterfoot deleted the master branch July 13, 2021 17:01

merged latest

c885c9a

peterfoot reopened this Jul 13, 2021

fixed XF reference in WPF sample

4a857a3

mattleibow mentioned this pull request Mar 8, 2022

Add Support for WinUI Unpackaged Apps dotnet/maui#3166

Closed

13 tasks

inthehand closed this by deleting the head repository Dec 11, 2022

Added Windows Desktop (WPF) platform implementation #1079

Added Windows Desktop (WPF) platform implementation #1079

Conversation

peterfoot commented Feb 3, 2020 • edited Loading

Description of Change

Bugs Fixed

API Changes

Behavioral Changes

PR Checklist

msftclas commented Feb 3, 2020 • edited Loading

mattleibow left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mrnikbobjeff commented Feb 16, 2020 • edited Loading

DamianMehers Feb 18, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DamianMehers Feb 18, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mrnikbobjeff commented Feb 21, 2020

Mrnikbobjeff Feb 29, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Redth commented Apr 14, 2020

peterfoot commented Apr 14, 2020

Redth commented Apr 15, 2020

peterfoot commented Apr 15, 2020

mattleibow commented Apr 25, 2020

peterfoot commented Apr 26, 2020

mattleibow commented Apr 26, 2020

Mrnikbobjeff commented Apr 27, 2020

peterfoot commented Oct 12, 2020

Mrnikbobjeff commented Oct 12, 2020

peterfoot commented Oct 12, 2020

Mrnikbobjeff commented Oct 13, 2020

follesoe commented Dec 8, 2020 • edited Loading

arivera12 commented May 21, 2021

acffordyce973 commented Jul 13, 2021

peterfoot commented Jul 13, 2021

peterfoot commented Feb 3, 2020 •

edited

Loading

msftclas commented Feb 3, 2020 •

edited

Loading

Mrnikbobjeff commented Feb 16, 2020 •

edited

Loading

DamianMehers Feb 18, 2020 •

edited

Loading

DamianMehers Feb 18, 2020 •

edited

Loading

Mrnikbobjeff Feb 29, 2020 •

edited

Loading

follesoe commented Dec 8, 2020 •

edited

Loading