TraversalRequest Class

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: WindowsBase.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a request to move focus to another control.

public ref class TraversalRequest

[System.Serializable]
public class TraversalRequest

public class TraversalRequest

[<System.Serializable>]
type TraversalRequest = class

type TraversalRequest = class

Public Class TraversalRequest

Inheritance: Object
TraversalRequest

Attributes: SerializableAttribute

Examples

The following example creates a TraversalRequest instance as input for a FrameworkElement.MoveFocus call.

// Creating a FocusNavigationDirection object and setting it to a
// local field that contains the direction selected.
FocusNavigationDirection focusDirection = _focusMoveValue;

// MoveFocus takes a TraveralReqest as its argument.
TraversalRequest request = new TraversalRequest(focusDirection);

// Gets the element with keyboard focus.
UIElement elementWithFocus = Keyboard.FocusedElement as UIElement;

// Change keyboard focus.
if (elementWithFocus != null)
{
    elementWithFocus.MoveFocus(request);
}

' Creating a FocusNavigationDirection object and setting it to a
' local field that contains the direction selected.
Dim focusDirection As FocusNavigationDirection = _focusMoveValue

' MoveFocus takes a TraveralReqest as its argument.
Dim request As New TraversalRequest(focusDirection)

' Gets the element with keyboard focus.
Dim elementWithFocus As UIElement = TryCast(Keyboard.FocusedElement, UIElement)

' Change keyboard focus.
If elementWithFocus IsNot Nothing Then
    elementWithFocus.MoveFocus(request)
End If

Remarks

This class is used as an input parameter for the UIElement.MoveFocus method. The MoveFocus method has a WPF framework-level override that provides a more practical implementation (FrameworkElement.MoveFocus), as well as a parallel implementation on ContentElement and FrameworkContentElement. You typically will set properties on TraversalRequest in order to customize the focusing behavior when you request that the focus be moved to another element.

This class is also used as input parameters for the following methods:

TabInto, and implementations of that method that are used for interoperation (TabInto).
OnNoMoreTabStops.

Constructors

TraversalRequest(FocusNavigationDirection)

Initializes a new instance of the TraversalRequest class.

Properties

FocusNavigationDirection	Gets the traversal direction.
Wrapped	Gets or sets a value that indicates whether focus traversal has reached the end of child elements that can have focus.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to