WP7 Tombstone Helper

New Post: Any news on support for the Phone Toolkit 7.1 - LongListSelector?

rickengle — Sat, 21 Jul 2012 14:54:48 GMT

I saw a post that support for the Phone Toolkit was coming. What's the status on that? Has anyone already written an extension for LongListSelector?

Thanks,

Rick

Reviewed: v2.5 (יונ 15, 2012)

orkazaz — Fri, 15 Jun 2012 14:19:46 GMT

Rated 5 Stars (out of 5) - Great release. A little problem when adding a custom control. I commented about how to resolve it in the "Documentation Section".

New Comment on "Documentation"

orkazaz — Fri, 15 Jun 2012 14:17:00 GMT

You can make life more easy for adding custom controls. It's not enough to: "Add appropriate entries to AllTombstoneRestorers() and AllSupportedTombstoners() in "PhoneApplicationPageExtensions.cs"." Because in the AllSupportedTombstoners method the first thing is a foreach loop that checks if the control type exists in the property: "SupportedTypes". Because we didn't add the new custom type to that list we will get an exception. Even if we did add the 2 enteries like written above: // There will be errors if the unsupported types have been passed in the filter. // Highlight this by raising an error foreach (var type in filteredTypesToSave) { if (!SupportedTypes.Contains(type) && !TombstoneHelperExtensibility.CustomTombstoners.ContainsKey(type)) { throw new ArgumentException(string.Format("TombstoneHelper doesn't know how to handle the type: {0}{1}You could create and register a custom tombstoner for this type or remove it from the list of types to use.", type.ToString(), System.Environment.NewLine)); } } You can fix it in 2 ways: (1) Add the 2 enteries like you said AND add the new type to the SupportedTypes list property hardcoded. OR (2) At the begining of the method "AllSupportedTombstoners" (Before the type checker foreach) call a new static method, AND also add the call for this method to begining of the "AllTombstoneRestorers" method. /// <summary> /// TODO: Register here all the custom tombstoners /// </summary> private static void RegisterAllCustomTombstoners() { TombstoneHelperExtensibility.RegisterCustomTombstoner(typeof(TextBlock), new TextBlockTombstoner()); } this method uses the RegisterCustomTombstoner method inside the class "TombstoneHelperExtensibility". I prefer the second option because you don't have to add the above written 2 enteries hardcoded for every new custome support for a new control. Just add a single line to this new method :-) And besides, this way the CustomTombstoners actually means something.

New Comment on "Documentation"

orkazaz — Fri, 15 Jun 2012 11:47:44 GMT

You can make life more easy for adding custom controls. It's not enough to: "Add appropriate entries to AllTombstoneRestorers() and AllSupportedTombstoners() in "PhoneApplicationPageExtensions.cs"." Because in the AllSupportedTombstoners method the first thing is a foreach loop that checks if the control type exists in the property: "SupportedTypes". Because we didn't add the new custom type to that list we will get an exception. Even if we did add the 2 enteries like written above: // There will be errors if the unsupported types have been passed in the filter. // Highlight this by raising an error foreach (var type in filteredTypesToSave) { if (!SupportedTypes.Contains(type) && !TombstoneHelperExtensibility.CustomTombstoners.ContainsKey(type)) { throw new ArgumentException(string.Format("TombstoneHelper doesn't know how to handle the type: {0}{1}You could create and register a custom tombstoner for this type or remove it from the list of types to use.", type.ToString(), System.Environment.NewLine)); } } You can fix it in 2 ways: (1) Add the 2 enteries like you said AND add the new type to the SupportedTypes list property hardcoded. OR (2) At the begining of the method "AllSupportedTombstoners" (Before the type checker foreach) call a new static method: /// <summary> /// TODO: Register here all the custom tombstoners /// </summary> private static void RegisterAllCustomTombstoners() { TombstoneHelperExtensibility.RegisterCustomTombstoner(typeof(TextBlock), new TextBlockTombstoner()); } this method uses the RegisterCustomTombstoner method inside the class "TombstoneHelperExtensibility". I prefer the second option because you don't have to add the above written 2 enteries hardcoded. Just add a single line to this new method. And besides, this way the CustomTombstoners actually means something.

