Portaria CAT 95 de 17/11/2003
TREPORT
Produto:Microsiga Protheus, verso 10Chamado:SCFHBT
Data da criao18/01/10Data da reviso29/10/13.
Pas(es):BrasilBanco de Dados:Todos
FNC:00000026652/2009
AplicabilidadeCampo especfico para o Gesto de Frotas Ficar oculto no modelo de boletim.
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. TREPORTClasse de impresso que substitui as funes SetPrint, SetDefault, RptStatuse 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.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 seoque automaticamente inclui no relatrio (TReport).PropriedadesaBreakArray com todas as quebras totalizadoras do relatrio. Elemento: 1-Objeto TRBreak.
aCollection
Array com todos totalizadores do tipo TRCollection do relatrio.
Elemento: 1-Objeto TRCollection.
aCustomText
Array contendo a customizao para impresso do cabealho padro.
Elementos: 1=Texto a ser impresso, no qual, um elemento por linha. Existem algumas strings que pode auxiliar na criao do cabealho:
__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
aBmpsArray com as imagens dos grficos enviadas por email. Elemento: 1- Caminho da imagem.
aFontSizeArray com as fontes do sistema. Elementos: 1-Fonte, 2-Tamanho, 3- Tamanho em pixel.
aFunction
Array com todos totalizadores do tipo TRFunction do relatrio.
Elemento: 1-Objeto TRFunction.
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.
bOnNumberPageBloco de cdigo para atualizao do nmero da pgina atual.
bOnPageBreak
Bloco de cdigo para tratamentos na inicializao de cada pgina.
bTotal
Compatibilidade No utilizado.
bTotalCanPrintBloco 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.
lClrFore
Define que a cor da fonte dever ser atualizada.
lDisableOrientationOrientao (Retrato/Paisagem) no poder ser modificada.
lDynamicAponta que o relatrio dinmico, permitindo imprimir as sees conforme a ordem de impresso selecionada.
lEdit
Relatrio no poder ser configurado pelo usurio.
lEnabled
Impresso do relatrio foi desabilitada.
lEmptyLineExcelSuprime as linhas em branco e os totais na gerao em planilha.
lFooterVisible
Habilita a impresso do rodap.
lFunctionBeforeImprime os totalizadores do tipo TRFunction antes dos totalizadores do tipo 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.
lParamReadOnlyParmetros 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.
nDeviceTipo de impresso selecionado. Opes: 1-Arquivo,2-Impressora,3-email,4-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.
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.
nRemoteTypeAponta de que forma o Server est gerando o relatrio. Opes: 1-Sem 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.
oXlsWorksheetCompatibilidade No utilizado.
uParam
Parmetros do relatrio cadastrado no Dicionrio de Perguntas (SX1).
Tambm pode ser utilizado bloco de cdigo para parmetros customizados.
MTODOS AddBreak(oBreak)Adiciona a quebra de impresso na propriedade aBreak.oBreak
Objeto TRBreak
AddCollection(oCollection)Adiciona o totalizador na propriedade aCollection.oCollectionObjeto TRCollection
AddFunction(oFunction,oParent)Adiciona o totalizador na propriedade aFunction.
oFunctionObjeto TRFunction
oParentObjeto TRSecion que aponta a seo que pertence o totalizador
AddHeaderPage(oSection)Adiciona a seo que imprime cabealho no topo da pgina.oSection Objeto TRSection
AddSection(oSection)Adiciona a seo na propriedade aSection.oSectionObjeto TRSection
Border(uBorder,lHeader)Retorna a borda do relatrio.uBorderTipo Caracter: "TOP","BOTTOM","LEFT","RIGHT",ALL
Tipo Numrico: 1-Superior,2-Inferior,3-Esquerda,4-Direita,5-Todas
lHeaderBorda do cabealho
RetornoObjeto do tipo TRBorder
Box(nRow,nCol,nBottom,nRight,oPen)Desenha uma caixa, utilizando as especificaes do objeto TPen.
nRow
Linha no qual inicia o desenho da caixa
nCol
Coluna no qual inicia o desenho da caixa
nBottomLinha no qual finaliza o desenho da caixa
nRight
Coluna no qual finaliza o desenho da caixa
oPen
Objeto da classe TPen
Cancel()Retorna se o usurio cancelou a impresso do relatrio.
CancelPrint()Cancela a impresso do relatrio.
Char2Pix(nSize,cFont,nFontSize)Retorna o tamanho de acordo com a fonte informada.
nSize
Tipo Caracter: Texto a ser considerado no clculo
Tipo Numrico: Valor a ser considerado no clculo
cFont
Fonte do relatrio
nFontSizeTamanho da fonte
RetornoTamanho calculado em pixel
ChkIncRow(nInc,lLine)Verifica a necessidade de inicializar uma nova pgina antes da incluso da linha.
nInc
Quantidade de linhas a serem impressas
lLine
Considera o tamanho da linha no clculo
Retorno Lgico
ClassName()Retorna o nome da classe. Exemplo: TREPORT.
ClrBack(lObject)Retorna a cor de fundo do relatrio.
lObject
Aponta que deve ser retornado o objeto TBrush
RetornoCaso o parmetro lObjeto seja verdadeiro o retorno ser o objeto TBrush, caso contrrio ser o nmero da cor RGB.
ClrFore()Retorna a cor de fonte do relatrio.
RetornoNmero da cor RGBCol()Retorna a coluna posicionada na impresso.
ColSpace()Retorna o espaamento entre as colunas.
Description()Retorna a descrio do relatrio.
Disable()Desabilita a impresso do relatrio.
DisableOrientation()Desabilita a seleo da orientao (Retrato/Paisagem).
Enable()Habilita a impresso do relatrio.
Enabled()Retorna se a impresso do relatrio esta habilitada.
EndPage(lFooter)Finaliza a pgina na impresso.
lFooter
Imprime rodap na finalizao da pgina
EvalBreak(lForce,lPrintHeader,oSection)Executa a quebra na impresso do relatrio.
lForce
Fora a execuo do mtodo OnBreak da classe TRBreak
lPrintHeaderImprime cabealho da seo
oSectionSeo considerada na quebra
Retorno Lgico. Se verdadeiro, quebrou a impresso
EndReport()Retorna se imprime o total geral do relatrio.
FatLine()Desenha uma linha com altura grossa, iniciando posio da linha atual de impresso com a largura da pgina.
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,
coluna final
oBrush
Objeto da classe TBrush
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.
FreeAllObjs()Elimina os objetos da memria no servidor.
FunctionBefore(lFunctionBefore)Define se a impresso dos totalizadores do tipo TRFunction ser realizada antes dos totalizadores do tipo TRCollection.
GetAction()Retorna o bloco de cdigo definido para a propriedade bAction.
GetBreak(uBreak)Retorna a quebra do relatrio.
uBreak
Tipo Caracter: Nome da quebra
Tipo Nmerico: Nmero da quebra no array aBreak
Retorno Objeto TRBreak
GetDynamic()Retorna se o relatrio do tipo dinmico.
Retorno Lgico
GetEdit()Retorna se permitida a configurao do relatrio pelo usurio.
Retorno Lgico
GetFontSize(cFont,nFontSize,lBold,lItalic,lUnderline)Retorna o tamanho da fonte.
cFont
Fonte a ser considerada no clculo
nFontSizeTamanho da fonte
lBold
Aponta se a fonte negrita
lItalic
Aponta se a fonte itlica
lUnderlineAponta se a fonte sublinhada
Retorno Array com informaes do tamanho da fonte. Elementos: 1-Fonte, 2-Tamanho, 3-Tamanho em pixelGetFunction(uFunction)Retorna objeto da classe TRFunction (totalizadores).
uFunctionTipo Caracter: Nome da Function
Tipo Numrico: ndice do objeto segundo a ordem de criao dos componentes TRFunction
RetornoObjeto da classe TRFunction (totalizadores)
GetOrder()Retorna a ordem de impresso selecionada.
RetornoOrdem selecionada
GetOrientation()Retorna a orientao de pgina (Retrato ou Paisagem) selecionada pelo usurio.
Retorno1=Retrato ou 2=Paisagem
GetParam()Retorna a pergunta ou bloco de cdigo utilizado como parmetros do relatrio.
GetPassword()No utilizado.
GetWidth()Retorna a largura da pgina.
HideFooter()Define que no ser impresso o rodap padro da pgina.
HideHeader()Define que no ser impresso o cabealho padro da pgina.
HideParamPage()Define se ser permitida a alterao dos parmetros do relatrio.
IncMeter(nInc)Incrementa a rgua de progresso do relatrio.
nInc
Quantidade a incrementar na rgua. Padro: 1
IncRow(nInc)Incrementa linhas na impresso.
nInc
Quantidade de linhas que devero ser incrementadas
RetornoLinha atualizada.
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.
LeftMargin(lPixel,lForce)Retorna o tamanho da margem esquerda do relatrio.
lPixel
Considera clculo em pixel
lForce
Fora o reclculo da margem esquerda
RetornoTamanho da margem esquerda
Line(nTop,nLeft,nBottom,nRight,oPen)Desenha uma linha, utilizando as especificaes da classe TPen.
nTop
Linha no qual inicia o desenho da linha
nLeft
Coluna no qual inicia o desenho da linha
nBottomLinha no qual finaliza o desenho da linha
nRight
Coluna no qual finaliza o desenho da linha
oPen
Objeto da classe TPen
LineHeight()Retorna a altura da linha.
RetornoAltura da linha
LoadDefault()Carrega o relatrio padro para personalizao.
LoadLayout(cLayout)Carrega um layout customizado para impresso.cLayoutLayout a ser carregado
New(cReport,cTitle,uParam,bAction,cDescription,lLandscape,uTotalText,lTotalInLine,cPageTText,lPageTInLine,lTPageBreak,nColSpace)Mtodo construtor da classe TReport.
cReportNome do relatrio. Exemplo: MATR010
cTitle
Ttulo do relatrio
uParamParmetros do relatrio cadastrado no Dicionrio de Perguntas (SX1)
Tambm pode ser utilizado bloco de cdigo para parmetros customizados.
bActionBloco de cdigo que ser executado quando o usurio confirmar a impresso do relatrio
cDescriptionDescrio do relatrio
lLandscapeAponta a orientao de pgina do relatrio como paisagem
uTotalTextTexto do totalizador do relatrio, podendo ser caracter ou bloco de cdigo
lTotalInLineImprime as clulas em linha
cPageTTextTexto do totalizador da pgina
lPageTInLineImprime totalizador da pgina em linha
lTPageBreakQuebra pgina aps a impresso do totalizador
nColSpaceEspaamento entre as colunas
RetornoObjeto
NoUserFilter()Desabilita a utilizao de filtros na personalizao do relatrio.
NoCell()Verifica a existncia de seo sem clulas.
Retorno Lgico
NoPrint()Retorna se no foram impressos registros.
RetornoLgico
OnPageBreak(bOnPageBreak,lOnPageBreak)Atualiza a propriedade bOnPageBreak utilizada para tratamentos na inicializao de cada pgina.
bOnPageBreak
Bloco de cdigo para tratamentos na inicializao de cada pginalOnPageBreak
Cabealho das sees impressas aps a quebra de pgina
Page()Retorna o nmero da pgina atual na impresso.
PageBreak()Retorna se existe quebra de pgina.
RetornoLgico
PageHeight(lHeaderDiff)Retorna a altura da pgina baseado no tamanho da folha (A4, Carta, etc), conforme seleo do usurio.
lHeaderDiffDesconsidera o tamanho reservado para impresso do cabealho
PageTotalBefore()Define se o total da pgina ser impresso antes do total geral do relatrio.
PageTotalInLine(lTotalInLine)Define se o total da pgina ser impresso em linha ou coluna.
lTotalInLineSe verdadeiro ser impresso em linhaPageTotalText(cText)Define o texto do totalizador da pgina.
cText
Texto do totalizador da pginaPageWidth()Retorna a largura da pgina baseado no tamanho da folha (A4, Carta, etc), conforme seleo do usurio.
ParamReadOnly(lParamReadOnly)Define se o usurio ter acesso aos parmetros do relatrio.
lParamReadOnly.T. No permite acesso aos parmetros
.F. Permite acesso aos parmetros
Preview()Apresenta a visualizao do relatrio antes da impresso fsica.
Print(lDlg)Executa a impresso do relatrio conforme o bloco de cdigo da propriedade bAction.
lDlg
Aponta se dever apresentar a tela de configurao do relatrio ou se imprime
em segundo plano.
PrintCollection(lPrintHeader,lFinish)Imprime os totalizadores do tipo Collections.
lPrintHeaderImprime cabealho da seo
lFinish
Aponta que o encerramento do relatrio
RetornoLgico. Se verdadeiro, o total foi impresso
PrintDialog(bAction)Exibe a tela de configurao para a impresso do relatrio.
bActionBloco de cdigo que ser executado quando usurio confirmar a impresso do relatrio
Retorno Lgico
PrintFooter()Imprime o rodap do relatrio.
PrintFunction(lPrintHeader)Imprime os totalizadores do tipo TRFunctions.
lPrintHeader Imprime cabealho da seo
PrintGraphic()Imprime os grficos do relatrio.
PrintHeader(lHeaderSection,lPage)Imprime o cabealho padro do relatrio.
lHeaderSectionImprime cabealho da seo
lPage
Imprime Informaes sobre a pgina, como por exemplo, nmero da pgina
Printing()Retorna se relatrio esta em processo de impresso.
O status de impresso definido pelos mtodos Init(), que indica o incio da impresso, e o mtodo Finish, que indica a finalizao.
PrintSHeader()Imprime o cabealho da seo.PrintText(cText,nRow,nCol,nClrText,cStyle,nCells,lUpdateRow)Imprime um texto no relatrio.
cText
Texto que ser impresso
nRow
Linha em que o texto ser impresso. Caso no informada, ser considerada a
linha posicionada na impresso
nCol
Coluna em que o texto ser impresso. Caso no informada, ser considerada a
coluna posicionada na impresso
nClrTextCor do texto
cStyle
Utilizado internamente para gerao do relatrio em planilha
nCells
Utilizado internamente para gerao do relatrio em planilha
lUpdateRowAtualiza o posicionamento da linha quando informado o parmetro nRow
PrintTHeader(nWidth,nCells)Imprime o cabealho dos totalizadores.
nWidth
Largura do cabealho
nCells
Quantidade de clulas considerada na gerao em planilha
PrintTotal(lFinish)Imprime os totalizadores do relatrio.
lFinish
Aponta que o fim do relatrio
RetornoSe verdadeiro, os totalizadores foram impressos
PrtCenter(cText)Imprime um texto centralizado.
cText
Texto a ser centralizado
PrtLeft(cText)Imprime um texto esquerda.
cText
Texto a ser impresso esquerda
PrtLogo()Imprime o logo da empresa/filial.
PrtRight(cText)Imprime um texto direita.
cText
Texto a ser impresso direita
ReportName()Retorna o nome do relatrio. Exemplo: MATR010.
Row()Retorna a linha posicionada na impresso.
SaveAsHTML()Salva o relatrio em HTML.
SaveDefault()Salva o relatrio padro sem as customizaes do usurio.Say(nRow,nCol,cText,oFont,nWidth,nClrText,nBkMode,nPad)Imprime um texto no relatrio.
nRow
Linha para impresso do texto
nCol
Coluna para impresso do texto
cText
Texto que sera impresso
oFont
Objeto da classe TFont
nWidth
Tamanho em pixel do texto para impresso
nClrTextCor da fonte
nBkModeCompatibilidade No utilizado
nPad
Compatibilidade No utilizado
SayBitmap(nRow,nCol,cBitmap,nWidth,nHeight,nRaster)Imprime uma imagem no relatrio.
nRow
Linha para impresso da imagem
nCol
Coluna para impresso da imagem
cBitmapNome da imagem, podendo ser path de um arquivo ou resource compilado no
repositrio
nWidth
Largura da imagem
nHeightAltura da imagem
nRasterCompatibilidade No utilizado
Section()Retorna objeto da classe TRSection (seo).
uSectionTipo Caracter: Ttulo da seo
Tipo Numrico: ndice da seo segundo a ordem de criao dos componentes TRSection
SendMail()Envia o relatrio atravs do e-mail.
SendToPrinter()Direciona o relatrio para o tipo de impresso selecionada.
SetAction(bAction)Define o bloco de cdigo que ser executado ao usurio confirmar a impresso do relatrio.
bActionBloco de cdigo que ser executado na confirmao
SetBorder(uBorder,nWeight,nColor,lHeader)Define as bordas do relatrio.uBorderTipo Caracter: "TOP","BOTTOM","LEFT","RIGHT",ALL
Tipo Numrico: 1-Superior,2-Inferior,3-Esquerda,4-Direita,5-Todas
nWeightLargura da borda
nColor
Cor da borda
lHeaderAponta se borda de cabealho
RetornoObjeto do tipo TRBorder
SetClrBack(nClrBack)Define a cor de fundo do relatrio.
nClrBackNmero da cor de fundo no format RGB
SetClrFore(nClrFore)Define a cor da fonte do relatrio.
nClrForeNmero da cor da fonte no format RGB
SetCol(nCol)Define a coluna de impresso.
SetColSpace(nColSpace,lPixel)Define o espaamento entre as colunas.
nColSpaceTamanho do espaamento
lPixel
Aponta se o tamanho ser calculado em pixel
SetCustomText(uCustomText)Define que a impresso do cabealho padro ser customizado.uCustomTextTipo Array: Array contendo a customizao para impresso do cabealho padro.
Elementos: 1=Texto a ser impresso, no qual, um elemento por linha. Existem algumas strings que pode auxiliar na criao do cabealho:
__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
Tipo Bloco de cdigo: Contendo Informaes para gerao do array descrito acima
SetDescription(cDescription)Define a descrio detalhada do relatrio.
cDescriptionDescrio do relatrio
SetDevice(nDevice)Define o tipo de impresso selecionado. Opes: 1-Arquivo,2-Impressora,3-email,4-Planilha e 5-Html.nDeviceTipo de impresso selecionada
SetDynamic()Define que o relatrio ser do tipo dinmico, no qual, permite imprimir as sees conforme a ordem de impresso selecionada.SetEdit(lEdit)Define se o relatrio poder ser configurado pelo usurio no caso de verdadeiro.
SetEnvironment(nEnv)Define o ambiente para impresso.
nEnv
Ambiente: 1-Server e 2-Cliente
SetFile()Define o nome do arquivo temporrio utilizado para gerao dos relatrios.
SetLandscape()Define orientao de pgina do relatrio como paisagem.
SetLeftMargin(nLeftMargin)Define a margem esquerda do relatrio.
nLeftMarginTamanho da margem esquerda
SetLineHeight(nLineHeight)Define a altura da linha na impresso.
nLineHeightAltura da linha
SetLogo()Define o logo da empresa na impresso do cabealho padro.
SetMeter(nTotal)Define o limite da rgua de progresso do relatrio.
nTotal
Limite da rgua
SetMsgPrint(cMsg)Define a mensagem apresentada durante a gerao do relatrio.
cMsg
Texto da mensagem
SetOnPageNumber(bOnNumberPage)Define o bloco de cdigo utilizado para manipular o nmero da pgina atual.
SetPageNumber(nPage)Define o nmero da pgina atual.
SetPageFooter(nLinesFooter,bPageFooter,lFooterBefore)nLinesFooterLinhas reservada para impresso do rodap
bPageFooterBloco de cdigo utilizado para imprimir Informaes customizadas, no qual,
dever ser utilizado mtodos do TReport para impresso. Exemplo: Say,
PrintText.
lFooterBeforeImprime rodap antes dos totalizadores
SetParam(uParam)Define os parmetros que sero utilizados pelo usurio.
uParamParmetros do relatrio cadastrado no Dicionrio de Perguntas (SX1).
Tambm pode ser utilizado bloco de cdigo para parmetros customizados
SetPortrait()Define orientao de pgina do relatrio como retrato.
SetPreview()Define se ser apresentada a visualizao do relatrio antes da impresso fsica.
SetPxLeftMargin(nPxLeftMargin)Define a margem esquerda em pixel do relatrio.
nPxLeftMarginTamanho da margem esquerda em pixel
SetRow()Define a linha de impresso.
SetStartPage(lStartPage)Define que dever ser gerada uma nova pgina no relatrio.
lStartPageSe verdadeiro, aponta a necessidade de uma nova pgina
SetTitle(cTitle)Define o ttulo do relatrio.
cTitle
Ttulo do relat
SetTotalInLine(lTotalInLine)Define se os totalizadores sero impressos em linha ou coluna.
SetTotalPageBreak(lTPageBreak)Define que ser quebrada pgina aps a impresso do totalizador.
lTPageBreakSe verdadeiro, aponta a quebra de pgina aps a impresso do totalizador
SetTotalText(uText)Define o texto que ser impresso antes da impresso dos totalizadores.
uText
Texto a ser impresso no formato caracter ou bloco de cdigo
ShowFooter()Define que ser impresso o rodap do relatrio.
ShowHeader()Define que ser impresso o cabealho do relatrio.
ShowParamPage()Define que ser impressa a pgina de parmetros do relatrio.
SkipLine(nSkip)Salta linhas na impresso.
nSkip
Quantidade de linhas a serem saltadas
StartPage()Inicializa uma nova pgina para impresso.
ThinLine()Desenha uma linha simples, iniciando posio da linha atual de impresso com a largura da pgina.
Title()Retorna o ttulo do relatrio.
TotalText()Retorna o texto que ser impresso no totalizador geral do relatrio.
TotalInLine()Retorna se a impresso dos totalizadores ser em linha.
XmlLoad(cXml)Carrega um layout personalizado pelo usurio.
cXml
Arquivo do tipo XML com as personalizaes do usurio
XmlSave()Salva um layout personalizado pelo usurio.
XlsNewCell(c,lIndex,nCol,cStyle,nCells,nWidth,cType)Adiciona uma clula na gerao em planilha.
c
Informao a ser inserido na clula
lIndex
Controla numerao de colunas na planilha
nCol
Coluna posicionada
cStyle
Estilo da clula
nCells
Quantidade de clulas utilizadas para a informao ( Mesclar )
nWidth
Largura da clula
cType
Tipo de dado. C-Caracter, N-Numrico, L-Lgico
XlsNewCol(nCol,nWidth)Adiciona uma coluna na gerao em planilha.
nCol
Coluna posicionada
nWidth
Largura da coluna
XlsNewRow(lIncRow)Adiciona uma linha na gerao em planilha.
lIncRowAponta se dever ser adicionada uma linha
XlsNewStyle(cID,cName,nAlign,aFont,aBorder,lWrapText,cType)Cria um estilo para utilizar nas criaes das clulas.
cID
ID do estilo
cName
Nome do estilo
nAlign
Tipo de alinhamento. 1-Esquerda, 2-Centralizado e 3-Direita
aFont
Array contendo a fonte. Elementos: 1-Fonte e 2-Tamanho
aBorderArray contendo a borda. Elementos: 1-Bottom,Left,Right,Center e 2=Largura da borda
lWrapTextAponta quebra de linha automtica
cType
Tipo de dado. C-Caracter, N-Numrico, L-Lgico
XlsSave()Compatibilidade No utilizado.
TRSECTIONSeo de um relatrio que utiliza a classe TReport.
A classe TRSection pode ser entendida como um layout do relatrio, por conter clulas, quebras e totalizadores que daro um formato para sua impresso.
Com a classe TRSection possvel definir uma query, filtro ou ndice com filtro (IndRegua) que ser utilizada por ela para processamento do relatrio, atravs do mtodo Print e utilizando as clulas de posicionamento (TRPosition) e componente de posicionamento de seo (TRPosSection), sem a necessidade de escrever um fonte para processar os resultados da query, filtro ou ndice com filtro.
Esta classe herda as propridades e mtodos da classe TREPORT.
PropriedadesaCell
Array contendo as clulas da seo. Elemento: 1-Objeto TRCell.
aCellPos
Array contendo as clulas reposicionadas da seo. Elemento: 1-Objeto
TRCell.
aFilter
Array contendo os filtros da seo: Elementos: 1-Tabela, 2-Filtro, 3- Chave de ndice, 4-Ordem.
aOrder
Array contendo as ordens do relatrio: Elementos: 1-Objeto TROrder.
aPosCell
Array com as clulas da seo na ordem de impresso.
aTable
Array com as tabelas utilizadas na seo.
aTCFieldsArray com os campos que possuem o tipo de dados diferente de caracter e que devem ser tratados para apresentar os resultados na query. Elementos: 1-Campo, 2-Tipo, 3- Tamanho e 4-Decimal.
aTCMemo
Array com os campos do tipo de dados Memo a serem desconsiderados na query.
aTCTables
Array com as tabelas utilizadas na query.
aLoadCellsArray com as tabelas que executaram o carregamento de Informaes das clulas atravs do Dicionrio de Dados (SX3).
aUserFilterArray com os filtros de usurios: Elementos: 1-Tabela, 2-Expresso ADVPL, 3-Expresso SQL e 4-Filtro adicionado na query principal.
aNoFilter
Array com as tabelas que no podero aplicar filtros de usurio. Elemento: 1-Tabela.
aSection
Array com as sees filhas. Elemento: 1-Objeto TRSection.
bCompQueryBloco de cdigo utilizado na montagem da query atravs de compilao em tempo real.
bLineConditionBloco de cdigo utilizado na validao do registro.
bOnPrintLineBloco de cdigo com os tratamentos a serem realizados antes da impresso do registro da seo.
bParentFilter
Bloco de cdigo com a regra para sada do loop.
bParentParamBloco de cdigo com a expresso que retorna o valor que enviado como parmetro para a regra de sada do loop da seo.
bRealQuery
Bloco de cdigo utilizado para montar a query da seo.
cAlias
Tabela principal da seo.
cAdvplExp
Filtro do usurio em forma de expresso ADVPL.
cDynamicKey
Chave que identifica a seo na impresso dinmica.
cFilter
Filtro da tabela principal da seo.
cIdxFile
Indice temporrio utilizado na filtro da tabela principal.
cName
Nome da seo.
cQuery
Query da seo com os tratamentos de adio de campos e filtros.
cRealFilter
Filtro da tabela principal da seo.
cRealQuery
Query sem os tratamentos de adio de campos e filtros.
cCharSeparatorCaracter que separa as Informaes na impresso em linha.
cSqlExp
Filtro do usurio em forma de expresso SQL.
lAutoSize
Ajusta o tamanho das clulas para que caiba em uma pgina.
lCellPos
Ajusta o cabealho das clulas.
lChangeQuery
Tratamento para utilizar a query em diversos Banco de Dados.
lChkFilters
Compatibilidade No utilizado.
lEdit
Aponta se a seo poder ser personalizada pelo usurio.
lEditCell
Aponta se o usurio poder personalizar as clulas da seo.
lForceLineStyleFora a impresso em linha.
lHeaderBreak
Imprime cabealho da seo na quebra de impresso (TRBreak).
lHeaderPage
Imprime cabealho da seo no topo da pgina.
lHeaderSectionImprime cabealho da seo na quebra de seo.
lIdxOrder
Utiliza ordem do Dicionrio de ndices (SIX) na impresso da seo.
lInit
Aponta que a impresso da seo no foi iniciada.
lInitFilter
Aponta que os filtros da seo no foram iniciados.
lLineBreakAponta que a impresso da seo quebra linhas no caso das colunas no couberem em uma linha.
lLineStyle
Impresso em linhas.
lSkipped
Aponta que a seo saltou o registro da seo pai.
lParentQuery
Utiliza Informaes da query da seo pai para impresso dos registros.
lParentRecno
Utiliza Informaes do registro da seo pai.
lPrintHeader
Aponta impresso do cabealho da seo.
lPrintLayout
Aponta que impresso de visualizao do layout.
lReadOnly
Define se o usurio pode personalizar informaes da seo.
lTCFieldsDefine que dever ser efetuado tratamento na query de campos com tipo de dado diferente de caracter.
lVisible
Aponta que a seo ser impressa.
lUserVisible
Aponta que a seo ser impressa na personalizao do usurio.
lCellUseQuery
Utiliza query na impresso de clulas da seo.
nCols
Quantidade de colunas a serem impressas.
nIdxOrder
Indice utilizado na impresso da seo.
nLineCount
Quantidade de linhas a serem impressas para o registro.
nLinesBefore
Quantidade de linhas a serem saltadas antes da impresso da seo.
nOrder
Ordem de impresso da seo.
nPercentage
Percentual da largura da pgina a ser considerada.
nRow
Linha posicionada na impresso da seo.
nWidth
Largura da seo.
oCBrdBottom
Objeto TRBorder com a borda Inferior.
oCBrdLeft
Objeto TRBorder com a borda esquerda.
oCBrdRight
Objeto TRBorder com a borda direita.
oCBrdTop
Objeto TRBorder com a borda superior.
oParent
Seo pai.
oRelation
Objeto TRRelation com informaes do relacionamento entre as sees.MTODOSAddCell(oCell)Adiciona a clula na propriedade aCell da seo.oCell
Objeto TRCell
AddOrder(oOrder)Adiciona a ordem da seo na propriedade aOrder.
oOrder
Objeto TROrder
AddPosCell(oCell)Adiciona a clula, na sequncia de impresso da seo, na propriedade aPosCell.oCell
Objeto TRCell
AddTable(cTable)Adiciona a tabela, que ser utilizada na impresso da seo, na propriedade aTable.
cTable
Tabela utilizada na impresso da seoAlias()Retorna o alias da tabela utilizado pela query da seo, definida pelo Embedded SQL com os mtodos BeginQuery e EndQuery.
RetornoAlias da tabela posicionada
AutoSize()Retorna se a impresso da seo ser ajustada automaticamente.
RetornoSe verdadeiro, ajusta automaticamente a impresso das clulas da seoBeginQuery()Indica que ser utilizado o Embedded SQL para criao de uma query para a seo.Cell(uCell)Retorna o objeto da classe TRCell (clula) baseado.
uCell
Tipo Caracter: Nome ou ttulo do objeto
Tipo Numrico: ndice do objeto segundo a ordem de criao dos componentes
TRCell
RetornoObjeto da classe TRCell
CellBorder(uBorder,lHeader)Retorna a borda da seo.uBorderTipo Caracter: "TOP","BOTTOM","LEFT","RIGHT",ALL
Tipo Numrico: 1-Superior,2-Inferior,3-Esquerda,4-Direita,5-Todas
lHeaderBorda do cabealho
RetornoObjeto do tipo TRBorder
CellPos(lReset)Ordena as clulas para impresso.
lReset
Fora a inicializao do tamanho das clulas
CharSeparator()Retorna o caracter que separa as Informaes na impresso das clulas em linha.
RetornoCaracter utilizado para separar as informaes
CheckFields(aTables,aMemo,lEnabled,aHasArea,nTotCell,cSelect)Retorna as clulas que podero ser adicionadas na query, ou seja, retira os campos do tipo Memo e as clulas que no foram selecionadas pelo usurio.
aTablesTabelas utilizadas na query
aMemoCampos memo da tabela
lEnabledDefine se considera as clulas selecionadas pelo usurio
aHasAreaValida se as tabelas utilizadas na query so padro do sistema
nTotCellQuantidade maxima de clulas a serem consideradas
cSelectTexto contendo a select da query
RetornoCampos a serem considerados na query
ChkMainFilter(cAlias)Retorna o filtro da tabela.
cAlias
Tabela que contm o filtro
RetornoFiltro da tabela
ChkTcMemo(aTables,aMemo)Retorna os campos do tipo Memo das tabelas.
aTablesTabelas a serem verificadas
aMemoArray contendo os campos do tipo Memo
Retorna Array contendo os campos do tipo Memo
CheckWidth(nWidth)Retorna a largura da seo.
nWidthCaso a largura da seo for inferior a largura informada, a seo assume a informada no parmetro
RetornoLargura da seo
CloseFilter()Finaliza todos os filtros da seo.
CloseQuery(lSections)Finaliza todas as querys da seo.
lSectionsFinaliza as querys de todas sees
DelUserCell()Exclui as clulas adicionadas pelo usurio.
EndQuery(aParam)Indica a query criada utilizando o Embedded SQL para a seo.
O mtodo EndQuery ira juntar na query as clulas selecionadas e o filtro criado pelo usurio, mais a expresso das perguntas do tipo Range, que foram convertidas anteriormente pela funo MakeSQLExpr.
Aps sua execuo, a query esta pronta para ser utilizada tanto pela classe TRSection como para o programa que esta criando os componentes, sem a necessidade de utilizar TCGenQuery, ChangeQuery e TCSetField.
aParamTipo Caracter: Pergunta. Exemplo: mv_par01 do tipo Range
Tipo Array: Lista de perguntas. Exemplo: {mv_par01, mv_par02} do tipo Range
EndBorder()Finaliza a impresso das bordas.
EvalCell()Atualiza o contedo de todas as clulas da seo.
EvalFunction()Atualiza o contedo dos totalizadores da seo.
EvalPosition()Atualiza o contedo das clulas utilizadas na impresso da seo.
ExecSql()Executa a query da seo.
ExUserFilter()Executa os filtros definidos pelo usurio.
RetornoRetorno da execuo do filtro ( Verdadeiro ou Falso )
Finish()Finaliza a impresso da seo, imprime os totalizadores, tratamentos de quebras das sees, 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.
ForceLineStyle()Fora a impresso da seo em linhas.
GetAdvplExp(cAlias)Retorna o filtro do usurio em forma de expresso ADVPL.
cAlias
Tabela a ser consultada
RetornoFiltro do usurio em forma de expresso ADVPL
GetDynamicKey()Retorna a chave dinmica utilizada para gerao de relatrios dinmicos.
RetornoChave dinmicaGetIdxOrder()Retorna o ndice utilizado pela tabela principal da seo.
Retorno ndice utilizado pela tabela principal
GetOrder()Retorna a ordem selecionada.
RetornoOrdem selecionada pelo usurioGetParentQuery()Atualiza as Informaes de query da seo atual com as Informaes da seo pai.
GetQuery()Retorna a query, que foi definida pelo Embedded SQL com os mtodos BeginQuery e EndQuery, com as clulas selecionadas, o filtro criado pelo usurio e as perguntas do tipo Range inclusas.
RetornoString com a query
GetSqlExp()Retorna o filtro do usurio em forma de expresso SQL.
cAlias
Tabela a ser consultada
RetornoFiltro do usurio em forma de expresso SQL
GetUseQuery()Retorna se a seo utiliza query para impresso.
Retorno Se verdadeiro, a query utilizada para impresso
GetUserExp()Retorna o filtro de usurio.
RetornoFiltro do usurio
GetUserFilter()Retorna os filtros de usurio.
RetornoArray contendo os filtros da seo
GetWidth()Retorna a largura da seo.
RetornoLargura da seo
HeaderBreak()Retorna se o cabealho das clulas ser impresso aps uma quebra (TRBreak).
RetornoSe verdadeiro, aponta que ser impresso o cabealhoHeaderSection()Retorna se o cabealho das clulas ser impresso na quebra de seo.
RetornoSe verdadeiro, aponta que ser impresso o cabealho
Hide()Desabilita a impresso da seo, porm todas as linhas sero processadas, somente no aparecero no relatrio.
Init()Executa as quebras de sees, imprime cabealhos entre outras configuraes 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.
IniRow()Inicializa a linha posicionada nas sees.
LineCount()Quantidade de linhas a serem impressas para cada registro da seo.
Retorno Quantidade de linhas a serem impressas
LoadCells(cTable,aCells,lDisableAll,lMarkAsUser)Carrega campos do Dicionrio de Campos (SX3) como clulas da seo, respeitando nvel, uso e contexto do campo.
cTableTabela que ser utilizada para carregar os campos. Se no for informada ser utilizada todas as tabelas informadas no mtodo New
aCells
Array com nomes dos campos que sero carregados como clulas da seo
lDisableAllDesabilita todas as clulas
lMarkAsUserAponta que as clulas foram definidas pelos usurios
LoadOrder()Carrega ndices do Dicionrio de ndices (SIX) como ordem da seo.
lReadOnly()Retorna se o usurio pode personalizar informaes da seo.
Objeto
Caso verdadeiro, aponta que o usurio no pode alterar informaes da seo
Name()Retorna o nome da seo.
Retorno Nome da seoNew(oParent,cTitle,uTable,aOrder,lLoadCells,lLoadOrder,uTotalText,lTotalInLine,lHeaderPage,lHeaderBreak,lPageBreak,lLineBreak,nLeftMargin,lLineStyle,nColSpace,lAutoSize,cCharSeparator,nLinesBefore,nCols,nClrBack,nClrFore,nPercentage)Mtodo construtor da classe TRSection.
No parmetro onde informado as tabelas utilizadas pela seo, a primeira ser a principal, sendo utilizada para o processamento pelo mtodo Print. As outras tabelas sero utilizadas para que o usurio possa incluir os campos como clula.
O relacionamento entre as tabelas poder ser feito pela query ou ento pelo uso dos objetos da classe TRPosition.
Dos elementos do parmetro onde so informadas as ordens utilizada pela seo sero criados os objetos da classe TROrder automaticamente, utilizando como ndice da tabela principal a ordem do elemento no vetor.
oParentObjeto da classe TReport ou TRSection que ser o pai da classe TRSection
cTitle
Ttulo da seouTable
Tipo Caracter: Tabela que ser utilizada pela seo
Tipo Array: Lista de tabelas que sero utilizadas pela seoaOrderArray contendo a descrio das ordens. Elemento: 1-Descrio, como por exemplo, Filial+Cdigo
lLoadCellsCarrega os campos do Dicionrio de Campos (SX3) das tabelas da seo como clulas
lLoadOrderCarrega os ndices do Dicionrio de ndices (SIX)
uTotalTextTexto do totalizador da seo, podendo ser caracter ou bloco de cdigo
lTotalInLineImprime as clulas em linha
lHeaderPageCabealho da seo no topo da pgina
lHeaderBreakImprime cabealho na quebra da seo
lPageBreakImprime cabealho da seo na quebra de pgina
lLineBreakQuebra a linha na impresso quando as Informaes no caber na pgina
nLeftMarginTamanho da margem esquerda da seo
lLineStyleImprime a seo em linha
nColSpaceEspaamento entre as colunas
lAutoSizeAjusta o tamanho das clulas para que caiba em uma pgina
cCharSeparatorDefine o caracter que separa as Informaes na impresso em linha
nLinesBeforeAponta a quantidade de linhas a serem saltadas antes da impresso da seo
nCols
Quantidade de colunas a serem impressas
nClrBackCor de fundo das clulas da seo
nClrForeCor da fonte das clulas da seo
nPercentageTamanho da pgina a ser considerada na impresso em percentual
NoCell()Verifica se no existem clulas configuradas para a seo.
RetornoSe verdadeiro, no existem clulas configuradas
OnPrintLine(bOnPrintLine)Permite efetuar tratamentos antes da impresso do registro da seo.
bOnPrintLineBloco de cdigo com os tratamentos a serem realizados antes da impresso do
registro da seo
Order(uOrder)Retorna objeto da classe TROrder (ordem).
uOrder
Tipo Caracter: Nickname da ordem
Tipo Numrico: ndice do objeto segundo a ordem de criao dos componentes
TROrder
RetornoObjeto da classe TROrder
PageBreak()Retorna se salta a pgina na quebra de seo.
RetornoSe verdadeiro, aponta que quebra pgina na seo
PageWidth()Retorna a largura da pgina.
Retorno Largura da pgina
Parent()Retorna o objeto pai da classe TRSection.
RetornoObjeto TRSection ou TReport
Print(lFromParent)Realiza a impresso baseada na tabela ou query principal, executando o mtodo PrintLine para cada linha e o mtodo Print de todas as sees filhas. Nas sees filhas, o posicionamento inicial pode ser baseado na query da seo pai (atravs do mtodo SetParentQuery) ou atravs da regra informada pelo mtodo SetRelation, junto com a regra informada pelo mtodo SetParentFilter que controla o fim da impresso.
lFromParentAponta que impresso de uma seo filha
PrintHeader(lCellPos,lVisible,cStyle,lExcel)Imprime o cabealho da seo.
lCellPosAjusta o cabealho das clulas
lVisible
Aponta que a seo est habilitada para impresso
cStyle
Utilizado internamente para gerao do relatrio em planilha
lExcel
Gerao em planilha
PrintLine(lEvalPosition,lParamPage,lExcel)Imprime a linha baseado nas clulas existentes.
lEvalPositionFora a atualizao do contedo das clulas
lParamPageAponta que a impresso da pgina de parmetros
lExcel
Aponta que gerao em planilha
ResetCellPos(lResetAll)Define que as clulas devero ser ajustadas para impresso.
lResetAllReavalia o posicionamento das clulas
Report()Retorna o objeto da classe TReport que a classe TRSection pertence.
RetornoObjeto TReport
SetAutoSize(lAutoSize)Define que as clulas sero ajustadas automaticamente na seo.
lAutoSizeAjuste automtico das clulas
SetCellBorder(uBorder,nWeight,nColor,lHeader)Define a borda da seo.uBorderTipo Caracter: "TOP","BOTTOM","LEFT","RIGHT",ALL
Tipo Numrico: 1-Superior,2-Inferior,3-Esquerda,4-Direita,5-Todas
nWeightLargura da borda
nColor
Cor da borda
lHeaderBorda do cabealho
RetornoObjeto do tipo TRBorder
SetCharSeparator(cCharSeparator)Retorna o caracter que separa as Informaes na impresso das clulas em linha.
cCharSeparatorCaracter utilizado para separar as informaes
SetCols(nCols)Define a quantidade de colunas a serem impressas.
nColsQuantidade de colunas a serem impressas
SetDynamicKey(cDynamicKey)Define a chave que identifica a seo na impresso dinmica.
cDynamicKeyChave que identifica a seo na impresso dinmica
SetEdit(lEdit)Define se a seo poder ser personalizada pelo usurio.
lEditSe verdadeiro, o usurio poder personalizar a seo
SetEditCell(lEditCell)Define se o usurio poder personalizar as clulas da seo.
lEditCellSe verdadeiro, o usurio poder personalizar as clulas
SetFilter(cFilter,cIndexKey,cOrdem,cAlias,nIdxOrder)Define um filtro para a tabela principal da seo.
Se no informado o parmetro com a chave de ndice, ser executado SET FILTER TO com o primeiro parmetro, seno ser criado um ndice com filtro (IndRegua).
cFilter
Expresso do filtro no format ADVPL
cIndexKeyChave de ndice
cOrdemOrdem para a criao do ndice
cAlias
Tabela a ser filtrada
nIdxOrderOrdem no Dicionrio de ndices (SIX)
SetHeaderBreak(lHeaderBreak)Define se imprime cabealho das clulas aps uma quebra (TRBreak).
lHeaderBreakSe verdadeiro, aponta que salta pgina na quebra
SetHeaderPage(lHeaderPage)Define que imprime cabealho das clulas no topo da pgina.lHeaderPageSe verdadeiro, aponta que imprime o cabealho no topo da pgina
SetHeaderSection(lHeaderSection)Define que imprime cabealho das clulas na quebra de seo.lHeaderSectionSe verdadeiro, aponta que imprime cabealho na quebra da seoSetIdxOrder(nIdxOrder)Define uma ordem de ndice para a tabela principal.
nIdxOrderOrdem de ndice para a tabela principal
SetLineBreak(lLineBreak)Define que a impresso poder ocorrer em uma ou mais linhas no caso das colunas excederem o tamanho da pgina.
lLineBreakSe verdadeiro, imprime em uma ou mais linhas
SetLineCondition(bLineCondition)Permite validar a impresso do registro.
bLineConditionBloco de cdigo utilizado na validao
SetLineStyle(lLineStyle)Define se imprime as clulas da seo em linhas.
lLineStyleImprime as clulas da seo em linhas
SetLinesBefore(nLinesBefore)Define a quantidade de linhas que sero saltadas antes da impresso da seo.
nLinesBefore Quantidade de linhas
SetName()Compatibilidade No utilizado.
SetNoFilter(cAlias)Define que a tabela no poder receber filtros de usurio.
cAlias
Tabela a ser considerada
SetUseQuery(lCellUseQuery)Define que a seo utilize query na impresso.
lCellUseQuerySe verdadeiro, utiliza query na impresso
SetOrder(nOrder)Define a ordem (TROrder) que ser utilizada pela seo.
nOrder
Ordem da seo
SetPageBreak(lPageBreak)Define se salta a pgina na quebra de seo.
lPageBreakSe verdadeiro, aponta que salta pgina na quebra de seo
SetParentFilter(bFilter,bParam)Define a regra de sada do loop de impresso das sees filhas.
bFilter
Bloco de cdigo com a regra para sada do loop
bParamBloco de cdigo com a expresso que retorna o valor que enviado como parmetro para a regra de sada do loop
SetParentQuery()Define que a seo filha utiliza a query da seo pai na impresso da seo.
SetParentRecno(lParentRecno)Define se a seo utiliza o registro da seo pai.
lParentRecnoUtiliza o registro da seo paiSetPercentage(nPercentage)Define o tamanho da pgina a ser considerada na impresso em percentual.
nPercentageTamanho da pgina a ser considerada na impresso em percentual
SetPrintLayout()Compatibilidade No utilizado.SetQuery(cAlias,cQuery,lChangeQuery,aParam,aTCFields)Aplica os tratamentos necessrios para execuo das querys, tais como, adicionar clulas de usurios, aplicao de filtros entre outros.
cAlias
Tabela principal da query
cQuery
Query da seo
lChangeQuerySe verdadeiro, realiza tratamentos para outros bancos de dados
aParamParmetros do tipo Range a serem utilizados no filtro da query
aTCFieldsLista de campos com tipo de dados diferente de character que devem ser tratados para apresentar os resultados na query. Elementos: 1-Campo, 2-Tipo, 3- Tamanho e 4-Decimal
SetReadOnly(lReadOnly)Define que o usurio no poder alterar informaes da seo, ou seja, no poder remover as clulas pr-definidas.
lReadOnlySe verdadeiro, aponta que o usurio no poder alterar Informaes da seo
SetRelation(bFormula,cAlias,uOrder,lSeek)Define a frmula de relacionamento de uma seo filha com sua seo pai, caso no utilize a query da seo pai atravs do mtodo SetParentQuery.
bFormulaBloco de cdigo com a expresso para relacionamento entre as sees
cAlias
Tabela utilizada pela frmula
uOrder
Ordem utilizada na tabela
Tipo Caracter: Nickname da ordem de ndice
Tipo Numrico: Ordem do ndice
lSeek
Indica se ser executado DbSeek com o contedo da frmula
SetRow(nRow)Define a linha de impresso.
nRowLinha atual
SetWidth(nWidth)Define a largura da seo.
nWidthLargura da seo
Show()Habilita a impresso da seo.
UseFilter()Retorna se existem clulas personalizadas pelo usurio.
RetornoSe verdadeiro, existe clula personalizada
Visible()Retorna se a seo esta habilitada para impresso.
RetornoCaso verdadeiro, a seo est habilitadaXmlLoad(oXml)Carrega uma seo do layout personalizado pelo usurio.
oXml
Objeto do tipo XML com as personalizaes da seo
XmlSave()Salva a seo no layout personalizado pelo usurio.TRCELLClula de impresso de uma seo (TRSection) de um relatrio que utiliza a classe TReport.Esta classe herda as propridades e mtodos da classe TRSECTION.Propriedades
aCBoxArray com os possveis textos a serem impressos na clula. Elemento: 1- Contedo. Exemplo: 1=Sim.
aFormatCondArray com as condies do usurio para impresso de forma varivel da cor da clula: Elementos: 1-Condio, 2-Cor de fundo e 3-Cor da fonte.
bCanPrint Bloco de cdigo que valida a impresso da clula.
bCellBlockBloco de cdigo que retornar o contedo de impresso da clula.
cFormulaFrmula para impresso da clula.
cOrder
Ordem de impresso da clula.
cPictureMscara da clula.
cRealFormulaFrmula em forma de expresso ADVPL.
cType
Tipo de dado da clula.
cUserFunctionTipo de acumulador: MIN Menor valor, MAX Maior valor, SUM Soma, COUNT Contador ou AVERAGE Mdia.
cXlsHStyleEstilo do cabealho padro utilizado na gerao da planilha.
cXlsStyleEstilo utilizado na gerao da planilha.
lBold
Aponta que a clula ser impressa em negrito.
lHeaderSizeAponta que o tamanho a ser considerado na impresso do cabealho.
lPixelSizeAponta que o tamanho da clula est calculada em pixel.
lPrintCellAponta que a clula est habilitada para impresso.
lCellBreakCompatibilidade No utilizado.
lUserEnabledAponta que a clula foi habilitada para impresso pelo usurio.
lUserFieldAponta que a clula foi personalizada pelo usurio.
lUserAccessAponta que o usurio tem acesso a impresso desta clula, no caso de falso, o usurio no possui o nvel de campo ou acesso definido no cadastro de usurios.
nAlign
Alinhamento da clula. 1-Esquerda, 2-Center ou 3-Direita.
nAutoWidthLargura gerada automaticamente quando excedida a largura da pgina.
nCellPixelLargura da clula em pixel.
nHeaderAlignAlinhamento do cabealho 1-Esquerda, 2-Center ou 3-Direita.
nHeaderPixelTamanho do cabealho da clula em pixel.
nHeaderSizeTamanho do cabealho da clula.
nLineStartAponta a primeira linha da clula a ser impressa no caso de quebra de linha.
nNegativeNmero do item de sinal negativo no array aNegative.
nPixelSizeTamanho da clula em pixel.
nRowDiffQuantidade de linhas a serem consideradas na impresso das bordas.
nSize
Tamanho da clula.
nType
Tipo da clula. 1-Celula, 2-Formula, 3-Acumulador ou 4-Clula de usurio.
nUserValueAuxilia no controle do totalizador do tipo MAX e MIN.
nUserCountContador de itens impressos quando utilizado totalizadores.
nLevel
Nvel de campo da clula.
uValue
Valor da clula a ser impresso.
uPrint
Contedo da clula a ser impresso.
oFontBodyObjeto TFont com Informaes da fonte da clula.
MTODOSCanPrint()Valida se a clula pode ser impressa.
Col()Retorna a coluna da clula.
ColPos()Retorna a coluna que a clula ser impressa pelo mtodo PrintLine da seo que a clula pertence.
RetornoColuna da clula na impresso
CellBreak()Compatibilidade No utilizado.
ClrBack(lObject)Retorna a cor de fundo do relatrio.
lObject
Aponta que deve ser retornado o objeto TBrush
RetornoCaso o parmetro lObjeto seja verdadeiro o retorno ser o objeto TBrush, caso
contrrio ser o nmero da cor RGB.
ClrFore(lPrintHeader)Retorna a cor de fonte do relatrio.
lPrintHeaderAponta impresso do cabealho da clula
RetornoNmero da cor RGBDisable()Desabilita a impresso da clula.Enable()Habilita a impresso da clula.
Enabled()Retorna se a clula est habilitada para impresso.
RetornoSe verdadeiro, a clula est habilitada
EvalFunction()Atualiza o contedo dos totalizadores da seo.
Execute(lPrintLayout)Atualiza o contedo da clula a ser impresso.
lPrintLayoutAponta visualizao de layout
Retorno Contedo a ser impressoGetCBox()Retorna o contedo da lista de dado a ser impresso. Exemplo: 1=Sim ou 2=No.
Retorno Contedo da lista
GetCellSize()Retorna o tamanho da clula.
RetornoTamanho da clula
GetCellWidth()Retorna a largura da clula.
Retorno Largura da clulaGetFieldInfo(cField)Carrega informaes (ttulo, picture, tamanho, etc) do campo baseado no Dicionrio de Campos (SX3).
cField
Campo a ser consultado no dicionrio
RetornoSe verdadeiro, conseguiu coletar informaes do dicionrio
GetHeaderSize()Retorna o tamanho do cabealho da clula.
Retorno Tamanho do cabealho
GetHeaderWidth()Retorna a largura do cabealho da clula.
RetornoLargura do cabealho
GetSize()Retorna o tamanho da clula considerando o maior tamanho entre a clula e o cabealho da clula.
Retorno Tamanho da clula
GetText()Retorna o texto que ser impresso.
Retorno Contedo da clula a ser impresso
GetValue()Retorna o valor a ser impresso na clula.
Retorno Valor da clulaGetWidth(lAutoWidth)Retorna a largura da clula.
lAutoWidthLargura automtica
RetornoLargura da clula
Hide()Desabilita a impresso da clula, porm calcula o posicionamento da clula.
LineCount(lHeader)Quantidade de linhas a serem impressas para a clula.
lHeaderSe verdadeiro, verifica as linhas do cabealho
RetornoQuantidade de linhasNew(oParent,cName,cAlias,cTitle,cPicture,nSize,lPixel,bBlock,cAlign,lLineBreak,cHeaderAlign,lCellBreak,nColSpace,lAutoSize,nClrBack,nClrFore,lBold)Mtodo construtor da classe TRCell.
Se o nome da clula informada for encontrada no Dicionrio de Campos (SX3), as informaes do campo sero carregadas para a clula, respeitando os parmetros de ttulo, picture e tamanho. Dessa forma o relatrio sempre estar atualizado com as informaes do Dicionrio de Campos (SX3).
O nome da clula ser utilizado junto ao alias informado pelo parmetro como contedo para a impresso da clula, como por exemplo a impresso do campo A1_COD da tabela SA1.
Se for informado o parmetro com o bloco de cdigo, o retorno deste ser utilizado como contedo para impresso da clula, com a picture, tamanho e ttulo definidos para a clula. Assim sendo, possvel criar clulas calculadas com formato de impresso baseada no Dicionrio de Campos (SX3)
oParentObjeto da classe TRSection que a clula pertence
cName
Nome da clula
cAlias
Tabela utilizada pela clula
cTitle
Ttulo da clula
cPictureMscara da clula
nSize
Tamanho da clula
lPixel
Aponta se o tamanho foi informado em pixel
bBlock
Bloco de cdigo com o retorno do campo
cAlign
Alinhamento da clula. LEFT, RIGHT e CENTER
lLineBreakQuebra linha se o contedo estourar o tamanho do campo
cHeaderAlignAlinhamento do cabealho da clula. LEFT, RIGHT e CENTER
lCellBreakCompatibilidade No utilizado
nColSpaceEspaamento entre as clulas
lAutoSizeAjusta o tamanho da clula com base no tamanho da pgina e as Informaes impressas
nClrBackCor de fundo da clula
nClrForeCor da fonte da clula
lBold
Imprime a fonte em negrito
Picture()Retorna a mscara de impresso da clula.
RetornoMscara de impresso
Print(lCanPrint,nXlsCol,lExcel)Imprime o contedo da clula.
lCanPrintValida impresso da clula
nXlsColNmero da coluna na gerao em planilha
lExcel
Gerao em planilha
PrintHeader(nSkipLine,lHeaderWidth,cXlsHStyle,lExcel)Imprime o cabealho da clula.
nSkipLineCompatibilidade No utilizado
lHeaderWidthConsidera a largura do cabealho na impresso
cXlsHStyleEstilo do cabealho na gerao em planilha
lExcel
Gerao em planilha
ResetWidth()Inicializa o tamanho e largura da clula.
ResetLineStart()Inicializa a linha que indica a primeira linha da clula a ser impressa no caso de quebra de linha.
Say(cText,nAlign,nSayWidth,lPrintHeader)Imprime um texto na clula ou o contedo da clula.
cText
Texto que ser impresso
nAlign
Alinhamento do texto. 1-Esquerda, 2-Centro ou 3-Direita
nSayWidthLargura do texto
lPrintHeaderImpresso do cabealho
SetAlign(uAlign)Define o alinhamento da clula na impresso.
uAlign
Tipo Caracter: "LEFT" esquerda, "RIGHT" direita e "CENTER" - centro
Tipo Nmerico: 1 esquerda, 2 centro e 3 - direita
SetAutoWidth(nAutoWidth)Aponta a largura da clula gerada automaticamente pelo clculo de posicionamento das clulas que atingirem a largura maxima da pgina.
nAutoWidthLargura da clulaSetBlock(bBlock)Define o bloco de cdigo que retornar o contedo de impresso da clula.
Definindo o bloco de cdigo para a clula, esta no utilizar mais o nome mais alias para retornar o contedo de impresso.
bBlock
Bloco de cdigo que retorna o contedo
SetBorder(uBorder,nWeight,nColor,lHeader)Define as bordas da clula.uBorderTipo Caracter: "TOP","BOTTOM","LEFT","RIGHT",ALL
Tipo Numrico: 1-Superior,2-Inferior,3-Esquerda,4-Direita,5-Todas
nWeightLargura da borda
nColor
Cor da borda
lHeaderAponta se borda de cabealho
RetornoObjeto do tipo TRBorder
SetCanPrint(bCanPrint)Define o bloco de cdigo que ser utilizado para validar se a clula poder ser impressa.
bCanPrintBloco de cdigo com a validao da clula
SetCBox(cBox)Define que a clula ir imprimir a descrio do item de um campo que tenha o formato ComboBox, utilizado no Dicionrio de Campos (SX3).
cBoxO formato do parmetro o mesmo utilizado no Dicionrio de Campos (SX3), como no exemplo abaixo:
oCell:SetCBox('1=Sim;2=No').
Na impresso ser utilizada a descrio do item. No exemplo acima se o
contedo da clula for '1', ser impresso 'Sim', sendo que o mtodo j ir
calcular o tamanho da clula baseado na maior descrio informada
SetCellBreak()Compatibilidade No utilizado.
SetHeaderAlign(uAlign)Define o alinhamento do cabealho da clula na impresso.
uAlign
Tipo Caracter: "LEFT" esquerda, "RIGHT" direita e "CENTER" - centro
Tipo Nmerico: 1 esquerda, 2 centro e 3 - direita
SetNegative(cNegative)Define o sinal de negativo utilizado na impresso.
cNegativeTipo Caracter: "PARENTHESES" ( ) ou "SIGNAL"
SetPicture(cPicture)Define a mscara de impresso da clula.
cPicture Mscara da clula
SetPrintCell(lPrintCell)Define se a clula ser impressa.
lPrintCellSe verdadeiro, imprime a clula
SetRow(nRow)Quantidade de linhas para impresso das bordas.
nRow
Qunatidade de linhas
SetRowDiff(nRowDiff)Quantidade de linhas a serem consideradas na impresso das bordas.
nRowDiffQuantidade de linhas
SetSize(nSize,lPixel)Define o tamanho da clula.
nSize
Tamanho da clula
lPixel
Aponta se o tamanho calculado em pixel
SetTitle(cTitle)Define o ttulo da clula.
cTitle
Ttulo da clula
SetType(cType)Define o tipo de dado da clula.
cType
Tipo de dado
SetValue(uValue)Define um valor constante para a clula.
uValue
Valor constante
Definindo um valor constante para a clula, esta no utilizar o nome mais o alias para impresso do contedo, ou seja, a clula passar a se comportar como um vriavel de um programa.
Se o parmetro no for informado (Nulo), ento a clula deixar de usar o valor constante, voltando a imprimir seu contedo utilizando nome mais alias.
XmlLoad(oXml)Carrega uma clula do layout personalizado pelo usurio.
oXml
Objeto do tipo XML com as personalizaes da clula
XmlSave()Salva a clula no layout personalizado pelo usurio.
TRPOSITION
Clula de posicionamento de uma seo de um relatrio que utiliza a classe TReport.
As clulas de posicionamento so executas em toda execuo do mtodo PrintLine da seo que elas pertencem, para posicionar as tabelas secundrias da seo que o usurio pode utilizar para incluir clulas baseadas em seus campos.Propriedades
cAlias
Tabela que ser utilizada para posicionamento.
cClassNameNome da classe. (TRPOSITION).
cNickNameNickname da ordem do ndice da tabela.
lSeek
Se verdadeiro, Executar o DbSeek com o contedo retornado pela frmula.
nOrder
Ordem a ser utilizada na pesquisa.
uFormulaFrmula de posicionamento.
uValue
Contedo retornado aps a execuo da frmula.
oReportObjeto TReport.
oParentObjeto da classe TRSection que a clula pertence.
MTODOS
ClassName()Retorna o nome da classe. Exemplo: TRPOSITION.
Execute()Executa a frmula de posicionamento.
New(oParent,cAlias,uOrder,uFormula,lSeek)Mtodo construtor da classe TRPOSITION.oParentObjeto da classe TRSection que a clula pertence
cAlias
Tabela que ser utilizada para posicionamento
uOrder
Tipo Caracter: Nickname da ordem do ndice da tabela
Tipo Numrico: Ordem do ndice da tabela
uFormulaFrmula de posicionamento
Tipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de Cdigo: Bloco de Cdigo com a expresso ADVPL para execuo
lSeek
Se verdadeiro, Executar o DbSeek com o contedo retornado pela frmula
RetornoObjeto do tipo TRPosition
SetFormula(uFormula,lSeek)Define a frmula de posicionamento.
uFormulaFrmula de posicionamento
Tipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de Cdigo: Bloco de Cdigo com a expresso ADVPL para execuo
lSeek
Se verdadeiro, Executar o DbSeek com o contedo retornado pela frmula
SetNickName(cNickName)Define a ordem do ndice pelo seu nickname.
cNickNameNickName da ordem de ndice da tabela
SetOrder(nOrder)Define a ordem do ndice para o posicionamento.
nOrder
Ordem do ndice
SetTable(cAlias)Define a tabela que ser utitliza pela frmula para o posicionamento.
cAlias
Tabela que ser utilizada na frmula
TRFUNCTIONTotalizador de uma quebra, seo ou relatrio que utiliza a classe TReport.
Um totalizador pode executar uma das seguintes funes abaixo, utilizando como referncia uma clula da seo ou o retorno de uma frmula definida para ele:
SUM
Somar
COUNT Contar
MAX
Valor mximo
MIN
Valor mnimo
AVERAGEValor mdio
ONPRINTValor atual
TIMESUMSomar horas
TIMEAVERAGEValor medio de horas
TIMESUBSubtrai horas
Na criao do totalizador sempre informado uma seo (TRSection) a qual ele pertence, e automaticamente o totalizador ser includo no relatrio (TReport) que a seo pertence.
Esta classe herda as propridades e mtodos da classe TRCELL.
PropriedadesbConditionBloco de cdigo com a condio de atualizao dos valores do totalizador.
bOnPrintBloco de cdigo para tratamentos antes da impresso do totalizador.
cFunctionFuno que ser utilizada pelo totalizador. Exemplo: SUM, COUNT, MAX, MIN.lCollectionSe verdadeiro, aponta que o totalizador do tipo Collection.
lEndPageSe verdadeiro, aponta que o totalizador ser impresso no final da pgina.
lEndReportSe verdadeiro, aponta que o totalizador ser impresso no final do relatrio.
lEndSection Se verdadeiro, aponta que o totalizador ser impresso no final da seo.
lPageValueSe verdadeiro, aponta que impresso do total da pgina.
lPrintLayoutSe verdadeiro, aponta que visualizao do layout.
lReportValueSe verdadeiro, aponta que impresso do total geral.
lSectionValueSe verdadeiro, aponta que impresso do total da seo.
lPrintCollectionSe verdadeiro, aponta que impresso de totalizador do tipo Collection.
nCount
Contador de registros impressos.
nCountPageContador de registros impressos para a pgina.
nCountReportContador geral de registros impressos.
nCountSection Contador de registros impressos para a seo.
oCell
Objeto da classe TRCell que o totalizador se refere.
oTotal
Objeto da classe TRFunction ou TRCollection.
uFormulaTipo Caracter: Expresso ADVPL para macro execuo.
Tipo Bloco de cdigo: Bloco de Cdigo com a expresso ADVPL para execuo.
uLastValueltimo valor atualizado no totalizador.
uPage
Total acumulado por pgina.
uReportTotal acumulado geral do relatrio.
uSectionTotal acumulado por seo.
MTODOSClrBack(lObject)Retorna a cor de fundo do relatrio.
lObject
Aponta que deve ser retornado o objeto TBrush
RetornoCaso o parmetro lObjeto seja verdadeiro o retorno ser o objeto TBrush, caso
contrrio ser o nmero da cor RGB.
ClrFore()Retorna a cor de fonte do relatrio.
lPrintHeaderAponta impresso do cabealho da clula
RetornoNmero da cor RGB
Col()Retorna a posio da coluna do totalizador.
RetornoPosio da coluna do totalizador
Enabled()Retorna se o totalizador est habilitado.RetornoSe verdadeiro, aponta que o totalizador est habilitadoEndPage()Retorna se o totalizador ser impresso no final de cada pgina.
RetornoSe verdadeiro, o totalizador ser impressoEndReport()Retorna se o totalizador ser impresso no final do relatrio.
RetornoSe verdadeiro, o totalizador ser impresso
EndSection()Retorna se o totalizador ser impresso na quebra de seo.
RetornoSe verdadeiro, o totalizador ser impresso
EvalFunction()Utilizado pelo mtodo Execute(), ele executa a funo do totalizador, utilizando a frmula definida pelo mtodo New ou pelo mtodo SetFormula.
Execute()Executa a funo do totalizador, utilizando a frmula definida pelo mtodo New ou pelo mtodo SetFormula.
O mtodo Execute executado para cada linha impressa pelo mtodo PrintLine da seo que o totalizador pertence.
Formula()Retorna a frmula do totalizador.
Retorno Tipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de cdigo: Bloco de Cdigo com a expresso ADVPL para execuo
FullID()Retorna o identificador do totalizador mais o identificador da clula.
RetornoIdentificador do totalizador mais o identificador da clula
GetFunction(uFunction)Retorna a funo utilizada pelo totalizador. Exemplo: SUM, COUNT, MAX, MIN, AVERAGE.uFunctionIdentificador do totalizador
RetornoCaso informado o identificador do totalizador o retorno ser o objeto, caso
contrrio ser a funo
GetValue()Retorna o valor do totalizador.
Retorno Valor do totalizador
GetLastValue()Retorno o ltimo valor atualizado no totalizador.
Retornoltimo valor atualizado no totalizador
GetWidth(lAutoWidth)Retorna a largura da clula.
lAutoWidthAponta que a largura ser calculada automaticamente
RetornoLargura da clula do totalizador
GetPrintCollection()Retorna se impresso de totalizador do tipo Collection.
RetornoSe verdadeiro, aponta impresso de totalizador do tipo CollectionNew(oCell,cName,cFunction,oBreak,cTitle,cPicture,uFormula,lEndSection,lEndReport,lEndPage,oParent,bCondition,lDisable,bCanPrint)Mtodo construtor da classe TRFunction.
oCell
Objeto da classe TRCell que o totalizador se refere
cName
Identificao do totalizador
cFunctionFuno que ser utilizada pelo totalizador. Exemplo: SUM, COUNT, MAX, MIN
oBreak
Objeto da classe TRBreak que define em qual quebra o totalizador ser impresso
cTitleTtulo do totalizador. Se no informado ser utilizado o ttulo da clula que o totalizador se refere
cPictureMscara de impresso do totalizador. Se no informado ser utilizado a mscara da clula que o totalizador se refere
uFormulaTipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de cdigo: Bloco de Cdigo com a expresso ADVPL para execuo
lEndSectionSe verdadeiro. Indica se totalizador ser impresso na quebra de seo
lEndReportSe verdadeiro. Indica se totalizador ser impresso no final do relatrio
lEndPageSe verdadeiro. Indica se totalizador ser impresso no final de cada pgina
oParentObjeto da classe TRSection que o totalizador se refere
bConditionBloco de cdigo com a condio de atualizao dos valores do totalizador
lDisableSe verdadeiro. Define que no ir atualizar os valores do totalizador
bCanPrintBloco de cdigo com a condio de impresso dos valores do totalizador
PageValue()Retorna o valor atual do totalizador para a pgina.
RetornoValor atual da pgina
Print(uValue)Imprime o total atual.
uValue
Se informado, define o valor a ser impresso e altera o valor do total, caso
contrrio imprime o valor atual
PrintPage()Imprime o totalizador da pgina.
PrintReport()Imprime o totalizador geral do relatrio.
PrintSection()Imprime o totalizador da seo.
ReportValue()Retorna o valor geral do totalizador para o relatrio.
RetornoValor geral do relatrio
Reset()Reinicia valor do totalizador.
ResetPage()Reinicia valor do totalizador da pgina.
ResetReport()Reinicia valor do totalizador geral do relatrio.
ResetSection()Reinicia valor do totalizador da seo.
SectionValue()Retorna o valor atual do totalizador para a seo.
RetornoValor atual da seo
SetBreak(oBreak)Define a quebra (TRBreak) que o totalizador ser impresso.oBreak
Objeto TRBreak
SetCollection(lCollection)Define que o totalizador do tipo collection.
lCollectionSe verdadeiro, aponta que o totalizador do tipo collection
SetCondition(bCondition)Define o bloco de cdigo com a condio de atualizao dos valores do totalizador.
bConditionBloco de cdigo com a condio de atualizao dos valores do totalizador
SetEndPage(lEndPage)Define se o totalizador ser impresso na quebra de cada pgina.
lEndPageSe verdadeiro, aponta que imprime o totalizador
SetEndReport(lEndReport)Define se o totalizador ser impresso no final do relatrio.
lEndReportSe verdadeiro, aponta que imprime o totalizador
SetEndSection(lEndSection)Define se o totalizador ser impresso na quebra de seo.
lEndSectionSe verdadeiro, aponta que imprime o totalizador
SetFormula(uFormula)Define a frmula utilizada pelo totalizador no lugar de utilizar o contedo da clula que ele se refere.
uFormulaTipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de cdigo: Bloco de cdigo com a expresso ADVPL para execuo
SetFunction(cFunction)Define a funo que ser utilizada pelo totalizador. Exemplo: SUM, COUNT, MAX, MIN.cFunctionFuno do totalizador
SetTotalInLine(lTotalInLine)Define que a impresso dos totalizadores ser em linha.
lTotalInLineSe verdadeiro, imprime os totalizadores em linhaSetPrintCollection(lPrintCollection)Define que impresso de collections.
lPrintCollectionSe verdadeiro, aponta que impresso de collectionsTRBREAKQuebra de uma seo de um relatrio que utiliza a classe TReport.
A classe TRBreak utilizada quando h a necessidade de impresso dos totalizadores da seo antes do final da seo ou do relatrio, dependendo da regra de quebra informada.
Esta classe herda as propridades e mtodos da classe TRSECTION.
PropriedadesbOnBreakBloco de cdigo com tratamentos a serem realizados antes da quebra.
bOnPrintTotal Bloco de cdigo com tratamentos a serem realizados aps a quebra.
uBreak
Regra para quebra.
Tipo Objeto: Objeto da classe TRCell.
Tipo Caracter: Expresso ADVPL para macro execuo.
Tipo Bloco de Cdigo: Bloco de cdigo com expresso que ser executada.
uContentltimo valor atualizado no controle da quebra.
MTODOSExecute(lForce)Executa a regra e indica se houve a quebra.
O mtodo Execute executado para cada linha impressa pelo mtodo PrintLine da seo que a quebra pertence.
lForce
Fora a execuo da quebra
RetornoSe verdadeiro, aponta que houve quebra
GetLastValue()Retorno o ltimo valor atualizado no controle da quebra.
Retorna
ltimo valor atualizado
New(oParent,uBreak,uTitle,lTotalInLine,cName,lPageBreak)Mtodo construtor da classe TRBreak.
oParentObjeto da classe TRSection que a quebra pertence
uBreak
Regra para quebra
Tipo Objeto: Objeto da classe TRCell
Tipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de Cdigo: Bloco de cdigo com expresso que ser executada
uTitle
Ttulo da quebra
lTotalInLineSe verdadeiro, aponta que os totalizadores sero impressos em linha
cName
Nome e identificador da quebra
lPageBreakSe verdadeiro, aponta salta de pgina aps a quebra
RetornoObjeto da classe TRBreak
OnBreak(bOnBreak)Define o bloco de cdigo que ser executado antes da impresso da quebra.
bOnBreakBloco de cdigo com tratamentos a serem realizados antes na quebra
OnPrintTotal(bOnPrintTotal)Define o bloco de cdigo que ser executado aps a impresso da quebra.
bOnPrintTotalBloco de cdigo com tratamentos a serem realizados aps a quebra
Print()Executa a impresso da quebra.
PrintTotal()Imprime a quebra e executa os tratamentos definidos no mtodo OnPrintTotal.
ResetBreak()Inicializa o valor utilizado para controlar a quebra.
SetBreak(uBreak)Define a regra para a quebra.
uBreak
Regra para quebra
Tipo Objeto: Objeto da classe TRCell
Tipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de Cdigo: Bloco de cdigo com expresso que ser executada
SetTitle(uTitle)Define o ttulo que ser impresso antes da impresso dos totalizadores.
uTitle
Texto a ser impresso no formato caracter ou bloco de cdigo
Title()Retorna o ttulo que ser impresso antes da impresso dos totalizadores.
RetornoTtulo da quebraTRORDEROrdena a seo de um relatrio que utiliza a classe TReport.
Esta classe herda as propridades e mtodos da classe TRPOSITION.
PropriedadescTitle
Ttulo da ordem
MTODOSExecute()Ordena a tabela.GetOrder()Retorna a ordem da tabela.
RetornoPosio da ordem no dicionrio de indices - SIX
New(oParent,uOrder,cTitle,cAlias)Mtodo construtor da classe TROrder.
oParent Objeto da classe TRSection que a ordem pertence
uOrder
Tipo Caracter: NickName da ordem no dicionrio de indices SIX
Tipo Numrico: Posio da ordem no dicionrio de indices - SIX
cTitle
Ttulo da ordem
cAlias
Tabela que ser ordenadaRetornoObjeto da classe TROrderSetTitle(cTitle)Define o ttulo da ordem.
cTitleTtulo da ordem
Title()Retorna o ttulo da ordem.
RetornoTtulo da ordemTRRELATIONRelacionamento entre as sees que utiliza a classe TReport.
Esta classe herda as propridades e mtodos da classe TRPOSITION.MTODOSNew(oParent)Mtodo construtor da classe TRRelation.oParent
Objeto da classe TRSection que o relacionamento pertence
Execute() Executa frmula de relacionamento.
SetFormula(uFormula,lSeek)Define a frmula de posicionamento.
uFormulaFrmula de posicionamento
Tipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de Cdigo: Bloco de Cdigo com a expresso ADVPL para execuo
lSeek
Se verdadeiro, Executar o DbSeek com o contedo retornado pela frmula
SetNickName(cNickName)Define a ordem do ndice pelo seu nickname.
cNickNameNickName da ordem de ndice da tabela
SetOrder(nOrder)Define a ordem do ndice para o posicionamento.
nOrder
Ordem do ndice
SetTable(cAlias)Define a tabela que ser utitliza pela frmula para o posicionamento.
cAlias
Tabela que ser utilizada na frmula
TRPAGEDefinio da pgina para relatrio que utiliza a classe TReport.
Esta classe herda as propridades e mtodos da classe TREPORT.
PropriedadesbPageFooterBloco de cdigo utilizado para imprimir Informaes customizadas, no qual, dever ser utilizado mtodos do TReport para impresso. Exemplo: Say, PrintText.
lEndPageAponta que dever quebrar pgina.
lFirstPageAponta que primeira pgina do relatrio.
lFooterBeforeAponta que o rodap ser impresso antes dos totalizadores.
lFooterDiffAponta que considerado a altura da linha no rodap para clculo do altura da pgina.
lLandscapeAponta a orientao de pgina do relatrio como paisagem.
lPageDiffAponta que considerado o tamanho da borda e rodap para clculo da altura da pgina.
lPageFooterAponta que est sendo impresso o rodap da pgina.
lPageTotalAponta que est sendo impresso o total da pgina.
lPortraitAponta a orientao de pgina do relatrio como retrato.
lTotalAfterAponta que o totalizador ser impresso aps a impresso do rodap.
lTotalDiffAponta que ser considerada a quantidade de linhas a serem impressosno rodap no clculo da altura da pgina.
nFooterDiffQuantidade de linhas a serem impressas no rodap considerando a altura da linha.
nHorzResResoluo horizontal da impressora configurada.
nLinesFooterQuantidade de linhas reservadas para impresso do rodap.
nPage
Pgina atual.
nPaperSizeTamanho da pgina.
nTotalDiffQuantidade de linhas a serem impressas no rodap considerando o tamanho da linha e bordas.
nWidth
Largura da pgina.
nVertResResoluo vertical da impressora configurada.
oParentObjeto da classe TRSection que a pgina pertence.
oReportObjeto da classe TREPORT que a pgina pertence.
MTODOSEndPage(lFooter)Imprime os totalizadores, rodap e salta a pgina.
lFooter
Aponta que o rodap ser impresso
FooterDiff()Retorna a quantidade de linhas do rodap considerando a altura da linha.
RetornoQuantidade de linhas
IsLandscape()Aponta que a orientao do relatrio paisagem.
RetornoSe verdadeiro, orientao paisagem
IsPortrait()Aponta que a orientao do relatrio retrato.
RetornoSe verdadeiro, orientao retrato
New(oParent,uTotalText,lTotalInLine)Mtodo contrutor da classe TRPage.
oParentObjeto da classe TRSection que a pgina pertence
uTotalTextTexto do totalizador da pgina
lTotalInLineImprime os totalizadores em linhas
Retorno Objeto da classe TRPage
Page()Retorna a pgina atual.
Retorno Pgina atual
PageDiff()Retorna a quantidade de linhas utilizadas na impresso do rodap.
RetornoQuantidade de linhas do rodap
PageHeight()Retorna a altura da pgina.
RetornoAltura da pgina
PageWidth()Retorna a largura da pgina.
RetornoLargura da pgina
PaperSize()Retorna o tamanho do papel selecionado.
RetornoTamanho do papel
PrintPageFooter(nDiff)Imprime o rodap da pgina.
nDiff
Quantidade de linhas reservadas para o rodap
PrintTotal(nDiff,lSetPos)Imprime os totalizadores da pgina.
nDiff
Quantidade de linhas reservadas para o rodap
lSetPosPosiciona a linha de imprresso na primeira linha reservada para o rodap
ResetFooterDiff()Inicializa os valores referente a quantidade de linhas reservadas para o rodap, utilizados no clculo da altura da pgina.ResetPage()Inicializa as variveis da pgina, indicando como impresso da primeira pgina.
ResetTotalDiff()Inicializa os valores referente a quantidade de linhas reservadas para o rodap.
SetLandscape()Define a orientao de pgina do relatrio como paisagem.
SetPageDiff(lPageDiff)Define que ser considerada a quantidade de linhas a serem impressas no rodap para o clculo da altura da pgina .
SetPageFooter(nLinesFooter,bPageFooter,lFooterBefore)Define a configurao para impresso do rodap da pgina.
nLinesFooterQuantidade de linhas reservadas para impresso do rodap
bPageFooter Bloco de cdigo utilizado para imprimir Informaes customizadas, no qual,
dever ser utilizado mtodos do TReport para impresso. Exemplo: Say, PrintText.
lFooterBeforeImprime rodap antes da impresso dos totalizadores
SetPageNumber(nPage)Define o nmero da pgina atual.
nPage
Nmero da pgina
SetPaperSize(nPaperSize)Define o tamanho da pgina.
nPaperSizeTamanho da pgina
SetPortrait()Define a orientao de pgina do relatrio como retrato.
SetTotalBefore(lTotalBefore)Define que o total da pgina ser impressa antes do rodap.
lTotalBeforeTotal da pgina antes do rodap
StartPage()Inicializa a impresso de uma nova pgina.
TotalDiff() Retorna a quantidade total de linhas reservadas para impresso do rodap.
RetornoQuantidade total de linhas reservadasTRPARAMPAGEImprime pgina de parmetros para relatrio que utiliza a classe TREPORT.
Este mtodo herda as propridades e mtodos da classe TRSECTION.
PropriedadesnSize
Tamanho da clula
MTODOSNew(oParent,cParam)Mtodo construtor da classe TRParamPage.
oParentObjeto da classe TREPORT
cParamGrupo de perguntas
RetornoObjeto da classe TRParamPage
Print()Imprime a pgina de parmetros.
PrintFilter()Imprime as Informaes de usurio e filtros.TRCOLLECTIONAcumulador de uma quebra, seo e relatrio que utiliza a classe TReport.
Um Acumulador pode executar uma das seguintes funes abaixo, utilizando como referncia uma clula da seo ou o retorno de uma frmula definida para ele:
SUM
Somar
COUNT Contar
MAX
Valor mximo
MIN
Valor mnimo
AVERAGEValor mdio
ONPRINTValor atual
TIMESUMSomar horas
TIMEAVERAGEValor medio de horas
TIMESUBSubtrai horas
Na criao do acumulador sempre informado uma seo (TRSection) a qual ele pertence, e automaticamente o acumulador ser incluido no relatrio (TReport) que a seo pertence.
Esta classe herda as propridades e mtodos da classe TRFUNCTION.
PropriedadesbItemPrintCompatibilidade No utilizado.
bItemResetCompatibilidade No utilizado.
bItemValueCompatibilidade No utilizado.
cGNameTtulo do grfico personalizado.
cGSerieTtulo da srie do grfico personalizado.
cItemPictureMscara de impresso do acumulador.
lGEndReportAponta impresso do grfico no final do relatrio.
lGraphicAponta a existncia de grficos no relatrio.
lPrintLayoutAponta que impresso de visualizao do layout.
lUserAccessSe verdadeiro, permite o usurio utilizar acumuladores personalizados.
nGTypeTipo do grfico personalizado.
1 Linhas
2 Area
3 Pontos
4 Barra
9 Pizza
12 Linhas Rpidas
uContentRegra com o valor acumulado.
Tipo Caracter: Expresso ADVPL para macro execuo.
Tipo Bloco de cdigo: Bloco de Cdigo com a expresso ADVPL para execuo.
MTODOSCol()Compatibilidade No utilizado.EvalFunction()Atualiza o contedo dos acumuladores.
New(cName,cFunction,oBreak,uTitle,cPicture,uFormula,lEndSection,lEndReport,oParent,bCondition,uContent)Mtodo constructor da classe TRCollection.
cName
Identificao do acumulador
cFunctionFuno que ser utilizada pelo acumulador. Exemplo: SUM, COUNT, MAX, MIN
oBreak
Objeto da classe TRBreak que define em qual quebra o acumulador ser impresso
uTitle
Ttulo do acumulador. Texto a ser impresso no formato caracter ou bloco de cdigo
cPictureMscara de impresso do acumulador
uFormulaRegra para acmulo dos valores
Tipo Caracter: Expresso ADVPL para macro execuo
Tipo Bloco de cdigo: Bloco de Cdigo com a expresso ADVPL para execuo
lEndSectionSe verdadeiro. Indica se o acumulador ser impresso na quebra de seo
lEndReportSe verdadeiro. Indica se op acumulador ser impresso no final do relatrio
oParentObjeto da classe TRSection que o acumulador se refere
bConditionBloco de cdigo com a condio de atualizao dos valores do acumulador
uContentRegra com o valor acumulado
Recommended