StringInfo Class

Provides functionality to split a string into text elements and to iterate through those text elements.

System.Object
  System.Globalization.StringInfo

Namespace:  System.Globalization
Assembly:  mscorlib (in mscorlib.dll)

public class StringInfo

The StringInfo type exposes the following members.

  NameDescription
Public methodStringInfo()Initializes a new instance of the StringInfo class.
Public methodStringInfo(String)Initializes a new instance of the StringInfo class to a specified string.
Top

  NameDescription
Public propertyLengthInTextElementsGets the number of text elements in the current StringInfo object.
Public propertyStringGets or sets the value of the current StringInfo object.
Top

  NameDescription
Public methodEqualsIndicates whether the current StringInfo object is equal to a specified object. (Overrides Object.Equals(Object).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeCalculates a hash code for the value of the current StringInfo object. (Overrides Object.GetHashCode().)
Public methodStatic memberGetNextTextElement(String)Gets the first text element in a specified string.
Public methodStatic memberGetNextTextElement(String, Int32)Gets the text element at the specified index of the specified string.
Public methodStatic memberGetTextElementEnumerator(String)Returns an enumerator that iterates through the text elements of the entire string.
Public methodStatic memberGetTextElementEnumerator(String, Int32)Returns an enumerator that iterates through the text elements of the string, starting at the specified index.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic memberParseCombiningCharactersReturns the index of each base character, high surrogate, or control character within the specified string.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The .NET Framework defines a text element as a unit of text that is displayed as a single character, that is, a grapheme. A text element can be a base character, a surrogate pair, or a combining character sequence. The Unicode Standard defines a surrogate pair as a coded character representation for a single abstract character that consists of a sequence of two code units, where the first unit of the pair is a high surrogate and the second is a low surrogate. The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. A surrogate pair can represent a base character or a combining character.

For more information on surrogate pairs and combining character sequences, see The Unicode Standard at http://www.unicode.org.

This example shows how to use the GetTextElementEnumerator and ParseCombiningCharacters methods of the StringInfo class to manipulate a string that contains surrogate and combining characters.


using System;
using System.Text;
using System.Globalization;

public class Example
{
   public static void Demo(System.Windows.Controls.TextBlock outputBlock)
   {
      // The string below contains combining characters.
      String s = "a\u0304\u0308bc\u0327";

      // Show each 'character' in the string.
      EnumTextElements(outputBlock, s);

      // Show the index in the string where each 'character' starts.
      EnumTextElementIndexes(outputBlock, s);
   }

   // Show how to enumerate each real character (honoring surrogates) in a string.
   static void EnumTextElements(System.Windows.Controls.TextBlock outputBlock, String s)
   {
      // This StringBuilder holds the output results.
      StringBuilder sb = new StringBuilder();

      // Use the enumerator returned from GetTextElementEnumerator 
      // method to examine each real character.
      TextElementEnumerator charEnum = StringInfo.GetTextElementEnumerator(s);
      while (charEnum.MoveNext())
      {
         sb.AppendFormat(
           "Character at index {0} is '{1}'\n",
           charEnum.ElementIndex, charEnum.GetTextElement());
      }

      // Show the results.
      outputBlock.Text += "Result of GetTextElementEnumerator:" + "\n";
      outputBlock.Text += sb + "\n";
   }

   // Show how to discover the index of each real character (honoring surrogates) in a string.
   static void EnumTextElementIndexes(System.Windows.Controls.TextBlock outputBlock, String s)
   {
      // This StringBuilder holds the output results.
      StringBuilder sb = new StringBuilder();

      // Use the ParseCombiningCharacters method to 
      // get the index of each real character in the string.
      Int32[] textElemIndex = StringInfo.ParseCombiningCharacters(s);

      // Iterate through each real character showing the character and the index where it was found.
      for (Int32 i = 0; i < textElemIndex.Length; i++)
      {
         sb.AppendFormat(
            "Character {0} starts at index {1}\n", i, textElemIndex[i]);
      }

      // Show the results.
      outputBlock.Text += "Result of ParseCombiningCharacters:" + "\n";
      outputBlock.Text += sb + "\n";
   }
}

// This code produces the following output.
//
// Result of GetTextElementEnumerator:
// Character at index 0 is 'a-"'
// Character at index 3 is 'b'
// Character at index 4 is 'c,'
// 
// Result of ParseCombiningCharacters:
// Character 0 starts at index 0
// Character 1 starts at index 3
// Character 2 starts at index 4


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2015 Microsoft