TReport

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.

Importante

A partir da Lib 20230220, a opção de impressão de planilha em formato xlsx passa gerar os dados de processamento no Banco de Dados ao invés de utilizar a memória do sistema, esta alteração visa solucionar problemas com alto consumo de memória.

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

AddCollection

Sintaxe
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

AddHeaderPage

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

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

Border

Sintaxe
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

Cancel

Sintaxe
TReport():Cancel( ) → NIL

Descrição
Retorna Verdadeiro se usuário cancelou impressão

CancelPrint

Sintaxe
TReport():CancelPrint( ) → NIL

Descrição
Cancela a impressão do relatório

Char2Pix

Sintaxe
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

ClassName

Sintaxe
TReport():ClassName() → NIL

Descrição
Retorna o nome da classe. Exemplo: TREPORT

ClrBack

Sintaxe
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

Retorno
nRet

ColSpace

Sintaxe
TReport():ColSpace( ) →

Descrição
Retorna o espaçamento entre as colunas

Retorno
nRet

Description

Sintaxe
TReport():Description( ) →

Descrição
Retorna a descrição do relatório

Disable

Sintaxe
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)

Enable

Sintaxe
TReport():Enable( ) →

Descrição
Habilita a impressão do relatório

Enabled

Sintaxe
TReport():Enabled( ) → lRet

Descrição
Retorna se a impressão do relatório esta habilitada

Retorno
lRet

EndPage

Sintaxe
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

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
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

EndReport

Sintaxe
TReport():EndReport( ) → lRet

Descrição
Retorna se imprime o total geral do relatório

Retorno
lRet

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

FillRect

Sintaxe
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

Finish

Sintaxe
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.

FreeAllObjs

Sintaxe
TReport():FreeAllObjs( ) →

Descrição
Elimina os objetos da memória no servidor

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

GetAction

Sintaxe
TReport():GetAction( ) →

Descrição
Retorna o bloco de código definido para a propriedade bAction

GetBreak

Sintaxe
TReport():GetBreak( <uBreak> ) →

Descrição
Retorna a quebra do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uBreak	Caracter / Numérico	Tipo Caracter: Nome da quebra Tipo Númerico: Número da quebra no array aBreak	X

Retorno
Objeto TRBreak

GetDynamic

Sintaxe
TReport():GetDynamic( ) → lRet

Descrição
Retorna se o relatório é do tipo dinâmico

Retorno
lRet

GetEdit

Sintaxe
TReport():GetEdit( ) → lRet

Descrição
Retorna se é permitida a configuração do relatório pelo usuário

Retorno
lRet

GetFontSize

Sintaxe
TReport():GetFontSize( <cFont> , <nFontSize> , <lBold> , <lItalic> , <lUnderline> ) → aArray

Descrição
Retorna o tamanho da fonte

Parâmetros

Nome	Tipo	Descrição
cFont	Caracter	Fonte a ser considerada no cálculo
nFontSize	Numérico	Tamanho da fonte
lBold	Lógico	Aponta se a fonte é negrita
lItalic	Lógico	Aponta se a fonte é itálica
lUnderline	Lógico	Aponta se a fonte é sublinhada

Retorno
aArray - Array com informações do tamanho da fonte. Elementos: 1-Fonte, 2-Tamanho, 3-Tamanho em pixel

GetFunction

Sintaxe
TReport():GetFunction( <uFunction> ) → oRet

Descrição
Retorna objeto da classe TRFunction (totalizadores)

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uFunction	Caracter / Numérico	Tipo Caracter: Nome da Function Tipo Numérico: Índice do objeto segundo a ordem de criação dos componentes TRFunction	X

Retorno
oRet - Objeto da classe TRFunction (totalizadores)

GetOrder

Sintaxe
TReport():GetOrder( ) → lRet

Descrição
Retorna a ordem de impressão selecionada

Retorno
nRet - Ordem selecionada

GetOrientation

Sintaxe
TReport():GetOrientation( ) →

Descrição
Retorna a orientação de página (Retrato ou Paisagem) selecionada pelo usuário

Retorno
1=Retrato ou 2=Paisagem

GetParam

Sintaxe
TReport():GetParam( ) →

Descrição
Retorna a pergunta ou bloco de código utilizado como parâmetros do relatório

