This topic has not yet been rated - Rate this topic

PageFunction(Of T).OnReturn Method

.NET Framework 4.5

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

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

'Declaration
Protected Overridable Sub OnReturn ( _
	e As ReturnEventArgs(Of T) _
)

Parameters

e: Type: System.Windows.Navigation.ReturnEventArgs(Of T)
A ReturnEventArgs(Of T) object that contains the PageFunction(Of T) return value (Result).

Remarks

OnReturn is called by a PageFunction(Of 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(Of T) has returned.
Retrieve the return value from the PageFunction(Of T).

Examples

The following example shows how to call OnReturn.

Private Sub doneButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    ' Complete the page function and return data of type T
    OnReturn(New ReturnEventArgs(Of String)(Me.pageFunctionData.Text))
End Sub

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Reference

PageFunction(Of T) Class

System.Windows.Navigation Namespace

Start

RemoveFromJournal

Other Resources

Structured Navigation Overview

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)