Friday, 7 July 2017

Navigation 02 Back

In our previous post we talked about navigating from our MainPage to a SecondPage with a parameter, which was really straight forward, but now that we are on our second page how do we get back to our main page. In a browser we'd hit the back button, well let's implement that same paradigm in our application.

let's add a back button to our second page.

<Page
    x:Class="pc.NavigateExample.SecondPage"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
    <Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
        <StackPanel HorizontalAlignment="Center" VerticalAlignment="Center">
            <TextBlock>Second Page</TextBlock>
            <TextBox x:Name="output_TextBox" PlaceholderText="Parameter received" />
            <Button x:Name="Back_Button" Click="Back_Button_Click">Back</Button>
        </StackPanel>
    </Grid>
</Page>


we've added it as content to our page for now.

using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Navigation;

namespace pc.NavigateExample
{
    public sealed partial class SecondPage : Page
    {
        public SecondPage() { this.InitializeComponent(); }

        protected override void OnNavigatedTo(NavigationEventArgs e) {
            var parameter = e.Parameter as string;

            if (parameter != null)
                output_TextBox.Text = parameter;
        }

        private void Back_Button_Click(object sender, Windows.UI.Xaml.RoutedEventArgs e)
        {
            if(Frame.CanGoBack)
                Frame.GoBack();
        }
    }
}

Now our base "Page" object has a Frame property that can be used for navigation, so let's leverage it to go back to our main page. This however is a very rudimentary implementation of back navigation, there's all sorts of complexities that we haven't even broached, like for example "Windows key" + Backspace shortcut for navigating back. Luckily there is the SystemNavigationManager class to make our lives easier.

using Windows.UI.Core;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Navigation;

namespace pc.NavigateExample
{
    public sealed partial class SecondPage : Page
    {
        public SecondPage() {
            this.InitializeComponent();
            SystemNavigationManager.GetForCurrentView().BackRequested +=
                SecondPage_BackRequested;
        }

        protected override void OnNavigatedTo(NavigationEventArgs e) {
            var parameter = e.Parameter as string;

            if (parameter != null)
                output_TextBox.Text = parameter;
        }

        protected override void OnNavigatedFrom(NavigationEventArgs e)
        {
            base.OnNavigatedFrom(e);
            SystemNavigationManager.GetForCurrentView().BackRequested -=
                SecondPage_BackRequested;
        }

        private void SecondPage_BackRequested(object sender, BackRequestedEventArgs e){
          if(!e.Handled && Frame.CanGoBack)
            Frame.GoBack();
        }

        private void Back_Button_Click(object sender, RoutedEventArgs e)
        {
            if (Frame.CanGoBack)
                Frame.GoBack();
        }
    }
}


now in our constructor we provide an event handler for our Back Requested event and since we subscribed to our event we unsubscribe from it when we navigate away from our page. In our SecondPage_BackRequested event handler we merely check if we can go back and we then go back, the difference is that this will handle:

  • "Windows Key" + Backspace
  • Hardware back button
  • Keyboard back button
  • mouse back button