CodeAction Classe

Définition

Espace de noms:

Microsoft.CodeAnalysis.CodeActions

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Paquet:

Microsoft.CodeAnalysis.Workspaces.Common v4.12.0

Source:

CodeAction.cs

Action produite par un CodeFixProvider ou un CodeRefactoringProvider.

public ref class CodeAction abstract

public abstract class CodeAction

type CodeAction = class

Public MustInherit Class CodeAction

Héritage

Object

CodeAction

Dérivé

Microsoft.CodeAnalysis.CodeActions.CodeActionWithOptions

Constructeurs

CodeAction()

Action produite par un CodeFixProvider ou un CodeRefactoringProvider.

Propriétés

EquivalenceKey	Deux actions de code sont traitées comme équivalentes si elles ont des valeurs égales non null EquivalenceKey et ont été générées par le même CodeFixProvider ou CodeRefactoringProvider.
IsInlinable	Si cette action de code contient NestedActions, cette propriété indique aux hôtes s’il est acceptable ou non d’élider cette action de code et de présenter simplement les actions imbriquées à la place. Lorsqu’un hôte a déjà un grand nombre d’actions de niveau supérieur à afficher, il doit envisager de ne pas mettre en évidence cette action, afin de limiter le nombre d’options présentées à l’utilisateur. Toutefois, s’il existe peu d’options à afficher à l’utilisateur, l’intéraction de cette action peut être utile, car elle permettrait à l’utilisateur de voir et de choisir l’une des options imbriquées avec moins d’étapes. Pour créer un avec des CodeAction actions imbriquées, utilisez Create(String, ImmutableArray<CodeAction>, Boolean).
NestedActions	Actions enfants contenues dans ce CodeAction. Peut être présenté dans un hôte pour fournir plus d’actions de solution potentielles à un problème particulier. Pour créer un avec des CodeAction actions imbriquées, utilisez Create(String, ImmutableArray<CodeAction>, Boolean).
Priority	Priorité de cette action particulière dans un groupe d’autres actions. Les actions moins pertinentes doivent remplacer ce paramètre et spécifier une priorité inférieure afin que les actions plus importantes soient facilement accessibles à l’utilisateur. Retourne Default s’il n’est pas remplacé.
Tags	Balises descriptives de WellKnownTags. Ces balises peuvent influencer la façon dont l’élément est affiché.
Title	Titre court décrivant l’action qui peut apparaître dans un menu.

Méthodes