Updated Wiki: Home

mrlacey — Tue, 13 Mar 2012 15:05:17 GMT

Tombstoning support just got REALLY simple!

This library adds extension methods to PhoneApplicationPage so you don't have to worry about maintaining the state of a page in your app if it gets tombstoned.

It just takes 2 lines of code!

protected override void OnNavigatingFrom(NavigatingCancelEventArgs e)
{
    this.SaveState(e);  // <- first line
}

protected override void OnNavigatedTo(NavigationEventArgs e)
{
    this.RestoreState();  // <- second line
}

If you add the above to your code then the contents, checked state and scroll positions of TextBoxes, PasswordBoxes, CheckBoxes, RadioButtons, Sliders, ListBoxes and ScrollViewers will be preserved.

If you want to add support for other types this can be done as the code was designed to be easily extensible.

The code is optimised for performance but if you don't use all of those types on your page you can get even better performance by just specifying the types of the objects you wish to save the state of:

    this.SaveState(typeof(ScrollViewer));
or 
    this.SaveState(typeof(TextBox), typeof(PasswordBox), typeof(CheckBox));
or 
    this.SaveState<TextBox, PasswordBox, CheckBox>();

Yes. It's reallly that simple.

You just need to make sure you're given a name to the object you wish to save the state of.

    <TextBox Name="thisHasANameAndSoWillBeSaved" />
    <TextBox /><!--This TextBox does not have a name so it's contents won't be automatically saved and restored -->

Please note that there are much better ways of using it. See the Documentation page for more details.

All feedback, comments, questions, etc. greatly appreciated.

New Post: what does it store when calling SaveState?

mrlacey — Tue, 06 Mar 2012 20:36:17 GMT

If you switch to the main menu and then launch the app from there, you are not recovering from tombstoning, you are launching a new instance of the app. The standard behaviour for such an action is to not restore the state of the app.

To be clear you are not tombstoning if you launch a new instance of the app.

TombstoneHelper only supports tombstoning, not persisting information between instances of apps. If you want to persist information or state between app instances you'll need to do that yourself and put the information in IsolatedStorgeSettings or a file in IsolatedStorage.

For an example of what's saved, you can examine the State property of the page after calling SaveState().
Alternatively, you can see what and how state is saved for each type by looking at the Save() method in each of the XxxxxTombstoner files.

New Post: what does it store when calling SaveState?

wackawacka — Fri, 17 Feb 2012 21:35:43 GMT

my app is very simple, it has a stack panel which, UserControls are added to when clicking on a button like so:-

void btnAddPlayer_Click(object sender, EventArgs e)
{
	PlayerControl sbItem = new PlayerControl();
	ctlPanel.Children.Add(sbItem);	
}

Playercontrol is a simple control inherited from UserControl, it has 2 textboxes on it...

when I switch between apps everything is ok, its only tombstoned if you switch to the main menu and then load the app from the menu (instead of just switching/multi-tasking back to it)

when it is tombstoned the controls are no longer in the stackpanel... Id like it to be able to reload all of the added PlayerControls (and whatever text is set... and if possible there are some variables that are set aswell when the textbox is changed) ... with as little code as possible :)

any ideas?

Thanks

Updated Wiki: Home

mrlacey — Fri, 13 Jan 2012 11:28:58 GMT

Tombstoning support just got REALLY simple!

This library adds extension methods to PhoneApplicationPage so you don't have to worry about maintaining the state of a page in your app if it gets tombstoned.

It just takes 2 lines of code!

protected override void OnNavigatingFrom(NavigatingCancelEventArgs e)
{
    this.SaveState(e);  // <- first line
}

protected override void OnNavigatedTo(NavigationEventArgs e)
{
    this.RestoreState();  // <- second line
}

    this.SaveState(typeof(ScrollViewer));
or 
    this.SaveState(typeof(TextBox), typeof(PasswordBox), typeof(CheckBox));

