LineDisplayWindow LineDisplayWindow LineDisplayWindow LineDisplayWindow LineDisplayWindow Class

Definition

Represents a line display window.

public : sealed class LineDisplayWindow : IClosable
struct winrt::Windows::Devices::PointOfService::LineDisplayWindow : IClosable
public sealed class LineDisplayWindow : IDisposable
Public NotInheritable Class LineDisplayWindow Implements IDisposable
// This class does not provide a public constructor.
Attributes

Windows 10 requirements

Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Remarks

Version history

Windows version SDK version Value added
1709 16299 Cursor
1709 16299 Marquee
1709 16299 ReadCharacterAtCursorAsync
1709 16299 TryDisplayStorageFileBitmapAtCursorAsync(StorageFile)
1709 16299 TryDisplayStorageFileBitmapAtCursorAsync(StorageFile,LineDisplayHorizontalAlignment,LineDisplayVerticalAlignment)
1709 16299 TryDisplayStorageFileBitmapAtCursorAsync(StorageFile,LineDisplayHorizontalAlignment,LineDisplayVerticalAlignment,Int32)
1709 16299 TryDisplayStorageFileBitmapAtPointAsync(StorageFile,Point)
1709 16299 TryDisplayStorageFileBitmapAtPointAsync(StorageFile,Point,Int32)
1709 16299 TryDisplayStoredBitmapAtCursorAsync

Properties

Cursor Cursor Cursor Cursor Cursor

Gets the cursor of the line display window.

InterCharacterWaitInterval InterCharacterWaitInterval InterCharacterWaitInterval InterCharacterWaitInterval InterCharacterWaitInterval

Gets or sets the delay interval between displaying successive characters.

Marquee Marquee Marquee Marquee Marquee

Gets the line display marquee.

SizeInCharacters SizeInCharacters SizeInCharacters SizeInCharacters SizeInCharacters

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

Methods

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

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

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

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

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

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

TryClearTextAsync() 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}.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

TryDisplayTextAsync(String, LineDisplayTextAttribute) 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.

TryDisplayTextAsync(String, LineDisplayTextAttribute, Point) 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.

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

Refresh the line display window.

TryScrollTextAsync(LineDisplayScrollDirection, UInt32) 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.