Índice

Introdução

Esta página lista e detalha todas as funções que podem ser utilizadas nas expressões no design de um relatório.

Funções de Agregação

Avg(Valor)

Retorna a média dos valores da coleção de dados.

Ex,:

[Produtos].Avg([PrecoUnitario])

Count(Valor)

Retorna o número de objetos em uma coleção de dados.

Ex,:

[Products].Count() → Retorna a quantidade de produtos em uma coleção de dados

Exists()

Determina se o objeto (Valor Especifico) existe na coleção de dados.

Ex.:

[Categories][[CategoryID] == 7].Exists()

Join()

Concatena todos os valores de Expressão na Coleção com base na Condição especificada (opcional) em uma única string (texto) separada pelo Separador especificado (opcional). Se você não especificar um Separador , a função usará uma vírgula.

A função tem as seguintes sobrecargas (2 formas de usar):

[Coleção][Condição].Join(Expressão)

[Coleção][Condição].Join(Expressão, Separador)

Ex.:

A expressão a seguir concatena os valores do campo CompanyName em um relatório agrupado pelo campo CategoryID em uma única string (texto) separada por ponto e vírgula:

[][[CategoryID] == [^.CategoryID]].Join([CompanyName], ';') → Concatena o valor do Id e o Nome da categoria separado por virgula:  41,Cereais

Max(Valor)

Retorna o valor máximo da expressão em uma coleção de dados.

ex.:

[Products].Max([UnitPrice]) →  Retorna o maior valor de preço unitário de uma coleção de produtos.

Min(Valor)

Retorna o valor mínimo da expressão em uma coleção de dados.

ex.:

[Products].Min([UnitPrice]) → Retorna o menor valor de preço unitário de uma coleção de produtos.

Single()

Retorna um objeto (Dado procurado) se for o único elemento de uma coleção de dado.

ex.:

[Accounts].Single() is not null

Single(Expressão)

Você pode passar uma expressão como parâmetro: [Coleção][Condição].Single(Expressão) .

Esta função retorna a Expressão se a Coleção contiver apenas um objeto que atenda à Condição especificada (opcional).

ex.:

[Coleção].Single([Propriedade]) → Retorna o valor da propriedade do objeto encontrado.

Sum(Valor)

Retorna a soma de todos os valores de expressão na coleção.

Ex.:

[Products].Sum([UnitsInStock]) → Soma os valores Unidade em estoque da coleção produtos

Funções de data e hora

AddDays(Data, Numero de Dias)

Retorna um valor de uma Data que é o número especificado de dias antes (Numero negativos) ou depois (Numero positivo) de uma data especificada.

Os operandos são:

1 - o valor Data é a data de início especificada com ou sem horas.

2 - o valor decimal de número de dias será o valor de avanço ou retrocesso da data especificada. Este número pode ser negativo ou positivo. Sua parte decimal é uma fração de dia.

Ex.:

AddDays([OrderDate], 30) → Adiciona 30 dias a partir da data de compra (OrderDate).

AddHours(Data, Numero de Horas)

Retorna um valor Data e Hora que é o número especificado de dias  antes (Numero negativos) ou depois (Numero positivo) de uma data especificada.

Os operandos são:

1 - o valor Data é a data de início especificada com ou sem horas.

2 - o valor decimal de número de horas será o valor de avanço ou retrocesso da data especificada. Este número pode ser negativo ou positivo. Sua parte decimal é uma fração de hora.

Ex.:

AddHours([FinishTime], -2) → Reduz 2 horas a partir do tempo final (FinishTime).

AddMilliSeconds(Data, Numero de Milissegundos)

Retorna um valor Data e hora que é o número especificado de milissegundos antes (Numero negativos) ou depois (Numero positivo) de uma data especificada.

Os operandos são:

1 - o valor Data é a data de início especificada com ou sem horas.

2 - o valor decimal de número de milissegundos  será o valor de avanço ou retrocesso da data especificada. Este número pode ser negativo ou positivo. Sua parte decimal é uma fração de milissegundo.

Ex.:

AddMilliSeconds(([StartTime], 5000)) → Aumenta em 5000 milissegundos o tempo de inicio (StartTime)