GetRightAlignPrinter

Sintaxe
TReport():GetRightAlignPrinter( ) → lAlignPrinter

Descrição
Retorna se o alinhamento do relatório para células à direita está utilizando o componente do binário.

Retorno

lAlignPrinter

Método disponível a partir da LIB Label 20211004

GetWidth

Sintaxe
TReport():GetWidth( ) →

Descrição
Retorna a largura da página

HideFooter

Sintaxe
TReport():HideFooter( ) →

Descrição
Define que não será impresso o rodapé padrão da página

HideHeader

Sintaxe
TReport():HideHeader( ) →

Descrição
Define que não será impresso o cabeçalho padrão da página

HideParamPage

Sintaxe
TReport():HideParamPage( ) →

Descrição
Define se será permitida a alteração dos parâmetros do relatório

IncMeter

Sintaxe
TReport():IncMeter( <nInc> ) →

Descrição
Incrementa a régua de progressão do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nInc	Numérico	Quantidade a incrementar na régua. Padrão: 1

IncRow

Sintaxe
TReport():IncRow( <nInc> ) → nRet

Descrição
Incrementa linhas na impressão

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nInc	Numérico	Quantidade de linhas que deverão ser incrementadas

Retorno
nRet - Linha atualizada

Init

Sintaxe
TReport():Init( ) →

Descrição
Inicializa as configurações e define a primeira página do relatório. Não é necessário executar o método Init se for utilizar o método Print, já que estes fazem o controle de inicialização e finalização da impressão.

LeftMargin

Sintaxe
TReport():LeftMargin( <lPixel> , <lForce> ) → nRet

Descrição
Retorna o tamanho da margem à esquerda do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lPixel	Lógico	Quantidade de linhas que deverão ser incrementadas
lForce	Lógico	Força o recálculo da margem à esquerda

Retorno
nRet - Tamanho da margem à esquerda

Line

Sintaxe
TReport():Line( <nTop> , <nLeft> , <nBottom> , <nRight> , <uParam5> ) →

Descrição
Desenha uma linha, utilizando as especificações da classe TPen

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nTop	Numérico	Linha na qual inicia o desenho da linha	X
nLeft	Numérico	Coluna na qual inicia o desenho da linha	X
nBottom	Numérico	Linha na qual finaliza o desenho da linha	X
nRight	Numérico	Coluna na qual finaliza o desenho da linha	X
uParam5	Objeto	Objeto Compatibilidade

LineHeight

Sintaxe
TReport():LineHeight( ) → nRet

Descrição
Retorna a altura da linha

Retorno
nRet - Altura da linha

LoadDefault

Sintaxe
TReport():LoadDefault( ) →

Descrição
Carrega o relatório padrão para personalização

New

Sintaxe
TReport():New( <cReport> , <cTitle> , <uParam> , <bAction> , <cDescription> , <lLandscape> , <uTotalText> , <lTotalInLine> , <cPageTText> , <lPageTInLine> , <lTPageBreak> , <nColSpace> ) → oRet

Descrição
Método construtor da classe TReport

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cReport	Caracter	Nome do relatório. Exemplo: MATR010	X
cTitle	Caracter	Título do relatório
uParam	Caracter / Bloco de Código	Parâmetros do relatório cadastrado no Dicionário de Perguntas (SX1). Também pode ser utilizado bloco de código para parâmetros customizados
bAction	Bloco de Código	Bloco de código que será executado quando o usuário confirmar a impressão do relatório
cDescription	Caracter	Descrição do relatório
lLandscape	Lógico	Aponta a orientação de página do relatório como paisagem
uTotalText	Caracter / Bloco de Código	Texto do totalizador do relatório, podendo ser caracter ou bloco de código
lTotalInLine	Lógico	Imprime as células em linha
cPageTText	Caracter	Texto do totalizador da página
lPageTInLine	Lógico	Imprime totalizador da página em linha
lTPageBreak	Lógico	Quebra página após a impressão do totalizador
nColSpace	Numérico	Espaçamento entre as colunas

Retorno
oRet - Objeto da classe TReport

NoUserFilter

Sintaxe
TReport():NoUserFilter( ) →

Descrição
Desabilita a utilização de filtros na personalização do relatório

NoCell

Sintaxe
TReport():NoCell( ) → lRet

