ClaimedLineDisplay ClaimedLineDisplay ClaimedLineDisplay ClaimedLineDisplay ClaimedLineDisplay Class

Definition

Represents a claimed line display device.

public : sealed class ClaimedLineDisplay : IClosable
struct winrt::Windows::Devices::PointOfService::ClaimedLineDisplay : IClosable
public sealed class ClaimedLineDisplay : IDisposable
Public NotInheritable Class ClaimedLineDisplay 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

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.

Version history

Windows version SDK version Value added
1709 16299 CheckHealthAsync
1709 16299 CheckPowerStatusAsync
1709 16299 CustomGlyphs
1709 16299 GetAttributes
1709 16299 GetStatisticsAsync
1709 16299 MaxBitmapSizeInPixels
1709 16299 StatusUpdated
1709 16299 SupportedCharacterSets
1709 16299 SupportedScreenSizesInCharacters
1709 16299 TryClearDescriptorsAsync
1709 16299 TryCreateWindowAsync
1709 16299 TrySetDescriptorAsync
1709 16299 TryStoreStorageFileBitmapAsync(StorageFile)
1709 16299 TryStoreStorageFileBitmapAsync(StorageFile,LineDisplayHorizontalAlignment,LineDisplayVerticalAlignment)
1709 16299 TryStoreStorageFileBitmapAsync(StorageFile,LineDisplayHorizontalAlignment,LineDisplayVerticalAlignment,Int32)
1709 16299 TryUpdateAttributesAsync
1809 17763 Closed

Properties

Capabilities Capabilities Capabilities Capabilities Capabilities

Gets the capabilities of the claimed line display.

CustomGlyphs CustomGlyphs CustomGlyphs CustomGlyphs CustomGlyphs

Gets the line display's custom glyph list, if the feature is supported.

DefaultWindow DefaultWindow DefaultWindow DefaultWindow DefaultWindow

Gets the default device window of the line display.

DeviceControlDescription DeviceControlDescription DeviceControlDescription DeviceControlDescription DeviceControlDescription

Gets the device control description of the line display.

DeviceControlVersion DeviceControlVersion DeviceControlVersion DeviceControlVersion DeviceControlVersion

Gets the device control version number of the line display.

DeviceId DeviceId DeviceId DeviceId DeviceId

Gets the DeviceInformation.Id of the line display.

DeviceServiceVersion DeviceServiceVersion DeviceServiceVersion DeviceServiceVersion DeviceServiceVersion

Gets the service version number of the line display.

MaxBitmapSizeInPixels MaxBitmapSizeInPixels MaxBitmapSizeInPixels MaxBitmapSizeInPixels MaxBitmapSizeInPixels

Gets the maximum bitmap size.

PhysicalDeviceDescription PhysicalDeviceDescription PhysicalDeviceDescription PhysicalDeviceDescription PhysicalDeviceDescription

Gets the physical device description.

PhysicalDeviceName PhysicalDeviceName PhysicalDeviceName PhysicalDeviceName PhysicalDeviceName

Gets the physical device name.

SupportedCharacterSets SupportedCharacterSets SupportedCharacterSets SupportedCharacterSets SupportedCharacterSets

Gets the character sets supported by the line display.

SupportedScreenSizesInCharacters SupportedScreenSizesInCharacters SupportedScreenSizesInCharacters SupportedScreenSizesInCharacters SupportedScreenSizesInCharacters

Gets the screen sizes supported by the line display.

Methods

CheckHealthAsync(UnifiedPosHealthCheckLevel) CheckHealthAsync(UnifiedPosHealthCheckLevel) CheckHealthAsync(UnifiedPosHealthCheckLevel) CheckHealthAsync(UnifiedPosHealthCheckLevel) CheckHealthAsync(UnifiedPosHealthCheckLevel)

Gets the device's health state asynchronously.

CheckPowerStatusAsync() CheckPowerStatusAsync() CheckPowerStatusAsync() CheckPowerStatusAsync() CheckPowerStatusAsync()

Gets the current power status of the device.

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

Close the line display session. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose().

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

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

FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String) FromIdAsync(String)

Creates a LineDisplay object from the DeviceInformation.Id.

GetAttributes() GetAttributes() GetAttributes() GetAttributes() GetAttributes()

Gets the attributes of the line display.

GetDeviceSelector() GetDeviceSelector() GetDeviceSelector() GetDeviceSelector() GetDeviceSelector()

Gets an Advanced Query Syntax (AQS) string that you can use to list the available line displays.

GetDeviceSelector(PosConnectionTypes) 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

GetStatisticsAsync(IIterable<String>) GetStatisticsAsync(IIterable<String>) GetStatisticsAsync(IIterable<String>) GetStatisticsAsync(IIterable<String>) GetStatisticsAsync(IIterable<String>)

Retrieves the requested statistics from the line display.

RetainDevice() 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.

TryClearDescriptorsAsync() TryClearDescriptorsAsync() TryClearDescriptorsAsync() TryClearDescriptorsAsync() TryClearDescriptorsAsync()

Attempts to asynchronously clear all descriptions.

TryCreateWindowAsync(Rect, Size) TryCreateWindowAsync(Rect, Size) TryCreateWindowAsync(Rect, Size) TryCreateWindowAsync(Rect, Size) TryCreateWindowAsync(Rect, Size)

Attempts to asynchronously create a LineDisplayWindow.

TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState) TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState) TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState) TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState) TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState)

Attempts to asynchronously set a descriptor using the specified attribute.

TryStoreStorageFileBitmapAsync(StorageFile) TryStoreStorageFileBitmapAsync(StorageFile) TryStoreStorageFileBitmapAsync(StorageFile) TryStoreStorageFileBitmapAsync(StorageFile) TryStoreStorageFileBitmapAsync(StorageFile)

Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.

TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment)

Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.

TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32)

Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device.

TryUpdateAttributesAsync(LineDisplayAttributes) TryUpdateAttributesAsync(LineDisplayAttributes) TryUpdateAttributesAsync(LineDisplayAttributes) TryUpdateAttributesAsync(LineDisplayAttributes) TryUpdateAttributesAsync(LineDisplayAttributes)

Updates the device attributes.

Events

Closed Closed Closed Closed Closed

Event that is raised when the ClaimedLineDisplay is closed.

ReleaseDeviceRequested ReleaseDeviceRequested ReleaseDeviceRequested ReleaseDeviceRequested ReleaseDeviceRequested

Occurs when a claimed line display claimed is claimed by another app with LineDisplay.ClaimAsync.

StatusUpdated StatusUpdated StatusUpdated StatusUpdated StatusUpdated

Notifies the application that there is a change in the power status of the line display.