LineDisplayWindow LineDisplayWindow LineDisplayWindow LineDisplayWindow Class

Definition

Some information relates to pre-released product which may be substantially modified before it’s commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Prerelease APIs are identified by a Prerelease label.

[Contains prerelease APIs.]
Represents a line display window.

public : sealed class LineDisplayWindow : ILineDisplayWindow, IClosablepublic sealed class LineDisplayWindow : ILineDisplayWindow, IDisposablePublic NotInheritable Class LineDisplayWindow Implements ILineDisplayWindow, IDisposable// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Properties

Cursor Cursor Cursor Cursor

Prerelease. Gets the cursor of the line display window.

public : LineDisplayCursor Cursor { get; }public LineDisplayCursor Cursor { get; }Public ReadOnly Property Cursor As LineDisplayCursor// You can use this property in JavaScript.
Value
LineDisplayCursor LineDisplayCursor LineDisplayCursor LineDisplayCursor

The cursor of the line display window.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

InterCharacterWaitInterval InterCharacterWaitInterval InterCharacterWaitInterval InterCharacterWaitInterval

Gets or sets the delay interval between displaying successive characters.

public : TimeSpan InterCharacterWaitInterval { get; set; }public TimeSpan InterCharacterWaitInterval { get; set; }Public ReadWrite Property InterCharacterWaitInterval As TimeSpan// You can use this property in JavaScript.
Value
TimeSpan TimeSpan TimeSpan TimeSpan

The delay interval between displaying successive characters. The default value of this property is 0.

Marquee Marquee Marquee Marquee

Prerelease. Gets the line display marquee.

public : LineDisplayMarquee Marquee { get; }public LineDisplayMarquee Marquee { get; }Public ReadOnly Property Marquee As LineDisplayMarquee// You can use this property in JavaScript.
Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

SizeInCharacters SizeInCharacters SizeInCharacters SizeInCharacters

Gets dimensions of the window, in number of character lines (rows and columns).

public : Size SizeInCharacters { get; }public Size SizeInCharacters { get; }Public ReadOnly Property SizeInCharacters As Size// You can use this property in JavaScript.
Value
Size Size Size Size

The number of character lines (rows and columns).

Methods

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

Closes the line display window resource, destroying the window on the device.

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

Remarks

Closing a window does not remove any content that it is displaying on the device. Use LineDisplay.TryClearTextAsync() to clear window contents before destroying it.

Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()

ReadCharacterAtCursorAsync() ReadCharacterAtCursorAsync() ReadCharacterAtCursorAsync() ReadCharacterAtCursorAsync()

Prerelease. Attempts to asynchronously read the currently displayed character at the current cursor position.

public : IAsyncOperation<unsigned int> ReadCharacterAtCursorAsync()public IAsyncOperation<uint> ReadCharacterAtCursorAsync()Public Function ReadCharacterAtCursorAsync() As IAsyncOperation( Of uint )// You can use this method in JavaScript.
Returns

Returns the code for the character at the current cursor position. Returns 0 if the method fails.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

This method requires LineDisplayCapabilities.CanReadCharacterAtCursor to be True to be succesfully executed.

TryClearTextAsync() TryClearTextAsync() TryClearTextAsync() TryClearTextAsync()

Clears the current window. Changers all characters to blanks, clears any bitmaps displayed in the window, and sets Cursor.Position to {0,0}.

public : IAsyncOperation<PlatForm::Boolean> TryClearTextAsync()public IAsyncOperation<bool> TryClearTextAsync()Public Function TryClearTextAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns

True if the window was successfully cleared; otherwise, false.

TryDisplayStorageFileBitmapAtCursorAsync(StorageFile) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile)

Prerelease. Attempts to asynchronously display a bitmap from a storage file at the current cursor position.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap)public IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap)Public Function TryDisplayStorageFileBitmapAtCursorAsync(bitmap As StorageFile) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
bitmap
StorageFile StorageFile StorageFile StorageFile

The bitmap to be displayed.

Returns

Return True if the bitmap was successfully displayed; otherwise, False.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.

TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment)

Prerelease. Attempts to asynchronously display a bitmap from a storage file at the current cursor position.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment)public IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment)Public Function TryDisplayStorageFileBitmapAtCursorAsync(bitmap As StorageFile, horizontalAlignment As LineDisplayHorizontalAlignment, verticalAlignment As LineDisplayVerticalAlignment) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
bitmap
StorageFile StorageFile StorageFile StorageFile