Yes. It's reallly that simple.

You just need to make sure you're given a name to the object you wish to save the state of.

    <TextBox Name="thisHasANameAndSoWillBeSaved" />
    <TextBox /><!--This TextBox does not have a name so it's contents won't be automatically saved and restored -->

Please note that there are much better ways of using it. See the Documentation page for more details.

All feedback, comments, questions, etc. greatly appreciated.

New Post: Panorama

mrlacey — Fri, 13 Jan 2012 10:30:32 GMT

Changing the selected (default) item in the panorama (which is what would be saved and restored when tombstoning) has the effect of moving the background relative to the items. It you have an image for the panorama background than this can be a big change.

I've known lots of people see the consequence of this and then decide they didn't want it. As such I made this opt in so you don't get unexpected and often unwanted behaviour as standard.

As it's VERY rare to have more than one panorama in an app I felt this wasn't adding a lot of overhead if you did want it.

I hope that clears it up.

New Post: Panorama

mhompus — Wed, 11 Jan 2012 18:04:43 GMT

Maybe a stupid question, but why is the Panorama control not included by default?

New Post: FAS not working

mrlacey — Thu, 17 Nov 2011 11:17:14 GMT

For anyoen else finding this. See also: http://stackoverflow.com/questions/8154852/trouble-using-fast-application-switching

and the extended discussion at http://chat.stackoverflow.com/rooms/5091/discussion-between-matt-lacey-and-badescu-alexandru

New Post: FAS not working

badescuga — Wed, 16 Nov 2011 16:03:44 GMT

Hello! Thanks for all the efforts done to make this library. I have some issues though.. and don't understand why. I've included your "two line code" method and am testing my app in the emulator.

I've activated the tombstoning option for debuging. all my controls have names; i then press the 'home' button and when i go back to my app i still see the "Resuming" loading message. I have in my App.xaml.cs a bool to see if my app was dormant or tombstoned :

WasTombstoned = !e.IsApplicationInstancePreserved;

and in my xaml view page i have :

protected override void OnNavigatedTo(NavigationEventArgs e)

{ if (App.WasTombstoned == true)

{ this.RestoreState(); }

}

protected override void OnNavigatingFrom(System.Windows.Navigation.NavigatingCancelEventArgs e)

{ this.SaveState(e); }

What am i doing wrong?

New Post: Problem with user controls

pgmariotti — Mon, 14 Nov 2011 13:11:30 GMT

This is the XAML for the control:

