VB.NET || Word Wrap – How To Split A String Text Into lines With Maximum Length

The following is a module with functions which demonstrates how to split text into multiple lines using VB.NET.
This function takes a string, and splits it into multiple lines (array indices) of a specified length. If a word is too long to fit on a line, the entire word gets moved to the next line (the next array index).
This function does not break up long individual words.
1. Word Wrap
The example below demonstrates the use of ‘Utils.WordWrap‘ to split a string into multiple lines.
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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
' Word Wrap ' Limit string text to 40 characters per line Dim text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus faucibus venenatis justo, placerat maximus tortor dictum non. Curabitur efficitur pulvinar arcu, id vehicula nisi commodo in. Interdum et malesuada fames ac ante ipsum primis in faucibus. Vivamus consectetur ut orci scelerisque fringilla. Sed id nisl ac nunc congue suscipit at sollicitudin elit. Nullam tempus tortor sit amet molestie rutrum. Sed a sollicitudin magna, eget vulputate tortor. Proin ut sodales orci, a iaculis ipsum.Ut nec odio risus. Vivamus viverra metus turpis. Pellentesque lacinia lacinia tempus. Suspendisse in justo eget orci porttitor ornare vitae nec tortor. Donec dolor odio, dapibus non sodales quis, volutpat a turpis. Curabitur eget fermentum ante. Donec pulvinar nulla non ante mattis aliquam.Aenean vulputate, ligula sit amet laoreet porttitor, magna justo pellentesque diam, id tempus eros orci ut arcu. Praesent et finibus ipsum. Mauris luctus, metus vel sagittis pharetra, felis odio placerat felis, et ullamcorper neque turpis eget tellus. Maecenas vel imperdiet augue. Morbi imperdiet diam ac enim cursus venenatis. Donec eros turpis, pharetra a aliquet sed, vehicula sed libero. Donec efficitur volutpat ex, in euismod dolor tristique at. Quisque a nisi ultricies libero lacinia fringilla nec vel tortor.Aenean id felis et quam lacinia ornare. Curabitur blandit, arcu eget ultricies pulvinar, neque lectus ultrices mauris, vitae feugiat mauris diam id tellus. Vestibulum finibus cursus dui et feugiat. Sed vitae sagittis lorem. Duis suscipit sollicitudin est tempor efficitur. Morbi eget fringilla massa. Integer ullamcorper, ligula congue consequat sodales, dolor eros pretium augue, in luctus enim massa quis est. Fusce cursus ac ipsum quis aliquet. Curabitur pharetra lectus non suscipit scelerisque. Pellentesque vitae scelerisque tellus. Donec sit amet ligula felis. Donec ac hendrerit magna, sed pharetra diam. Morbi gravida felis finibus sodales suscipit. In hac habitasse platea dictumst.Curabitur purus erat, tincidunt vel tincidunt et, fermentum eget dui. Fusce eu justo vel massa ultrices lacinia sit amet quis augue. Nunc fringilla justo quis felis fringilla, at rutrum justo venenatis. Ut ullamcorper gravida finibus. Donec fermentum varius metus sit amet porttitor. Sed at auctor velit. Quisque et urna metus. Donec ut mi vel turpis dignissim pulvinar. Curabitur massa leo, interdum ac urna id, dictum pellentesque nunc. Ut dolor justo, vehicula quis porta in, laoreet eget augue. " Dim maxCharacters = 40 Dim result = Utils.WordWrap(text, maxCharacters) For Each line In result Debug.Print($"Length: {line.Length} - {line}") Next ' expected output: ' Length: 39 - Lorem ipsum dolor sit amet, consectetur ' Length: 35 - adipiscing elit. Phasellus faucibus ' Length: 33 - venenatis justo, placerat maximus ' Length: 38 - tortor dictum non. Curabitur efficitur ' Length: 39 - pulvinar arcu, id vehicula nisi commodo ' Length: 39 - in. Interdum et malesuada fames ac ante ' Length: 33 - ipsum primis in faucibus. Vivamus ' Length: 31 - consectetur ut orci scelerisque ' Length: 37 - fringilla. Sed id nisl ac nunc congue ' Length: 37 - suscipit at sollicitudin elit. Nullam ' Length: 39 - tempus tortor sit amet molestie rutrum. ' Length: 30 - Sed a sollicitudin magna, eget ' Length: 34 - vulputate tortor. Proin ut sodales ' Length: 33 - orci, a iaculis ipsum.Ut nec odio ' Length: 36 - risus. Vivamus viverra metus turpis. ' Length: 36 - Pellentesque lacinia lacinia tempus. ' Length: 30 - Suspendisse in justo eget orci ' Length: 34 - porttitor ornare vitae nec tortor. ' Length: 37 - Donec dolor odio, dapibus non sodales ' Length: 39 - quis, volutpat a turpis. Curabitur eget ' Length: 36 - fermentum ante. Donec pulvinar nulla ' Length: 30 - non ante mattis aliquam.Aenean ' Length: 34 - vulputate, ligula sit amet laoreet ' Length: 35 - porttitor, magna justo pellentesque ' Length: 34 - diam, id tempus eros orci ut arcu. ' Length: 33 - Praesent et finibus ipsum. Mauris ' Length: 36 - luctus, metus vel sagittis pharetra, ' Length: 29 - felis odio placerat felis, et ' Length: 37 - ullamcorper neque turpis eget tellus. ' Length: 35 - Maecenas vel imperdiet augue. Morbi ' Length: 29 - imperdiet diam ac enim cursus ' Length: 38 - venenatis. Donec eros turpis, pharetra ' Length: 35 - a aliquet sed, vehicula sed libero. ' Length: 39 - Donec efficitur volutpat ex, in euismod ' Length: 34 - dolor tristique at. Quisque a nisi ' Length: 38 - ultricies libero lacinia fringilla nec ' Length: 34 - vel tortor.Aenean id felis et quam ' Length: 39 - lacinia ornare. Curabitur blandit, arcu ' Length: 37 - eget ultricies pulvinar, neque lectus ' Length: 37 - ultrices mauris, vitae feugiat mauris ' Length: 34 - diam id tellus. Vestibulum finibus ' Length: 32 - cursus dui et feugiat. Sed vitae ' Length: 29 - sagittis lorem. Duis suscipit ' Length: 34 - sollicitudin est tempor efficitur. ' Length: 35 - Morbi eget fringilla massa. Integer ' Length: 36 - ullamcorper, ligula congue consequat ' Length: 37 - sodales, dolor eros pretium augue, in ' Length: 33 - luctus enim massa quis est. Fusce ' Length: 39 - cursus ac ipsum quis aliquet. Curabitur ' Length: 28 - pharetra lectus non suscipit ' Length: 31 - scelerisque. Pellentesque vitae ' Length: 34 - scelerisque tellus. Donec sit amet ' Length: 39 - ligula felis. Donec ac hendrerit magna, ' Length: 38 - sed pharetra diam. Morbi gravida felis ' Length: 32 - finibus sodales suscipit. In hac ' Length: 35 - habitasse platea dictumst.Curabitur ' Length: 39 - purus erat, tincidunt vel tincidunt et, ' Length: 38 - fermentum eget dui. Fusce eu justo vel ' Length: 36 - massa ultrices lacinia sit amet quis ' Length: 38 - augue. Nunc fringilla justo quis felis ' Length: 37 - fringilla, at rutrum justo venenatis. ' Length: 37 - Ut ullamcorper gravida finibus. Donec ' Length: 31 - fermentum varius metus sit amet ' Length: 39 - porttitor. Sed at auctor velit. Quisque ' Length: 37 - et urna metus. Donec ut mi vel turpis ' Length: 35 - dignissim pulvinar. Curabitur massa ' Length: 32 - leo, interdum ac urna id, dictum ' Length: 34 - pellentesque nunc. Ut dolor justo, ' Length: 36 - vehicula quis porta in, laoreet eget ' Length: 6 - augue. |
2. Utils Namespace
The following is the Utils Namespace. Include this in your project to start using!
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 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
' ============================================================================ ' Author: Kenneth Perkins ' Taken From: http://programmingnotes.org/ ' Date: Nov 3, 2020 ' File: Utils.vb ' Description: Handles general utility functions ' ============================================================================ Option Strict On Option Explicit On Namespace Global.Utils Public Module modUtils ''' <summary> ''' Takes in a string and splits it into multiple lines (array indices) of a specified length. ''' If a word is too long to fit on a line, the entire word gets moved to the next line (the next array index) ''' </summary> ''' <param name="text">The text to word wrap</param> ''' <param name="maxCharactersPerLine">The maximum characters per line</param> ''' <returns>A list of strings that contains each line limited by the specified length</returns> Public Function WordWrap(text As String, maxCharactersPerLine As Integer) As List(Of String) text = text.Trim Dim result = New List(Of String) Dim words = text.Split(" ".ToCharArray, StringSplitOptions.RemoveEmptyEntries) If text.Length <= maxCharactersPerLine OrElse words.Count = 1 Then result.Add(text) Else For Each word In words Dim addition = $" {word.Trim}" Dim lineIndex = result.Count - 1 Dim lineCharacters = If(lineIndex > -1, result(lineIndex).Length + addition.Length, 0) If result.Count < 1 _ OrElse lineCharacters >= maxCharactersPerLine Then ' Start new line addition = addition.Trim result.Add(addition) Else ' Append existing line result(lineIndex) += addition End If Next End If 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!
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 34 |
' ============================================================================ ' Author: Kenneth Perkins ' Taken From: http://programmingnotes.org/ ' Date: Nov 3, 2020 ' File: Program.vb ' Description: The following demonstrates the use of the Utils Namespace. ' ============================================================================ Option Strict On Option Explicit On Imports System Module Program Sub Main(args As String()) Try ' Limit string text to 40 characters per line Dim text = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus faucibus venenatis justo, placerat maximus tortor dictum non. Curabitur efficitur pulvinar arcu, id vehicula nisi commodo in. Interdum et malesuada fames ac ante ipsum primis in faucibus. Vivamus consectetur ut orci scelerisque fringilla. Sed id nisl ac nunc congue suscipit at sollicitudin elit. Nullam tempus tortor sit amet molestie rutrum. Sed a sollicitudin magna, eget vulputate tortor. Proin ut sodales orci, a iaculis ipsum.Ut nec odio risus. Vivamus viverra metus turpis. Pellentesque lacinia lacinia tempus. Suspendisse in justo eget orci porttitor ornare vitae nec tortor. Donec dolor odio, dapibus non sodales quis, volutpat a turpis. Curabitur eget fermentum ante. Donec pulvinar nulla non ante mattis aliquam.Aenean vulputate, ligula sit amet laoreet porttitor, magna justo pellentesque diam, id tempus eros orci ut arcu. Praesent et finibus ipsum. Mauris luctus, metus vel sagittis pharetra, felis odio placerat felis, et ullamcorper neque turpis eget tellus. Maecenas vel imperdiet augue. Morbi imperdiet diam ac enim cursus venenatis. Donec eros turpis, pharetra a aliquet sed, vehicula sed libero. Donec efficitur volutpat ex, in euismod dolor tristique at. Quisque a nisi ultricies libero lacinia fringilla nec vel tortor.Aenean id felis et quam lacinia ornare. Curabitur blandit, arcu eget ultricies pulvinar, neque lectus ultrices mauris, vitae feugiat mauris diam id tellus. Vestibulum finibus cursus dui et feugiat. Sed vitae sagittis lorem. Duis suscipit sollicitudin est tempor efficitur. Morbi eget fringilla massa. Integer ullamcorper, ligula congue consequat sodales, dolor eros pretium augue, in luctus enim massa quis est. Fusce cursus ac ipsum quis aliquet. Curabitur pharetra lectus non suscipit scelerisque. Pellentesque vitae scelerisque tellus. Donec sit amet ligula felis. Donec ac hendrerit magna, sed pharetra diam. Morbi gravida felis finibus sodales suscipit. In hac habitasse platea dictumst.Curabitur purus erat, tincidunt vel tincidunt et, fermentum eget dui. Fusce eu justo vel massa ultrices lacinia sit amet quis augue. Nunc fringilla justo quis felis fringilla, at rutrum justo venenatis. Ut ullamcorper gravida finibus. Donec fermentum varius metus sit amet porttitor. Sed at auctor velit. Quisque et urna metus. Donec ut mi vel turpis dignissim pulvinar. Curabitur massa leo, interdum ac urna id, dictum pellentesque nunc. Ut dolor justo, vehicula quis porta in, laoreet eget augue. " Dim maxCharacters = 40 Dim result = Utils.WordWrap(text, maxCharacters) For Each line In result Display($"Length: {line.Length} - {line}") Next 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.
Leave a Reply