StringInfo クラス

定義

文字列をテキスト要素に分割し、そのテキスト要素を反復処理する機能を提供します。Provides functionality to split a string into text elements and to iterate through those text elements.

public ref class StringInfo
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class StringInfo
type StringInfo = class
Public Class StringInfo
継承
StringInfo
属性

この例では、StringInfo クラスの GetTextElementEnumerator および ParseCombiningCharacters メソッドを使用して、サロゲート文字と組み合わせ文字を含む文字列を操作します。This example uses the GetTextElementEnumerator and ParseCombiningCharacters methods of the StringInfo class to manipulate a string that contains surrogate and combining characters.

using namespace System;
using namespace System::Text;
using namespace System::Globalization;


// Show how to enumerate each real character (honoring surrogates)
// in a string.

void EnumTextElements(String^ combiningChars)
{
    // This StringBuilder holds the output results.
    StringBuilder^ sb = gcnew StringBuilder();

    // Use the enumerator returned from GetTextElementEnumerator
    // method to examine each real character.
    TextElementEnumerator^ charEnum =
        StringInfo::GetTextElementEnumerator(combiningChars);
    while (charEnum->MoveNext())
    {
        sb->AppendFormat("Character at index {0} is '{1}'{2}", 
            charEnum->ElementIndex, charEnum->GetTextElement(), 
            Environment::NewLine);
    }

    // Show the results.
    Console::WriteLine("Result of GetTextElementEnumerator:");
    Console::WriteLine(sb);
}


// Show how to discover the index of each real character
// (honoring surrogates) in a string.

void EnumTextElementIndexes(String^ combiningChars)
{
    // This StringBuilder holds the output results.
    StringBuilder^ sb = gcnew StringBuilder();

    // Use the ParseCombiningCharacters method to
    // get the index of each real character in the string.
    array <int>^ textElemIndex =
        StringInfo::ParseCombiningCharacters(combiningChars);

    // Iterate through each real character showing the character
    // and the index where it was found.
    for (int i = 0; i < textElemIndex->Length; i++)
    {
        sb->AppendFormat("Character {0} starts at index {1}{2}",
            i, textElemIndex[i], Environment::NewLine);
    }

    // Show the results.
    Console::WriteLine("Result of ParseCombiningCharacters:");
    Console::WriteLine(sb);
}

int main()
{

    // The string below contains combining characters.
    String^ combiningChars = L"a\u0304\u0308bc\u0327";

    // Show each 'character' in the string.
    EnumTextElements(combiningChars);

    // Show the index in the string where each 'character' starts.
    EnumTextElementIndexes(combiningChars);

};

// 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 sealed class App {
   static void Main() {
      // The string below contains combining characters.
      String s = "a\u0304\u0308bc\u0327";

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

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

   // Show how to enumerate each real character (honoring surrogates) in a string.
   static void EnumTextElements(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}'{2}",
           charEnum.ElementIndex, charEnum.GetTextElement(),
           Environment.NewLine);
      }

      // Show the results.
      Console.WriteLine("Result of GetTextElementEnumerator:");
      Console.WriteLine(sb);
   }

   // Show how to discover the index of each real character (honoring surrogates) in a string.
   static void EnumTextElementIndexes(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}{2}",
            i, textElemIndex[i], Environment.NewLine);
      }

      // Show the results.
      Console.WriteLine("Result of ParseCombiningCharacters:");
      Console.WriteLine(sb);
   }
}

// 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
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 では、テキスト要素を1つの文字 (書記素) として表示されるテキストの単位として定義します。.NET 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. Unicode 規格では、2つのコード単位のシーケンスで構成される単一の抽象文字のコード化された文字表現としてサロゲートペアを定義します。ペアの最初の単位は上位サロゲート、2番目は下位サロゲートです。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. Unicode 規格では、基本文字と1つ以上の組み合わせ文字の組み合わせとして、組み合わせ文字シーケンスを定義します。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.

StringInfo クラスを使用すると、個別の Char オブジェクトではなく、一連のテキスト要素として文字列を操作できます。The StringInfo class enables you to work with a string as a series of textual elements rather than individual Char objects.

指定した文字列を表す StringInfo オブジェクトをインスタンス化するには、次のいずれかの操作を行います。To instantiate a StringInfo object that represents a specified string, you can do either of the following:

