String.PadLeft メソッド

定義

名前空間:

System

アセンブリ:

System.Runtime.dll

アセンブリ:

netstandard.dll

アセンブリ:

mscorlib.dll

現在の文字列の先頭に空白または指定された Unicode 文字が埋め込まれた指定された長さの新しい文字列を返します。

オーバーロード

PadLeft(Int32)	指定された文字数になるまで左側に空白を埋め込むことで、このインスタンス内の文字を右寄せした新しい文字列を返します。
PadLeft(Int32, Char)	指定された文字数になるまで左側に指定された Unicode 文字を埋め込むことで、このインスタンス内の文字を右寄せした新しい文字列を返します。

PadLeft(Int32)

指定された文字数になるまで左側に空白を埋め込むことで、このインスタンス内の文字を右寄せした新しい文字列を返します。

public:
 System::String ^ PadLeft(int totalWidth);

public string PadLeft (int totalWidth);

member this.PadLeft : int -> string

Public Function PadLeft (totalWidth As Integer) As String

パラメーター

totalWidth

Int32

結果として生成される文字列の文字数。これは、元の文字数と、埋め込み文字がある場合はその数を加えた数に等しくなります。

戻り値

String

このインスタンスと等価な新しい文字列。ただし右揃えであり、totalWidth の長さになるまで左側に空白が埋め込まれています。 ただし、totalWidth がこのインスタンスの長さより短い場合、メソッドは既存のインスタンスへの参照を返します。 totalWidth がこのインスタンスの長さと等しい場合、メソッドはこのインスタンスと同一の新しい文字列を返します。

例外

ArgumentOutOfRangeException

totalWidth が 0 未満です。

例

PadLeftメソッドの例を次に示します。

String^ str = "BBQ and Slaw";
Console::WriteLine( str->PadLeft( 15 ) ); // Displays "   BBQ and Slaw".
Console::WriteLine( str->PadLeft( 5 ) );  // Displays "BBQ and Slaw".

string str = "BBQ and Slaw";
Console.WriteLine(str.PadLeft(15));  // Displays "   BBQ and Slaw".
Console.WriteLine(str.PadLeft(5));   // Displays "BBQ and Slaw".

Dim str As String
str = "BBQ and Slaw"
Console.WriteLine(str.PadLeft(15)) ' Displays "   BBQ and Slaw".
Console.WriteLine(str.PadLeft(5))  ' Displays "BBQ and Slaw".

注釈

Unicode 空間は、16 進数の文字0x0020。

メソッド PadLeft(Int32) は、返された文字列の先頭をパットします。 つまり、右から左の言語で使用すると、文字列の右側の部分がパッドになります。

注意

メソッドが現在のインスタンスを空白文字でパッドする場合、このメソッドは現在のインスタンスの PadLeft 値を変更しません。 代わりに、先頭の空白で埋め込んだ新しい文字列が返されます。この文字列の合計長は文字 totalWidth になります。

こちらもご覧ください

• Int32
• PadRight(Int32)
• Trim(Char[])

PadLeft(Int32, Char)

指定された文字数になるまで左側に指定された Unicode 文字を埋め込むことで、このインスタンス内の文字を右寄せした新しい文字列を返します。

public:
 System::String ^ PadLeft(int totalWidth, char paddingChar);

public string PadLeft (int totalWidth, char paddingChar);

member this.PadLeft : int * char -> string

Public Function PadLeft (totalWidth As Integer, paddingChar As Char) As String

パラメーター

totalWidth

Int32

結果として生成される文字列の文字数。これは、元の文字数と、埋め込み文字がある場合はその数を加えた数に等しくなります。

paddingChar

Char

Unicode 埋め込み文字。

戻り値

String

このインスタンスと等価な新しい文字列。ただし右揃えであり、totalWidth の長さになるまで左側に paddingChar の文字が埋め込まれています。 ただし、totalWidth がこのインスタンスの長さより短い場合、メソッドは既存のインスタンスへの参照を返します。 totalWidth がこのインスタンスの長さと等しい場合、メソッドはこのインスタンスと同一の新しい文字列を返します。

例外

ArgumentOutOfRangeException

totalWidth が 0 未満です。

例

PadLeftメソッドの例を次に示します。

using namespace System;

void main()
{
   String^ str = "forty-two";
   Console::WriteLine( str->PadLeft( 15, L'.' ) ); 
   Console::WriteLine( str->PadLeft( 2, L'.' ) ); 
}
// The example displays the following output:
//       ......forty-two
//       forty-two

using System;

class Sample
{
   public static void Main()
   {
   string str = "forty-two";
   char pad = '.';

   Console.WriteLine(str.PadLeft(15, pad));
   Console.WriteLine(str.PadLeft(2, pad));
   }
}
// The example displays the following output:
//       ......forty-two
//       forty-two

Public Class Example
   Public Shared Sub Main()
      Dim str As String
      Dim pad As Char
      str = "forty-two"
      pad = "."c
      Console.WriteLine(str.PadLeft(15, pad)) 
      Console.WriteLine(str.PadLeft(2,  pad))
    End Sub
End Class
' The example displays the following output:
'       ......forty-two
'       forty-two

注釈

メソッド PadLeft(Int32, Char) は、返された文字列の先頭をパットします。 つまり、右から左の言語で使用すると、文字列の右側の部分がパッドになります。

注意

メソッドが現在のインスタンスを空白文字でパッドする場合、このメソッドは現在のインスタンスの PadLeft 値を変更しません。 代わりに、先頭の文字で埋め込んだ新しい文字列を返し、その合計 paddingChar 長が文字 totalWidth になります。

こちらもご覧ください

• Char
• Int32
• PadRight(Int32)
• Trim(Char[])