Find2 - интерфейс

Статья
08/11/2011

Поддерживает общие операции Find для текста в документах и файлах среды.

Пространство имен: EnvDTE80
Сборка: EnvDTE80 (в EnvDTE80.dll)

Синтаксис

'Декларация
<GuidAttribute("01568308-5B2A-4F30-8D0A-E10EE0F28F4A")> _
Public Interface Find2 _
    Inherits Find

[GuidAttribute("01568308-5B2A-4F30-8D0A-E10EE0F28F4A")]
public interface Find2 : Find

[GuidAttribute(L"01568308-5B2A-4F30-8D0A-E10EE0F28F4A")]
public interface class Find2 : Find

[<GuidAttribute("01568308-5B2A-4F30-8D0A-E10EE0F28F4A")>]
type Find2 =  
    interface
        interface Find
    end

public interface Find2 extends Find

Тип Find2 предоставляет следующие члены.

Свойства

	Имя	Описание
	Action	(Унаследовано от Find.)
	Action	Возвращает или задает способы поиска (найти далее, соблюдать регистр, найти все, заменить и найти и т. д.).
	Backwards	(Унаследовано от Find.)
	Backwards	Указывает, осуществляется ли поиск по документу в обратном направлении от текущей позиции, или получает информацию об этом.
	DTE	(Унаследовано от Find.)
	DTE	Возвращает объект расширения верхнего уровня.
	FilesOfType	(Унаследовано от Find.)
	FilesOfType	Задает или получает расширение файлов, в которых осуществляется поиск.
	FindWhat	(Унаследовано от Find.)
	FindWhat	Возвращает или задает искомый текст или шаблон.
	KeepModifiedDocumentsOpen	(Унаследовано от Find.)
	KeepModifiedDocumentsOpen	Указывает, остаются ли измененные документы открытыми после того, как имела место операция замены, или получает информацию об этом.
	MatchCase	(Унаследовано от Find.)
	MatchCase	Возвращает или задает значение, указывающее, учитывается ли при поиске регистр.
	MatchInHiddenText	(Унаследовано от Find.)
	MatchInHiddenText	Возвращает или задает значение, указывающее, включается ли в поиск скрытый текст.
	MatchWholeWord	(Унаследовано от Find.)
	MatchWholeWord	Возвращает или задает значение, указывающее, производится ли поиск только по точным совпадениям слов.
	Parent	(Унаследовано от Find.)
	Parent	Возвращает текущий родительский объект для объекта Find.
	PatternSyntax	(Унаследовано от Find.)
	PatternSyntax	Задает или возвращает синтаксис, который используется при указании шаблона поиска.
	ReplaceWith	(Унаследовано от Find.)
	ReplaceWith	Возвращает или задает текст, на который осуществляется замещение при выполнении операции замещения.
	ResultsLocation	(Унаследовано от Find.)
	ResultsLocation	Возвращает или задает место отображения результатов во время операции массового поиска.
	SearchPath	(Унаследовано от Find.)
	SearchPath	Возвращает или задает список каталогов, которые будут использоваться при выполнении операции поиска в файлах.
	SearchSubfolders	(Унаследовано от Find.)
	SearchSubfolders	Указывает, будет ли во время проведения операции поиска осуществляться поиск во вложенных папках, или получает информацию об этом.
	Target	(Унаследовано от Find.)
	Target	Возвращает или задает целевой объект операции поиска, например, все открытые документы, файлы, активный документ и т. д.
	WaitForFindToComplete	Возвращает или задает значение, указывающее, возвращаются ли результаты поиска до того, как продолжить выполнение.

В начало страницы

Методы

	Имя	Описание
	Execute()	(Унаследовано от Find.)
	Execute()	Выполняет поиск на основе параметров, заданных для объекта Find.
	FindReplace(vsFindAction, String, Int32, String, vsFindTarget, String, String, vsFindResultsLocation)	(Унаследовано от Find.)
	FindReplace(vsFindAction, String, Int32, String, vsFindTarget, String, String, vsFindResultsLocation)	Выполняет операции поиска или замены на основе аргументов метода. На параметры Find влияния не оказывает.

В начало страницы

Заметки

Объект Find позволяет выполнять поиск и замену текста в компонентах среды, поддерживающих подобные операции, например в редакторе кода.

Этот объект предназначен главным образом для использования при записи макросов. В механизме записи макросов редактора используется класс Find вместо TextSelection.FindPattern, что обеспечивает доступ к функциям глобального поиска. К тому же этот объект эффективнее объекта TextSelection в таких операциях, как поиск в файлах.

В среде Visual Studio поддерживается глобальное состояние поиска, которое используется всеми ее инструментами, предоставляющими возможности поиска. Например, все элементы Visual Studio совместно используют данные о шаблонах поиска, задействованных во время сеанса, а также индикатор требуемого направления просмотра (прямого или обратного) в очередной операции Find для открытых документов. Свойства объекта Find обеспечивают взаимодействие с глобальным состоянием поиска и отслеживание его изменений. Когда задаются свойства объекта Find, тем самым задается и глобальное состояние поиска. Если пользователь выполняет операцию Find с помощью среды, объект Find будет отражать вид выполненного поиска. Так как код автоматизации выполняется синхронно с потоком пользовательского интерфейса среды, это избавляет от необходимости задавать некоторые свойства и требовать от пользователя выполнения поиска перед вызовом Execute.

Метод Execute выполняет операцию Find на основе параметров объекта Find. Можно также передать аргументы в метод FindReplace, чтобы выполнить поиск, не затрагивая глобального состояния поиска. Важно, чтобы клиенты автоматизации имели возможность выполнить поиск, не влияя на глобальное состояние поиска и избегая конфликтов с моделью состояния среды конечного пользователя.

Примеры

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

См. также

Ссылки

EnvDTE80 - пространство имен

Поделиться через