Funkcja FormatNumber [VBA]

Zwraca ciąg z formatowaniem liczb zastosowanym do wyrażenia liczbowego.

Ta stała, funkcja lub obiekt włączane są przez instrukcję Option VBASupport 1 umieszczoną w module przed programem wykonywalnym.

Składnia:

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

Zwracana wartość:

String

Parametry:

expression: Wymagany. Wyrażenie liczbowe do sformatowania. Jeśli expression jest łańcuchem znaków, separator dziesiętny i tysiące muszą być zlokalizowane.

numDigitsAfterDecimal: Opcjonalny. Wartość liczbowa określająca liczbę cyfr, które mają być wyświetlane po przecinku. Jeśli zostanie pominięty, przyjmuje wartość domyślną -1, co oznacza, że należy użyć domyślnych ustawień regionalnych interfejsu użytkownika.

includeLeadingDigit: Opcjonalny. Wartość wyliczenia vbTriState, określająca, czy w przypadku wartości ułamkowych ma być wyświetlane wiodące zero.

vbTrue lub -1: Wyświetl wiodące zero.
vbFalse lub 0: Nie wyświetlaj wiodących zer.
vbUseDefault lub -2: Użyj ustawień regionalnych interfejsu użytkownika. Jest to ustawienie domyślne w przypadku pominięcia.

useParensForNegativeNumbers: Opcjonalny. Wartość wyliczenia vbTriState określająca, czy liczby ujemne powinny być ujęte w nawiasy.

vbTrue lub -1: Użyj nawiasów dla liczb ujemnych.
vbFalse lub 0: Nie wyświetlaj nawiasów.
vbUseDefault lub -2: To samo co vbFalse. Jest to ustawienie domyślne w przypadku pominięcia.

groupDigits: Opcjonalny. Wartość wyliczenia vbTriState określająca, że liczba powinna być pogrupowana (w tysiące itp.) przy użyciu ogranicznika grupy określonego w systemowych ustawieniach regionalnych.

vbTrue lub -1: Grupuj cyfry.
vbFalse lub 0: Nie grupuj cyfr.
vbUseDefault lub -2: To samo co vbFalse. Jest to ustawienie domyślne w przypadku pominięcia.

Kody błędów:

13 Niezgodność typów

Przykład:

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

Funkcje matematyczne w VBA