Descrição
Verifica a existência de seção sem células

Retorno
lRet

NoPrint

Sintaxe
TReport():NoPrint( ) → lRet

Descrição
Retorna se não foram impressos registros

Retorno
lRet

OnPageBreak

Sintaxe
TReport():OnPageBreak( <bOnPageBreak> , <lOnPageBreak> ) →

Descrição
Atualiza a propriedade bOnPageBreak utilizada para tratamentos na inicialização de cada página

Parâmetros

Nome	Tipo	Descrição	Obrigatório
bOnPageBreak	Bloco de Código	Bloco de código para tratamentos na inicialização de cada página
lOnPageBreak	Lógico	Cabeçalho das seções impressas após a quebra de página

Page

Sintaxe
TReport():Page( ) →

Descrição
Retorna o número da página atual na impressão

PageBreak

Sintaxe
TReport():PageBreak( ) → lRet

Descrição
Retorna se existe quebra de página

Retorno
lRet

PageHeight

Sintaxe
TReport():PageHeight( <lHeaderDiff> ) → nRet

Descrição
Retorna a altura da página baseado no tamanho da folha (A4, Carta, etc), conforme seleção do usuário

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lHeaderDiff	Lógico	Desconsidera o tamanho reservado para impressão do cabeçalho

Retorno
nRet - Retorna a altura da página

PageTotalBefore

Sintaxe
TReport():PageTotalBefore( <lTotalBefore> ) →

Descrição
Define se o total da página será impresso antes do total geral do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lTotalBefore	Lógico	Se verdadeiro, imprime antes do total gerado do relatório o total de páginas

PageTotalInLine

Sintaxe
TReport():PageTotalInLine( <lTotalInLine> ) →

Descrição
Define se o total da página será impresso em linha ou coluna

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lTotalInLine	Lógico	Se falso, será impresso em linha

PageTotalText

Sintaxe
TReport():PageTotalText( <cText> ) →

Descrição
Define o texto do totalizador da página

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cText	Caracter	Texto do totalizador da página

PageWidth

Sintaxe
TReport():PageWidth( ) → nRet

Descrição
Retorna a largura da página baseado no tamanho da folha (A4, Carta, etc), conforme seleção do usuário

Retorno
nRet - Largura da página

ParamReadOnly

Sintaxe
TReport():ParamReadOnly( <lParamReadOnly> ) →

Descrição
Define se o usuário terá acesso aos parâmetros do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lParamReadOnly	Lógico	.T. – Não permite acesso aos parâmetros .F. – Permite acesso aos parâmetros

Preview

Sintaxe
TReport():Preview( ) →

Descrição
Apresenta a visualização do relatório antes da impressão física

Print

Sintaxe
TReport():Print( <lDlg> ) →

Descrição
Executa a impressão do relatório conforme o bloco de código da propriedade bAction

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lDlg	Lógico	Aponta se deverá apresentar a tela de configuração do relatório ou se imprime em segundo plano

PrintCollection

Sintaxe
TReport():PrintCollection( <lPrintHeader> , <lFinish> ) → lRet

Descrição
Imprime os totalizadores do tipo Collections

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lPrintHeader	Lógico	Imprime cabeçalho da seção	X
lFinish	Lógico	Aponta que é o encerramento do relatório

Retorno
lRet - Se verdadeiro, o total foi impresso

PrintDialog

Sintaxe
TReport():PrintDialog( <bAction> ) → lRet

Descrição
Exibe a tela de configuração para a impressão do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
bAction	Bloco de Código	Bloco de código que será executado quando usuário confirmar a impressão do relatório

Retorno
lRet

PrintFooter

Sintaxe
TReport():PrintFooter( ) →

Descrição
Imprime o rodapé do relatório

PrintFunction

Sintaxe
TReport():PrintFunction( <lPrintHeader> ) →

Descrição
Imprime os totalizadores do tipo TRFunctions

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lPrintHeader	Lógico	Imprime cabeçalho da seção	X

PrintGraphic

Sintaxe
TReport():PrintGraphic( ) →

Descrição
Imprime os gráficos do relatório de acordo com o componente TRCollection.

PrintHeader

Sintaxe
TReport():PrintHeader( <lHeaderSection> ,<lPage> ) →

