FrameworkElement.PredictFocus Method
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.
Assembly: PresentationFramework (in PresentationFramework.dll)
'Declaration Public Overrides NotOverridable Function PredictFocus ( _ direction As FocusNavigationDirection _ ) As DependencyObject 'Usage Dim instance As FrameworkElement Dim direction As FocusNavigationDirection Dim returnValue As DependencyObject returnValue = instance.PredictFocus(direction)
You cannot use methods in XAML.
Parameters
- direction
- Type: System.Windows.Input.FocusNavigationDirection
The direction for which a prospective focus change should be determined.
Return Value
Type: System.Windows.DependencyObjectThe next element that focus would move to if focus were actually traversed. May return Nothing 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). |
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.
private void OnPredictFocus(object sender, RoutedEventArgs e) { DependencyObject predictionElement = null; UIElement elementWithFocus = Keyboard.FocusedElement as UIElement; if (elementWithFocus != null) { // Only these four directions are currently supported // by PredictFocus, so we need to filter on these only. if ((_focusMoveValue == FocusNavigationDirection.Up) || (_focusMoveValue == FocusNavigationDirection.Down) || (_focusMoveValue == FocusNavigationDirection.Left) || (_focusMoveValue == FocusNavigationDirection.Right)) { // Get the element which would receive focus if focus were changed. predictionElement = elementWithFocus.PredictFocus(_focusMoveValue); Control controlElement = predictionElement as Control; // If a ContentElement. if (controlElement != null) { controlElement.Foreground = Brushes.DarkBlue; controlElement.FontSize += 10; controlElement.FontWeight = FontWeights.ExtraBold; // Fields used to reset the UI when the mouse // button is released. _focusPredicted = true; _predictedControl = controlElement; } } } }
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.