Função Formatar Número

A função Formatar Número retorna uma sequência que é um número formatado para se ajustar ao padrão especificado.

Parâmetro: número

O número a ser formatado. Isto pode vir de um nó de origem, o resultado de uma outra função ou um valor especificado.

Parâmetro: cadeia

Um padrão que especifica como o primeiro parâmetro deve ser formatado. Esse padrão usa estes símbolos para definir o padrão:
  • Dígitos necessários = 0
  • Dígitos opcionais = #
  • Símbolo de menos = -
  • Símbolo decimal = .
  • Separador de agrupamento = ,. Geralmente usado para separar grupos de três dígitos.
  • Símbolo de porcentagem = %. Quando o símbolo de porcentagem está presente, o número de entrada é multiplicado por 100 e o resultado é mostrado como uma porcentagem.
  • Símbolo por mil =  (Unicode x2030). Este símbolo multiplica o número por 1000 e mostra o resultado como por mil.
  • Separador positivo/negativo = ;
  • Infinito = infinito
  • Não um número = NaN
  • $ = $
Os padrões podem ter texto constante como um prefixo, sufixo ou ambos. Os usos comuns são para especificar o símbolo monetário ou alguma unidade de medida.
  • $#,##0.00 – formata um número no formato padrão para dólares americanos com o sinal de dólar, vírgulas para separadores e pelo menos um dígito para dólar e dois dígitos para centavos.
  • #0.000% – formata um número decimal como uma porcentagem com pelo menos três posições decimais.
  • #,##0.00;(#,##0.00) – formata número negativo com parênteses, um formato normalmente usado em contabilidade.

Retorna: cadeia

O primeiro parâmetro reformatado para refletir o padrão especificado pelo segundo parâmetro.

Exemplos

Os padrões podem ter texto constante como um prefixo, sufixo ou ambos. Os usos comuns são para especificar o símbolo monetário ou alguma unidade de medida.  

Exemplo 1

$#,##0.00 – formata um número no formato padrão para dólares americanos com o sinal de dólar, vírgulas para separadores e pelo menos um dígito para dólar e dois dígitos para centavos.

format-number(12345.6789,'$#,##0.00') = '$12,345.67'
Exemplo 2

#0.000% – formata um número decimal como uma porcentagem com pelo menos três posições decimais.

format-number(.67890123,'#0.000%') = '67.890%'

Quando o símbolo de porcentagem está presente, o número de entrada é multiplicado por 100.

Exemplo 3

#,##0.00;(#,##0.00) – formata número negativo com parênteses, um formato normalmente usado em contabilidade.

format-number(-12345.6789,'#,##0.00;(#,##0.00)') = '(12,345.67)'