Truncates the specified string. : String Util « Data Types « C# / C Sharp






  1. C# / C Sharp
  2. Data Types
  3. String Util

Truncates the specified string.

    

#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 && 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;
      }
    }

  }
}








Related examples in the same category

1.Generate ToString for given object
2.Remove all Html tag in a string
3.If given string Not Null Or Empty
4.Does string Contain White Space
5.Is given string white space
6.Ensure given string to end with another string
7.Does a string have only one word
8.Is the input string null or empty
9.Get Right Side Of String
10.Count Lines In String
11.Reverse a string
12.Get used chars
13.Calculate the max count of continuous characters
14.Count number of chars in a string
15.Count lines in a string with IndexOf
16.Forces the string to word wrap so that each line doesn't exceed the maxLineLength.
17.Determines if a string consists of all valid ASCII values.
18.Gets the right side of the string.
19.Truncates the string from left side
20.Shortcut for string.Format.
21.Gets the string up to the maximum number of characters.
22.Xml Encode String
23.returns the last word of the string, using separators space ,;!?:
24.checks if a string is null or empty or is made only of spaces
25.joins the strings with the speficied separator.
26.Truncates the string.
27.Truncate with text
28.If null returns empty string, else, returns original.
29.Returns the defaultval if the val string is null or empty.
30.Convert the word(s) in the sentence to sentence case.
31.Get the index of a spacer ( space" " or newline )
32.Remove Trailing Path Delimeter
33.Get delimited chars from a string.
34.String Utils
35.If necessary, adds zeros to the beginning of a value so that the total length matches the given precision
36.Add leading and trailing double quotes to the provided string if required.
37.Determines whether the string has white space.
38.Determines whether the string is all white space. Empty string will return false.
39.Ensures the target string ends with the specified string.
40.Convert String To Upper Ignore Null
41.Returns the size of substring that does not contain any trailing spaces
42.Skips any spaces at or after start and returns the index of first non-space character;
43.Provides a collection of convenience methods for processing and creating objects with String value components.
44.Get new line string
45.Convert string to sentence case
46.Cut string and display three dots
47.Remove Html
48.Ensures the carriage returns. See http://cr.yp.to/docs/smtplf.html and 822bis section 2.3.
49.Select Single Inner Text
50.Returns a string with non alphanumeric chars converted to the substitute character.
51.Use HttpUtility.HtmlEncode to encode the input string
52.Shortened the string.
53.Get sub string
54.Joins the key/value pairs into a string
55.Crops a given text