PadLeft()
OutputVar := instance.PadLeft(totalWidth)
OutputVar := instance.PadLeft(totalWidth, paddingChar)
OutputVar := MfString.PadLeft(str, totalWidth)
OutputVar := MfString.PadLeft(str, totalWidth, paddingChar)
Returns a new MfString that right-aligns the characters in this instance of MfString by padding them with spaces on the left, for a specified total length.
Returns a new MfString that right-aligns the characters in this instance of MfString by padding them on the left with a specified character, for a specified total length.
Static method.
Returns new MfString that right-aligns the characters in the str of MfString by padding them with spaces on the left, for a specified total length.
Static method.
Returns new MfString that right-aligns the characters in the str of MfString by padding them on the left with a specified character, for a specified total length.
str
A string to pad left.
Can be MfString instance or var containing string.
totalWidth
An integer of the total characters in the resulting string, equal to the number of original characters plus any additional padding characters.
Can be MfInteger instance or var containing integer.
paddingChar
A padding character.
Can be MfChar instance or string var containing character.
A new string that is equivalent to this instance, but right-aligned and padded on the left with as many paddingChar characters as needed to create a length of totalWidth. However, if totalWidth is less than the length of this instance, the method returns a reference to the existing instance. If totalWidth is equal to the length of this instance or str value, the method returns a var containing a string that is identical to this instance or str value.
If ReturnAsObject Property for this instance is true then returns MfString otherwise returns var containing string.
Overloads method supports using all vars or all objects. Mixing of vars and Objects is supported for this method.
Variadic Method; This method is Variadic so you may construct an instance of MfParams containing any of the overload method parameters listed above and pass in the MfParams instance to the method instead of using the overloads described above. See MfParams for more information.
Throws MfNotSupportedException if the incorrect number or type of parameters are passed in.
Throws MfArgumentOutOfRangeException if startIndex or length is out of range
Throws MfArgumentException if there is an error get a value from a parameter.
; ---------------------------------------------------
s := "Hello World"
result := MfString.PadLeft(s, 20) ; Get the results; result.Value = " Hello World"
; ---------------------------------------------------
MyStr := new MfString("Hello World")
result := MyStr.PadLeft(20) ; Get the results; result.Value = " Hello World"
; ---------------------------------------------------
MyStr := new MfString("Hello World")
result := MyStr.PadLeft(20, ".") ; Get the results; result.Value = ".........Hello World"
; ---------------------------------------------------
MyStr := new MfString("Hello World")
iWidth := new MfInteger(20) ; create a new instance MfInteger
result := MyStr.PadLeft(iWidth) ; Get the results; result.Value = " Hello World"
; ---------------------------------------------------
MyStr := new MfString("Hello World")
p := new MfParams() ; create a new instance of the MfParams class
p.AddInteger(20) ; add totalWidth to MfParams
p.AddChar(".") ; add paddingChar to MfParams
result := MyStr.PadLeft(p) ; Get the results; result.Value = ".........Hello World"
; ---------------------------------------------------
MyStr := new MfString("Hello World")
iWidth := new MfInteger(20) ; create a new instance MfInteger
pChar := new MfChar(".") ; create a new instance of MfChar
result := MyStr.PadLeft(iWidth, pChar) ; Get the results; result.Value = ".........Hello World"
;---------------------------------------------------
mystr := MfString.Format("OsType:{0} Version:{1}", A_OSType, A_OSVersion)
i := new MfInteger(5)
str := new MfString("Cool computer")
mystr := MfString.Format("My computer is named:{0} and I have had it for {1} years", str, i)
; set MfString instance to return it method outputs as objects. This allows for method chaining
strObjA := new MfString(mystr, true)
resultA := MfString.Format(strObjA, str, i).Substring(58).PadLeft(20, ".")
MsgBox % resultA.Value ; displays ...............years