CodeRefactoringContext Struct

Definition

Namespace:

Microsoft.CodeAnalysis.CodeRefactorings

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.13.0

Source:

CodeRefactoringContext.cs

Context for code refactorings provided by a CodeRefactoringProvider.

C#

public readonly struct CodeRefactoringContext

Inheritance

ValueType

CodeRefactoringContext

Constructors

CodeRefactoringContext(Document, TextSpan, Action<CodeAction>, CancellationToken)	Creates a code refactoring context to be passed into ComputeRefactoringsAsync(CodeRefactoringContext) method.
CodeRefactoringContext(TextDocument, TextSpan, Action<CodeAction>, CancellationToken)	Creates a code refactoring context to be passed into ComputeRefactoringsAsync(CodeRefactoringContext) method.

Properties

CancellationToken	CancellationToken.
Document	Document corresponding to the Span to refactor. For code refactorings that support non-source documents by providing a non-default value for DocumentKinds, this property will throw an InvalidOperationException. Such refactorings should use the TextDocument property instead.
Span	Text span within the Document or TextDocument to refactor.
TextDocument	TextDocument corresponding to the Span to refactor. This property should be used instead of Document property by code refactorings that support non-source documents by providing a non-default value for DocumentKinds

Methods

RegisterRefactoring(CodeAction)

Add supplied action to the list of refactorings that will be offered to the user.

Applies to