Variável, Formatação

Formatação de Variáveis ou Máscara de Formatação:

Com o Editor GDoc é possível formatar o conteúdo das variáveis do tipo data, hora, CPF, valores e outras. Desta forma, o conteúdo das variáveis poderão ser apresentados de forma padronizada nos documentos. Exemplo: Data no formato DD/MM/AAAA ou CPF 999.999.999-99.

Sintaxe (modelo) para o uso da Máscara de formatação:

${nomedafuncao.execute([{variável}, parâmetro2, parâmetro3, ....])}

A seguir demostraremos as Máscaras de formatação para as Variáveis Gennera:

• CPF:

Função: ${cpf.execute([{variável}])}

Formata variáveis cujo conteúdo é de CPF da seguinte forma: 12.123.123-12

Ex.: ${cpf.execute([{cpfAluno}])} para formatar o CPF do aluno

• CNPJ:

Função: ${cnpj.execute([{variável}])}

Formata variáveis cujo conteúdo é de CNPJ da seguinte forma: 123.123.123/1234-12

Ex.: ${cnpj.execute([{cnpjInstituicao}])} para formatar o CNPJ da instituição

• CEP:

Função: ${cep.execute([{variável}])}

Formata variáveis cujo conteúdo é de CEP da seguinte forma: 12345-123

Ex.: ${cep.execute([{cepAluno}])} para formatar o CEP da residência do aluno

• Letras Maiúsculas:

Função: ${upper.execute([{variável}])}

Altera todas as letras da variável para maiúsculas.

Ex.: ${upper.execute([{nmAluno}])} para que o nome do aluno seja exibido com todas as letras em maiúsculo, como “ANTONIO DOS SANTOS”.

Poderá ser usada para fazer a formatação de um texto escrito diretamente na função, sendo colocado entre aspas simples. Ex.: ${upper.execute(['Lei Federal N. 123'])} resulta em “LEI FEDERAL N. 123”.

• Letras Minúsculas:

Função: ${lower.execute([{variável}])}

Altera todas as letras da variável para minúsculas.

Ex.: ${lower.execute([{nmAluno}])} para que o nome do aluno seja exibido com todas as letras em minúsculo, como “antonio dos santos”.

Poderá ser usada para fazer a formatação de um texto escrito diretamente na função, sendo colocado entre aspas simples. Ex.: ${lower.execute(['Lei Federal N. 123'])} resulta em “lei federal n. 123”.

• Conteúdo:

Função: ${ formatNull.execute([{variável}, 'valorPadrao'])}

Se a variável não tiver conteúdo ou tiver conteúdo nulo, será exibido o valor padrão informado. Caso contrário, será informado o conteúdo da variável.

Ex.: ${ formatNull.execute([{mediaAprovacaoPeriodo}, '--'])} se a média em questão não tiver conteúdo ou tiver conteúdo nulo, será apresentado “--” (dois tracinhos)

• Data e Hora:

Função: ${date.execute([{variável}, 'dd-MM-yyyy'])}

Trata variáveis cujo conteúdo é Data e Hora para serem apresentadas em diversos formatos como 30/03/2000 ou Mar/2000 ou 2000/03/30, etc

A função trata dois parâmetros: o primeiro é a variável de data/hora a ser formatada, e o segundo é o padrão de formatação. Para especificar um padrão, utiliza-se uma combinação de identificadores e símbolos:

• Identificadores (deve-se obedecer a escrita em maiúscula/minúscula indicadas, sendo informado entre aspas simples):

– ano com dois algarismos: yy

– ano com 4 algarismos: yyyy

– mês com 2 algarismos: MM

– mês por extenso com 3 letras: MMM (ex.: Jan, Fev, etc)

– mês por extenso: MMMM (ex.: Janeiro, Fevereiro, etc)

– dia do mês: dd

– dia da semana com 3 letras: EEE (ex.: Sex)

– dia da semana por extenso: EEEE (ex.: Sexta-feira)

– hora, de 00 até 23: HH

– hora, de 00 até 11: KK

– período do dia (am/pm): aa

– minutos: mm

– segundos: SS

- Símbolos:

“/” ou “–“ ou “,” para datas

“:” para hora

• A seguir apresentaremos alguns exemplos considerando, data 12/03/2011 e horas: 14h

Representação de dia / mês / ano com 4 algarismos separados por hífen

${date.execute([{variável}, 'dd-MM-yyyy'])} resultará em “12-03-2011”

Representação de dia / mês / ano com 2 algarismos separados por barra

${date.execute([{variável}, 'dd/MM/yy'])} resultará em “12/03/11”

Representação de mês / ano com 4 algarismos separados por barra

${date.execute([{variável}, 'MMM/yyyy'])} resultará em Mar/2011“”

Representação só de dia

${date.execute([{variável}, 'dd'])} resultará em “12”

Representação só de mês

${date.execute([{variável}, 'MM'])} resultará em “03”

Representação com mês por extenso, com 3 letras separados por vírgula

${date.execute([{variável}, 'dd, MMMM, yyyy'])} resultará em “12, Março, 2011”

Representação de hora:minutos (24h)

${date.execute([{variável}, 'HH:mm'])} resultará em “14:00”

Representação de hora:minutos (12h)

${date.execute([{variável}, 'KK:mm aa'])} resultará em “02:00 pm”

• Variáveis Numéricas

Função: ${number.execute([{variável}, '000,0'])}

Trata variáveis cujo conteúdo é um número para serem apresentadas em diversos formatos como 30,00, 30, 030, etc.

Esta função formata variáveis numéricas, ou variáveis com valores de texto que possam ser convertidos para um número válido.

• A função aceita um, dois ou três parâmetros, sendo que:

1. Um parâmetro: o parâmetro deve ser a variável a ser formatada, que será apresentada com duas casas decimais e separador de milhar. Os separadores de milhar e decimal serão ponto e vírgula, respectivamente. Caso a variável seja um número decimal com precisão de mais de duas casas decimais, a segunda casa decimal é arredondada.

2. Dois parâmetros: o segundo parâmetro deve especificar o padrão para a formatação. Os separadores de milhar e decimal continuam sendo ponto e vírgula, respectivamente.

3. Três parâmetros: o terceiro parâmetro ('en') é utilizado para inverter os separadores de milhar e decimal, isto é, fazer com que o ponto seja o separador decimal e a vírgula seja o separador de milhar.

• Número mínimo de dígitos na formatação:

- para cada dígito que deva aparecer obrigatoriamente, um '0' (zero) deve ser usado no padrão

- para cada dígito que deva aparecer somente se o número a ser formatado contenha aquele dígito, uma '#' (cerquilha) deve ser usada no padrão

• Percentual:

Números com valor entre 0 a 1 podem ser expressos em percentual, exemplo:

${number.execute([{variável}, '#%']} . Se a variável = 0.33 , resultará em '33%'

• Exemplos considerando o número 1000,057:

${number.execute([{variável}])} resultará em '1.000,06' (o valor é arredondado)

${number.execute([{variável}, '00000,000'])} resultará em '01000,057' (omite o separador de milhar)

${number.execute([{variável}, '00000'])} resultará em '01000'

${number.execute([{variável}, '##.##0,00'])} resultará em '1.000,06'

${number.execute([{variável}, '##,###.00', 'en']} resultará em '1,000.06'

Dica

Para mudar de formatação da variável (tamanho, tipo, cor e outros) selecione todo o nome da variável, incluindo as chaves.