TREPORT Guia Completo

Download TREPORT Guia Completo

Post on 27-Sep-2015

392 views

Category:

Documents

20 download

Embed Size (px)

DESCRIPTION

TREPORT Guia Completo

TRANSCRIPT

<ul><li><p>TREPORT</p><p>Produto : Microsiga Protheus, verso 10 Chamado : SCFHBTData da criao</p><p>18/01/10 Data da reviso</p><p>29/11/11.</p><p>Pas(es) : Brasil Banco de Dados</p><p>: Todos</p><p>FNC : 00000026652/2009</p><p>Este boletim tem o objetivo de informar a utilizao do objeto TReport para criao de relatrios, detalhando as propriedades e mtodos de cada classe utilizada no TReport. </p><p>TREPORTClasse de impresso que substitui as funes SetPrint, SetDefault, RptStatus e Cabec.A classe TReport permite que o usurio personalize as informaes que sero apresentadas no relatrio, alterando fonte (tipo, tamanho, etc.), cor, tipo de linhas, cabealho, rodap, etc.</p><p>Estrutura do componente TReport:O relatrio (TReport) contm uma ou mais sees (TRSection); Uma seo (TRSection) pode conter uma ou mais sees; A seo (TRSection) contm clulas pr-definidas e clulas selecionadas pelo usurio; A seo (TRSection) tambm contm as quebras (TRBreak) para impresso de totalizadores (TRFunction); Os totalizadores so includos pela seo que automaticamente inclui no relatrio </p><p>(TReport).</p><p>PropriedadesaBreak Array com todas as quebras totalizadoras do relatrio. Elemento: 1-Objeto </p><p>TRBreak.aCollection Array com todos totalizadores do tipo TRCollection do relatrio. </p><p>Elemento: 1-Objeto TRCollection.aCustomText Array contendo a customizao para impresso do cabealho padro. </p><p>Elementos: 1=Texto a ser impresso, no qual, um elemento por linha. Existem algumas strings que pode auxiliar na criao do cabealho:</p><p>__NOLINEBREAK__ - No quebra linha__NOTRANSFORM__ - Imprime sem nenhum tratamento__LOGOEMP__ - Imprime o logo da empresa__FATLINE__ - Imprime um linha grossa__THINLINE__ - Imprime uma linha fina</p><p>FrameWork - TReport 1</p></li><li><p>aBmps Array com as imagens dos grficos enviadas por email. Elemento: 1- Caminho da imagem.</p><p>aFontSize Array com as fontes do sistema. Elementos: 1-Fonte, 2-Tamanho, 3- Tamanho em pixel.</p><p>aFunction Array com todos totalizadores do tipo TRFunction do relatrio. Elemento: 1-Objeto TRFunction.</p><p>aHeaderPage Array com todas as sees que imprimem cabealho no topo da pgina.aSection Array com todas as sees do relatrio. Elemento: 1-Objeto TRSection.bAction Bloco de cdigo executado quando o usurio confirmar a impresso do relatrio.bCustomText Bloco de cdigo para atualizao da propriedade aCustomText.bOnNumberPage Bloco de cdigo para atualizao do nmero da pgina atual.bOnPageBreak Bloco de cdigo para tratamentos na inicializao de cada pgina.bTotal Compatibilidade No utilizado.bTotalCanPrint Bloco de cdigo utilizado para validar a impresso dos totalizadores.bTotalPos Bloco de cdigo utilizado para localizar a posio do totalizador a ser impresso.bTotalPrint Bloco de cdigo utilizado para imprimir os totalizadores.bTotalReset Bloco de cdigo utilizado para limpar os totalizadores.bTotalRSize Bloco de cdigo utilizado para definir o tamanho das Collections.bTotalText Bloco de cdigo utilizado na impresso do texto do totalizador.cClassName Nome da classe. Exemplo: TREPORT.cDate Data da impresso do relatrio.cDescription Descrio do relatrio.cDir Diretrio selecionado para gerao do relatrio.cEmail E-mail utilizado na gerao do relatrio via e-mail.cFontBody Fonte definida para impresso do relatrio.cFile Nome do arquivo que ser gerado.cID ID do component. Exemplo: TREPORT.cLogo Logo da empresa/filial.cMsgPrint Mensagem apresentada durante a gerao do relatrio.cPrinterName Nome da impressora selecionada para impresso.cReport Nome do relatrio. Exemplo: MATR010.cTime Hora da impresso do relatrio.cTitle Ttulo do relatrio.cRealTitle Ttulo padro do relatrio definido pelo criador do relatrio.cUserObs Observao do usurio.cXlsTHStyle Estilo do cabealho padro utilizado na gerao da planilha.cXlsSHStyle Estilo do cabealho utilizado na gerao da planilha.cXmlDefault Arquivo XML contendo Informaes do relatrio padro.cXlsFile Nome do arquivo que ser gerado em planilha.lBold Aponta que as Informaes sero impressas em negrito.lCanceled Aponta que o relatrio foi cancelado.lClrBack Define que a cor de fundo dever ser atualizada.</p><p>2 FrameWork - TReport</p></li><li><p>lClrFore Define que a cor da fonte dever ser atualizada.lDisableOrientation Orientao (Retrato/Paisagem) no poder ser modificada.lDynamic Aponta que o relatrio dinmico, permitindo imprimir as sees conforme a </p><p>ordem de impresso selecionada.lEdit Relatrio no poder ser configurado pelo usurio.lEnabled Impresso do relatrio foi desabilitada.lEmptyLineExcel Suprime as linhas em branco e os totais na gerao em planilha.lFooterVisible Habilita a impresso do rodap.lFunctionBefore Imprime os totalizadores do tipo TRFunction antes dos totalizadores do tipo </p><p>TRCollecions.lHeaderVisible Habilita a impresso do cabealho.lItalic Aponta que as informaes sero impressas em itlico.lOnPageBreak Cabealho das sees impressas aps a quebra de pgina.lPageBreak Quebra pgina antes da impresso dos totalizadores.lParamPage Existe parmetros para impresso.lParamReadOnly Parmetros no podero ser alterados pelo usurio.lPixColSpace Espaamento das colunas sero calculadas em pixel.lPreview Visualizao do relatrio antes da impresso fsica.lPrinting Relatrio esta em processo de impresso.lPrtParamPage Aponta que sero impressos os parmetros do relatrio.lStartPage Aponta que uma nova pgina dever se inicializada.lTotalInLine Imprime as clulas no formato linha.lTPageBreak Quebra pgina aps a impresso do totalizador.lUnderline Aponta que as Informaes sero impressas sublinhadas.lUserAccess Valida permisso para gerao dos grficos do relatrio.lUserInfo Imprime Informaes do usurio na pgina de parmetros.lUserFilter Permite a utilizao de filtros na personalizao do relatrio.lXlsHeader Imprime informaes do cabealho padro na gerao em planilha.lNoPrint Aponta que nenhuma informao foi impressa.lXmlEndRow Aponta fim de linha na gerao em planilha.lXlsParam Aponta a existncia de parmetros na gerao em planilha.lEndReport Imprime total geral do relatrio.nBorderDiff Tamanho da borda utilizado para clculo da altura de uma linha.nClrBack Cor de fundo.nClrFore Cor da fonte.nCol Coluna posiciona na impresso.nColSpace Espaamento entre as colunas.nDevice Tipo de impresso selecionado. Opes: 1-Arquivo,2-Impressora,3-email,4-</p><p>Planilha e 5-Html.nEnvironment Ambiente selecionado. Opes: 1-Server e 2-Cliente.nFontBody Tamanho da fonte definida para impresso do relatrio.nHeaderDiff Tamanho do cabealho utilizado para clculo do altura da pgina.nLeftMargin Tamanho da margem a esquerda.nLineHeight Altura da linha.</p><p>FrameWork - TReport 3</p></li><li><p>nLogPxYDiff Utilizado no clculo para gerao da visualizao do relatrio.nLogPxXDiff Utilizado no clculo para gerao da visualizao do relatrio.nMeter Posio da rgua de progresso.nOrder Ordem de impresso selecionada.nPageWidth Largura da pgina.nPxColSpace Espaamento da coluna em pixel.nPxBase Tamanho da base em pixel.nPxDate Tamanho da sistema operacional em pixel.nPxLeftMargin Tamanho da margem a esquerda em pixel.nPxPage Tamanho da numerao da pgina em pixel.nPxTitle Tamanho do ttulo em pixel.nRemoteType Aponta de que forma o Server est gerando o relatrio. Opes: 1-Sem </p><p>Remote, 2-Remote Delphi,3-Remote Windows e 4-Remote Linux.nRow Linha posicionada na impresso.nXlsCol Coluna posicionada na gerao em planilha.nXlsRow Linha posicionada na gerao em planilha.nXlsStyle Estilo utilizado na gerao em planilha.nExcel Nmero do arquivo na gerao em planilha.nColumnPos Posicionamento no arquivo gerado em planilha.oBrdBottom Objeto TRBorder com a borda Inferior .oBrdLeft Objeto TRBorder com a borda esquerda.oBrdRight Objeto TRBorder com a borda direita.oBrdTop Objeto TRBorder com a borda superior.oHBrdBottom Objeto TRBorder com a borda Inferior no cabealho.oHBrdLeft Objeto TRBorder com a borda esquerda no cabealho.oHBrdRight Objeto TRBorder com a borda direita no cabealho.oHBrdTop Objeto TRBorder com a borda superior no cabealho.oClrBack Objeto TBrush com a cor de Fundo.oFontBody Objeto TFont com a fonte do relatrio.oFontHeader Objeto TFont com a fonte do cabealho.oMeter Objeto TMeter com a rgua de progresso.oMsg Objeto TSAY com a mensagem apresentada durante a impresso do relatrio.oPage Objeto TRPage com a configurao da pgina de impresso.oParamPage Objeto TRParamPage com a configurao da pgina de parmetros.oPrint Objeto TMSPrinter.oReport Componente de impresso.oXlsCell Compatibilidade No utilizado.oXlsRow Compatibilidade No utilizado.oXlsStyles Compatibilidade No utilizado.oXlsWorksheet Compatibilidade No utilizado.uParam Parmetros do relatrio cadastrado no Dicionrio de Perguntas (SX1).</p><p>Tambm pode ser utilizado bloco de cdigo para parmetros customizados.</p><p>4 FrameWork - TReport</p></li><li><p>MTODOS </p><p>AddBreak(oBreak)Adiciona a quebra de impresso na propriedade aBreak.oBreak Objeto TRBreak</p><p>AddCollection(oCollection)Adiciona o totalizador na propriedade aCollection.oCollection Objeto TRCollection</p><p>AddFunction(oFunction,oParent)Adiciona o totalizador na propriedade aFunction.oFunction Objeto TRFunctionoParent Objeto TRSecion que aponta a seo que pertence o totalizador</p><p>AddHeaderPage(oSection)Adiciona a seo que imprime cabealho no topo da pgina.oSection Objeto TRSection</p><p>AddSection(oSection)Adiciona a seo na propriedade aSection.oSection Objeto TRSection</p><p>Border(uBorder,lHeader)Retorna a borda do relatrio.uBorder Tipo Caracter: "TOP","BOTTOM","LEFT","RIGHT",ALL</p><p>Tipo Numrico: 1-Superior,2-Inferior,3-Esquerda,4-Direita,5-TodaslHeader Borda do cabealho</p><p>Retorno Objeto do tipo TRBorder</p><p>Box(nRow,nCol,nBottom,nRight,oPen)Desenha uma caixa, utilizando as especificaes do objeto TPen.nRow Linha no qual inicia o desenho da caixanCol Coluna no qual inicia o desenho da caixanBottom Linha no qual finaliza o desenho da caixanRight Coluna no qual finaliza o desenho da caixaoPen Objeto da classe TPen</p><p>Cancel()Retorna se o usurio cancelou a impresso do relatrio.</p><p>CancelPrint()</p><p>FrameWork - TReport 5</p></li><li><p>Cancela a impresso do relatrio.</p><p>Char2Pix(nSize,cFont,nFontSize)Retorna o tamanho de acordo com a fonte informada.nSize Tipo Caracter: Texto a ser considerado no clculo</p><p>Tipo Numrico: Valor a ser considerado no clculocFont Fonte do relatrionFontSize Tamanho da fonte</p><p>Retorno Tamanho calculado em pixel</p><p>ChkIncRow(nInc,lLine)Verifica a necessidade de inicializar uma nova pgina antes da incluso da linha.nInc Quantidade de linhas a serem impressaslLine Considera o tamanho da linha no clculo</p><p>Retorno Lgico</p><p>ClassName()Retorna o nome da classe. Exemplo: TREPORT.</p><p>ClrBack(lObject)Retorna a cor de fundo do relatrio.lObject Aponta que deve ser retornado o objeto TBrush</p><p>Retorno Caso o parmetro lObjeto seja verdadeiro o retorno ser o objeto TBrush, caso contrrio ser o nmero da cor RGB.</p><p>ClrFore()Retorna a cor de fonte do relatrio.Retorno Nmero da cor RGB</p><p>Col()Retorna a coluna posicionada na impresso.</p><p>ColSpace()Retorna o espaamento entre as colunas.</p><p>Description()Retorna a descrio do relatrio.</p><p>Disable()Desabilita a impresso do relatrio.</p><p>6 FrameWork - TReport</p></li><li><p>DisableOrientation()Desabilita a seleo da orientao (Retrato/Paisagem).</p><p>Enable()Habilita a impresso do relatrio.</p><p>Enabled()Retorna se a impresso do relatrio esta habilitada.</p><p>EndPage(lFooter)Finaliza a pgina na impresso.lFooter Imprime rodap na finalizao da pgina</p><p>EvalBreak(lForce,lPrintHeader,oSection)Executa a quebra na impresso do relatrio.lForce Fora a execuo do mtodo OnBreak da classe TRBreaklPrintHeader Imprime cabealho da seooSection Seo considerada na quebra</p><p>Retorno Lgico. Se verdadeiro, quebrou a impresso</p><p>EndReport()Retorna se imprime o total geral do relatrio.</p><p>FatLine()Desenha uma linha com altura grossa, iniciando posio da linha atual de impresso com a largura da pgina.</p><p>FillRect(aRect,oBrush)Preenche um retngulo na impresso utilizando as especificaes do objeto TBrush.aRect Vetor com coordenadas no formato: linha inicial, coluna inicial, linha final, </p><p>coluna finaloBrush Objeto da classe TBrush</p><p>Finish()Finaliza a impresso do relatrio, imprime os totalizadores, fecha as querys e ndices temporrios, entre outros tratamentos do componente.No necessrio executar o mtodo Finish se for utilizar o mtodo Print, j que este faz o controle de inicializao e finalizao da impresso.</p><p>FreeAllObjs()Elimina os objetos da memria no servidor.</p><p>FrameWork - TReport 7</p></li><li><p>FunctionBefore(lFunctionBefore)Define se a impresso dos totalizadores do tipo TRFunction ser realizada antes dos totalizadores do tipo TRCollection.</p><p>GetAction()Retorna o bloco de cdigo definido para a propriedade bAction.</p><p>GetBreak(uBreak)Retorna a quebra do relatrio.uBreak Tipo Caracter: Nome da quebra</p><p>Tipo Nmerico: Nmero da quebra no array aBreak</p><p>Retorno Objeto TRBreak</p><p>GetDynamic()Retorna se o relatrio do tipo dinmico.</p><p>Retorno Lgico</p><p>GetEdit()Retorna se permitida a configurao do relatrio pelo usurio.</p><p>Retorno Lgico</p><p>GetFontSize(cFont,nFontSize,lBold,lItalic,lUnderline)Retorna o tamanho da fonte.cFont Fonte a ser considerada no clculonFontSize Tamanho da fontelBold Aponta se a fonte negritalItalic Aponta se a fonte itlicalUnderline Aponta se a fonte sublinhada</p><p>Retorno Array com informaes do tamanho da fonte. Elementos: 1-Fonte, 2-Tamanho, 3-Tamanho em pixel</p><p>GetFunction(uFunction)Retorna objeto da classe TRFunction (totalizadores).uFunction Tipo Caracter: Nome da Function</p><p>Tipo Numrico: ndice do objeto segundo a ordem de criao dos componentes TRFunction</p><p>Retorno Objeto da classe TRFunction (totalizadores)</p><p>8 FrameWork - TReport</p></li><li><p>GetOrder()Retorna a ordem de impresso selecionada.</p><p>Retorno Ordem selecionada</p><p>GetOrientation()Retorna a orientao de pgina (Retrato ou Paisagem) selecionada pelo usurio.</p><p>Retorno 1=Retrato ou 2=Paisagem</p><p>GetParam()Retorna a pergunta ou bloco de cdigo utilizado como parmetros do relatrio.</p><p>GetPassword()No utilizado.</p><p>GetWidth()Retorna a largura da pgina.</p><p>HideFooter()Define que no ser impresso o rodap padro da pgina.</p><p>HideHeader()Define que no ser impresso o cabealho padro da pgina.</p><p>HideParamPage()Define se ser permitida a alterao dos parmetros do relatrio.</p><p>IncMeter(nInc)Incrementa a rgua de progresso do relatrio.nInc Quantidade a incrementar na rgua. Padro: 1</p><p>IncRow(nInc)Incrementa linhas na impresso.nInc Quantidade de linhas que devero ser incrementadas</p><p>Retorno Linha atualizada.</p><p>Init()Inicializa as configuraes e define a primeira pgina do relatrio.No necessrio executar o mtodo Init se for utilizar o mtodo Print, j que estes fazem o controle de inicializao e finalizao da impresso.</p><p>FrameWork - TReport 9</p></li><li><p>LeftMargin(lPixel,lForce)Retorna o tamanho da margem esquerda do relatrio.lPixel Considera clculo em pixellForce Fora o reclculo da margem esquerda</p><p>Retorno Tamanho da margem esquerda</p><p>Line(nTop,nLeft,nBottom,nRight,oPen)Desenha uma linha, utilizando as especificaes da classe TPen.nTop Linha no qual inicia o desenho da linhanLeft Coluna no qual inicia o desenho da linhanBottom Linha no qual finaliza o desenho da linhanRight Coluna no qual finaliza o desenho da linhaoPen Objeto da classe TPen</p><p>LineHeight()Retorna a altura da linha.</p><p>Retorno Altura da linha</p><p>LoadDefault()Carrega o relatrio padro para personalizao.</p><p>LoadLayout(cLayout)Carrega um layout customizado para impresso.cLayout Layout a ser carregado</p><p>New(cReport,cTitle,uParam,bAction,cDescription...</p></li></ul>