Revision as of 21:57, 21 November 2012 by kiran10182 (Talk | contribs)

Create simple overlay with UserControl in Windows Phone

From Nokia Developer Wiki
Jump to: navigation, search

This article explains how to create simple overlay using UserControl in Windows Phone.

WP Metro Icon UI.png
SignpostIcon XAML 40.png
WP Metro Icon WP8.png
SignpostIcon WP7 70px.png
Article Metadata
Code Example
Source file: Media:OverLays.zip
Tested with
SDK: windows phone 8.0
Devices(s): windows phone 8.0 emulator
Platform(s): windows phone
Windows Phone 8
Windows Phone 7.5
Created: mehul_raje (16 Nov 2012)
Last edited: kiran10182 (21 Nov 2012)


Overlays can be in the form of progress overlay or simple prompt overlay. Using UserControl for implementing overlay gives us feasibility to easily construct any type of overlay. This article shows implementation of progress overlays using UserControl.

The following steps describe how to implement progress overlay:

  1. Create new Windows Phone project from Visual Studio.
  2. Add new UserControl named OverLay.xaml in current project.

Copy paste following code in your OverLay.xaml file.

<UserControl x:Class="WindowsPhoneSample7.OverLay"
FontFamily="{StaticResource PhoneFontFamilyNormal}"
FontSize="{StaticResource PhoneFontSizeNormal}"
d:DesignHeight="800" d:DesignWidth="480">
<Grid x:Name="LayoutRoot" Background="Transparent">
<RowDefinition Height="400"/>
<RowDefinition Height="400"/>
<StackPanel Grid.Row="1">
<ProgressBar IsIndeterminate="True" Foreground="Orange" Height="50" Width="480" VerticalAlignment="Center"/>
<TextBlock Text="Wait" Foreground="Orange" HorizontalAlignment="Center"/>

LayoutRoot is populated with ProgressBar and TextBlock but you can put any UI controls here which you want to show as overlay. For e.g, if you want to show simple About prompt as overlay then you may put simple TextBlock and Image with custom size.

In code behind file of Overlay.xaml initialize LayoutRoot size with the size you want. Referring the following code where height and width of LayoutRoot is set to height and width of the screen.

public OverLay()
this.LayoutRoot.Height = Application.Current.Host.Content.ActualHeight;
this.LayoutRoot.Width = Application.Current.Host.Content.ActualWidth;
SystemTray.IsVisible = false; //to hide system tray

Now open MainPage.xaml.cs file and copy paste the following code in it.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Animation;
using System.Windows.Shapes;
using Microsoft.Phone.Controls;
using System.Windows.Controls.Primitives;
using System.ComponentModel;
using System.Threading;
namespace WindowsPhoneSample7
public partial class MainPage : PhoneApplicationPage
private Popup popup;
// Constructor
public MainPage()
this.popup = new Popup();
private void BtnStart_Click(object sender, RoutedEventArgs e)
this.LayoutRoot.Opacity = 0.2;
OverLay ovr = new OverLay();
this.popup.Child = ovr;
this.popup.IsOpen = true;
BackgroundWorker worker = new BackgroundWorker();
worker.DoWork += (s, a) =>
worker.RunWorkerCompleted += (s, a) =>
popup.IsOpen = false;
this.LayoutRoot.Opacity = 1.0;
protected override void OnBackKeyPress(System.ComponentModel.CancelEventArgs e)
this.popup.IsOpen = false;

BtnStart_Click event contains logic of showing progress overlay, with the activation and deactivation of overlay you need to set opacity of underlying page. In the DoWork method of BackgroundWorker, you can write actual logic. In the current implementation, it just blocks the UI thread for some time.
Following screen shot shows progress overlay of above implementation.

Progress Overlay

Finally don't forget to set IsOpen property of popup to "false" on OnBackKeyPress event, otherwise overlay continues to display even though you travel to another xaml page.
You can find complete source code below.

655 page views in the last 30 days.

Was this page helpful?

Your feedback about this content is important. Let us know what you think.


Thank you!

We appreciate your feedback.