The bitmap to be displayed.

horizontalAlignment
LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment

The horizontal alignment of the bitmap relative to the current text character position.

verticalAlignment
LineDisplayVerticalAlignment LineDisplayVerticalAlignment LineDisplayVerticalAlignment LineDisplayVerticalAlignment

The vertical alignment of the bitmap relative to the current text character position.

Returns

Return True if the bitmap was successfully displayed; otherwise, False.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.

TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32)

Prerelease. Attempts to asynchronously display a bitmap from a storage file at the current cursor position, at a particular width.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment, int widthInPixels)public IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment, Int32 widthInPixels)Public Function TryDisplayStorageFileBitmapAtCursorAsync(bitmap As StorageFile, horizontalAlignment As LineDisplayHorizontalAlignment, verticalAlignment As LineDisplayVerticalAlignment, widthInPixels As Int32) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
bitmap
StorageFile StorageFile StorageFile StorageFile

The bitmap to be displayed.

horizontalAlignment
LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment

The horizontal alignment of the bitmap relative to the current text character position.

verticalAlignment
LineDisplayVerticalAlignment LineDisplayVerticalAlignment LineDisplayVerticalAlignment LineDisplayVerticalAlignment

The vertical alignment of the bitmap relative to the current text character position.

widthInPixels
int Int32 Int32 Int32

The desired width of the bitmap. A value of 0 pixels will display the bitmap at one pixel per screen dot (unscaled).

Returns

Return True if the bitmap was successfully displayed; otherwise, False.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.

If the provided widthInPixels value is larger than ClaimedLineDisplay.MaxBitmapSizeInPixels, this method will fail.

TryDisplayStorageFileBitmapAtPointAsync(StorageFile, Point) TryDisplayStorageFileBitmapAtPointAsync(StorageFile, Point) TryDisplayStorageFileBitmapAtPointAsync(StorageFile, Point) TryDisplayStorageFileBitmapAtPointAsync(StorageFile, Point)

Prerelease. Attempts to asynchronously display a bitmap from a storage file at a particular point.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayStorageFileBitmapAtPointAsync(StorageFile bitmap, Point offsetInPixels)public IAsyncOperation<bool> TryDisplayStorageFileBitmapAtPointAsync(StorageFile bitmap, Point offsetInPixels)Public Function TryDisplayStorageFileBitmapAtPointAsync(bitmap As StorageFile, offsetInPixels As Point) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
bitmap
StorageFile StorageFile StorageFile StorageFile

The bitmap to be displayed.

offsetInPixels
Point Point Point Point

The number of pixels to offset the bitmap display from the top-left corner of the screen, {0,0}.

Returns

Return True if the bitmap was successfully displayed; otherwise, False.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.

TryDisplayStorageFileBitmapAtPointAsync(StorageFile, Point, Int32) TryDisplayStorageFileBitmapAtPointAsync(StorageFile, Point, Int32) TryDisplayStorageFileBitmapAtPointAsync(StorageFile, Point, Int32) TryDisplayStorageFileBitmapAtPointAsync(StorageFile, Point, Int32)

Prerelease. Attempts to asynchronously display a bitmap from a storage file at a particular point, scaled to a particular width.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayStorageFileBitmapAtPointAsync(StorageFile bitmap, Point offsetInPixels, int widthInPixels)public IAsyncOperation<bool> TryDisplayStorageFileBitmapAtPointAsync(StorageFile bitmap, Point offsetInPixels, Int32 widthInPixels)Public Function TryDisplayStorageFileBitmapAtPointAsync(bitmap As StorageFile, offsetInPixels As Point, widthInPixels As Int32) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
bitmap
StorageFile StorageFile StorageFile StorageFile

The bitmap to be displayed.

offsetInPixels
Point Point Point Point

The number of pixels to offset the bitmap display from the top-left corner of the screen, {0,0}.

widthInPixels
int Int32 Int32 Int32

The desired width of the bitmap. A value of 0 pixels will display the bitmap at one pixel per screen dot (unscaled).

Returns

Return True if the bitmap was successfully displayed; otherwise, False.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.

If the provided widthInPixels value is larger than ClaimedLineDisplay.MaxBitmapSizeInPixels, this method will fail.

TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap) TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap) TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap) TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap)

