LineDisplayWindow.TryDisplayStorageFileBitmapAtCursorAsync Method

Definition

Namespace:

Windows.Devices.PointOfService

Overloads

TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment, Int32)	Attempts to asynchronously display a bitmap from a storage file at the current cursor position, at a particular width.
TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment)	Attempts to asynchronously display a bitmap from a storage file at the current cursor position.
TryDisplayStorageFileBitmapAtCursorAsync(StorageFile)	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.

public:
 virtual IAsyncOperation<bool> ^ TryDisplayStorageFileBitmapAtCursorAsync(StorageFile ^ bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment, int widthInPixels) = TryDisplayStorageFileBitmapAtCursorAsync;

/// [Windows.Foundation.Metadata.Overload("TryDisplayStorageFileBitmapAtCursorWithAlignmentAndWidthAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile const& bitmap, LineDisplayHorizontalAlignment const& horizontalAlignment, LineDisplayVerticalAlignment const& verticalAlignment, int const& widthInPixels);

[Windows.Foundation.Metadata.Overload("TryDisplayStorageFileBitmapAtCursorWithAlignmentAndWidthAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment, int widthInPixels);

function tryDisplayStorageFileBitmapAtCursorAsync(bitmap, horizontalAlignment, verticalAlignment, widthInPixels)

Public Function TryDisplayStorageFileBitmapAtCursorAsync (bitmap As StorageFile, horizontalAlignment As LineDisplayHorizontalAlignment, verticalAlignment As LineDisplayVerticalAlignment, widthInPixels As Integer) As IAsyncOperation(Of Boolean)

Parameters

bitmap

StorageFile

The bitmap to be displayed.

horizontalAlignment

LineDisplayHorizontalAlignment

The horizontal alignment of the bitmap relative to the current text character position.

verticalAlignment

LineDisplayVerticalAlignment

The vertical alignment of the bitmap relative to the current text character position.

widthInPixels

Int32

int

The desired width of the bitmap. A value of 0 pixels will display the bitmap at one pixel per screen dot (unscaled).

Returns

IAsyncOperation<Boolean>

IAsyncOperation<bool>

Return True if the bitmap was successfully displayed; otherwise, False.

Attributes

OverloadAttribute RemoteAsyncAttribute

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.

If the provided widthInPixels value is larger than ClaimedLineDisplay.MaxBitmapSizeInPixels, this method will fail.

TryDisplayStorageFileBitmapAtCursorAsync(StorageFile, LineDisplayHorizontalAlignment, LineDisplayVerticalAlignment)

Attempts to asynchronously display a bitmap from a storage file at the current cursor position.

public:
 virtual IAsyncOperation<bool> ^ TryDisplayStorageFileBitmapAtCursorAsync(StorageFile ^ bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment) = TryDisplayStorageFileBitmapAtCursorAsync;

/// [Windows.Foundation.Metadata.Overload("TryDisplayStorageFileBitmapAtCursorWithAlignmentAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile const& bitmap, LineDisplayHorizontalAlignment const& horizontalAlignment, LineDisplayVerticalAlignment const& verticalAlignment);

[Windows.Foundation.Metadata.Overload("TryDisplayStorageFileBitmapAtCursorWithAlignmentAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap, LineDisplayHorizontalAlignment horizontalAlignment, LineDisplayVerticalAlignment verticalAlignment);

function tryDisplayStorageFileBitmapAtCursorAsync(bitmap, horizontalAlignment, verticalAlignment)

Public Function TryDisplayStorageFileBitmapAtCursorAsync (bitmap As StorageFile, horizontalAlignment As LineDisplayHorizontalAlignment, verticalAlignment As LineDisplayVerticalAlignment) As IAsyncOperation(Of Boolean)

Parameters

bitmap

StorageFile

The bitmap to be displayed.

horizontalAlignment

LineDisplayHorizontalAlignment

The horizontal alignment of the bitmap relative to the current text character position.

verticalAlignment

LineDisplayVerticalAlignment

The vertical alignment of the bitmap relative to the current text character position.

Returns

IAsyncOperation<Boolean>

IAsyncOperation<bool>

Return True if the bitmap was successfully displayed; otherwise, False.

Attributes

OverloadAttribute RemoteAsyncAttribute

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.

TryDisplayStorageFileBitmapAtCursorAsync(StorageFile)

Attempts to asynchronously display a bitmap from a storage file at the current cursor position.

public:
 virtual IAsyncOperation<bool> ^ TryDisplayStorageFileBitmapAtCursorAsync(StorageFile ^ bitmap) = TryDisplayStorageFileBitmapAtCursorAsync;

/// [Windows.Foundation.Metadata.Overload("TryDisplayStorageFileBitmapAtCursorAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile const& bitmap);

[Windows.Foundation.Metadata.Overload("TryDisplayStorageFileBitmapAtCursorAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<bool> TryDisplayStorageFileBitmapAtCursorAsync(StorageFile bitmap);

function tryDisplayStorageFileBitmapAtCursorAsync(bitmap)

Public Function TryDisplayStorageFileBitmapAtCursorAsync (bitmap As StorageFile) As IAsyncOperation(Of Boolean)

Parameters

bitmap

StorageFile

The bitmap to be displayed.

Returns

IAsyncOperation<Boolean>

IAsyncOperation<bool>

Return True if the bitmap was successfully displayed; otherwise, False.

Attributes

OverloadAttribute RemoteAsyncAttribute

Windows requirements

Device family	Windows 10 Fall Creators Update (introduced in 10.0.16299.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v5.0)

Remarks

If the LineDisplayCapabilities.CanDisplayBitmaps value is False, this method will fail.