CodeAction.GetChangedDocumentAsync 方法

定义

命名空间:

Microsoft.CodeAnalysis.CodeActions

程序集:

Microsoft.CodeAnalysis.Workspaces.dll

包:

Microsoft.CodeAnalysis.Workspaces.Common v4.12.0

重载

GetChangedDocumentAsync(IProgress<CodeAnalysisProgress>, CancellationToken)	计算单个文档的更改。 如果要实现更改单个文档的 CodeAction 子类，请重写此方法。 优先于在计算长时间运行且应向用户显示进度时重写此方法 GetChangedDocumentAsync(CancellationToken) 。
GetChangedDocumentAsync(CancellationToken)	计算单个文档的更改。 如果要实现更改单个文档的 CodeAction 子类，请重写此方法。 重写 GetChangedDocumentAsync(IProgress<CodeAnalysisProgress>, CancellationToken) 以在计算操作时报告进度。

GetChangedDocumentAsync(IProgress<CodeAnalysisProgress>, CancellationToken)

Source:

CodeAction.cs

计算单个文档的更改。 如果要实现更改单个文档的 CodeAction 子类，请重写此方法。 优先于在计算长时间运行且应向用户显示进度时重写此方法 GetChangedDocumentAsync(CancellationToken) 。

protected virtual System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document> GetChangedDocumentAsync (IProgress<Microsoft.CodeAnalysis.CodeAnalysisProgress> progress, System.Threading.CancellationToken cancellationToken);

abstract member GetChangedDocumentAsync : IProgress<Microsoft.CodeAnalysis.CodeAnalysisProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document>
override this.GetChangedDocumentAsync : IProgress<Microsoft.CodeAnalysis.CodeAnalysisProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document>

Protected Overridable Function GetChangedDocumentAsync (progress As IProgress(Of CodeAnalysisProgress), cancellationToken As CancellationToken) As Task(Of Document)

参数

progress

IProgress<CodeAnalysisProgress>

cancellationToken

CancellationToken

返回

Task<Document>

例外

NotSupportedException

如果此代码操作不支持更改单个文档。

注解

所有代码操作都应在解决方案上运行。 此方法是一个帮助程序，用于简化只需更改一个文档的代码操作的 GetChangedSolutionAsync(CancellationToken) 实现。

GetChangedDocumentAsync(CancellationToken)

Source:

CodeAction.cs

计算单个文档的更改。 如果要实现更改单个文档的 CodeAction 子类，请重写此方法。 重写 GetChangedDocumentAsync(IProgress<CodeAnalysisProgress>, CancellationToken) 以在计算操作时报告进度。

protected:
 virtual System::Threading::Tasks::Task<Microsoft::CodeAnalysis::Document ^> ^ GetChangedDocumentAsync(System::Threading::CancellationToken cancellationToken);

protected virtual System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document> GetChangedDocumentAsync (System.Threading.CancellationToken cancellationToken);

abstract member GetChangedDocumentAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document>
override this.GetChangedDocumentAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Document>

Protected Overridable Function GetChangedDocumentAsync (cancellationToken As CancellationToken) As Task(Of Document)

参数

cancellationToken

CancellationToken

返回

Task<Document>

例外

NotSupportedException

如果此代码操作不支持更改单个文档。

注解

所有代码操作都应在解决方案上运行。 此方法是一个帮助程序，用于简化只需更改一个文档的代码操作的 GetChangedSolutionAsync(CancellationToken) 实现。