ClaimedLineDisplay Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a claimed line display device.
public ref class ClaimedLineDisplay sealed : IClosable/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class ClaimedLineDisplay final : IClosable[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class ClaimedLineDisplay : System.IDisposablePublic NotInheritable Class ClaimedLineDisplay
Implements IDisposable- Inheritance
- Attributes
- Implements
Windows requirements
| Device family |
Windows 10 Creators Update (introduced in 10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v4.0)
|
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 |
Gets the capabilities of the claimed line display. |
| CustomGlyphs |
Gets the line display's custom glyph list, if the feature is supported. |
| DefaultWindow |
Gets the default device window of the line display. |
| DeviceControlDescription |
Gets the device control description of the line display. |
| DeviceControlVersion |
Gets the device control version number of the line display. |
| DeviceId |
Gets the DeviceInformation.Id of the line display. |
| DeviceServiceVersion |
Gets the service version number of the line display. |
| MaxBitmapSizeInPixels |
Gets the maximum bitmap size. |
| PhysicalDeviceDescription |
Gets the physical device description. |
| PhysicalDeviceName |
Gets the physical device name. |
| SupportedCharacterSets |
Gets the character sets supported by the line display. |
| SupportedScreenSizesInCharacters |
Gets the screen sizes supported by the line display. |
Methods
| CheckHealthAsync(UnifiedPosHealthCheckLevel) |
Gets the device's health state asynchronously. |
| CheckPowerStatusAsync() |
Gets the current power status of the device. |
| Close() |
Close the line display session. For C++ and JavaScript, use Close(). For C# and Visual Basic, use Dispose(). |
| Dispose() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
| FromIdAsync(String) |
Creates a LineDisplay object from the DeviceInformation.Id. |
| GetAttributes() |
Gets the attributes of the line display. |
| GetDeviceSelector() |
Gets an Advanced Query Syntax (AQS) string that you can use to list the available line displays. |
| 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>) |
Retrieves the requested statistics from the line display. |
| RetainDevice() |
Retains an app's claim on a line display device after it has been claimed by another app with LineDisplay.ClaimAsync. |
| TryClearDescriptorsAsync() |
Attempts to asynchronously clear all descriptions. |
| TryCreateWindowAsync(Rect, Size) |
Attempts to asynchronously create a LineDisplayWindow. |
| TrySetDescriptorAsync(UInt32, LineDisplayDescriptorState) |
Attempts to asynchronously set a descriptor using the specified attribute. |
| TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32) |
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device. |
| TryStoreStorageFileBitmapAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment) |
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device. |
| TryStoreStorageFileBitmapAsync(StorageFile) |
Attempts to asynchronously store a bitmap image from a StorageFile for later display on the line display device. |
| TryUpdateAttributesAsync(LineDisplayAttributes) |
Updates the device attributes. |
Events
| Closed |
Event that is raised when the ClaimedLineDisplay is closed. |
| ReleaseDeviceRequested |
Occurs when a claimed line display claimed is claimed by another app with LineDisplay.ClaimAsync. |
| StatusUpdated |
Notifies the application that there is a change in the power status of the line display. |