AddMinutes(Data, Numero de Minutos)

Retorna um valor Data e hora que é o número especificado de minutos antes (Numero negativos) ou depois (Numero positivo) de uma data especificada.

Os operandos são:

1 - o valor Data é a data de início especificada com ou sem horas.

2 - o valor decimal de número de minutos será o valor de avanço ou retrocesso da data especificada. Este número pode ser negativo ou positivo. Sua parte decimal é uma fração de milissegundo.

Ex.:

AddMinutes([StartTime], -30) → Reduz em 30 minutos o tempo de inicio (StartTime)

AddMonths(Data, Numero de Meses)

Retorna um valor Data e hora que é o número especificado de meses antes (Numero negativos) ou depois (Numero positivo) de uma data especificada.

Os operandos são:

1 - o valor Data é a data de início.

2 - o valor inteiro de número de meses será o valor de avanço ou retrocesso da data especificada. Este número pode ser negativo ou positivo.

Ex.:

AddMonths([OrderDate], 1) → Aumenta em 1 mês a data da ordem (OrdemDate)

AddSeconds(Data, Numero de Segundos)

Retorna um valor Data e hora que é o número especificado de segundos antes (Numero negativos) ou depois (Numero positivo) de uma data especificada.

Os operandos são:

1 - o valor Data é a data de início.

2 - o valor decimal de número de segundos será o valor de avanço ou retrocesso da data especificada. Este número pode ser negativo ou positivo. Sua parte decimal é uma fração de segundos.

Ex.:

AddSeconds([StartTime], -60) → Reduz em 60 segundos o tempo de inicio (StartTime)

AddTicks(Data, Numero de Ticks)

Retorna um valor Data e Hora  que é o número especificado de ticks antes (Numero negativos) ou depois (Numero positivo) de uma data especificada.

Os operandos são:

1 - o valor Data é a data de início.

2 - o valor inteiro de número de ticks de 100 nanossegundos será o valor de avanço ou retrocesso da data especificada. Este número pode ser negativo ou positivo.

Ex.:

AddTicks([StartTime], 5000) → Aumenta em 5000 ticks (500.000 nanossegundos) o tempo de inicio (StartTime)

AddTimeSpan(Data, Duração)

Retorna um valor Data e hora que difere por um período de tempo especificado de uma data especificada.

Os operandos são:

1 - o valor Data é a data de início.

2 - o objeto duração que é o período  será o valor de avanço ou retrocesso da data especificada. 

Ex.:

AddTimeSpan([StartTime], [Duration]) →Testar e colocar descrição melhor, tentei de varias forma e não consegui.

AddYears(Data, Numero de anos)

Retorna um valor Data e Hora  que é o número especificado de anos antes (Numero negativos) ou depois (Numero positivo) de uma data especificada.

Os operandos são:

1 - o valor DateTime que é a data de início.

2 -o valor inteiro de número de anos será o valor de avanço ou retrocesso da data especificada. Este número pode ser negativo ou positivo.

Ex.:

AddYears([EndDate], -1) → Reduz em 1 ano a data final (EndDate)

DataDiffDay(datainicial,datafim)

Retorna o número de dias entre as datas especificadas.

Os operandos são:

1 - o valor Datainicial é a data de início.

2 - o valor Datafim é a data final.

Ex.:

DateDiffDay([StartDate], [FinishDate]) → Retorna o numero de dias entre a data de inicio (StartDate) e data final (FinishDate)

DataDiffHora(datainicial,datafim)

Retorna o número de horas entre as datas especificadas.

Os operandos são:

1 - o valor Datainicial é a data de início.

2 - o valor Datafim é a data final.

Ex.:

DateDiffHour([StartTime], [FinishTime]) → Retorna o numero de horas entre a data de inicio (StartTime) e data final (FinishTime)

DateDiffMilliSecond(datainicial,datafinal)

Retorna o número de limites de milissegundos entre as datas especificadas.

Os operandos são:

1 - o valor DateTime que Datainicial é a data de início.

2 - o valor DateTime que Datafim é a data final.

ExemploEx.:

