FocusManager.GetFocusedElement(DependencyObject) Method

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: PresentationCore.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.

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

public:
 static System::Windows::IInputElement ^ GetFocusedElement(System::Windows::DependencyObject ^ element);

public static System.Windows.IInputElement GetFocusedElement (System.Windows.DependencyObject element);

static member GetFocusedElement : System.Windows.DependencyObject -> System.Windows.IInputElement

Public Shared Function GetFocusedElement (element As DependencyObject) As IInputElement

Parameters

element: DependencyObject

An element that is a focus scope.

Returns

IInputElement

The element in the specified focus scope with logical focus.

Exceptions

ArgumentNullException

element is null.

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.

// 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);

' Sets the focused element in focusScope1
' focusScope1 is a StackPanel.
FocusManager.SetFocusedElement(focusScope1, button2)

' Gets the focused element for focusScope 1
Dim focusedElement As IInputElement = FocusManager.GetFocusedElement(focusScope1)

Remarks

The FocusedElement is the element that has logical focus for a specific focus scope. An element that is a focus scope has IsFocusScope set to true. 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 null.

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

Applies to