Find.FindReplace 方法

项目
09/04/2008

更新：2007 年 11 月

根据该方法的参数执行“查找”或“替换”操作，不影响为 Find 设置的选项。

命名空间： EnvDTE
程序集： EnvDTE（在 EnvDTE.dll 中）

语法

声明
Function FindReplace ( _
    Action As vsFindAction, _
    FindWhat As String, _
    vsFindOptionsValue As Integer, _
    ReplaceWith As String, _
    Target As vsFindTarget, _
    SearchPath As String, _
    FilesOfType As String, _
    ResultsLocation As vsFindResultsLocation _
) As vsFindResult
用法
Dim instance As Find
Dim Action As vsFindAction
Dim FindWhat As String
Dim vsFindOptionsValue As Integer
Dim ReplaceWith As String
Dim Target As vsFindTarget
Dim SearchPath As String
Dim FilesOfType As String
Dim ResultsLocation As vsFindResultsLocation
Dim returnValue As vsFindResult

returnValue = instance(Action, FindWhat, _
    vsFindOptionsValue, ReplaceWith, _
    Target, SearchPath, FilesOfType, _
    ResultsLocation)

vsFindResult FindReplace(
    vsFindAction Action,
    string FindWhat,
    int vsFindOptionsValue,
    string ReplaceWith,
    vsFindTarget Target,
    string SearchPath,
    string FilesOfType,
    vsFindResultsLocation ResultsLocation
)

vsFindResult FindReplace(
    [InAttribute] vsFindAction Action, 
    [InAttribute] String^ FindWhat, 
    [InAttribute] int vsFindOptionsValue, 
    [InAttribute] String^ ReplaceWith, 
    [InAttribute] vsFindTarget Target, 
    [InAttribute] String^ SearchPath, 
    [InAttribute] String^ FilesOfType, 
    [InAttribute] vsFindResultsLocation ResultsLocation
)

function FindReplace(
    Action : vsFindAction, 
    FindWhat : String, 
    vsFindOptionsValue : int, 
    ReplaceWith : String, 
    Target : vsFindTarget, 
    SearchPath : String, 
    FilesOfType : String, 
    ResultsLocation : vsFindResultsLocation
) : vsFindResult

参数

Action
类型：EnvDTE.vsFindAction

必选。指示要执行的搜索操作的 vsFindAction 常数。

FindWhat
类型：System.String

可选项。搜索的模式。默认值为 ""。

vsFindOptionsValue
类型：System.Int32

可选项。一个位域，指示要执行的搜索的几个方位。
- 对于匹配，您可以提供 vsFindOptionsMatchCase、vsFindOptionsMatchWholeWord 或 vsFindOptionsMatchInHiddenText。
- 可以为文件、项目和解决方案目标打开的标志是 vsFindOptionsSearchSubfolders 和 vsFindOptionsKeepModifiedDocumentsOpen。
- FindWhat 属性语法的标志是 vsFindOptionsRegularExpression 和 vsFindOptionsWildcards。如果这两项都未提供，将逐字匹配 FindWhat。
vsFindOptionsValue 默认为关闭所有标志。

ReplaceWith
类型：System.String

可选项。当 Action 被设置为 vsFindActionReplace 或 vsFindActionReplaceAll 时，用于替换匹配文本的字符串。默认值为 ""。

Target
类型：EnvDTE.vsFindTarget

可选项。一个 vsFindTarget 常数，指示搜索操作的目标（如当前的文档或在文件中查找）。

SearchPath
类型：System.String

可选项。要搜索的以分号分隔的目录和文件名列表。默认值为 ""。

FilesOfType
类型：System.String

可选项。要包含在搜索中的以分号分隔的文件类型列表。忽略在指定的目标中遇到的其他文件类型。默认值为 ""，表示搜索所有的文件。

ResultsLocation
类型：EnvDTE.vsFindResultsLocation

可选项。一个 vsFindResultsLocation 常数。有两个可能显示 Find 结果的结果列表。可以在不覆盖第一次搜索结果的情况下执行两次搜索。使用 ResultsLocation，可以确定放置 Find 结果的结果列表。

返回值

类型：EnvDTE.vsFindResult

一个 vsFindResult 常数。

示例

Sub FindReplaceExample()
   Dim objTextDoc As TextDocument
   Dim objEditPt As EditPoint
   Dim iCtr As Integer
   Dim objFind As Find

   ' Create a new text file.
   DTE.ItemOperations.NewFile("General\Text File")

   ' Get a handle to the new document and create an EditPoint.
   objTextDoc = DTE.ActiveDocument.Object("TextDocument")
   objEditPt = objTextDoc.StartPoint.CreateEditPoint
   objFind = objTextDoc.DTE.Find

   ' Insert ten lines of text.
   For iCtr = 1 To 10
      objEditPt.Insert("This is a test." & Chr(13))
   Next iCtr
   objEditPt.StartOfDocument()
   objFind.FindReplace(vsFindAction.vsFindActionReplaceAll, "test", vsFindOptions.vsFindOptionsMatchWholeWord, "NEW THING", vsFindTarget.vsFindTargetOpenDocuments, , , vsFindResultsLocation.vsFindResultsNone)
End Sub