LineDisplayWindow.TryDisplayStorageFileBitmapAtCursorAsync Method
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.
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
Return True if the bitmap was successfully displayed; otherwise, False.
- Attributes
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.
Applies to
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
Return True if the bitmap was successfully displayed; otherwise, False.
- Attributes
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.
Applies to
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
Return True if the bitmap was successfully displayed; otherwise, False.
- Attributes
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.
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for