GroupCollection.Item[String] プロパティ

定義

整数インデックスまたは文字列インデックスによってコレクションの単一のメンバーにアクセスできるようになります。Enables access to a single member of the collection by integer or string index.

オーバーロード

Item[Int32]

整数インデックスによってコレクションのメンバーにアクセスできるようにします。Enables access to a member of the collection by integer index.

Item[String]

文字列インデックスによってコレクションのメンバーにアクセスできるようにします。Enables access to a member of the collection by string index.

Item[Int32]

整数インデックスによってコレクションのメンバーにアクセスできるようにします。Enables access to a member of the collection by integer index.

public:
 property System::Text::RegularExpressions::Group ^ default[int] { System::Text::RegularExpressions::Group ^ get(int groupnum); };
public System.Text.RegularExpressions.Group this[int groupnum] { get; }
member this.Item(int) : System.Text.RegularExpressions.Group
Default Public ReadOnly Property Item(groupnum As Integer) As Group

パラメーター

groupnum
Int32

取得するコレクション メンバーの 0 から始まるインデックス。The zero-based index of the collection member to be retrieved.

プロパティ値

groupnum で指定されたコレクションのメンバー。The member of the collection specified by groupnum.

実装

次の例では、2つの番号付きグループで構成される正規表現を定義しています。The following example defines a regular expression that consists of two numbered groups. 最初のグループは、1つ以上の連続する数字をキャプチャします。The first group captures one or more consecutive digits. 2番目のグループは1つの文字と一致します。The second group matches a single character. 正規表現エンジンは、最初のグループの0回または1回の出現を検索するので、正規表現の一致が成功した場合でも、常に一致を検出するとは限りません。Because the regular expression engine looks for zero or one occurrence of the first group, it does not always find a match even if the regular expression match is successful. この例では、Item[Int32] プロパティを使用して、一致しないグループ、一致するグループ、および正規表現で定義されていないグループを取得した場合の結果を示します。The example then illustrates the result when the Item[Int32] property is used to retrieve an unmatched group, a matched group, and a group that is not defined in the regular expression. この例では、次の表に示すように、正規表現パターン (\d+)*(\w)\2を定義しています。The example defines a regular expression pattern (\d+)*(\w)\2, which is interpreted as shown in the following table.

[パターン]Pattern 説明Description
(\d+)* 10進数字の1回以上の出現と一致します。Match one or more occurrence of a decimal digit. これが最初のキャプチャ グループです。This is the first capturing group. 0回または1回、このパターンに一致します。Match this pattern either zero or one time.
(\w) これが 2 番目のキャプチャ グループです。This is the second capturing group.
\k 2番目のキャプチャグループによってキャプチャされた文字列と一致します。Match the string captured by the second capturing group.
using System;
using System.Text.RegularExpressions;

public class Example
{
   public static void Main()
   {
      string pattern = @"(\d+)*(\w)\2";
      string input = "AA";
      Match match = Regex.Match(input, pattern);
      
      // Get the first named group.
      Group group1 = match.Groups[1];
      Console.WriteLine("Group 1 value: {0}", group1.Success ? group1.Value : "Empty");
      
      // Get the second named group.
      Group group2 = match.Groups[2];
      Console.WriteLine("Group 2 value: {0}", group2.Success ? group2.Value : "Empty");
      
      // Get a non-existent group.
      Group group3 = match.Groups[3];
      Console.WriteLine("Group 3 value: {0}", group3.Success ? group3.Value : "Empty");
   }
}
// The example displays the following output:
//       Group 1 value: Empty
//       Group 2 value: A
//       Group 3 value: Empty
Imports System.Text.RegularExpressions

Module Example
   Public Sub Main()
      Dim pattern As String = "(\d+)*(\w)\2"
      Dim input As String = "AA"
      Dim match As Match = Regex.Match(input, pattern)
      
      ' Get the first named group.
      Dim group1 As Group = match.Groups.Item(1)
      Console.WriteLine("Group 1 value: {0}", If(group1.Success, group1.Value, "Empty"))
      
      ' Get the second named group.
      Dim group2 As Group = match.Groups.Item(2)
      Console.WriteLine("Group 2 value: {0}", If(group2.Success, group2.Value, "Empty"))
      
      ' Get a non-existent group.
      Dim group3 As Group = match.Groups.Item(3)
      Console.WriteLine("Group 3 value: {0}", If(group3.Success, group3.Value, "Empty"))
   End Sub
