VB.NET || How To Replace Entire Words In A String Using VB.NET

November 24, 2020 admin No comments

The following is a module with functions which demonstrates how to replace entire words in a string using VB.NET.

This function is different from String.Replace in that instead of replacing all substring instances in a word, it replaces all instances of matching entire words in a string.

1. Replace Entire Word

The example below demonstrates the use of ‘Utils.ReplaceWord‘ to replace an entire word.





		
		
			1. Replace Entire Word
			
Visual Basic .NET
			
			' Replace Entire Word

Imports Utils

Dim word = "This docment uses 3 other docments to docment the docmentation"

' Replace the entire word in the string
Dim result = word.ReplaceWord("docment", "document")

Debug.Print(result)

' expected output:
'    This document uses 3 other docments to document the docmentation
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
				
						' Replace Entire Word
 
Imports Utils
 
Dim word = "This docment uses 3 other docments to docment the docmentation"
 
' Replace the entire word in the string
Dim result = word.ReplaceWord("docment", "document")
 
Debug.Print(result)
 
' expected output:
'    This document uses 3 other docments to document the docmentation

2. Utils Namespace

The following is the Utils Namespace. Include this in your project to start using!





		
		
			Utils Namespace
			
Visual Basic .NET
			
			' ============================================================================
'    Author: Kenneth Perkins
'    Date:   Nov 24, 2020
'    Taken From: http://programmingnotes.org/
'    File: Utils.vb
'    Description: Handles general utility functions
' ============================================================================
Option Strict On
Option Explicit On

Namespace Global.Utils
    Public Module modUtils
        ''' <summary>
        ''' Replaces the entire word in the string
        ''' </summary>
        ''' <param name="source">The source string</param> 
        ''' <param name="wordToReplace">The word to replace</param> 
        ''' <param name="replacementWord">The replacement word</param> 
        ''' <param name="regexOptions">The search options</param> 
        ''' <returns>The modified source string</returns>
        <Runtime.CompilerServices.Extension()>
        Public Function ReplaceWord(source As String, wordToReplace As String, replacementWord As String _
                , Optional regexOptions As System.Text.RegularExpressions.RegexOptions = System.Text.RegularExpressions.RegexOptions.None) As String
            Dim pattern = $"\b{System.Text.RegularExpressions.Regex.Escape(wordToReplace)}\b"
            Dim result = System.Text.RegularExpressions.Regex.Replace(source, pattern, replacementWord, regexOptions)
            Return result
        End Function
    End Module
End Namespace ' http://programmingnotes.org/
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
				
						' ============================================================================
'    Author: Kenneth Perkins
'    Date:   Nov 24, 2020
'    Taken From: http://programmingnotes.org/
'    File: Utils.vb
'    Description: Handles general utility functions
' ============================================================================
Option Strict On
Option Explicit On
 
Namespace Global.Utils
    Public Module modUtils
        ''' <summary>
        ''' Replaces the entire word in the string
        ''' </summary>
        ''' <param name="source">The source string</param> 
        ''' <param name="wordToReplace">The word to replace</param> 
        ''' <param name="replacementWord">The replacement word</param> 
        ''' <param name="regexOptions">The search options</param> 
        ''' <returns>The modified source string</returns>
        <Runtime.CompilerServices.Extension()>
        Public Function ReplaceWord(source As String, wordToReplace As String, replacementWord As String _
                , Optional regexOptions As System.Text.RegularExpressions.RegexOptions = System.Text.RegularExpressions.RegexOptions.None) As String
            Dim pattern = $"\b{System.Text.RegularExpressions.Regex.Escape(wordToReplace)}\b"
            Dim result = System.Text.RegularExpressions.Regex.Replace(source, pattern, replacementWord, regexOptions)
            Return result
        End Function
    End Module
End Namespace ' http://programmingnotes.org/

3. More Examples

Below are more examples demonstrating the use of the ‘Utils‘ Namespace. Don’t forget to include the module when running the examples!





		
		
			More Examples
			
Visual Basic .NET
			
			' ============================================================================
'    Author: Kenneth Perkins
'    Date:   Nov 24, 2020
'    Taken From: http://programmingnotes.org/
'    File: Program.vb
'    Description: The following demonstrates the use of the Utils Namespace
' ============================================================================
Option Strict On
Option Explicit On
Imports System
Imports Utils

Module Program
    Sub Main(args As String())
        Try
            Dim word = "This docment uses 3 other docments to docment the docmentation"

            ' Replace the entire word in the string
            Dim result = word.ReplaceWord("docment", "document")

            Display(result)
        Catch ex As Exception
            Display(ex.ToString)
        Finally
            Console.ReadLine()
        End Try
    End Sub

    Public Sub Display(message As String)
        Console.WriteLine(message)
        Debug.Print(message)
    End Sub
End Module ' http://programmingnotes.org/
			
				
					
				
					1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
				
						' ============================================================================
'    Author: Kenneth Perkins
'    Date:   Nov 24, 2020
'    Taken From: http://programmingnotes.org/
'    File: Program.vb
'    Description: The following demonstrates the use of the Utils Namespace
' ============================================================================
Option Strict On
Option Explicit On
Imports System
Imports Utils
 
Module Program
    Sub Main(args As String())
        Try
            Dim word = "This docment uses 3 other docments to docment the docmentation"
 
            ' Replace the entire word in the string
            Dim result = word.ReplaceWord("docment", "document")
 
            Display(result)
        Catch ex As Exception
            Display(ex.ToString)
        Finally
            Console.ReadLine()
        End Try
    End Sub
 
    Public Sub Display(message As String)
        Console.WriteLine(message)
        Debug.Print(message)
    End Sub
End Module ' http://programmingnotes.org/

QUICK NOTES:
The highlighted lines are sections of interest to look out for.

The code is heavily commented, so no further insight is necessary. If you have any questions, feel free to leave a comment below.

Was this article helpful?

👍 YesNo

Posted in: Console, VB.NET Tags: replace word, vb.net

VB.NET || How To Replace Entire Words In A String Using VB.NET

Related

Leave a ReplyCancel reply

Search

Compile Your Code Now

Translate Page

Popular Pages

Recent

Archives

Categories