GettingFocusEventArgs.CorrelationId Property
Definition
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 unique ID generated when a focus movement event is initiated.
public:
property Platform::Guid CorrelationId { Platform::Guid get(); };winrt::guid CorrelationId();public Guid CorrelationId { get; }var guid = gettingFocusEventArgs.correlationId;Public ReadOnly Property CorrelationId As GuidProperty Value
The unique ID, if any. Otherwise, null.
The default is null.
Windows requirements
| Device family |
Windows 10, version 1809 (introduced in 10.0.17763.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v7.0)
|
Remarks
Focus moves can result in a number of direct and indirect actions.
For example, there is the standard sequence of events that starts with LosingFocus and moves through LostFocus, GettingFocus, to GotFocus. These focus events typically get routed through multiple elements in the element tree (including the FocusManager).
In some cases, the focus event can also get re-routed. For example, if the target element is not valid for some reason, you might call TrySetNewFocusedElement from the LosingFocus event to re-target focus to another element.
In other cases, you might need to cancel a focus change from one of your focus event handlers.
In addition, because focus events are raised asynchronously, focus might change again before a previous focus event has finished executing.
Each time a focus event is initiated, a unique CorrelationId is generated to help you track a focus event throughout these focus actions.
A new CorrelationId is generated when:
- The user moves focus.
- The app moves focus using methods such as Control.Focus or FocusManager.TryFocusAsync.
- The app gets/loses focus due to window activation (see CoreWindow.Activated).