Descrição
Imprime o cabeçalho padrão do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lHeaderSection	Lógico	Imprime cabeçalho da seção
lPage	Lógico	Imprime Informações sobre a página, como por exemplo, número da página

Printing

Sintaxe
TReport():Printing( ) →

Descrição
Retorna se relatório esta em processo de impressão. O status de impressão é definido pelos métodos Init(), que indica o início da impressão, e o método Finish, que indica a finalização.

PrintSHeader

Sintaxe
TReport():PrintSHeader( ) →

Descrição
Imprime o cabeçalho da seção

PrintText

Sintaxe
TReport():PrintText( <cText> , <nRow> , <nCol> , <nClrText> , <cStyle> , <nCells> , <lUpdateRow> ) →

Descrição
Imprime um texto no relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cText	Caracter	Texto que será impresso	X
nRow	Numérico	Linha em que o texto será impresso. Caso não informada, será considerada a linha posicionada na impressão
nCol	Numérico	Coluna em que o texto será impresso. Caso não informada, será considerada a coluna posicionada na impressão
nClrText	Numérico	Cor do texto
cStyle	Caracter	Utilizado internamente para geração do relatório em planilha
nCells	Numérico	Utilizado internamente para geração do relatório em planilha
lUpdateRow	Lógico	Atualiza o posicionamento da linha quando informado o parâmetro nRow

PrintTHeader

Sintaxe
TReport():PrintTHeader( <nWidth> ,<nCells> ) →

Descrição
Imprime o cabeçalho dos totalizadores

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nWidth	Numérico	Largura do cabeçalho
nCells	Numérico	Quantidade de células considerada na geração em planilha

PrintTotal

Sintaxe
TReport():PrintTotal( <lFinish> ) →

Descrição
Imprime os totalizadores do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lFinish	Lógico	Aponta que é o fim do relatório

Retorno
Se verdadeiro, os totalizadores foram impressos

PrtCenter

Sintaxe
TReport():PrtCenter( <cText> ) →

Descrição
Imprime um texto centralizado

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cText	Caracter	Texto a ser centralizado	X

PrtLeft

Sintaxe
TReport():PrtLeft( <cText> ) →

Descrição
Imprime um texto à esquerda

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cText	Caracter	Texto a ser impresso à esquerda	X

PrtLogo

Sintaxe
TReport():PrtLogo( ) →

Descrição
Imprime o logo da empresa/filial

PrtRight

Sintaxe
TReport():PrtRight( <cText> ) →

Descrição
Imprime um texto à direita

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cText	Caracter	Texto a ser impresso à direita	X

ReportName

Sintaxe
TReport():ReportName( ) →

Descrição
Retorna o nome do relatório. Exemplo: MATR010

Row

Sintaxe
TReport():Row( ) →

Descrição
Retorna a linha posicionada na impressão

Retorno
nRet - Linha posicionada na impressão

SaveAsHTML

Sintaxe
TReport():SaveAsHTML( ) →

Descrição
Salva o relatório em HTML

SaveDefault

Sintaxe
TReport():SaveDefault( ) →

Descrição
Salva o relatório padrão sem as customizações do usuário

Say

Sintaxe
TReport():Say( <nRow> , <nCol> , <cText> , <oFont> , <nWidth> , <nClrText> , <nBkMode> , <nPad> ) →

Descrição
Imprime um texto no relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nRow	Numérico	Linha para impressão do texto	X
nCol	Numérico	Coluna para impressão do texto	X
cText	Caracter	Texto que será impresso	X
oFont	Objeto	Objeto da classe TFont
nWidth	Numérico	Tamanho em pixel do texto para impressão
nClrText	Numérico	Cor da fonte
nBkMode	Numérico	Compatibilidade – Não utilizado
nPad	Numérico	Compatibilidade – Não utilizado

SayBitmap

Sintaxe
TReport():SayBitmap( <nRow> , <nCol> , <cBitmap> , <nWidth> , <nHeight> , <nRaster> ) →

Descrição
Imprime uma imagem no relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nRow	Numérico	Linha para impressão da imagem	X
nCol	Numérico	Coluna para impressão da imagem	X
cBitmap	Caracter	Nome da imagem, podendo ser path de um arquivo ou resource compilado no repositório	X
nWidth	Numérico	Largura da imagem
nHeight	Numérico	Altura da imagem
nRaster	Numérico	Compatibilidade – Não utilizado

