EditPoint.FindPattern - метод

Статья
05/17/2015

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

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

Синтаксис

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

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
)

abstract FindPattern : 
        Pattern:string * 
        vsFindOptionsValue:int * 
        EndPoint:EditPoint byref * 
        Tags:TextRanges byref -> bool

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

Параметры

Pattern
Тип: String

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

vsFindOptionsValue
Тип: Int32

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

EndPoint
Тип: EnvDTE.EditPoint%

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

Tags
Тип: EnvDTE.TextRanges%

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

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

Тип: 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

Безопасность платформы .NET Framework

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

См. также

Ссылки

EditPoint Интерфейс

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

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