ISuggestedAction.GetPreviewAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Language.Intellisense

Assembly:: Microsoft.VisualStudio.Language.Intellisense.dll

Package:: Microsoft.VisualStudio.Language.Intellisense v17.11.260

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.

Gets an object visually representing a preview of the suggested action.

public:
 System::Threading::Tasks::Task<System::Object ^> ^ GetPreviewAsync(System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<object> GetPreviewAsync (System.Threading.CancellationToken cancellationToken);

public System.Threading.Tasks.Task<object?> GetPreviewAsync (System.Threading.CancellationToken cancellationToken);

abstract member GetPreviewAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<obj>

Public Function GetPreviewAsync (cancellationToken As CancellationToken) As Task(Of Object)

Parameters

cancellationToken: CancellationToken

A cancellation token that allows to cancel preview creation.

Returns

Task<Object>

A task whose result is an object visually representing a preview of the suggested action, or null if no preview can be provided.

Remarks

The only currently supported type of preview object is UIElement.

By default preview panel gets highlighted when focused by setting background color to PreviewFocusBackgroundBrush. When providing a preview object make sure it doesn't set different background for the whole preview content, otherwise it's recommended that preview object indicates focused state using PreviewFocusBackgroundBrush color.

Applies to

Share via