SymbolEditor.EditOneDeclarationAsync Method

Definition

Namespace:

Microsoft.CodeAnalysis.Editing

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.7.0

Overloads

EditOneDeclarationAsync(ISymbol, SymbolEditor+AsyncDeclarationEditAction, CancellationToken)	Enables editing the definition of one of the symbol's declarations. Partial types and methods may have more than one declaration.
EditOneDeclarationAsync(ISymbol, SymbolEditor+DeclarationEditAction, CancellationToken)	Enables editing the definition of one of the symbol's declarations. Partial types and methods may have more than one declaration.
EditOneDeclarationAsync(ISymbol, ISymbol, SymbolEditor+AsyncDeclarationEditAction, CancellationToken)	Enables editing the symbol's declaration where the member is also declared. Partial types and methods may have more than one declaration.
EditOneDeclarationAsync(ISymbol, ISymbol, SymbolEditor+DeclarationEditAction, CancellationToken)	Enables editing the symbol's declaration where the member is also declared. Partial types and methods may have more than one declaration.
EditOneDeclarationAsync(ISymbol, Location, SymbolEditor+AsyncDeclarationEditAction, CancellationToken)	Enables editing the definition of one of the symbol's declarations. Partial types and methods may have more than one declaration.
EditOneDeclarationAsync(ISymbol, Location, SymbolEditor+DeclarationEditAction, CancellationToken)	Enables editing the definition of one of the symbol's declarations. Partial types and methods may have more than one declaration.

EditOneDeclarationAsync(ISymbol, SymbolEditor+AsyncDeclarationEditAction, CancellationToken)

Source:

SymbolEditor.cs

Enables editing the definition of one of the symbol's declarations. Partial types and methods may have more than one declaration.

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol> EditOneDeclarationAsync (Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.Editing.SymbolEditor.AsyncDeclarationEditAction editAction, System.Threading.CancellationToken cancellationToken = default);

member this.EditOneDeclarationAsync : Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.Editing.SymbolEditor.AsyncDeclarationEditAction * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol>

Public Function EditOneDeclarationAsync (symbol As ISymbol, editAction As SymbolEditor.AsyncDeclarationEditAction, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ISymbol)

Parameters

symbol

ISymbol

The symbol to edit.

editAction

SymbolEditor.AsyncDeclarationEditAction

The action that makes edits to the declaration.

cancellationToken

CancellationToken

An optional CancellationToken.

Returns

Task<ISymbol>

The new symbol including the changes.

EditOneDeclarationAsync(ISymbol, SymbolEditor+DeclarationEditAction, CancellationToken)

Source:

SymbolEditor.cs

Enables editing the definition of one of the symbol's declarations. Partial types and methods may have more than one declaration.

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol> EditOneDeclarationAsync (Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.Editing.SymbolEditor.DeclarationEditAction editAction, System.Threading.CancellationToken cancellationToken = default);

member this.EditOneDeclarationAsync : Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.Editing.SymbolEditor.DeclarationEditAction * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol>

Public Function EditOneDeclarationAsync (symbol As ISymbol, editAction As SymbolEditor.DeclarationEditAction, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ISymbol)

Parameters

symbol

ISymbol

The symbol to edit.

editAction

SymbolEditor.DeclarationEditAction

The action that makes edits to the declaration.

cancellationToken

CancellationToken

An optional CancellationToken.

Returns

Task<ISymbol>

The new symbol including the changes.

EditOneDeclarationAsync(ISymbol, ISymbol, SymbolEditor+AsyncDeclarationEditAction, CancellationToken)

Source:

SymbolEditor.cs

Enables editing the symbol's declaration where the member is also declared. Partial types and methods may have more than one declaration.

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol> EditOneDeclarationAsync (Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.ISymbol member, Microsoft.CodeAnalysis.Editing.SymbolEditor.AsyncDeclarationEditAction editAction, System.Threading.CancellationToken cancellationToken = default);

member this.EditOneDeclarationAsync : Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.Editing.SymbolEditor.AsyncDeclarationEditAction * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol>

