TRSection

AddCell

Sintaxe
TRSection():AddCell( <oCell> ) →

Descrição
Adiciona a célula na propriedade aCell da seção

Parâmetros

AddOrder

Sintaxe
TRSection():AddOrder( <oOrder> ) →

Descrição
Adiciona a ordem da seção na propriedade aOrder

Parâmetros

AddPosCell

Sintaxe
TRSection():AddPosCell( <oCell> ) →

Descrição
Adiciona a célula, na sequência de impressão da seção, na propriedade aPosCell

Parâmetros

AddTable

Sintaxe
TRSection():AddTable( <cTable> ) →

Descrição
Adiciona a tabela, que será utilizada na impressão da seção, na propriedade aTable

Parâmetros

Alias

Sintaxe
TRSection():Alias( ) → aArray

Descrição
Retorna o alias da tabela utilizado pela query da seção, definida pelo Embedded SQL com os métodos BeginQuery e EndQuery

Retorno
aArray - Array com Alias da tabela posicionada

AutoSize

Sintaxe
TRSection():AutoSize( ) → lRet

Descrição
Retorna se a impressão da seção será ajustada automaticamente

Retorno
Se verdadeiro, ajusta automaticamente a impressão das células da seção

BeginQuery

Sintaxe
TRSection():BeginQuery( ) →

Descrição
Indica que será utilizado o Embedded SQL para criação de uma query para a seção

Observação
Ao utilizar o método BeginQuery, toda a execução de querys via Embedded SQL fica no controle desse método e do EndQuery, por isso recomendamos que todas as funções que serão utilizadas para a montagem da query, sejam utilizadas antes de chamar esse método, evitando que alguma função que faça uso do Embeded SQL tenha seu comportamento alterado.

Cell

Sintaxe
TRSection():Cell( <uCell> ) → oRet

Descrição
Retorna o objeto da classe TRCell (célula) baseado

Parâmetros

Retorno
oRet - Objeto da classe TRCell

CellBorder

Sintaxe
TRSection():CellBorder( <uBorder> , <lHeader> ) → oRet

Descrição
Retorna a borda do seção

Parâmetros

Retorno
oRet - Objeto do tipo TRBorder

CellPos

Sintaxe
TRSection():CellPos( <lReset> ) →

Descrição
Ordena as células para impressão

Parâmetros

CharSeparator

Sintaxe
TRSection():CharSeparator( ) →

Descrição
Retorna o caracter que separa as informações na impressão das células em linha

Retorno
cCharSeparator - Caracter utilizado para separar as informações

CheckFields

Sintaxe
TRSection():CheckFields( <aTables> , <aMemo> , <lEnabled> , <aHasArea> , <nTotCell> , <cSelect> ) → cRet

Descrição
Retorna as células que poderão ser adicionadas na query, ou seja, retira os campos do tipo Memo e as células que não foram selecionadas pelo usuário

Parâmetros

Retorno
oRet - Caracter - Campos a serem considerados na query

ChkMainFilter

Sintaxe
TRSection():ChkMainFilter( <cAlias> ) → cFilter

Descrição
Retorna o filtro da tabela

Parâmetros

Retorno
cFilter - Caracter - Filtro da tabela

CheckWidth

Sintaxe
TRSection():CheckWidth( <nWidth> ) → nRet

Descrição
Retorna a largura da seção

Parâmetros

Retorno
nRet - Numérico - Largura da seção

CloseFilter

Sintaxe
TRSection():CloseFilter( ) →

Descrição
Finaliza todos os filtros da seção

CloseQuery

Sintaxe
TRSection():CloseQuery( <lSections> ) →

Descrição
Finaliza todas as querys da seção

Parâmetros

DelUserCell

Sintaxe
TRSection():DelUserCell( ) →

Descrição
Exclui as células adicionadas pelo usuário

EndQuery

Sintaxe
TRSection():EndQuery( <aParam> ) →

Descrição
Indica a query criada utilizando o Embedded SQL para a seção. O método EndQuery irá juntar na query as células selecionadas e o filtro criado pelo usuário, mais a expressão das perguntas do tipo Range, que foram convertidas anteriormente pela função MakeSQLExpr. Após sua execução, 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

Parâmetros

EndBorder

Sintaxe
TRSection():EndBorder( ) →

Descrição
Finaliza a impressão das bordas

EvalCell

Sintaxe
TRSection():EvalCell( ) →

