<!doctype html>
< html class = "default no-js" lang = "zh-CN" >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< title > RenameProvider | VS Code API 中文文档< / title >
< meta name = "description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta name = "author" content = "洛竹" >
< meta name = "copyright" content = "洛竹" >
< meta property = "og:title" content = "Vscode Api 中文文档" / >
< meta property = "og:type" content = "docs" >
< meta property = "og:image" content = "https://code.visualstudio.com/favicon.ico" / >
< meta property = "og:url" content = "https://vscode-api-cn.js.org/index.html" >
< meta property = "og:site_name" content = "Vscode Api 中文文档" >
< meta property = "og:description" content = "VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API， >
< meta property = "article:tag" content = "vscode api" >
< meta property = "article:tag" content = "vscode api 中文文档" >
< meta property = "article:tag" content = "vscode 插件" >
< meta property = "article:tag" content = "vscode 插件开发" >
< meta property = "article:tag" content = "vscode VS Code API 中文文档" >
< meta property = "article:tag" content = "vscode RenameProvider" >
< meta name = "viewport" content = "width=device-width, initial-scale=1, viewport-fit=cover" >
< link rel = "shortcut icon" href = "https://code.visualstudio.com/favicon.ico" sizes = "128x128" >
< link rel = 'canonical' href = 'https://vscode-api-cn.js.org/interfaces/vscode.RenameProvider.html' / >
< link rel = "stylesheet" href = "../assets/css/main.css" >
< script async src = "../assets/js/search.js" id = "search-script" > < / script >
< meta name = "baidu-site-verification" content = "codeva-3X25ouCcqY" / >
< script async src = "https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin = "anonymous" > < / script >
<!-- Google tag (gtag.js) -->
< script async src = "https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1" > < / script >
< script >
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-T4TRRS1LB1');
< / script >
< style >
.container-main {
padding-bottom: 50px;
}
< / style >
< / head >
< body >
< header >
< div class = "tsd-page-toolbar" >
< div class = "container" >
< div class = "table-wrap" >
< div class = "table-cell" id = "tsd-search" data-index = "../assets/js/search.json" data-base = ".." >
< div class = "field" >
< label for = "tsd-search-field" class = "tsd-widget search no-caption" > Search< / label >
< input id = "tsd-search-field" type = "text" / >
< / div >
< ul class = "results" >
< li class = "state loading" > Preparing search index...< / li >
< li class = "state failure" > The search index is not available< / li >
< / ul >
< a href = "../index.html" class = "title" > VS Code API 中文文档< / a >
< / div >
< div class = "table-cell" id = "tsd-widgets" >
< div id = "tsd-filter" >
< a href = "#" class = "tsd-widget options no-caption" data-toggle = "options" > Options< / a >
< div class = "tsd-filter-group" >
< div class = "tsd-select" id = "tsd-filter-visibility" >
< span class = "tsd-select-label" > All< / span >
< ul class = "tsd-select-list" >
< li data-value = "public" > Public< / li >
< li data-value = "protected" > Public/Protected< / li >
< li data-value = "private" class = "selected" > All< / li >
< / ul >
< / div >
< input type = "checkbox" id = "tsd-filter-inherited" checked / >
< label class = "tsd-widget" for = "tsd-filter-inherited" > Inherited< / label >
< input type = "checkbox" id = "tsd-filter-externals" checked / >
< label class = "tsd-widget" for = "tsd-filter-externals" > Externals< / label >
< / div >
< / div >
< a href = "#" class = "tsd-widget menu no-caption" data-toggle = "menu" > Menu< / a >
< / div >
< / div >
< / div >
< / div >
< div class = "tsd-page-title" >
< div class = "container" >
< ul class = "tsd-breadcrumb" >
< li >
< a href = "../modules.html" > VS Code API 中文文档< / a >
< / li >
< li >
< a href = "../modules/vscode.html" > vscode< / a >
< / li >
< li >
< a href = "vscode.RenameProvider.html" > RenameProvider< / a >
< / li >
< / ul >
< h1 > Interface RenameProvider< / h1 >
< / div >
< / div >
< / header >
< div class = "container container-main" >
< div class = "row" >
< div class = "col-8 col-content" >
< ins class = "adsbygoogle" style = "display:block" data-ad-client = "ca-pub-5641491107630454" data-ad-slot = "1206633556" data-page-url = "https://nablepart.com" data-override-format = "true" data-ad-format = "auto" data-full-width-responsive = "true" > < / ins >
< section class = "tsd-panel tsd-comment" >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > The rename provider interface defines the contract between extensions and
the < a href = "https://code.visualstudio.com/docs/editor/editingevolved#_rename-symbol" > rename< / a > -feature.< / p >
< / div >
< / div >
< / section >
< section class = "tsd-panel tsd-hierarchy" >
< h3 > 层级< / h3 >
< ul class = "tsd-hierarchy" >
< li >
< span class = "target" > RenameProvider< / span >
< / li >
< / ul >
< / section >
< section class = "tsd-panel-group tsd-index-group" >
< h2 > 索引< / h2 >
< section class = "tsd-panel tsd-index-panel" >
< div class = "tsd-index-content" >
< section class = "tsd-index-section " >
< h3 > Methods（ ） < / h3 >
< ul class = "tsd-index-list" >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.RenameProvider.html#provideRenameEdits" class = "tsd-kind-icon" > provide< wbr > Rename< wbr > Edits< / a > < / li >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < a href = "vscode.RenameProvider.html#prepareRename" class = "tsd-kind-icon" > prepare< wbr > Rename< / a > < / li >
< / ul >
< / section >
< / div >
< / section >
< / section >
< section class = "tsd-panel-group tsd-member-group " >
< h2 > Methods（ ） < / h2 >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "provideRenameEdits" class = "tsd-anchor" > < / a >
< h3 > provide< wbr > Rename< wbr > Edits< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > provide< wbr > Rename< wbr > Edits< span class = "tsd-signature-symbol" > (< / span > document< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.TextDocument.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextDocument< / a > , position< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > , newName< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > , token< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.CancellationToken.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CancellationToken< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../modules/vscode.html#ProviderResult" class = "tsd-signature-type" data-tsd-kind = "Type alias" > ProviderResult< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../classes/vscode.WorkspaceEdit.html" class = "tsd-signature-type" data-tsd-kind = "Class" > WorkspaceEdit< / a > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/3e14418/vscode.d.ts#L3430" > vscode.d.ts:3430< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Provide an edit that describes changes that have to be made to one
or many resources to rename a symbol to a different name.< / p >
< / div >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > document: < a href = "vscode.TextDocument.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextDocument< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The document in which the command was invoked.< / p >
< / div >
< / li >
< li >
< h5 > position: < a href = "../classes/vscode.Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The position at which the command was invoked.< / p >
< / div >
< / li >
< li >
< h5 > newName: < span class = "tsd-signature-type" > string< / span > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The new name of the symbol. If the given name is not valid, the provider must return a rejected promise.< / p >
< / div >
< / li >
< li >
< h5 > token: < a href = "vscode.CancellationToken.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CancellationToken< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A cancellation token.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../modules/vscode.html#ProviderResult" class = "tsd-signature-type" data-tsd-kind = "Type alias" > ProviderResult< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../classes/vscode.WorkspaceEdit.html" class = "tsd-signature-type" data-tsd-kind = "Class" > WorkspaceEdit< / a > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > A workspace edit or a thenable that resolves to such. The lack of a result can be
signaled by returning < code > undefined< / code > or < code > null< / code > .< / p >
< / li >
< / ul >
< / section >
< section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface" >
< a name = "prepareRename" class = "tsd-anchor" > < / a >
< h3 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > prepare< wbr > Rename< / h3 >
< ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-interface" >
< li class = "tsd-signature tsd-kind-icon" > prepare< wbr > Rename< span class = "tsd-signature-symbol" > (< / span > document< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.TextDocument.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextDocument< / a > , position< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > , token< span class = "tsd-signature-symbol" > : < / span > < a href = "vscode.CancellationToken.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CancellationToken< / a > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "../modules/vscode.html#ProviderResult" class = "tsd-signature-type" data-tsd-kind = "Type alias" > ProviderResult< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > range< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > ; < / span > placeholder< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > > < / span > < / li >
< / ul >
< ul class = "tsd-descriptions" >
< li class = "tsd-description" >
< aside class = "tsd-sources" >
< ul >
< li > Defined in < a href = "https://github.com/youngjuning/vscode-api-cn.js.org/blob/3e14418/vscode.d.ts#L3445" > vscode.d.ts:3445< / a > < / li >
< / ul >
< / aside >
< div class = "tsd-comment tsd-typography" >
< div class = "lead" >
< p > Optional function for resolving and validating a position < em > before< / em > running rename. The result can
be a range or a range and a placeholder text. The placeholder text should be the identifier of the symbol
which is being renamed - when omitted the text in the returned range is used.< / p >
< / div >
< p > *Note: * This function should throw an error or return a rejected thenable when the provided location
doesn' t allow for a rename.< / p >
< / div >
< h4 class = "tsd-parameters-title" > Parameters< / h4 >
< ul class = "tsd-parameters" >
< li >
< h5 > document: < a href = "vscode.TextDocument.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > TextDocument< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The document in which rename will be invoked.< / p >
< / div >
< / li >
< li >
< h5 > position: < a href = "../classes/vscode.Position.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Position< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > The position at which rename will be invoked.< / p >
< / div >
< / li >
< li >
< h5 > token: < a href = "vscode.CancellationToken.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CancellationToken< / a > < / h5 >
< div class = "tsd-comment tsd-typography" >
< p > A cancellation token.< / p >
< / div >
< / li >
< / ul >
< h4 class = "tsd-returns-title" > Returns < a href = "../modules/vscode.html#ProviderResult" class = "tsd-signature-type" data-tsd-kind = "Type alias" > ProviderResult< / a > < span class = "tsd-signature-symbol" > < < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-symbol" > { < / span > range< span class = "tsd-signature-symbol" > : < / span > < a href = "../classes/vscode.Range.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Range< / a > < span class = "tsd-signature-symbol" > ; < / span > placeholder< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 >
< p > The range or range and placeholder text of the identifier that is to be renamed. The lack of a result can signaled by returning < code > undefined< / code > or < code > null< / code > .< / p >
< / li >
< / ul >
< / section >
< / section >
< ins class = "adsbygoogle" style = "display:block" data-ad-client = "ca-pub-5641491107630454" data-ad-slot = "5596588097" data-page-url = "https://nablepart.com" data-override-format = "true" data-ad-format = "auto" data-full-width-responsive = "true" > < / ins >
< / div >
< div class = "col-4 col-menu menu-sticky-wrap menu-highlight" >
< nav class = "tsd-navigation primary" >
< ul >
< li class = " " >
< a href = "../modules.html" > Exports< / a >
< / li >
< li class = "current tsd-kind-namespace" >
< a href = "../modules/vscode.html" > vscode< / a >
< ul >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.authentication.html" > authentication< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.commands.html" > commands< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.comments.html" > comments< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.debug.html" > debug< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.env.html" > env< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.extensions.html" > extensions< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.languages.html" > languages< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.notebooks.html" > notebooks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.scm.html" > scm< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tasks.html" > tasks< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.tests.html" > tests< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.window.html" > window< / a >
< / li >
< li class = " tsd-kind-namespace tsd-parent-kind-namespace" >
< a href = "../modules/vscode.workspace.html" > workspace< / a >
< / li >
< / ul >
< / li >
< / ul >
< / nav >
< nav class = "tsd-navigation secondary menu-sticky" >
< div style = "width: 200px" >
< script async = "async" type = "text/javascript" id = "clstr_globe" src = "//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4" > < / script >
< / div >
< ul class = "before-current" >
< / ul >
< ul class = "current" >
< li class = "current tsd-kind-interface tsd-parent-kind-namespace" >
< a href = "vscode.RenameProvider.html" class = "tsd-kind-icon" > Rename< wbr > Provider< / a >
< ul >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.RenameProvider.html#provideRenameEdits" class = "tsd-kind-icon" > provide< wbr > Rename< wbr > Edits< / a >
< / li >
< li class = " tsd-kind-method tsd-parent-kind-interface" >
< a href = "vscode.RenameProvider.html#prepareRename" class = "tsd-kind-icon" > prepare< wbr > Rename< / a >
< / li >
< / ul >
< / li >
< / ul >
< ul class = "after-current" >
< ins class = "adsbygoogle" style = "display:block" data-ad-client = "ca-pub-5641491107630454" data-ad-slot = "5702084207" data-page-url = "https://nablepart.com" data-override-format = "true" data-ad-format = "auto" data-full-width-responsive = "true" > < / ins >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< footer class = "with-border-bottom" >
< div class = "container" >
< h2 > 图例< / h2 >
< div class = "tsd-legend-group" >
< ul class = "tsd-legend" >
< li class = "tsd-kind-method tsd-parent-kind-interface" > < span class = "tsd-kind-icon" > Method< / span > < / li >
< / ul >
< / div >
< / div >
< / footer >
< div class = "container tsd-generator" >
< p > 友链：< a href = "https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target = "_blank" > VS Code 中文文档< / a > | < a href = "https://code.visualstudio.com/docs" target = "_blank" > VS Code 官网文档< / a > | < a href = "https://marketplace.visualstudio.com/" target = "_blank" > VS Code 扩展市场< / a > < / p >
< p > Generated by < a href = "https://typedoc.org/" target = "_blank" > TypeDoc< / a > . Maintained by < a href = "https://youngjuning.js.org" target = "_blank" > 洛竹< / a > < / p >
< / div >
< div class = "overlay" > < / div >
< script src = "../assets/js/main.js" > < / script >
< script > ( adsbygoogle = window . adsbygoogle || [ ] ) . push ( { 'enable_page_level_ads' : true } ) ; < / script >
< / body >
< / html >
