LineDisplayAttributes LineDisplayAttributes LineDisplayAttributes LineDisplayAttributes 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 the attributes of a line display device.

public : sealed class LineDisplayAttributes : ILineDisplayAttributespublic sealed class LineDisplayAttributes : ILineDisplayAttributesPublic NotInheritable Class LineDisplayAttributes Implements ILineDisplayAttributes// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 Insider Preview (introduced v10.0.16257.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v5)

Properties

BlinkRate BlinkRate BlinkRate BlinkRate

Prerelease. Gets or sets the blink rate of the line display.

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

The blink rate in milliseconds.

Remarks

When the device supports blinking (LineDisplayCapabilities.CanBlink is not NotSupported) this writeable property configures the current blink cycle time. A blink cycle is the period of time when text completes an on-off-on cycle during blinking. After this property is set, the device driver (the Service Object) typically sets the blink rate to the closest supported rate.

When the device does not support blinking (LineDisplayCapabilities.CanBlink is NotSupported) this property is fixed to a value of 0 and cannot be changed.

The default value of this property is 0.

Changes to this property are committed to the device on the next call of ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes).

Brightness Brightness Brightness Brightness

Prerelease. Gets or sets the brightness of the line display.

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

The brightness of the line display.

Remarks

When the device supports brightness adjustment (LineDisplayCapabilities.IsBrightnessSupported is True) this writeable property configures the current screen brightness, in percent (valid values are positive integers from 0 to 100, inclusive). All devices support 100% (maximum brightness) and 0% (blank screen). Some devices also support dimming values in between these limits. In all cases the device driver (the Service Object) maps the requested brightness value to the closest value supported by the Hardware device.

The default value of this property is 100.

Changes to this property are committed to the device on the next call to ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes).

CharacterSet CharacterSet CharacterSet CharacterSet

Prerelease. Gets or sets the current character set used by the device to display characters.

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

The current character set.

Remarks

Valid values for this property are the values stored in ClaimedLineDisplay.SupportedCharacterSets.

Changes to this property are committed to the device on the next call to ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes).

CurrentWindow CurrentWindow CurrentWindow CurrentWindow

Prerelease. Gets or sets the current window to which text is displayed.

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

The current window to which text is displayed.

Remarks

Setting the current window does not refresh that window's viewport. If the viewports of the current window and another window overlap, and the other window has changed content within the viewport, then refreshWindow may be called to restore the window's viewport contents.

Changes to this property are committed to the device on the next call to ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes).

IsCharacterSetMappingEnabled IsCharacterSetMappingEnabled IsCharacterSetMappingEnabled IsCharacterSetMappingEnabled

Prerelease. Gets or sets whether character set mapping is enabled.

public : PlatForm::Boolean IsCharacterSetMappingEnabled { get; set; }public bool IsCharacterSetMappingEnabled { get; set; }Public ReadWrite Property IsCharacterSetMappingEnabled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if character set mapping is enabled; otherwise, False.

Remarks

When LineDisplayCapabilities.CanMapCharacterSets is True, this writeable property controls whether character mapping is enabled. When character mapping is enabled, characters sent by the application are mapped by the device driver/the Service Object to the characters supported by the device.

When LineDisplayCapabilities.CanMapCharacterSets is False the value of this property is fixed to False and cannot be changed.

Changes to this property are committed to the device on the next call to ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes).

IsPowerNotifyEnabled IsPowerNotifyEnabled IsPowerNotifyEnabled IsPowerNotifyEnabled

Prerelease. Gets or sets whether the device is enabled to notify the user of power state changes.

public : PlatForm::Boolean IsPowerNotifyEnabled { get; set; }public bool IsPowerNotifyEnabled { get; set; }Public ReadWrite Property IsPowerNotifyEnabled As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if power state notifications are enabled; otherwise, False.

Remarks

Power state notifications are delivered via ClaimedLineDisplay.StatusUpdated. The property's default value is False (meaning that the device does not send power state notifications even if the app is subscribed to the ClaimedLineDisplay.StatusUpdated event). This property can be set to True only when LineDisplayCapabilities.PowerReportingType is not set to UnknownPowerReportingType.

Changes to this property are committed to the device on the next call to ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes).

ScreenSizeInCharacters ScreenSizeInCharacters ScreenSizeInCharacters ScreenSizeInCharacters

Prerelease. Gets or sets the current screen size.

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

The current screen size in characters.

Remarks

When the device supports multiple screen sizes (LineDisplayCapabilities.CanChangeScreenSize is True) this writeable property configures the current screen size. When bitmaps are also supported, changing the ScreenSizeinCharacters property may cause MaxBitmapSize to change to a new value.

When the device supports only one screen size (LineDisplayCapabilities.CanChangeScreenSize is False) this property supports only one value, behaving as a read-only property.

Changes to this property are committed to the device on the next call to ClaimedLineDisplay.TryUpdateAttributesAsync(LineDisplayAttributes).