TextSelection.FindPattern - метод

Статья
08/11/2011

Выполняет поиск заданного шаблона с активной точки до конца документа.

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

Синтаксис

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

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

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

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

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

Параметры

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

vsFindOptionsValue
Тип: System.Int32
Одно из значений vsFindOptions.

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

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

Тип: System.Boolean
Логическое значение, возвращающее true, если шаблон найден, и false в противном случае.

Заметки

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

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

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

Примеры

Sub FindPatternExample()
   ' Before running this example, open a text document.
   Dim objSel As TextSelection = DTE.ActiveDocument.Selection

   ' Advance to the next Visual Basic function beginning or end by 
   ' searching for  "Sub" with white space before and after it.
   If objSel.FindPattern(":WhSub:Wh", vsFindOptions.vsFindOptionsRegularExpression) Then
      ' Select the entire line.
      objSel.SelectLine()
   End If
End Sub

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

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

См. также

Ссылки

TextSelection Интерфейс

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

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