Window Window Window Window Class

Definition

Represents an application window.

public : sealed class Window : IWindow, IWindow2, IWindow3
struct winrt::Windows::UI::Xaml::Window : IWindow, IWindow2, IWindow3
public sealed class Window : IWindow, IWindow2, IWindow3
Public NotInheritable Class Window Implements IWindow, IWindow2, IWindow3
Attributes

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

The following code example shows the OnLaunched method override generated for the blank application template in Microsoft Visual Studio. This code demonstrates typical usage patterns for the Current and Content properties and the Activate method.

protected override void OnLaunched(LaunchActivatedEventArgs args)
{
    // Create a Frame to act navigation context and navigate to the first page
    var rootFrame = new Frame();
    rootFrame.Navigate(typeof(BlankPage));

    // Place the frame in the current Window and ensure that it is active
    Window.Current.Content = rootFrame;
    Window.Current.Activate();
}
Protected Overrides Sub OnLaunched(args As 
    Windows.ApplicationModel.Activation.LaunchActivatedEventArgs)

    ' Create a Frame to act navigation context and navigate to the first page
    Dim rootFrame As New Frame()
    rootFrame.Navigate(GetType(BlankPage))

    ' Place the frame in the current Window and ensure that it is active
    Window.Current.Content = rootFrame
    Window.Current.Activate()
End Sub

Remarks

This class represents the window of the current Application. In the same manner as the static Application property, the static Current property will return the app window object. From this object, an app can utilize the Dispatcher or determine the size of the Window from the Bounds property. The most common usage for Window is setting a UIElement to the Content that represents the app UI. This is usually done as part of app activation (for example in the OnLaunched override.) You can change this window content throughout the lifetime of the window.

There is no XAML representation of the Window class because it is not a control.

A Window object is just surfacing information from CoreWindow, which in turn is referencing the window created by the system.

Make sure to call Activate on any Window you use on initial activation. If you use the default app templates from Microsoft Visual Studio, calling Window.Activate is part of the initial code in the app.xaml code-behind file.

The LayoutAwarePage class that is part of some application templates in Microsoft Visual Studio has handling for the SizeChanged event, which is used for keeping track of visual states that match values of ApplicationViewState. LayoutAwarePage also has code that checks Bounds and uses this value to influence how page-wide input events are handled.

Properties

Bounds Bounds Bounds Bounds

Gets a Rect value containing the height and width of the application window in units of effective (view) pixels.

Compositor Compositor Compositor Compositor

Gets the Compositor for this window.

Content Content Content Content

Gets or sets the visual root of an application window.

CoreWindow CoreWindow CoreWindow CoreWindow

Gets an internal core object for the application window.

Current Current Current Current

Gets the currently activated window for an application.

Dispatcher Dispatcher Dispatcher Dispatcher

Gets the CoreDispatcher object for the Window, which is generally the CoreDispatcher for the UI thread.

Visible Visible Visible Visible

Gets a value that reports whether the window is visible.

Methods

Activate() Activate() Activate() Activate()

Attempts to activate the application window by bringing it to the foreground and setting the input focus to it.

Close() Close() Close() Close()

Closes the application window.

SetTitleBar(UIElement) SetTitleBar(UIElement) SetTitleBar(UIElement) SetTitleBar(UIElement)

Makes a XAML element interact with the system as if it’s the title bar.

Events

Activated Activated Activated Activated

Occurs when the window has successfully been activated.

Closed Closed Closed Closed

Occurs when the window has closed.

SizeChanged SizeChanged SizeChanged SizeChanged

Occurs when the app window has first rendered or has changed its rendering size.

VisibilityChanged VisibilityChanged VisibilityChanged VisibilityChanged

Occurs when the value of the Visible property changes.

See also