Descrição
Atualiza o conteúdo de todas as células da seção

EvalFunction

Sintaxe
TRSection():EvalFunction( ) →

Descrição
Atualiza o conteúdo dos totalizadores da seção

EvalPosition

Sintaxe
TRSection():EvalPosition( ) →

Descrição
Atualiza o conteúdo das células utilizadas na impressão da seção

ExecSql

Sintaxe
TRSection():ExecSql( ) →

Descrição
Executa a query da seção

ExUserFilter

Sintaxe
TRSection():ExUserFilter( ) → lRet

Descrição
Executa os filtros definidos pelo usuário

Retorno
lRet - Lógico - Retorno da execução do filtro (Verdadeiro ou Falso)

Finish

Sintaxe
TRSection():Finish( ) →

Descrição

Finaliza a impressão da seção, imprime os totalizadores, tratamentos de quebras das seções, entre outros tratamentos do componente. Não é necessário executar o método Finish se for utilizar o método Print, já que este faz o controle de inicialização e finalização da impressão.

ForceLineStyle

Sintaxe
TRSection():ForceLineStyle( ) → Nil

Descrição
Força a impressão da seção em linhas. A impressão em linha é o estilo: rótulo/título: conteúdo da célula.

Exemplo

GetAdvplExp

Sintaxe
TRSection():GetAdvplExp( ) →

Descrição
Força a impressão da seção em linhas

GetDynamicKey

Sintaxe
TRSection():GetDynamicKey( ) → cDynamicKey

Descrição
Retorna a chave dinâmica utilizada para geração de relatórios dinâmicos

Retorno
cDynamicKey - Caracter - Chave dinâmica

GetIdxOrder

Sintaxe
TRSection():GetIdxOrder( ) → nIdxOrder

Descrição
Retorna o índice utilizado pela tabela principal da seção

Retorno
nIdxOrder - Numérico - Índice utilizado pela tabela principal

GetOrder

Sintaxe
TRSection():GetOrder( ) → nOrder

Descrição
Retorna a ordem selecionada

Retorno
nOrder - Numérico - Ordem selecionada pelo usuário

GetParentQuery

Sintaxe
TRSection():GetParentQuery( ) →

Descrição
Atualiza as Informações de query da seção atual com as Informações da seção pai

GetQuery

Sintaxe
TRSection():GetQuery( ) → cRet

Descrição
Retorna a query, que foi definida pelo Embedded SQL com os métodos BeginQuery e EndQuery, com as células selecionadas, o filtro criado pelo usuário e as perguntas do tipo Range inclusas

Retorno
cRet - Caracter - String com a query

GetSqlExp

Sintaxe
TRSection():GetSqlExp( <cAlias> ) →

Descrição
Retorna o filtro do usuário em forma de expressão SQL

Parâmetros

Retorno
Filtro do usuário em forma de expressão SQL

GetUseQuery

Sintaxe
TRSection():GetUseQuery( ) → cRet

Descrição
Retorna se a seção utilize query para impressão

Retorno
lCellUseQuery - Lógico - Se verdadeiro, a query é utilizada impressão

GetUserExp

Sintaxe
TRSection():GetUserExp( <cAlias> , <lSql> , <lPosition> ) → cExp

Descrição
Retorna o filtro de usuário

Parâmetros

Retorno
cExp - Caracter - Filtro do usuário ou
nPos - Numérico - Posição do filtro

GetUserFilter

Sintaxe
TRSection():GetUserFilter( ) → aArray

Descrição
Retorna os filtros de usuário

Retorno
aArray - Array contendo os filtros da seção

GetWidth

Sintaxe
TRSection():GetWidth( ) → nRet

Descrição
Retorna a largura da seção

Retorno
nRet - Numérico - Largura da seção

HeaderBreak

Sintaxe
TRSection():HeaderBreak( ) → lRet

Descrição
Retorna se o cabeçalho das células será impresso após uma quebra (TRBreak)

Retorno
lRet - Lógico - Se verdadeiro, aponta que será impresso o cabeçalho

HeaderSection

Sintaxe
TRSection():HeaderSection( ) → lRet

Descrição
Retorna se o cabeçalho das células será impresso na quebra de seção

Retorno
lRet - Lógico - Se verdadeiro, aponta que será impresso o cabeçalho

Hide

Sintaxe
TRSection():Hide( ) →

