String.Join メソッド

定義

名前空間:

System

アセンブリ:

System.Runtime.dll

各要素またはメンバー間で指定した区切り記号を使用して、指定した配列の要素またはコレクションのメンバーを連結します。

オーバーロード

Join(String, String[])	各要素間で指定された区切り記号を使用して、文字列配列のすべての要素を連結します。
Join(String, String[], Int32, Int32)	各要素間で指定された区切り記号を使用して、文字列配列の指定された要素を連結します。
Join(Char, String[], Int32, Int32)	各メンバー間で指定された区切り記号を使用して、startIndex 位置にある value の要素から始まり、最大 count 要素を連結して、文字列の配列を連結します。
Join(String, IEnumerable<String>)	各メンバー間で指定された区切り記号を使用して、String型の構築された IEnumerable<T> コレクションのメンバーを連結します。
Join(Char, Object[])	各メンバー間で指定された区切り記号を使用して、オブジェクトの配列の文字列形式を連結します。
Join(String, Object[])	各要素間で指定された区切り記号を使用して、オブジェクト配列の要素を連結します。
Join(Char, String[])	各メンバー間で指定された区切り記号を使用して、文字列の配列を連結します。
Join<T>(Char, IEnumerable<T>)	各メンバー間で指定された区切り記号を使用して、コレクションのメンバーを連結します。
Join<T>(String, IEnumerable<T>)	各メンバー間で指定された区切り記号を使用して、コレクションのメンバーを連結します。

Join(String, String[])

ソース:

String.Manipulation.cs

各要素間で指定された区切り記号を使用して、文字列配列のすべての要素を連結します。

C#

public static string Join (string? separator, params string?[] value);

パラメーター

separator

String

区切り記号として使用する文字列。 separator は、value に複数の要素がある場合にのみ、返される文字列に含まれます。

value

String[]

連結する要素を含む配列。

戻り値

String

separator 文字列で区切られた value 内の要素で構成される文字列。

-又は-

value に 0 個の要素がある場合に Empty します。

例外

ArgumentNullException

value は nullです。

OutOfMemoryException

結果の文字列の長さは、許容される最大長 (Int32.MaxValue) をオーバーフローします。

例

次の例では、Join メソッドを示します。

C#

using System;

public class JoinTest
{
    public static void Main()
    {
        Console.WriteLine(MakeLine(0, 5, ", "));
        Console.WriteLine(MakeLine(1, 6, "  "));
        Console.WriteLine(MakeLine(9, 9, ": "));
        Console.WriteLine(MakeLine(4, 7, "< "));
    }

    private static string MakeLine(int initVal, int multVal, string sep)
    {
        string [] sArr = new string [10];

        for (int i = initVal; i < initVal + 10; i++)
            sArr[i - initVal] = String.Format("{0,-3}", i * multVal);

        return String.Join(sep, sArr);
    }
}
// The example displays the following output:
//       0  , 5  , 10 , 15 , 20 , 25 , 30 , 35 , 40 , 45
//       6    12   18   24   30   36   42   48   54   60
//       81 : 90 : 99 : 108: 117: 126: 135: 144: 153: 162
//       28 < 35 < 42 < 49 < 56 < 63 < 70 < 77 < 84 < 91

注釈

たとえば、separator が ", " で、value の要素が "apple"、"orange"、"grape"、"pear" の場合、Join(separator, value) は "apple, orange, grape, pear" を返します。

separator が nullの場合は、代わりに空の文字列 (String.Empty) が使用されます。 value のいずれかの要素が nullされている場合は、代わりに空の文字列が使用されます。

こちらもご覧ください

• Concat(Object)

Join(String, String[], Int32, Int32)

ソース:

String.Manipulation.cs

各要素間で指定された区切り記号を使用して、文字列配列の指定された要素を連結します。

C#

public static string Join (string? separator, string?[] value, int startIndex, int count);

パラメーター

separator

String

区切り記号として使用する文字列。 separator は、value に複数の要素がある場合にのみ、返される文字列に含まれます。

value

String[]

連結する要素を含む配列。

startIndex

Int32

使用する value の最初の要素。

count

Int32

使用する value の要素の数。

戻り値

String

