ITextDocumentSnapshot.GetEditorOptionValueAsync<T> Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Extensibility.Editor

Assembly:: Microsoft.VisualStudio.Extensibility.Editor.Contracts.dll

Package:: Microsoft.VisualStudio.Extensibility.Editor.Contracts v17.10.166

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 editor option value based on the current text document scope.

public System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Editor.EditorOptionValue<T?>> GetEditorOptionValueAsync<T> (Microsoft.VisualStudio.Extensibility.Editor.TextDocumentOption<T> option, System.Threading.CancellationToken cancellationToken);

abstract member GetEditorOptionValueAsync : Microsoft.VisualStudio.Extensibility.Editor.TextDocumentOption<'T> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Extensibility.Editor.EditorOptionValue<'T>>

Public Function GetEditorOptionValueAsync(Of T) (option As TextDocumentOption(Of T), cancellationToken As CancellationToken) As Task(Of EditorOptionValue(Of T))

Type Parameters

T

Type of the option value.

Parameters

option: TextDocumentOption<T>

Option identifier.

cancellationToken: CancellationToken

Cancellation token to monitor.

Returns

Task<EditorOptionValue<T>>

This method returns either:

the current value of option.
the defined default value if option is defined but not set.

Exceptions

ArgumentOutOfRangeException

Throw when option is not set in this scope.

Applies to

Share via