Remember the Windows API PathCompactPath[Ex] used to take a path and shorten it by inserting an ellipsis in the appropriate place to make it fit a specific pixel width? Ever wonder how to do it native .NET? There's a very simple way to do it with the
TextRenderer.MeasureText method but it's relatively undocumented.
If you're familiar with this problem you might already know about using
Drawing.Graphics.DrawString methods to programmatically draw a shortened string using the framework. But I wanted a way to retrieve a shortened string in memory to later use that string inside an existing control (like a menu item).
Using the Code
Here's a simple function to do the trick, internally I copy the string (to keep it from affecting the source string), call
Windows.Forms.TextRenderer.MeasureText with the magic bitwise parameter:
TextFormatFlags.ModifyString, and return the string variable that was passed into the function.
Function CompactString(ByVal MyString As String, ByVal Width As Integer,
ByVal Font As Drawing.Font,
ByVal FormatFlags As Windows.Forms.TextFormatFlags) As String
Dim Result As String = String.Copy(MyString)
TextRenderer.MeasureText(Result, Font, New Drawing.Size(Width, 0),
FormatFlags Or TextFormatFlags.ModifyString)
To set a label to a compacted version of the string path you would call:
Label1.Text = CompactString(MyPath, Label1.Width, Label1.Font,
For example, the string: c:\program files\test app\runme.exe might turn into:
c:\program files\...\runme.exe depending on the font and width.
Check out the
Windows.Forms.TextFormatFlags enumerated type for other options on how to compact your string.
TextFormatFlags.WordEllipsis for example will insert a "..." at the end of the string instead in between parts of a path.
Points of Interest
You might be thinking, why not just write your own algorithm to break apart a string and insert the ellipsis in a certain spot. And in fact I have seen programmers doing this but I would recommend using the framework to handle this for a couple reasons:
- Why reinvent the wheel? Microsoft already did it and it's probably well tested and efficient; do you really have extra time on your hands?
- What if the standard for where to put the ellipsis changes? Maybe someday the ellipsis will be commonly inserted just after the drive letter instead of just before the filename. Let MS think about these details and just follow their lead. If MS changes this implementation internally, your app will automatically follow suit.
I am a software architect and engineer who has been working in the industry since 1994. Although I officially started writing software many years earlier at age 11 by authoring games, graphics demos, or whatever I found interesting. I even landed my first consulting job at age 16 implementing a newly invented mathimatical algorithm for a team of researchers at the local University.
I've designed and implemented hundreds if not thousands of applications: client, web, and hybrid of all scales and was a contributing author to the Black Belt programming column of Visual Basic Programmer's Journal.
My goals when coding are always to write clean, reusable and optimized code using the latest and technology, tools and techniques.