Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Obs.: Uma seção (TRSection) pode ser considerada um tópico dentro do relatório, podendo ter um ou mais tópicos que se relacionam no relatório.


Informações
titleImportante

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

Métodos:

Painel

AddBreak

Sintaxe
TReport():AddBreak( <oBreak> ) → NIL

Descrição
Adiciona a quebra de impressão na propriedade aBreak

Parâmetros

NomeTipoDescriçãoObrigatório
oBreakObjetoObjeto TRBreakX

...

Painel

GetParam

Sintaxe
TReport():GetParam( ) →

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

Painel
GetWidth

GetRightAlignPrinter

Sintaxe
TReport():GetWidthGetRightAlignPrinter( ) → lAlignPrinter

Descrição
Retorna a largura da páginase o alinhamento do relatório para células à direita está utilizando o componente do binário.

Retorno

lAlignPrinter

Aviso

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

Painel

GetWidth

Sintaxe
TReport():GetWidth( ) →

Descrição
Retorna a largura da página

Painel

HideFooter

Sintaxe
TReport

Painel

HideFooter

Sintaxe
TReport():HideFooter( ) →

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

...

Painel

LoadDefault

Sintaxe
TReport():LoadDefault( ) →

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

LoadLayout

Sintaxe
TReport():LoadLayout( <cLayout> ) →
Descrição
Carrega um layout customizado para impressão
Parâmetros
Painel
NomeTipoDescriçãoObrigatório
cLayout
Caracter

Layout a ser carregado

X
Painel

New

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


Descrição
Método construtor da classe TReport

Parâmetros

NomeTipoDescriçãoObrigatório
cReportCaracter

Nome do relatório. Exemplo: MATR010

X
cTitleCaracterTítulo do relatório
uParamCaracter / Bloco de CódigoParâmetros do relatório cadastrado no Dicionário de Perguntas (SX1). Também pode ser utilizado bloco de código para parâmetros customizados
bActionBloco de CódigoBloco de código que será executado quando o usuário confirmar a impressão do relatório
cDescriptionCaracterDescrição do relatório
lLandscapeLógicoAponta a orientação de página do relatório como paisagem
uTotalTextCaracter / Bloco de CódigoTexto do totalizador do relatório, podendo ser caracter ou bloco de código
lTotalInLineLógicoImprime as células em linha
cPageTTextCaracterTexto do totalizador da página
lPageTInLineLógicoImprime totalizador da página em linha
lTPageBreakLógicoQuebra página após a impressão do totalizador
nColSpaceNuméricoEspaçamento entre as colunas


Retorno
oRet - Objeto da classe TReport

...

Painel

PageTotalInLine

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lTotalInLineLógico

Se verdadeirofalso, será impresso em linha


Painel

PageTotalText

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
cTextCaracter

Texto do totalizador da página


...

Painel

SetPxLeftMargin

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
nPxLeftMarginNuméricoTamanho da margem à esquerda em pixelX
Painel
SetRow

SetRightAlignPrinter

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lAlignPrinterLógicoSe verdadeiro, utiliza o alinhamento do binário para células à direitaX
Informações
titleImportante

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

Aviso

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

Painel

SetRow

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
nRowNuméricoNúmero da linha a ser impressaX

...

Painel

SetTotalInLine

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lTotalInLineLógicoSe verdadeirofalso, imprime em linha
Painel

SetTotalPageBreak

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
lTPageBreakLógicoSe verdadeiro, aponta a quebra de página após a impressão do totalizador
Painel

SetTotalText

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
uTextLógicoCharacter, CodeBlockTexto a ser impresso no formato caracter ou bloco de código

...

Painel

XmlLoad

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
cXmluXmlCaracter, ArrayArquivo do tipo XML com as personalizações do usuárioX
Painel

XmlSave

Sintaxe
TReport():XmlSave( ) → lRetaXml

Descrição
Salva Retorna um layout personalizado pelo usuárioarray com o layout do TReport atual.

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

Painel

XlsNewCell

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
cCaracterInformação a ser inserida na célula
lIndexLógicoControla numeração de colunas na planilha
nColNuméricoColuna posicionada
cStyleCaracterEstilo da célula
nCellsNuméricoQuantidade de células utilizadas para a informação (Mesclar)
nWidthNuméricoLargura da célula
cTypeCaracterTipo de dado. C-Caracter, N-Numérico, L-Lógico

...

Painel

XlsNewStyle

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

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

Parâmetros

NomeTipoDescriçãoObrigatório
cIDCaracterID do estilo
cNameCaracterNome do estilo
nAlignNuméricoTipo de alinhamento. 1-Esquerda, 2-Centralizado, 3-Direita
aFontArrayArray contendo a fonte. Elementos: 1-Fonte, 2-Tamanho
aBorderArrayArray contendo a borda. Elementos: 1-“Bottom”,”Left”,”Right”,”Center”, 2=Largura da borda
lWrapTextLógicoAponta quebra de linha automática
cTypeCaracterTipo de dado. C-Caracter, N-Numérico, L-Lógico
Painel

XlsSave

Sintaxe
TReport():XlsSave( ) →

Descrição
Compatibilidade – Não utilizado

...