CodeFixContext Struct

Definition

Namespace:

Microsoft.CodeAnalysis.CodeFixes

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.13.0

Source:

CodeFixContext.cs

Context for code fixes provided by a CodeFixProvider.

public readonly struct CodeFixContext

Inheritance

ValueType

CodeFixContext

Constructors

CodeFixContext(Document, Diagnostic, Action<CodeAction,ImmutableArray<Diagnostic>>, CancellationToken)	Creates a code fix context to be passed into RegisterCodeFixesAsync(CodeFixContext) method.
CodeFixContext(Document, TextSpan, ImmutableArray<Diagnostic>, Action<CodeAction,ImmutableArray<Diagnostic>>, CancellationToken)	Creates a code fix context to be passed into RegisterCodeFixesAsync(CodeFixContext) method.
CodeFixContext(TextDocument, Diagnostic, Action<CodeAction,ImmutableArray<Diagnostic>>, CancellationToken)	Creates a code fix context to be passed into RegisterCodeFixesAsync(CodeFixContext) method.
CodeFixContext(TextDocument, TextSpan, ImmutableArray<Diagnostic>, Action<CodeAction,ImmutableArray<Diagnostic>>, CancellationToken)	Creates a code fix context to be passed into RegisterCodeFixesAsync(CodeFixContext) method.

Properties

CancellationToken	CancellationToken.
Diagnostics	Diagnostics to fix. NOTE: All the diagnostics in this collection have the same Span.
Document	Document corresponding to the Span to fix. For code fixes that support non-source documents by providing a non-default value for DocumentKinds, this property will throw an InvalidOperationException. Such fixers should use the TextDocument property instead.
Span	Text span within the Document or TextDocument to fix.
TextDocument	TextDocument corresponding to the Span to fix. This property should be used instead of Document property by code fixes that support non-source documents by providing a non-default value for DocumentKinds

Methods

RegisterCodeFix(CodeAction, Diagnostic)	Add supplied action to the list of fixes that will be offered to the user.
RegisterCodeFix(CodeAction, IEnumerable<Diagnostic>)	Add supplied action to the list of fixes that will be offered to the user.
RegisterCodeFix(CodeAction, ImmutableArray<Diagnostic>)	Add supplied action to the list of fixes that will be offered to the user.

Applies to