ClaimedLineDisplay.TryCreateWindowAsync(Rect, Size) Method

Definition

Attempts to asynchronously create a LineDisplayWindow.

public:
 virtual IAsyncOperation<LineDisplayWindow ^> ^ TryCreateWindowAsync(Rect viewport, Size windowSize) = TryCreateWindowAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<LineDisplayWindow> TryCreateWindowAsync(Rect viewport, Size windowSize);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<LineDisplayWindow> TryCreateWindowAsync(Rect viewport, Size windowSize);
function tryCreateWindowAsync(viewport, windowSize)
Public Function TryCreateWindowAsync (viewport As Rect, windowSize As Size) As IAsyncOperation(Of LineDisplayWindow)

Parameters

viewport
Rect

The viewport’s origin device row, origin device column, width in rows and height in columns.

windowSize
Size

The numbers of rows and the number of columns in the window.

Returns

IAsyncOperation<LineDisplayWindow>

A new LineDisplayWindow object, representing a new window for the device.

Attributes

Windows 10 requirements

Device family
Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

When LineDisplayCapabiliaties.SupportedWindows is greater than 0 this method can be called to create a new LineDisplayWindow object representing a new window for the device. The new window is not automatically set as the current window when it is created, to set that window as current set the LineDisplayAttributes.CurrentWindow property to point to this LineDisplayWindow object, or on that same LineDisplayWindow object call its TryRefreshAsync method.

Calling this method when LineDisplayCapabiliaties.SupportedWindows is 0 will result in an exception.

The window size must be at least as large as the viewport size, and it may be larger than its viewport in at most one direction. When LineDisplayCapabilities.IsVerticalMarqueeSupported is True, the window may be larger than the viewport in the vertical dimension. When LineDisplayCapabilities.IsHorizontalMarqueeSupported is True, the window may be larger than the viewport in the horizontal dimension.

Applies to