Во-первых, RegEx действительно соответствует чему-то? Попробуйте сначала в диалоге поиска.
Во-вторых, вам нужно указать шаблону замены, как это сделать - по сути, это то же самое, что выполнить поиск / замену.
Вот кое-что для начала: (Обратите внимание на vsFindOptions.vsFindOptionsRegularExpression)
Public Sub ReplaceRegEx()
DTE.UndoContext.Open("RegEx Replace")
Dim textSelection As TextSelection = DTE.ActiveDocument.Selection
textSelection.ReplacePattern("test{[^']+}test", "testAAAAtest", vsFindOptions.vsFindOptionsRegularExpression)
DTE.UndoContext.Close()
End Sub