Totalizador de uma quebra, seção ou relatório que utiliza a classe TReport.
Um totalizador pode executar uma das seguintes funções abaixo, utilizando como referência uma célula da seção ou o retorno de uma fórmula definida para ele:
SUM - Somar
COUNT - Contar
MAX - Valor máximo
MIN - Valor mínimo
AVERAGE - Valor médio
ONPRINT - Valor atual
TIMESUM - Somar horas
TIMEAVERAGE - Valor médio de horas
TIMESUB - Subtrai horas
Na criação do totalizador sempre é informado uma seção (TRSection) a qual ele pertence, e automaticamente o totalizador será incluído no relatório (TReport) que a seção pertence.
Esta classe herda as propriedades e métodos da classe TRCELL
Métodos:
| Painel |
|---|
ClrBackSintaxe
TRFunction():ClrBack( <lObject> ) →
Descrição
Retorna a cor de fundo do relatório
Parâmetros | Nome | Tipo | Descrição | Obrigatório |
|---|
| lObject | Lógico | Aponta que deve ser retornado o objeto TBrush |
|
Retorno
Caso o parâmetro lObjeto seja verdadeiro o retorno será o objeto TBrush, caso contrário será o número da cor RGB
|
| Painel |
|---|
ClrFore
Sintaxe
TRFunction():ClrFore( <lPrintHeader> ) →
Descrição
Retorna a cor de fonte do relatório
Parâmetros | Nome | Tipo | Descrição | Obrigatório |
|---|
| lPrintHeader | Lógico | Aponta impressão do cabeçalho da célula |
|
Retorno
Número da cor RGB
|
| Painel |
|---|
Enabled
Sintaxe
TRFunction():Enabled( ) →
Descrição
Retorna se o totalizador está habilitado
Retorno
Se verdadeiro, aponta que o totalizador está habilitado |
| Painel |
|---|
EndPageSintaxe
TRFunction():EndPage( ) →
Descrição
Retorna se o totalizador será impresso no final de cada página
Retorno
Se verdadeiro, o totalizador será impresso |
| Painel |
|---|
EndReport
Sintaxe
TRFunction():EndReport( ) →
Descrição
Retorna se o totalizador será impresso no final do relatório
Retorno
Se verdadeiro, o totalizador será impresso |
| Painel |
|---|
EndSectionSintaxe
TRFunction():EndSection( ) →
Descrição
Retorna se o totalizador será impresso na quebra de seção
Retorno
Se verdadeiro, o totalizador será impresso |
| Painel |
|---|
EvalFunction
Sintaxe
TRFunction():EvalFunction( ) →
Descrição
Utilizado pelo método Execute(), ele executa a função do totalizador, utilizando a fórmula definida pelo método New ou pelo método SetFormula |
| Painel |
|---|
ExecuteSintaxe
TRFunction():Execute( ) →
Descrição
Executa a função do totalizador, utilizando a fórmula definida pelo método New ou pelo método SetFormula. O método Execute é executado para cada linha impressa pelo método PrintLine da seção que o totalizador pertence |
| Painel |
|---|
Sintaxe
TRFunction():Formula( ) →
Descrição
Retorna a fórmula do totalizador
Retorno
Tipo Caracter: Expressão ADVPL para macro execução
Tipo Bloco de Código: Bloco de Código com a expressão ADVPL para execução |
| Painel |
|---|
FullIDSintaxe
TRFunction():FullID( ) →
Descrição
Retorna o identificador do totalizador mais o identificador da célula
Retorno
Identificador do totalizador mais o identificador da célula |
| Painel |
|---|
GetFunctionSintaxe
TRFunction():GetFunction( <uFunction> ) →
Descrição
Retorna a função utilizada pelo totalizador. Exemplo: SUM, COUNT, MAX, MIN, AVERAGE
Parâmetros | Nome | Tipo | Descrição | Obrigatório |
|---|
uFunction
|
| Identificador do totalizador |
|
Retorno
Caso informado o identificador do totalizador o retorno será o objeto, caso contrário será a função
|
| Painel |
|---|
GetValue
Sintaxe
TRFunction():GetValue( ) →
Descrição
Retorna o valor do totalizador
Retorno
Valor do totalizador |
| Painel |
|---|
GetLastValueSintaxe
TRFunction():GetLastValue( ) →
Descrição
Retorno o último valor atualizado no totalizador
Retorno
Último valor atualizado no totalizador |
| Painel |
|---|
GetWidth
Sintaxe
TRFunction():GetWidth( <lAutoWidth> ) →
Descrição
Retorna a largura da célula
Parâmetros | Nome | Tipo | Descrição | Obrigatório |
|---|
| lAutoWidth | Lógico | Aponta que a largura será calculada automaticamente |
|
Retorno
Largura da célula do totalizador
|
| Painel |
|---|
GetPrintCollection
Sintaxe
TRFunction():GetPrintCollection( ) →
Descrição
Retorna se é impressão de totalizador do tipo Collection
Retorno
Se verdadeiro, aponta impressão de totalizador do tipo Collection |
| Painel |
|---|
NewSintaxe
TRFunction():New( <oCell> , <cName> , <cFunction> , <oBreak> , <cTitle> , <cPicture> , <uFormula> , <lEndSection> , <lEndReport> , <lEndPage> , <oParent> , <bCondition> , <lDisable> , <bCanPrint> ) →
Descrição
Método construtor da classe TRFunction
Parâmetros | Nome | Tipo | Descrição | Obrigatório |
|---|
| oCell | Objeto |
|
| | cName | Caracter |
|
| | cFunction | Caracter |
|
| | oBreak | Objeto |
|
| | cTitle | Caracter |
|
| | cPicture | Caracter |
|
| | uFormula |
|
|
| | lEndSection | Lógico |
|
| | lEndReport | Lógico |
|
| | lEndPage | Lógico |
|
| | oParent | Objeto |
|
| | bCondition | Bloco de Código |
|
| | lDisable | Lógico |
|
| | bCanPrint | Bloco de Código |
|
|
|
