String.PadLeft Método

Definición

Devuelve una nueva cadena de una longitud especificada en la que el principio de la cadena actual se rellena con espacios o con un carácter Unicode especificado.

Sobrecargas

PadLeft(Int32)

Devuelve una nueva cadena que alinea a la derecha los caracteres de la instancia e inserta espacios en blanco a la izquierda hasta alcanzar la longitud total especificada.

PadLeft(Int32, Char)

Devuelve una nueva cadena que alinea a la derecha los caracteres de la instancia e inserta a la izquierda un carácter Unicode especificado hasta alcanzar la longitud total especificada.

PadLeft(Int32)

Devuelve una nueva cadena que alinea a la derecha los caracteres de la instancia e inserta espacios en blanco a la izquierda hasta alcanzar la longitud total especificada.

public:
 System::String ^ PadLeft(int totalWidth);
public string PadLeft (int totalWidth);
member this.PadLeft : int -> string
Public Function PadLeft (totalWidth As Integer) As String

Parámetros

totalWidth
Int32

Número de caracteres de la cadena resultante, igual al número de caracteres originales más el número de caracteres de relleno adicionales.

Devoluciones

String

Nueva cadena que es equivalente a esta instancia, pero que se alinea a la derecha y en la que se insertan a la izquierda los espacios que sean necesarios para crear la longitud especificada por el parámetro totalWidth. Sin embargo, si totalWidth es menor que la longitud de esta instancia, el método devuelve una referencia a la instancia existente. Si totalWidth es igual que la longitud de esta instancia, el método devuelve una nueva cadena que es idéntica a esta instancia.

Excepciones

totalWidth es menor que cero.

Ejemplos

En el siguiente ejemplo se muestra el PadLeft método.

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".

Comentarios

Un espacio Unicode se define como un espacio hexadecimal 0x0020.

El PadLeft(Int32) método completa el principio de la cadena devuelta. Esto significa que, cuando se usa con idiomas de derecha a izquierda, se completa la parte derecha de la cadena.

Nota

Si el método incluye caracteres de espacio en blanco en la instancia actual, este método PadLeft no modifica el valor de la instancia actual. En su lugar, devuelve una nueva cadena que se agrega con espacio en blanco inicial para que su longitud total sea totalWidth caracteres.

Consulte también

Se aplica a

PadLeft(Int32, Char)

Devuelve una nueva cadena que alinea a la derecha los caracteres de la instancia e inserta a la izquierda un carácter Unicode especificado hasta alcanzar la longitud total especificada.

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

Parámetros

totalWidth
Int32

Número de caracteres de la cadena resultante, igual al número de caracteres originales más el número de caracteres de relleno adicionales.

paddingChar
Char

Carácter Unicode de relleno.

Devoluciones

String

Nueva cadena que es equivalente a esta instancia, pero que se alinea a la derecha y en la que se insertan a la izquierda los caracteres de paddingChar que sean necesarios para crear la longitud especificada por el parámetro totalWidth. Sin embargo, si totalWidth es menor que la longitud de esta instancia, el método devuelve una referencia a la instancia existente. Si totalWidth es igual que la longitud de esta instancia, el método devuelve una nueva cadena que es idéntica a esta instancia.

Excepciones

totalWidth es menor que cero.

Ejemplos

En el siguiente ejemplo se muestra el PadLeft método.

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

Comentarios

El PadLeft(Int32, Char) método completa el principio de la cadena devuelta. Esto significa que, cuando se usa con idiomas de derecha a izquierda, se completa la parte derecha de la cadena.

Nota

Si el método incluye caracteres de espacio en blanco en la instancia actual, este método PadLeft no modifica el valor de la instancia actual. En su lugar, devuelve una nueva cadena que se agrega con caracteres iniciales paddingChar para que su longitud total sea totalWidth caracteres.

Consulte también

Se aplica a