DateDiffMilliSecond([StartTime], Now()[FinishTime]) → Retorna o numero de milissegundos entre a data de inicio (StartTime) e data final (FinishTime)

DataDiffMinuto(datainicial,datafim)
Retorna o número de limites de minutos entre as datas especificadas.

Os operandos são:

1 - o valor DateTime que é a data de início.

2 - o valor DateTime que é a data final.

Exemplo:DateDiffMinute([StartTime], Now())
DataDiffMês(dataInício,DataFim)
Retorna o número de limites de meses entre as datas especificadas.

Os operandos são:

1 - o valor DateTime que é a data de início.

2 - o valor DateTime que é a data final.

Exemplo:DateDiffMonth([StartTime], Now())
DateDiffSecond(datainicial,datafim)
Retorna o número de segundos limites entre as datas especificadas.

Os operandos são:

1 - o valor DateTime que é a data de início.

2 - o valor DateTime que é a data final.

Exemplo:DateDiffSecond([StartTime], Now())
DateDiffTick(datainicial,datafim)
Retorna o número de limites de ticks entre as datas especificadas.

Os operandos são:

1 - o valor DateTime que é a data de início.

2 - o valor DateTime que é a data final.

Exemplo:DateDiffTick([StartTime], Now())
DataDiffAno(datainicial,datafim)
Retorna o número de limites de ano entre as datas especificadas.

Os operandos são:

1 - o valor DateTime que é a data de início.

2 - o valor DateTime que é a data final.

Exemplo:DateDiffYear([StartTime], Now())
DateTimeFromParts(Ano, Mês, Dia, Hora, Minuto, Segundo, Milissegundo)
Retorna um valor de data construído a partir do Ano, Mês, Dia, Hora, Minuto, Segundo e Milissegundo especificados.

Os operandos são:

1 - (Obrigatório) - um valor inteiro que é o valor do ano completo (quatro dígitos, século incluído).

2 - (Obrigatório) - um valor inteiro que é o número do mês (1-12).

3 - (Obrigatório) - um valor inteiro que é o dia do mês (1-31).

4 - (Opcional) - um valor de hora no formato de 24 horas (0-23).

5 - (Opcional) - um valor de minuto (0-59).

6 - (Opcional) - um segundo valor (0-59).

7 - (Opcional) - um valor em milissegundos.

Exemplo:DateTimeFromParts(2018, 5, 5, 20)
ObterData(DataHora)
Retorna a parte da data da data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um objeto DateTime com a mesma parte de data. O horário é 00:00:00.

Exemplo:GetDate([OrderDateTime])
ObterDia(DataHora)
Obtém o dia do mês na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um número inteiro no intervalo entre 1 e 31.

Exemplo:GetDay([OrderDate])
GetDayOfWeek(DataHora)
Obtém o dia da semana na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um valor inteiro da enumeração DayOfWeek . Não depende da cultura atual.

Exemplo:GetDayOfWeek([OrderDate])
GetDayOfYear(DataHora)
Obtém o dia do ano na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um número inteiro no intervalo entre 1 e 366.

Exemplo:GetDayOfYear([OrderDate])
ObterHora(DataHora)
Retorna o valor das horas na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um número inteiro no intervalo entre 0 e 23.

Exemplo:GetHour([StartTime])
GetMilliSecond(DataHora)
Retorna o valor em milissegundos na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um número inteiro no intervalo entre 0 e 999.

Exemplo:GetMilliSecond([StartTime])
ObterMinuto(DataHora)
Retorna o valor dos minutos na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um número inteiro no intervalo entre 0 e 59.

Exemplo:GetMinute([StartTime])
ObterMês(DataHora)
Obtém o mês na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um número inteiro e depende do calendário atual.

Exemplo:GetMonth([StartTime])
GetSecond(DataHora)
Retorna o valor dos segundos na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um número inteiro no intervalo entre 0 e 59.

Exemplo:GetSecond([StartTime])
GetTimeOfDay(DataHora)
Obtém a parte da hora da data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é o objeto Int64 que é o número de ticks de 100 nanossegundos decorridos desde a meia-noite.