Section

Sintaxe
TReport():Section( <uSection> ) →

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uSection	Caracter / Numérico	Tipo Caracter: Título da seção Tipo Numérico: Índice da seção segundo a ordem de criação dos componentes TRSection	X

Descrição
Retorna objeto da classe TRSection (seção)

SendMail

Sintaxe
TReport():SendMail( ) →

Descrição
Envia o relatório através do e-mail

SendToPrinter

Sintaxe
TReport():SendToPrinter( ) →

Descrição
Direciona o relatório para o tipo de impressão selecionada

SetAction

Sintaxe
TReport():SetAction( <bAction> ) →

Descrição
Define o bloco de código que será executado ao usuário confirmar a impressão do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
bAction	Bloco de Código	Bloco de código que será executado na confirmação	X

SetBorder

Sintaxe
TReport():SetBorder( <uBorder> , <nWeight> , <nColor> , <lHeader> ) →

Descrição
Define as bordas 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
nWeight	Numérico	Cor da borda
nColor	Numérico	Aponta se é borda de cabeçalho
lHeader	Lógico	Objeto do tipo TRBorder

SetClrBack

Sintaxe
TReport():SetClrBack( <nClrBack> ) →

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

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nClrBack	Numérico	Número da cor de fundo no formato RGB

SetClrFore

Sintaxe
TReport():SetClrFore( <nClrFore> ) →

Descrição
Define a cor da fonte do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nClrFore	Numérico	Número da cor da fonte no formato RGB	X

SetCol

Sintaxe
TReport():SetCol( <nCol> ) →

Descrição
Define a coluna de impressão

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nCol	Numérico	Número da coluna de impressão	X

SetColSpace

Sintaxe
TReport():SetColSpace( <nColSpace> , <lPixel> ) →

Descrição
Define o espaçamento entre as colunas

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nColSpace	Numérico	Tamanho do espaçamento	X
lPixel	Lógico	Aponta se o tamanho será calculado em pixel	X

SetCustomText

Sintaxe
TReport():SetCustomText( <uCustomText> ) →

Descrição
Define que a impressão do cabeçalho padrão será customizado

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uCustomText	Array / Bloco de Código	Tipo Array: Array contendo a customização para impressão do cabeçalho padrão. Elementos: 1=Texto a ser impresso, no qual, um elemento por linha. Existem algumas strings que pode auxiliar na criação do cabeçalho: __NOLINEBREAK__ - Não quebra linha __NOTRANSFORM__ - Imprime sem nenhum tratamento __LOGOEMP__ - Imprime o logo da empresa __FATLINE__ - Imprime um linha grossa __THINLINE__ - Imprime uma linha fina Tipo Bloco de Código: Contendo Informações para geração do array descrito acima

SetDescription

Sintaxe
TReport():SetDescription( <cDescription> ) →

Descrição
Define a descrição detalhada do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cDescription	Caracter	Descrição do relatório	X

SetDevice

Sintaxe
TReport():SetDevice( <nDevice> ) →

Descrição
Define o tipo de impressão selecionado. Opções: 1-Arquivo,2-Impressora,3-Email,4-Planilha, 5-Html e 6-PDF

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nDevice	Numérico	Tipo de impressão selecionada	X

SetDynamic

Sintaxe
TReport():SetDynamic( ) →

Descrição
Define que o relatório será do tipo dinâmico, no qual, permite imprimir as seções conforme a ordem de impressão selecionada

SetEdit

Sintaxe
TReport():SetEdit( <lEdit> ) →

Descrição
Define se o relatório poderá ser configurado pelo usuário no caso de verdadeiro

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lEdit	Lógico	Habilita a personalização dos campos a imprimir	X

SetEnvironment

Sintaxe
TReport():SetEnvironment( <nEnv> ) →

Descrição
Define o ambiente para impressão

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nEnv	Numérico	Ambiente: 1-Server e 2-Client	X

SetFile

Sintaxe
TReport():SetFile( <cFile> ) →

Descrição
Define o nome do arquivo temporário utilizado para geração dos relatórios

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cFile	Caracter	Nome do arquivo temporário

SetLandscape