文字列内の個々のテキスト要素を操作するには、次の2つの方法があります。You can work with the individual text elements in a string in two ways:

  • 各テキスト要素を列挙する。By enumerating each text element. これを行うには、GetTextElementEnumerator メソッドを呼び出し、メソッドが falseを返すまで、返された TextElementEnumerator オブジェクトに対して MoveNext メソッドを繰り返し呼び出します。To do this, you call the GetTextElementEnumerator method, and then repeatedly call the MoveNext method on the returned TextElementEnumerator object until the method returns false.

  • ParseCombiningCharacters メソッドを呼び出して、各テキスト要素の開始インデックスを含む配列を取得する。By calling the ParseCombiningCharacters method to retrieve an array that contains the starting index of each text element. これらのインデックスを SubstringByTextElements メソッドに渡すことによって、個々のテキスト要素を取得できます。You can then retrieve individual text elements by passing these indexes to the SubstringByTextElements method.

次の例は、文字列内のテキスト要素を操作する両方の方法を示しています。The following example illustrates both ways of working with the text elements in a string. 次の2つの文字列が作成されます。It creates two strings:

  • strCombining、複数の Char オブジェクトを持つ3つのテキスト要素を含むアラビア文字の文字列です。strCombining, which is a string of Arabic characters that includes three text elements with multiple Char objects. 最初のテキスト要素は、基本文字のアラビア文字の ALEF (U +-627) の後に、アラビア語の KASRA (u +-655) とアラビア語 (u + 0650) を続けたものです。The first text element is the base character ARABIC LETTER ALEF (U+-627) followed by ARABIC HAMZA BELOW (U+-655) and ARABIC KASRA (U+0650). 2番目のテキスト要素は、アラビア文字のへー (U + 0647) の後にアラビア語 FATHA (U +-64E) が続きます。The second text element is ARABIC LETTER HEH (U+0647) followed by ARABIC FATHA (U+-64E). 3番目のテキスト要素は、アラビア文字バー (U + 0628) の後にアラビア語 DAMMATAN (U + 064C) が続きます。The third text element is ARABIC LETTER BEH (U+0628) followed by ARABIC DAMMATAN (U+064C).

  • strSurrogates、3つのサロゲートペアを含む文字列です。ギリシャ語 ACROPHONIC 5 才能 (U + 10148)、補助多言語プレーンからの U + 20026、補助表意文字平面からの u +、プライベートユーザー領域からの U + F1001。strSurrogates, which is a string that includes three surrogate pairs: GREEK ACROPHONIC FIVE TALENTS (U+10148) from the Supplementary Multilingual Plane, U+20026 from the Supplementary Ideographic Plane, and U+F1001 from the private user area. 各文字の UTF-16 エンコーディングは、上位サロゲートと下位サロゲートで構成されるサロゲートペアです。The UTF-16 encoding of each character is a surrogate pair that consists of a high surrogate followed by a low surrogate.

各文字列は、ParseCombiningCharacters メソッドによって1回、次に GetTextElementEnumerator メソッドによって解析されます。Each string is parsed once by the ParseCombiningCharacters method and then by the GetTextElementEnumerator method. どちらのメソッドも、2つの文字列のテキスト要素を正しく解析し、解析操作の結果を表示します。Both methods correctly parse the text elements in the two strings and display the results of the parsing operation.

using System;
using System.Globalization;

public class Example
{
   public static void Main()
   {
      // The Unicode code points specify Arabic base characters and 
      // combining character sequences.
      string strCombining = "\u0627\u0655\u0650\u064A\u0647\u064E" +
                            "\u0627\u0628\u064C";

      // The Unicode code points specify private surrogate pairs.
      string strSurrogates = Char.ConvertFromUtf32(0x10148) +
                             Char.ConvertFromUtf32(0x20026) + "a" +
                             Char.ConvertFromUtf32(0xF1001);
      
      EnumerateTextElements(strCombining);
      EnumerateTextElements(strSurrogates);
   }

   public static void EnumerateTextElements(string str)
   {
      // Get the Enumerator.
      TextElementEnumerator teEnum = null;      

      // Parse the string using the ParseCombiningCharacters method.
      Console.WriteLine("\nParsing with ParseCombiningCharacters:");
      int[] teIndices = StringInfo.ParseCombiningCharacters(str);
      
      for (int i = 0; i < teIndices.Length; i++) {
         if (i < teIndices.Length - 1)
            Console.WriteLine("Text Element {0} ({1}..{2})= {3}", i, 
               teIndices[i], teIndices[i + 1] - 1, 
               ShowHexValues(str.Substring(teIndices[i], teIndices[i + 1] - 
                             teIndices[i])));
         else
            Console.WriteLine("Text Element {0} ({1}..{2})= {3}", i, 
               teIndices[i], str.Length - 1, 
               ShowHexValues(str.Substring(teIndices[i])));
      }
      Console.WriteLine();

      // Parse the string with the GetTextElementEnumerator method.
      Console.WriteLine("Parsing with TextElementEnumerator:");
      teEnum = StringInfo.GetTextElementEnumerator(str);

      int teCount = - 1;

      while (teEnum.MoveNext()) {
         // Displays the current element.
         // Both GetTextElement() and Current retrieve the current
         // text element. The latter returns it as an Object.
         teCount++;
         Console.WriteLine("Text Element {0} ({1}..{2})= {3}", teCount, 
            teEnum.ElementIndex, teEnum.ElementIndex + 
            teEnum.GetTextElement().Length - 1, ShowHexValues((string)(teEnum.Current)));
      }
   }
   