separator 文字で区切られた startIndex から始まる value の count 要素で構成される文字列。

-又は-

count が 0 の場合に Empty します。

例外

ArgumentNullException

value は nullです。

ArgumentOutOfRangeException

startIndex または count が 0 未満です。

-又は-

startIndex プラス count は、value内の要素の数よりも大きくなります。

OutOfMemoryException

メモリ不足。

例

次の例では、フルーツの名前の配列から 2 つの要素を連結します。

C#

String[] val = {"apple", "orange", "grape", "pear"};
String sep   = ", ";
String result;

Console.WriteLine("sep = '{0}'", sep);
Console.WriteLine("val[] = {{'{0}' '{1}' '{2}' '{3}'}}", val[0], val[1], val[2], val[3]);
result = String.Join(sep, val, 1, 2);
Console.WriteLine("String.Join(sep, val, 1, 2) = '{0}'", result);

// This example produces the following results:
// sep = ', '
// val[] = {'apple' 'orange' 'grape' 'pear'}
// String.Join(sep, val, 1, 2) = 'orange, grape'

注釈

たとえば、separator が "," で、value の要素が "apple"、"orange"、"grape"、"pear" の場合、Join(separator, value, 1, 2) は "orange, grape" を返します。

separator が nullの場合は、代わりに空の文字列 (String.Empty) が使用されます。 value のいずれかの要素が nullされている場合は、代わりに空の文字列が使用されます。

こちらもご覧ください

• Split(Char[])

Join(Char, String[], Int32, Int32)

ソース:

String.Manipulation.cs

各メンバー間で指定された区切り記号を使用して、startIndex 位置にある value の要素から始まり、最大 count 要素を連結して、文字列の配列を連結します。

C#

public static string Join (char separator, string?[] value, int startIndex, int count);

パラメーター

separator

Char

指定したインデックス位置にある要素から始まり、指定した数の要素を含めて、各メンバー間で指定された区切り記号を使用して、文字列の配列を連結します。

value

String[]

連結する文字列の配列。

startIndex

Int32

連結する value の最初の項目。

count

Int32

startIndex 位置の要素から始まる、連結する value の要素の数。

戻り値

String

separator 文字で区切られた startIndex から始まる value の count 要素で構成される文字列。

-又は-

count が 0 の場合に Empty します。

例外

ArgumentNullException

value は nullです。

ArgumentOutOfRangeException

startIndex または count は負の値です。

-又は-

startIndex が value - countの長さを超えています。

OutOfMemoryException

結果の文字列の長さは、許容される最大長 (Int32.MaxValue) をオーバーフローします。

Join(String, IEnumerable<String>)

ソース:

String.Manipulation.cs

各メンバー間で指定された区切り記号を使用して、String型の構築された IEnumerable<T> コレクションのメンバーを連結します。

C#

public static string Join (string? separator, System.Collections.Generic.IEnumerable<string?> values);

パラメーター

separator

String

区切り記号として使用する文字列。 separator は、values に複数の要素がある場合にのみ、返される文字列に含まれます。

values

IEnumerable<String>

連結する文字列を含むコレクション。

戻り値

String

separator 文字列で区切られた values の要素で構成される文字列。

-又は-

values に 0 個の要素がある場合に Empty します。

例外

ArgumentNullException

values は nullです。

OutOfMemoryException

結果の文字列の長さは、許容される最大長 (Int32.MaxValue) をオーバーフローします。

例

次の例では、Eratosthenes アルゴリズムのシーブを使用して、100 以下の素数を計算します。 String型の List<T> オブジェクトに結果が割り当てられ、Join(String, IEnumerable<String>) メソッドに渡されます。

C#

