Conteúdo
Índice 🔎︎

# Função Format

Converts a numeric expression to a string, and then formats it according to the format that you specify.

### Sintaxe:

    Format(expression [, format As String]) As String

### Parâmetros:

expression: Numeric expression that you want to convert to a formatted string.

format: String that specifies the format code for the number. If format is omitted, the Format function works like the LibreOffice Basic Str() function.

### Valor de retorno:

Text string.

## Códigos de formatação

The following list describes the codes that you can use for formatting a numeric expression:

0: If expression has a digit at the position of the 0 in the format code, the digit is displayed, otherwise a zero is displayed.

If expression has fewer digits than the number of zeros in the format code, (on either side of the decimal), leading or trailing zeros are displayed. If the expression has more digits to the left of the decimal separator than the amount of zeros in the format code, the additional digits are displayed without formatting.

Decimal places in the expression are rounded according to the number of zeros that appear after the decimal separator in the format code.

#: If expression contains a digit at the position of the # placeholder in the format code, the digit is displayed, otherwise nothing is displayed at this position.

This symbol works like the 0, except that leading or trailing zeroes are not displayed if there are more # characters in the format code than digits in the expression. Only the relevant digits of the expression are displayed.

.: O marcador de posição decimal determina o número de casas decimais à esquerda e direita do separador decimal.

If the format code contains only # placeholders to the left of this symbol, numbers less than 1 begin with a decimal separator. To always display a leading zero with fractional numbers, use 0 as a placeholder for the first digit to the left of the decimal separator.

%: Multiplies the expressionby 100 and inserts the percent sign (%) where the expression appears in the format code.

E- E+ e- e+ : If the format code contains at least one digit placeholder (0 or #) to the right of the symbol E-, E+, e-, or e+, the expression is formatted in the scientific or exponential format. The letter E or e is inserted between the number and the exponent. The number of placeholders for digits to the right of the symbol determines the number of digits in the exponent.

Se o expoente for negativo, é mostrado um sinal negativo antes de um expoente com E-, E+, e-, e+. Se o expoente for positivo, só é mostrado o sinal de mais antes dos expoentes com E+ ou e+.

The thousands delimiter is displayed if the format code contains the delimiter enclosed by digit placeholders (0 or #).

A utilização do ponto como separador de milhares e decimal depende da configuração regional. Ao introduzir um número no código fonte do Basic, utilize sempre um ponto como separador decimal. O carácter mostrado como separador decimal depende do formato numérico nas definições do sistema.

- + $ ( ) space: A plus (+), minus (-), dollar ($), space, or brackets entered directly in the format code is displayed as a literal character.

Para mostrar diferentes dos que aqui estão listados, terá de precedê-los com uma barra invertida (\) ou colocá-los entre aspas (" ").

\ : The backslash displays the next character in the format code.

Characters in the format code that have a special meaning can only be displayed as literal characters if they are preceded by a backslash. The backslash itself is not displayed, unless you enter a double backslash (\\) in the format code.

Os caracteres que têm de ser precedidos por uma barra invertida no código do formato para serem mostrados como caracteres literais são os caracteres de formatação da data e hora (a, c, d, h, m, n, p, q, s, t, w, y, /, :), caracteres de formatação numérica (#, 0, %, E, e, vírgula, ponto final) e os caracteres de formatação de cadeias (@, &, <, >, !).

You can also use the following predefined number formats. Except for "General Number", all of the predefined format codes return the number as a decimal number with two decimal places.

Se utilizar formatos pré-definidos, o nome do formato terá de estar entre aspas.

## Formato pré-definido

Geral: os números são mostrados tal como inseridos.

Moeda: insere um símbolo à frente do número e coloca os números negativos entre parênteses.

Fixa: mostra, pelo menos, um dígito à frente do separador decimal.

Padrão: mostra os números com o separador de milhares.

Percentagem: multiplica o número por 100 e anexa um sinal de percentagem ao número.

Científico: mostra os números em notação cientifica (por exemplo, 1,00E+03 para 1000).

A format code can be divided into three sections that are separated by semicolons. The first part defines the format for positive values, the second part for negative values, and the third part for zero. If you only specify one format code, it applies to all numbers.

Pode definir a configuração regional utilizada para controlar o formato de números, datas e moedas no LibreOffice Basic em >LibreOffice - PreferênciasFerramentas - Opções - Definições de idioma - Idiomas. Nos códigos de formato do Basic, o ponto decimal (.) é sempre utilizado como marcador de posição para o separador decimal definido na sua localização e será substituído pelo carácter correspondente.

O mesmo é aplicável às configurações regionais para data, hora e moeda. O código de formatação do Basic será interpretado e mostrado de acordo com a configuração regional do utilizador.

### Códigos de erro

5 Chamada de procedimento inválido

### Exemplo:

    Sub ExampleFormat
        MsgBox Format(6328.2, "##,##0.00")
        ' utilize sempre um ponto como delimitador decimal ao introduzir números no código fonte Basic.
        ' mostra 6,328.20 na configuração regional inglesa e 6.328,20 na configuração regional alemã.
    End Sub

Tópicos relacionados

Códigos de formatos numéricos

String functions