Renamer.RenameDocumentActionSet Class

Definition

Namespace:

Microsoft.CodeAnalysis.Rename

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.13.0

Source:

Renamer.RenameDocumentActionSet.cs

Information about rename document calls that allows them to be applied as individual actions. Actions are individual units of work that can change the contents of one or more document in the solution. Even if the ApplicableActions is empty, the document metadata will still be updated by calling UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken)

To apply all actions use UpdateSolutionAsync(Solution, CancellationToken), or use a subset of the actions by calling UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken). Actions can be applied in any order. Each action has a description of the changes that it will apply that can be presented to a user.

C#

public sealed class Renamer.RenameDocumentActionSet

Inheritance

Object

Renamer.RenameDocumentActionSet

Properties

ApplicableActions

All applicable actions computed for the action. Action set may be empty, which represents updates to document contents rather than metadata. Document metadata will still not be updated unless UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken) is called.

Methods

UpdateSolutionAsync(Solution, CancellationToken)	Same as calling UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken) with ApplicableActions as the argument
UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken)	Applies each Renamer.RenameDocumentAction in order and returns the final solution. All actions must be contained in ApplicableActions

Applies to