Compartir a través de

FormatNumber (Función, Visual Basic)

  • Artículo

Actualización: noviembre 2007

Devuelve una expresión con formato de número.

Function FormatNumber(
   ByVal Expression As Object,
   Optional ByVal NumDigitsAfterDecimal As Integer = -1,
   Optional ByVal IncludeLeadingDigit As TriState = TriState.UseDefault,
   Optional ByVal UseParensForNegativeNumbers As TriState = TriState.UseDefault,
   Optional ByVal GroupDigits As TriState = TriState.UseDefault
) As String

Parámetros

  • Expression
    Requerido. Expresión a la que se va a dar formato.

  • NumDigitsAfterDecimal
    Opcional. Valor numérico que indica cuántos lugares a la derecha del signo decimal se van a mostrar. El valor predeterminado es –1, que indica que se utilizará la configuración regional del equipo.

  • IncludeLeadingDigit
    Opcional. Constante de triple estado que indica si los valores fraccionarios han de llevar cero inicial. Vea la sección "Valores" para conocer los valores utilizados.

  • UseParensForNegativeNumbers
    Opcional. Constante de triple estado que indica si los valores negativos han de situarse entre paréntesis. Vea la sección "Valores" para conocer los valores utilizados.

  • GroupDigits
    Opcional. Constante de triple estado que indica si los números se han de agrupar utilizando el delimitador de grupos especificado en la configuración regional del equipo. Vea la sección "Valores" para conocer los valores utilizados.

Valores

Los argumentos IncludeLeadingDigit, UseParensForNegativeNumbers y GroupDigits tienen los siguientes valores.

Constante

Descripción

TriState.True

True

TriState.False

False

TriState.UseDefault

Configuración regional del equipo

Excepciones

Tipo de excepción

Número de error

Condición

InvalidCastException

El tipo no es numérico.

Consulte la columna "Número de error" si está actualizando aplicaciones de Visual Basic 6.0 que utilizan el control de errores no estructurado. (Se puede comparar el número de error con respecto a Number (Propiedad, objeto Err)). Sin embargo, siempre que sea posible, se debe considerar la sustitución de dicho control de errores por Información general sobre el control estructurado de excepciones de Visual Basic.

Comentarios

Cuando se omitan uno o más argumentos opcionales, la configuración regional del equipo proporcionará los valores correspondientes.

Nota:

Toda la información de configuración provendrá de la configuración regional de la aplicación. De manera predeterminada, la configuración regional será la establecida en el panel de control. No obstante, la configuración regional podrá cambiarse mediante programación en .NET Framework.

Ejemplo

En este ejemplo se muestra el uso de la función FormatNumber.

Dim TestNumber As Integer = 45600
' Returns "45,600.00".
Dim TestString As String = FormatNumber(TestNumber, 2, , , TriState.True)

Requisitos

Espacio de nombres:Microsoft.VisualBasic

**Módulo:**Strings

**Ensamblado:**Visual Basic Runtime Library (en Microsoft.VisualBasic.dll)

Vea también

Referencia

Resumen de manipulación de cadenas

FormatCurrency (Función, Visual Basic)

FormatDateTime (Función, Visual Basic)

FormatPercent (Función, Visual Basic)

TriState (Enumeración)

InvalidCastException