This documentation is archived and is not being maintained.

PageFunction<T>.OnReturn Method

A PageFunction<T> calls OnReturn to return to the caller, passing a return value via a ReturnEventArgs<T> object

Namespace:  System.Windows.Navigation
Assembly:  PresentationFramework (in PresentationFramework.dll)

protected virtual void OnReturn(
	ReturnEventArgs<T> e
You cannot use methods in XAML.


Type: System.Windows.Navigation.ReturnEventArgs<T>


ReturnEventArgs<T> object that contains the PageFunction<T> return value (Result).

OnReturn is called by a PageFunction<T> to initiate a navigation to the calling page.

This causes the Return event to be raised, in order for the calling page to:

The following example shows how to call OnReturn.

void doneButton_Click(object sender, RoutedEventArgs e)
    // Complete the page function and return data of type T
    OnReturn(new ReturnEventArgs<String>(this.pageFunctionData.Text));

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0