   private static string ShowHexValues(string s)
   {
      string hexString = "";
      foreach (var ch in s)
         hexString += String.Format("{0:X4} ", Convert.ToUInt16(ch));

      return hexString;
   }
}
// The example displays the following output:
//       Parsing with ParseCombiningCharacters:
//       Text Element 0 (0..2)= 0627 0655 0650
//       Text Element 1 (3..3)= 064A
//       Text Element 2 (4..5)= 0647 064E
//       Text Element 3 (6..6)= 0627
//       Text Element 4 (7..8)= 0628 064C
//       
//       Parsing with TextElementEnumerator:
//       Text Element 0 (0..2)= 0627 0655 0650
//       Text Element 1 (3..3)= 064A
//       Text Element 2 (4..5)= 0647 064E
//       Text Element 3 (6..6)= 0627
//       Text Element 4 (7..8)= 0628 064C
//       
//       Parsing with ParseCombiningCharacters:
//       Text Element 0 (0..1)= D800 DD48
//       Text Element 1 (2..3)= D840 DC26
//       Text Element 2 (4..4)= 0061
//       Text Element 3 (5..6)= DB84 DC01
//       
//       Parsing with TextElementEnumerator:
//       Text Element 0 (0..1)= D800 DD48
//       Text Element 1 (2..3)= D840 DC26
//       Text Element 2 (4..4)= 0061
//       Text Element 3 (5..6)= DB84 DC01
Imports System.Globalization

Public Module Example
   Public Sub Main()
      ' The Unicode code points specify Arabic base characters and 
      ' combining character sequences.
      Dim strCombining As String = ChrW(&H627) & ChrW(&h0655) + ChrW(&H650) & 
              ChrW(&H64A) & ChrW(&H647) & ChrW(&H64E) & ChrW(&H627) & 
              ChrW(&H628) & ChrW(&H64C)

      ' The Unicode code points specify private surrogate pairs.
      Dim strSurrogates As String = Char.ConvertFromUtf32(&h10148) +
                                    Char.ConvertFromUtf32(&h20026) + "a" +
                                    Char.ConvertFromUtf32(&hF1001)
      
      EnumerateTextElements(strCombining)
      EnumerateTextElements(strSurrogates)
   End Sub

   Public Sub EnumerateTextElements(str As String)
      ' Get the Enumerator.
      Dim teEnum As TextElementEnumerator = Nothing      

      ' Parse the string using the ParseCombiningCharacters method.
      Console.WriteLine()
      Console.WriteLine("Parsing with ParseCombiningCharacters:")
      Dim teIndices As Integer() = StringInfo.ParseCombiningCharacters(str)
      
      For i As Integer = 0 To teIndices.Length - 1
         If i < teIndices.Length - 1 Then
            Console.WriteLine("Text Element {0} ({1}..{2})= {3}", i, 
               TEIndices(i), TEIndices((i + 1)) - 1, 
               ShowHexValues(str.Substring(TEIndices(i), TEIndices((i + 1)) - 
                             teIndices(i))))
         Else
            Console.WriteLine("Text Element {0} ({1}..{2})= {3}", i, 
               teIndices(i), str.Length - 1, 
               ShowHexValues(str.Substring(teIndices(i))))
         End If
      Next
      Console.WriteLine()

      ' Parse the string with the GetTextElementEnumerator method.
      Console.WriteLine("Parsing with TextElementEnumerator:")
      teEnum = StringInfo.GetTextElementEnumerator(str)

      Dim TECount As Integer = - 1

      While teEnum.MoveNext()
         ' Prints the current element.
         ' Both GetTextElement() and Current retrieve the current
         ' text element. The latter returns it as an Object.
         TECount += 1
         Console.WriteLine("Text Element {0} ({1}..{2})= {3}", teCount, 
            teEnum.ElementIndex, teEnum.ElementIndex + 
            teEnum.GetTextElement().Length - 1, ShowHexValues(CStr(teEnum.Current)))
      End While
   End Sub
   
   Private Function ShowHexValues(s As String) As String
      Dim hexString As String = ""
      For Each ch In s
         hexString += String.Format("{0:X4} ", Convert.ToUInt16(ch))
      Next
      Return hexString
   End Function
