Renamer.RenameDocumentAsync 方法

定義

命名空間:

Microsoft.CodeAnalysis.Rename

組件:

Microsoft.CodeAnalysis.Workspaces.dll

套件:

Microsoft.CodeAnalysis.Workspaces.Common v4.13.0

多載

RenameDocumentAsync(Document, DocumentRenameOptions, String, IReadOnlyList<String>, CancellationToken)	呼叫 以在檔資料夾中執行檔重新命名或變更。 傳回與所修改檔相關的其他程式碼變更，例如重新命名檔案中的符號。 每個變更都會在傳 ApplicableActions 回 的 中新增為 Renamer.RenameDocumentAction 。 每個動作可能會個別遇到錯誤，以防止它正確運作。 這些報告于 中 GetErrors(CultureInfo) 。 可能傳回的目前支援動作：
RenameDocumentAsync(Document, String, IReadOnlyList<String>, OptionSet, CancellationToken)	已淘汰. 呼叫 以在檔資料夾中執行檔重新命名或變更。 傳回與所修改檔相關的其他程式碼變更，例如重新命名檔案中的符號。 每個變更都會在傳 ApplicableActions 回 的 中新增為 Renamer.RenameDocumentAction 。 每個動作可能會個別遇到錯誤，以防止它正確運作。 這些報告于 中 GetErrors(CultureInfo) 。 可能傳回的目前支援動作：

RenameDocumentAsync(Document, DocumentRenameOptions, String, IReadOnlyList<String>, CancellationToken)

來源:

Renamer.cs

呼叫 以在檔資料夾中執行檔重新命名或變更。 傳回與所修改檔相關的其他程式碼變更，例如重新命名檔案中的符號。

每個變更都會在傳 ApplicableActions 回 的 中新增為 Renamer.RenameDocumentAction 。

每個動作可能會個別遇到錯誤，以防止它正確運作。 這些報告于 中 GetErrors(CultureInfo) 。

可能傳回的目前支援動作：

C#

public static System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Rename.Renamer.RenameDocumentActionSet> RenameDocumentAsync(Microsoft.CodeAnalysis.Document document, Microsoft.CodeAnalysis.Rename.DocumentRenameOptions options, string? newDocumentName, System.Collections.Generic.IReadOnlyList<string>? newDocumentFolders = default, System.Threading.CancellationToken cancellationToken = default);

參數

document

Document

要修改的檔

options

DocumentRenameOptions

用來設定符合檔案名稱之檔中所含類型重新命名的選項。

newDocumentName

String

檔的新名稱。 傳遞 Null 或相同的名稱，以保持不變。

newDocumentFolders

IReadOnlyList<String>

屬性的新資料夾 Folders 集

cancellationToken

CancellationToken

傳回

Task<RenameDocumentActionSet>

RenameDocumentAsync(Document, String, IReadOnlyList<String>, OptionSet, CancellationToken)

來源:

Renamer.cs

警告

Use overload taking RenameOptions

呼叫 以在檔資料夾中執行檔重新命名或變更。 傳回與所修改檔相關的其他程式碼變更，例如重新命名檔案中的符號。

每個變更都會在傳 ApplicableActions 回 的 中新增為 Renamer.RenameDocumentAction 。

每個動作可能會個別遇到錯誤，以防止它正確運作。 這些報告于 中 GetErrors(CultureInfo) 。

可能傳回的目前支援動作：

C#

[System.Obsolete("Use overload taking RenameOptions")]
public static System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Rename.Renamer.RenameDocumentActionSet> RenameDocumentAsync(Microsoft.CodeAnalysis.Document document, string? newDocumentName, System.Collections.Generic.IReadOnlyList<string>? newDocumentFolders = default, Microsoft.CodeAnalysis.Options.OptionSet? optionSet = default, System.Threading.CancellationToken cancellationToken = default);

參數

document

Document

要修改的檔

newDocumentName

String

檔的新名稱。 傳遞 Null 或相同的名稱，以保持不變。

newDocumentFolders

IReadOnlyList<String>

屬性的新資料夾 Folders 集

optionSet

OptionSet

cancellationToken

CancellationToken

傳回

Task<RenameDocumentActionSet>

屬性

ObsoleteAttribute