using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      int maxPrime = 100;
      List<int> primes = GetPrimes(maxPrime);
      Console.WriteLine("Primes less than {0}:", maxPrime);
      Console.WriteLine("   {0}", String.Join(" ", primes));
   }

   private static List<int> GetPrimes(int maxPrime)
   {
      Array values = Array.CreateInstance(typeof(int), 
                              new int[] { maxPrime - 1}, new int[] { 2 });
      // Use Sieve of Eratosthenes to determine prime numbers.
      for (int ctr = values.GetLowerBound(0); ctr <= (int) Math.Ceiling(Math.Sqrt(values.GetUpperBound(0))); ctr++)
      {
                           
         if ((int) values.GetValue(ctr) == 1) continue;
         
         for (int multiplier = ctr; multiplier <=  maxPrime / 2; multiplier++)
            if (ctr * multiplier <= maxPrime)
               values.SetValue(1, ctr * multiplier);
      }      
      
      List<int> primes = new List<int>();
      for (int ctr = values.GetLowerBound(0); ctr <= values.GetUpperBound(0); ctr++)
         if ((int) values.GetValue(ctr) == 0) 
            primes.Add(ctr);
      return primes;
   }   
}
// The example displays the following output:
//    Primes less than 100:
//       2 3 5 7 11 13 17 19 23 29 31 37 41 43 47 53 59 61 67 71 73 79 83 89 97

注釈

separator が nullの場合は、代わりに空の文字列 (String.Empty) が使用されます。 values のいずれかのメンバーが nullされている場合は、代わりに空の文字列が使用されます。

Join(String, IEnumerable<String>) は、最初に要素を文字列配列に変換せずに、IEnumerable(Of String) コレクション内の各要素を連結できる便利なメソッドです。 これは、Language-Integrated クエリ (LINQ) クエリ式で特に便利です。 次の例では、アルファベットの大文字または小文字を含む List(Of String) オブジェクトを、特定の文字以上の文字を選択するラムダ式に渡します (この例では "M" です)。 Enumerable.Where メソッドによって返される IEnumerable(Of String) コレクションが Join(String, IEnumerable<String>) メソッドに渡され、結果が 1 つの文字列として表示されます。

C#

using System;
using System.Collections.Generic;
using System.Linq;

public class Example
{
   public static void Main()
   {
      string output = String.Join(" ", GetAlphabet(true).Where( letter => 
                      letter.CompareTo("M") >= 0));
      Console.WriteLine(output);  
   }

   private static List<string> GetAlphabet(bool upper)
   {
      List<string> alphabet = new List<string>();
      int charValue = upper ? 65 : 97;
      for (int ctr = 0; ctr <= 25; ctr++)
         alphabet.Add(((char)(charValue + ctr)).ToString());
      return alphabet; 
   }
}
// The example displays the following output:
//      M N O P Q R S T U V W X Y Z

こちらもご覧ください

• Split(Char[])

Join(Char, Object[])

ソース:

String.Manipulation.cs

各メンバー間で指定された区切り記号を使用して、オブジェクトの配列の文字列形式を連結します。

C#

public static string Join (char separator, params object?[] values);

パラメーター

separator

Char

区切り記号として使用する文字。 separator は、values に複数の要素がある場合にのみ、返される文字列に含まれます。

values

Object[]

文字列表現が連結されるオブジェクトの配列。

戻り値

String

separator 文字で区切られた values の要素で構成される文字列。

-又は-

values に 0 個の要素がある場合に Empty します。

例外

ArgumentNullException

values は nullです。

OutOfMemoryException

結果の文字列の長さは、許容される最大長 (Int32.MaxValue) をオーバーフローします。

Join(String, Object[])

ソース:

String.Manipulation.cs

各要素間で指定された区切り記号を使用して、オブジェクト配列の要素を連結します。

C#

public static string Join (string? separator, params object?[] values);

パラメーター

separator

String

区切り記号として使用する文字列。 separator は、values に複数の要素がある場合にのみ、返される文字列に含まれます。

values

Object[]

連結する要素を含む配列。

戻り値

String

separator 文字列で区切られた values の要素で構成される文字列。

-又は-

values に 0 個の要素がある場合に Empty します。

-又は-

.NET Framework のみ: values の最初の要素が null場合に Empty します。

例外

ArgumentNullException

values は nullです。

OutOfMemoryException

結果の文字列の長さは、許容される最大長 (Int32.MaxValue) をオーバーフローします。

例

次の例では、Eratosthenes アルゴリズムのシーブを使用して、100 以下の素数を計算します。 結果が整数配列に割り当てられ、Join(String, Object[]) メソッドに渡されます。

C#

