FormatPercent [VBA]

Retorna uma cadeia de caracteres com uma formatação numérica aplicada a uma expressão numérica. Um sinal de porcentagem é anexado à cadeia de caracteres retornada.

Esta constante, função ou objeto se ativa com a instrução Option VBASupport 1 colocada antes do código executável do programa em um módulo.

Sintaxe:


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

Valor de retorno:

String

Parâmetros:

expression: Requerido. Uma expressão numérica a ser formatada. Se expression é uma cadeia de caracteres, então o separador decimal e de milhar precisa ser localizado.

numDigitsAfterDecimal: Opcional. Um valor numérico que especifica o número de dígitos a ser exibido após a decimal. Se omitido, o padrão é -1, significando que a configuração padrão da localidade para a interface do usuário deve ser usada.

includeLeadingDigit: Opcional. Um valor da enumeração vbTriState, que especifica se zeros à esquerda devem ser exibidos para valores fracionários.

vbTrue ou -1: Exibe um zero à esquerda.
vbFalse ou 0: Não mostre zeros à esquerda.
vbUseDefaults ou -2: Utilize as configurações regionais da interface do usuário. Este é o padrão se omitido.

useParensForNegativeNumbers: Optional. Um valor da enumeração vbTriState especificando se valores negativos devem estar entre parênteses.

vbTrue ou -1: Use parenteses para números negativos.
vbFalse ou 0: Não mostre parênteses.
vbUseDefaults ou -2: O mesmo que vbFalse. Este é o padrão quando omitido.

groupDigits: Opcional. Um valor da enumeração vbTriState especificando que o número deve ser agrupado ( em milhares, etc...), usando o delimitador de grupo especificado nas configurações regionais do sistema.

vbTrue ou -1: agrupar dígitos.
vbFalse ou 0: não agrupar dígitos.
vbUseDefaults ou -2: O mesmo que vbFalse. Este é o padrão quando omitido.

Códigos de erro:

13 Tipo de dados incompatível

Exemplo:


        Sub TestFormatNumber
          Const UseComputerRegionalSettings = -1

          MsgBox FormatPercent(12.2, NumDigitsAfterDecimal:=2) ' 1220.00% com a interface em inglês

          MsgBox FormatPercent("-,2", 2, IncludeLeadingDigit:=vbTrue) ' -20,00% com a interface em português

          MsgBox FormatPercent("-0.2", 2) ' -20.00% para interface en-US, -0,00 para a interface fr-CA, de-AT ou pt-BR

          MsgBox FormatPercent(-0.2, UseComputerRegionalSettings, UseParensForNegativeNumbers:=vbTrue) ' (20,00)% para a interface pt-BR

          MsgBox FormatPercent("-0,2", UseComputerRegionalSettings, vbUseDefault, vbTrue) ' (20,00)% para a interface em alemão

          MsgBox FormatPercent("-12345678", -1, vbUseDefault, vbUseDefault, GroupDigits:=vbTrue) ' -1 234 567 800,00% para a interface fr-BE

        End Sub

Funções matemáticas do VBA