string.PadLeft

定義

名前空間: Alice
アセンブリ: Losetta.Runtime.dll
ソースコード: Alice.Core.String.cs

PadLeft(number)

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

namespace Alice;
public string PadLeft(number totalWidth);

PadLeft(number,bool)

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

namespace Alice;
public string PadLeft(number totalWidth, bool truncate = false);

PadLeft(number,string)

指定された文字数になるまで右側に指定した文字を埋め込むことで、この文字列を左寄せした新しい文字列を取得します。

namespace Alice;
public string PadLeft(number totalWidth, string paddingChar, bool truncate = false);

PadLeft(number,string,bool)

指定した文字数になるまで右側に指定した文字を埋め込み、必要に応じて切り詰めることで、指定した文字数内でこの文字列を左寄せした新しい文字列を取得します。

namespace Alice;
public string PadLeft(number totalWidth, string paddingChar, bool truncate = false);

説明

この関数は、文字列を特定の文字数の中で右寄せします。

右寄せとは、その文字列が全体のあたかも右端にあるかのように、指定された長さになるまで左に文字を追加することです。追加される文字はpaddingCharで指定できます。この引数に長さが2以上の文字列が指定された場合は、先頭の1文字目が使用されます。

規定ではこの関数は、文字列の長さがtotalWidthより大きい場合は、そのままの文字列を返します。文字列をtotalWidthまで切り詰めたい場合は、truncateにtrueを指定してください。ただし、この切り詰めは文字列の右側に適用されます。

次の表は、totalWidthを5に、paddingCharに*を指定したとして、文字列がどのように中央揃えされるかを表しています。

文字列を中央寄せするにはstring.PadCenterメソッドを、左寄せするにはstring.PadRightメソッドを使用してください。

例

以下は、ABCを5文字になるまで右寄せします。

var str = "ABC";
print(str.PadLeft(5));
//出力例:"  ABC"