.NET Framework Class Library
FocusManager..::.GetFocusedElement Method

Gets the element with logical focus within the specified focus scope.

Namespace:  System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)
Syntax

Visual Basic (Declaration)
Public Shared Function GetFocusedElement ( _
    element As DependencyObject _
) As IInputElement
Visual Basic (Usage)
Dim element As DependencyObject
Dim returnValue As IInputElement

returnValue = FocusManager.GetFocusedElement(element)
C#
public static IInputElement GetFocusedElement(
    DependencyObject element
)
Visual C++
public:
static IInputElement^ GetFocusedElement(
    DependencyObject^ element
)
JScript
public static function GetFocusedElement(
    element : DependencyObject
) : IInputElement
XAML
You cannot use methods in XAML.

Parameters

element
Type: System.Windows..::.DependencyObject
The element with logical focus in the specified focus scope.

Return Value

Type: System.Windows..::.IInputElement
The element in the specified focus scope with logical focus.
Exceptions

ExceptionCondition
ArgumentNullException

element is nullNothingnullptra null reference (Nothing in Visual Basic).

Remarks

The FocusedElement is the element which has logical focus for a specific focus scope. This object may or may not have keyboard focus. Keyboard focus refers to the element that receives keyboard input. For more information on focus, keyboard focus, and logical focus, see the Input Overview.

If element is not a focus scope, this method will return nullNothingnullptra null reference (Nothing in Visual Basic).

Use SetFocusedElement, to specify the element with logical focus within a specified focus scope.

Examples

The following example sets the element with logical focus by using the SetFocusedElement and it gets the element with logical focus by using the GetFocusedElement.

C#
// Sets the focused element in focusScope1
// focusScope1 is a StackPanel.
FocusManager.SetFocusedElement(focusScope1, button2);

// Gets the focused element for focusScope 1
IInputElement focusedElement = FocusManager.GetFocusedElement(focusScope1);
Platforms

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.
Version Information

.NET Framework

Supported in: 3.5, 3.0
See Also

Reference

Other Resources

Tags :


Page view tracker