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

Definição

Retorna um enumerador que itera por meio dos elementos de texto de uma cadeia de caracteres.Returns an enumerator that iterates through the text elements of a string.

Sobrecargas

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

Retorna um enumerador que itera pelos elementos de texto de toda a cadeia de caracteres.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)

Retorna um enumerador que itera por meio dos elementos de texto da cadeia de caracteres, começando no índice especificado.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)

Retorna um enumerador que itera pelos elementos de texto de toda a cadeia de caracteres.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

Parâmetros

str
String String String String

A cadeia de caracteres a iterar.The string to iterate through.

Retornos

Exceções

Exemplos

O exemplo a seguir demonstra a chamada a GetTextElementEnumerator método.The following example demonstrates calling the GetTextElementEnumerator method. Este exemplo é parte de um exemplo maior fornecido para o StringInfo classe.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

Comentários

O .NET define um elemento de texto como uma unidade de texto que é exibido como um único caractere, ou seja, um grafemas..NET defines a text element as a unit of text that is displayed as a single character, that is, a grapheme. Um elemento de texto pode ser um caractere base, um par substituto ou um caractere de combinação sequência.A text element can be a base character, a surrogate pair, or a combining character sequence. O padrão Unicode define um par substituto como uma representação de caracteres codificado para um único caractere abstrato que consiste em uma sequência de duas unidades de código, em que a primeira unidade do par é um substituto alto e o segundo é uma baixa substituto.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. O padrão Unicode define uma combinação sequência como uma combinação de um caractere base e um ou mais caracteres de combinação de caracteres.The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. Um par substituto pode representar um caractere base ou um caractere de combinação.A surrogate pair can represent a base character or a combining character.

O enumerador de elemento de texto é usado somente para ler os dados na cadeia de caracteres; ele não é possível modificar a cadeia de caracteres subjacente.The text element enumerator is used only to read data in the string; it cannot modify the underlying string. O enumerador não tem acesso exclusivo à cadeia de caracteres.The enumerator does not have exclusive access to the string.

O enumerador está em um estado inválido, se ele está posicionado antes do primeiro elemento de texto na cadeia de caracteres ou após o último elemento de texto na cadeia de caracteres.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. Quando o enumerador está em um estado inválido, chamando Current gera uma exceção.When the enumerator is in an invalid state, calling Current throws an exception.

Inicialmente, o enumerador está posicionado antes do primeiro elemento de texto na cadeia de caracteres.Initially, the enumerator is positioned before the first text element in the string. Reset também traz o enumerador de volta para essa posição.Reset also brings the enumerator back to this position. Portanto, após a criação de um enumerador ou depois Reset é chamado, MoveNext deve ser chamado para avançar o enumerador para o primeiro elemento de texto da cadeia de caracteres antes de ler o valor de 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 retorna o mesmo objeto até MoveNext ou Reset ser chamado.Current returns the same object until either MoveNext or Reset is called.

Após o final da cadeia de caracteres for passado, o enumerador está novamente em um inválido, estado e chamando MoveNext retorna false.After the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. Chamando Current gera uma exceção se a última chamada para MoveNext retornou false.Calling Current throws an exception if the last call to MoveNext returned false.

Veja também

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

Retorna um enumerador que itera por meio dos elementos de texto da cadeia de caracteres, começando no índice especificado.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

Parâmetros

str
String String String String

A cadeia de caracteres a iterar.The string to iterate through.

index
Int32 Int32 Int32 Int32

O índice baseado em zero no qual se começa a iterar.The zero-based index at which to start iterating.

Retornos

Um TextElementEnumerator para a cadeia de caracteres que começa em index.A TextElementEnumerator for the string starting at index.

Exceções

index está fora do intervalo de índices válidos para str.index is outside the range of valid indexes for str.

Comentários

O .NET define um elemento de texto como uma unidade de texto que é exibido como um único caractere, ou seja, um grafemas..NET defines a text element as a unit of text that is displayed as a single character, that is, a grapheme. Um elemento de texto pode ser um caractere base, um par substituto ou um caractere de combinação sequência.A text element can be a base character, a surrogate pair, or a combining character sequence. O padrão Unicode define um par substituto como uma representação de caracteres codificado para um único caractere abstrato que consiste em uma sequência de duas unidades de código, em que a primeira unidade do par é um substituto alto e o segundo é uma baixa substituto.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. O padrão Unicode define uma combinação sequência como uma combinação de um caractere base e um ou mais caracteres de combinação de caracteres.The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. Um par substituto pode representar um caractere base ou um caractere de combinação.A surrogate pair can represent a base character or a combining character.

O enumerador de elemento de texto é usado somente para ler os dados na cadeia de caracteres; ele não é possível modificar a cadeia de caracteres subjacente.The text element enumerator is used only to read data in the string; it cannot modify the underlying string. O enumerador não tem acesso exclusivo à cadeia de caracteres.The enumerator does not have exclusive access to the string.

O enumerador está em um estado inválido, se ele está posicionado antes do primeiro elemento de texto na cadeia de caracteres ou após o último elemento de texto na cadeia de caracteres.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. Quando o enumerador está em um estado inválido, chamando Current gera uma exceção.When the enumerator is in an invalid state, calling Current throws an exception.

Inicialmente, o enumerador está posicionado antes do primeiro elemento de texto na cadeia de caracteres.Initially, the enumerator is positioned before the first text element in the string. Reset também traz o enumerador de volta para essa posição.Reset also brings the enumerator back to this position. Portanto, após a criação de um enumerador ou depois Reset é chamado, MoveNext deve ser chamado para avançar o enumerador para o primeiro elemento de texto da cadeia de caracteres antes de ler o valor de 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 retorna o mesmo objeto até MoveNext ou Reset ser chamado.Current returns the same object until either MoveNext or Reset is called.

Após o final da cadeia de caracteres for passado, o enumerador está novamente em um inválido, estado e chamando MoveNext retorna false.After the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. Chamando Current gera uma exceção se a última chamada para MoveNext retornou false.Calling Current throws an exception if the last call to MoveNext returned false.

Veja também

Aplica-se a