Share via


NotesWindowManagerPreview.SetNotesThumbnailAsync(IBuffer) Method

Definition

Sets the thumbnail image for this application as it appears in the Windows Ink Workspace, in the Alt+TAB task switcher, or on hovering in the taskbar.

public:
 virtual IAsyncAction ^ SetNotesThumbnailAsync(IBuffer ^ thumbnail) = SetNotesThumbnailAsync;
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncAction SetNotesThumbnailAsync(IBuffer const& thumbnail);
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncAction SetNotesThumbnailAsync(IBuffer thumbnail);
function setNotesThumbnailAsync(thumbnail)
Public Function SetNotesThumbnailAsync (thumbnail As IBuffer) As IAsyncAction

Parameters

thumbnail
IBuffer

A byte array describing the thumbnail image and usage (see Remarks).

Returns

This method does not return a value.

Attributes

Remarks

The thumbnail byte array must adhere to the following format in order to describe a thumbnail image: Bytes 0-3: thumbnail type – a string value of either "NTPW" (for Ink Workspace appearance) or "NTTS" (for Alt+TAB switching and taskbar hover).

Bytes 4-7: Image width in pixels – an integer value.

Bytes 8-11: Image height in pixels – an integer value.

The final section must contain 4 * image width * image height number of bytes. Every 4-byte integer of this section corresponds to the BGRA color data of one pixel.

Note

If the size of the image used (in pixels) exceeds the size of the primary monitor, an InvalidArgumentException will be thrown.

Applies to