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

Definicja

Zwraca moduł wyliczający, który wykonuje iterację przez elementy tekstowe ciągu.Returns an enumerator that iterates through the text elements of a string.

Przeciążenia

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

Zwraca moduł wyliczający, który wykonuje iterację przez elementy tekstowe całego ciągu.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)

Zwraca moduł wyliczający, który wykonuje iterację przez elementy tekstowe ciągu, rozpoczynając od określonego indeksu.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)

Zwraca moduł wyliczający, który wykonuje iterację przez elementy tekstowe całego ciągu.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

Parametry

str
String String String String

Ciąg do iteracji.The string to iterate through.

Zwraca

Wyjątki

Przykłady

Poniższy przykład demonstruje wywołanie GetTextElementEnumerator metody.The following example demonstrates calling the GetTextElementEnumerator method. Ten przykład jest częścią większego przykładu dostarczonego dla StringInfo klasy.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

Uwagi

Platforma .NET definiuje element tekstowy jako jednostkę tekstu wyświetlaną jako pojedynczy znak, czyli Grapheme..NET defines a text element as a unit of text that is displayed as a single character, that is, a grapheme. Element tekstowy może być znakiem podstawowym, parą zastępczą lub kombinacją sekwencji znaków.A text element can be a base character, a surrogate pair, or a combining character sequence. Standard Unicode definiuje parę zastępczą jako reprezentację kodowanego znaku dla pojedynczego znaku abstrakcyjnego, który składa się z sekwencji dwóch jednostek kodu, gdzie pierwsza jednostka pary jest górnym surogatem, a drugi jest dolnym surogatem.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. Standard Unicode definiuje Łączenie sekwencji znaków jako kombinację znaku podstawowego i jednego lub więcej łączących się znaków.The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. Para dwuskładnikowa może reprezentować znak podstawowy lub łączący znak.A surrogate pair can represent a base character or a combining character.

Moduł wyliczający element tekstowy służy tylko do odczytu danych w ciągu; nie można zmodyfikować ciągu bazowego.The text element enumerator is used only to read data in the string; it cannot modify the underlying string. Moduł wyliczający nie ma wyłącznego dostępu do ciągu.The enumerator does not have exclusive access to the string.

Moduł wyliczający jest w nieprawidłowym stanie, jeśli jest umieszczony przed pierwszym elementem tekstu w ciągu lub po ostatnim elemencie tekstu w ciągu.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. Gdy moduł wyliczający jest w nieprawidłowym stanie Current , wywołanie zgłosi wyjątek.When the enumerator is in an invalid state, calling Current throws an exception.

Początkowo moduł wyliczający jest umieszczony przed pierwszym elementem tekstu w ciągu.Initially, the enumerator is positioned before the first text element in the string. Resetprzywraca również moduł wyliczający z powrotem do tego położenia.Reset also brings the enumerator back to this position. W związku z tym po utworzeniu modułu wyliczającego lub Reset po MoveNext wywołaniu, należy wywołać, aby przetworzyć moduł wyliczający do pierwszego elementu tekstowego ciągu Currentprzed odczytem wartości.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.

Currentzwraca ten sam obiekt do MoveNext momentu Reset wywołania metody lub.Current returns the same object until either MoveNext or Reset is called.

Po przekazaniu końca ciągu moduł wyliczający jest ponownie w nieprawidłowym stanie i wywołuje wywołania MoveNext zwrotne false.After the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. Wywołanie Current zgłasza wyjątek, jeśli ostatnie wywołanie do MoveNext zwracanego falseelementu.Calling Current throws an exception if the last call to MoveNext returned false.

Zobacz też

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

Zwraca moduł wyliczający, który wykonuje iterację przez elementy tekstowe ciągu, rozpoczynając od określonego indeksu.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

Parametry

str
String String String String

Ciąg do iteracji.The string to iterate through.

index
Int32 Int32 Int32 Int32

Indeks (liczony od zera), od którego należy rozpocząć iterację.The zero-based index at which to start iterating.

Zwraca

A TextElementEnumerator dla ciągu rozpoczynającego się indexod.A TextElementEnumerator for the string starting at index.

Wyjątki

indexznajduje się poza zakresem prawidłowych indeksów strdla.index is outside the range of valid indexes for str.

Uwagi

Platforma .NET definiuje element tekstowy jako jednostkę tekstu wyświetlaną jako pojedynczy znak, czyli Grapheme..NET defines a text element as a unit of text that is displayed as a single character, that is, a grapheme. Element tekstowy może być znakiem podstawowym, parą zastępczą lub kombinacją sekwencji znaków.A text element can be a base character, a surrogate pair, or a combining character sequence. Standard Unicode definiuje parę zastępczą jako reprezentację kodowanego znaku dla pojedynczego znaku abstrakcyjnego, który składa się z sekwencji dwóch jednostek kodu, gdzie pierwsza jednostka pary jest górnym surogatem, a drugi jest dolnym surogatem.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. Standard Unicode definiuje Łączenie sekwencji znaków jako kombinację znaku podstawowego i jednego lub więcej łączących się znaków.The Unicode Standard defines a combining character sequence as a combination of a base character and one or more combining characters. Para dwuskładnikowa może reprezentować znak podstawowy lub łączący znak.A surrogate pair can represent a base character or a combining character.

Moduł wyliczający element tekstowy służy tylko do odczytu danych w ciągu; nie można zmodyfikować ciągu bazowego.The text element enumerator is used only to read data in the string; it cannot modify the underlying string. Moduł wyliczający nie ma wyłącznego dostępu do ciągu.The enumerator does not have exclusive access to the string.

Moduł wyliczający jest w nieprawidłowym stanie, jeśli jest umieszczony przed pierwszym elementem tekstu w ciągu lub po ostatnim elemencie tekstu w ciągu.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. Gdy moduł wyliczający jest w nieprawidłowym stanie Current , wywołanie zgłosi wyjątek.When the enumerator is in an invalid state, calling Current throws an exception.

Początkowo moduł wyliczający jest umieszczony przed pierwszym elementem tekstu w ciągu.Initially, the enumerator is positioned before the first text element in the string. Resetprzywraca również moduł wyliczający z powrotem do tego położenia.Reset also brings the enumerator back to this position. W związku z tym po utworzeniu modułu wyliczającego lub Reset po MoveNext wywołaniu, należy wywołać, aby przetworzyć moduł wyliczający do pierwszego elementu tekstowego ciągu Currentprzed odczytem wartości.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.

Currentzwraca ten sam obiekt do MoveNext momentu Reset wywołania metody lub.Current returns the same object until either MoveNext or Reset is called.

Po przekazaniu końca ciągu moduł wyliczający jest ponownie w nieprawidłowym stanie i wywołuje wywołania MoveNext zwrotne false.After the end of the string is passed, the enumerator is again in an invalid state and calling MoveNext returns false. Wywołanie Current zgłasza wyjątek, jeśli ostatnie wywołanie do MoveNext zwracanego falseelementu.Calling Current throws an exception if the last call to MoveNext returned false.

Zobacz też

Dotyczy