End Module
' The example displays the following output:
'       Parsing with ParseCombiningCharacters:
'       Text Element 0 (0..2)= 0627 0655 0650
'       Text Element 1 (3..3)= 064A
'       Text Element 2 (4..5)= 0647 064E
'       Text Element 3 (6..6)= 0627
'       Text Element 4 (7..8)= 0628 064C
'       
'       Parsing with TextElementEnumerator:
'       Text Element 0 (0..2)= 0627 0655 0650
'       Text Element 1 (3..3)= 064A
'       Text Element 2 (4..5)= 0647 064E
'       Text Element 3 (6..6)= 0627
'       Text Element 4 (7..8)= 0628 064C
'       
'       Parsing with ParseCombiningCharacters:
'       Text Element 0 (0..1)= D800 DD48
'       Text Element 1 (2..3)= D840 DC26
'       Text Element 2 (4..4)= 0061
'       Text Element 3 (5..6)= DB84 DC01
'       
'       Parsing with TextElementEnumerator:
'       Text Element 0 (0..1)= D800 DD48
'       Text Element 1 (2..3)= D840 DC26
'       Text Element 2 (4..4)= 0061
'       Text Element 3 (5..6)= DB84 DC01

注意 (呼び出し元)

内部的には、StringInfo クラスのメソッドは、CharUnicodeInfo クラスのメソッドを呼び出して、文字カテゴリを決定します。Internally, the methods of the StringInfo class call the methods of the CharUnicodeInfo class to determine character categories. .NET Framework 4.6.2 以降では、文字分類はUnicode 標準バージョン 8.0.0に基づいています。Starting with the .NET Framework 4.6.2, character classification is based on The Unicode Standard, Version 8.0.0. .NET Framework 4 ~ .NET Framework 4.6.1 では、 Unicode 標準バージョン 6.3.0に基づいています。For the .NET Framework 4 through the .NET Framework 4.6.1, it is based on The Unicode Standard, Version 6.3.0. .NET Core では、 Unicode 標準バージョン 8.0.0に基づいています。In .NET Core, it is based on The Unicode Standard, Version 8.0.0.

コンストラクター

StringInfo()

StringInfo クラスの新しいインスタンスを初期化します。Initializes a new instance of the StringInfo class.

StringInfo(String)

StringInfo クラスの新しいインスタンスを指定した文字列に初期化します。Initializes a new instance of the StringInfo class to a specified string.

プロパティ

LengthInTextElements

現在の StringInfo オブジェクト内のテキスト要素数を取得します。Gets the number of text elements in the current StringInfo object.

String

現在の StringInfo オブジェクトの値を取得または設定します。Gets or sets the value of the current StringInfo object.

メソッド

Equals(Object)

現在の StringInfo オブジェクトが指定されたオブジェクトと等しいかどうかを示します。Indicates whether the current StringInfo object is equal to a specified object.

GetHashCode()

現在の StringInfo オブジェクトの値のハッシュ コードを計算します。Calculates a hash code for the value of the current StringInfo object.

GetNextTextElement(String)

指定した文字列の最初のテキスト要素を取得します。Gets the first text element in a specified string.

GetNextTextElement(String, Int32)

指定した文字列の指定したインデックスにあるテキスト要素を取得します。Gets the text element at the specified index of the specified string.

GetTextElementEnumerator(String)

文字列全体のテキスト要素を反復処理する列挙子を返します。Returns an enumerator that iterates through the text elements of the entire string.

GetTextElementEnumerator(String, Int32)

指定したインデックスから開始する文字列のテキスト要素を反復処理する列挙子を返します。Returns an enumerator that iterates through the text elements of the string, starting at the specified index.

GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ParseCombiningCharacters(String)

指定した文字列の各基本文字、上位サロゲート、または制御文字のインデックスを返します。Returns the indexes of each base character, high surrogate, or control character within the specified string.

SubstringByTextElements(Int32)

指定されたテキスト要素から最後のテキスト要素までの範囲内で、現在の StringInfo オブジェクトからテキスト要素の部分文字列を取得します。Retrieves a substring of text elements from the current StringInfo object starting from a specified text element and continuing through the last text element.

SubstringByTextElements(Int32, Int32)

指定されたテキスト要素から指定された数のテキスト要素までの範囲内で、現在の StringInfo オブジェクトからテキスト要素の部分文字列を取得します。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.

ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

適用対象

こちらもご覧ください