using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      int maxPrime = 100;
      int[] primes = GetPrimes(maxPrime);
      Console.WriteLine("Primes less than {0}:", maxPrime);
      Console.WriteLine("   {0}", String.Join(" ", primes));
   }

   private static int[] GetPrimes(int maxPrime)
   {
      Array values = Array.CreateInstance(typeof(int), 
                              new int[] { maxPrime - 1}, new int[] { 2 }); 
      // Use Sieve of Eratosthenes to determine prime numbers.
      for (int ctr = values.GetLowerBound(0); ctr <= (int) Math.Ceiling(Math.Sqrt(values.GetUpperBound(0))); ctr++)
      {
                           
         if ((int) values.GetValue(ctr) == 1) continue;
         
         for (int multiplier = ctr; multiplier <=  maxPrime / 2; multiplier++)
            if (ctr * multiplier <= maxPrime)
               values.SetValue(1, ctr * multiplier);
      }      
      
      List<int> primes = new List<int>();
      for (int ctr = values.GetLowerBound(0); ctr <= values.GetUpperBound(0); ctr++)
         if ((int) values.GetValue(ctr) == 0) 
            primes.Add(ctr);
      return primes.ToArray();
   }   
}
// The example displays the following output:
//    Primes less than 100:
//       2 3 5 7 11 13 17 19 23 29 31 37 41 43 47 53 59 61 67 71 73 79 83 89 97

注釈

separator が null されている場合、または最初の要素以外の values のいずれかの要素が nullされている場合は、代わりに空の文字列 (String.Empty) が使用されます。 values の最初の要素が null場合は、「呼び出し元のメモ」セクションを参照してください。

Join(String, Object[]) は、オブジェクト配列内の各要素を明示的に文字列に変換せずに連結できる便利なメソッドです。 配列内の各オブジェクトの文字列表現は、そのオブジェクトの ToString メソッドを呼び出すことによって派生します。

注意 (呼び出し元)

.NET Framework のみ: values の最初の要素が nullされている場合、Join(String, Object[]) メソッドは values 内の要素を連結せず、代わりに Emptyを返します。 この問題の回避策は多数あります。 次の例に示すように、最も簡単な方法は、配列の最初の要素に Empty の値を割り当てることです。

C#

object[] values = { null, "Cobb", 4189, 11434, .366 };
if (values[0] == null) values[0] = String.Empty;
Console.WriteLine(String.Join("|", values));

// The example displays the following output:
//      |Cobb|4189|11434|0.366

こちらもご覧ください

• Split(Char[])

Join(Char, String[])

ソース:

String.Manipulation.cs

各メンバー間で指定された区切り記号を使用して、文字列の配列を連結します。

C#

public static string Join (char separator, params string?[] value);

パラメーター

separator

Char

区切り記号として使用する文字。 separator は、value に複数の要素がある場合にのみ、返される文字列に含まれます。

value

String[]

連結する文字列の配列。

戻り値

String

separator 文字で区切られた value の要素で構成される文字列。

-又は-

value に 0 個の要素がある場合に Empty します。

例外

ArgumentNullException

value は nullです。

OutOfMemoryException

結果の文字列の長さは、許容される最大長 (Int32.MaxValue) をオーバーフローします。

Join<T>(Char, IEnumerable<T>)

ソース:

String.Manipulation.cs

各メンバー間で指定された区切り記号を使用して、コレクションのメンバーを連結します。

C#

public static string Join<T> (char separator, System.Collections.Generic.IEnumerable<T> values);

型パラメーター

T

valuesのメンバーの型。

パラメーター

separator

Char

区切り記号として使用する文字。 separator は、values に複数の要素がある場合にのみ、返される文字列に含まれます。

values

IEnumerable<T>

連結するオブジェクトを含むコレクション。

戻り値

String

separator 文字で区切られた values のメンバーで構成される文字列。

-又は-

values に要素がない場合に Empty します。

例外

ArgumentNullException

values は nullです。

OutOfMemoryException

結果の文字列の長さは、許容される最大長 (Int32.MaxValue) をオーバーフローします。

Join<T>(String, IEnumerable<T>)

ソース:

String.Manipulation.cs

各メンバー間で指定された区切り記号を使用して、コレクションのメンバーを連結します。

C#

public static string Join<T> (string? separator, System.Collections.Generic.IEnumerable<T> values);

