WP7 ToggleSwitch in depth | key concepts and API

published on: 12/13/2010 | Views: N/A | Tags: WP7Toolkit

by WindowsPhoneGeek

In this article I am going to talk about the key properties, events and the main features of the Windows Phone 7 ToggleSwitch control in details..

One of the new components in the Silverlight Toolkit is ToggleSwitch. It is a UI element that enables users to turn something on or off.  Basically it is mobile equivalent of the well known checkbox.

To begin using ToggleSwitch first  add a reference to  the Microsoft.Phone.Controls.Toolkit.dll  assembly which is installed with the toolkit and you can find it in :
       C:\Program Files (x86)\Microsoft SDKs\Windows Phone\v7.0\Toolkit\Nov10\Bin\Microsoft.Phone.Controls.Toolkit.dll.

You will also need to add the "toolkit" prefix declaration. Make sure that your page declaration includes the "toolkit" namespace:

       xmlns:toolkit="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone.Controls.Toolkit"

The sample code should looks like:

<toolkit:ToggleSwitch x:Name="toggle" Content="ToggleSwitch is on" IsChecked="True"  Header="ToggleSwitch"/>

Basic Structure

ToggleSwitch has two check states:  On and Off.

        

Key Properties

ToggleSwitch derives from ContentControl so it exposes some properties like Content and ContentTemplate which come from the base class. In addition to that ToggleSwitch has the following properties:

• IsChecked

       IsChecked is a dependency property of type bool?. It gets or sets whether the ToggleSwitch is checked.

       Example:

      <toolkit:ToggleSwitch x:Name="toggle"  Content="ToggleSwitch is on"  IsChecked="True"  Header="ToggleSwitch"/>

• Header
  Header is a dependency property of type object. It gets or sets the header of the ToggleSwitch.

• Content

       An object that contains the control's content.

       Example:

      <toolkit:ToggleSwitch x:Name="toggle"  Content="ToggleSwitch is on"  IsChecked="True" Header="ToggleSwitch">

• HeaderTemplate 

  HeaderTemplate is a dependency property of type DataTemplate. It gets or sets the template used to display the control's header.

• ContentTemplate

      The data template that is used to display the content of the ToggleSwitch.

      Example:

     <toolkit:ToggleSwitch Header="5:45 AM">
        <toolkit:ToggleSwitch.HeaderTemplate>
            <DataTemplate>
                <ContentControl Foreground="{StaticResource PhoneForegroundBrush}" Content="{Binding}"/>
            </DataTemplate>
        </toolkit:ToggleSwitch. HeaderTemplate>
        <toolkit:ToggleSwitch. ContentTemplate>
            <DataTemplate>
                <StackPanel>
                    <StackPanel Orientation="Horizontal">
                        <TextBlock Text="Alarm: " FontSize="{StaticResource PhoneFontSizeSmall}"/>
                        <ContentControl HorizontalAlignment="Left" FontSize="{StaticResource PhoneFontSizeSmall}" Content="{Binding}"/>
                    </StackPanel>
                    <TextBlock Text="every schoolday" FontSize="{StaticResource PhoneFontSizeSmall}" Foreground="{StaticResource PhoneSubtleBrush}"/>
                </StackPanel>
            </DataTemplate>
        </toolkit:ToggleSwitch. ContentTemplate>
    </toolkit:ToggleSwitch>

• SwitchForeground

       SwitchForeground is a dependency property of type Brush . It gets or sets the switch foreground color of the ToggleSwitch.

       Example:

       this.toggle.SwitchForeground = new SolidColorBrush(Colors.Red);

Events

• Checked

      Occurs when the ToggleSwitch" is checked.
      Example:

      this.toggle.Checked += new EventHandler<RoutedEventArgs>(toggle_Checked);

      void toggle_Checked(object sender, RoutedEventArgs e) 
      { //add some code here        }

• Click

       Occurs when the ToggleSwitch is clicked.

      Example:

      this.toggle.Click += new EventHandler<RoutedEventArgs>(toggle_Click);

      void toggle_Click(object sender, RoutedEventArgs e) 
      { //add some codehere        }

• Indeterminate

      Occurs when the ToggleSwitch" is indeterminate - neither on nor off

     Example:

     this.toggle.Indeterminate += new EventHandler<RoutedEventArgs>(toggle_Indeterminate);

     void toggle_Indeterminate(object sender, RoutedEventArgs e) 
    {//add some code here        }

• Unchecked

      Occurs when the ToggleSwitch" is unchecked.
      Example:

      this.toggle.Unchecked += new EventHandler<RoutedEventArgs>(toggle_Unchecked);

      void toggle_Unchecked(object sender, RoutedEventArgs e) 
      {//add some code here        }

Sample Usage

Here is an example of how to use this control in the easiest way:

<toolkit:ToggleSwitch x:Name="toggle" Content="ToggleSwitch is on" IsChecked="True"  Header="ToggleSwitch"/>

public MainPage()
{
    InitializeComponent();
    this.toggle.Checked += new EventHandler<RoutedEventArgs>(toggle_Checked);
    this.toggle.Unchecked += new EventHandler<RoutedEventArgs>(toggle_Unchecked);
}

void toggle_Unchecked(object sender, RoutedEventArgs e)
{
    this.toggle.Content = "ToggleSwitch is off";
    this.toggle.SwitchForeground = new SolidColorBrush(Colors.Red);
}

void toggle_Checked(object sender, RoutedEventArgs e)
{
    this.toggle.Content = "ToggleSwitch is on";
    this.toggle.SwitchForeground = new SolidColorBrush(Colors.Green);
}

The result can be seen on the following screen shots:

  

That was all about the Windows Phone 7 ToggleSwitch in depth. I hope that the article was helpful. You can find the full source code here:

You can also follow us on Twitter @winphonegeek

Comments

Add comment to 'WP7 ToggleSwitch in depth | key concepts and API'

Title Your Name

Comment