Public Function EditOneDeclarationAsync (symbol As ISymbol, member As ISymbol, editAction As SymbolEditor.AsyncDeclarationEditAction, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ISymbol)

Parameters

symbol

ISymbol

The symbol to edit.

member

ISymbol

A symbol whose declaration is contained within one of the primary symbol's declarations.

editAction

SymbolEditor.AsyncDeclarationEditAction

The action that makes edits to the declaration.

cancellationToken

CancellationToken

An optional CancellationToken.

Returns

Task<ISymbol>

The new symbol including the changes.

EditOneDeclarationAsync(ISymbol, ISymbol, SymbolEditor+DeclarationEditAction, CancellationToken)

Source:

SymbolEditor.cs

Enables editing the symbol's declaration where the member is also declared. Partial types and methods may have more than one declaration.

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol> EditOneDeclarationAsync (Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.ISymbol member, Microsoft.CodeAnalysis.Editing.SymbolEditor.DeclarationEditAction editAction, System.Threading.CancellationToken cancellationToken = default);

member this.EditOneDeclarationAsync : Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.Editing.SymbolEditor.DeclarationEditAction * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol>

Public Function EditOneDeclarationAsync (symbol As ISymbol, member As ISymbol, editAction As SymbolEditor.DeclarationEditAction, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ISymbol)

Parameters

symbol

ISymbol

The symbol to edit.

member

ISymbol

A symbol whose declaration is contained within one of the primary symbol's declarations.

editAction

SymbolEditor.DeclarationEditAction

The action that makes edits to the declaration.

cancellationToken

CancellationToken

An optional CancellationToken.

Returns

Task<ISymbol>

The new symbol including the changes.

EditOneDeclarationAsync(ISymbol, Location, SymbolEditor+AsyncDeclarationEditAction, CancellationToken)

Source:

SymbolEditor.cs

Enables editing the definition of one of the symbol's declarations. Partial types and methods may have more than one declaration.

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol> EditOneDeclarationAsync (Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.Location location, Microsoft.CodeAnalysis.Editing.SymbolEditor.AsyncDeclarationEditAction editAction, System.Threading.CancellationToken cancellationToken = default);

member this.EditOneDeclarationAsync : Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.Location * Microsoft.CodeAnalysis.Editing.SymbolEditor.AsyncDeclarationEditAction * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol>

Public Function EditOneDeclarationAsync (symbol As ISymbol, location As Location, editAction As SymbolEditor.AsyncDeclarationEditAction, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ISymbol)

Parameters

symbol

ISymbol

The symbol to edit.

location

Location

A location within one of the symbol's declarations.

editAction

SymbolEditor.AsyncDeclarationEditAction

The action that makes edits to the declaration.

cancellationToken

CancellationToken

An optional CancellationToken.

Returns

Task<ISymbol>

The new symbol including the changes.

EditOneDeclarationAsync(ISymbol, Location, SymbolEditor+DeclarationEditAction, CancellationToken)

Source:

SymbolEditor.cs

Enables editing the definition of one of the symbol's declarations. Partial types and methods may have more than one declaration.

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol> EditOneDeclarationAsync (Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.Location location, Microsoft.CodeAnalysis.Editing.SymbolEditor.DeclarationEditAction editAction, System.Threading.CancellationToken cancellationToken = default);

member this.EditOneDeclarationAsync : Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.Location * Microsoft.CodeAnalysis.Editing.SymbolEditor.DeclarationEditAction * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.ISymbol>

Public Function EditOneDeclarationAsync (symbol As ISymbol, location As Location, editAction As SymbolEditor.DeclarationEditAction, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ISymbol)

Parameters

symbol

ISymbol

The symbol to edit.

location

Location

A location within one of the symbol's declarations.

editAction

SymbolEditor.DeclarationEditAction

The action that makes edits to the declaration.

cancellationToken

CancellationToken

An optional CancellationToken.

Returns

Task<ISymbol>

The new symbol including the changes.