Quebra de uma seção de um relatório que utiliza a classe TReport.
A classe TRBreak é utilizada quando há a necessidade de impressão dos totalizadores da seção antes do final da seção ou do relatório, dependendo da regra de quebra informada.
Esta classe herda as propriedades e métodos da classe TRSECTION.
Métodos:
Execute
Sintaxe
TRBreak():Execute( <lForce> ) →
Descrição
Executa a regra e indica se houve a quebra. O método Execute é executado para cada linha impressa pelo método PrintLine da seção que a quebra pertence.
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
lForce | Objeto | Força a execução da quebra |
Retorno
Se verdadeiro, aponta que houve quebra
GetLastValue
Sintaxe
TRBreak():GetLastValue( ) →
Descrição
Retorno o último valor atualizado no controle da quebra
Retorno
Último valor atualizado
New
Sintaxe
TRBreak():New( <oParent> , <uBreak> , <uTitle> , <lTotalInLine> , <cName> , <lPageBreak> ) →
Descrição
Método construtor da classe TRBreak
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
oParent | Objeto | Objeto da classe TRSection que a quebra pertence | |
uBreak | Objeto / Caracter / Bloco de Código | Regra para quebra | |
uTitle | Título da quebra | ||
lTotalInLine | Lógico | Se verdadeiro, aponta que os totalizadores serão impressos em linha | |
cName | Caracter | Nome e identificador da quebra | |
lPageBreak | Lógico | Se verdadeiro, aponta salto de página após a quebra |
Retorno
Objeto da classe TRBreak
OnBreak
Sintaxe
TRBreak():OnBreak( <bOnBreak> ) →
Descrição
Define o bloco de código que será executado antes da impressão da quebra
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
bOnBreak | Bloco de Código | Bloco de Código com tratamentos a serem realizados antes na quebra |
OnPrintTotal
Sintaxe
TRBreak():OnPrintTotal( <bOnPrintTotal> ) →
Descrição
Define o bloco de código que será executado após a impressão da quebra
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
bOnPrintTotal | Bloco de Código | Bloco de Código com tratamentos a serem realizados após a quebra |
Sintaxe
TRBreak():Print( ) →
Descrição
Executa a impressão da quebra
PrintTotal
Sintaxe
TRBreak():PrintTotal( ) →
Descrição
Imprime a quebra e executa os tratamentos definidos no método OnPrintTotal
ResetBreak
Sintaxe
TRBreak():ResetBreak( ) →
Descrição
Inicializa o valor utilizado para controlar a quebra
SetBreak
Sintaxe
TRBreak():SetBreak( <uBreak> ) →
Descrição
Define a regra para a quebra
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
uBreak | Objeto / Caracter / Bloco de Código | Regra para quebra |
SetTitle
Sintaxe
TRBreak():SetTitle( <uTitle> ) →
Descrição
Define o título que será impresso antes da impressão dos totalizadores
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
uTitle | Caracter / Bloco de Código | Texto a ser impresso no formato caracter ou bloco de código |
Title
Sintaxe
TRBreak():Title( ) →
Descrição
Retorna o título que será impresso antes da impressão dos totalizadores
Retorno
Título da quebra