Window Class
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.
Represents an application window.
public ref class Window sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Window final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class Window
Public NotInheritable Class Window
- Inheritance
- Attributes
Device family |
Windows 10 (introduced in 10.0.10240.0)
|
API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
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
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.
Windows version | SDK version | Value added |
---|---|---|
1703 | 15063 | Compositor |
1903 | 18362 | UIContext |
IXamlSourceTransparency.IsBackgroundTransparent | Gets or sets a value that specifies whether the background of all DesktopWindowXamlSource objects on the current thread is transparent. |
Bounds |
Gets a Rect value that contains the origin, height, and width of the client area of the window, in device-independent pixels (DIPs). |
Compositor |
Gets the Compositor for this window. |
Content |
Gets or sets the visual root of an application window. |
Core |
Gets an internal core object for the application window. |
Current |
Gets the window of the current thread. |
Dispatcher |
Gets the CoreDispatcher object for the Window, which is generally the CoreDispatcher for the UI thread. |
UIContext |
Gets the context identifier for the window. |
Visible |
Gets a value that reports whether the window is visible. |
Activate() |
Attempts to activate the application window by bringing it to the foreground and setting the input focus to it. |
Close() |
Closes the application window. |
Set |
Makes a XAML element interact with the system as if it’s the title bar. |
Activated |
Occurs when the window has successfully been activated. |
Closed |
Occurs when the window has closed. |
Size |
Occurs when the app window has first rendered or has changed its rendering size. |
Visibility |
Occurs when the value of the Visible property changes. |
Product | Versions |
---|---|
WinRT | Build 10240, Build 10586, Build 14383, Build 15063, Build 16299, Build 17134, Build 17763, Build 18362, Build 19041, Build 20348, Build 22000, Build 22621, Build 26100 |