Funktion FormatNumber [VBA]

Gibt eine Zeichenfolge mit einer Zahl zurück, auf die ein numerischer Ausdruck angewandt wurde.

Diese Konstante, diese Funktion oder dieses Objekt wird durch Platzierung der Anweisung Option VBASupport 1 vor dem auszuführenden Programmcode des Moduls aktiviert.

Syntax:


        FormatNumber( expression As Variant, [numDigitsAfterDecimal As Integer], [includeLeadingDigit As Integer], _
            [useParensForNegativeNumbers As Integer], [groupDigits As Integer] ) As String

Rückgabewert:

String

Parameter:

expression: Erforderlich. Ein zu formatierender numerischer Ausdruck. Wenn expression eine Zeichenfolge ist, müssen das Dezimal- und Tausendertrennzeichen lokalisiert werden.

numDigitsAfterDecimal: Optional. Ein numerischer Wert, welcher die anzuzeigende Zahl der Ziffern nach dem Dezimaltrennzeichen festlegt. Falls fehlend, ist der Standardwert -1, was bedeutet, dass die Standardeinstellungen der Benutzeroberflächen-Sprache verwendet werden.

includeLeadingDigit: Optional. Ein Aufzählungswert vbTriState, welcher festlegt, ob eine führende Null für Bruchteile angezeigt werden soll.

vbTrue oder -1: Mit führender Null darstellen.
vbFalse oder 0: Ohne führende Null darstellen.
vbUseDefault oder -2: Verwendet die Gebietsschemaeinstellungen der Benutzeroberfläche. Dies ist die Standardeinstellung, wenn es weggelassen wird.

useParensForNegativeNumbers: Optional. Ein Aufzählungswert vbTriState, welcher festlegt, ob negative Zahlen in Klammern eingeschlossen dargestellt werden sollen.

vbTrue oder -1: Klammern für negative Zahlen verwenden.
vbFalse oder 0: Keine Klammern verwenden.
vbUseDefault oder -2: Identisch mit vbFalse. Dies ist die Standardeinstellung, wenn es weggelassen wird.

groupSigits: Optional. Ein Aufzählungswert vbTriState, welcher die Anzahl der Stellen festlegt, die gruppiert werden sollen (bei Tausendern und so weiter), unter Verwendung des Gruppierung-Trennzeichens, welches in den lokalen Einstellungen des Betriebssystems festgelegt ist.

vbtrue oder -1: Ziffern gruppieren.
vbFalse oder 0: Ohne Ziffern zu gruppieren.
vbUseDefault oder -2: Identisch mit vbFalse. Dies ist die Standardeinstellung, wenn es weggelassen wird.

Fehlercodes:

13 Datentyp kann nicht konvertiert werden

Beispiel:


        Sub TestFormatNumber
        testName = "Test 1: positive, 2 decimals"
        str2 = "12.20"
        str1 = FormatNumber("12.2", 2, vbFalse, vbFalse, vbFalse)
        msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

        testName = "Test 2: negative, 20 decimals, use leading zero"
        str2 = "-0.20000000000000000000"
        str1 = FormatNumber("-.2", 20, vbTrue, vbFalse, vbFalse)
        msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

        testName = "Test 3: negative, 20 decimals, no leading zero"
        str2 = "-.20000000000000000000"
        str1 = FormatNumber("-0.2", 20, vbFalse, vbFalse, vbFalse)
        msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

        testName = "Test 4: negative, no leading zero, use parens"
        str2 = "(.20)"
        str1 = FormatNumber("-0.2", -1, vbFalse, vbTrue, vbFalse)
        msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

        testName = "Test 5: negative, default leading zero, use parens"
        str2 = "(0.20)"
        str1 = FormatNumber("-0.2", -1, vbUseDefault, vbTrue, vbFalse)
        msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)

        testName = "Test 6: group digits"
        str2 = "-12,345,678.00"
        str1 = FormatNumber("-12345678", -1, vbUseDefault, vbUseDefault, vbTrue)
        msgbox( "FormatNumber returned: " + str1 + ", Expected: " + str2)
        End Sub

VBA – Mathematische Funktionen