<UserControl x:Class="Stanzetta.AddressControl"
    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:toolkit="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone.Controls.Toolkit"
    mc:Ignorable="d"
    FontFamily="{StaticResource PhoneFontFamilyNormal}"
    FontSize="{StaticResource PhoneFontSizeNormal}"
    Foreground="{StaticResource PhoneForegroundBrush}"
    d:DesignHeight="648" d:DesignWidth="477" Loaded="UserControl_Loaded">
 
    <Grid x:Name="LayoutRoot" Height="645">
        <StackPanel VerticalAlignment="Top" Height="244" Name="stpLogin" Visibility="Collapsed">
            <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String122, Mode=OneTime}"
                       TextAlignment="Center" FontSize="{StaticResource PhoneFontSizeMediumLarge}" FontWeight="Bold" />
            <TextBox Text="{Binding Email, Mode=TwoWay}" InputScope="EmailUserName" 
                     Name="tbEmail" FontSize="22" Height="Auto" Tag="5" GotFocus="tb_GotFocus" TextChanged="tbEmail_TextChanged"></TextBox>
            <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String124, Mode=OneTime}" 
                       FontSize="{StaticResource PhoneFontSizeMediumLarge}" 
                       TextAlignment="Center" FontWeight="Bold" Margin="0,-10,0,0" />
            <PasswordBox Password="{Binding Password, Mode=TwoWay}" Name="pwPass" FontSize="22" Tag="6" GotFocus="tb_GotFocus" PasswordChanged="pwPass_PasswordChanged" />
        </StackPanel>
        <StackPanel Orientation="Vertical" Margin="0,0,0,1" VerticalAlignment="Bottom" Height="394">
            <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String125, Mode=OneTime}" 
                       TextAlignment="Center" 
                       Height="40" FontSize="24" FontWeight="SemiBold" 
                       Margin="0,10,0,0"/>
            <CheckBox Content="{Binding Source={StaticResource ResKey},Path=Labels.String54, Mode=OneTime}" 
                          Height="72" HorizontalAlignment="Left" 
                          Margin="60,-5,0,0" Name="ckbWebAddress" VerticalAlignment="Top" 
                          Click="ckbWebAddress_Click" Width="370" FontSize="24" Foreground="{StaticResource PhoneForegroundBrush}" IsChecked="True" />
            <CheckBox Content="{Binding Source={StaticResource ResKey},Path=Labels.String53, Mode=OneTime}"
                          Height="70" Margin="60,-10,0,0" Name="ckbIPAddress" IsChecked="False" 
                          Click="ckbIPAddress_Click" FontSize="24" Foreground="{StaticResource PhoneForegroundBrush}" />
            <StackPanel Orientation="Horizontal" VerticalAlignment="Top"
                            Margin="30,0,30,0" Height="74" Name="stpIP" 
                            Visibility="Collapsed">
                <TextBox Height="73" HorizontalAlignment="Center" 
                         Margin="0,0,0,0" Name="tbAddress1" 
                         Text="" VerticalAlignment="Bottom" Width="90" 
                         BorderBrush="{StaticResource PhoneBorderBrush}" 
                         InputScope="CurrencyAmount"
                         HorizontalContentAlignment="Left" 
                         TextChanged="tbAddress_TextChanged" 
                         BorderThickness="3" 
                         FontSize="20"  GotFocus="tb_GotFocus" Tag="1" />
                <TextBox Height="73" HorizontalAlignment="Center" 
                         HorizontalContentAlignment="Left" 
                         Margin="15,0,0,0" Name="tbAddress2" 
                         InputScope="CurrencyAmount"
                         Text="" VerticalAlignment="Bottom" Width="90" 
                         TextChanged="tbAddress_TextChanged"  
                         BorderBrush="{StaticResource PhoneBorderBrush}" BorderThickness="3" 
                         FontSize="20" GotFocus="tb_GotFocus" Tag="2" />
                <TextBox Height="73" HorizontalAlignment="Center" 
                         Margin="15,0,0,0" Name="tbAddress3" Text="" 
                         VerticalAlignment="Bottom" Width="90" 
                         BorderBrush="{StaticResource PhoneBorderBrush}" 
                         InputScope="CurrencyAmount"
                         HorizontalContentAlignment="Left" 
                         TextChanged="tbAddress_TextChanged" 
                         BorderThickness="3" 
                         FontSize="20" SelectionForeground="Black" GotFocus="tb_GotFocus" Tag="3" />
                <TextBox Foreground="{StaticResource PhoneTextBoxForegroundBrush}"
                         Height="73" HorizontalAlignment="Center" 
                         HorizontalContentAlignment="Left" 
                         Margin="15,0,0,0" Name="tbAddress4" Text="" 
                         InputScope="CurrencyAmount"
                         VerticalAlignment="Bottom" Width="90"                      
                         TextChanged="tbAddress_TextChanged" 
                         BorderBrush="{StaticResource PhoneBorderBrush}" 
                         BorderThickness="3" FontSize="20" GotFocus="tb_GotFocus" Tag="4" />
            </StackPanel>
            <StackPanel Orientation="Horizontal">
                <TextBox Height="72" HorizontalAlignment="Left" Width="240" Name="tbApi" 
                         Text="http://api.dropbox.com/" VerticalAlignment="Top" Margin="10,0,0,0" 
                         FontSize="20" Visibility="Collapsed" IsReadOnly="True" />
                <TextBox Height="72" HorizontalAlignment="Center"
                     Text="" VerticalAlignment="Bottom" Width="425"
                     Margin="30,0,11,0" Name="tbWebAddress" GotFocus="tb_GotFocus" 
                     TextChanged="tbWebAddress_TextChanged" Tag="0"
                     HorizontalContentAlignment="Left"  
                     BorderThickness="3"
                     FontSize="20" Visibility="Visible" />
            </StackPanel>
            <TextBox Height="72" 
                     HorizontalContentAlignment="Left" Name="tbPort" 
                     Text="8080" 
                     InputScope="CurrencyAmount" Width="151" 
                     BorderBrush="{StaticResource PhoneBorderBrush}" BorderThickness="3" 
                     FontSize="20"  
                     GotFocus="tb_GotFocus" Tag="5" HorizontalAlignment="Left" Margin="303,0,0,0" TextChanged="tbPort_TextChanged" />
            <TextBlock Height="40" Name="tbkPort" 
                           Text="{Binding Source={StaticResource ResKey},Path=Labels.String55, Mode=OneTime}" 
                           Width="53" 
                           Foreground="{StaticResource PhoneForegroundBrush}" FontSize="22" 
                           HorizontalAlignment="Left" VerticalAlignment="Top" Margin="260,-55,0,0" IsHitTestVisible="False" />
            <CheckBox Content="  Needs login" Height="77" HorizontalAlignment="Left" Margin="32,-78,0,0" Name="ckbNeedsLogin" VerticalAlignment="Top" Width="218" Click="ckbNeedsLogin_Click" Visibility="Collapsed" IsChecked="True" />
            <Button Content="{Binding Source={StaticResource ResKey},Path=Labels.String56, Mode=OneTime}"
                        Height="71" HorizontalAlignment="Right" Name="btnValidate" VerticalAlignment="Top" 
                        Width="300" BorderBrush="Green" Background="White" FontSize="20" Foreground="Green" 
                        IsEnabled="False" Visibility="Visible" Margin="5,-5,23,0" Click="btnValidate_Click" />
            <Button Margin="20,-78,0,0" Width="100" HorizontalAlignment="Left" BorderBrush="Transparent" BorderThickness="0" Click="Button_Click">
                <Image Source="/Stanzetta;component/Resources/help.png" />
            </Button>            
        </StackPanel>
        <toolkit:PerformanceProgressBar Background="Transparent" 
                                        BorderBrush="White" 
                                        BorderThickness="2" 
                                        Height="32" 
                                        HorizontalAlignment="Center" 
                                        VerticalAlignment="Center" 
                                        Width="403" 
                                        Visibility="Visible" 
                                        Name="ppbValidate" Margin="42,212,42,401" />
    </Grid>
