StringInfo.GetTextElementEnumerator Méthode

Définition

Retourne un énumérateur qui itère au sein des éléments de texte d'une chaîne.Returns an enumerator that iterates through the text elements of a string.

Surcharges

GetTextElementEnumerator(String)

Retourne un énumérateur qui itère au sein des éléments de texte de l'ensemble de la chaîne.Returns an enumerator that iterates through the text elements of the entire string.

GetTextElementEnumerator(String, Int32)

Retourne un énumérateur qui itère au sein des éléments de texte de la chaîne, en commençant à l'index spécifié.Returns an enumerator that iterates through the text elements of the string, starting at the specified index.

GetTextElementEnumerator(String)

Retourne un énumérateur qui itère au sein des éléments de texte de l'ensemble de la chaîne.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

Paramètres

str
String

Chaîne au sein de laquelle itérer.The string to iterate through.

Retours

TextElementEnumerator pour l'ensemble de la chaîne.A TextElementEnumerator for the entire string.

Exceptions

str a la valeur null.str is null.

Exemples

L'exemple suivant montre l'appel à la méthode GetTextElementEnumerator.The following example demonstrates calling the GetTextElementEnumerator method. Cet exemple fait partie d’un exemple plus complet fourni pour la classe 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

Remarques

.NET définit un élément de texte comme une unité de texte qui s’affiche sous la forme d’un caractère unique, autrement dit, un graphèmes..NET defines a text element as a unit of text that is displayed as a single character, that is, a grapheme. Un élément de texte peut être un caractère de base, une paire de substitution ou une séquence de caractères d’association.A text element can be a base character, a surrogate pair, or a combining character sequence. La norme Unicode définit une paire de substitution comme une représentation de caractère codé pour un caractère abstrait unique qui se compose d’une séquence de deux unités de code, où la première unité de la paire est un substitut étendu et la seconde est un substitut faible.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. La norme Unicode définit une séquence de caractères d’association comme une combinaison d’un caractère de base et d’un ou plusieurs caractères d’association.The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. Une paire de substitution peut représenter un caractère de base ou un caractère d’association.A surrogate pair can represent a base character or a combining character.

L’énumérateur d’élément de texte est utilisé uniquement pour lire des données dans la chaîne ; elle ne peut pas modifier la chaîne sous-jacente.The text element enumerator is used only to read data in the string; it cannot modify the underlying string. L’énumérateur ne dispose pas d’un accès exclusif à la chaîne.The enumerator does not have exclusive access to the string.

L’énumérateur est dans un État non valide s’il est positionné avant le premier élément de texte de la chaîne ou après le dernier élément de texte de la chaîne.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. Lorsque l’énumérateur est dans un État non valide, l’appel de Current lève une exception.When the enumerator is in an invalid state, calling Current throws an exception.

Initialement, l’énumérateur est positionné avant le premier élément de texte de la chaîne.Initially, the enumerator is positioned before the first text element in the string. Reset replace également l'énumérateur à cette position.Reset also brings the enumerator back to this position. Par conséquent, après la création d’un énumérateur ou après l’appel de Reset, MoveNext doit être appelé pour avancer l’énumérateur jusqu’au premier élément de texte de la chaîne avant de lire la valeur 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 retourne le même objet tant que MoveNext ou Reset n'est pas appelé.Current returns the same object until either MoveNext or Reset is called.

Une fois la fin de la chaîne passée, l’énumérateur est à nouveau dans un État non valide et l’appel de MoveNext retourne false.After the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. L’appel de Current lève une exception si le dernier appel à MoveNext a retourné false.Calling Current throws an exception if the last call to MoveNext returned false.

Voir aussi

GetTextElementEnumerator(String, Int32)

Retourne un énumérateur qui itère au sein des éléments de texte de la chaîne, en commençant à l'index spécifié.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

Paramètres

str
String

Chaîne au sein de laquelle itérer.The string to iterate through.

index
Int32

Index de base zéro au niveau duquel commencer l'itération.The zero-based index at which to start iterating.

Retours

TextElementEnumerator pour la chaîne commençant à index.A TextElementEnumerator for the string starting at index.

Exceptions

str est null.str is null.

index n’est pas compris dans la plage d’index valides pour str.index is outside the range of valid indexes for str.

Remarques

.NET définit un élément de texte comme une unité de texte qui s’affiche sous la forme d’un caractère unique, autrement dit, un graphèmes..NET defines a text element as a unit of text that is displayed as a single character, that is, a grapheme. Un élément de texte peut être un caractère de base, une paire de substitution ou une séquence de caractères d’association.A text element can be a base character, a surrogate pair, or a combining character sequence. La norme Unicode définit une paire de substitution comme une représentation de caractère codé pour un caractère abstrait unique qui se compose d’une séquence de deux unités de code, où la première unité de la paire est un substitut étendu et la seconde est un substitut faible.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. La norme Unicode définit une séquence de caractères d’association comme une combinaison d’un caractère de base et d’un ou plusieurs caractères d’association.The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. Une paire de substitution peut représenter un caractère de base ou un caractère d’association.A surrogate pair can represent a base character or a combining character.

L’énumérateur d’élément de texte est utilisé uniquement pour lire des données dans la chaîne ; elle ne peut pas modifier la chaîne sous-jacente.The text element enumerator is used only to read data in the string; it cannot modify the underlying string. L’énumérateur ne dispose pas d’un accès exclusif à la chaîne.The enumerator does not have exclusive access to the string.

L’énumérateur est dans un État non valide s’il est positionné avant le premier élément de texte de la chaîne ou après le dernier élément de texte de la chaîne.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. Lorsque l’énumérateur est dans un État non valide, l’appel de Current lève une exception.When the enumerator is in an invalid state, calling Current throws an exception.

Initialement, l’énumérateur est positionné avant le premier élément de texte de la chaîne.Initially, the enumerator is positioned before the first text element in the string. Reset replace également l'énumérateur à cette position.Reset also brings the enumerator back to this position. Par conséquent, après la création d’un énumérateur ou après l’appel de Reset, MoveNext doit être appelé pour avancer l’énumérateur jusqu’au premier élément de texte de la chaîne avant de lire la valeur 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 retourne le même objet tant que MoveNext ou Reset n'est pas appelé.Current returns the same object until either MoveNext or Reset is called.

Une fois la fin de la chaîne passée, l’énumérateur est à nouveau dans un État non valide et l’appel de MoveNext retourne false.After the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. L’appel de Current lève une exception si le dernier appel à MoveNext a retourné false.Calling Current throws an exception if the last call to MoveNext returned false.

Voir aussi

S’applique à