Функция FormatNumber [VBA]

Връща низ с числов формат, приложен върху числов израз.

Тази константа, функция или обект се разрешава с оператора Option VBASupport 1, поставен преди изпълнимия програмен код в модула.

Синтаксис:


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

Резултат:

String

Параметри:

expression: задължителен. Числов израз, чиято стойност да се форматира. Ако expression е низ, тогава десетичният разделител и разделителят на хилядите трябва да са локализирани.

numDigitsAfterDecimal: незадължителен. Числова стойност, указваща броя цифри в дробната част. Ако е пропусната, се подразбира -1, което означава да се използват подразбираните настройки за локала на потребителския интерфейс.

includeLeadingDigit: незадължителен. Стойност от изброения тип vbTriState, указваща дали да се показва водеща нула за дробните стойности.

vbTrue или -1: да се показва водеща нула.
vbFalse или 0: да не се показват водещи нули.
vbUseDefault или -2: да се използват настройките за локал на потребителския интерфейс. Това е подразбираната стойност при пропуснат аргумент.

useParensForNegativeNumbers: незадължителен. Стойност от изброения тип vbTriState, указваща дали отрицателните числа да се ограждат в скоби.

vbTrue или -1: да се използват скоби за отрицателните числа.
vbFalse или 0: да не се показват скоби.
vbUseDefault или -2: също като vbFalse. Това е подразбираната стойност при пропуснат аргумент.

groupDigits: незадължителен. Стойност от изброения тип vbTriState, указваща дали цифрите да се групират (за хиляди и пр.) чрез разделителя за групи, зададен в регионалните настройки на системата.

vbTrue или -1: цифрите да се групират.
vbFalse или 0: цифрите да не се групират.
vbUseDefault или -2: също като vbFalse. Това е подразбираната стойност при пропуснат аргумент.

Кодове за грешка:

13 Несъответствие на типовете

Пример:


        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