Find Replace Regex (regular expressions) Form, VB.NET (.NET Framework)

My latest tool, Standalone Find/Replace in VB.NET, to be added on anywhere (including your and my existing projects!) It is a simple standalone find replace form which uses a reference to a object to search it. You will probably only find this useful if you, like I, have to accommodate higher end users doing text editing (usually REGEX stuff in my case.) It is also a good example of leveraging Regex better than many I have seen elsewhere so I thought I would share it. It could be easily ported to C# using SharpDevelop.

It currently accepts the reference to a listview or textbox (with the idea of leaving room for other items I may find useful in the future) and finds text normally or using REGEX matching (.NET regexs, Rock on.)

I have not implemented the replace in the listview because I myself display tables or objects using a listview, but the listview is just to give the user an idea of what is going on in the object behind the scenes and editing the listview will have no effect on the object (unless you wanted to write a listview to object backward conversion for everything you do). Therefore, if you want it to work on your own objects you would have a code that in on your own, and if you want it to replace in listviews you will have to do that too! (unless I suddenly find the need) I think the find option alone on a listview is great though. The "Include subitems" checkbox is listview specific to be able to search all columns or not, optionally.

I got most of the motivation for the GUI from EditPlus a great text editing program which also has a powerful regular expression find replace built in I highly suggest it.

The options:

• Include Subitems - As I said above this checkbox makes it where you can search all columns of a listbox instead of just the first, though you can turn it off when you are only concerned about the first column (or text) of the listviewitems.
• Use Regex - makes the top box search by regular expression and has the bottom box replace by regex one of the great options is you can capture in the top area and then put those back in with $1, $2, $3, etc.
• For instance (This is a bit complex but most would probably get it):
  
