Essa documentação diz respeito aos blocos de programação Formatar Data e Formatar Data com Fuso, apesar de terem nomes parecidos, funcionam de formas diferentes.

Para mais detalhes sobre as máscaras aceitas por esses blocos, acesse a documentação oficial.

Formatar data

Formata uma determinada data a partir da máscara informada, permite selecionar o idioma de retorno a partir das configurações do cliente ou servidor. 

Figura 1 - Bloco Formatar Data

Compatibilidade

• Bloco servidor: cronapi.dateTime.Operations.formatDateTime2()

Retorno

Retorna uma string formatada com o padrão da máscara e idioma passados como argumento.

Parâmetros

Data

Data para formatação.

• Posição: 1
• Inglês: Date
• Tipo: Data / Date
• Exemplo: retorno do bloco Obter data e hora atual

Máscara

Máscara a ser aplicada. Para saber mais sobre as máscaras, acesse a documentação Formatação de máscaras na camada servidor.

• Posição: 2
• Inglês: Mask
• Tipo: Texto / String
• Exemplo: "EEEEE MMMMM yyy HH:mm:ss.SSS"

Usar idioma do cliente?

Define o idioma da data formatada.

• Posição: 3
• Inglês: Use client locale?
• Tipo: Boleano / Boolean
• Exemplo: Sim
• Opções:
  • Sim: obtém o idioma configurado no navegador do cliente.
  • Não: obtém o idioma configurado no campo País e Idioma nas Configurações do Projeto. Caso esse campo esteja vazio, o bloco irá obter o idioma configurado na máquina virtual do servidor do sistema.

Exemplo 

A função abaixo recebe a data e hora atual e aplica a máscara (EEEEE MMMMM yyyy HH:mm:ss.SSS) passada como parâmetro. A função foi requisitada 3 vezes (destaque 1 da figura 2) alterando apenas a configuração do parâmetro "Usar idioma do cliente?" e o campo "País e Idioma" nas configurações do projeto (aba Configurações do projeto). Abaixo temos detalhes de cada execução:

1. A opção "Usar idioma do cliente" foi marcado como "Sim" e o navegador que executou a aplicação estava configurado para o idioma "Francês".
2. A opção "Usar idioma do cliente" foi marcado como "Não" e não foi definido um valor no campo "País e Idioma" nas configurações do projeto, logo o bloco usou a configuração de idioma da máquina virtual do servidor.
3. A opção "Usar idioma do cliente" foi marcado como "Não" e o valor no campo "País e Idioma" nas configurações do projeto foi definido como "Brasil - Português".

Figura 2 - Executando o bloco Formatar data

Formatar data com Fuso Horário

Formata uma determinada data (com um fuso horário) a partir da máscara informada, permite selecionar o idioma de retorno a partir das configurações do cliente ou servidor.

Figura 3 - Bloco Formatar Data Com Fuso Horário

Compatibilidade

• Bloco servidor: cronapi.dateTime.Operations.formatDateTime2()

Retorno

Retorna uma string formatada com o padrão da máscara, idioma e fuso horário passados como argumento.

Parâmetros

Data

Data para formatação.

• Posição: 1
• Inglês: Date
• Tipo: Data / Date
• Exemplo: retorno do bloco Obter data e hora atual

Máscara

Máscara a ser aplicada. Para saber mais sobre as máscaras, acesse a documentação Formatação de máscaras na camada servidor.

• Posição: 2
• Inglês: Mask
• Tipo: Texto / String
• Exemplo: "EEEEE MMMMM yyy HH:mm:ss.SSS"

Fuso Horário

Valor do fuso horário. Aceita valores negativos, não é necessário informar "+" para valores positivos.

• Posição: 3
• Inglês: Time Zone
• Tipo: Inteiro / Integer
• Exemplo: -3

Usar idioma do cliente?

Define o idioma da data formatada.

• Posição: 4
• Inglês: Use client locale?
• Tipo: Boleano / Boolean
• Exemplo: Sim
• Opções:
  • Sim: obtém o idioma configurado no navegador do cliente.
  • Não: obtém o idioma configurado no campo País e Idioma nas Configurações do Projeto. Caso esse campo esteja vazio, o bloco irá obter o idioma configurado na máquina virtual do servidor do sistema.

Exemplo 

A função abaixo recebe a data e hora atual, mais o fuso horário (3), e aplica a máscara (EEEEE MMMMM yyyy HH:mm) passada como parâmetro. O resultado está impresso no Console do Depurador. 

A função foi requisitada 3 vezes (destaque 1 da figura 3.1) alterando apenas a configuração do parâmetro "Usar idioma do cliente?" e o campo "País e Idioma" nas configurações do projeto (aba Configurações do projeto). Abaixo temos detalhes de cada execução:

1. A opção "Usar idioma do cliente" foi marcado como "Sim" e o navegador que executou a aplicação estava configurado para o idioma "Francês".
2. A opção "Usar idioma do cliente" foi marcado como "Não" e não foi definido um valor no campo "País e Idioma" nas configurações do projeto, logo o bloco usou a configuração de idioma da máquina virtual do servidor.
3. A opção "Usar idioma do cliente" foi marcado como "Não" e o valor no campo "País e Idioma" nas configurações do projeto foi definido como "Brasil - Português".

Figura 3.1 - Executando o bloco Formatar data com Fuso Horário