PageFunction.OnReturn Method

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

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

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




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

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

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

  • Detect when the PageFunction has returned.

  • Retrieve the return value from the PageFunction.

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 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions