Skip to main content

Rendering a Xaml Gauge Control (and other WPF Controls) in ASP.NET MVC

In my last post, I introduced XamlAsyncController, a POC implementation that shows how to render Xaml controls from ASP.NET MVC.

To recap, these are the two steps you need to do to render Xaml or a WPF control as an image from your ASP.NET MVC Controller

  1. Inherit your Controller from XamlAsyncController, and add an Async action for serving the image 
  2. Add your Xaml file to the path /Visualizations/{Controller}/{Action}.xaml

Also, now there is one more way of rendering a WPF control from your MVC controller. You can create a WPF control from your controller and pass it as a parameter of StartRendering method, in your Async method.image

The Gauge control XAML I’ve used in this example is the Xaml guage control developed by Evelyn from Codeproject – Credits to Evelyn.

Have a look at the Controller that renders the Button image and the Gauge image, in the shown html page.

    public class VisualsController : XamlAsyncController
    {

        public void GuageAsync()
        {           
            ViewData["Score"]=200d;
            ViewData["Title"] = "Hello";
            StartRendering();
        }

        public ActionResult GuageCompleted()
        {
            return XamlView();
        }

        public void ButtonAsync()
        {
            StartRendering(()=>new Button() { Content="Hello",Height=30, Width=100 });
        }

        public ActionResult ButtonCompleted()
        {
            return XamlView();
        }
     }

And now you can do following to render those images

     
   <h2>Xaml in ASP.NET MVC Demos</h2>
    <h3>Simple Button</h3>
     <image src="/Visuals/Button" />
    <h3>Gauge</h3>
     <image src="/Visuals/Guage" />

As you can see, the Visuals controller returns the image, based on the action name. In the case of ButtonAsync action, you can see that we are creating the WPF Button object directly in the action, and passing it as a parameter of StartRendering method, to render the button as an image.

In case of the GuageAsync action, you may see that we are just calling StartRendering after filling some data in the ViewData. If that is the case, as I explained in my previous post, by convention, we expect the Xaml view in the path Visualizations\Visual\Guage.xaml . Here is our Guage.xaml View, and you can see the we have the ‘Score’ property of our UserControl bound to the ViewData we passed in the GuageAsync action.

<UserControl x:Class="MvcXamlController.Demo.Visualizations.Dashboard.Guage"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:controls="clr-namespace:MvcXamlController.Controls;assembly=MvcXamlController.Controls"
        Width="300" Height="300"     
        mc:Ignorable="d">
    <Grid>
        <controls:CircularGaugeControl x:Name="myGauge1" 
                                        Radius="150" 
                                        ScaleRadius="110" 
                                        ScaleStartAngle="120" 
                                        ScaleSweepAngle="300"
                                        PointerLength="85" 
                                        PointerCapRadius="35" 
                                        MinValue="0" 
                                        MaxValue="1000" 
                                        MajorDivisionsCount="10" 
                                        MinorDivisionsCount="5" 
                                        CurrentValue="{Binding Score}"
                                        ResetPointerOnStartUp="True" 
                                        ImageSize="40,50"
                                        RangeIndicatorThickness="8"
                                        RangeIndicatorRadius="120"
                                        RangeIndicatorLightRadius="10"
                                        RangeIndicatorLightOffset="80"
                                        ScaleLabelRadius="90"
                                        ScaleLabelSize="40,20"
                                        ScaleLabelFontSize="10"
                                        ScaleLabelForeground="LightGray"
                                        MajorTickSize="10,3"
                                        MinorTickSize="3,1"
                                        MajorTickColor="LightGray"
                                        MinorTickColor="LightGray"
                                        ImageOffset="-50"
                                        GaugeBackgroundColor="Black"
                                        PointerThickness ="16"
                                        OptimalRangeStartValue="300"
                                        OptimalRangeEndValue="700" 
                                        DialTextOffset="40" 
                                        DialText="{Binding Title}"
                                        DialTextColor="Black"
                                        >

        </controls:CircularGaugeControl>
    </Grid>
</UserControl>
	

Have a look at the source code here.

There are some limitations as of now. You may note that if the WPF control supports animation (like the Chart controls), you won’t be able to render them properly. How ever, if you create your own UserControls, you can easily make them work

Also, Keep in touch :) follow me in twitter or subscribe to this blog. Interested in more ASP.NET MVC? Read my articles about creating a custom view engine for ASP.NET MVC or using Duck Typed View Models in ASP.NET MVC

Happy coding..

Popular posts from this blog

Top 7 Coding Standards & Guideline Documents For C#/.NET Developers

Some time back, I collated a list of 7 Must Read, Free EBooks for .NET Developers, and a lot of people found it useful. So, I thought about putting together a list of Coding Standard guidelines/checklists for .NET /C# developers as well.As you may already know, it is easy to come up with a document - the key is in implementing these standards in your organization, through methods like internal trainings, Peer Reviews, Check in policies, Automated code review tools etc. You can have a look at FxCop and/or StyleCop for automating the review process to some extent, and can customize the rules based on your requirements.Anyway, here is a list of some good Coding Standard Documents. They are useful not just from a review perspective - going through these documents can definitely help you and me to iron out few hidden glitches we might have in the programming portion of our brain. So, here we go, the listing is not in any specific order.1 – IDesign C# Coding StandardsIDesign C# coding stand…

5 Awesome Learning Resources For Programmers (To help you and your kids to grow the geek neurons)

Happy New Year, this is my first post in 2012. I’ll be sharing few awesome learning resources I’ve bookmarked, and will be pointing out some specific computer/programming related courses I've found interesting from these resources.Also, thought about saving this blog post for my kids as well - instead of investing in these Child education schemes (though they are too small as of today, 2 years and 60 days respectively ). Anyway, personally my new year resolution is to see as much videos from this course collections (assuming I can find some free time in between my regular job && changing my babies diapers).1 – Khan AcademyAs I mentioned some time back, you and your kids are missing some thing huge if you havn’t heard about Khan Academy.  It is an awesome learning resource, especially if you want to re-visit your basics in Math, Science etc.With a library of over 2,600 videos covering everything from arithmetic to physics, finance, and history and 268 practice exercises, th…

Hack Raspberry Pi – How To Build Apps In C#, WinForms and ASP.NET Using Mono In Pi

Recently I was doing a bit of R&D related to finding a viable, low cost platform for client nodes. Obviously, I came across Raspberry Pi, and found the same extremely interesting. Now, the missing piece of the puzzle was how to get going using C# and .NET in the Pi. C# is a great language, and there are a lot of C# developers out there in the wild who are interested in the Pi.In this article, I’ll just document my findings so far, and will explain how develop using C# leveraging Mono in a Raspberry Pi. Also, we’ll see how to write few minimal Windows Forms & ASP.NET applications in the Pie as well.Step 1: What is Raspberry Pi?Raspberry Pi is an ARM/Linux box for just ~ $30. It was introduced with a vision to teach basic computer science in schools. How ever, it got a lot of attention from hackers all around the world, as it is an awesome low cost platform to hack and experiment cool ideas as Pi is almost a full fledged computer.  More About R-Pi From Wikipedia.The Raspberry Pi