• Topbox: (ab)(c) Bottom box: $2$1 Text found: abc Changed to: cab
• Topbox: (http://)[^\.]+(\.[^/]+/) Bottom Box: $1technage$2 TextFound: http://www.blogger.com Changed to: http://technage.blogger.com
• Search Up - Changes from searching in the downward direction to searching in the upward direction.

This makes heavy use of general string functions as well as System.Text.RegularExpressions.

It contains a great use of MatchCollection.Result() which handles the reinsertion of the captures.

I can do some more chatting and example giving but for now I want to throw it out there and see if anyone has questions or is interested.

Sorry for the crudeness of the textboxes below, but I do not have a real place to host the files except on this blog. And due to the fact these are very small I just put them down there in the text areas to be copied out. If that is too annoying I can add them in a pre.

The codes I have published below are a great example for why one should have a replacer like this because the carriage returns in normal code for VB.NET are resulting in <br />'s to be placed in the code. I assume its a blogger bug, but if anyone knows a great trick to fix it that would be great I looked at some of the FAQ and the groups discussion no one had a definitive way to fix the problem except for removing the carriage returns, but for proper coding format that is the dumbest idea ever. Do people actually use Textarea for something other than displaying code???

NOTE: So use the tool to fix the code once you have compiled it, have it replace the double tabs (\t\t) with a single newline (\n) in regex mode. That should make it pretty again.

THE CODES:

FindForm.VB

Public Class FindForm Dim lvFind As Windows.Forms.ListView Dim txtfind As Windows.Forms.TextBox Dim findtype As String #Region "Example Calls" '*************************** '***TYPICAL TEXTBOX CALL *** '*************************** ' 'Private Sub OutPutBox_TextChanged(ByVal sender As System.Object, ByVal e As Windows.Forms.KeyEventArgs) Handles OutputBox.KeyUp ' If e.Control Then ' If e.KeyCode = Keys.F Then ' If frm Is Nothing OrElse frm.Visible = False Then ' frm = New FindForm(OutputBox, Me) ' frm.Show() ' Else ' frm.SetToTextBox(OutputBox) ' End If ' End If ' End If 'End Sub ' '**************************** '**************************** '**************************** #End Region Public Sub New(ByRef inLV As Windows.Forms.ListView, ByRef inParent As Windows.Forms.Form, Optional ByVal strText As String = "") SetToListView(inLV) AddHandler inParent.FormClosing, AddressOf parentClosing InitializeComponent() If strText IsNot Nothing And strText <> "" Then cmbFind.Text = strText End If End Sub Public Sub SetToListView(ByRef inLV As Windows.Forms.ListView) findtype = "listview" lvFind = inLV End Sub Public Sub New(ByRef inTxt As Windows.Forms.TextBox, ByRef inParent As Windows.Forms.Form, Optional ByVal strText As String = "") SetToTextBox(inTxt) AddHandler inParent.FormClosing, AddressOf parentClosing InitializeComponent() If strText IsNot Nothing And strText <> "" Then cmbFind.Text = strText End If End Sub Public Sub SetToTextBox(ByRef inTxt As Windows.Forms.TextBox) findtype = "textbox" txtfind = inTxt End Sub Private Sub parentClosing(ByVal sender As Object, ByVal e As System.Windows.Forms.FormClosingEventArgs) Me.Close() End Sub Private Sub cmbFind_KeyPress(ByVal sender As Object, ByVal e As System.Windows.Forms.KeyPressEventArgs) Handles cmbFind.KeyPress If e.KeyChar = Chr(13) Then e.Handled = True FindIt() cmbFind.SelectionStart = 0 cmbFind.SelectionLength = cmbFind.Text.Length End If End Sub Private Sub btnFindNext_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnFindNext.Click FindIt() End Sub Private Function FindIt() As Integer If Not cmbFind.Items.Contains(cmbFind.Text) Then cmbFind.Items.Add(cmbFind.Text) End If btnFindNext.BackColor = Drawing.Color.PaleGoldenrod System.Windows.Forms.Application.DoEvents() btnFindNext.BackColor = System.Drawing.Color.FromKnownColor(Drawing.KnownColor.Control) Select Case findtype Case "listview" ListviewFind() Case "textbox" TextBoxFind() End Select If btnFindNext.BackColor = Drawing.Color.Pink Then Return 1 Else Return 0 End If End Function Private Sub TextBoxFind() Dim intStart As Integer Dim intEnd As Integer If txtfind.SelectionStart > 0 Then If Not cbSearchUp.Checked Then intStart = txtfind.SelectionStart + 1 Else intStart = txtfind.SelectionStart - 1 End If If intStart >= txtfind.Text.Length Then intStart = 0 btnFindNext.BackColor = Drawing.Color.Pink ElseIf intStart < intstart =" txtfind.Text.Length" intstart =" 0" intend =" txtfind.Text.Length"> "" AndAlso txtfind IsNot Nothing Then Dim notfound As Boolean = False Dim findspot As Integer = -1 If cbRegEx.Checked = False AndAlso txtfind.Text.Contains(cmbFind.Text) Then If Not cbSearchUp.Checked Then findspot = txtfind.Text.IndexOf(cmbFind.Text, intStart) Else findspot = txtfind.Text.LastIndexOf(cmbFind.Text, intStart) End If If findspot = -1 Then If Not cbSearchUp.Checked Then findspot = txtfind.Text.IndexOf(cmbFind.Text, 0) btnFindNext.BackColor = Drawing.Color.Pink Else findspot = txtfind.Text.LastIndexOf(cmbFind.Text, txtfind.Text.Length) btnFindNext.BackColor = Drawing.Color.Pink End If End If txtfind.SelectionStart = findspot txtfind.SelectionLength = cmbFind.Text.Length ElseIf cbRegEx.Checked = True AndAlso System.Text.RegularExpressions.Regex.IsMatch(txtfind.Text.ToLower, cmbFind.Text) Then Dim mat As Text.RegularExpressions.MatchCollection Dim aboveindex As Integer = -1 Dim abovelength As Integer mat = System.Text.RegularExpressions.Regex.Matches(txtfind.Text.ToLower, cmbFind.Text) If mat IsNot Nothing AndAlso mat.Count > 0 Then For i As Integer = 0 To mat.Count - 1 If Not cbSearchUp.Checked AndAlso mat(i).Index > intStart Then findspot = mat(i).Index txtfind.SelectionLength = mat(i).Length Exit For ElseIf cbSearchUp.Checked AndAlso mat(i).Index <> aboveindex Then aboveindex = mat(i).Index abovelength = mat(i).Length End If End If Next End If If cbSearchUp.Checked Then If aboveindex <> -1 Then findspot = aboveindex txtfind.SelectionLength = abovelength End If End If If findspot = -1 Then If mat IsNot Nothing AndAlso mat.Count > 0 Then If Not cbSearchUp.Checked Then findspot = mat(0).Index Else findspot = mat(mat.Count - 1).Index End If btnFindNext.BackColor = Drawing.Color.Pink End If End If txtfind.SelectionStart = findspot 'txtfind.SelectionLength = cmbFind.Text.Length ElseIf cbRegEx.Checked = True AndAlso Not System.Text.RegularExpressions.Regex.IsMatch(txtfind.Text.ToLower, cmbFind.Text) Then btnFindNext.BackColor = Drawing.Color.Pink End If txtfind.ScrollToCaret() End If End Sub Private Sub ListviewFind() Dim selected As Boolean Dim intStart As Integer Dim intEnd As Integer If lvFind.SelectedItems.Count > 0 Then intStart = lvFind.SelectedItems(0).Index + 1 If intStart >= lvFind.Items.Count Then intStart = 0 btnFindNext.BackColor = Drawing.Color.Pink End If Else intStart = 0 End If intEnd = lvFind.Items.Count - 1 If cmbFind.Text <> "" AndAlso lvFind IsNot Nothing Then For i As Integer = intStart To intEnd 'Check the listview item itself If cbRegEx.Checked = False AndAlso lvFind.Items(i).Text.ToLower.Contains(cmbFind.Text.ToLower) Then lvFind.SelectedItems.Clear() lvFind.Items(i).Selected = True lvFind.TopItem = lvFind.Items(i) selected = True ElseIf cbRegEx.Checked = True AndAlso System.Text.RegularExpressions.Regex.IsMatch(lvFind.Items(i).Text.ToLower, cmbFind.Text) Then lvFind.SelectedItems.Clear() lvFind.Items(i).Selected = True lvFind.TopItem = lvFind.Items(i) selected = True End If 'Check the Subitems of the listviewItem If cbIncludeSubs.Checked AndAlso lvFind.Items(i).SubItems.Count > 0 Then For j As Integer = 0 To lvFind.Items(i).SubItems.Count - 1 If cbRegEx.Checked = False AndAlso lvFind.Items(i).SubItems(j).Text.ToLower.Contains(cmbFind.Text.ToLower) Then lvFind.SelectedItems.Clear() lvFind.Items(i).Selected = True lvFind.TopItem = lvFind.Items(i) selected = True ElseIf cbRegEx.Checked = True AndAlso System.Text.RegularExpressions.Regex.IsMatch(lvFind.Items(i).SubItems(j).Text.ToLower, cmbFind.Text) Then lvFind.SelectedItems.Clear() lvFind.Items(i).Selected = True lvFind.TopItem = lvFind.Items(i) selected = True End If Next End If If selected = True Then Exit For Else If i = lvFind.Items.Count - 1 AndAlso btnFindNext.BackColor <> Drawing.Color.Pink AndAlso intStart > 0 Then i = -1 intEnd = intStart btnFindNext.BackColor = Drawing.Color.Pink End If End If Next End If End Sub Private Sub BtnClose_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnClose.Click Me.Close() End Sub Private Function Replace() As Integer Dim pastend As Integer If findtype = "textbox" Then If cmbFind.Text <> "" AndAlso txtfind IsNot Nothing Then Dim notfound As Boolean = False Dim temprep As String Dim findspot As Integer = -1 If cbRegEx.Checked = False AndAlso txtfind.Text.Contains(cmbFind.Text) Then If txtfind.Text.Substring(txtfind.SelectionStart, txtfind.SelectionLength) = cmbFind.Text Then Dim tempstart As Integer = txtfind.SelectionStart Dim templen As Integer = txtfind.SelectionLength txtfind.Text = txtfind.Text.Remove(tempstart, templen) txtfind.Text = txtfind.Text.Insert(tempstart, cmbReplace.Text) txtfind.SelectionStart = tempstart txtfind.SelectionLength = cmbReplace.Text.Length pastend = FindIt() Else pastend = FindIt() End If ElseIf cbRegEx.Checked = True AndAlso System.Text.RegularExpressions.Regex.IsMatch(txtfind.Text.ToLower, cmbFind.Text) Then If System.Text.RegularExpressions.Regex.IsMatch(txtfind.Text.Substring(txtfind.SelectionStart, txtfind.SelectionLength), cmbFind.Text) Then Dim mc As System.Text.RegularExpressions.Match mc = System.Text.RegularExpressions.Regex.Match(txtfind.Text.Substring(txtfind.SelectionStart, txtfind.SelectionLength), cmbFind.Text) temprep = cmbReplace.Text temprep = mc.Result(cmbReplace.Text) Dim tempstart As Integer = txtfind.SelectionStart Dim templen As Integer = txtfind.SelectionLength txtfind.Text = txtfind.Text.Remove(tempstart, templen) txtfind.Text = txtfind.Text.Insert(tempstart, temprep) txtfind.SelectionStart = tempstart txtfind.SelectionLength = temprep.Length pastend = FindIt() Else pastend = FindIt() End If End If txtfind.ScrollToCaret() End If End If Return pastend End Function Private Sub btnReplace_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnReplace.Click Replace() End Sub Private Sub btnReplaceAll_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnReplaceAll.Click Try txtfind.SelectionStart = 0 txtfind.SelectionLength = 0 Dim Pastend As Integer = 0 If findtype = "textbox" Then If cmbFind.Text <> "" AndAlso txtfind IsNot Nothing Then Dim notfound As Boolean = False Dim findspot As Integer = -1 If cbRegEx.Checked = False AndAlso txtfind.Text.Contains(cmbFind.Text) Then FindIt() While txtfind.Text.Substring(txtfind.SelectionStart, txtfind.SelectionLength) = cmbFind.Text Pastend = Replace() If Pastend = 1 Then Exit While End If End While ElseIf cbRegEx.Checked = True AndAlso System.Text.RegularExpressions.Regex.IsMatch(txtfind.Text.ToLower, cmbFind.Text) Then FindIt() While System.Text.RegularExpressions.Regex.IsMatch(txtfind.Text.Substring(txtfind.SelectionStart, txtfind.SelectionLength), cmbFind.Text) Pastend = Replace() If Pastend = 1 Then Exit While End If End While End If End If End If Catch ex As Exception System.Windows.Forms.MessageBox.Show("U F*'d up my 1337 find form WAY TO GO, you probably F'd up your regex.", "D'oh") End Try End Sub End Class

FindForm.Designer.VB
<global.microsoft.visualbasic.compilerservices.designergenerated()> _ Partial Class FindForm Inherits System.Windows.Forms.Form 'Form overrides dispose to clean up the component list. <system.diagnostics.debuggernonusercode()> _ Protected Overrides Sub Dispose(ByVal disposing As Boolean) If disposing AndAlso components IsNot Nothing Then components.Dispose() End If MyBase.Dispose(disposing) End Sub 'Required by the Windows Form Designer Private components As System.ComponentModel.IContainer 'NOTE: The following procedure is required by the Windows Form Designer 'It can be modified using the Windows Form Designer. 'Do not modify it using the code editor. <system.diagnostics.debuggerstepthrough()> _ Private Sub InitializeComponent() Me.cmbFind = New System.Windows.Forms.ComboBox Me.cmbReplace = New System.Windows.Forms.ComboBox Me.Label1 = New System.Windows.Forms.Label Me.cbRegEx = New System.Windows.Forms.CheckBox Me.btnFindNext = New System.Windows.Forms.Button Me.cbIncludeSubs = New System.Windows.Forms.CheckBox Me.btnReplace = New System.Windows.Forms.Button Me.btnReplaceAll = New System.Windows.Forms.Button Me.btnClose = New System.Windows.Forms.Button Me.Label2 = New System.Windows.Forms.Label Me.cbSearchUp = New System.Windows.Forms.CheckBox Me.SuspendLayout() ' 'cmbFind ' Me.cmbFind.Anchor = CType(((System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Left) _ Or System.Windows.Forms.AnchorStyles.Right), System.Windows.Forms.AnchorStyles) Me.cmbFind.FormattingEnabled = True Me.cmbFind.Location = New System.Drawing.Point(55, 5) Me.cmbFind.Margin = New System.Windows.Forms.Padding(4, 2, 4, 2) Me.cmbFind.Name = "cmbFind" Me.cmbFind.Size = New System.Drawing.Size(172, 21) Me.cmbFind.TabIndex = 0 ' 'cmbReplace ' Me.cmbReplace.Anchor = CType(((System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Left) _ Or System.Windows.Forms.AnchorStyles.Right), System.Windows.Forms.AnchorStyles) Me.cmbReplace.FormattingEnabled = True Me.cmbReplace.Location = New System.Drawing.Point(55, 30) Me.cmbReplace.Margin = New System.Windows.Forms.Padding(4, 2, 4, 2) Me.cmbReplace.Name = "cmbReplace" Me.cmbReplace.Size = New System.Drawing.Size(172, 21) Me.cmbReplace.TabIndex = 1 ' 'Label1 ' Me.Label1.AutoSize = True Me.Label1.Location = New System.Drawing.Point(0, 9) Me.Label1.Margin = New System.Windows.Forms.Padding(4, 0, 4, 0) Me.Label1.Name = "Label1" Me.Label1.Size = New System.Drawing.Size(56, 13) Me.Label1.TabIndex = 2 Me.Label1.Text = "Find what:" ' 'cbRegEx ' Me.cbRegEx.Location = New System.Drawing.Point(5, 75) Me.cbRegEx.Margin = New System.Windows.Forms.Padding(4, 2, 4, 2) Me.cbRegEx.Name = "cbRegEx" Me.cbRegEx.Size = New System.Drawing.Size(80, 16) Me.cbRegEx.TabIndex = 3 Me.cbRegEx.Text = "Use Regex" Me.cbRegEx.UseVisualStyleBackColor = True ' 'btnFindNext ' Me.btnFindNext.Anchor = CType((System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Right), System.Windows.Forms.AnchorStyles) Me.btnFindNext.Location = New System.Drawing.Point(232, 5) Me.btnFindNext.Margin = New System.Windows.Forms.Padding(4, 2, 4, 2) Me.btnFindNext.Name = "btnFindNext" Me.btnFindNext.Size = New System.Drawing.Size(76, 24) Me.btnFindNext.TabIndex = 4 Me.btnFindNext.Text = "Find Next" Me.btnFindNext.UseVisualStyleBackColor = True ' 'cbIncludeSubs ' Me.cbIncludeSubs.Checked = True Me.cbIncludeSubs.CheckState = System.Windows.Forms.CheckState.Checked Me.cbIncludeSubs.Location = New System.Drawing.Point(5, 60) Me.cbIncludeSubs.Name = "cbIncludeSubs" Me.cbIncludeSubs.Size = New System.Drawing.Size(110, 15) Me.cbIncludeSubs.TabIndex = 5 Me.cbIncludeSubs.Text = "Include Subitems" Me.cbIncludeSubs.UseVisualStyleBackColor = True ' 'btnReplace ' Me.btnReplace.Anchor = CType((System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Right), System.Windows.Forms.AnchorStyles) Me.btnReplace.Location = New System.Drawing.Point(232, 30) Me.btnReplace.Margin = New System.Windows.Forms.Padding(4, 2, 4, 2) Me.btnReplace.Name = "btnReplace" Me.btnReplace.Size = New System.Drawing.Size(76, 24) Me.btnReplace.TabIndex = 6 Me.btnReplace.Text = "Replace" Me.btnReplace.UseVisualStyleBackColor = True ' 'btnReplaceAll ' Me.btnReplaceAll.Anchor = CType((System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Right), System.Windows.Forms.AnchorStyles) Me.btnReplaceAll.Location = New System.Drawing.Point(232, 55) Me.btnReplaceAll.Margin = New System.Windows.Forms.Padding(4, 2, 4, 2) Me.btnReplaceAll.Name = "btnReplaceAll" Me.btnReplaceAll.Size = New System.Drawing.Size(76, 24) Me.btnReplaceAll.TabIndex = 7 Me.btnReplaceAll.Text = "Replace All" Me.btnReplaceAll.UseVisualStyleBackColor = True ' 'btnClose ' Me.btnClose.Anchor = CType((System.Windows.Forms.AnchorStyles.Top Or System.Windows.Forms.AnchorStyles.Right), System.Windows.Forms.AnchorStyles) Me.btnClose.Location = New System.Drawing.Point(232, 80) Me.btnClose.Margin = New System.Windows.Forms.Padding(4, 2, 4, 2) Me.btnClose.Name = "btnClose" Me.btnClose.Size = New System.Drawing.Size(76, 24) Me.btnClose.TabIndex = 8 Me.btnClose.Text = "Close" Me.btnClose.UseVisualStyleBackColor = True ' 'Label2 ' Me.Label2.AutoSize = True Me.Label2.Location = New System.Drawing.Point(0, 34) Me.Label2.Margin = New System.Windows.Forms.Padding(4, 0, 4, 0) Me.Label2.Name = "Label2" Me.Label2.Size = New System.Drawing.Size(50, 13) Me.Label2.TabIndex = 9 Me.Label2.Text = "Replace:" ' 'cbSearchUp ' Me.cbSearchUp.AutoSize = True Me.cbSearchUp.Location = New System.Drawing.Point(5, 90) Me.cbSearchUp.Name = "cbSearchUp" Me.cbSearchUp.Size = New System.Drawing.Size(77, 17) Me.cbSearchUp.TabIndex = 10 Me.cbSearchUp.Text = "Search Up" Me.cbSearchUp.UseVisualStyleBackColor = True ' 'FindForm ' Me.AutoScaleDimensions = New System.Drawing.SizeF(6.0!, 13.0!) Me.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font Me.ClientSize = New System.Drawing.Size(312, 116) Me.Controls.Add(Me.cbSearchUp) Me.Controls.Add(Me.Label2) Me.Controls.Add(Me.cmbFind) Me.Controls.Add(Me.btnClose) Me.Controls.Add(Me.btnReplaceAll) Me.Controls.Add(Me.btnReplace) Me.Controls.Add(Me.cbIncludeSubs) Me.Controls.Add(Me.btnFindNext) Me.Controls.Add(Me.cbRegEx) Me.Controls.Add(Me.Label1) Me.Controls.Add(Me.cmbReplace) Me.Font = New System.Drawing.Font("Microsoft Sans Serif", 8.25!, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, CType(0, Byte)) Me.Margin = New System.Windows.Forms.Padding(4, 2, 4, 2) Me.MaximizeBox = False Me.MinimizeBox = False Me.MinimumSize = New System.Drawing.Size(320, 150) Me.Name = "FindForm" Me.ShowIcon = False Me.Text = "Find" Me.TopMost = True Me.ResumeLayout(False) Me.PerformLayout() End Sub Friend WithEvents cmbFind As System.Windows.Forms.ComboBox Friend WithEvents cmbReplace As System.Windows.Forms.ComboBox Friend WithEvents Label1 As System.Windows.Forms.Label Friend WithEvents cbRegEx As System.Windows.Forms.CheckBox Friend WithEvents btnFindNext As System.Windows.Forms.Button Friend WithEvents cbIncludeSubs As System.Windows.Forms.CheckBox Friend WithEvents btnReplace As System.Windows.Forms.Button Friend WithEvents btnReplaceAll As System.Windows.Forms.Button Friend WithEvents btnClose As System.Windows.Forms.Button Friend WithEvents Label2 As System.Windows.Forms.Label Friend WithEvents cbSearchUp As System.Windows.Forms.CheckBox End Class