Prerelease. Attempts to asynchronously display a stored bitmap from at LineDisplayStoredBitmap object at the current cursor position.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap bitmap)public IAsyncOperation<bool> TryDisplayStoredBitmapAtCursorAsync(LineDisplayStoredBitmap bitmap)Public Function TryDisplayStoredBitmapAtCursorAsync(bitmap As LineDisplayStoredBitmap) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
Returns

Returns True if the bitmap was successfully displayed; otherwise, False.

Additional features and requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.

TryDisplayTextAsync(String) TryDisplayTextAsync(String) TryDisplayTextAsync(String) TryDisplayTextAsync(String)

Try to display the specified text in the line display window.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayTextAsync(PlatForm::String text)public IAsyncOperation<bool> TryDisplayTextAsync(String text)Public Function TryDisplayTextAsync(text As String) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
text
PlatForm::String String String String

The text to be displayed.

Returns

True if the text was displayed successfully; otherwise, false.

TryDisplayTextAsync(String, LineDisplayTextAttribute) TryDisplayTextAsync(String, LineDisplayTextAttribute) TryDisplayTextAsync(String, LineDisplayTextAttribute) TryDisplayTextAsync(String, LineDisplayTextAttribute)

Try to display the specified text in the line display window, using the specified display attribute.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayTextAsync(PlatForm::String text, LineDisplayTextAttribute displayAttribute)public IAsyncOperation<bool> TryDisplayTextAsync(String text, LineDisplayTextAttribute displayAttribute)Public Function TryDisplayTextAsync(text As String, displayAttribute As LineDisplayTextAttribute) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
text
PlatForm::String String String String

The text to be displayed.

displayAttribute
LineDisplayTextAttribute LineDisplayTextAttribute LineDisplayTextAttribute LineDisplayTextAttribute

The display attribute to be applied to the window.

Returns

True if the text was displayed successfully; otherwise, false.

TryDisplayTextAsync(String, LineDisplayTextAttribute, Point) TryDisplayTextAsync(String, LineDisplayTextAttribute, Point) TryDisplayTextAsync(String, LineDisplayTextAttribute, Point) TryDisplayTextAsync(String, LineDisplayTextAttribute, Point)

Try to display the specified text at a specified position in the line display window, using the specified display attribute.

public : IAsyncOperation<PlatForm::Boolean> TryDisplayTextAsync(PlatForm::String text, LineDisplayTextAttribute displayAttribute, Point startPosition)public IAsyncOperation<bool> TryDisplayTextAsync(String text, LineDisplayTextAttribute displayAttribute, Point startPosition)Public Function TryDisplayTextAsync(text As String, displayAttribute As LineDisplayTextAttribute, startPosition As Point) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
text
PlatForm::String String String String

The text to be displayed.

displayAttribute
LineDisplayTextAttribute LineDisplayTextAttribute LineDisplayTextAttribute LineDisplayTextAttribute

The display attribute to be applied to the window.

startPosition
Point Point Point Point

The row and column at which to start displaying the text.

Returns

True if the text was displayed successfully; otherwise, false.

TryRefreshAsync() TryRefreshAsync() TryRefreshAsync() TryRefreshAsync()

Refresh the line display window.

public : IAsyncOperation<PlatForm::Boolean> TryRefreshAsync()public IAsyncOperation<bool> TryRefreshAsync()Public Function TryRefreshAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns

True if the window was successfully refreshed; otherwise, false.

TryScrollTextAsync(LineDisplayScrollDirection, UInt32) TryScrollTextAsync(LineDisplayScrollDirection, UInt32) TryScrollTextAsync(LineDisplayScrollDirection, UInt32) TryScrollTextAsync(LineDisplayScrollDirection, UInt32)

Scroll the window text contents the specified number of lines in the specified direction.

public : IAsyncOperation<PlatForm::Boolean> TryScrollTextAsync(LineDisplayScrollDirection direction, unsigned int numberOfColumnsOrRows)public IAsyncOperation<bool> TryScrollTextAsync(LineDisplayScrollDirection direction, UInt32 numberOfColumnsOrRows)Public Function TryScrollTextAsync(direction As LineDisplayScrollDirection, numberOfColumnsOrRows As UInt32) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Parameters
numberOfColumnsOrRows
unsigned int UInt32 UInt32 UInt32

The number of columns or rows to scroll. Columns are used if the scroll direction is left or right; rows are used if the scroll direction is up or down.

Returns