IAsyncCompletionSource.GetDescriptionAsync 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
| GetDescriptionAsync(CompletionItem, CancellationToken) |
Returns tooltip associated with provided CompletionItem. The returned object will be rendered by IViewElementFactoryService. See its documentation for default supported types. You may export a IViewElementFactory to provide a renderer for a custom type. Since this method is called on a background thread and on multiple platforms, an instance of UIElement may not be returned. |
| GetDescriptionAsync(IAsyncCompletionSession, CompletionItem, CancellationToken) |
Returns tooltip associated with provided CompletionItem. The returned object will be rendered by IViewElementFactoryService. See its documentation for default supported types. You may export a IViewElementFactory to provide a renderer for a custom type. Since this method is called on a background thread and on multiple platforms, an instance of UIElement may not be returned. |
GetDescriptionAsync(CompletionItem, CancellationToken)
Returns tooltip associated with provided CompletionItem. The returned object will be rendered by IViewElementFactoryService. See its documentation for default supported types. You may export a IViewElementFactory to provide a renderer for a custom type. Since this method is called on a background thread and on multiple platforms, an instance of UIElement may not be returned.
public:
System::Threading::Tasks::Task<System::Object ^> ^ GetDescriptionAsync(Microsoft::VisualStudio::Language::Intellisense::AsyncCompletion::Data::CompletionItem ^ item, System::Threading::CancellationToken token);public System.Threading.Tasks.Task<object> GetDescriptionAsync (Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data.CompletionItem item, System.Threading.CancellationToken token);abstract member GetDescriptionAsync : Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data.CompletionItem * System.Threading.CancellationToken -> System.Threading.Tasks.Task<obj>Public Function GetDescriptionAsync (item As CompletionItem, token As CancellationToken) As Task(Of Object)Parameters
- item
- CompletionItem
CompletionItem which is a subject of the tooltip
- token
- CancellationToken
Cancellation token that may interrupt this operation
Returns
An object that will be passed to IViewElementFactoryService. See its documentation for supported types.
Applies to
GetDescriptionAsync(IAsyncCompletionSession, CompletionItem, CancellationToken)
Returns tooltip associated with provided CompletionItem. The returned object will be rendered by IViewElementFactoryService. See its documentation for default supported types. You may export a IViewElementFactory to provide a renderer for a custom type. Since this method is called on a background thread and on multiple platforms, an instance of UIElement may not be returned.
public:
System::Threading::Tasks::Task<System::Object ^> ^ GetDescriptionAsync(Microsoft::VisualStudio::Language::Intellisense::AsyncCompletion::IAsyncCompletionSession ^ session, Microsoft::VisualStudio::Language::Intellisense::AsyncCompletion::Data::CompletionItem ^ item, System::Threading::CancellationToken token);public System.Threading.Tasks.Task<object> GetDescriptionAsync (Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.IAsyncCompletionSession session, Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data.CompletionItem item, System.Threading.CancellationToken token);abstract member GetDescriptionAsync : Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.IAsyncCompletionSession * Microsoft.VisualStudio.Language.Intellisense.AsyncCompletion.Data.CompletionItem * System.Threading.CancellationToken -> System.Threading.Tasks.Task<obj>Public Function GetDescriptionAsync (session As IAsyncCompletionSession, item As CompletionItem, token As CancellationToken) As Task(Of Object)Parameters
- session
- IAsyncCompletionSession
Reference to the active IAsyncCompletionSession
- item
- CompletionItem
CompletionItem which is a subject of the tooltip
- token
- CancellationToken
Cancellation token that may interrupt this operation
Returns
An object that will be passed to IViewElementFactoryService. See its documentation for supported types.