StringInfo.ParseCombiningCharacters Method

Parameters

• str
  Type: System.String
  The string to search.

Return Value

Type: array<System.Int32[]
An array of integers that contains the zero-based index of each base character, high surrogate, or control character within the specified string.

Imports System.Globalization
Imports System.Text

Module Example
   Public Sub Demo(outputBlock As System.Windows.Controls.TextBlock)
      ' The string below contains combining characters.
      Dim chars() As Char = {"a"c, ChrW(&h0304), ChrW(&h0308), "b"c, "c"c, ChrW(&h0327)}
      Dim s As New String(chars)

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

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

   ' Show how to enumerate each real character (honoring surrogates) in a string.
   Private Sub EnumTextElements(outputBlock As System.Windows.Controls.TextBlock, 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(), vbCrLf)
      Loop

      ' Show the results.
      outputBlock.Text &= "Result of GetTextElementEnumerator:" & vbCrLf
      outputBlock.Text &= sb.ToString() & vbCrLf
   End Sub

   ' Show how to discover the index of each real character (honoring surrogates) in a string.
   Private Sub EnumTextElementIndexes(outputBlock As System.Windows.Controls.TextBlock, 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 Integer = 0 To textElemIndex.Length - 1
         sb.AppendFormat("Character {0} starts at index {1}{2}", _
                         i, textElemIndex(i), vbCrLf)
      Next

      ' Show the results.
      outputBlock.Text &= "Result of ParseCombiningCharacters:" & vbCrLf
      outputBlock.Text &= sb.ToString() & vbCrLf
   End Sub
End Module
' 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

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