PredictFocus Method

FrameworkElement::PredictFocus Method (FocusNavigationDirection)

 

Determines the next element that would receive focus relative to this element for a provided focus movement direction, but does not actually move the focus.

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

public:
virtual DependencyObject^ PredictFocus(
	FocusNavigationDirection direction
) override sealed

Parameters

direction
Type: System.Windows.Input::FocusNavigationDirection

The direction for which a prospective focus change should be determined.

Return Value

Type: System.Windows::DependencyObject^

The next element that focus would move to if focus were actually traversed. May return null if focus cannot be moved relative to this element for the provided direction.

Exception Condition
InvalidEnumArgumentException

Specified one of the following directions in the TraversalRequest: Next, Previous, First, Last. These directions are not legal for PredictFocus (but they are legal for MoveFocus).

MoveFocus is the related method that actually does move focus.

The following example implements a handler that handles several possible button inputs, each button representing a possible FocusNavigationDirection. The handler tracks the element with current keyboard focus, and calls PredictFocus on that element, and specifies the appropriate FocusNavigationDirection as initialization for the TraversalRequest type parameter provided. Instead of moving to that element as MoveFocus would do, the handler changes the physical dimensions of the predicted focus destination for visualization purposes.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top
Show:
© 2016 Microsoft