Descrição
Desabilita a impressão da seção, porém todas as linhas serão processadas, somente não aparecerão no relatório.

Init

Sintaxe
TRSection():Init( <lHeader> ) →

Descrição
Executa as quebras de seções, imprime cabeçalhos entre outras configurações do relatório. Não é necessário executar o método Init se for utilizar o método Print, já que estes fazem o controle de inicialização e finalização da impressão

Parâmetros

IniRow

Sintaxe
TRSection():IniRow( ) →

Descrição
Inicializa a linha posicionada nas seções

LineCount

Sintaxe
TRSection():LineCount( ) → nRet

Descrição
Quantidade de linhas a serem impressas para cada registro da seção

Retorno
nRet - Numérico - Quantidade de linhas a serem impressas

LoadCells

Sintaxe
TRSection():LoadCells( <cTable> , <aCells> , <lDisableAll> , <lMarkAsUser> ) →

Descrição
Carrega campos do Dicionário de Campos (SX3) como células da seção, respeitando nível, uso e contexto do campo

Parâmetros

SetRelation

Sintaxe
TRSection():SetRelation( <bFormula> , <cAlias> , <uOrder> , <lSeek> ) →

Descrição
Define a fórmula de relacionamento de uma seção filha com sua seção pai, caso não utilize a query da seção pai através do método SetParentQuery

Parâmetros

LoadOrder

Sintaxe
TRSection():LoadOrder( ) →

Descrição
Carrega índices do Dicionário de Índices (SIX) como ordem da seção

lReadOnly

Sintaxe
TRSection():lReadOnly( ) → oRet

Descrição
Retorna se o usuário pode personalizar informações da seção

Retorno
oRet - Objeto - Caso verdadeiro, aponta que o usuário não pode alterar informações da seção

Name

Sintaxe
TRSection():Name( ) → cRet

Descrição
Retorna o nome da seção

Retorno
cRet - Caracter - Nome da seção

New

Sintaxe
TRSection():New( <oParent> , <cTitle> , <uTable> , <aOrder> , <lLoadCells> , <lLoadOrder> , <uTotalText> , <lTotalInLine> , <lHeaderPage> , <lHeaderBreak> , <lPageBreak> , <lLineBreak> , <nLeftMargin> , <lLineStyle> , <nColSpace> , <lAutoSize> , <cCharSeparator> , <nLinesBefore> , <nCols> , <nClrBack> , <nClrFore> , <nPercentage> ) →

Descrição
Método construtor da classe TRSection
No parâmetro onde é informado as tabelas utilizadas pela seção, a primeira será a principal, sendo utilizada para o processamento pelo método Print. As outras tabelas serão utilizadas para que o usuário possa incluir os campos como célula.
O relacionamento entre as tabelas poderá ser feito pela query ou então pelo uso dos objetos da classe TRPosition.
Dos elementos do parâmetro onde são informadas as ordens utilizada pela seção serão criados os objetos da classe TROrder automaticamente, utilizando como índice da tabela principal a ordem do elemento no vetor.

Parâmetros

NoCell

Sintaxe
TRSection():NoCell( ) → lRet

Descrição
Verifica se não existem células configuradas para a seção

Retorno
lRet - Lógico - Se verdadeiro, não existem células configuradas

OnPrintLine

Sintaxe
TRSection():OnPrintLine( <bOnPrintLine> ) →

Descrição
Permite efetuar tratamentos antes da impressão do registro da seção

Parâmetros

Order

Sintaxe
TRSection():Order( <uOrder> ) → oRet

Descrição
Retorna objeto da classe TROrder (ordem)

Parâmetros

Retorno
oRet - Objeto da classe TROrder

PageBreak

Sintaxe
TRSection():PageBreak( ) → lRet

Descrição
Retorna se salta a página na quebra de seção

Retorno
lRet - Lógico - Se verdadeiro, aponta que quebra página na seção

PageWidth

Sintaxe
TRSection():PageWidth( ) → nRet

Descrição
Retorna a largura da página

Retorno
nRet - Numérico - Largura da página

Parent

Sintaxe
TRSection():Parent( ) → oRet

Descrição
Retorna o objeto pai da classe TRSection

Retorno
oRet - Objeto TRSection ou TReport

Print

Sintaxe
TRSection():Print( <lFromParent> ) → oRet

