LineDisplayWindow Class

Definition

Namespace:

Windows.Devices.PointOfService

Represents a line display window.

public ref class LineDisplayWindow sealed : IClosable

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class LineDisplayWindow final : IClosable

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class LineDisplayWindow : System.IDisposable

Public NotInheritable Class LineDisplayWindow
Implements IDisposable

Inheritance

Object Platform::Object IInspectable LineDisplayWindow

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute

Implements

IClosable IDisposable

Windows requirements

Device family	Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v4.0)

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	Gets the cursor of the line display window.
InterCharacterWaitInterval	Gets or sets the delay interval between displaying successive characters.
Marquee	Gets the line display marquee.
SizeInCharacters	Gets dimensions of the window, in number of character lines (rows and columns).

Methods

Close()	Closes the line display window resource, destroying the window on the device.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
ReadCharacterAtCursorAsync()	Attempts to asynchronously read the currently displayed character at the current cursor position.
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)	Attempts to asynchronously display a bitmap from a storage file at the current cursor position.
TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment)	Attempts to asynchronously display a bitmap from a storage file at the current cursor position.
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)	Attempts to asynchronously display a bitmap from a storage file at a particular point.
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)	Attempts to asynchronously display a stored bitmap from at LineDisplayStoredBitmap object at the current cursor position.
TryDisplayTextAsync(String)	Try to display the specified text in the line display window.
TryDisplayTextAsync(String, LineDisplayTextAttribute)	Try to display the specified text in the line display window, using the specified display attribute.
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()	Refresh the line display window.
TryScrollTextAsync(LineDisplayScrollDirection, UInt32)	Scroll the window text contents the specified number of lines in the specified direction.