Share via

LeavingBackgroundEventArgs Class

  • Reference

Definition

Namespace:
Windows.ApplicationModel
Edit

Gets the deferral object when the app is leaving the background state.

public ref class LeavingBackgroundEventArgs sealed : ILeavingBackgroundEventArgs
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class LeavingBackgroundEventArgs final : ILeavingBackgroundEventArgs
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class LeavingBackgroundEventArgs : ILeavingBackgroundEventArgs
Public NotInheritable Class LeavingBackgroundEventArgs
Implements ILeavingBackgroundEventArgs
Inheritance
Object Platform::Object IInspectable LeavingBackgroundEventArgs
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute
Implements
ILeavingBackgroundEventArgs

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Remarks

This object is passed to the app's leaving background event handler.

Tip

This event is raised before any UI is shown and is a good place to ensure that any assets that you load programmatically are ready so that the UI will be presented correctly.

Methods

GetDeferral()

Gets the deferral object which delays the transition from running in the background to running in the foreground until the app calls Deferral.Complete or the deadline for navigation has passed.

Applies to

See also