Descrição
Realiza a impressão baseada na tabela ou query principal, executando o método PrintLine para cada linha e o método Print de todas as seções filhas. Nas seções filhas, o posicionamento inicial pode ser baseado na query da seção pai (através do método SetParentQuery) ou através da regra informada pelo método SetRelation, junto com a regra informada pelo método SetParentFilter que controla o fim da impressão

Parâmetros

PrintHeader

Sintaxe
TRSection():PrintHeader( <lCellPos> , <lVisible> , <cStyle> , <lExcel> ) → oRet

Descrição
Imprime o cabeçalho da seção

Parâmetros

PrintLine

Sintaxe
TRSection():PrintLine( <lEvalPosition> , <lParamPage,> , <lExcel> ) →

Descrição
Imprime a linha baseado nas células existentes

Parâmetros

ResetCellPos

Sintaxe
TRSection():ResetCellPos( <lResetAll> ) →

Descrição
Define que as células deverão ser ajustadas para impressão

Parâmetros

Report

Sintaxe
TRSection():Report( ) → oRet

Descrição
Retorna o objeto da classe TReport que a classe TRSection pertence

Retorno
oRet - Objeto TReport

SetAutoSize

Sintaxe
TRSection():SetAutoSize( <lAutoSize> ) →

Descrição
Define que as células serão ajustadas automaticamente na seção

Parâmetros

SetCellBorder

Sintaxe
TRSection():SetCellBorder( <uBorder> , <nWeight> , <nColor> , <lHeader> ) → oRet

Descrição
Define a borda da seção

Parâmetros

Retorno
oRet - Objeto do tipo TRBorder

SetCharSeparator

Sintaxe
TRSection():SetCharSeparator( <cCharSeparator> ) →

Descrição
Retorna o caracter que separa as informações na impressão das células em linha

Parâmetros

SetCols

Sintaxe
TRSection():SetCols( <nCols> ) →

Descrição
Define a quantidade de  colunas a serem impressas

Parâmetros

SetDynamicKey

Sintaxe
TRSection():SetDynamicKey( <cDynamicKey> ) →

Descrição
Define a chave que identifica a seção na impressão dinâmica

Parâmetros

SetEdit

Sintaxe
TRSection():SetEdit( <lEdit> ) →

Descrição
Define se a seção poderá ser personalizada pelo usuário

Parâmetros

SetEditCell

Sintaxe
TRSection():SetEditCell( <lEditCell> ) →

Descrição
Define se o usuário poderá personalizar as células da seção

Parâmetros

SetFilter

Sintaxe
TRSection():SetFilter( <cFilter> , <cIndexKey> , <cOrdem> , <cAlias> , <nIdxOrder> ) →

Descrição
Define um filtro para a tabela principal da seção. Se não informado o parâmetro com a chave de índice, será executado SET FILTER TO com o primeiro parâmetro, senão será criado um índice com filtro (IndRegua)

Parâmetros

SetHeaderBreak

Sintaxe
TRSection():SetHeaderBreak( <lHeaderBreak> ) →

Descrição
Define se imprime cabeçalho das células após uma quebra (TRBreak)

Parâmetros

SetHeaderPage

Sintaxe
TRSection():SetHeaderPage( <lHeaderPage> ) →

Descrição
Define que imprime cabeçalho das células no topo da página

Parâmetros

SetHeaderSection

Sintaxe
TRSection():SetHeaderSection( <lHeaderSection> ) →

Descrição
Define que imprime cabeçalho das células na quebra de seção

Parâmetros

SetIdxOrder

Sintaxe
TRSection():SetIdxOrder( <nIdxOrder> ) →

Descrição
Define uma ordem de índice para a tabela principal

Parâmetros

SetLineBreak

Sintaxe
TRSection():SetLineBreak( <lLineBreak> ) →

Descrição
Define que a impressão poderá ocorrer emu ma ou mais linhas no caso das colunas excederem o tamanho da página

Parâmetros

SetLineCondition

Sintaxe
TRSection():SetLineCondition( <bLineCondition> ) →

Descrição
Permite validar a impressão do registro

Parâmetros

SetLineStyle

Sintaxe
TRSection():SetLineStyle( <lLineStyle> ) →

Descrição
Define se imprime as células da seção em linhas

Parâmetros

SetLinesBefore

Sintaxe
TRSection():SetLinesBefore( <nLinesBefore> ) →

Descrição
Define a quantidade de linhas que serão saltadas antes da impressão da seção

Parâmetros

SetName

Sintaxe
TRSection():SetName( ) →

