FormatNumber [VBA]

Vrátí řetězec se zformátovaným číselným výrazem.

Tato konstanta, funkce nebo objekt se povoluje příkazem Option VBASupport 1, který je umístěn v modulu před spustitelným programem.

Syntaxe:


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

Návratová hodnota:

String

Parametry:

expression: Vyžadováno. Číselný výraz, který se má zformátovat. Pokud je expression řetězec, desetinný oddělovač a oddělovač tisíců musejí odpovídat národnímu prostředí.

numDigitsAfterDecimal: Nepovinné. Číselná hodnota určující počet číslic, který se má zobrazit za desetinnou čárkou. Je-li vynecháno, výchozí hodnotou je -1, což znamená, že by se mělo použít národní nastavení uživatelského rozhraní.

includeLeadingDigit: Nepovinné. Hodnota výčtu vbTriState určující, zda se mají zobrazovat úvodní nuly.

vbTrue nebo -1: Úvodní nuly se zobrazí.
vbFalse nebo 0: Úvodní nuly se nezobrazí.
vbUseDefault nebo -2: Použije se nastavení národního prostředí uživatelského rozhraní. Jedná se o výchozí hodnotu, je-li parametr vynechán.

useParensForNegativeNumbers: Nepovinné. Hodnota výčtu vbTriState, která určuje, zda se mají záporná čísla zobrazovat v závorkách.

vbTrue nebo -1: Pro záporná čísla se použijí závorky.
vbFalse nebo 0: Závorky se nepoužijí.
vbUseDefault nebo -2: Stejné jako vbFalse. Jedná se o výchozí hodnotu, je-li parametr vynechán.

groupDigits: Nepovinné. Hodnota výčtu vbTriState, která určuje, zda se mají číslice seskupovat (do tisíců apod.) s využitím oddělovače podle místního nastavení systému.

vbTrue nebo -1: Číslice budou členěny.
vbFalse nebo 0: Číslice nebudou členěny.
vbUseDefault nebo -2: Stejné jako vbFalse. Jedná se o výchozí hodnotu, je-li parametr vynechán.

Chybové kódy:

13 Datové typy nesouhlasí

Příklad:


        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

Matematické funkce VBA