...
Obs.: Uma seção (TRSection) pode ser considerada um tópico dentro do relatório, podendo ter um ou mais tópicos que se relacionam no relatório.
Métodos:
Painel |
---|
AddBreak
Sintaxe TReport():AddBreak( <oBreak> ) → NIL
Descrição Adiciona a quebra de impressão na propriedade aBreak
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
oBreak | Objeto | Objeto TRBreak | X |
|
Painel |
---|
AddCollectionSintaxe TReport():AddCollection( <oCollection> ) → NIL
Descrição Adiciona o totalizador na propriedade aCollection
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
oCollection | Objeto | Objeto TRCollection | X |
|
Painel |
---|
AddFunction
Sintaxe TReport():AddFunction( <oFunction> , <oParent> ) → NIL
Descrição Adiciona o totalizador na propriedade aFunction
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
oFunction | Objeto | Objeto TRFunction | X | oParent | Objeto | Objeto que aponta a seção que pertence o totalizador |
|
|
Painel |
---|
Sintaxe TReport():AddHeaderPage( <oSection> ) → NIL
Descrição Adiciona a seção que imprime cabeçalho no topo da página
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
oSection | Objeto | Objeto TRSection | X |
|
Painel |
---|
AddSection
Sintaxe TReport():AddSection( <oSection> ) → NIL
Descrição Adiciona a seção na propriedade aSection
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
oSection | Objeto | Objeto TRSection | X |
|
Painel |
---|
BorderSintaxe TReport():Border( <uBorder> , <lHeader> ) → oRet
Descrição Retorna a borda do relatório
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
uBorder | Caracter / Numérico | Tipo Caracter: "TOP","BOTTOM","LEFT","RIGHT",”ALL” Tipo Numérico: 1-Superior, 2-Inferior, 3-Esquerda, 4-Direita, 5-Todas | X | lHeader | Lógico | Borda do cabeçalho |
|
Retorno oRet - Objeto do tipo TRBorder
|
Painel |
---|
Box
Sintaxe TReport():Box( <nRow> , <nCol> , <nBottom> , <nRight> , <uParam5> ) → NIL
Descrição Desenha uma caixa baseado nas coordenadas informados nos parâmetros
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
nRow | Numérico | Linha no qual inicia o desenho da caixa | X | nCol | Numérico | Coluna no qual inicia o desenho da caixa | X | nBottom | Numérico | Linha no qual finaliza o desenho da caixa | X | nRight | Numérico | Coluna no qual finaliza o desenho da caixa | X | uParam5 | Objeto | Compatibilidade |
|
|
Painel |
---|
CancelSintaxe TReport():Cancel( ) → NIL
Descrição Retorna Verdadeiro se usuário cancelou impressão |
Painel |
---|
CancelPrintSintaxe TReport():CancelPrint( ) → NIL
Descrição Cancela a impressão do relatório |
Painel |
---|
Char2PixSintaxe TReport():Char2Pix( <nSize< , <cFont>, <nFontSize>, < lBold ) → nRet
Descrição Retorna o tamanho de acordo com a fonte informada
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
nSize | Numérico | Tipo Caracter: Texto a ser considerado no cálculo Tipo Numérico: Valor a ser considerado no cálculo | X | cFont | Caracter | Fonte do relatório |
| nFontSize | Numérico | Tamanho da fonte |
| lBold | Lógico | Se usará negrito |
|
Retorno nRet - Tamanho calculado em pixel
|
Painel |
---|
ChkIncRow
Sintaxe TReport():ChkIncRow( <nInc> , <lLine> ) → lRet
Descrição Verifica a necessidade de inicializar uma nova página antes da inclusão da linha
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
nInc | Numérico | Quantidade de linhas a serem impressas | X | lLine | Lógico | Considera o tamanho da linha no cálculo | X |
Retorno lRet
|
Painel |
---|
ClassNameSintaxe TReport():ClassName() → NIL
Descrição Retorna o nome da classe. Exemplo: TREPORT |
Painel |
---|
ClrBackSintaxe TReport():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 TReport():ClrFore( ) →
Descrição Retorna a cor de fonte do relatório
Retorno Número da cor RGB
|
Painel |
---|
Col
Sintaxe TReport():Col( ) → Descrição Retorna a coluna posicionada na impressão
Retorno nRet |
Painel |
---|
ColSpaceSintaxe TReport():ColSpace( ) → Descrição Retorna o espaçamento entre as colunas
Retorno nRet |
Painel |
---|
Description
Sintaxe TReport():Description( ) →
Descrição Retorna a descrição do relatório |
Painel |
---|
DisableSintaxe TReport():Disable( ) →
Descrição Desabilita a impressão do relatório |
Painel |
---|
DisableOrientation
Sintaxe TReport():DisableOrientation( ) →
Descrição Desabilita a seleção da orientação (Retrato/Paisagem) |
Painel |
---|
EnableSintaxe TReport():Enable( ) →
Descrição Habilita a impressão do relatório |
Painel |
---|
Enabled
Sintaxe TReport():Enabled( ) → lRet
Descrição Retorna se a impressão do relatório esta habilitada
Retorno lRet |
Painel |
---|
EndPageSintaxe TReport():EndPage( <lFooter> ) → lRet
Descrição Finaliza a página na impressão
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
lFooter | Lógico | Imprime rodapé na finalização da página |
|
Retorno lRet
|
Painel |
---|
EvalBreak
Sintaxe TReport():EvalBreak( <lForce> , <lPrintHeader> , <oSection> ) → lRet
Descrição Executa a quebra na impressão do relatório
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
lForce
| Lógico | Força a execução do método OnBreak da classe TRBreak |
| lPrintHeader | Lógico | Imprime cabeçalho da seção |
| oSection | Objeto | Seção considerada na quebra |
|
Retorno lRet - Se verdadeiro, quebrou a impressão
|
Painel |
---|
EndReportSintaxe TReport():EndReport( ) → lRet
Descrição Retorna se imprime o total geral do relatório
Retorno lRet |
Painel |
---|
FatLine
Sintaxe TReport():FatLine( ) →
Descrição Desenha uma linha com altura grossa, iniciando posição da linha atual de impressão com a largura da página |
Painel |
---|
FillRectSintaxe TReport():FillRect( <aRect> , <oBrush> ) →
Descrição Preenche um retângulo na impressão utilizando as especificações do objeto TBrush
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
aRect | Array | Vetor com coordenadas no formato: linha inicial, coluna inicial, linha final, coluna final | X | oBrush | Objeto | Objeto da classe TBrush |
|
|
Painel |
---|
FinishSintaxe TReport():Finish( ) →
Descrição Finaliza a impressão do relatório, imprime os totalizadores, fecha as querys e índices temporários, entre outros tratamentos do componente. Não é necessário executar o método Finish se for utilizar o método Print, já que este faz o controle de inicialização e finalização da impressão. |
Painel |
---|
FreeAllObjs
Sintaxe TReport():FreeAllObjs( ) →
Descrição Elimina os objetos da memória no servidor |
Painel |
---|
FunctionBefore
Sintaxe TReport():FunctionBefore( <lFunctionBefore> ) →
Descrição Define se a impressão dos totalizadores do tipo TRFunction será realizada antes dos totalizadores do tipo TRCollection
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
lFunctionBefore | Lógico | Define se será antes ou depois a execução dos totalizadores do tipo TRFunction |
|
|
Painel |
---|
GetActionSintaxe TReport():GetAction( ) →
Descrição Retorna o bloco de código definido para a propriedade bAction |