CodeActionWithOptions 类

定义

CodeAction 可因用户指定的选项而异。 重写 或 之ComputeOperationsAsync(Object, CancellationToken)ComputeOperationsAsync(Object, IProgress<CodeAnalysisProgress>, CancellationToken)一,以实际计算此操作的操作。

public ref class CodeActionWithOptions abstract : Microsoft::CodeAnalysis::CodeActions::CodeAction
public abstract class CodeActionWithOptions : Microsoft.CodeAnalysis.CodeActions.CodeAction
type CodeActionWithOptions = class
    inherit CodeAction
Public MustInherit Class CodeActionWithOptions
Inherits CodeAction
继承
CodeActionWithOptions

构造函数

CodeActionWithOptions()

CodeAction 可因用户指定的选项而异。 重写 或 之ComputeOperationsAsync(Object, CancellationToken)ComputeOperationsAsync(Object, IProgress<CodeAnalysisProgress>, CancellationToken)一,以实际计算此操作的操作。

属性

EquivalenceKey

如果两个代码操作具有相等的非 null EquivalenceKey 值并且由相同的 CodeFixProviderCodeRefactoringProvider生成,则它们被视为等效。

(继承自 CodeAction)
IsInlinable

如果此代码操作包含 NestedActions,则此属性向主机提供一个提示,说明是否可以删除此代码操作,并仅显示嵌套操作。 当主机已经有很多顶级操作要显示时,它应考虑 不要 内联此操作,以保持向用户显示的选项数较低。 但是,如果向用户显示的选项很少,则内联此操作可能很有用,因为它将允许用户以较少的步骤查看和选择嵌套选项之一。 若要创建 CodeAction 包含嵌套操作的 ,请使用 Create(String, ImmutableArray<CodeAction>, Boolean)

(继承自 CodeAction)
NestedActions

CodeAction中包含的子操作。 可以在主机中呈现,以便为特定问题提供更多潜在的解决方案操作。 若要创建 CodeAction 包含嵌套操作的 ,请使用 Create(String, ImmutableArray<CodeAction>, Boolean)

(继承自 CodeAction)
Priority

此特定操作在一组其他操作中的优先级。 不太相关的操作应覆盖此内容并指定较低的优先级,以便用户可以轻松访问更重要的操作。 Default如果未重写,则返回 。

(继承自 CodeAction)
Tags

来自 WellKnownTags的描述性标记。 这些标记可能会影响项的显示方式。

(继承自 CodeAction)
Title

描述可能显示在菜单中的操作的简短标题。

(继承自 CodeAction)

方法

ComputeOperationsAsync(CancellationToken)

CodeAction 可因用户指定的选项而异。 重写 或 之ComputeOperationsAsync(Object, CancellationToken)ComputeOperationsAsync(Object, IProgress<CodeAnalysisProgress>, CancellationToken)一,以实际计算此操作的操作。

ComputeOperationsAsync(IProgress<CodeAnalysisProgress>, CancellationToken)

如果要实现 CodeAction 包含自定义 CodeActionOperation的 子类,请重写此方法。 优先于在计算长时间运行且应向用户显示进度时重写此方法 ComputeOperationsAsync(CancellationToken)

(继承自 CodeAction)
ComputeOperationsAsync(Object, CancellationToken)

重写此方法以计算实现此 CodeAction的操作。

ComputeOperationsAsync(Object, IProgress<CodeAnalysisProgress>, CancellationToken)

重写此方法以计算实现此 CodeAction的操作。 优先于在计算长时间运行且应向用户显示进度时重写此方法 ComputeOperationsAsync(Object, CancellationToken)

ComputePreviewOperationsAsync(CancellationToken)

如果要实现具有一 CodeAction 组与 生成的 ComputeOperationsAsync(IProgress<CodeAnalysisProgress>, CancellationToken)操作不同的预览操作的 ,请重写此方法。

(继承自 CodeAction)
ComputePriority()

CodeActionPriority计算应显示此代码操作的组。 此合法值必须介于 和 High之间Lowest

(继承自 CodeAction)
GetChangedDocumentAsync(CancellationToken)

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

(继承自 CodeAction)
GetChangedDocumentAsync(IProgress<CodeAnalysisProgress>, CancellationToken)

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

(继承自 CodeAction)
GetChangedSolutionAsync(CancellationToken)

计算整个解决方案的所有更改。 如果要实现更改多个文档的 CodeAction 子类,请重写此方法。 重写 GetChangedSolutionAsync(IProgress<CodeAnalysisProgress>, CancellationToken) 以在计算操作时报告进度。

(继承自 CodeAction)
GetChangedSolutionAsync(IProgress<CodeAnalysisProgress>, CancellationToken)

计算整个解决方案的所有更改。 如果要实现更改多个文档的 CodeAction 子类,请重写此方法。 优先于在计算长时间运行且应向用户显示进度时重写此方法 GetChangedSolutionAsync(CancellationToken)

(继承自 CodeAction)
GetOperationsAsync(CancellationToken)

定义代码操作的操作序列。

(继承自 CodeAction)
GetOperationsAsync(Object, CancellationToken)

CodeActionOperation在给定指定选项的情况下获取此CodeAction的 。

GetOperationsAsync(Solution, IProgress<CodeAnalysisProgress>, CancellationToken)

定义代码操作的操作序列。

(继承自 CodeAction)
GetOptions(CancellationToken)

获取要用于此代码操作的选项。 保证在 UI 线程上调用此方法。

GetPreviewOperationsAsync(CancellationToken)

用于构造预览的操作序列。

(继承自 CodeAction)
PostProcessAsync(IEnumerable<CodeActionOperation>, CancellationToken)

将后处理步骤应用于任何 ApplyChangesOperation的 。

(继承自 CodeAction)
PostProcessChangesAsync(Document, CancellationToken)

将后处理步骤应用于单个文档:减少使用 添加批注 Annotation 的格式节点的节点 Annotation

(继承自 CodeAction)
PostProcessChangesAsync(Solution, CancellationToken)

将后处理步骤应用于解决方案更改,例如格式设置和简化。

(继承自 CodeAction)

适用于