Find2 Interface
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Dá suporte a operações de localização de texto geral no ambiente para documentos e arquivos.
public interface class Find2 : EnvDTE::Find
public interface class Find2 : EnvDTE::Find
__interface Find2 : EnvDTE::Find
[System.Runtime.InteropServices.Guid("01568308-5B2A-4F30-8D0A-E10EE0F28F4A")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Find2 : EnvDTE.Find
[<System.Runtime.InteropServices.Guid("01568308-5B2A-4F30-8D0A-E10EE0F28F4A")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Find2 = interface
interface Find
Public Interface Find2
Implements Find
- Atributos
- Implementações
Exemplos
Sub FindExample()
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
' Set the find options.
objFind.Action = vsFindAction.vsFindActionReplaceAll
objFind.Backwards = False
objFind.FilesOfType = "*.txt"
objFind.FindWhat = "test"
objFind.KeepModifiedDocumentsOpen = True
objFind.MatchCase = False
objFind.MatchInHiddenText = False
objFind.MatchWholeWord = True
objFind.PatternSyntax = vsFindPatternSyntax.vsFindPatternSyntaxLiteral
objFind.ReplaceWith = "NEW THING"
objFind.ResultsLocation = vsFindResultsLocation.vsFindResultsNone
objFind.SearchPath = "c:\temp"
objFind.SearchSubfolders = False
objFind.Target = vsFindTarget.vsFindTargetCurrentDocument
' Perform the Find operation.
objFind.Execute()
End Sub
Comentários
O Find objeto permite que você localize e substitua texto em locais do ambiente que dão suporte a tais operações, como o editor de código.
Ele destina-se principalmente a fins de gravação de macro. O mecanismo de gravação de macro do editor usa Find em vez de TextSelection.FindPattern para que você possa descobrir a funcionalidade de localização global. Além disso, geralmente é mais útil do que usar o TextSelection objeto para essas operações como find-in-files.
O estado global de localização do ambiente do Visual Studio é compartilhado entre todas as suas ferramentas e fornece recursos de pesquisa. Por exemplo, todos os elementos do Visual Studio compartilham o histórico dos padrões de pesquisa usados durante uma sessão e se a próxima Find operação para documentos abertos deve ser encaminhada ou inversa. As Find Propriedades do objeto interagem com e rastreiam o estado de localização global. Ao definir propriedades no Find objeto, você também define o estado de localização global. Se os usuários executarem uma Find operação por meio do ambiente, o Find objeto refletirá o tipo de pesquisa que executou. Como o código de automação é executado de forma síncrona com o thread da interface do usuário do ambiente, você não precisa se preocupar em definir algumas propriedades e fazer com que o usuário execute uma pesquisa antes de poder chamar o Execute .
O Execute método executa uma Find operação com base nas configurações do Find objeto. Você também pode passar argumentos para o FindReplace método para executar uma pesquisa sem afetar o estado de localização global. É importante que os clientes de automação possam executar uma pesquisa sem afetar o estado de localização global ou interferir no modelo do usuário final do estado do ambiente.
Propriedades
| Action |
Obtém ou define como localizar, como Localizar próxima correspondência, localizar tudo, substituir e localizar e assim por diante. |
| Backwards |
Obtém ou define um valor que indica se a pesquisa é executada retroativamente a partir da posição atual. |
| DTE |
Obtém o objeto de extensibilidade de nível superior. |
| FilesOfType |
Obtém ou define a extensão de arquivo para os arquivos a serem pesquisados. |
| FindWhat |
Obtém ou define o texto ou o padrão a ser localizado. |
| KeepModifiedDocumentsOpen |
Obtém ou define um valor que indica se os documentos modificados permanecem ou não abertos após uma operação de substituição. |
| MatchCase |
Obtém ou define um valor que indica se a pesquisa diferencia maiúsculas de minúsculas. |
| MatchInHiddenText |
Obtém ou define um valor que indica se o texto oculto está incluído na pesquisa. |
| MatchWholeWord |
Obtém ou define um valor que indica se a pesquisa corresponde somente a palavras inteiras. |
| Parent |
Obtém o objeto pai imediato de um Find objeto. |
| PatternSyntax |
Obtém ou define a sintaxe usada para especificar o padrão de pesquisa. |
| ReplaceWith |
Obtém ou define o texto de substituição para uma operação de substituição. |
| ResultsLocation |
Obtém ou define o local onde os resultados são mostrados em uma operação de pesquisa em massa. |
| SearchPath |
Obtém ou define uma lista de diretórios a serem usados para uma operação de localização em arquivos. |
| SearchSubfolders |
Obtém ou define um valor que indica se as subpastas estão incluídas em uma operação de pesquisa. |
| Target |
Obtém ou define o destino da operação de pesquisa, como todos os documentos abertos, arquivos, o documento ativo e assim por diante. |
| WaitForFindToComplete |
Obtém ou define um valor que indica se um resultado de localização é retornado antes de continuar a execução. |
Métodos
| Execute() |
Executa uma pesquisa com base nas opções definidas para o Find objeto. |
| FindReplace(vsFindAction, String, Int32, String, vsFindTarget, String, String, vsFindResultsLocation) |
Executa uma operação de localização ou substituição com base nos argumentos para o método, sem afetar as opções definidas para o Find objeto. |