Frameworksp

Páginas filhas
  • TRFunction

Versões comparadas

Versão antiga 2

changes.mady.by.user Danilo Basilio Medeiros

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Vanessa Ruama de Sousa Barros

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Esta classe herda as propriedades e métodos da classe TRCELL

Informações
titleAlinhamento

A TRFunction não possui opção de alinhamento. Seu alinhamento (campos númericos) é à 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:

Painel

ClrBack

Sintaxe
TRFunction():ClrBack( <lObject> ) →

Descrição
Retorna a cor de fundo do relatório

Parâmetros

NomeTipoDescriçãoObrigatório
lObjectLógicoAponta 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

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

NomeTipoDescriçãoObrigatório
oCellObjetoObjeto da classe TRCell que o totalizador se refere
cNameCaracterIdentificação do totalizador
cFunctionCaracterFunção que será utilizada pelo totalizador. Exemplo: SUM, COUNT, MAX, MIN
oBreakObjetoObjeto da classe TRBreak que define em qual quebra o totalizador será impresso
cTitleCaracterTítulo do totalizador. Se não informado será utilizado o título da célula que o totalizador se refere
cPictureCaracterMáscara de impressão do totalizador. Se não informado será utilizado a máscara da célula que o totalizador se refere
uFormulaCaracter / 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


lEndSectionLógicoSe verdadeiro, indica se o totalizador será impresso na quebra de seção
lEndReportLógicoSe verdadeiro, indica se o totalizador será impresso no final do relatório
lEndPageLógicoSe verdadeiro, indica se o totalizador será impresso no final de cada página
oParentObjetoObjeto da classe TRSection que o totalizador se refere
bConditionBloco de CódigoBloco de Código com a condição de atualização dos valores do totalizador
lDisableLógicoSe verdadeiro, define que não irá atualizar os valores do totalizador
bCanPrintBloco de CódigoBloco de Código com a condição de impressão dos valores do totalizador

Retorno
Objeto da classe TRFunction

Painel

PageValue

Sintaxe
TRFunction():PageValue( ) →

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

Retorno
Valor atual da página

Painel

Print

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

Descrição
Imprime o total atual

Parâmetros

NomeTipoDescriçãoObrigatório
uValue
Se informado, define o valor a ser impresso e altera o valor do total, caso contrário imprime o valor atual
Painel

PrintPage

Sintaxe
TRFunction():PrintPage( ) →

Descrição
Imprime o totalizador da página

Painel

PrintReport

Sintaxe
TRFunction():PrintReport( ) →

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

Painel

PrintSection

Sintaxe
TRFunction():PrintSection( ) →

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

Painel

ReportValue

Sintaxe
TRFunction():ReportValue( ) →

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

Retorno
Valor geral do relatório

Painel

Reset

Sintaxe
TRFunction():Reset( ) →

Descrição
Reinicia valor do totalizador

Painel

ResetPage

Sintaxe
TRFunction():ResetPage( ) →

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

Painel

ResetReport

Sintaxe
TRFunction():ResetReport( ) →

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

Painel

ResetSection

Sintaxe
TRFunction():ResetSection( ) →

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

Painel

SectionValue

Sintaxe
TRFunction():SectionValue( ) →

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

Retorno
Valor atual da seção

Painel

SetBreak

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
oBreakObjetoObjeto TRBreak
Painel

SetCollection

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lCollectionLógicoSe verdadeiro, aponta que o totalizador é do tipo collection
Painel

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

NomeTipoDescriçãoObrigatório
bConditionLógicoBloco de código com a condição de atualização dos valores do totalizador
Painel

SetEndPage

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lEndPageLógicoSe verdadeiro, aponta que imprime o totalizador



Painel

SetEndReport

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lEndReportLógicoSe verdadeiro, aponta que imprime o totalizador
Painel

SetEndSection

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lEndSectionLógicoSe verdadeiro, aponta que imprime o totalizador
Painel

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

NomeTipoDescriçãoObrigató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


Painel

SetFunction

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
cFunctionCaracter

Função do totalizador




Painel

SetPrintCollection

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lPrintCollectionLógico

Se verdadeiro, aponta que é impressão de collections