Célula de impressão pertencente a uma seção (TRSection) de um relatório que utiliza a classe TReport.
Esta classe herda as propriedades e métodos da classe TRSECTION.
Planilha/Formato Tabela
Quando o formato do relatório é Planilha/Formato Tabela, toda a definição do esqueleto do relatório é definido no ReportDef.
Caso crie uma célula no ReportDef e depois utilize o método HideHeader, o mesmo não surtirá efeito, ou seja, o header da célula irá aparecer no relatório.
Alinhamento de células à direita
Métodos:
CanPrint
Sintaxe
TRCell():CanPrint( ) →
Descrição
Valida se a célula pode ser impressa
Col
Sintaxe
TRCell():Col( ) →
Descrição
Retorna a coluna da célula
ColPos
Sintaxe
TRCell():ColPos( ) →
Descrição
Retorna a coluna que a célula será impressa pelo método PrintLine da seção que a célula pertence
Retorno
Coluna da célula na impressão
CellBreak
Sintaxe
TRCell():CellBreak( ) →
Descrição
Compatibilidade – Não utilizado
ClrBack
Sintaxe
TRCell():ClrBack( <lObject> ) →
Descrição
Retorna a cor de fundo do relatório
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
lObject | Lógico | Aponta que deve ser retornado o objeto TBrush |
Retorno
Caso o parâmetro lObjeto seja verdadeiro o retorno será o objeto TBrush, caso contrário será o número da cor RGB
ClrFore
Sintaxe
TRCell():ClrFore( <lPrintHeader> ) →
Descrição
Retorna a cor de fonte do relatório
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
lPrintHeader | Lógico | Aponta impressão do cabeçalho da célula |
Retorno
Número da cor RGB
Disable
Sintaxe
TRCell():Disable( ) →
Descrição
Desabilita a impressão da célula
Enable
Sintaxe
TRCell():Enable( ) →
Descrição
Habilita a impressão da célula
Enabled
Sintaxe
TRCell():Enabled( ) →
Descrição
Retorna se a célula está habilitada para impressão
Retorno
Se verdadeiro, a célula está habilitada
EvalFunction
Sintaxe
TRCell():EvalFunction( ) →
Descrição
Atualiza o conteúdo dos totalizadores da seção
Execute
Sintaxe
TRCell():Execute( <lPrintLayout> ) →
Descrição
Atualiza o conteúdo da célula a ser impresso
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
lPrintLayout | Lógico | Aponta visualização de layout |
Retorno
Conteúdo a ser impresso
GetCBox
Sintaxe
TRCell():GetCBox( ) →
Descrição
Retorna o conteúdo da lista de dado a ser impresso. Exemplo: 1=Sim ou 2=Não
Retorno
Conteúdo da lista
GetCellSize
Sintaxe
TRCell():GetCellSize( ) →
Descrição
Retorna o tamanho da célula
Retorno
Tamanho da célula
GetCellWidth
Sintaxe
TRCell():GetCellWidth( ) →
Descrição
Retorna a largura da célula
Retorno
Largura da célula
GetFieldInfo
Sintaxe
TRCell():GetFieldInfo( <cField> ) →
Descrição
Carrega informações (título, picture, tamanho, etc) do campo baseado no Dicionário de Campos (SX3)
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
cField | Caracter | Campo a ser consultado no dicionário |
Retorno
Se verdadeiro, conseguiu coletar informações do dicionário
GetHeaderSize
Sintaxe
TRCell():GetHeaderSize( ) →
Descrição
Retorna o tamanho do cabeçalho da célula
Retorno
Tamanho do cabeçalho
GetHeaderWidth
Sintaxe
TRCell():GetHeaderWidth( ) →
Descrição
Retorna a largura do cabeçalho da célula
Retorno
Largura do cabeçalho
GetSize
Sintaxe
TRCell():GetSize( ) →
Descrição
Retorna o tamanho da célula considerando o maior tamanho entre a célula e o cabeçalho da célula
Retorno
Tamanho da célula
GetText
Sintaxe
TRCell():GetText( ) →
Descrição
Retorna o texto que será impresso
Retorno
Conteúdo da célula a ser impresso
GetValue
Sintaxe
TRCell():GetValue( ) →
Descrição
Retorna o valor a ser impresso na célula
Retorno
Valor da célula
GetWidth
Sintaxe
TRCell():GetWidth( <lAutoWidth> ) →
Descrição
Retorna a largura da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
lAutoWidth | Lógico | Largura automática |
Retorno
Largura da célula
Hide
Sintaxe
TRCell():Hide( ) →
Descrição
Desabilita a impressão da célula, porém calcula o posicionamento da célula
LineCount
Sintaxe
TRCell():LineCount( <lHeader> ) →
Descrição
Quantidade de linhas a serem impressas para a célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
lHeader | Lógico | Se verdadeiro, verifica as linhas do cabeçalho |
Retorno
Quantidade de linhas
New
Sintaxe
TRCell():New( <oParent> , <cName> , <cAlias> , <cTitle> , <cPicture> , <nSize> , <lPixel> , <bBlock> , <cAlign> , <lLineBreak> , <cHeaderAlign> , <lCellBreak> , <nColSpace> , <lAutoSize> , <nClrBack> , <nClrFore> , <lBold> ) →
Descrição
Método construtor da classe TRCell
Se o nome da célula informada for encontrada no Dicionário de Campos (SX3), as informações do campo serão carregadas para a célula, respeitando os parâmetros de título, picture e tamanho. Dessa forma o relatório sempre estará atualizado com as informações do Dicionário de Campos (SX3).
O nome da célula será utilizado junto ao alias informado pelo parâmetro como conteúdo para a impressão da célula, como por exemplo a impressão do campo A1_COD da tabela SA1.
Se for informado o parâmetro com o bloco de código, o retorno deste será utilizado como conteúdo para impressão da célula, com a picture, tamanho e título definidos para a célula. Assim sendo, é possível criar células calculadas com formato de impressão baseada no Dicionário de Campos (SX3).
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
oParent | Objeto | Objeto da classe TRSection que a célula pertence | |
cName | Caracter | Nome da célula | |
cAlias | Caracter | Tabela utilizada pela célula | |
cTitle | Caracter | Título da célula | |
cPicture | Caracter | Mascara da célula | |
nSize* | Numérico | Tamanho da célula | |
lPixel | Lógico | Aponta se o tamanho foi informado em pixel | |
bBlock | Bloco de Código | Bloco de código com o retorno do campo | |
cAlign | Caracter | Alinhamento da célula. “LEFT”, “RIGHT” e “CENTER” | |
lLineBreak | Lógico | Quebra linha se o conteúdo estourar o tamanho do campo | |
cHeaderAlign | Caracter | Alinhamento do cabeçalho da célula. “LEFT”, “RIGHT” e “CENTER” | |
lCellBreak | Lógico | Compatibilidade – Não utilizado | |
nColSpace | Numérico | Espaçamento entre as células | |
lAutoSize** | Lógico | Ajusta o tamanho da célula com base no tamanho da página e as informações impressas | |
nClrBack | Numérico | Cor de fundo da célula | |
nClrFore | Numérico | Cor da fonte da célula | |
lBold | Lógico | Imprime a fonte em negrito |
*É recomendada a definição de tamanho pelo parâmetro nSize, pois quando não está definido e entra nas situações de auto ajuste de tamanho pode acontecer problemas na impressão.
**Para detalhes sobre auto ajuste verifique a documentação Ajuste automático de tamanho das células nas seções (autosize).
Picture
Sintaxe
TRCell():Picture( ) →
Descrição
Retorna a máscara de impressão da célula
Retorno
Máscara de impressão
Print
Sintaxe
TRCell():Print( <lCanPrint> , <nXlsCol> , <lExcel> ) →
Descrição
Imprime o conteúdo da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
lCanPrint | Lógico | Valida impressão da célula | |
nXlsCol | Numérico | Número da coluna na geração em planilha | |
lExcel | Lógico | Geração em planilha |
PrintHeader
Sintaxe
TRCell():PrintHeader( <nSkipLine> , <lHeaderWidth> , <cXlsHStyle> , <lExcel> ) →
Descrição
Imprime o cabeçalho da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
nSkipLine | Numérico | Compatibilidade – Não utilizado | |
lHeaderWidth | Lógico | Considera a largura do cabeçalho na impressão | |
cXlsHStyle | Caracter | Estilo do cabeçalho na geração em planilha | |
lExcel | Lógico | Geração em planilha |
ResetWidth
Sintaxe
TRCell():ResetWidth( ) →
Descrição
Inicializa o tamanho e largura da célula
ResetLineStart
Sintaxe
TRCell():ResetLineStart( ) →
Descrição
Inicializa a linha que indica a primeira linha da célula a ser impressa no caso de quebra de linha
Say
Sintaxe
TRCell():Say( <cText> ,<nAlign> ,<nSayWidth> ,<lPrintHeader> ) →
Descrição
Imprime um texto na célula ou o conteúdo da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
cText | Caracter | Texto que será impresso | |
nAlign | Numérico | Alinhamento do texto. 1-Esquerda, 2-Centro ou 3-Direita | |
nSayWidth | Numérico | Largura do texto | |
lPrintHeader | Lógico | Impressão do cabeçalho |
Say
Sintaxe
TRCell():Say( <cText> ,<nAlign> ,<nSayWidth> ,<lPrintHeader> ) →
Descrição
Imprime um texto na célula ou o conteúdo da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
cText | Caracter | Texto que será impresso | |
nAlign | Numérico | Alinhamento do texto. 1-Esquerda, 2-Centro ou 3-Direita | |
nSayWidth | Numérico | Largura do texto | |
lPrintHeader | Lógico | Impressão do cabeçalho |
SetAlign
Sintaxe
TRCell():SetAlign( <uAlign> ) →
Descrição
Define o alinhamento da célula na impressão
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
uAlign | Caracter | Tipo Caracter: "LEFT" - esquerda, "RIGHT" - direita e "CENTER" - centro |
SetAutoWidth
Sintaxe
TRCell():SetAlign( <nAutoWidth> ) →
Descrição
Aponta a largura da célula gerada automaticamente pelo cálculo de posicionamento das células que atingirem a largura máxima da página
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
nAutoWidth | Numérico | Largura da célula |
SetBlock
Sintaxe
TRCell():SetBlock( <bBlock> ) →
Descrição
Define o bloco de código que retornará o conteúdo de impressão da célula. Definindo o bloco de código para a célula, esta não utilizara mais o nome mais o alias para retornar o conteúdo de impressão
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
bBlock | Bloco de Código | Bloco de código que retorna o conteúdo |
SetBorder
Sintaxe
TRCell():SetBorder( <uBorder> , <nWeight> , <nColor> , <lHeader> ) →
Descrição
Define as bordas da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
uBorder | Bloco de Código | Bloco de código que retorna o conteúdo | |
nWeight | Numérico | Largura da borda | |
nColor | Numérico | Cor da borda | |
lHeader | Lógico | Aponta se é borda de cabeçalho |
Retorno
Objeto do tipo TRBorder
SetCanPrint
Sintaxe
TRCell():SetCanPrint( <bCanPrint> ) →
Descrição
Define o bloco de código que será utilizado para validar se a célula poderá ser impressa
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
bCanPrint | Bloco de Código | Bloco de código com a validação da célula |
SetCBox
Sintaxe
TRCell():SetCBox( <cBox> ) →
Descrição
Define que a célula irá imprimir a descrição do item de um campo que tenha o formato ComboBox, utilizado no Dicionário de Campos (SX3)
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
cBox | Caracter | O formato do parâmetro é o mesmo utilizado no Dicionário de Campos (SX3), como no exemplo abaixo: |
SetCellBreak
Sintaxe
TRCell():SetCellBreak( ) →
Descrição
Compatibilidade – Não utilizado
SetHeaderAlign
Sintaxe
TRCell():SetHeaderAlign( <uAlign> ) →
Descrição
Define o alinhamento do cabeçalho da célula na impressão
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
uAlign | Caracter / Numérico | Tipo Caracter: "LEFT" - esquerda, "RIGHT" - direita e "CENTER" - centro |
SetNegative
Sintaxe
TRCell():SetNegative( <cNegative> ) →
Descrição
Define o sinal de negativo utilizado na impressão
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
cNegative | Caracter | Tipo Caracter: "PARENTHESES" ( ) ou "SIGNAL" - |
SetPicture
Sintaxe
TRCell():SetPicture( <cPicture> ) →
Descrição
Define a mascara de impressão da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
cPicture | Caracter | Máscara da célula |
SetPrintCell
Sintaxe
TRCell():SetPrintCell( <lPrintCell> ) →
Descrição
Define se a célula será impressa
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
lPrintCell | Lógico | Se verdadeiro, imprime a célula |
SetRow
Sintaxe
TRCell():SetRow( <nRow> ) →
Descrição
Quantidade de linhas para impressão das bordas
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
nRow | Numérico | Quantidade de linhas |
SetRowDiff
Sintaxe
TRCell():SetRowDiff( <nRowDiff> ) →
Descrição
Quantidade de linhas a serem consideradas na impressão das bordas
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
nRowDiff | Numérico | Quantidade de linhas |
SetSize
Sintaxe
TRCell():SetSize( <nSize> , <lPixel> ) →
Descrição
Define o tamanho da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
nSize | Numérico | Tamanho da célula | |
lPixel | Lógico | Aponta se o tamanho é calculado em pixel |
SetTitle
Sintaxe
TRCell():SetTitle( <cTitle> ) →
Descrição
Define o título da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
cTitle | Caracter | Título da célula |
SetType
Sintaxe
TRCell():SetType( <cType> ) →
Descrição
Define o tipo de dado da célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
cType | Caracter | Tipo de dado |
SetValue
Sintaxe
TRCell():SetValue( <uValue> ) →
Descrição
Define um valor constante para a célula
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
uValue | Valor constante Definindo um valor constante para a célula, esta não utilizara o nome mais o alias para impressão do conteúdo, ou seja, a célula passará a se comportar como um variável de um programa. |
XmlLoad
Sintaxe
TRCell():XmlLoad( <oXml> ) →
Descrição
Carrega uma célula do layout personalizado pelo usuário
Parâmetros
Nome | Tipo | Descrição | Obrigatório |
---|---|---|---|
oXml | Objeto | Objeto do tipo XML com as personalizações da célula |
XmlSave
Sintaxe
TRCell():XmlSave( ) →
Descrição
Salva a célula no layout personalizado pelo usuário