</UserControl>

and this is the XAML for the page where the control is used:

<phone:PhoneApplicationPage 
    x:Class="Stanzetta.SetupSourcesPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:phone="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone"
    xmlns:shell="clr-namespace:Microsoft.Phone.Shell;assembly=Microsoft.Phone"
    xmlns:controls="clr-namespace:Microsoft.Phone.Controls;assembly=Microsoft.Phone.Controls"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" 
    mc:Ignorable="d" d:DesignWidth="480" d:DesignHeight="768"
    FontFamily="{StaticResource PhoneFontFamilyNormal}"
    FontSize="{StaticResource PhoneFontSizeNormal}"
    Foreground="{StaticResource PhoneForegroundBrush}"
    SupportedOrientations="Portrait"  Orientation="Portrait"
    shell:SystemTray.IsVisible="True" xmlns:my="clr-namespace:Stanzetta" Loaded="PhoneApplicationPage_Loaded">
 
    <!--LayoutRoot is the root grid where all page content is placed-->
    <Grid x:Name="LayoutRoot" Background="Transparent">
        <!--Pivot Control-->
        <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String137, Mode=OneTime}" 
                   FontSize="36" 
                    FontWeight="Bold" 
                    FontFamily="Segoe WP"
                    TextAlignment="Center" />
        <controls:Pivot Margin="0,50,0,0" Name="MainPivot" >
            <!--Pivot item one-->
            <controls:PivotItem >
                <controls:PivotItem.Header>
                    <StackPanel Orientation="Horizontal">
                        <Image Source="/Stanzetta;component/Resources/calibre.png" Height="48" Width="48"/>
                        <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String138, Mode=OneTime}" 
                                   FontStyle="Italic" FontSize="30" VerticalAlignment="Center" Margin="10,0,0,0"/>
                    </StackPanel>
                </controls:PivotItem.Header>
                <Grid Height="640" VerticalAlignment="Top">
                    <my:AddressControl HorizontalAlignment="Left" x:Name="acCalibre" VerticalAlignment="Top" Width="485" Height="632" Margin="0,-6,0,0" />
                </Grid>
            </controls:PivotItem>
 
            <!--Pivot item two-->
            <controls:PivotItem>
                <controls:PivotItem.Header>
                    <StackPanel Orientation="Horizontal">
                        <Image Source="/Stanzetta;component/Resources/dropbox.png" Height="48" Width="48"/>
                        <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String139, Mode=OneTime}" 
                                   FontStyle="Italic" FontSize="30" VerticalAlignment="Center" Margin="10,0,0,0"/>
                    </StackPanel>
                </controls:PivotItem.Header>
                <Grid Height="640" VerticalAlignment="Top">
                    <my:AddressControl HorizontalAlignment="Left" x:Name="acDropbox" VerticalAlignment="Top" Width="483" Height="632" />
                </Grid>
            </controls:PivotItem>
            <controls:PivotItem VerticalAlignment="Top">
                <controls:PivotItem.Header>
                    <StackPanel Orientation="Horizontal">
                        <Image Source="/Stanzetta;component/Resources/calibredropbox.png" Height="48" Width="120"/>
                        <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String140, Mode=OneTime}" 
                                   FontStyle="Italic" FontSize="30" VerticalAlignment="Center" Margin="10,0,0,0"/>
                    </StackPanel>
                </controls:PivotItem.Header>
                <Grid Height="640" VerticalAlignment="Top">
                    <my:AddressControl HorizontalAlignment="Left" x:Name="acCalibreDropbox" VerticalAlignment="Top" Width="483" Height="628" />
                </Grid>
            </controls:PivotItem>
            <controls:PivotItem VerticalAlignment="Top">
                <controls:PivotItem.Header>
                    <StackPanel Orientation="Horizontal">
                        <Image Source="/Stanzetta;component/Resources/skydrive.png" Height="48" Width="48"/>
                        <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String141, Mode=OneTime}" 
                                   FontStyle="Italic" FontSize="30" VerticalAlignment="Center" Margin="10,0,0,0"/>
                    </StackPanel>
                </controls:PivotItem.Header>
                <Grid Height="640" VerticalAlignment="Top">
                    <my:AddressControl HorizontalAlignment="Left" x:Name="acSkydrive" VerticalAlignment="Top" Width="483" Height="629" />
                </Grid>
            </controls:PivotItem>
            <controls:PivotItem VerticalAlignment="Top">
                <controls:PivotItem.Header>
                    <StackPanel Orientation="Horizontal">
                        <Image Source="/Stanzetta;component/Resources/cloud.png" Height="48" Width="48"/>
                        <TextBlock Text="{Binding Source={StaticResource ResKey},Path=Labels.String142, Mode=OneTime}" 
                                   FontStyle="Italic" FontSize="30" VerticalAlignment="Center" Margin="10,0,0,0" />
                    </StackPanel>
                </controls:PivotItem.Header>
                <Grid Height="640" VerticalAlignment="Top">
                    <my:AddressControl HorizontalAlignment="Left" x:Name="acCloud" VerticalAlignment="Top" Width="483" Height="633" />
                </Grid>
            </controls:PivotItem>
        </controls:Pivot>
    </Grid>
 
    <!--Sample code showing usage of ApplicationBar-->
    <!--<phone:PhoneApplicationPage.ApplicationBar>
        <shell:ApplicationBar IsVisible="True" IsMenuEnabled="True">
            <shell:ApplicationBarIconButton x:Name="appbar_button1" IconUri="/Images/appbar_button1.png" Text="Button 1"/>
            <shell:ApplicationBarIconButton x:Name="appbar_button2" IconUri="/Images/appbar_button2.png" Text="Button 2"/>
            <shell:ApplicationBar.MenuItems>
                <shell:ApplicationBarMenuItem x:Name="menuItem1" Text="MenuItem 1"/>
                <shell:ApplicationBarMenuItem x:Name="menuItem2" Text="MenuItem 2"/>
            </shell:ApplicationBar.MenuItems>
        </shell:ApplicationBar>
    </phone:PhoneApplicationPage.ApplicationBar>-->
    
