ClaimedLineDisplay
ClaimedLineDisplay
ClaimedLineDisplay
ClaimedLineDisplay
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 claimed line display device.
public : sealed class ClaimedLineDisplay : IClaimedLineDisplay, IClosablepublic sealed class ClaimedLineDisplay : IClaimedLineDisplay, IDisposablePublic NotInheritable Class ClaimedLineDisplay Implements IClaimedLineDisplay, IDisposable// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Remarks
This object can be constructed directly, or by using LineDisplay.ClaimAsync. Unlike other peripherals, the EnableAsync() method has been removed for line displays. Instead, the device is implicitly enabled whenever commands are sent that require the line display to be in an enabled state.
Properties
Capabilities Capabilities Capabilities Capabilities
Gets the capabilities of the claimed line display.
public : LineDisplayCapabilities Capabilities { get; }public LineDisplayCapabilities Capabilities { get; }Public ReadOnly Property Capabilities As LineDisplayCapabilities// You can use this property in JavaScript.
- Value
- LineDisplayCapabilities LineDisplayCapabilities LineDisplayCapabilities LineDisplayCapabilities
The capabilities of the line display.
CustomGlyphs CustomGlyphs CustomGlyphs CustomGlyphs
Prerelease. Gets the line display's custom glyph list, if the feature is supported.
public : LineDisplayCustomGlyphs CustomGlyphs { get; }public LineDisplayCustomGlyphs CustomGlyphs { get; }Public ReadOnly Property CustomGlyphs As LineDisplayCustomGlyphs// You can use this property in JavaScript.
- Value
- LineDisplayCustomGlyphs LineDisplayCustomGlyphs LineDisplayCustomGlyphs LineDisplayCustomGlyphs
The line display's LineDisplayCustomGlyphs object.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
When CanDisplayCustomGlyphs is True this property holds the LineDisplayCustomGlyphs object for this line display device. When Capabilities.CanDisplayCustomGlyphs is set to False this property is set to null.
DefaultWindow DefaultWindow DefaultWindow DefaultWindow
Gets the default device window of the line display.
public : LineDisplayWindow DefaultWindow { get; }public LineDisplayWindow DefaultWindow { get; }Public ReadOnly Property DefaultWindow As LineDisplayWindow// You can use this property in JavaScript.
The default device window, covering the entire screen area.
DeviceControlDescription DeviceControlDescription DeviceControlDescription DeviceControlDescription
Gets the device control description of the line display.
public : PlatForm::String DeviceControlDescription { get; }public string DeviceControlDescription { get; }Public ReadOnly Property DeviceControlDescription As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The control description of the line display.
DeviceControlVersion DeviceControlVersion DeviceControlVersion DeviceControlVersion
Gets the device control version number of the line display.
public : PlatForm::String DeviceControlVersion { get; }public string DeviceControlVersion { get; }Public ReadOnly Property DeviceControlVersion As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The UnifiedPOS control version number of the line display.
DeviceId DeviceId DeviceId DeviceId
Gets the DeviceInformation.Id of the line display.
public : PlatForm::String DeviceId { get; }public string DeviceId { get; }Public ReadOnly Property DeviceId As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The DeviceInformation.Id of the line display.
DeviceServiceVersion DeviceServiceVersion DeviceServiceVersion DeviceServiceVersion
Gets the service version number of the line display.
public : PlatForm::String DeviceServiceVersion { get; }public string DeviceServiceVersion { get; }Public ReadOnly Property DeviceServiceVersion As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The service version number.
MaxBitmapSizeInPixels MaxBitmapSizeInPixels MaxBitmapSizeInPixels MaxBitmapSizeInPixels
Prerelease. Gets the maximum bitmap size.
public : Size MaxBitmapSizeInPixels { get; }public Size MaxBitmapSizeInPixels { get; }Public ReadOnly Property MaxBitmapSizeInPixels As Size// You can use this property in JavaScript.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
When bitmaps are supported (when LineDisplayCapabilities.CanDisplayBitmaps is True) this read-only property describes the size of the screen that can display bitmaps as number of horizontal and vertical pixels. The maximum number of pixels in each direction is 65,535. When bitmaps are not supported by the device (LineDisplayCapabilities.CanDisplayBitmaps is False) the value of this property is {0, 0}.
PhysicalDeviceDescription PhysicalDeviceDescription PhysicalDeviceDescription PhysicalDeviceDescription
Gets the physical device description.
public : PlatForm::String PhysicalDeviceDescription { get; }public string PhysicalDeviceDescription { get; }Public ReadOnly Property PhysicalDeviceDescription As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The physical device description given by the UnifiedPOS specification.
PhysicalDeviceName PhysicalDeviceName PhysicalDeviceName PhysicalDeviceName
Gets the physical device name.
public : PlatForm::String PhysicalDeviceName { get; }public string PhysicalDeviceName { get; }Public ReadOnly Property PhysicalDeviceName As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The physical device name given by the UnifiedPOS specification.
SupportedCharacterSets SupportedCharacterSets SupportedCharacterSets SupportedCharacterSets
Prerelease. Gets the character sets supported by the line display.
public : IVectorView<int> SupportedCharacterSets { get; }public IReadOnlyList<int> SupportedCharacterSets { get; }Public ReadOnly Property SupportedCharacterSets As IReadOnlyList<int>// You can use this property in JavaScript.
- Value
- IVectorView<int> IReadOnlyList<int> IReadOnlyList<int> IReadOnlyList<int>
The character set numbers supported.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
Each character set is identified by a number which may be either a device-specific character set number or a code page, including 997 (Unicode), ASCII (998) and ANSI (999).
SupportedScreenSizesInCharacters SupportedScreenSizesInCharacters SupportedScreenSizesInCharacters SupportedScreenSizesInCharacters
Prerelease. Gets the screen sizes supported by the line display.
public : IVectorView<Size> SupportedScreenSizesInCharacters { get; }public IReadOnlyList<Size> SupportedScreenSizesInCharacters { get; }Public ReadOnly Property SupportedScreenSizesInCharacters As IReadOnlyList<Size>// You can use this property in JavaScript.
- Value
- IVectorView<Size> IReadOnlyList<Size> IReadOnlyList<Size> IReadOnlyList<Size>
A list containting the sizes that the device supports. Each size is represented as a pair of rows and columns.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Methods
CheckHealthAsync(UnifiedPosHealthCheckLevel) CheckHealthAsync(UnifiedPosHealthCheckLevel) CheckHealthAsync(UnifiedPosHealthCheckLevel) CheckHealthAsync(UnifiedPosHealthCheckLevel)
Prerelease. Gets the device's health state asynchronously.
public : IAsyncOperation<PlatForm::String> CheckHealthAsync(UnifiedPosHealthCheckLevel level)public IAsyncOperation<string> CheckHealthAsync(UnifiedPosHealthCheckLevel level)Public Function CheckHealthAsync(level As UnifiedPosHealthCheckLevel) As IAsyncOperation( Of string )// You can use this method in JavaScript.
- level
- UnifiedPosHealthCheckLevel UnifiedPosHealthCheckLevel UnifiedPosHealthCheckLevel UnifiedPosHealthCheckLevel
The specified health check level.
This value is intended to be reflected in the app interface immediately so the user of the app can interpret it. For example, it will return “OK” as the health string if the device state is good.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
This feature behaves identically to corresponding features in the other POS peripherals, and support for this operation is required by the UPOS standard.
CheckPowerStatusAsync() CheckPowerStatusAsync() CheckPowerStatusAsync() CheckPowerStatusAsync()
Prerelease. Gets the current power status of the device.
public : IAsyncOperation<LineDisplayPowerStatus> CheckPowerStatusAsync()public IAsyncOperation<LineDisplayPowerStatus> CheckPowerStatusAsync()Public Function CheckPowerStatusAsync() As IAsyncOperation( Of LineDisplayPowerStatus )// You can use this method in JavaScript.
The current power status of the device.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Close() Close() Close() Close()
Close the line display session. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().
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.
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()
FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String)
Creates a LineDisplay object from the DeviceInformation.Id.
public : static IAsyncOperation<ClaimedLineDisplay> FromIdAsync(PlatForm::String deviceId)public static IAsyncOperation<ClaimedLineDisplay> FromIdAsync(String deviceId)Public Static Function FromIdAsync(deviceId As String) As IAsyncOperation( Of ClaimedLineDisplay )// You can use this method in JavaScript.
- deviceId
- PlatForm::String String String String
The DeviceInformation.Id that identifies a specific line display, which can be retrieved from the DeviceId property.
The line display specified by the unique device identifier. Returns a null object in the following cases:
- The specific device is not found.
- Access denied to the existing device. The user can deny access to a device, which is not treated as an exception.
GetAttributes() GetAttributes() GetAttributes() GetAttributes()
Prerelease. Gets the attributes of the line display.
public : LineDisplayAttributes GetAttributes()public LineDisplayAttributes GetAttributes()Public Function GetAttributes() As LineDisplayAttributes// You can use this method in JavaScript.
The attributes of the line display.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
GetDeviceSelector() GetDeviceSelector() GetDeviceSelector() GetDeviceSelector()
Gets an Advanced Query Syntax (AQS) string that you can use to list the available line displays.
public : static PlatForm::String GetDeviceSelector()public static string GetDeviceSelector()Public Static Function GetDeviceSelector() As string// You can use this method in JavaScript.
An Advanced Query Syntax string that is used to enumerate available line displays.
GetDeviceSelector(PosConnectionTypes) GetDeviceSelector(PosConnectionTypes) GetDeviceSelector(PosConnectionTypes) GetDeviceSelector(PosConnectionTypes)
Gets an Advanced Query Syntax (AQS) string that you can use to list the line displays available over the specified connection types
public : static PlatForm::String GetDeviceSelector(PosConnectionTypes connectionTypes)public static string GetDeviceSelector(PosConnectionTypes connectionTypes)Public Static Function GetDeviceSelector(connectionTypes As PosConnectionTypes) As string// You can use this method in JavaScript.
- connectionTypes
- PosConnectionTypes PosConnectionTypes PosConnectionTypes PosConnectionTypes
A list of the connection types to check for available line displays.
An AQS string that is used to enumerate available line displays available over the specified connection types
GetStatisticsAsync(IIterable)
GetStatisticsAsync(IIterable)
GetStatisticsAsync(IIterable)
GetStatisticsAsync(IIterable)
Prerelease. Retrieves the requested statistics from the line display.
public : IAsyncOperation<PlatForm::String> GetStatisticsAsync(IIterable<PlatForm::String> statisticsCategories)public IAsyncOperation<string> GetStatisticsAsync(IEnumerable<String> statisticsCategories)Public Function GetStatisticsAsync(statisticsCategories As IEnumerable<String>) As IAsyncOperation( Of string )// You can use this method in JavaScript.
- statisticsCategories
- IIterable<PlatForm::String> IEnumerable<String> IEnumerable<String> IEnumerable<String>
The list of statistics to retrieve.
- An empty list retrieves all statistics.
- To retrieve specific statistics defined by the manufacturer, include the manufacturer-specified statistic names such as "name1" or "name2".
- Include LineDisplayStatisticsCategorySelector.ManufacturerStatistics and LineDisplayStatisticsCategorySelector.UnifiedPosStatistics to retrieve manufacturer-specific and UnifiedPOS statistics respectively.
An XML string representing the requested statistics.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
RetainDevice() RetainDevice() RetainDevice() RetainDevice()
Retains an app's claim on a line display device after it has been claimed by another app with LineDisplay.ClaimAsync.
public : void RetainDevice()public void RetainDevice()Public Function RetainDevice() As void// You can use this method in JavaScript.
TryClearDescriptorsAsync() TryClearDescriptorsAsync() TryClearDescriptorsAsync() TryClearDescriptorsAsync()
Prerelease. Attempts to asynchronously clear all descriptions.
public : IAsyncOperation<PlatForm::Boolean> TryClearDescriptorsAsync()public IAsyncOperation<bool> TryClearDescriptorsAsync()Public Function TryClearDescriptorsAsync() As IAsyncOperation( Of bool )// You can use this method in JavaScript.
Returns True if all descriptors are successfully cleared; otherwise, False.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
TryCreateWindowAsync(Rect, Size) TryCreateWindowAsync(Rect, Size) TryCreateWindowAsync(Rect, Size) TryCreateWindowAsync(Rect, Size)
Prerelease. Attempts to asynchronously create a LineDisplayWindow.
public : IAsyncOperation<LineDisplayWindow> TryCreateWindowAsync(Rect viewport, Size windowSize)public IAsyncOperation<LineDisplayWindow> TryCreateWindowAsync(Rect viewport, Size windowSize)Public Function TryCreateWindowAsync(viewport As Rect, windowSize As Size) As IAsyncOperation( Of LineDisplayWindow )// You can use this method in JavaScript.
The viewport’s origin device row, origin device column, width in rows and height in columns.
A new LineDisplayWindow object, representing a new window for the device.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
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.
TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState) TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState) TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState) TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState)
Prerelease. Attempts to asynchronously set a descriptor using the specified attribute.
public : IAsyncOperation<PlatForm::Boolean> TrySetDescriptorAsync(unsigned int descriptor, LineDisplayDescriptorState descriptorState)public IAsyncOperation<bool> TrySetDescriptorAsync(UInt32 descriptor, LineDisplayDescriptorState descriptorState)Public Function TrySetDescriptorAsync(descriptor As UInt32, descriptorState As LineDisplayDescriptorState) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
- descriptor
- unsigned int UInt32 UInt32 UInt32
The descriptor to be set. Must have a value between 0 and LineDisplayCapabilities.SupportedDescriptors - 1.
- descriptorState
- LineDisplayDescriptorState LineDisplayDescriptorState LineDisplayDescriptorState LineDisplayDescriptorState
The state to give to the descriptor.
Returns True if the descriptor was set successfully; otherwise, False.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
LineDisplayCapabilities.SupportedDescriptors must be greater than zero for this method to be successfully executed.
TryStoreStorageFileBitmapAsync(StorageFile) TryStoreStorageFileBitmapAsync(StorageFile) TryStoreStorageFileBitmapAsync(StorageFile) TryStoreStorageFileBitmapAsync(StorageFile)
Prerelease. Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.
public : IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap)public IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap)Public Function TryStoreStorageFileBitmapAsync(bitmap As StorageFile) As IAsyncOperation( Of LineDisplayStoredBitmap )// You can use this method in JavaScript.
A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats.
True if the bitmap is stored successfully, False if a failure occurs.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
- The bitmap StorageFile must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception.
- Calling this method when LineDisplayCapabiliaties.CanDisplayBitmaps is False will result in an exception.
- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using LineDisplayStoredBitmap.TryDeleteAsync.
TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment)
Prerelease. Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.
public : IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment)public IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment)Public Function TryStoreStorageFileBitmapAsync(bitmap As StorageFile, horizontalAlignment As LineDisplayHorizontalAlignment, verticalAlignment As LineDisplayVerticalAlignment) As IAsyncOperation( Of LineDisplayStoredBitmap )// You can use this method in JavaScript.
A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats.
- horizontalAlignment
- LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment
Determines how the bitmap will be horizontally aligned relative to its originating character cell.
- verticalAlignment
- LineDisplayVerticalAlignment LineDisplayVerticalAlignment LineDisplayVerticalAlignment LineDisplayVerticalAlignment
Determines how the bitmap will be vertically aligned relative to its originating character cell.
True if the bitmap is stored successfully, False if a failure occurs.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
- The bitmap StorageFile must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception.
- Calling this method when LineDisplayCapabiliaties.CanDisplayBitmaps is False will result in an exception.
- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using LineDisplayStoredBitmap.TryDeleteAsync.
TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32)
Prerelease. Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.
public : IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment, int widthInPixels)public IAsyncOperation<LineDisplayStoredBitmap> TryStoreStorageFileBitmapAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment, Int32 widthInPixels)Public Function TryStoreStorageFileBitmapAsync(bitmap As StorageFile, horizontalAlignment As LineDisplayHorizontalAlignment, verticalAlignment As LineDisplayVerticalAlignment, widthInPixels As Int32) As IAsyncOperation( Of LineDisplayStoredBitmap )// You can use this method in JavaScript.
A StorageFile that represents a local bitmap file. All line displays support black and white uncompressed Windows bitmaps. Check device specifications for other supported formats.
- horizontalAlignment
- LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment LineDisplayHorizontalAlignment
Determines how the bitmap will be horizontally aligned relative to its originating character cell.
- verticalAlignment
- LineDisplayVerticalAlignment LineDisplayVerticalAlignment LineDisplayVerticalAlignment LineDisplayVerticalAlignment
Determines how the bitmap will be vertically aligned relative to its originating character cell.
- widthInPixels
- int Int32 Int32 Int32
The displayed bitmap width in pixels, if different from the original bitmap width. Height will be calculated proportionally.
True if the bitmap is stored successfully, False if a failure occurs.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
- The bitmap StorageFile must be backed by a local file. If it is created from a stream, a URI or another source this method will throw an exception.
- Calling this method when LineDisplayCapabiliaties.CanDisplayBitmaps is False will result in an exception.
- Up to 100 bitmaps can be stored using this method. Attempting to store more than 100 bitmaps will result in an exception. Delete unused bitmaps using LineDisplayStoredBitmap.TryDeleteAsync.
- Passing a bitmap width greater than ClaimedLineDisplay.MaxBitmapSizeInPixels will result in an exception.
TryUpdateAttributesAsync(LineDisplayAttributes) TryUpdateAttributesAsync(LineDisplayAttributes) TryUpdateAttributesAsync(LineDisplayAttributes) TryUpdateAttributesAsync(LineDisplayAttributes)
Prerelease. Updates the device attributes.
public : IAsyncOperation<PlatForm::Boolean> TryUpdateAttributesAsync(LineDisplayAttributes attributes)public IAsyncOperation<bool> TryUpdateAttributesAsync(LineDisplayAttributes attributes)Public Function TryUpdateAttributesAsync(attributes As LineDisplayAttributes) As IAsyncOperation( Of bool )// You can use this method in JavaScript.
The updated attributes to be applied to the device.
Returns True if the attributes were successfully updated; otherwise, False.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Events
ReleaseDeviceRequested ReleaseDeviceRequested ReleaseDeviceRequested ReleaseDeviceRequested
Occurs when a claimed line display claimed is claimed by another app with LineDisplay.ClaimAsync.
public : event TypedEventHandler ReleaseDeviceRequested<ClaimedLineDisplay, object>public event TypedEventHandler ReleaseDeviceRequested<ClaimedLineDisplay, object>Public Event ReleaseDeviceRequested<ClaimedLineDisplay, object>// You can use this event in JavaScript.
StatusUpdated StatusUpdated StatusUpdated StatusUpdated
Prerelease. Notifies the application that there is a change in the power status of the line display.
public : event TypedEventHandler StatusUpdated<ClaimedLineDisplay, LineDisplayStatusUpdatedEventArgs>public event TypedEventHandler StatusUpdated<ClaimedLineDisplay, LineDisplayStatusUpdatedEventArgs>Public Event StatusUpdated<ClaimedLineDisplay, LineDisplayStatusUpdatedEventArgs>// You can use this event in JavaScript.
| Device family |
Windows 10 Insider Preview (introduced v10.0.16257.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v5)
|
Remarks
The event values are the same as the values returned by CheckPowerStatusAsync.