Функція FormatNumber [VBA]

Зміст
Покажчик 🔎︎

# FormatNumber [VBA]

Повертає рядок з числовим форматом, застосованим до числового виразу.

This constant, function or object is enabled with the statement Option VBASupport 1 placed before the executable program code in a module.

### Синтаксис:

FormatNumber( expression, numDigitsAfterDecimal as Integer, includeLeadingDigit as Integer, useParensForNegativeNumbers as Integer, groupDigits as Integer )

### Повертає значення:

Рядок

### Параметри:

виарз: обов'язковий. Числовий вираз для форматування.

numDigitsAfterDecimal: не обов'язково. Числове значення, що вказує кількість цифр, які слід відображати після десяткової коми. Якщо опущено, застосовується значення -1, тобто використовуються типові параметри локалі інтерфейсу користувача.

includeLeadingDigit: не обов'язково. Значення з переліку vbTriState, що вказує, чи повинен виводитися нуль на початку дробових значень.

- vbTrue або -1: показувати нуль на початку.

- vbFalse або 0: не показувати нуль на початку.

- vbUseDefaults або -2: використати налаштування локалі інтерфейсу користувача. Це типове значення.

useParensForNegativeNumbers: не обов'язково. Значення з переліку vbTriState, що вказує, чи повинні від'ємні числа братися в дужки.

- vbTrue або -1: брати від'ємні числа в дужки.

- vbFalse або 0: не брати в дужки.

- vbUseDefaults або -2: те саме, що vbFalse. Це типове значення, якщо пропущено.

groupDigits: не обов'язково. Значення з переліку vbTriState, яке вказує, чи треба згрупувати цифри (тисячі і т. д.), використовуючи розділювач груп, вказаний у регіональних налаштуваннях системи.

- vbTrue або -1: групувати цифри.

- vbFalse або 0: не групувати цифри.

- vbUseDefaults або -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