ComputeOperationsAsync(CancellationToken)	Remplacez cette méthode si vous souhaitez implémenter une CodeAction sous-classe qui inclut des personnalisées CodeActionOperation.
ComputeOperationsAsync(IProgress<CodeAnalysisProgress>, CancellationToken)	Remplacez cette méthode si vous souhaitez implémenter une CodeAction sous-classe qui inclut des personnalisées CodeActionOperation. Préférez remplacer cette méthode lorsque ComputeOperationsAsync(CancellationToken) le calcul est de longue durée et que la progression doit être affichée à l’utilisateur.
ComputePreviewOperationsAsync(CancellationToken)	Remplacez cette méthode si vous souhaitez implémenter un CodeAction qui a un ensemble d’opérations d’aperçu qui sont différentes des opérations produites par ComputeOperationsAsync(IProgress<CodeAnalysisProgress>, CancellationToken).
ComputePriority()	Calcule le CodeActionPriority groupe dans lequel cette action de code doit être présentée. Les valeurs juridiques que ce peut être doivent être comprises entre Lowest et High.
Create(String, Func<CancellationToken,Task<Document>>, String, CodeActionPriority)	Crée un CodeAction pour une modification d’un seul Document. Utilisez cette fabrique lorsque la modification est coûteuse à calculer et doit être différée jusqu’à la demande.
Create(String, Func<CancellationToken,Task<Document>>, String)	Crée un CodeAction pour une modification d’un seul Document. Utilisez cette fabrique lorsque la modification est coûteuse à calculer et doit être différée jusqu’à la demande.
Create(String, Func<CancellationToken,Task<Solution>>, String, CodeActionPriority)	Crée un CodeAction pour une modification de plusieurs au sein d’un DocumentSolution. Utilisez cette fabrique lorsque la modification est coûteuse à calculer et doit être différée jusqu’à la demande.
Create(String, Func<CancellationToken,Task<Solution>>, String)	Crée un CodeAction pour une modification de plusieurs au sein d’un DocumentSolution. Utilisez cette fabrique lorsque la modification est coûteuse à calculer et doit être différée jusqu’à la demande.
Create(String, Func<IProgress<CodeAnalysisProgress>,CancellationToken,Task<Document>>, String, CodeActionPriority)	Action produite par un CodeFixProvider ou un CodeRefactoringProvider.
Create(String, Func<IProgress<CodeAnalysisProgress>,CancellationToken,Task<Solution>>, String, CodeActionPriority)	Crée un CodeAction pour une modification de plusieurs au sein d’un DocumentSolution. Utilisez cette fabrique lorsque la modification est coûteuse à calculer et doit être différée jusqu’à la demande.
Create(String, ImmutableArray<CodeAction>, Boolean, CodeActionPriority)	Crée un CodeAction représentant un groupe d’actions de code.
Create(String, ImmutableArray<CodeAction>, Boolean)	Crée un CodeAction représentant un groupe d’actions de code.
GetChangedDocumentAsync(CancellationToken)	Calcule les modifications pour un seul document. Remplacez cette méthode si vous souhaitez implémenter une CodeAction sous-classe qui modifie un document unique. Remplacez GetChangedDocumentAsync(IProgress<CodeAnalysisProgress>, CancellationToken) pour signaler la progression lors du calcul des opérations.
GetChangedDocumentAsync(IProgress<CodeAnalysisProgress>, CancellationToken)	Calcule les modifications pour un seul document. Remplacez cette méthode si vous souhaitez implémenter une CodeAction sous-classe qui modifie un document unique. Préférez remplacer cette méthode lorsque GetChangedDocumentAsync(CancellationToken) le calcul est de longue durée et que la progression doit être affichée à l’utilisateur.
GetChangedSolutionAsync(CancellationToken)	Calcule toutes les modifications pour une solution entière. Remplacez cette méthode si vous souhaitez implémenter une CodeAction sous-classe qui modifie plusieurs documents. Remplacez GetChangedSolutionAsync(IProgress<CodeAnalysisProgress>, CancellationToken) pour signaler la progression lors du calcul des opérations.
GetChangedSolutionAsync(IProgress<CodeAnalysisProgress>, CancellationToken)	Calcule toutes les modifications pour une solution entière. Remplacez cette méthode si vous souhaitez implémenter une CodeAction sous-classe qui modifie plusieurs documents. Préférez remplacer cette méthode lorsque GetChangedSolutionAsync(CancellationToken) le calcul est de longue durée et que la progression doit être affichée à l’utilisateur.
GetOperationsAsync(CancellationToken)	Séquence d’opérations qui définissent l’action de code.
GetOperationsAsync(Solution, IProgress<CodeAnalysisProgress>, CancellationToken)	Séquence d’opérations qui définissent l’action de code.
GetPreviewOperationsAsync(CancellationToken)	Séquence d’opérations utilisée pour construire une préversion.
PostProcessAsync(IEnumerable<CodeActionOperation>, CancellationToken)	Appliquez les étapes de post-traitement à n’importe quel ApplyChangesOperation.
PostProcessChangesAsync(Document, CancellationToken)	Appliquer des étapes de post-traitement à un seul document : Réduction des nœuds annotés avec Annotation des nœuds de mise en forme annotés avec Annotation
PostProcessChangesAsync(Solution, CancellationToken)	Appliquez des étapes de post-traitement aux modifications de solution, telles que la mise en forme et la simplification.