Truncates the specified string.

image_pdfimage_print
   
 

#region License
// Copyright (c) 2007 James Newton-King
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;


namespace Newtonsoft.Utilities.Text
{
  public static class StringExtensions
  {


    /// <summary>
    /// Truncates the specified string.
    /// </summary>
    /// <param name="s">The string to truncate.</param>
    /// <param name="maximumLength">The maximum length of the string before it is truncated.</param>
    /// <returns></returns>
    public static string Truncate(this string s, int maximumLength)
    {
      return Truncate(s, maximumLength, "...");
    }

    /// <summary>
    /// Truncates the specified string.
    /// </summary>
    /// <param name="s">The string to truncate.</param>
    /// <param name="maximumLength">The maximum length of the string before it is truncated.</param>
    /// <param name="suffix">The suffix to place at the end of the truncated string.</param>
    /// <returns></returns>
    public static string Truncate(this string s, int maximumLength, string suffix)
    {
      if (suffix == null)
        throw new ArgumentNullException("suffix");

      if (maximumLength <= 0)
        throw new ArgumentException("Maximum length must be greater than zero.", "maximumLength");

      int subStringLength = maximumLength - suffix.Length;

      if (subStringLength <= 0)
        throw new ArgumentException("Length of suffix string is greater or equal to maximumLength");

      if (s != null &amp;&amp; s.Length > maximumLength)
      {
        string truncatedString = s.Substring(0, subStringLength);
        // incase the last character is a space
        truncatedString = truncatedString.TrimEnd();
        truncatedString += suffix;

        return truncatedString;
      }
      else
      {
        return s;
      }
    }

  }
}

   
     


This entry was posted in Data Types. Bookmark the permalink.