EditPoint.FindPattern - метод

Статья
11/05/2008

Обновлен: Ноябрь 2007

Отыскивает соответствующий заданному шаблон в выделенном тексте.

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

Синтаксис

'Декларация
Function FindPattern ( _
    Pattern As String, _
    vsFindOptionsValue As Integer, _
    <OutAttribute> ByRef EndPoint As EditPoint, _
    <OutAttribute> ByRef Tags As TextRanges _
) As Boolean
'Применение
Dim instance As EditPoint
Dim Pattern As String
Dim vsFindOptionsValue As Integer
Dim EndPoint As EditPoint
Dim Tags As TextRanges
Dim returnValue As Boolean

returnValue = instance.FindPattern(Pattern, _
    vsFindOptionsValue, EndPoint, Tags)

bool FindPattern(
    string Pattern,
    int vsFindOptionsValue,
    out EditPoint EndPoint,
    out TextRanges Tags
)

bool FindPattern(
    [InAttribute] String^ Pattern, 
    [InAttribute] int vsFindOptionsValue, 
    [InAttribute] [OutAttribute] EditPoint^% EndPoint, 
    [InAttribute] [OutAttribute] TextRanges^% Tags
)

function FindPattern(
    Pattern : String, 
    vsFindOptionsValue : int, 
    EndPoint : EditPoint, 
    Tags : TextRanges
) : boolean

Параметры

Pattern
Тип: System.String
Обязательный. Текст, который необходимо найти.

vsFindOptionsValue
Тип: System.Int32
Необязательный компонент. Константа vsFindOptions, указывающая тип выполняемой операции поиска. Константное значение vsFindOptionsMatchInHiddenText неприменимо к методу, потому что FindPattern ищет по всему тексту, включая скрытый текст.

EndPoint
Тип: EnvDTE.EditPoint%
Необязательный компонент. Объект EditPoint, представляющий точку, которая должна быть перенесена в конец шаблона.

Tags
Тип: EnvDTE.TextRanges%
Необязательный компонент. Если шаблон является регулярным выражением, содержащим заключенные в теги подвыражения, аргумент Tags содержит коллекцию объектов TextRange, по одному для каждого подвыражения.

Возвращаемое значение

Тип: System.Boolean
true — если шаблон найден; false — в противном случае.

Заметки

FindPattern выполняет поиск по всему тексту(включая скрытый) для данного текстового шаблона от точки редактирования до конца документа. Один флаг указывает, начался ли поиск с начала документа. Шаблон может быть регулярным или иным выражением. Возвращаемое значение показывает, был ли шаблон найден. Если шаблон найден, точка редактирования перемещается в начало соответствующего ему текста. В противном случае ее место остается неизменным.

Если приведен параметр EndPoint и шаблон найден, FindPattern переносит точку конца в конец найденного шаблона.

Если шаблон является регулярным выражением и содержит заключенные в теги подвыражения, аргумент Tags возвращает коллекцию объектов TextRange, по одному для каждого подвыражения.

Примеры

Sub FindPatternExample()
   Dim objTextDoc As TextDocument
   Dim objEditPt As EditPoint, iCtr As Integer
        
   ' 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
        
   ' Insert ten lines of text.
   For iCtr = 1 To 10
      objeditpt.Insert("This is a test." & Chr(13))
   Next iCtr
   objEditPt.StartOfDocument()
   'Search for the word "test."
   If objeditpt.FindPattern("test") = True Then
      msgbox("Found the word.")
   End If
End Sub

Разрешения

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

EditPoint Интерфейс

EditPoint - члены

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

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