Sintaxe
TReport():SetLandscape( ) →

Descrição
Define a orientação de página do relatório como Paisagem

SetLeftMargin

Sintaxe
TReport():SetLeftMargin( <nLeftMargin> ) →

Descrição
Define a margem à esquerda do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nLeftMargin	Numérico	Tamanho da margem à esquerda	X

SetLineHeight

Sintaxe
TReport():SetLineHeight( <nLineHeight> ) →

Descrição
Define a altura da linha na impressão

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nLineHeight	Numérico	Altura da linha	X

SetLogo

Sintaxe
TReport():SetLogo( <cLogo> ) →

Descrição
Define o logo da empresa na impressão do cabeçalho padrão

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cLogo	Caracter	Indica o caminho para o arquivo de logo	X

SetMeter

Sintaxe
TReport():SetMeter( <nTotal> ) →

Descrição
Define o limite da régua de progressão do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nTotal	Caracter	Limite da régua	X

SetMsgPrint

Sintaxe
TReport():SetMsgPrint( <cMsg> ) →

Descrição
Define a mensagem apresentada durante a geração do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cMsg	Caracter	Texto da mensagem	X

SetOnPageNumber

Sintaxe
TReport():SetOnPageNumber( <bOnNumberPage> ) →

Descrição
Define o bloco de código utilizado para manipular o número da página atual

Parâmetros

Nome	Tipo	Descrição	Obrigatório
bOnNumberPage	Bloco de Código	Block para manipular numeração da página atual	X

SetPageNumber

Sintaxe
TReport():SetPageNumber( <nPage> ) →

Descrição
Define o número da página atual

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nPage	Numérico	Número da página atual	X

SetPageFooter

Sintaxe
TReport():SetPageFooter( <nLinesFooter> , <bPageFooter> , <lFooterBefore> ) →

Descrição
Define o rodapé da página

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nLinesFooter	Numérico	Linhas reservada para impressão do rodapé	X
bPageFooter	Bloco de Código	Bloco de código utilizado para imprimir Informações customizadas, no qual, deverão ser utilizados métodos do TReport para impressão. Exemplo: Say, PrintText	X
lFooterBefore	Lógico	Imprime rodapé antes dos totalizadores

SetParam

Sintaxe
TReport():SetParam( <uParam> ) →

Descrição
Define os parâmetros que serão utilizados pelo usuário

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uParam	Caracter / Bloco de Código	Parâmetros do relatório cadastrados no Dicionário de Perguntas (SX1). Também pode ser utilizado Bloco de Código para parâmetros customizados

SetPortrait

Sintaxe
TReport():SetPortrait( ) →

Descrição
Define orientação de página do relatório como retrato

SetPreview

Sintaxe
TReport():SetPreview( <lPreview> ) →

Descrição
Define se será apresentada a visualização do relatório antes da impressão física

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lPreview	Lógico	Se verdadeiro, será apresentada a visualização antes da impressão

SetPxLeftMargin

Sintaxe
TReport():SetPxLeftMargin( <nPxLeftMargin> ) →

Descrição
Define a margem à esquerda em pixel do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nPxLeftMargin	Numérico	Tamanho da margem à esquerda em pixel	X

SetRightAlignPrinter

Sintaxe
TReport():SetRightAlignPrinter( <lAlignPrinter> ) →

Descrição
Seta que será utilizado o componente do binário para realizar o alinhamento das células que estejam à direita.

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lAlignPrinter	Lógico	Se verdadeiro, utiliza o alinhamento do binário para células à direita	X

Importante

Ao utilizar esse método ficar atento ao alinhamento das células, as mesmas deverão estar alinhadas à direita (sem espaços à esquerda) para que fique com o comportamento correto.

Método disponível a partir da LIB Label 20211004

SetRow

Sintaxe
TReport():SetRow( <nRow> ) →

Descrição
Define a margem à esquerda em pixel do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nRow	Numérico	Número da linha a ser impressa	X

SetStartPage

Sintaxe
TReport():SetStartPage( <lStartPage> ) →

Descrição
Define que deverá ser gerada uma nova página no relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lStartPage	Lógico	Se verdadeiro, aponta a necessidade de uma nova página

SetTitle

Sintaxe
TReport():SetTitle( <cTitle> ) →

