How to Create a Different Circular Loader using XAML?


Custom Loader

Last Wednesday (July 6th 2011) we explored a way to create a Circular loader using XAML without writing any line in the code behind file. Lot of you gave a good feedback and discussed various findings on the same.

 

I did some more investigation to create a different type of circular loader which you can include in your Silverlight, WPF and Windows Phone 7 applications where you are using XAML code. In this article, I will be guiding to create similar kind of Circular loader as shown above. This will be more simple than the previous one. Let's start our discussion and create one loader like this.

 

Background

I hope that you read my previous article "How to Create a Circular Loader using XAML?" that I posted last week. If you didn't read that yet, I will suggest you to read that one first because, that will give you more idea while reading this article. This is the 2nd part of the series where I am going to showcase you another type of loader just using the XAML code.

 

Setting up the Project

First we need to setup our project.  First create your Silverlight project and add one UserControl named "CustomLoader.xaml" in the project. Then we need to create the UI of the UserControl. But before going to that step, we need three assembly references included in the project. the following three DLL references in it:

  1. Microsoft.Expression.Drawing.dll
  2. Microsoft.Expression.Interactions.dll
  3. System.Windows.Interactivity.dll

The first DLL will be useful to create a Circular Arc and the rest of the other two DLLs will be used to create the Triggers. We will discuss more on this later while adding them.

 

Add Assembly References for Microsoft.Expression.Drawing, Microsoft.Expression.Interactions and System.Windows.Interactivity

 

Once you added the DLL references, add the respective XMLNS namespaces in the CustomLoader usercontrol as shown below:

 

Add xmlns Namespace to the UserControl

 

The first xmlns namespace named "ed" will refer the Microsoft.Expression.Drawing.dll assembly and by using this we will create an Arc in the UI. The rest two namespaces from the System.Windows.Interactivity.dll and Microsoft.Expression.Interactions.dll will be useful to create the EventTrigger. Once you are done with this step, we can jump into the UI design.

 

Creating the XAML UI for the Circular Loader

In this step, we will just create the UI of the loader, where we will have a circular control in the screen. Let's open the usercontrol that we added into the project and replace the LayoutRoot Grid control with a ViewBox control and add a Canvas panel into it. Confused, why we did this!!! Read my previous article then. That will clarify the same.

 

Now add proper height and width to the Canvas, so that, we can place a symmetric arc control inside it. We will now add one Arc control from the "ed" namespace as shown below and add RenderTransform to it, so that, we can rotate the control easily using the StoryBoard. We will also add a Gradient fill to the control to create the similar look and feel that we shown earlier.

 
<Viewbox>    
    <Canvas x:Name="LayoutRoot" Background="White" Height="100" Width="100">
        <ed:Arc x:Name="arc" ArcThickness="20" ArcThicknessUnit="Pixel"
                EndAngle="360" Height="100" Stretch="None"
                StartAngle="0" UseLayoutRounding="False" Width="100" 
                RenderTransformOrigin="0.5,0.5">
            <ed:Arc.RenderTransform>
                <CompositeTransform/>
            </ed:Arc.RenderTransform>
            <ed:Arc.Fill>
                <LinearGradientBrush EndPoint="0.5,1" StartPoint="0.5,0">
                    <GradientStop Color="Black"/>
                    <GradientStop Color="White" Offset="1"/>
                </LinearGradientBrush>
            </ed:Arc.Fill>
        </ed:Arc>
    </Canvas>
</Viewbox>

 

Make sure that, we can create the same without using the Arc control. In that case, you don't have to add the said assembly. So, what to do in that case? You can create two circles using Ellipse control but that step will be little tough and complex.

 

If you are familiar with Expression Blend, you can add the Arc by following the below steps as shown in the screenshot:

 

Selecting Ring Control from the Shapes Assets in Expression Blend

  1. Inside the Expression Blend, click the Assets panel.
  2. Click the "Shape" section from the left group.
  3. Now from the "Object and Timeline" Explorer, select the LayoutRoot canvas where we will add the Arc.
  4. Double click on the "Ring" to insert the Arc control inside the LayoutRoot.

These steps will add the control in the UI as shown below:

 