型パラメーター

T

valuesのメンバーの型。

パラメーター

separator

String

区切り記号として使用する文字列。 separator は、values に複数の要素がある場合にのみ、返される文字列に含まれます。

values

IEnumerable<T>

連結するオブジェクトを含むコレクション。

戻り値

String

separator 文字列で区切られた values の要素で構成される文字列。

-又は-

values に要素がない場合に Empty します。

例外

ArgumentNullException

values は nullです。

OutOfMemoryException

結果の文字列の長さは、許容される最大長 (Int32.MaxValue) をオーバーフローします。

例

次の例では、Eratosthenes アルゴリズムのシーブを使用して、100 以下の素数を計算します。 結果は整数型の List<T> オブジェクトに割り当てられ、Join<T>(String, IEnumerable<T>) メソッドに渡されます。

C#

using System;
using System.Collections.Generic;

public class Example
{
   public static void Main()
   {
      int maxPrime = 100;
      List<int> primes = GetPrimes(maxPrime);
      Console.WriteLine("Primes less than {0}:", maxPrime);
      Console.WriteLine("   {0}", String.Join(" ", primes));
   }

   private static List<int> GetPrimes(int maxPrime)
   {
      Array values = Array.CreateInstance(typeof(int), 
                              new int[] { maxPrime - 1}, new int[] { 2 });
      // Use Sieve of Eratosthenes to determine prime numbers.
      for (int ctr = values.GetLowerBound(0); ctr <= (int) Math.Ceiling(Math.Sqrt(values.GetUpperBound(0))); ctr++)
      {
                           
         if ((int) values.GetValue(ctr) == 1) continue;
         
         for (int multiplier = ctr; multiplier <=  maxPrime / 2; multiplier++)
            if (ctr * multiplier <= maxPrime)
               values.SetValue(1, ctr * multiplier);
      }      
      
      List<int> primes = new List<int>();
      for (int ctr = values.GetLowerBound(0); ctr <= values.GetUpperBound(0); ctr++)
         if ((int) values.GetValue(ctr) == 0) 
            primes.Add(ctr);
      return primes;
   }   
}
// The example displays the following output:
//    Primes less than 100:
//       2 3 5 7 11 13 17 19 23 29 31 37 41 43 47 53 59 61 67 71 73 79 83 89 97

注釈

separator が nullの場合は、代わりに空の文字列 (String.Empty) が使用されます。 values のいずれかのメンバーが nullされている場合は、代わりに空の文字列が使用されます。

Join<T>(String, IEnumerable<T>) は、最初に文字列に変換することなく、IEnumerable<T> コレクションの各メンバーを連結できる便利なメソッドです。 IEnumerable<T> コレクション内の各オブジェクトの文字列形式は、そのオブジェクトの ToString メソッドを呼び出すことによって派生します。

このメソッドは、Language-Integrated クエリ (LINQ) クエリ式で特に便利です。 たとえば、次のコードは、動物の名前とそれが属する順序を含む非常に単純な Animal クラスを定義します。 次に、多数の Animal オブジェクトを含む List<T> オブジェクトを定義します。 Enumerable.Where 拡張メソッドは、Order プロパティが "Rodent" と等しい Animal オブジェクトを抽出するために呼び出されます。 結果は、Join<T>(String, IEnumerable<T>) メソッドに渡されます。

C#

using System;
using System.Collections.Generic;
using System.Linq;

public class Animal
{
   public string Kind;
   public string Order;
   
   public Animal(string kind, string order)
   {
      this.Kind = kind;
      this.Order = order;
   }
   
   public override string ToString()
   {
      return this.Kind;
   }
}

public class Example
{
   public static void Main()
   {
      List<Animal> animals = new List<Animal>();
      animals.Add(new Animal("Squirrel", "Rodent"));
      animals.Add(new Animal("Gray Wolf", "Carnivora"));
      animals.Add(new Animal("Capybara", "Rodent"));
      string output = String.Join(" ", animals.Where( animal => 
                      (animal.Order == "Rodent")));
      Console.WriteLine(output);  
   }
}
// The example displays the following output:
//      Squirrel Capybara

こちらもご覧ください

• Split(Char[])