Descrição
Define o título do relatório

Parâmetros

Nome	Tipo	Descrição	Obrigatório
cTitle	Lógico	Título do relatório	X

SetTotalInLine

Sintaxe
TReport():SetTotalInLine( <lTotalInLine> ) →

Descrição
Define se os totalizadores serão impressos em linha ou coluna

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lTotalInLine	Lógico	Se falso, imprime em linha

SetTotalPageBreak

Sintaxe
TReport():SetTotalPageBreak( <lTPageBreak> ) →

Descrição
Define que será quebrada página após a impressão do totalizador

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lTPageBreak	Lógico	Se verdadeiro, aponta a quebra de página após a impressão do totalizador

SetTotalText

Sintaxe
TReport():SetTotalText( <uText> ) →

Descrição
Define o texto que será impresso antes da impressão dos totalizadores

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uText	Character, CodeBlock	Texto a ser impresso no formato caracter ou bloco de código

ShowFooter

Sintaxe
TReport():ShowFooter( ) →

Descrição
Define que será impresso o rodapé do relatório

ShowHeader

Sintaxe
TReport():ShowHeader( ) →

Descrição
Define que será impresso o cabeçalho do relatório

ShowParamPage

Sintaxe
TReport():ShowParamPage( ) →

Descrição
Define que será impressa a página de parâmetros do relatório

SkipLine

Sintaxe
TReport():SkipLine( <nSkip> ) →

Descrição
Salta linhas na impressão

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nSkip	Numérico	Quantidade de linhas a serem saltadas

StartPage

Sintaxe
TReport():StartPage( ) →

Descrição
Inicializa um nova página para impressão

ThinLine

Sintaxe
TReport():ThinLine( ) →

Descrição
Desenha uma linha simples, iniciando posição da linha atual de impressão com a largura da página

Title

Sintaxe
TReport():Title( ) → cTitle

Descrição
Retorna o título do relatório

Retorno
cTitle - Caracter - Título do relatório

TotalText

Sintaxe
TReport():TotalText( ) → cTitle

Descrição
Retorna o texto que será impresso no totalizador geral do relatório

TotalInLine

Sintaxe
TReport():TotalInLine( ) → lRet

Descrição
Retorna se a impressão dos totalizadores será em linha

Retorno
lRet - Lógico

XmlLoad

Sintaxe
TReport():XmlLoad( <uXml> ) →

Descrição
Carrega um layout personalizado pelo usuário

Parâmetros

Nome	Tipo	Descrição	Obrigatório
uXml	Caracter, Array	Arquivo do tipo XML com as personalizações do usuário	X

XmlSave

Sintaxe
TReport():XmlSave( ) → aXml

Descrição
Retorna um array com o layout do TReport atual.

O array contém o layout em formato XML, é retornando em formato de array para evitar problemas em relação ao tamanho máximo de strings.

XlsNewCell

Sintaxe
TReport():XlsNewCell( <c> , <lIndex> , <nCol> , <cStyle> , <nCells> , <nWidth> , <cType> ) →

Descrição
Adiciona uma célula na geração em planilha

Parâmetros

Nome	Tipo	Descrição
c	Caracter	Informação a ser inserida na célula
lIndex	Lógico	Controla numeração de colunas na planilha
nCol	Numérico	Coluna posicionada
cStyle	Caracter	Estilo da célula
nCells	Numérico	Quantidade de células utilizadas para a informação (Mesclar)
nWidth	Numérico	Largura da célula
cType	Caracter	Tipo de dado. C-Caracter, N-Numérico, L-Lógico

XlsNewCol

Sintaxe
TReport():XlsNewCol( <nCol> , <nWidth> ) →

Descrição
Adiciona uma coluna na geração em planilha

Parâmetros

Nome	Tipo	Descrição	Obrigatório
nCol	Numérico	Coluna posicionada	X
nWidth	Numérico		X

XlsNewRow

Sintaxe
TReport():XlsNewRow( <lIncRow> ) →

Descrição
Adiciona uma linha na geração em planilha

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lIncRow	Lógico	Aponta se deverá ser adicionada uma linha

XlsNewStyle

Sintaxe
TReport():XlsNewStyle( <cID> , <cName> , <nAlign> , <aFont> , <aBorder> , <lWrapText> , <cType> ) →

