Export (0) Print
Expand All
0 out of 2 rated this helpful - Rate this topic

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)
'Declaration
<SerializableAttribute> _
<ComVisibleAttribute(True)> _
Public Class StringInfo

The StringInfo type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryStringInfoInitializes a new instance of the StringInfo class.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryStringInfo(String)Initializes a new instance of the StringInfo class to a specified string.
Top
  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryLengthInTextElementsGets the number of text elements in the current StringInfo object.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryStringGets or sets the value of the current StringInfo object.
Top
  NameDescription
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEqualsIndicates whether the current StringInfo object is equal to a specified object. (Overrides Object.Equals(Object).)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeCalculates a hash code for the value of the current StringInfo object. (Overrides Object.GetHashCode.)
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryGetNextTextElement(String)Gets the first text element in a specified string.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryGetNextTextElement(String, Int32)Gets the text element at the specified index of the specified string.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryGetTextElementEnumerator(String)Returns an enumerator that iterates through the text elements of the entire string.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryGetTextElementEnumerator(String, Int32)Returns an enumerator that iterates through the text elements of the string, starting at the specified index.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryParseCombiningCharactersReturns the indexes of each base character, high surrogate, or control character within the specified string.
Public methodSubstringByTextElements(Int32)Retrieves a substring of text elements from the current StringInfo object starting from a specified text element and continuing through the last text element.
Public methodSubstringByTextElements(Int32, Int32)Retrieves a substring of text elements from the current StringInfo object starting from a specified text element and continuing through the specified number of text elements.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns 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.

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.


Imports System.Text
Imports System.Globalization

Public Module Example
   Public Sub Main()
      ' The string below contains combining characters.
      Dim s As String = "a" + ChrW(&h0304) + ChrW(&h0308) + "bc" + ChrW(&h0327)

      ' Show each 'character' in the string.
      EnumTextElements(s)

      ' Show the index in the string where each 'character' starts.
      EnumTextElementIndexes(s)
   End Sub

   ' Show how to enumerate each real character (honoring surrogates) in a string.
   Sub EnumTextElements(s As String)
      ' This StringBuilder holds the output results.
      Dim sb As New StringBuilder()

      ' Use the enumerator returned from GetTextElementEnumerator 
      ' method to examine each real character.
      Dim charEnum As TextElementEnumerator = StringInfo.GetTextElementEnumerator(s)
      Do While charEnum.MoveNext()
         sb.AppendFormat("Character at index {0} is '{1}'{2}",
                         charEnum.ElementIndex, 
                         charEnum.GetTextElement(),
                         Environment.NewLine)
      Loop

      ' Show the results.
      Console.WriteLine("Result of GetTextElementEnumerator:")
      Console.WriteLine(sb)
   End Sub

   ' Show how to discover the index of each real character (honoring surrogates) in a string.
   Sub EnumTextElementIndexes(s As String)
      ' This StringBuilder holds the output results.
      Dim sb As New StringBuilder()

      ' Use the ParseCombiningCharacters method to 
      ' get the index of each real character in the string.
      Dim textElemIndex() As Integer = StringInfo.ParseCombiningCharacters(s)

      ' Iterate through each real character showing the character and the index where it was found.
      For i As Int32 = 0 To textElemIndex.Length - 1
         sb.AppendFormat("Character {0} starts at index {1}{2}",
                         i, textElemIndex(i), Environment.NewLine)
      Next

      ' Show the results.
      Console.WriteLine("Result of ParseCombiningCharacters:")
      Console.WriteLine(sb)
   End Sub
End Module
' The example displays 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


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.