Document.GetOptionsAsync(CancellationToken) Method

Definition

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.13.0

Source:

Document.cs

Returns the options that should be applied to this document. This consists of global options from Options, merged with any settings the user has specified at the document levels.

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Options.DocumentOptionSet> GetOptionsAsync(System.Threading.CancellationToken cancellationToken = default);

member this.GetOptionsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Options.DocumentOptionSet>

Public Function GetOptionsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentOptionSet)

Parameters

cancellationToken

CancellationToken

Returns

Task<DocumentOptionSet>

Remarks

This method is async because this may require reading other files. In files that are already open, this is expected to be cheap and complete synchronously.