Format (Función)

Artículo
08/23/2008

Actualización: noviembre 2007

Devuelve una cadena con el formato que especifiquen las instrucciones contenidas en una expresión String de formato.

Public Shared Function Format( _
   ByVal Expression As Object, _
   Optional ByVal Style As String = "" _
) As String

Parámetros

Expression
Requerido. Cualquier expresión válida.
Style
Opcional. Expresión String de formato con nombre o definido por el usuario que es válido.

Valores

Para obtener información sobre cómo crear el argumento Style, vea el tema correspondiente en la siguiente lista:

Para dar formato	Haga lo siguiente
Números	Utilice formatos numéricos predefinidos o cree formatos numéricos definidos por el usuario.
Fechas y horas	Utilice formatos de fecha y hora predefinidos o cree formatos de fecha y hora definidos por el usuario.
Números de serie de fecha y hora.	Usar formatos de fecha y hora o numéricos.

Si intenta aplicar formato a un número sin especificar Style, la función Format ofrecerá una funcionalidad similar a la función Str, a pesar de admitir configuraciones internacionales. No obstante, los números positivos a los que se les da formato de cadena mediante la función Format no incluyen ningún espacio inicial reservado para el signo del valor; los que se convierten mediante la función Str sí conservan este espacio inicial.

Comentarios

Si da formato a una cadena numérica no localizada, debería utilizar un formato numérico definido por el usuario para asegurarse de lograr la presentación deseada.

El método String.Format también proporciona una funcionalidad similar.

Ejemplo

En este ejemplo se muestran los diversos usos de la función Format para dar formato a valores tanto con formatos String como otros definidos por el usuario. Para el separador de fecha (/), hora (:) e indicadores de a.m./p.m. (t y tt), el formato de salida que muestre su sistema dependerá de la configuración regional que use el código. Cuando las horas y fechas se muestren en el entorno de desarrollo, se utilizará el formato de fecha y hora corta de la configuración regional del código.

Nota:
Para configuraciones regionales que utilizan un reloj de 24 horas, los indicadores de a.m./p.m. (t y tt) no muestran nada.

Dim TestDateTime As Date = #1/27/2001 5:04:23 PM#
Dim TestStr As String
' Returns current system time in the system-defined long time format.
TestStr = Format(Now(), "Long Time")
' Returns current system date in the system-defined long date format.
TestStr = Format(Now(), "Long Date")
' Also returns current system date in the system-defined long date 
' format, using the single letter code for the format.
TestStr = Format(Now(), "D")

' Returns the value of TestDateTime in user-defined date/time formats.
' Returns "5:4:23".
TestStr = Format(TestDateTime, "h:m:s")
' Returns "05:04:23 PM".
TestStr = Format(TestDateTime, "hh:mm:ss tt")
' Returns "Saturday, Jan 27 2001".
TestStr = Format(TestDateTime, "dddd, MMM d yyyy")
' Returns "17:04:23".
TestStr = Format(TestDateTime, "HH:mm:ss")
' Returns "23".
TestStr = Format(23)

' User-defined numeric formats.
' Returns "5,459.40".
TestStr = Format(5459.4, "##,##0.00")
' Returns "334.90".
TestStr = Format(334.9, "###0.00")
' Returns "500.00%".
TestStr = Format(5, "0.00%")