TRFunction

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

Alinhamento

A TRFunction não possui opção de alinhamento. Seu alinhamento é à direita, default também de campos numéricos nos relatórios TReport.

Para manter os valores das células e dos totalizadores alinhados ambos devem estar com alinhamento à direita.

Mais informações: TRFunction - Alinhamento

Métodos:

ClrBack

Sintaxe
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

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

Enabled

Sintaxe
TRFunction():Enabled( ) →

Descrição
Retorna se o totalizador está habilitado

Retorno
Se verdadeiro, aponta que o totalizador está habilitado

EndPage

Sintaxe
TRFunction():EndPage( ) →

Descrição
Retorna se o totalizador será impresso no final de cada página

Retorno
Se verdadeiro, o totalizador será impresso

EndReport

Sintaxe
TRFunction():EndReport( ) →

Descrição
Retorna se o totalizador será impresso no final do relatório

Retorno
Se verdadeiro, o totalizador será impresso

EndSection

Sintaxe
TRFunction():EndSection( ) →

Descrição
Retorna se o totalizador será impresso na quebra de seção

Retorno
Se verdadeiro, o totalizador será impresso

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

Execute

Sintaxe
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

Formula

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

FullID

Sintaxe
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

GetFunction

Sintaxe
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

GetValue

Sintaxe
TRFunction():GetValue( ) →

Descrição
Retorna o valor do totalizador

Retorno
Valor do totalizador

GetLastValue

Sintaxe
TRFunction():GetLastValue( ) →

Descrição
Retorno o último valor atualizado no totalizador

Retorno
Último valor atualizado no totalizador

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

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

New

Sintaxe
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
oCell	Objeto	Objeto da classe TRCell que o totalizador se refere
cName	Caracter	Identificação do totalizador
cFunction	Caracter	Função que será utilizada pelo totalizador. Exemplo: SUM, COUNT, MAX, MIN
oBreak	Objeto	Objeto da classe TRBreak que define em qual quebra o totalizador será impresso
cTitle	Caracter	Título do totalizador. Se não informado será utilizado o título da célula que o totalizador se refere
cPicture	Caracter	Máscara de impressão do totalizador. Se não informado será utilizado a máscara da célula que o totalizador se refere
uFormula	Caracter / Bloco de Código	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
lEndSection	Lógico	Se verdadeiro, indica se o totalizador será impresso na quebra de seção
lEndReport	Lógico	Se verdadeiro, indica se o totalizador será impresso no final do relatório
lEndPage	Lógico	Se verdadeiro, indica se o totalizador será impresso no final de cada página
oParent	Objeto	Objeto da classe TRSection que o totalizador se refere
bCondition	Bloco de Código	Bloco de Código com a condição de atualização dos valores do totalizador
lDisable	Lógico	Se verdadeiro, define que não irá atualizar os valores do totalizador
bCanPrint	Bloco de Código	Bloco de Código com a condição de impressão dos valores do totalizador

Retorno
Objeto da classe TRFunction

PageValue

Sintaxe
TRFunction():PageValue( ) →

Descrição
Retorna o valor atual do totalizador para a página

Retorno
Valor atual da página

Print

Sintaxe
TRFunction():Print( <uValue> ) →

Descrição
Imprime o total atual

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uValue		Se informado, define o valor a ser impresso e altera o valor do total, caso contrário imprime o valor atual

PrintPage

Sintaxe
TRFunction():PrintPage( ) →

Descrição
Imprime o totalizador da página

PrintReport

Sintaxe
TRFunction():PrintReport( ) →

Descrição
Imprime o totalizador geral do relatório

PrintSection

Sintaxe
TRFunction():PrintSection( ) →

Descrição
Imprime o totalizador da seção

ReportValue

Sintaxe
TRFunction():ReportValue( ) →

Descrição
Retorna o valor geral do totalizador para o relatório

Retorno
Valor geral do relatório

Reset

Sintaxe
TRFunction():Reset( ) →

Descrição
Reinicia valor do totalizador

ResetPage

Sintaxe
TRFunction():ResetPage( ) →

Descrição
Reinicia valor do totalizador da página

ResetReport

Sintaxe
TRFunction():ResetReport( ) →

Descrição
Reinicia valor do totalizador geral do relatório

ResetSection

Sintaxe
TRFunction():ResetSection( ) →

Descrição
Reinicia valor do totalizador da seção

SectionValue

Sintaxe
TRFunction():SectionValue( ) →

Descrição
Retorna o valor atual do totalizador para a seção

Retorno
Valor atual da seção

SetBreak

Sintaxe
TRFunction():SetBreak( <oBreak> ) →

Descrição
Define a quebra (TRBreak) que o totalizador será impresso

Parâmetros

Nome	Tipo	Descrição	Obrigatório
oBreak	Objeto	Objeto TRBreak

SetCollection

Sintaxe
TRFunction():SetCollection( <lCollection> ) →

Descrição
Define que o totalizador é do tipo collection

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lCollection	Lógico	Se verdadeiro, aponta que o totalizador é do tipo collection

SetCondition

Sintaxe
TRFunction():SetCondition( <bCondition> ) →

Descrição
Define o bloco de código com a condição de atualização dos valores do totalizador

Parâmetros

Nome	Tipo	Descrição	Obrigatório
bCondition	Lógico	Bloco de código com a condição de atualização dos valores do totalizador

SetEndPage

Sintaxe
TRFunction():SetEndPage( <lEndPage> ) →

Descrição
Define se o totalizador será impresso na quebra de cada página

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lEndPage	Lógico	Se verdadeiro, aponta que imprime o totalizador

SetEndReport

Sintaxe
TRFunction():SetEndReport( <lEndReport> ) →

Descrição
Define se o totalizador será impresso no final do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lEndReport	Lógico	Se verdadeiro, aponta que imprime o totalizador

SetEndSection

Sintaxe
TRFunction():SetEndSection( <lEndSection> ) →

Descrição
Define se o totalizador será impresso na quebra de seção

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lEndSection	Lógico	Se verdadeiro, aponta que imprime o totalizador

SetFormula

Sintaxe
TRFunction():SetFormula( <uFormula> ) →

Descrição
Define a fórmula utilizada pelo totalizador no lugar de utilizar o conteúdo da célula que ele se refere

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uFormula		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

SetFunction

Sintaxe
TRFunction():SetFunction( <cFunction> ) →

Descrição
Define a função que será utilizada pelo totalizador. Exemplo: SUM, COUNT, MAX, MIN

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cFunction	Caracter	Função do totalizador

SetPrintCollection

Sintaxe
TRFunction():SetPrintCollection( <lPrintCollection> ) →

Descrição
Define que é impressão de collections

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lPrintCollection	Lógico	Se verdadeiro, aponta que é impressão de collections

Páginas filhas