StringInfo.GetTextElementEnumerator StringInfo.GetTextElementEnumerator StringInfo.GetTextElementEnumerator StringInfo.GetTextElementEnumerator Method

Определение

Возвращает перечислитель, который выполняет итерацию по текстовым элементам строки.Returns an enumerator that iterates through the text elements of a string.

Перегрузки

GetTextElementEnumerator(String) GetTextElementEnumerator(String) GetTextElementEnumerator(String) GetTextElementEnumerator(String)

Возвращает перечислитель, который выполняет итерацию по текстовым элементам всей строки.Returns an enumerator that iterates through the text elements of the entire string.

GetTextElementEnumerator(String, Int32) GetTextElementEnumerator(String, Int32) GetTextElementEnumerator(String, Int32) GetTextElementEnumerator(String, Int32)

Возвращает перечислитель, который может выполнять итерацию по текстовым элементам строки, начиная с указанного индекса.Returns an enumerator that iterates through the text elements of the string, starting at the specified index.

GetTextElementEnumerator(String) GetTextElementEnumerator(String) GetTextElementEnumerator(String) GetTextElementEnumerator(String)

Возвращает перечислитель, который выполняет итерацию по текстовым элементам всей строки.Returns an enumerator that iterates through the text elements of the entire string.

public:
 static System::Globalization::TextElementEnumerator ^ GetTextElementEnumerator(System::String ^ str);
public static System.Globalization.TextElementEnumerator GetTextElementEnumerator (string str);
static member GetTextElementEnumerator : string -> System.Globalization.TextElementEnumerator
Public Shared Function GetTextElementEnumerator (str As String) As TextElementEnumerator

Параметры

str
String String String String

Строка, в выполняется итерация.The string to iterate through.

Возвраты

Исключения

Примеры

В следующем примере демонстрируется вызов метода GetTextElementEnumerator.The following example demonstrates calling the GetTextElementEnumerator method. Этот пример является частью большого примера, StringInfo приведенного для класса.This example is part of a larger example provided for the StringInfo class.

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 определяет текстовый элемент как блок текста, который отображается как один символ, то есть графеме..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. Стандарт Юникода определяет суррогатную пару как закодированное представление символа для одного абстрактного символа, состоящего из последовательности двух единиц кода, где первая единица пары является старшим суррогатом, а вторая — младшим суррогатом.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 определяет последовательность присоединяемых символов как сочетание базового символа и одного или нескольких Объединенных символов.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.

Перечислитель элементов текста используется только для чтения данных в строке. Он не может изменить базовую строку.The text element enumerator is used only to read data in the string; it cannot modify the underlying string. Перечислитель не имеет монопольного доступа к строке.The enumerator does not have exclusive access to the string.

Перечислитель находится в недопустимом состоянии, если он расположен перед первым текстовым элементом в строке или после последнего текстового элемента в строке.The enumerator is in an invalid state if it is positioned before the first text element in the string or after the last text element in the string. Если перечислитель находится в недопустимом состоянии, вызов Current создает исключение.When the enumerator is in an invalid state, calling Current throws an exception.

Изначально перечислитель располагается перед первым текстовым элементом в строке.Initially, the enumerator is positioned before the first text element in the string. Метод Reset также переводит перечислитель в эту позицию.Reset also brings the enumerator back to this position. Таким образом, после создания перечислителя или Reset вызова метода необходимо вызвать метод, MoveNext чтобы переместить перечислитель к первому текстовому элементу строки Currentперед считыванием значения.Therefore, after an enumerator is created or after Reset is called, MoveNext must be called to advance the enumerator to the first text element of the string before reading the value of Current.

Current возвращает тот же объект, пока не будет вызван метод MoveNext или Reset.Current returns the same object until either MoveNext or Reset is called.

После передачи конца строки перечислитель снова находится в недопустимом состоянии и вызывается метод MoveNext ReturnS. falseAfter the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. При Current вызове метода создается исключение, если последний MoveNext вызов falseвозвращал.Calling Current throws an exception if the last call to MoveNext returned false.

Дополнительно

GetTextElementEnumerator(String, Int32) GetTextElementEnumerator(String, Int32) GetTextElementEnumerator(String, Int32) GetTextElementEnumerator(String, Int32)

Возвращает перечислитель, который может выполнять итерацию по текстовым элементам строки, начиная с указанного индекса.Returns an enumerator that iterates through the text elements of the string, starting at the specified index.

public:
 static System::Globalization::TextElementEnumerator ^ GetTextElementEnumerator(System::String ^ str, int index);
public static System.Globalization.TextElementEnumerator GetTextElementEnumerator (string str, int index);
static member GetTextElementEnumerator : string * int -> System.Globalization.TextElementEnumerator
Public Shared Function GetTextElementEnumerator (str As String, index As Integer) As TextElementEnumerator

Параметры

str
String String String String

Строка, в выполняется итерация.The string to iterate through.

index
Int32 Int32 Int32 Int32

Отсчитываемый от нуля индекс, с которого необходимо начать итерацию.The zero-based index at which to start iterating.

Возвраты

Параметр TextElementEnumerator для всей строки, начиная с индекса index.A TextElementEnumerator for the string starting at index.

Исключения

Значение параметра index находится вне диапазона допустимых индексов параметра str.index is outside the range of valid indexes for str.

Комментарии

.NET определяет текстовый элемент как блок текста, который отображается как один символ, то есть графеме..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. Стандарт Юникода определяет суррогатную пару как закодированное представление символа для одного абстрактного символа, состоящего из последовательности двух единиц кода, где первая единица пары является старшим суррогатом, а вторая — младшим суррогатом.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 определяет последовательность присоединяемых символов как сочетание базового символа и одного или нескольких Объединенных символов.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.

Перечислитель элементов текста используется только для чтения данных в строке. Он не может изменить базовую строку.The text element enumerator is used only to read data in the string; it cannot modify the underlying string. Перечислитель не имеет монопольного доступа к строке.The enumerator does not have exclusive access to the string.

Перечислитель находится в недопустимом состоянии, если он расположен перед первым текстовым элементом в строке или после последнего текстового элемента в строке.The enumerator is in an invalid state if it is positioned before the first text element in the string or after the last text element in the string. Если перечислитель находится в недопустимом состоянии, вызов Current создает исключение.When the enumerator is in an invalid state, calling Current throws an exception.

Изначально перечислитель располагается перед первым текстовым элементом в строке.Initially, the enumerator is positioned before the first text element in the string. Метод Reset также переводит перечислитель в эту позицию.Reset also brings the enumerator back to this position. Таким образом, после создания перечислителя или Reset вызова метода необходимо вызвать метод, MoveNext чтобы переместить перечислитель к первому текстовому элементу строки Currentперед считыванием значения.Therefore, after an enumerator is created or after Reset is called, MoveNext must be called to advance the enumerator to the first text element of the string before reading the value of Current.

Current возвращает тот же объект, пока не будет вызван метод MoveNext или Reset.Current returns the same object until either MoveNext or Reset is called.

После передачи конца строки перечислитель снова находится в недопустимом состоянии и вызывается метод MoveNext ReturnS. falseAfter the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. При Current вызове метода создается исключение, если последний MoveNext вызов falseвозвращал.Calling Current throws an exception if the last call to MoveNext returned false.

Дополнительно

Применяется к