Ring Control from the Shapes Assets Added to the LayoutRoot Canvas

 

This actually create the same XAML code mentioned earlier. Add the RenderTransform properly to the control. Remember that, if you didn't already add the reference in the project. This step will do that for you automatically.

 

Create the Animation using Storyboard

Now time to create the Storyboard for our loader to give proper animation to it. Inside the UserControl.Resources add the Storyboard as shown below:

 
<UserControl.Resources>
    <Storyboard x:Name="LoaderAnimation">
        <DoubleAnimationUsingKeyFrames Storyboard.TargetName="arc" RepeatBehavior="Forever"
                                       Storyboard.TargetProperty="(UIElement.RenderTransform).(CompositeTransform.Rotation)">
            <EasingDoubleKeyFrame KeyTime="0" Value="0"/>
            <EasingDoubleKeyFrame KeyTime="0:0:2" Value="365"/>
        </DoubleAnimationUsingKeyFrames>
    </Storyboard>
</UserControl.Resources> 

 

This storyboard will be responsible to rotate the control 360 degree for indefinite time. Give a proper name (say "LoaderAnimation" in our case) to the Storyboard.

 

Adding the Trigger to Start the Animation

Once your Storyboard animation is ready, it's time to fire the Storyboard to play. You can do this from the code behind too. But as we said, we will not use any code behind file, hence we will trigger this from the XAML code itself.

 

Let's use the below code which will trigger the animation once the view loaded:

 
<i:Interaction.Triggers>
    <i:EventTrigger>
        <ei:ControlStoryboardAction Storyboard="{StaticResource LoaderAnimation}"/>
    </i:EventTrigger>
</i:Interaction.Triggers>

 

The ControlStoryboardAction behavior will fire the play call to the animation mentioned using the StaticResource.

 

Adding the Control to the View

This is simple step. First add the proper XMLNS namespace of the control in the view and then add the control inside the Grid control or whatever is your preferred location. Our code will look like this:

 
<UserControl x:Class="CircularLoader.MainPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:CircularLoader="clr-namespace:CircularLoader">
    <Grid x:Name="LayoutRoot" Background="White">
        <CircularLoader:CustomLoader Height="50" Width="50"/>
    </Grid>
</UserControl>

 

Use this code for your reference. This step finishes the complete design of our control and now time to see it in action.

 

Demo

Build the project and resolve if any error happens. Now run the project and you will see the following UI inside your browser:

 

Loader Demo

 

That's our control that we created just now. Simple and small steps to create such nice looking circular loader for your application. You can now customize and add other functionalities to it too.

 

Hope these two articles will help you to create circular loader for your application. You can create many types of circular loader. Once these steps are clear to you, it will be easier for you to implement.

 

Download Source Code

Do you need the complete code? Ok, you can download the complete source code for free from the below mentioned location. Use it for your reference:


If you have come this far, it means that you liked what you are reading. Why not reach little more and connect with me directly on Twitter , Facebook , Google+ and LinkedIn . I would love to hear your thoughts and opinions on my articles directly. Also, don't forget to share your views and/or feedback in the comment section below.

4 comments

  1. web hosting review
    [url][http://webhostingreview.info/][/url]
    Thanks for sharing this blog how to create different circular loader.It is good article to users.thanks for sharing this blog

    ReplyDelete
  2. I like this article.

    Bear in mind these things are commonly called throbbers.
    Anyone looking for alternatives might want to google using throbber as there are a number of such articles although mostly done back in 2007, 2008.

    Laurent Bugnion does an interesting alternative type in one of his MVVM videos I think the 2011 one. http://channel9.msdn.com/Events/MIX/MIX11/OPN03
    If it's not in there then it'll be the mix10 video.

    ReplyDelete
  3. That is an interesting graphic your have with the hands showing where you would click in Expression Blend. I need to consider using that technique :)

    ReplyDelete
  4. @Michael, you can order your Free copy of SnagIt to do it by providing your MVP url.

    ReplyDelete


 
© 2008-2016 Kunal-Chowdhury.com - Microsoft Technology Blog for developers and consumers | Designed by Kunal Chowdhury
Back to top