End Module
' The example displays the following output:
'       Group 1 value: Empty
'       Group 2 value: A
'       Group 3 value: Empty

注釈

Item[Int32] プロパティは、GroupCollection クラスのインデックスC#(の場合) または既定のプロパティ (Visual Basic の場合) です。The Item[Int32] property is the index (in C#) or the default property (in Visual Basic) of the GroupCollection class. または Visual Basic の For Each ステートメントでC# foreach ステートメントを使用して、コレクションのメンバーを列挙できます。It allows you to enumerate the members of the collection by using a foreach statement in C# or a For Each statement in Visual Basic.

このプロパティを使用して、キャプチャされた個々のグループをインデックス番号で取得することもできます。You can also use this property to retrieve individual captured groups by their index number. インスタンス Regex.GetGroupNumbers メソッドを呼び出すことによって、正規表現内のすべてのキャプチャグループの数を含む配列を取得できます。You can retrieve an array that contains the numbers of all capturing groups in a regular expression by calling the instance Regex.GetGroupNumbers method. インスタンス Regex.GroupNumberFromName メソッドを呼び出すことによって、名前付きキャプチャグループを数値にマップすることもできます。You can also map named capturing groups to their numbers by calling the instance Regex.GroupNumberFromName method.

コレクション内の項目の数を確認するには、Count プロパティの値を取得します。You can determine the number of items in the collection by retrieving the value of the Count property. groupnum パラメーターの有効な値は、0からコレクション内の項目の数までの範囲です。Valid values for the groupnum parameter range from 0 to one less than the number of items in the collection.

Match.Groups プロパティによって返される GroupCollection オブジェクトには、常に少なくとも1つのメンバーがあります。The GroupCollection object returned by the Match.Groups property always has at least one member. 正規表現エンジンが特定の入力文字列に一致する文字列が見つからない場合、コレクション内の1つの Group オブジェクトの Group.Success プロパティが false に設定され、その Group.Value プロパティが String.Emptyに設定されます。If the regular expression engine cannot find any matches in a particular input string, the single Group object in the collection has its Group.Success property set to false and its Group.Value property set to String.Empty.

groupnum がコレクションのメンバーのインデックスでない場合、または groupnum が入力文字列で一致していないキャプチャグループのインデックスである場合、メソッドは Group.Success プロパティが falseGroup.Value プロパティが String.Emptyである Group オブジェクトを返します。If groupnum is not the index of a member of the collection, or if groupnum is the index of a capturing group that has not been matched in the input string, the method returns a Group object whose Group.Success property is false and whose Group.Value property is String.Empty.

こちらもご覧ください

Item[String]

文字列インデックスによってコレクションのメンバーにアクセスできるようにします。Enables access to a member of the collection by string index.

public:
 property System::Text::RegularExpressions::Group ^ default[System::String ^] { System::Text::RegularExpressions::Group ^ get(System::String ^ groupname); };
public System.Text.RegularExpressions.Group this[string groupname] { get; }
member this.Item(string) : System.Text.RegularExpressions.Group
Default Public ReadOnly Property Item(groupname As String) As Group

パラメーター

groupname
String

キャプチャ グループの名前。The name of a capturing group.

プロパティ値

groupname で指定されたコレクションのメンバー。The member of the collection specified by groupname.

実装

次の例では、2つの名前付きグループで構成される正規表現を定義します。The following example defines a regular expression that consists of two named groups. 最初のグループである numbersは、1つ以上の連続する数字をキャプチャします。The first group, numbers, captures one or more consecutive digits. 2番目のグループである letterは、1つの文字と一致します。The second group, letter, matches a single character. 正規表現エンジンは、numbers グループによって定義されたパターンの0回または1回の出現を検索するため、一致が成功した場合でも、numbers グループは常に存在するとは限りません。Because the regular expression engine looks for zero or one occurrence of the pattern defined by the numbers group, the numbers group is not always present even if a match is successful. この例では、Item[String] プロパティを使用して、一致しないグループ、一致するグループ、および正規表現で定義されていないグループを取得した場合の結果を示します。The example then illustrates the result when the Item[String] property is used to retrieve an unmatched group, a matched group, and a group that is not defined in the regular expression. この例では、次の表に示すように、正規表現パターン (?<numbers>\d+)*(?<letter>\w)\k<letter>を定義しています。The example defines a regular expression pattern (?<numbers>\d+)*(?<letter>\w)\k<letter>, which is interpreted as shown in the following table.

