補間文字列 (Visual Basic リファレンス)Interpolated Strings (Visual Basic Reference)

文字列の作成に使用されます。Used to construct strings. 挿入文字列は、挿入式が含まれているテンプレート文字列のように見えます。An interpolated string looks like a template string that contains interpolated expressions. 挿入文字列は、含まれる挿入式をその文字列表現に置き換えた文字列を返します。An interpolated string returns a string that replaces the interpolated expressions that it contains with their string representations. この機能は、Visual Basic 14 以降のバージョンで使用できます。This feature is available in Visual Basic 14 and later versions.

挿入文字列の引数は、複合書式指定文字列よりもわかりやすいものです。The arguments of an interpolated string are easier to understand than a composite format string. たとえば、挿入文字列には、For example, the interpolated string

Console.WriteLine($"Name = {name}, hours = {hours:hh}")

2 つの挿入式、"{name}" と "{hours:hh}" が含まれています。contains two interpolated expressions, '{name}' and '{hours:hh}'. 同等の複合書式指定文字列は次のとおりです。The equivalent composite format string is:

Console.WriteLine("Name = {0}, hours = {1:hh}", name, hours);

挿入文字列の構造は次のとおりです。The structure of an interpolated string is:

$"<text> {<interpolated-expression> [,<field-width>] [:<format-string>] } <text> ..."

ここで、where:

  • field-width はフィールドの文字数を示す符号付き整数です。field-width is a signed integer that indicates the number of characters in the field. これが正である場合、フィールドは右揃えとなり、負である場合は左揃えとなります。If it is positive, the field is right-aligned; if negative, left-aligned.

  • format-string は、書式設定されるオブジェクトの種類に適した書式指定文字列です。format-string is a format string appropriate for the type of object being formatted. たとえば、DateTime値である可能性があります、標準の日付と時刻の書式指定文字列"D"または"d"など。For example, for a DateTime value, it could be a standard date and time format string such as "D" or "d".

重要

$ と文字列を開始する " の間に空白を入れることはできません。You cannot have any white space between the $ and the " that starts the string. そうと、コンパイラ エラーが発生します。Doing so causes a compiler error.

文字列リテラルを使用できる場所であればどこでも補間文字列を使用できます。You can use an interpolated string anywhere you can use a string literal. この挿入文字列は、挿入文字列を含むコードが実行されるたびに評価されます。The interpolated string is evaluated each time the code with the interpolated string executes. これにより、挿入文字列の定義と評価を分離することができます。This allows you to separate the definition and evaluation of an interpolated string.

挿入文字列に中かっこ "{" または "}" を含めるには、2 つの中かっこ "{{" または "}}" を使用します。To include a curly brace ("{" or "}") in an interpolated string, use two curly braces, "{{" or "}}". 詳細については、「暗黙の型変換」を参照してください。See the Implicit Conversions section for more details.

挿入文字列には、引用符 (")、コロン (:)、コンマ (,) など、特別な意味を持つその他の文字が含まれることがあります。これらの文字がリテラル テキストに出現する場合は、エスケープする必要があります。また、これらの文字が言語要素として挿入式に含まれる場合は、かっこで区切られた式に含める必要があります。If the interpolated string contains other characters with special meaning in an interpolated string, such as the quotation mark ("), colon (:), or comma (,), they should be escaped if they occur in literal text, or they should be included in an expression delimited by parentheses if they are language elements included in an interpolated expression. 次の例では、引用符をエスケープして、結果文字列に引用符を含めています。さらに、かっこを使用して式 (age == 1 ? "" : "s") を区切り、コロンが書式指定文字列の先頭として解釈されないようにしています。The following example escapes quotation marks to include them in the result string, and it uses parentheses to delimit the expression (age == 1 ? "" : "s") so that the colon is not interpreted as beginning a format string.

Public Module Example
   Public Sub Main()
      Dim name = "Horace"
      Dim age = 34
      Dim s1 = $"He asked, ""Is your name {name}?"", but didn't wait for a reply."
      Console.WriteLine(s1)
      
      Dim s2 = $"{name} is {age:D3} year{(If(age = 1, "", "s"))} old."
      Console.WriteLine(s2) 
   End Sub
End Module
' The example displays the following output:
'       He asked, "Is your name Horace?", but didn't wait for a reply.
'       Horace is 034 years old.
' </Snippet1>

暗黙の型変換Implicit Conversions