</phone:PhoneApplicationPage>

In the code behind for the page I had tried to save/restore as follows:
        protected override void OnNavigatedFrom(System.Windows.Navigation.NavigationEventArgs e)
        {
            base.OnNavigatedFrom(e);
            //this.SaveState();
            PhoneApplicationService.Current.State["Stanzetta.AddLibraryFocus"] = ifocus;
            PhoneApplicationService.Current.State["Stanzetta.CurrentPivot"] = MainPivot.SelectedIndex;
        }
 
        protected override void OnNavigatedTo(System.Windows.Navigation.NavigationEventArgs e)
        {
            base.OnNavigatedTo(e);
            //this.RestoreState();
            if (!PhoneApplicationService.Current.State.ContainsKey("Stanzetta.AddLibraryFocus"))
                PhoneApplicationService.Current.State.Add("Stanzetta.AddLibraryFocus", ifocus.ToString());
            if (!PhoneApplicationService.Current.State.ContainsKey("Stanzetta.CurrentPivot"))
                PhoneApplicationService.Current.State.Add("Stanzetta.CurrentPivot", iIndex.ToString());
            string s = PhoneApplicationService.Current.State["Stanzetta.AddLibraryFocus"] as string;
            ifocus = Convert.ToInt32(s);
        }

I hope this is useful to you...