[パターン]Pattern 説明Description
(?<numbers>\d+)* 10進数字の1回以上の出現と一致します。Match one or more occurrence of a decimal digit. numbers キャプチャグループの名前を指定します。Name this the numbers capturing group. 0回または1回、このパターンに一致します。Match this pattern either zero or one time.
(?<letter>\w) 1つの単語文字と一致します。Match a single word character. letter キャプチャグループの名前を指定します。Name this the letter capturing group.
\k<letter> letter キャプチャグループによってキャプチャされた文字列と一致します。Match the string captured by the letter capturing group.
using System;
using System.Text.RegularExpressions;

public class Example
{
   public static void Main()
   {
      string pattern = @"(?<numbers>\d+)*(?<letter>\w)\k<letter>";
      string input = "AA";
      Match match = Regex.Match(input, pattern);
      
      // Get the first named group.
      Group group1 = match.Groups["numbers"];
      Console.WriteLine("Group 'numbers' value: {0}", group1.Success ? group1.Value : "Empty");
      
      // Get the second named group.
      Group group2 = match.Groups["letter"];
      Console.WriteLine("Group 'letter' value: {0}", group2.Success ? group2.Value : "Empty");
      
      // Get a non-existent group.
      Group group3 = match.Groups["none"];
      Console.WriteLine("Group 'none' value: {0}", group3.Success ? group3.Value : "Empty");
   }
}
// The example displays the following output:
//       Group 'numbers' value: Empty
//       Group 'letter' value: A
//       Group 'none' value: Empty
Imports System.Text.RegularExpressions

Module Example
   Public Sub Main()
      Dim pattern As String = "(?<numbers>\d+)*(?<letter>\w)\k<letter>"
      Dim input As String = "AA"
      Dim match As Match = Regex.Match(input, pattern)
      
      ' Get the first named group.
      Dim group1 As Group = match.Groups.Item("numbers")
      Console.WriteLine("Group 'numbers' value: {0}", If(group1.Success, group1.Value, "Empty"))
      
      ' Get the second named group.
      Dim group2 As Group = match.Groups.Item("letter")
      Console.WriteLine("Group 'letter' value: {0}", If(group2.Success, group2.Value, "Empty"))
      
      ' Get a non-existent group.
      Dim group3 As Group = match.Groups.Item("none")
      Console.WriteLine("Group 'none' value: {0}", If(group3.Success, group3.Value, "Empty"))
   End Sub
End Module
' The example displays the following output:
'       Group 'numbers' value: Empty
'       Group 'letter' value: A
'       Group 'none' value: Empty

注釈

groupName には、正規表現で (?<name>) 要素で定義されているキャプチャグループの名前、またはグループ化構成体で定義されているキャプチャグループの番号の文字列形式のいずれかを指定できます。groupName can be either the name of a capturing group that is defined by the (?<name>) element in a regular expression, or the string representation of the number of a capturing group that is defined by a grouping construct. 正規表現でのグループの詳細については、「グループ化構成体」を参照してください。For more information about groups in regular expressions, see Grouping Constructs.

Regex.GetGroupNames メソッドを呼び出すことによって、Regex オブジェクト内のすべてのキャプチャ対象グループの名前を取得できます。You can retrieve the names of all the captured groups in a Regex object by calling the Regex.GetGroupNames method. Regex.GroupNameFromNumber メソッドを呼び出すことによって、正規表現内のキャプチャグループの数を名前にマップすることもできます。You can also map the numbers of capturing groups in a regular expression to their names by calling the Regex.GroupNameFromNumber method. 配列の個々の名前は、キャプチャされた文字列を取得するために Item[String] プロパティに渡すことができます。Individual names from the array can then be passed to the Item[String] property to retrieve the captured string.

groupname がコレクション内のキャプチャグループの名前でない場合、または groupname が入力文字列で一致していないキャプチャグループの名前である場合、メソッドは Group.Success プロパティが falseGroup.Value プロパティが String.Emptyである Group オブジェクトを返します。If groupname is not the name of a capturing group in the collection, or if groupname is the name of a capturing group that has not been matched in the input string, the method returns a Group object whose Group.Success property is false and whose Group.Value property is String.Empty.

こちらもご覧ください

適用対象