挿入文字列から暗黙の型変換を行う方法は 3 種類あります。There are three implicit type conversions from an interpolated string:

  1. 挿入文字列から String への変換。Conversion of an interpolated string to a String. 次の例では、挿入文字列式を文字列表現で置き換えた文字列が返されます。The following example returns a string whose interpolated string expressions have been replaced with their string representations. 例:For example:

    Public Module Example
       Public Sub Main()
          Dim name = "Bartholomew"
          Dim s1 = $"Hello, {name}!"  
          Console.WriteLine(s1)
       End Sub
    End Module
    ' The example displays the following output:
    '      Hello, Bartholomew!
    ' </Snippet1>
    

    これが、文字列解釈の最終的な結果です。This is the final result of a string interpretation. 二重中かっこ ("{{" および "}}") のすべての発生箇所は、単一の中かっこに変換されます。All occurrences of double curly braces ("{{" and "}}") are converted to a single curly brace.

  2. 挿入文字列から IFormattable 変数への変換。これは、単一の IFormattable インスタンスから、カルチャ固有のコンテンツを持った複数の結果文字列の作成を可能にするものです。Conversion of an interpolated string to an IFormattable variable that allows you create multiple result strings with culture-specific content from a single IFormattable instance. これは、個々のカルチャに適切な数値書式や日付形式などの情報を含めるのに便利です。This is useful for including such things as the correct numeric and date formats for individual cultures. 二重中かっこ ("{{" および "}}") のすべての出現箇所は、明示的または暗黙的に ToString() メソッドを呼び出して文字列を書式指定するまで、二重中かっこのままです。All occurrences of double curly braces ("{{" and "}}") remain as double curly braces until you format the string by explicitly or implicitly calling the ToString() method. すべての含まれる補間式に変換されます{0}、{1}など。All contained interpolation expressions are converted to {0}, {1}, and so on.

    次の例では、リフレクションを使用することで、挿入文字列から作成された IFormattable 変数のフィールドおよびプロパティ値だけでなく、メンバーも表示しています。The following example uses reflection to display the members as well as the field and property values of an IFormattable variable that is created from an interpolated string. また、IFormattable 変数を Console.WriteLine(String) メソッドに渡しています。It also passes the IFormattable variable to the Console.WriteLine(String) method.

    Imports System.Globalization
    Imports System.Reflection
    
    Public Module Example
       Public Sub Main()
          Dim price = 1000
          Dim s2 As IFormattable = $"The cost of this item is {price:C}."  
          ShowInfo(s2)
          CultureInfo.CurrentCulture = New CultureInfo("en-US")
          Console.WriteLine(s2)
          CultureInfo.CurrentCulture = New CultureInfo("fr-FR")
          Console.WriteLine(s2)      
       End Sub
    
       Private Sub ShowInfo(obj As Object)
          Console.WriteLine($"Displaying member information:{vbCrLf}")
          Dim t = obj.GetType()
          Dim flags = BindingFlags.Public Or BindingFlags.Instance Or BindingFlags.Static Or BindingFlags.NonPublic
          For Each m In t.GetMembers(flags) 
             Console.Write($"   {m.Name} {m.MemberType}")   
             If m.MemberType = MemberTypes.Property Then
                Dim p = t.GetProperty(m.Name, flags)
                Console.Write($"   Value: {p.GetValue(obj)}")         
             End If
             If m.MemberType = MemberTypes.Field Then
                Dim f = t.GetField(m.Name, flags)
                Console.Write($"   Value: {f.GetValue(obj)}")
             End If
             Console.WriteLine()
          Next
          Console.WriteLine($"-------{vbCrLf}")
       End Sub
    End Module
    ' The example displays the following output:
    Displaying member information:
    
    '       get_Format Method
    '       GetArguments Method
    '       get_ArgumentCount Method
    '       GetArgument Method
    '       ToString Method
    '       System.IFormattable.ToString Method
    '       ToString Method
    '       Equals Method
    '       GetHashCode Method
    '       GetType Method
    '       Finalize Method
    '       MemberwiseClone Method
    '       .ctor Constructor
    '       Format Property   Value: The cost of this item is {0:C}.
    '       ArgumentCount Property   Value: 1
    '       _format Field   Value: The cost of this item is {0:C}.
    '       _arguments Field   Value: System.Object[]
    '       -------
    '
    '       The cost of this item is $1,000.00.
    '       The cost of this item is 1 000,00 €.
    ' </Snippet1>
    
    

    挿入文字列の検査には、リフレクションを使用する必要があることに注意してください。Note that the interpolated string can be inspected only by using reflection. 挿入文字列が WriteLine(String) などの文字列書式指定メソッドに渡されると、書式指定項目が解決され、結果文字列が返されます。If it is passed to a string formatting method, such as WriteLine(String), its format items are resolved and the result string returned.

  3. 挿入文字列からの変換、FormattableString複合書式指定文字列を表す変数です。Conversion of an interpolated string to a FormattableString variable that represents a composite format string. たとえば、複合書式指定文字列を検査し、それが結果文字列としてどのように表示されるかを検査すると、クエリを構築する場合にインジェクション攻撃を防ぐことができます。Inspecting the composite format string and how it renders as a result string might, for example, help you protect against an injection attack if you were building a query. AFormattableStringも含まれています。A FormattableString also includes:

    出現するすべての二重中かっこ ("{{"と"}}") 書式を設定するまで二重中かっこのままです。All occurrences of double curly braces ("{{" and "}}") remain as double curly braces until you format. すべての含まれる補間式に変換されます{0}、{1}など。All contained interpolation expressions are converted to {0}, {1}, and so on.

    Imports System.Globalization
    
    Public Module Example
       Public Sub Main()
          Dim name = "Bartholomew"
          Dim s3 As FormattableString = $"Hello, {name}!"  
          Console.WriteLine($"String: '{s3.Format}'")
          Console.WriteLine($"Arguments: {s3.ArgumentCount}")
          Console.WriteLine($"Result string: {s3}")
       End Sub
    End Module
    ' The example displays the following output:
    '       String: 'Hello, {0}!'
    '       Arguments: 1
    '       Result string: Hello, Bartholomew!
    
    

関連項目See also