Document.GetOptionsAsync(CancellationToken) Method

Definition

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.

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

Parameters

cancellationToken
CancellationToken

Returns

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.

Applies to

Product Versions
Roslyn 4.2.0, 4.3.0, 4.4.0, 4.5.0, 4.6.0, 4.7.0, 4.8.0, 4.9.2, 3.0.0, 3.1.0, 3.2.0, 3.2.1, 3.3.1, 3.4.0, 3.5.0, 3.6.0, 3.7.0, 3.8.0, 3.9.0, 3.10.0, 3.11.0, 4.0.1, 4.1.0, 4.12.2, 4.13.0