Descrição
Cria um estilo para utilizar nas criações das células

Parâmetros

Nome	Tipo	Descrição
cID	Caracter	ID do estilo
cName	Caracter	Nome do estilo
nAlign	Numérico	Tipo de alinhamento. 1-Esquerda, 2-Centralizado, 3-Direita
aFont	Array	Array contendo a fonte. Elementos: 1-Fonte, 2-Tamanho
aBorder	Array	Array contendo a borda. Elementos: 1-“Bottom”,”Left”,”Right”,”Center”, 2=Largura da borda
lWrapText	Lógico	Aponta quebra de linha automática
cType	Caracter	Tipo de dado. C-Caracter, N-Numérico, L-Lógico

XlsSave

Sintaxe
TReport():XlsSave( ) →

Descrição
Compatibilidade – Não utilizado

SetUseGC

Sintaxe
TReport():SetUseGC( lUseGC ) →

Descrição
Define se o relatório poderá utilizar o conceito de gestão de empresas

Parâmetros

Nome	Tipo	Descrição	Obrigatório
lUseGC	Lógico	Se falso, indica que o relatório não utilizará o conceito de gestão de empresas. Caso não seja informado o parâmetro o valor default é verdadeiro.

GetGCList

Sintaxe
TReport():GetGCList() → aFilterGC

Descrição
Retorna um array contendo a lista de grupos, empresas, unidade de negócio e filiais selecionadas na tela de gestão de empresas.

Retorno

Array contendo a lista de grupos, empresas, unidade de negócio e filiais selecionadas na tela de gestão de empresas.

xlsxTypeWrite

Sintaxe
TReport():xlsxTypeWrite( <nXlsxTypeWrite> )

Descrição
Informa ao TReport como a geração do XLSX deve ser efetuada, sendo que cada opção leva a cenários de maior performance ou maior consumo de memória, logo essa opção deve ser utilizada conforme necessidade específica de um relatório, normalmente relatórios com grande volume de dados.

Parâmetros

Nome

Tipo

Descrição

Obrigatório

nXlsxTypeWrite

Numeric

Tipo da geração de planilha XLSX, sendo valores de 0 a 3:

0: Gera o xlsx de acordo com as regras do TReport (default)
1: Gera o xlsx em arquivo (possui limitações)
2: Gera o xlsx em banco de dados (baixo consumo de memória)
3: Gera o xlsx em memória (alta performance)

Importante: A geração em arquivo (valor 1) é limitada e deve ser utilizada somente em relatório que possuam apenas uma seção, caso contrário, os dados podem ficar agrupados na última worksheet criada, portanto, essa opção deve ser utilizada com cautela e deve ser rigorosamente homologada.

Caso o método seja chamado durante a impressão, seu valor não será acatado.

Observação

Esse método está disponível na lib 20240812 ou superior
O valor enviado é repassado para a classe responsável por gerar a planilha XLSX: FWMsExcelXlsx
O método precisa ser chamado antes da ativação do TReport, ou seja, durante sua definição, normalmente na função ReportDef

Páginas filhas

TReport

Métodos:

AddBreak

AddCollection

AddFunction

AddHeaderPage

AddSection

Border

Cancel

CancelPrint

Char2Pix

ChkIncRow

ClassName

ClrBack

ClrFore

Col

ColSpace

Description

Disable

DisableOrientation

Enable

Enabled

EndPage

EvalBreak

EndReport

FatLine

FillRect

Finish

FreeAllObjs

FunctionBefore

GetAction

GetBreak

GetDynamic

GetEdit

GetFontSize

GetFunction

GetOrder

GetOrientation

GetParam

GetRightAlignPrinter

GetWidth

HideFooter

HideHeader

HideParamPage

IncMeter

IncRow

Init

LeftMargin

Line

LineHeight

LoadDefault

New

NoUserFilter

NoCell

NoPrint

OnPageBreak

Page

PageBreak

PageHeight

PageTotalBefore

PageTotalInLine

PageTotalText

PageWidth

ParamReadOnly

Preview

Print

PrintCollection

PrintDialog

PrintFooter

PrintFunction

PrintGraphic

PrintHeader

Printing

PrintSHeader

PrintText

PrintTHeader

PrintTotal

PrtCenter

PrtLeft