Paul Mariotti

New Post: Problem with user controls

mrlacey — Mon, 14 Nov 2011 09:54:30 GMT

@pgmariotti can you share the XAML for the page?
What are you expecting to restore? Just the selected Pivot or anything else as well?
Are you specifying any type(s) when you call `SaveState`?

p.s. sorry for slow response. The notification of this only just got to me. :(

New Post: Problem with user controls

pgmariotti — Thu, 03 Nov 2011 13:52:13 GMT

I have a problem with a pivot page that includes several copies of a user control in its xaml (one on each element of the pivot). On return to the page TombstoneHelper terminates the App with an exception as follows: $exception {"Value does not fall within the expected range."} System.Exception {System.ArgumentException}.

If I remove the SaveState/RestoreStare from the page being navigated to, everything functuions properly.

Can you take a look please?

New Post: Any chance to support ListPicker?

mrlacey — Fri, 28 Oct 2011 09:19:24 GMT

Support for all Toolkit controls is coming soon. promise.
Hopefully next week.

New Post: Any chance to support ListPicker?

DevWheel — Thu, 27 Oct 2011 15:14:55 GMT

any plans on supporting the listpicker control from the toolkit?

New Comment on "Documentation"

mrlacey — Fri, 30 Sep 2011 17:36:01 GMT

@Pluginbaby - good spot. The base calls are acutally unnecessary as they don't actually do anything. Just a result of my Resharper generated code. The wrong method being called was a result of me not updating everything correctly. :(

Updated Wiki: Documentation

mrlacey — Fri, 30 Sep 2011 17:34:21 GMT

Installation
Usage
Adding support for other types
Gotchas

Installation

Download the library
Add a reference to it in your project

Or use NuGet: http://www.nuget.org/List/Packages/WP7TombstoneHelper

Usage

Simple usage

Include a reference to the namespace:

using TombstoneHelper;

In any pages that have something you may want to preserve during tombstoning, simply call SaveState(e) in the OnNavigatingFrom handler and RestoreState() in the OnNavigatedTo handler.
Note that I'm using OnNavingatingFrom method, rather than OnNavigatedFrom, as it allows us to detect the direction of navigation. This means we don't save state if we know we won't need it again. This can help improve the performance of the app.

    protected override void OnNavigatingFrom(System.Windows.Navigation.NavigatingCancelEventArgs e)
    {
        this.SaveState(e); 
    }

    protected override void OnNavigatedTo(System.Windows.Navigation.NavigationEventArgs e)
    {
        this.RestoreState();
    }

Ensure that every object you want to be preserved has a Name specified.
The code below is from "TextBoxes.xaml" in the demo project included with the source. It shows three textboxes, the middle of which won't have it's text automatically preserved during tombstoning.

    <TextBlock Text="first (has name)" />
    <TextBox Name="first" />
    <TextBlock Text="second (doesn't have name)" />
    <TextBox /><!--This TextBox does not have a name so it's contents won't be automatically saved and restored -->
    <TextBlock Text="third (has name)" />
    <TextBox Name="third" />

That's it!

Slightly more advanced usage

If you want to improve performance you can specify only the types of the controls which you want to be preserved when calling SaveState().
eg:

    this.SaveState(typeof(TextBox), typeof(PasswordBox), typeof(CheckBox));

    this.SaveState(typeof(ScrollViewer));

or in a more generic style

    this.SaveState<ScrollViewer>();

    this.SaveState<ListBox, TextBox>();

Not only does this improve performance but it makes it easy to integrate this functionality to save some properties (typically the scroll position of a ListBox or ScrolViewer) where there is already a view model which preserves the data state.

Adding support for other types

Add a new class to the project which implements ICanTombstone.
Add the necessary code to implement the functionality. N.B. The key used for saving the state of the object should be a string comprising the name of the type and the name of the object separated by a '^' character.
Add appropriate entries to AllTombstoneRestorers() and AllSupportedTombstoners() in "PhoneApplicationPageExtensions.cs".

If you are adding support for additional types then reviewing the exising implementations of ICanTombstone is highly recommended.

Gotchas

You may experience strange behaviour or unwanted side effects in the following situations

If you have an event that is triggered upon setting the property that automatically preserved. e.g. If it's a TextBox and you're handling the TextChanged event—it may have too account for it being triggered additional times.
If you are databinding the property which is has events or actions in response to setting it.
If you are generating the UI in code at runtime.
If you are also doing something with the State object yourself then do it after calling SaveState() as it will clear the contents of the state object to ensure it doen't have anything more than it needs in it.

If one of these scenarios does cause a problem then get in touch as there may be a workaround.

New Comment on "Documentation"

Pluginbaby — Fri, 30 Sep 2011 02:47:30 GMT

Awesome project! There is a mistake in the sample of this page: Replace: protected override void OnNavigatingFrom(System.Windows.Navigation.NavigatingCancelEventArgs e) { this.SaveState(e); base.OnNavigatedFrom(); } With: protected override void OnNavigatingFrom(System.Windows.Navigation.NavigatingCancelEventArgs e) { this.SaveState(e); base.OnNavigatingFrom(); }

WP7 Tombstone Helper

New Post: Any news on support for the Phone Toolkit 7.1 - LongListSelector?

Reviewed: v2.5 (יונ 15, 2012)

New Comment on "Documentation"

New Comment on "Documentation"

Updated Wiki: Home

Tombstoning support just got REALLY simple!

Yes. It's reallly that simple.

New Post: what does it store when calling SaveState?

New Post: what does it store when calling SaveState?

Updated Wiki: Home

Tombstoning support just got REALLY simple!

Yes. It's reallly that simple.

New Post: Panorama

New Post: Panorama

New Post: FAS not working

New Post: FAS not working

New Post: Problem with user controls

New Post: Problem with user controls

New Post: Problem with user controls

New Post: Any chance to support ListPicker?

New Post: Any chance to support ListPicker?

New Comment on "Documentation"

Updated Wiki: Documentation

Contents

Installation

Usage

Simple usage

Slightly more advanced usage

Adding support for other types

Gotchas

New Comment on "Documentation"