...
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 |
---|
|
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 Nome | Tipo | Descrição | Obrigatório |
---|
oBreak | Objeto | Objeto TRBreak | X |
|
...
Painel |
---|
GetRightAlignPrinterSintaxe TReport():GetRightAlignPrinter( ) → lAlignPrinter
Descrição Retorna se o alinhamento do relatório para células à direita está utilizando o componente do binário. Retorno lAlignPrinter Aviso |
---|
Método disponível a partir da LIB Label 20211004 |
|
Painel |
---|
GetWidthSintaxe TReport():GetWidth( ) →
Descrição Retorna a largura da página |
...
Painel |
---|
SetRightAlignPrinterSintaxe TReport():SetRightAlignPrinter( <lAlignPrinter> ) →
Descrição Seta que será utilizado o componente do binário para realizar o alinhamento das células que estejam à direita.
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
lAlignPrinter | Lógico | Se verdadeiro, utiliza o alinhamento do binário para células à direita (Default .F.) | X |
Informações |
---|
| 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 |
---|
SetRowSintaxe TReport():SetRow( <nRow> ) →
Descrição Define a margem à esquerda em pixel do relatório
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
nRow | Numérico | Número da linha a ser impressa | X |
|
...
Painel |
---|
SetTotalText
Sintaxe TReport():SetTotalText( <uText> ) →
Descrição Define o texto que será impresso antes da impressão dos totalizadores
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
uTextLógico | Character, CodeBlock | Texto 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 Nome | Tipo | Descrição | Obrigatório |
---|
cXmluXml | Caracter, Array | Arquivo do tipo XML com as personalizações do usuário | X |
|
Painel |
---|
XmlSaveSintaxe 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 |
---|
XlsNewCellSintaxe TReport():XlsNewCell( <c> , <lIndex> , <nCol> , <cStyle> , <nCells> , <nWidth> , <cType> ) →
Descrição Adiciona uma célula na geração em planilha
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
c | Caracter | Informação a ser inserida na célula |
| lIndex | Lógico | Controla numeração de colunas na planilha |
| nCol | Numérico | Coluna posicionada |
| cStyle | Caracter | Estilo da célula |
| nCells | Numérico | Quantidade de células utilizadas para a informação (Mesclar) |
| nWidth | Numérico | Largura da célula |
| cType | Caracter | Tipo de dado. C-Caracter, N-Numérico, L-Lógico |
|
|
...
Painel |
---|
GetGCList
Sintaxe TReport():GetGCList() → aFilterGC
Descrição Retorna um array contendo a lista de grupos, empresas, unidade de negócio e filiais selecionadas na tela de gestão de empresas. Parâmetros
Retorno Array contendo a lista de grupos, empresas, unidade de negócio e filiais selecionadas na tela de gestão de empresas. |
Painel |
---|
xlsxTypeWrite
Sintaxe TReport():xlsxTypeWrite( <nXlsxTypeWrite> )
Descrição Informa ao TReport como a geração do XLSX deve ser efetuada, sendo que cada opção leva a cenários de maior performance ou maior consumo de memória, logo essa opção deve ser utilizada conforme necessidade específica de um relatório, normalmente relatórios com grande volume de dados.
Parâmetros Nome | Tipo | Descrição | Obrigatório |
---|
nXlsxTypeWrite | Numeric | Tipo da geração de planilha XLSX, sendo valores de 0 a 3: - 0: Gera o xlsx de acordo com as regras do TReport (default)
- 1: Gera o xlsx em arquivo (possui limitações)
- 2: Gera o xlsx em banco de dados (baixo consumo de memória)
- 3: Gera o xlsx em memória (alta performance)
Importante: A geração em arquivo (valor 1) é limitada e deve ser utilizada somente em relatório que possuam apenas uma seção, caso contrário, os dados podem ficar agrupados na última worksheet criada, portanto, essa opção deve ser utilizada com cautela e deve ser rigorosamente homologada. Caso o método seja chamado durante a impressão, seu valor não será acatado. |
|
Observação - Esse método está disponível na lib 20240812 ou superior
- O valor enviado é repassado para a classe responsável por gerar a planilha XLSX: FWMsExcelXlsx
- O método precisa ser chamado antes da ativação do TReport, ou seja, durante sua definição, normalmente na função ReportDef
|