Classe de impressão que substitui as funções SetPrint, SetDefault, RptStatus e Cabec.
A classe TReport permite que o usuário personalize as informações que serão apresentadas no relatório, alterando fonte (tipo, tamanho, etc.), cor, tipo de linhas, cabeçalho, rodapé, etc.
Estrutura do componente TReport:
- O relatório (TReport) contém uma ou mais seções (TRSection);
- Uma seção (TRSection) pode conter uma ou mais seções;
- A seção (TRSection) contém células pré-definidas e células selecionadas pelo usuário;
- A seção (TRSection) também contém as quebras (TRBreak) para impressão de totalizadores (TRFunction);
- Os totalizadores são incluídos pela seção que automaticamente inclui no relatório (TReport).
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:
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 |
|
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 |
|
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 |
|
|
AddHeaderPageSintaxe
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 |
|
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 |
|
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
|
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 |
|
|
CancelSintaxe
TReport():Cancel( ) → NIL
Descrição
Retorna Verdadeiro se usuário cancelou impressão |
CancelPrintSintaxe
TReport():CancelPrint( ) → NIL
Descrição
Cancela a impressão do relatório |
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
|
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
|
ClassNameSintaxe
TReport():ClassName() → NIL
Descrição
Retorna o nome da classe. Exemplo: TREPORT |
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
|
ClrFore
Sintaxe
TReport():ClrFore( ) →
Descrição
Retorna a cor de fonte do relatório
Retorno
Número da cor RGB
|
Col
Sintaxe TReport():Col( ) →
Descrição
Retorna a coluna posicionada na impressão
RetornonRet |
ColSpaceSintaxe TReport():ColSpace( ) →
Descrição
Retorna o espaçamento entre as colunas
RetornonRet |
Description
Sintaxe
TReport():Description( ) →
Descrição
Retorna a descrição do relatório |
DisableSintaxe
TReport():Disable( ) →
Descrição Desabilita a impressão do relatório |
DisableOrientation
Sintaxe
TReport():DisableOrientation( ) →
Descrição
Desabilita a seleção da orientação (Retrato/Paisagem) |
EnableSintaxe
TReport():Enable( ) →
Descrição
Habilita a impressão do relatório |