Descrição
Compatibilidade – Não utilizado

SetNoFilter

Sintaxe
TRSection():SetNoFilter( <cAlias> ) →

Descrição
Define que a tabela não poderá ser receber filtros de usuário

Parâmetros

SetUseQuery

Sintaxe
TRSection():SetUseQuery( <lCellUseQuery> ) →

Descrição
Define que a seção utilize query na impressão

Parâmetros

SetOrder

Sintaxe
TRSection():SetOrder( <nOrder> ) →

Descrição
Define a ordem (TROrder) que será utilizada pela seção

Parâmetros

SetPageBreak

Sintaxe
TRSection():SetPageBreak( <lPageBreak> ) →

Descrição
Define se salta a página na quebra de seção

Parâmetros

SetParentFilter

Sintaxe
TRSection():SetParentFilter( <bFilter> , <bParam> ) →

Descrição
Define a regra de saída do loop de impressão das seções filhas

Parâmetros

SetParentQuery

Sintaxe
TRSection():SetParentQuery( ) →

Descrição
Define que a seção filha utiliza a query da seção pai na impressão da seção

SetParentRecno

Sintaxe
TRSection():SetParentRecno( <lParentRecno> ) →

Descrição
Define se a seção utiliza o registro da seção pai

Parâmetros

SetPercentage

Sintaxe
TRSection():SetPercentage( <nPercentage> ) →

Descrição
Define o tamanho da página a ser considerada na impressão em percentual

Parâmetros

SetPrintLayout

Sintaxe
TRSection():SetPrintLayout( ) →

Descrição
Compatibilidade – Não utilizado

SetQuery

Sintaxe
TRSection():SetQuery( <cAlias> , <cQuery> , <lChangeQuery> , <aParam> , <aTCFields> ) →

Descrição
Aplica os tratamentos necessários para execução das querys, tais como, adicionar células de usuários, aplicação de filtros entre outros

Parâmetros

SetReadOnly

Sintaxe
TRSection():SetReadOnly( <lReadOnly> ) →

Descrição
Define que o usuário não poderá alterar informações da seção, ou seja, não poderá remover as células pré-definidas

Parâmetros

SetRelation

Sintaxe
TRSection():SetRelation( <bFormula> , <cAlias> , <uOrder> , <lSeek> ) →

Descrição
Define a fórmula de relacionamento de uma seção filha com sua seção pai, caso não utilize a query da seção pai através do método SetParentQuery

Parâmetros

SetRow

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

Descrição
Define a linha de impressão

Parâmetros

SetWidth

Sintaxe
TRSection():SetWidth( <nWidth> ) →

Descrição
Define a largura da seção

Parâmetros

Show

Sintaxe
TRSection():Show( ) →

Descrição
Habilita a impressão da seção

UseFilter

Sintaxe
TRSection():UseFilter( ) → lRet

Descrição
Retorna se existem células personalizadas pelo usuário

Retorno
lRet - Lógico - Se verdadeiro, existe célula personalizada

Visible

Sintaxe
TRSection():Visible( ) → lRet

Descrição
Retorna se a seção esta habilitada para impressão

Retorno
lRet - Lógico - Caso verdadeiro, a seção está habilitada

XmlLoad

Sintaxe
TRSection():XmlLoad( <oXml> ) →

Descrição
Carrega uma seção do layout personalizado pelo usuário

Parâmetros

IsAlignInCell

Sintaxe
TRSection():IsAlignInCell() → lRet

Descrição

Recupera se a definição de alinhamento para as células da seção, se usa o padrão de alinhamento dentro do tamanho das células.

Retorno

Verdadeiro que usa a forma padrão, alinhamento dentro do tamanho da célula.

IsExpandedAlignment

Sintaxe
TRSection():IsExpandedAlignment() → lRet

Descrição

Recupera a definição de alinhamento para as células da seção, se usa o formato expandido para colunas ignorando o tamanho das células.

Retorno

Verdadeiro que usa a forma expandida, alinhamento considerando o espaço disponível para a célula.

UseExpandedAlignment

Sintaxe
TRSection():UseExpandedAlignment() → Nil

Descrição

Define que a impressão em linha/com colunas deve usar o espaço total disponível até a próxima coluna e não somente o espaço do tamanho da célula.

oSection := TRSection():New(oReport,cSection,cAlias,aOrder,.T.,lLoadOrder)
oSection:UseExpandedAlignment()