EditPoint.ReplacePattern - метод

Статья
11/05/2008

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

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

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

Синтаксис

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

returnValue = instance.ReplacePattern(Point, _
    Pattern, Replace, vsFindOptionsValue, _
    Tags)

bool ReplacePattern(
    TextPoint Point,
    string Pattern,
    string Replace,
    int vsFindOptionsValue,
    out TextRanges Tags
)

bool ReplacePattern(
    [InAttribute] TextPoint^ Point, 
    [InAttribute] String^ Pattern, 
    [InAttribute] String^ Replace, 
    [InAttribute] int vsFindOptionsValue, 
    [InAttribute] [OutAttribute] TextRanges^% Tags
)

function ReplacePattern(
    Point : TextPoint, 
    Pattern : String, 
    Replace : String, 
    vsFindOptionsValue : int, 
    Tags : TextRanges
) : boolean

Параметры

Point
Тип: EnvDTE.TextPoint
Обязательный. Точка конца заданного диапазона текста. Точка редактирования и Point являются границами диапазона для выполнения замены.

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

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

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

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

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

Тип: System.Boolean
Возвращается значение true, если объект успешно заменен. В противном случае возвращается значение false.

Заметки

ReplacePattern ищет текст так же, как и FindPattern, с той разницей, что он ищет текст между точкой редактирования и аргументом Point. Чтобы искать и заменять по всему документу, используйте ReplacePattern. Коллекция Tags возвращает только информацию о последнем шаблоне, для которого найдено соответствие.

Примеры

Sub ReplacePatternExample()
   Dim objTextDoc As TextDocument
   Dim objMovePt As EditPoint
   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")
   objMovePt = objTextDoc.EndPoint.CreateEditPoint
   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()
   objMovePt.EndOfDocument()
   ' Replace all occurrences of "test" with "thing."
    objEditPt.ReplacePattern(objMovePt, "test", "thing", vsFindOptions.vsFindOptionsFromStart)
End Sub

Разрешения

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

См. также

Ссылки

EditPoint Интерфейс

EditPoint - члены

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

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