Exemplo:GetTimeOfDay([StartTime])
ObterAno(DataHora)
Obtém o ano na data especificada.

O operando deve ser do tipo DateTime .

O valor de retorno é um número inteiro no intervalo entre 1 e 9999.

Exemplo:GetYear([StartTime])
InDateRange(DataHora1, DataHora2, DataHora3)
Exemplo:InDateRange([OrderDate], #2022-01-01 00:00:00#, #2022-12-31 23:59:59#)
É abril (data e hora)
Retorna True se a data especificada estiver dentro de abril. Exemplo:IsApril([OrderDate])
ÉAgosto(DataHora)
Retorna True se a data especificada estiver dentro de agosto. Exemplo:IsAugust([OrderDate])
ÉDezembro(DataHora)
Retorna True se a data especificada estiver dentro de dezembro. Exemplo:IsDecember([OrderDate])
ÉFevereiro(DataHora)
Retorna True se a data especificada estiver dentro de fevereiro. Exemplo:IsFebruary([OrderDate])
ÉJaneiro(DataHora)
Retorna True se a data especificada estiver dentro de janeiro. Exemplo:IsJanuary([OrderDate])
É julho (data e hora)
Retorna True se a data especificada estiver dentro de julho. Exemplo:IsJuly([OrderDate])
É junho (data e hora)
Retorna True se a data especificada estiver dentro de junho. Exemplo:IsJune([OrderDate])
ÉÚltimoMês(DataHora)
Retorna True se a data especificada estiver no mês anterior. Exemplo:IsLastMonth([OrderDate])
ÉÚltimoAno(DataHora)
Retorna True se a data especificada estiver no ano anterior. Exemplo:IsLastYear([OrderDate])
ÉMarço(DataHora)
Retorna True se a data especificada estiver dentro de março. Exemplo:IsMarch([OrderDate])
ÉMaio(DataHora)
Retorna True se a data especificada estiver dentro de maio. Exemplo:IsMay([OrderDate])
ÉPróximoMês(DataHora)
Retorna True se a data especificada estiver no próximo mês. Exemplo:IsNextMonth([OrderDate])
ÉPróximo Ano(DataHora)
Retorna True se a data especificada estiver no próximo ano. Exemplo:IsNextYear([OrderDate])
ÉNovembro(DataHora)
Retorna True se a data especificada estiver dentro de novembro. Exemplo:IsNovember([OrderDate])
É outubro (data e hora)
Retorna True se a data especificada estiver dentro de outubro. Exemplo:IsOctober([OrderDate])
ÉMesmoDia(DataHora)
Retorna True se os valores de data/hora especificados estiverem no mesmo dia.

IsSameDay([OrderDate])

ÉSetembro(DataHora)
Retorna True se a data especificada estiver dentro de setembro. Exemplo:IsSeptember([OrderDate])
ÉEsteMês(DataHora)
Retorna Truese a data especificada estiver dentro do mês atual.

Para criar o operador IsThisMonth usando o método CriteriaOperator.Parse , use a seguinte sintaxe: CriteriaOperator.Parse(“IsThisMonth(StartDate)”) .

Exemplo:IsThisMonth([OrderDate])
ÉEstaSemana(DataHora)
Retorna Truese a data especificada estiver na semana atual. Exemplo:IsThisWeek([OrderDate])
ÉYearToDate(DateTime)
Retorna Truese a data especificada estiver dentro do período que começa no primeiro dia do ano atual e continua até a data atual (incluindo a data atual).

IsYearToDate([OrderDate])

ÉEsteAno(DataHora)
Retorna Truese a data especificada estiver no ano atual. Exemplo:IsThisYear([OrderDate])
LocalDateTimeDayAfterTomorrow()
Retorna o valor DateTime que possui a parte da data dois dias após a data atual e a parte da hora 00:00:00. Exemplo:AddDays(LocalDateTimeDayAfterTomorrow(), 5)
LocalDateTimeLastMonth()
Retorna o valor DateTime que possui a parte da data um mês antes da data atual e a parte da hora 00:00:00. Exemplo:AddMonths(LocalDateTimeLastMonth(), 5)
LocalDateTimeLastWeek()
Retorna o valor DateTime que possui a parte da data 7 dias antes do início da semana atual e a parte da hora 00:00:00. Exemplo:AddDays(LocalDateTimeLastWeek(), 5)
LocalDateTimeÚltimoAno()
Retorna o valor DateTime que possui a parte da data que é o primeiro dia do ano anterior e a parte da hora 00:00:00. Exemplo:AddYears(LocalDateTimeLastYear(), 5)
LocalDateTimeNextMonth()
Retorna o valor DateTime que possui a parte da data que é o primeiro dia do próximo mês e a parte da hora 00:00:00. Exemplo:AddMonths(LocalDateTimeNextMonth(), 5)
LocalDateTimeNextWeek()
Retorna o valor DateTime que possui a parte da data 7 dias após o início da semana atual e a parte da hora 00:00:00. Exemplo:AddDays(LocalDateTimeNextWeek(), 5)
LocalDateTimePróximoAno()
Retorna o valor DateTime com a parte da data que corresponde ao primeiro dia do próximo ano e a parte da hora 00:00:00. Exemplo:AddYears(LocalDateTimeNextYear(), 5)
LocalDateTimeAgora()
Retorna o valor DateTime que é o momento atual. Exemplo:AddDays(LocalDateTimeNow(), 5)
LocalDateTimeThisMonth()
Retorna o valor DateTime com a parte da data que é o primeiro dia do mês atual e a parte da hora 00:00:00. Exemplo:AddMonths(LocalDateTimeThisMonth(), 5)
LocalDateTimeThisWeek()
Retorna o valor DateTime com a parte da data que é o primeiro dia da semana atual e a parte da hora 00:00:00. Exemplo:AddDays(LocalDateTimeThisWeek(), 5)
LocalDateTimeThisYear()
Retorna o valor DateTime com a parte da data que é o primeiro dia do ano atual e a parte da hora 00:00:00. Exemplo:AddYears(LocalDateTimeThisYear(), 5)
LocalDateTimeHoje()
Retorna o valor DateTime com a parte da data que é o início do dia atual e a parte da hora 00:00:00. Exemplo:AddDays(LocalDateTimeToday(), 5)
LocalDateTimeAmanhã()
Retorna o valor DateTime com a parte da data que é o dia seguinte e a parte da hora 00:00:00. Exemplo:AddDays(LocalDateTimeTomorrow(), 5)
LocalDateTimeTwoMonthsAway()
Retorna o valor DateTime com a parte da data que é o primeiro dia do mês após o mês seguinte e a parte da hora 00:00:00. Exemplo:AddMonths(LocalDateTimeTwoMonthAway(), 5)
LocalDateTimeTwoWeeksAway()
Retorna o valor DateTime com a parte da data que é o primeiro dia da semana após a semana seguinte e a parte da hora 00:00:00. Exemplo:AddDays(LocalDateTimeTwoWeeksAway(), 5)
LocalDateTimeTwoYearsAway()
Retorna o valor DateTime com a parte da data que é o primeiro dia do ano após o ano seguinte e a parte da hora 00:00:00. Exemplo:AddYears(LocalDateTimeTwoYearsAway(), 5)
LocalDateTimeYearBeforeToday()
Retorna o valor DateTime com a parte da data que é a data de um ano atrás e a parte da hora de 00:00:00. Exemplo:AddYears(LocalDateTimeYearBeforeToday(), 5)
LocalDateTimeOntem()
Retorna o valor DateTime com a parte da data que é o dia anterior e a parte da hora 00:00:00. Exemplo:AddDays(LocalDateTimeYesterday(), 5)
Agora()
Retorna o valor DateTime que é a data e hora atuais. Exemplo:AddDays(Now(), 5)
Hoje()
Retorna um valor DateTime que é a data atual. A parte horária está definida como 00:00:00. Exemplo:AddMonths(Today(), 1)
UtcAgora()
Retorna um objeto DateTime que é a data e hora atuais no Tempo Universal Coordenado (UTC).

Exemplo:AddDays(UtcNow(), 7)

Lógico

Matemática

String

Reporting

Resumo

TOTVS