PageFunction<T>.OnReturn(ReturnEventArgs<T>) Method

Definition

Namespace:

System.Windows.Navigation

Assembly:

PresentationFramework.dll

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

C#

protected virtual void OnReturn(System.Windows.Navigation.ReturnEventArgs<T> e);

Parameters

e

ReturnEventArgs<T>

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

Examples

The following example shows how to call OnReturn.

C#

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

Remarks

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:

• Detect when the PageFunction<T> has returned.

• Retrieve the return value from the PageFunction<T>.

Applies to

See also

• Start()
• RemoveFromJournal