Histórico da Página

Fornece

...

um

...

objeto

...

do

...

tipo

...

grid

...

que

...

permite

...

a

...

exibição

...

de

...

dados

...

do

...

tipo

...

array,

...

texto,

...

tabela

...

e

...

query.

Hierarquia

TGrid

Construtores

New

Construtor da classe

.

Sintaxe FWBrowse(): New ( [ oOwner] ) --> oSelf Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
oOwner	Objeto	Objeto proprietário

Retorno oSelf () Objeto FWBrowse Exemplos oBrowse := FWBrowse():New()

...

Métodos

Activate

Ativação da classe. Sintaxe FWBrowse(): Activate ( [ lFWBrowse] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lFWBrowse	Lógico	Indica se a chamada foi acionada pela classe FWBROWSE

Exemplos

oBrowse:Activate()

AddBrwRelation

Permite adicionar a informacao de um browse relacionado. Sintaxe FWBrowse(): AddBrwRelation ( < oBrwRel> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
oBrwRel	Objeto	Browse que se deseja informar como relacionado	X

Observações

null

AddColumn

Adiciona uma coluna no Browse em tempo de execução. Sintaxe FWBrowse(): AddColumn ( < aColumn> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aColumn	Array of Record	Indica o array com informações para criação da coluna.	X

aColumn Estrutura da Coluna

[n][01] Título da coluna
[n][02] Code-Block de carga dos dados
[n][03] Tipo de dados
[n][04] Máscara
[n][05] Alinhamento (0=Centralizado, 1=Esquerda ou 2=Direita)
[n][06] Tamanho
[n][07] Decimal
[n][08] Indica se permite a edição
[n][09] Code-Block de validação da coluna após a edição
[n][10] Indica se exibe imagem
[n][11] Code-Block de execução do duplo clique
[n][12] Variável a ser utilizada na edição (ReadVar)
[n][13] Code-Block de execução do clique no header
[n][14] Indica se a coluna está deletada
[n][15] Indica se a coluna será exibida nos detalhes do Browse (Somente valido para Browse de Tabela ou Query)
[n][16] Opções de carga dos dados (Ex: 1=Sim, 2=Não)

|

[n][17] Id da coluna

Observações

null

AddCustomConfig

[n][18] Indica se a coluna é virtual

AddCustomConfig

Permite adicionar uma configuração customizada na opção de configuração do Browse. Sintaxe FWBrowse(): AddCustomConfig ( < cTitle>, < bView>, [ bSave] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cTitle	Caracter	Título a ser exibido na configuração.	X


bView	Bloco de código	Code-Block de carga da janela de configuração	X


bSave	Bloco de código	Code-Block de gravação das configurações efetuadas pelo usuário.

Exemplos

oBrowse

Observações

null

Exemplos

oBrowse

:AddCustomConfig("Filial",{\|o\| MBrFilialCfg(o,Self) }, { \|\| MBrSaveFilCfg(Self) } )

AddFilter

Permite adicionar um filtro na lista de opções de filtros do Browse. Sintaxe FWBrowse(): AddFilter ( < cFilter>, < cExpAdvPL>, [ lNoCheck], [ lSelected], [ cAlias], [ lFilterAsk], [ aFilParser], [ cID] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cFilter	Caracter	Título que será exibido no filtro	X


cExpAdvPL	Caracter	Expressão do filtro em formato AdvPL.	X


lNoCheck	Lógico	Indica que o filtro não poderá ser marcado/desmarcado.


lSelected	Lógico	Indica que o filtro deverá ser apresentado como marcado/desmarcado.


cAlias	Caracter	Indica que o filtro é de relacionamento entre as tabelas e a expressão AdvPL deve ser informado obrigatoriamente com expressões SQL.


lFilterAsk	Lógico

Indica se o filtro pergunta as informações na execução.

Não suportado
aFilParser	Array of Record

Array contendo informações parseadas do filtro.

Observações

null

Não suportado
cID	Caracter	Nome do identificador do filtro

Exemplos oBrowse:AddFilter(cTitle,xCondition)

AddLine

Permite adicionar um linha

Observação Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

AddLegend

Permite adicionar legendas no Browse.

Sintaxe

FWBrowse():

AddLine (

AddLegend ( < xCondition>, < cColor>, <cTitle>, <cID>, <lFilter>) -->

Observações

null

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
xCondition	Expressão	Expressão AdvPL ou Code-Block com a regra da legenda	X
cColor	Caracter	Cor que identifica a regra	X
cTitle	Caracter	Título da legenda, utilizado na janela de visualização das legendas
cID	Caracter	Id
lFilter	Lógico	Indica se deve ser exibido filtro da legenda

Exemplos

oBrowse:AddLegend(xCondition,cColor,cTitle)

AddLine

Permite adicionar um linha no Browse. Sintaxe FWBrowse(): AddLine ( ) -->

AddMarkColumns

Permite adicionar uma coluna com a opção de marca e desmarca. Sintaxe FWBrowse(): AddMarkColumns ( < bMark>, [ bLDblClick], [ bHeaderClick] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bMark	Bloco de código	Code-Block com a regra e deverá retornar a imagem referente a marcado/desmarcado.	X


bLDblClick	Bloco de código	Code-Block com a execução do duplo clique na coluna.


bHeaderClick	Bloco de código	Code-Block com a execução do clique no header da coluna.

Observações

null

AddStatusColumns

Permite adicionar uma coluna

Permite adicionar uma coluna

de status. Sintaxe FWBrowse(): AddStatusColumns ( < bStatus>, [ bLDblClick] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bStatus	Bloco de código	Code-Block com a regra e deverá retornar a imagem referente ao status.	X


bLDblClick	Bloco de código	Code-Block com a execução do duplo clique na coluna.

Observações

null

Alias

Retorna o Alias utilizado no Browse. Sintaxe FWBrowse(): Alias ( ) --> cAlias Retorno cAlias (caracter) Alias utilizado no Browse.

Observações

null

AllOk

Executa o Code-Block definido no método SetAllOK(bAllOK). Sintaxe FWBrowse(): AllOk ( ) --> lReturn Retorno lReturn (logico) Retorno da execução do Code-Block.

Observações

null

At

Retorna a posição atual do registro. Sintaxe FWBrowse(): At ( ) --> nAt Retorno nAt () Posição atual do registro.

Observações

null

Browse

Retorna o componente Browse (TGRID). Sintaxe FWBrowse(): Browse ( ) --> oBrowse Retorno oBrowse () Objeto Browse (TGRID).

Observações

null

ClassName

Retorna o nome da classe (FWBROWSE). Sintaxe FWBrowse(): ClassName ( ) --> cClassName Retorno cClassName (caracter) Nome da classe.

Observações

null

CleanExFilter

Executa a limpeza dos filtros estendidos realizados no Browse. Sintaxe FWBrowse(): CleanExFilter ( ) -->

Observações

null

CleanFilter

Realizada a limpeza dos filtros utilizados no Browse. Sintaxe FWBrowse(): CleanFilter ( ) -->

Observações

null

CleanProfile

Elimina as configurações realizadas no Browse do perfil do usuário. Sintaxe FWBrowse(): CleanProfile ( ) -->

Observações

null

ColPos

Retorna a coluna posicionada no Browse Sintaxe FWBrowse(): ColPos ( [ lDeleted] ) --> nColPos Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lDeleted	Lógico	Indica que deve considerar as colunas deletadas.

Retorno nColPos () Coluna posicionada.

Observações

null

Data

Retorna o objeto de dados no Browse. Sintaxe FWBrowse(): Data ( ) --> oData Retorno oData () Retorna o objeto de dados do Browse

Observações

null

DataArray

Retorna se o dados apresentados no Browse é de Array. Sintaxe FWBrowse(): DataArray ( ) --> lDataArray Retorno lDataArray (logico) Indica que o Browse utiliza informações de um array.

Observações

null

DataQuery

Retorna se o dados apresentados no Browse é de Query. Sintaxe FWBrowse(): DataQuery ( ) --> lDataQuery Retorno lDataQuery (logico) Indica que o Browse utiliza informações de uma Query.

Observações

null

DataTable

Retorna se o dados apresentados no Browse é de Tabela. Sintaxe FWBrowse(): DataTable ( ) --> lDataTable Retorno lDataTable (logico) Indica que o Browse utiliza informações de uma Tabela.

Observações

null

DataText

Retorna se o dados apresentados no Browse é de Texto. Sintaxe FWBrowse(): DataText ( ) --> lDataText Retorno lDataText (logico) Indica que o Browse utiliza informações de um arquivo Texto.

Observações

null

DBFFilter

Indica se utiliza filtro para tabelas CODEBASE. Sintaxe FWBrowse(): DBFFilter ( ) --> lDBFFilter Retorno lDBFFilter (logico) Indica se utiliza filtro para tabelas CODEBASE.

Observações

null

DeActivate

Método de destruição da classe. Sintaxe FWBrowse(): DeActivate ( [ lFreeChildren] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lFreeChildren	Lógico	Indica se é necessário limpar a classe proprietária. (oOwner)

Observações

null

Default

Compatibilização com a MBrowse antiga. Sintaxe FWBrowse(): Default ( ) -->

Observações

null

DelColumn

Indica que uma determinada coluna está deletada. Sintaxe FWBrowse(): DelColumn ( < nColumn> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nColumn	Numérico	Indica a coluna que será marcada como deletada.	X

Observações

null

DeleteFilter

Permite realizar a exclusão de filtros. Sintaxe FWBrowse(): DeleteFilter ( [ cID] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cID	Caracter	Identificador do Filtro

Observações

null

DelLine

Executa o Code-Block, definido no método SetDelete(lDelete,bDelete), para deleção de uma linha no Browse. Sintaxe FWBrowse(): DelLine ( ) -->

Observações

null

DelOk

Executa o Code-Block, definido no método SetDelOk(bDelOK), para validar a deleção de uma linha no Browse. Sintaxe FWBrowse(): DelOk ( ) --> lReturn Retorno lReturn

()

Observações

null

Disable

Desabilita a utilização do Browse. Sintaxe FWBrowse(): Disable ( ) -->

Observações

null

DisableConfig

Desabilita a utilização das configurações do Browse. Sintaxe FWBrowse(): DisableConfig ( ) -->

Observações

null

DisableFilter

Desabilita a utilização do filtro no Browse. Sintaxe FWBrowse(): DisableFilter ( ) -->

Observações

null

DisableLocate

Desabilita a utilização do localizador de registro no Browse. Sintaxe FWBrowse(): DisableLocate ( ) --> DisableReport Desabilita a impressão das informações disponíveis no Browse. Sintaxe FWBrowse():

DisableReport

DisableLocate ( ) -->

Observações

null

DisableSaveConfig

Desabilita a gravação das configurações realizadas no Browse. Sintaxe FWBrowse(): DisableSaveConfig ( ) -->

Observações

null

DisableSeek

Desabilita a utilização da pesquisa no Browse. Sintaxe FWBrowse(): DisableSeek ( ) -->

Observações

null

Enable

Habilita a utilização do Browse. Sintaxe FWBrowse(): Enable ( ) -->

Observações

null

ExecuteFilter

Aplica os filtros realizados no Browse. Sintaxe FWBrowse(): ExecuteFilter ( [ lBrwUpdate] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lBrwUpdate	Lógico	Atualiza o Browse e posiciona no primeiro registro.

Observação

Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

Observações

null

Filtrate

Indica se o Browse está filtrado. Sintaxe FWBrowse(): Filtrate ( ) --> lFiltrate Retorno lFiltrate (logico) Indica se o Browse está filtrado.

Observações

null

FWFilter

Retorna o objeto FWFilter. Sintaxe FWBrowse(): FWFilter ( ) --> oFWFilter Retorno oFWFilter () Retorna o objeto FWFilter.

Observações

null

GetBackColor

Retorna a cor de fundo do Browse. Sintaxe FWBrowse(): GetBackColor ( ) --> nBackColor Retorno nBackColor () Retorna a cor de fundo do Browse

Observações

null

GetClrAlterRow

Retorna a cor alternada do Browse. Sintaxe FWBrowse(): GetClrAlterRow ( ) --> nClrAlterRow Retorno nClrAlterRow () Retorna a cor alternada do Browse

Observações

null

GetColumn

Retorno um objeto tipo FWBrwColumn da coluna passada. Sintaxe FWBrowse(): GetColumn (

) --> nCol()

[nCol]) Retorno

nCol

oCol

Retorna

a

o objeto da coluna posicionada.

Observações

null

GetDescription

Retorna a descrição do Browse. Sintaxe FWBrowse(): GetDescription ( ) --> cDescription Retorno cDescription (caracter) Retorna a descrição do Browse

GetFilterDefault

Retorna o filtro padrão do Browse Sintaxe FWBrowse(): GetFilterDefault ( ) --> cFilterDefault Retorno cFilterDefault (caracter) Retorna o filtro padrão do Browse.

Observações

null

GetForeColor

Retorna a cor da fonte do Browse. Sintaxe FWBrowse(): GetForeColor ( ) --> cForeColor Retorno cForeColor (caracter) Retorna a cor da fonte do Browse.

Observações

null

GetObjMark

Retorna o objeto FWMARKBROWSE utilizado na passagem de parâmetros na execução das rotinas na FWFORMBROWSE; Sintaxe FWBrowse(): GetObjMark ( ) --> oObjMark Retorno oObjMark () Indica o objeto FWMARKBROWSE

Observações

null

GetProfileID

Retorna o identificador do Browse utiliza na gravação das configurações no profile do usuário. Deve ser utilizado quando existir mais de um Browse na rotina. Sintaxe FWBrowse(): GetProfileID ( ) --> cProfileID Retorno cProfileID (caracter) Identificador do Browse

Observações

null

GetQuery

Retorna a Query que esta sendo utilizada no Browse. Sintaxe FWBrowse(): GetQuery ( ) --> cQuery Retorno cQuery (caracter) Indica a Query para a criação do Browse.

Observações

null

GoBottom

Posiciona no último registro do Browse. Sintaxe FWBrowse(): GoBottom ( [ lCallRefresh] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lCallRefresh	Lógico	Indica que foi chamado através do método Refresh().

GoColumn

Posiciona na coluna desejada.

Observações

null

GoColumn

Posiciona na coluna desejada.

Sintaxe FWBrowse(): GoColumn ( [ nColumn] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nColumn	Numérico	Indica a coluna que deseja posicionar.

Observações

null

GoDown

Salta uma ou mais linhas para baixo do item posicionado. Sintaxe FWBrowse(): GoDown ( [ nOffSet], [ lReport] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nOffSet	Numérico	Indica a quantidade de linhas a serem saltadas.


lReport	Lógico	Indica se é impressão dos itens do Browse.

Observações

null

GoPgDown

Salta uma página para baixo do item posicionado. Sintaxe FWBrowse(): GoPgDown ( ) --> GoPgUp Salta uma página para cima do item posicionado. Sintaxe FWBrowse(): GoPgUp ( ) -->

Observações

null

GoTo

Posiciona em um determinado registro do Browse. Sintaxe FWBrowse(): GoTo ( < nGoto>, [ lRefresh] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nGoto	Numérico	Indica o item que deverá ser posicionado.	X


lRefresh	Lógico	Indica se deverá forçar a atualização do Browse.

Observações

null

GoTop

Posiciona no primeiro registro do Browse. Sintaxe FWBrowse(): GoTop ( [ lForce] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lForce	Lógico	Indica que deverá forçar o posicionamento.

Observações

null

GoUp

Salta uma ou mais linhas

Salta uma ou mais linhas

para cima do item posicionado. Sintaxe FWBrowse(): GoUp ( [ nOffSet] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nOffSet	Numérico	Indica a quantidade de linhas a serem saltadas.

Observações

null

Hide

Permite tornar o Browse invisível Sintaxe FWBrowse(): Hide ( ) -->

Observações

null

LineOk

Executa o Code-Block, definido no método SetLineOk(bLineOk), para validação da linha posicionada. Sintaxe FWBrowse(): LineOk ( ) --> lRet Retorno lRet (logico) Indica se a linha é válida.

LineRefresh

Executa a atualização das informações de uma determinada linha do Browse. Sintaxe FWBrowse(): LineRefresh ( [ nAt] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nAt	Numérico	Indica a linha que será atualizada.

Observações

null

LogicLen

Observação:

O parâmetro nAt que refere-se a linha, começa em zero, ele índice é enviado para o método TGrid:SetRowData do binário.

LogicLen

Retorna a quantidade de registros disponíveis para o browse. Sintaxe FWBrowse(): LogicLen ( ) --> nLogicLen Retorno nLogicLen () Indica a quantidade de registros disponíveis.Quando o Browse for de tabela ou Query será retornado o último registro para a orderm selecionada.

Observações

null

ObligateFilter

ObligateFilter

Retorna se a

Retorna se a

selecão de um filtro é obrigatório para a apresentação do browse. Sintaxe FWBrowse(): ObligateFilter ( ) --> lObligateFilter Retorno lObligateFilter (logico) Indica se a selecão de um filtro é obrigatório para a apresentação do browse

Observações

null

OptionConfig

Observação Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

OptionConfig

Indica se a opção de configuração do Browse está habilitada. Sintaxe FWBrowse(): OptionConfig ( ) --> lOptionConfig Retorno lOptionConfig (logico) Indica se a opção de configuração está habilitada.

Observações

null

OptionReport

Indica se a opção de impressão das informações do Browse está habilitada. Sintaxe FWBrowse(): OptionReport ( ) --> lOptionReport Retorno lOptionReport (logico) Indica se a opção de impressão está habilitada.

Observações

null

Refresh

Executa a atualização das informações no Browse. Sintaxe FWBrowse(): Refresh ( [ lGoTop] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lGoTop	Lógico	Indica que deverá ser posicionado no primeiro registro do Browse.

Observações

null

Report

Executa a impressão das informações do Browse. Sintaxe FWBrowse(): Report ( ) -->

Reset

Compatibilidade com o Browse antigo. Sintaxe FWBrowse(): Reset ( ) -->

Observações

null

ResetLen

ResetLen

Compatibilidade com o

Compatibilidade com o

Browse antigo. Sintaxe FWBrowse(): ResetLen ( ) -->

SetAddLine

Indica a Code-Block executado para adicionar linha no browse. Sintaxe FWBrowse(): SetAddLine ( < bAdd> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bAdd	Bloco de código	Indica a Code-Block executado para adicionar linha no browse.	X

Observações

null

SetAfterAddLine

Indica o Code-Block que será executado após a inclusão de uma linha. Sintaxe FWBrowse(): SetAfterAddLine ( < bAfterAddLine> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bAfterAddLine	Bloco de código	Code-Block a ser executado após a inclusão de uma linha.	X

Observações

null

SetAlias

Indica o alias da tabela que será utilizada no Browse. Sintaxe FWBrowse(): SetAlias ( < cAlias> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cAlias	Caracter	Indica o alias da tabela	X

SetAllOk

Indica o Code-Block executado para validar todos itens do Browse. Sintaxe FWBrowse(): SetAllOk ( < bAllOk> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bAllOk	Bloco de código	Code-Block para validar todos itens do Browse.	X

Observações

null

SetArray

Indica o array utilizado para apresentação dos dados no Browse. Sintaxe FWBrowse(): SetArray ( < aArray> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aArray	Array of Record	Array utilizado para apresentação dos dados no Browse.	X

Observações

null

SetBackColor

Indica a cor de fundo do Browse. Sintaxe FWBrowse(): SetBackColor ( < nBackColor> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nBackColor	Numérico	Cor de fundo do Browse.	X

Observações

null

SetBlkBackColor

Indica a

Indica a

cor de fundo para a linha atual. Sintaxe FWBrowse(): SetBlkBackColor ( < bBackColor> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bBackColor	Bloco de código	Codigo de bloco que retorna a cor de fonte para a linha atual.	X

SetBlkColor

Indica a cor de fonte para a linha atual. Sintaxe FWBrowse(): SetBlkColor ( < bBlkColor> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bBlkColor	Bloco de código	Codigo de bloco que retorna a cor de fonte para a linha atual.	X

Observações

null

SetChange

Indica a Code-Block executado após a mudança de uma linha. Sintaxe FWBrowse(): SetChange ( < bChange> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bChange	Bloco de código	Code-Block executado após a mudança de uma linha.	X

Observações

null

SetClrAlterRow

Indica a cor alternada do Browse. Sintaxe FWBrowse(): SetClrAlterRow ( < nClrAlterRow> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nClrAlterRow	Numérico	Indica a cor de alternada do Browse.	X

Observações

null

SetColumns

SetDataArray

Indica que o Browse exibe dados através de um array.

Adiciona uma coluna no Browse em tempo de execução.

Sintaxe FWBrowse():

SetColumns

SetDataArray (

< aColumns>

) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aColumns	Array of Record	Array contendo as informações da coluna.	X

Observação Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

SetDataQuery

Indica que o Browse exibe dados através de uma Query, porém, a Query cria um arquivo temporário atualizando de acordo com a demanda. Sintaxe FWBrowse(): SetDataQuery ( ) -->

SetDataTable

SetDataArray

Indica que o Browse exibe dados através de

um array

uma tabela.

Sintaxe FWBrowse():

SetDataArray

SetDataTable ( ) -->

Observações

null

SetDataText

Indica que o Browse exibe dados através de um arquivo texto.

SetDataQuery

Indica que o Browse exibe dados através de uma Query, porém, a Query cria um arquivo temporário atualizando de acordo com a demanda.

Sintaxe

FWBrowse(): SetDataQuery ( ) -->

Observações

null

SetDataTable

Indica que o Browse exibe dados através de uma tabela.

Sintaxe FWBrowse():

SetDataTable

SetDataText ( ) -->

SetDelete

Indica que o usuário pode excluir linhas no Browse.

Observações

null

SetDataText

Indica que o Browse exibe dados através de um arquivo texto.

Sintaxe FWBrowse():

SetDataText (

SetDelete ( [ lDelete], [ bDelete] ) -->

Observações

Parâmetros

null

Nome	Tipo	Descrição	Obrigatório	Referência
lDelete	Lógico	Indica se

SetDelete

Indica que

o usuário pode excluir linhas no Browse.
bDelete	Bloco de código	Code-Block executado na exclusão da linha.

SetDelOk

Indica o Code-Block executado para validar a exclusão da linha.

Sintaxe FWBrowse():

SetDelete ( [ lDelete], [ bDelete]

SetDelOk ( < bDelOK> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

lDeleteLógicoIndica se o usuário pode excluir linhas no Browse. bDelete

bDelOK

Bloco de código

Code-Block executado

na

para validar a exclusão da linha.

X

SetDescription

Indica a descrição do Browse.

Observações

null

SetDelOk

Indica o Code-Block executado para validar a exclusão da linha. Sintaxe

Sintaxe

FWBrowse():

SetDelOk

SetDescription ( <

bDelOK>

cDescription> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

bDelOK

cDescription

Bloco de código

Caracter

Indica a descrição do Browse

Code-Block executado para validar a exclusão da linha.

X

SetDoubleClick

Indica o Code-Block executado no duplo clique do item no

Observações

null

SetDescription

Indica a descrição do

Browse.

Sintaxe FWBrowse():

SetDescription

SetDoubleClick ( <

cDescription>

bLDblClick> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cDescription

bLDblClick

CaracterIndica a descrição do BrowseX

Bloco de código

Code-Block executado no duplo clique do item no Browse.

X

SetFieldFilter

Indica os campos que serão apresentados na edição de filtros.

Observações

null

SetDoubleClick

Indica o Code-Block executado no duplo clique do item no Browse.

Sintaxe FWBrowse():

SetDoubleClick

SetFieldFilter ( <

bLDblClick>

aFields> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aFields

bLDblClickBloco de códigoCode-Block executado no duplo clique do item no Browse.X

Observações

null

SetEditCell

Array of Record

Array contendo os campos apresentados na edição de filtros.

O formato para do parâmetroaFields deve ser:

[n][01] Campo
[n][02] Título
[n][03] Tipo de dado
[n][04] Tamanho
[n][05] Decimal
[n][06] Picture

Exemplo:
{ {"CAMPO1", "Campo 1", "C", 10, 0, "@!"}, {"CAMPO2", "Campo 2", "D", 8, 0, ""} }

X

Observação

Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

SetFile

Indica o arquivo texto que será utilizado no Browse.

Indica que será permitido a edição da célula no Browse.

Sintaxe FWBrowse():

SetEditCell ( [ lEditCell]

SetFile ( < cFile>, [

bValidEdit

cCharSeparator] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

lEditCell

cFile

LógicoIndica se permite a edição de células. bValidEditBloco de códigoCode-Block executado para validar a edição da célula.

Observações

null

SetFieldFilter

Caracter	Arquivo texto. Ex.: "\Browse\Teste.txt"	X
cCharSeparator	Caracter	Indica o caracter separador dos dados. Ex.: ";" para "dados1;dados2;dados3"

SetFilter

Indica o limite superior e inferior de um campo respeitando a classificação das informações atual

Indica os campos que serão apresentados na edição de filtros

.

Sintaxe FWBrowse():

SetFieldFilter

SetFilter (

< aFields>

< cCpoFil>, < cTopFun>, [ cBotFun] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

aFields

cCpoFil

Array of Record

Caracter

Indica o campo a ser considerado o limite superior e inferior

Array contendo os campos apresentados na edição de filtros

.

X

Observações

null


cTopFun	Caracter	Indica o limite superior.	X
cBotFun	Array of Record	Indica o limite inferior.

Observação

Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

SetFilterDefault

Indica o filtro padrão do Browse.

SetFile

Indica o arquivo texto que será utilizado no Browse.

Sintaxe FWBrowse():

SetFile

SetFilterDefault ( <

cFile>, [ cCharSeparator]

cFilterDefault> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cFile

cFilterDefault

Caracter

Arquivo texto. Ex.: "\Browse\Teste.txt"

Indica o filtro AdvPL para o Browse.

X

cCharSeparatorCaracterIndica o caracter separador dos dados. Ex.: ";" para "dados1;dados2;dados3"

Observação

Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

SetFocus

Força o foco no objeto Browse.

SetFilter

Indica o limite superior e inferior de um campo respeitando a classificação das informações atual.

Sintaxe FWBrowse():

SetFilter ( < cCpoFil>, < cTopFun>, [ cBotFun]

SetFocus ( ) -->

SetFontBrowse

Indica a fonte do Browse.

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cCpoFil	Caracter	Indica o campo a ser considerado o limite superior e inferior.	X
cTopFun	Caracter	Indica o limite superior.	X
cBotFun	Array of Record	Indica o limite inferior.

Observações

null

SetFilterDefault

Indica o filtro padrão do Browse.

Sintaxe FWBrowse():

SetFilterDefault ( < cFilterDefault>

SetFontBrowse ( [ oFont] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cFilterDefault

oFont

Caracter

Objeto

Indica o

filtro AdvPL para o

objeto TFont utilizado no Browse.

SetForeColor

Indica a cor da fonte no Browse.

X

Observações

null

SetFilterRelation

Indica o relacionamento de filtros para o Browse.

Sintaxe FWBrowse():

SetFilterRelation

SetForeColor ( <

aFilterRelation>, < bChgFields>

nForeColor> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

aFilterRelation

nForeColor

Array of Record

Numérico

Cor da fonte no Browse

Array contendo os itens do relacionamento

.

X

bChgFieldsBloco de códigoSetGroup

Indica

o Code-Block executado para trocar os campos para o filtro.X

Observações

null

que o Browse utiliza agrupamento de informações.

SetFocus

Força o foco no objeto Browse.

Sintaxe

FWBrowse(): SetGroup ( < bGroup>, [ lOpen] ) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bGroup	Bloco de código	Code-Block com a regra do agrupamento retornando um valor lógico (.T. = Quebra, .F. = Filho ).	X
lOpen	Lógico	Indica que o agrupamento será apresentado com os sub-itens visíveis na abertura do Browse.

SetHeaderImage

Indica a imagem que será apresentada ao lado do título da coluna. Sintaxe FWBrowse():

SetFocus

SetHeaderImage ( < nColumn>, < cResource> ) -->

SetFontBrowse

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nColumn	Numérico	Indica coluna que será apresentada a imagem.	X
cResource	Caracter	Indica a imagem que será apresentada ao lado da coluna.	X

SetInsert

Indica que o usuário poderá inserir novas linhas no Browse.

Indica a fonte do Browse.

Sintaxe FWBrowse():

SetFontBrowse

SetInsert ( [

oFont

lInsert] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

oFont

lInsert

Objeto

Lógico

Indica que poderá inserir novas linhas.

SetItemDoubleClick

Indica os itens que serão disponibilizados para a configuração do duplo clique pelo usuário.

o objeto TFont utilizado no Browse.

Observações

null

SetForeColor

Indica a cor da fonte no Browse.

Sintaxe FWBrowse():

SetForeColor

SetItemDoubleClick ( <

nForeColor>

aItemDoubleClick> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

nForeColor

aItemDoubleClick

Numérico

Array of Record

Array contendo as informações que serão apresentadas para configuração do duplo clique

Cor da fonte no Browse

.

X

SetItemHeaderClick

Indica os itens que serão disponibilizados para a configuração do clique no header pelo usuário

Observações

null

SetGroup

Indica que o Browse utiliza agrupamento de informaçõesSintaxe

.

Sintaxe

FWBrowse():

SetGroup

SetItemHeaderClick ( <

bGroup>, [ lOpen]

aItemHeaderClick> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aItemHeaderClick	Array of Record	Indica os itens que serão disponibilizados para a configuração do clique no header pelo usuário.	X

SetLineBegin

Indica a linha do arquivo texto que deverá ser considerado para ínicio da leitura no Browse.

bGroupBloco de códigoCode-Block com a regra do agrupamento retornando um valor lógico (.T. = Quebra, .F. = Filho ).X lOpenLógicoIndica que o agrupamento será apresentado com os sub-itens visíveis na abertura do Browse.

Observações

null

SetHeaderImage

Indica a imagem que será apresentada ao lado do título da coluna.

Sintaxe FWBrowse():

SetHeaderImage

SetLineBegin ( <

nColumn>, < cResource>

nLineBegin> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

nColumn

nLineBegin

Numérico

Indica

coluna que será apresentada a imagem

a linha inicial do arquivo texto.

X

cResourceSetLineHeight

Caracter

Indica a

imagem que será apresentada ao lado da coluna.X

Observações

null

altura da linha no Browse.

SetIdAlias

Indica o ID para Browses que trabalham com Left Join.

Sintaxe FWBrowse():

SetIdAlias ( < cIdAlias>

SetLineHeight ( [ nHeight] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nHeight	Numérico	Indica a altura da linha

SetLineOk

Indica o Code-Block executado na troca de linha do Browse.

cIdAliasCaracterIndica o ID para Browses que trabalham com Left Join.X

Observações

null

SetInsert

Indica que o usuário poderá inserir novas linhas no Browse.

Sintaxe FWBrowse():

SetInsert ( [ lInsert]

SetLineOk ( < bLineOk> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

lInsert

bLineOk

Bloco de código

Code-Block executado na troca de linha.

X

SetLocate

Habilita a utilização do localizador de registros no Browse.

LógicoIndica que poderá inserir novas linhas.

Observações

null

SetItemDoubleClick

Indica os itens que serão disponibilizados para a configuração do duplo clique pelo usuário.

Sintaxe FWBrowse():

SetItemDoubleClick ( < aItemDoubleClick>

SetLocate ( [ bAction] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bAction	Bloco de código	Code-Block executado para localização das informações, caso não seja informado será utilizado o padrão.

SetNumberLegend

Indica que a legenda será representada por números.

aItemDoubleClickArray of RecordArray contendo as informações que serão apresentadas para configuração do duplo clique.X

SetItemHeaderClick

Indica os itens que serão disponibilizados para a configuração do clique no header pelo usuário.

Sintaxe FWBrowse():

SetItemHeaderClick ( < aItemHeaderClick>

SetNumberLegend ( [ lNumber] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

aItemHeaderClick

lNumber

Array of Record

Lógico

Indica

os itens

que a legenda será representada por números.

SetObjMark

Indica o objeto FWMARKBROWSE utilizado na passagem de parâmetros na execução das rotinas na FWFORMBROWSE.

serão disponibilizados para a configuração do clique no header pelo usuário.X

Observações

null

SetLineBegin

Indica a linha do arquivo texto que deverá ser considerado para ínicio da leitura no Browse.

Sintaxe FWBrowse(): SetObjMark ( < oObjMark> ) -

SintaxeFWBrowse(): SetLineBegin ( < nLineBegin> ) -

-> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

nLineBegin

oObjMark

Numérico

Objeto

Indica

a linha inicial do arquivo texto.

o objeto FWMARKBROWSE

X

SetObligateFilter

Indica se a selecão de um filtro é obrigatório para a apresentação do browse.

Observações

null

SetLineHeight

Indica a altura da linha no Browse.

Sintaxe FWBrowse():

SetLineHeight

SetObligateFilter ( [ lObligateFilter], [

nHeight

lCanCancel] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

nHeight

lObligateFilter

Numérico

Lógico	Indica que o filtro será solicitado na entrada do Browse
lCanCancel	Lógico	Indica que permite o cancelamento na tela de filtros.

Observação

Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

SetOwner

Indica o container para criação do Browse.

a altura da linha

Observações

null

SetLineOk

Indica o Code-Block executado na troca de linha do Browse.

Sintaxe FWBrowse():

SetLineOk ( < bLineOk>

SetOwner ( [ oOwner] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

bLineOk

oOwner

Bloco de códigoCode-Block executado na troca de linha.X

Observações

null

SetLocate

Habilita a utilização do localizador de registros no Browse.

SintaxeFWBrowse(): SetLocate ( [ bAction]

Objeto

Indica o container para criação do Browse.

SetEditCell

Indica que será permitido a edição de células no Browse

Sintaxe

FWBrowse(): SetEditCell ( <lEditCell>,<bValidEdit> ) -->

Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

...


lEditCell	Lógico	Indica se permite a edição de células	X
bValidEdit

...

Bloco de código

Code-Block executado para validar a edição da célula

X

SetPreEditCell

Indica o bloco de pré-validação para a edição de celula, o bloco devera retorna .T. para abrir a edição e .F. para nao abrir.

localização das informações, caso não seja informado será utilizado o padrão.

Observações

null

SetNumberLegend

Indica que a legenda será representada por números.

Sintaxe FWBrowse():

SetNumberLegend ( [ lNumber]

SetPreEditCell ( < bBlock> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

lNumber

bBlock

LógicoIndica que a legenda será representada por números.

Observações

null

SetObjMark

Bloco de código

Code-Block com a funcao de validação. O bloco recebe como parametro o objeto do Browse, a coluna ,e o caracter precionado.

X

SetProfileID

Define o identificador do Browse utiliza na gravação das configurações no profile do usuário.

Indica o objeto FWMARKBROWSE utilizado na passagem de parâmetros na execução das rotinas na FWFORMBROWSE.

Sintaxe FWBrowse():

SetObjMark

SetProfileID ( <

oObjMark>

cProfileID> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

oObjMark

cProfileID

Objeto

Caracter

Identificador do Browse

Indica o objeto FWMARKBROWSE

X

Informações

title

Observações

null

SetObligateFilter

Importante

Sua implementação recomendada como boa pratica;
Obrigatória a implementação quando existir mais de um Browse na rotina;
Obrigatória a implementação em Browses que façam uso da função GetNextAlias();
O tamanho máximo do ID deve ser de 4 (quatro) caracteres.

SetQuery

Indica a Query que será utilizada para criação do Browse

Indica se a selecão de um filtro é obrigatório para a apresentação do browse

. Sintaxe FWBrowse():

SetObligateFilter ( [ lObligateFilter], [ lCanCancel]

SetQuery ( < cQuery> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

lObligateFilter

cQuery

Lógico

Caracter

Indica

que o filtro será solicitado na entrada

a Query para a criação do Browse.

lCanCancelLógicoIndica que permite o cancelamento na tela de filtros.

Observações

null

X

Observação: A partir da versão Lib 20161010, não deve ser informado o campo R_E_C_N_O_ na query, pois tratasse de um campo exclusivo na criação de arquivos temporários no banco de dados.

SetQueryIndex

Indica os índices utilizados pela Query na criação do Browse.

SetOwner

Indica o container para criação do Browse.

Sintaxe

FWBrowse(): SetQueryIndex ( < aIndex> ) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aIndex	Array of Record	Indica os índices utilizados pela Query na criação do Browse.	X

SetSeek

Habilita a utilização da pesquisa de registros no Browse. Sintaxe FWBrowse():

SetOwner

SetSeek ( [ bAction], [

oOwner

aOrder] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

oOwner

Observações

null

bAction

ObjetoIndica o container para criação do Browse.

Bloco de código	Code-Block executado para a pesquisa de registros, caso não seja informado será utilizado o padrão.
aOrder	Array of Record	Array contendo as informações para criação dos detalhes da pesquisa. Estrutura do array: [n,1] Título da pesquisa

SetPreEditCell

Indica o bloco de pré-validação para a edição de celula, o bloco devera retorna .T. para abrir a edição e .F. para nao abrir.

Sintaxe

FWBrowse(): SetPreEditCell ( < bBlock> ) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bBlock	Bloco de código	Code-Block com a funcao de validação. O bloco recebe como parametro o objeto do Browse, a coluna ,e o caracter precionado.	X

Observações

null

Define o identificador do Browse utiliza na gravação das configurações no profile do usuário. Deve ser utilizado quando existir mais de um Browse na rotina.

Sintaxe

FWBrowse(): SetProfileID ( < cProfileID> ) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cProfileID	Caracter	Identificador do Browse	X

Observações

null

[n,2,n,1] LookUp
[n,2,n,2] Tipo de dados
[n,2,n,3] Tamanho
[n,2,n,4] Decimal
[n,2,n,5] Título do campo
[n,2,n,6] Máscara

SetProfileID

[n,2,n,7] Nome Físico do campo - Opcional - é ajustado no programa
[n,3] Ordem da pesquisa

SetQuery

Indica a Query que será utilizada para criação do Browse

[n,4] Exibe na pesquisa

SetSeekChange

Indica o Code-Block executado na mudança da ordem de pesquisa.

Sintaxe FWBrowse():

SetQuery ( < cQuery>

SetSeekChange ( [ bSeekChange] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

cQuery

bSeekChange

CaracterIndica a Query para a criação do Browse.X

Observações

null

SetQueryIndex

Bloco de código

Code-Block executado na mudança da ordem de pesquisa.

SetShowLimit

Indica se apresenta somente o limite de informacoes do Browse do tipo Query quando a Query ultrapassar o limite definido.

Sintaxe

FWBrowse(): SetShowLimit ( [ lShowLimit] ) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lShowLimit	Lógico	Indica se apresenta somente o limite de informacoes do Browse do tipo Query quando a Query ultrapassar o limite definido.

SetSuperDel

Indica o Code-Block executado ao pressionar as teclas CTRL+Del

Indica os índices utilizados pela Query na criação do Browse

.

Sintaxe FWBrowse():

SetQueryIndex

SetSuperDel ( <

aIndex>

bSuperDel> ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

aIndexArray of Record

bSuperDel

Bloco de código

Code-Block executado no CTRL+Del

Indica os índices utilizados pela Query na criação do Browse

.

X

Observações

null

SetTypeMove

Indica o tipo de navegação do Browse

SetSeek

Habilita a utilização da pesquisa de registros no Browse.

Sintaxe FWBrowse():

SetSeek ( [ bAction], [ aOrder]

SetTypeMove ( < nTypeMove> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nTypeMove

bAction

Numérico

Bloco de códigoCode-Block executado para a pesquisa de registros, caso não seja informado será utilizado o padrão. aOrderArray of RecordArray contendo as informações para criação dos detalhes da pesquisa.

Observações

null

Indica o tipo de navegação no Browse 0=Linha ou 1=Coluna

X

SetUseCaseFilter

Habilita a utilização do filtro case no Browse.

SetSeekChange

Indica o Code-Block executado na mudança da ordem de pesquisa.

Sintaxe FWBrowse():

SetSeekChange

SetUseCaseFilter ( [

bSeekChange

nAlign] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

bSeekChange

nAlign

Bloco de códigoCode-Block executado na mudança da ordem de pesquisa.

Observações

null

Numérico

Indica o alinhamento do filtro no Browse.

SetUseFilter

Habilita a utilização do filtro no Browse.

SetShowLimit

Indica se apresenta somente o limite de informacoes do Browse do tipo Query quando a Query ultrapassar o limite definido.

Sintaxe FWBrowse():

SetShowLimit

SetUseFilter ( [

lShowLimit] )

nAlign], [ bOnStart] ) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

lShowLimit

nAlign

Lógico

Numérico

Indica

se apresenta somente o limite de informacoes do Browse do tipo Query quando a Query ultrapassar o limite definido.

Observações

null

SetSuperDel

o alinhamento do filtro no Browse.
bOnStart	Bloco de código	Code-Block executado na criação do componente de filtro.

Observação

Este método espera que os campos para filtro tenham sido definidos previamente pelo método SetFieldFilter.
Caso o array de campos para o filtro não tenha sido preenchido e o browse seja baseado em tabela (alias ou temporária), a lista de campos será preenchida lendo as informações através de dbStruct da tabela, exibindo algo parecido com"A1_FILIAL, A1_COD, A1_LOJA"ao invés dos títulos dos campos"Filial, Código, Loja"no momento de criação dos filtros.

Observação

Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )

SetVldExecFilter

Define um bloco de códigos para validar se o filtro deve ser executado.

Indica o Code-Block executado ao pressionar as teclas CTRL+Del.

Sintaxe

FWBrowse(): SetSuperDel ( < bSuperDel> ) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bSuperDel	Bloco de código	Code-Block executado no CTRL+Del.	X

Observações

null

SetTypeMove

Indica o tipo de navegação do Browse

Sintaxe

FWBrowse(): SetVldExecFilter ( < bVldExecFilter> ) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bVldExecFilter	Bloco de código	Code-Block para validar se o filtro deve ser executado.	X

SetUniqueKey(aSetKey)

Define os campos chave de um browse de query ou array para conseguir reposicionar posteriormente em atualizações que forcem a reconstrução do browse. Não será realizado controle de inserção em duplicidade de registros no browse.

Sintaxe

FWBrowse():

SetTypeMove

SetUniqueKey(

< nTypeMove>

aSetKey) --> Parâmetros

Nome

Tipo

Descrição

Obrigatório

Referência

nTypeMove

aSetKey

NuméricoIndica o tipo de navegação no Browse 0=Linha ou 1=ColunaX

Array

Lista com os campos definidos como chave.
Quando browse de query espera { “CAMPO1”, “CAMPO2” }, nomes dos campos. Quando browse de array { 1, 2, 3 }, número das colunas do array.

X

Retorno

Lógico, indica se a definição dos campos aconteceu ou não.

GetUniqueKey()

Retorna a lista com os campos ou colunas definidos como chave para o browse.

Observações

null

SetUseCaseFilter

Habilita a utilização do filtro case no Browse.

Sintaxe FWBrowse():

SetUseCaseFilter

GetUniqueKey(

[ nAlign]

) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nAlign	Numérico	Indica o alinhamento do filtro no Browse.

Observações

null

SetUseFilter

Retorno

Array, lista com os campos definidos como chave do browse.

GetUniqueDataKey()

Captura o conteúdo dos campos e colunas informados como chave do browse

Habilita a utilização do filtro no Browse

.

Sintaxe FWBrowse():

SetUseFilter ( [ nAlign], [ bOnStart]

SetUniqueKey(aSetKey) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nAlign	Numérico	Indica o alinhamento do filtro no Browse.
bOnStart	Bloco de código	Code-Block executado na criação do componente de filtro.

SetVldExecFilter

Retorno

Array, com lista com os pares de campos e valores identificados. Quando browse por query: { { “CAMPO”, VALOR }, { “CAMPO”, VALOR } }. Quando browse por array: { { NUM_COLUNA, VALOR }, { NUM_COLUNA, VALOR } }.

GoToDataKey(aDataKey)

Posiciona o browse no registro conforme a chave recebida por parâmetro.

Define um bloco de códigos para validar se o filtro deve ser executado.

Sintaxe

FWBrowse():

SetVldExecFilter

SetUniqueKey(

< bVldExecFilter>

aDataKey) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aDataKey

bVldExecFilterBloco de códigoCode-Block para validar se o filtro deve ser executado.X

Observações

null

Show

Array

Lista com os pares de campos e valores identificados. Quando browse por query: { { “CAMPO”, VALOR }, { “CAMPO”, VALOR } }. Quando browse por array: { { NUM_COLUNA, VALOR }, { NUM_COLUNA, VALOR } }.

X

Retorno

Lógico, indica se foi possível realizar o posicionamento no registro do browse conforme o parâmetro informado.

Show

Permite tornar o Browse visível. Sintaxe FWBrowse(): Show ( ) -->

Observações

null

UpdateBrowse

Realiza a reconstrução do browse para atualizações em tempo de execução. Este método fará com que exista problemas de desempenho nos programas pois o browse é completamente reconstruído.

Sintaxe

FWBrowse(): UpdateBrowse(lResetSeek) → NIL

Parâmetros

Nome	Tipo	Descrição
lResetSeek	Lógico	Indica se deve refazer a construção das ordens de pesquisa no browse.

Retorno

NIL

Aviso
A função POSICIONE, quando utilizada em campos virtuais, não deve utilizar a tabela principal do browse. Caso utilize o POSICIONE ou outra maneira (como User Function) utilizando a tabela principal, atente-se a respeito do desposicionamento da tabela ou demora na execução.

Exemplos

Bloco de código

language	java
theme	RDark
title	Exemplo com Define
linenumbers	true

#INCLUDE "PROTHEUS.CH"
#INCLUDE "FWBROWSE.CH"
User Function BrwTable()

Local oBrowse
Local oColumn
Local oDlg

//---------------

Exemplo

#INCLUDE "FWBROWSE.CH"

     User Function BrwTable()

Local oBrowse

Local oColumn

Local oDlg

//------------------------------

----------------------------------------------------// Abertura da tabela//-------------------------------------------------------------------

DbUseArea(.T.,,"SX2990","SX2",.T.,.F.)


DbSelectArea("SX2")
DbSetOrder(1)



//-------------------------------------------------------------------// Define a janela do Browse//-------------------------------------------------------


DEFINE

MSDIALOG

DIALOG oDlg FROM 0,0 TO 600,800 PIXEL

 

//-------------------------------------------------------------------

 // Define o Browse

 //----------------------------------------------------------------


DEFINE FWBROWSE oBrowse DATA TABLE ALIAS "SX2" OF oDlg

 

//--------------------------------------------------------

 // Cria uma coluna de marca/desmarca//----------------------------------------------


ADD MARKCOLUMN oColumn DATA { || If(.T./* Função com a regra*/,'LBOK','LBNO') }

;
DOUBLECLICK { |oBrowse| /* Função que atualiza a regra*/ }

;
HEADERCLICK { |oBrowse| /* Função executada no clique do header */ } OF oBrowse

 

//--------------------------------------------------------

 // Cria uma coluna de status

 //--------------------------------------------------------


ADD STATUSCOLUMN oColumn DATA { || If(.T./* Função com a regra*/,'BR_VERDE','BR_VERMELHO') }

;
DOUBLECLICK { |oBrowse| /* Função executada no duplo clique na coluna*/ } OF oBrowse

 

//--------------------------------------------------------

 // Adiciona legenda no Browse

 //--------------------------------------------------------


ADD LEGEND DATA 'X2_CHAVE $ "AA1|AA2"'

COLOR "GREEN" TITLE "Chave teste 1" OF oBrowse

 
ADD LEGEND DATA '!(X2_CHAVE $ "AA1|AA2")' COLOR "RED"

TITLE "Chave teste 2" OF oBrowse

 

//-------------------------------------------------------------------

 // Adiciona as colunas do Browse

 //------------------------------------------


ADD COLUMN oColumn DATA { || X2_CHAVE

} TITLE "Chave"

SIZE

3 OF oBrowse

 
ADD COLUMN oColumn DATA { || X2_ARQUIVO } TITLE "Arquivo"

 SIZE 10 OF oBrowse

 
ADD COLUMN oColumn DATA { || X2_NOME

} TITLE DecodeUTF8("Descrição") SIZE 40 OF oBrowse

 
ADD COLUMN oColumn DATA { || X2_MODO }

}

TITLE "Modo"

 SIZE

 1 OF oBrowse

 

//-------------------------------------------------------------------

 // Ativação do Browse//----------------------------------------------------------------

 
ACTIVATE FWBROWSE oBrowse

//



//-------------------------------------------------------------------// Ativação do janela//----------------------------------------------------------------

------// Ativação do janela//-------------------------------------------------------------------

ACTIVATE MSDIALOG oDlg CENTERED

Return

---
ACTIVATE DIALOG oDlg CENTERED

Return

Bloco de código

language	java
theme	RDark
title	Exemplo sem Define
linenumbers	true

User Function BrwTable()
 
Local oBrowse
Local oColumn
Local oDlg
 
// Abertura da tabela
DbSelectArea("SX2")
DbSetOrder(1)

//Define a janela do Browse
oDlg = TDialog():New(0, 0, 600, 800,,,,,,,,,,.T.)

// Define o Browse
oBrowse := FWBrowse():New(oDlg)
oBrowse:SetDataTable(.T.)
oBrowse:SetAlias("SX2")

// Cria uma coluna de marca/desmarca
oColumn := oBrowse:AddMarkColumns({||If(.T./*Função de Marca/desmaca*/,'LBOK','LBNO')},{|oBrowse|/*Função de DOUBLECLICK*/},{|oBrowse|/* Função de HEADERCLICK*/})

// Cria uma coluna de status
oColumn := oBrowse:AddStatusColumns({||If(.T./*Função de avaliação de status*/,'BR_VERDE','BR_VERMELHO')},{|oBrowse|/*Função de DOUBLECLICK*/})

// Adiciona legenda no Browse
oBrowse:AddLegend('X2_CHAVE $ "AA1|AA2"',"GREEN","Chave teste 1")
oBrowse:AddLegend('!(X2_CHAVE $ "AA1|AA2")',"RED","Chave teste 2")

// Adiciona as colunas do Browse
oColumn := FWBrwColumn():New()
oColumn:SetData({||X2_CHAVE})
oColumn:SetTitle("Chave")
oColumn:SetSize(3)
oBrowse:SetColumns({oColumn})

oColumn := FWBrwColumn():New()
oColumn:SetData({||X2_ARQUIVO})
oColumn:SetTitle("Arquivo")
oColumn:SetSize(10)
oBrowse:SetColumns({oColumn})

oColumn := FWBrwColumn():New()
oColumn:SetData({||X2_NOME})
oColumn:SetTitle(DecodeUTF8("Descrição"))
oColumn:SetSize(40)
oBrowse:SetColumns({oColumn})

oColumn := FWBrwColumn():New()
oColumn:SetData({||X2_MODO})
oColumn:SetTitle("Modo")
oColumn:SetSize(1)
oBrowse:SetColumns({oColumn})

// Ativação do Browse
oBrowse:Activate()

// Ativação da janela
oDlg:Activate(,,,.T.)

Return

Bloco de código

language	java
theme	RDark
title	Exemplo com Array
linenumbers	true

Function u_BrwArray

    Local oDlg        := Nil
    Local oFwBrowse   := Nil
    Local aColumns    := {}
    Local aItems      :={}
    Local nX


    oDlg = TDialog():New(0, 0, 600, 800, "Browse com Array",,,,,,,,,.T.)

    oFwBrowse := FWBrowse():New(oDlg)
    oFwBrowse:SetDataArrayoBrowse()  //Define utilização de array

    aItems := LoadItems()      //Carregar os itens que irão compor o conteudo do grid
    oFwBrowse:SetArray(aItems) //Indica o array utilizado para apresentação dos dados no Browse.

    aColumns := RetColumns( aItems )

    //Cria as colunas do array
    For nX := 1 To Len(aColumns )
        oFwBrowse:AddColumn( aColumns[nX] )
    Next

    oFwBrowse:SetOwner(oDlg)
    oFwBrowse:SetDescription( "Browse com Array" )
    oFwBrowse:Activate()

    oDlg:Activate()

Return

Static Function RetColumns(aItems)
   	Local aColumns := {}

    aAdd(aColumns, {;
                        "Coluna 1",;                     // [n][01] Título da coluna
                        {|oBrw| aItems[oBrw:At(), 1] },; // [n][02] Code-Block de carga dos dados
                        "N",;                            // [n][03] Tipo de dados
                        "@E 9999",;                      // [n][04] Máscara
                        2,;                              // [n][05] Alinhamento (0=Centralizado, 1=Esquerda ou 2=Direita)
                        10,;                             // [n][06] Tamanho
                        0,;                              // [n][07] Decimal
                        .T.,;                            // [n][08] Indica se permite a edição
                        {|| },;                          // [n][09] Code-Block de validação da coluna após a edição
                        .F.,;                            // [n][10] Indica se exibe imagem
                        Nil,;                            // [n][11] Code-Block de execução do duplo clique
                        "__ReadVar",;                    // [n][12] Variável a ser utilizada na edição (ReadVar)
                        {|| AlwaysTrue()},;              // [n][13] Code-Block de execução do clique no header
                        .F.,;                            // [n][14] Indica se a coluna está deletada
                        .F.,;                            // [n][15] Indica se a coluna será exibida nos detalhes do Browse
                        {},;                             // [n][16] Opções de carga dos dados (Ex: 1=Sim, 2=Não)
                        "ID1"})                          // [n][17] Id da coluna

	aAdd(aColumns, {;
                        "Coluna 2",;                    // [n][01] Título da coluna
                        {|oBrw| aItems[oBrw:At(), 2] },; // [n][02] Code-Block de carga dos dados
                        "C",;                            // [n][03] Tipo de dados
                        "@!",;                           // [n][04] Máscara
                        0,;                              // [n][05] Alinhamento (0=Centralizado, 1=Esquerda ou 2=Direita)
                        10,;                             // [n][06] Tamanho
                        0,;                              // [n][07] Decimal
                        .F.,;                            // [n][08] Indica se permite a edição
                        {|| },;                          // [n][09] Code-Block de validação da coluna após a edição
                        .F.,;                            // [n][10] Indica se exibe imagem
                        Nil,;                            // [n][11] Code-Block de execução do duplo clique
                        __ReadVar,;                      // [n][12] Variável a ser utilizada na edição (ReadVar)
                        {|| AlwaysTrue()},;              // [n][13] Code-Block de execução do clique no header
                        .F.,;                            // [n][14] Indica se a coluna está deletada
                        .F.,;                            // [n][15] Indica se a coluna será exibida nos detalhes do Browse
                        {},;                             // [n][16] Opções de carga dos dados (Ex: 1=Sim, 2=Não)
                        "ID2"})                          // [n][17] Id da coluna

	aAdd(aColumns, {;
                        "Coluna 3",;                      // [n][01] Título da coluna
                        {|oBrw| aItems[oBrw:At(), 3 ] },; // [n][02] Code-Block de carga dos dados
                        "C",;                             // [n][03] Tipo de dados
                        "@!",;                            // [n][04] Máscara
                        0,;                               // [n][05] Alinhamento (0=Centralizado, 1=Esquerda ou 2=Direita)
                        10,;                              // [n][06] Tamanho
                        0,;                               // [n][07] Decimal
                        .F.,;                             // [n][08] Indica se permite a edição
                        {|| },;                           // [n][09] Code-Block de validação da coluna após a edição
                        .F.,;                             // [n][10] Indica se exibe imagem
                        Nil,;                             // [n][11] Code-Block de execução do duplo clique
                        "__ReadVar",;                     // [n][12] Variável a ser utilizada na edição (ReadVar)
                        {|| AlwaysTrue()},;               // [n][13] Code-Block de execução do clique no header
                        .F.,;                             // [n][14] Indica se a coluna está deletada
                        .F.,;                             // [n][15] Indica se a coluna será exibida nos detalhes do Browse
                        {},;                              // [n][16] Opções de carga dos dados (Ex: 1=Sim, 2=Não)
                        "ID3"})                           // [n][17] Id da coluna

Return aColumns

Static Function LoadItems()
   Local aLinha     := {}
   Local nX

    For nX := 1 To 20
        aAdd(aLinha,{ nX, StrZero(nX, 5), " Linha : "+ cValToChar(nX)})
    Next
Return aLinha

Bloco de código

language	java
theme	RDark
title	Exemplo com Query
linenumbers	true

Function u_FwBrwQry()
    Local oDlg       As Object
    Local aColumns   As Array
    Local nContFlds  As Numeric
    Local cAliasTemp As Character
    Local oBrowse    As Object
    Local aFields    As Array

    cAliasTemp  := MpSysOpenQuery( "SELECT C5_FILIAL, C5_NUM, C5_TIPO, C5_CLIENTE, C5_PEDEXP FROM " + RetSqlName("SC5") + " WHERE D_E_L_E_T_ = ' '" )

    DEFINE MSDIALOG oDlg TITLE "Browse com Query" FROM 0,0 TO 600, 800 PIXEL

    oBrowse := FWBrowse():New()
    oBrowse:SetDataTable( .T. )
    oBrowse:SetAlias( cAliasTemp )
    oBrowse:SetOwner( oDlg )
    oBrowse:SetDescription( "Browse com Query" )

    //-------------------------------------------------------------------
    // Adiciona as colunas do Browse
    //-------------------------------------------------------------------
    aColumns    := {}
    aFields     := {}

    aAdd( aFields, "C5_FILIAL" )
    aAdd( aFields, "C5_NUM" )
    aAdd( aFields, "C5_TIPO" )
    aAdd( aFields, "C5_CLIENTE" )
    aAdd( aFields, "C5_PEDEXP"  )


    For nContFlds := 1 To Len( aFields )

        AAdd( aColumns, FWBrwColumn():New() )

        aColumns[Len(aColumns)]:SetData( &("{ || " + aFields[nContFlds] + " }") )
        aColumns[Len(aColumns)]:SetTitle( aFields[nContFlds] )
        aColumns[Len(aColumns)]:SetSize( 15 )
        aColumns[Len(aColumns)]:SetID( aFields[nContFlds] )
    Next nContFlds

    oBrowse:SetColumns(aColumns)
    oBrowse:Activate()

    ACTIVATE MSDIALOG oDlg
Return

Bloco de código

language	java
theme	RDark
title	Browse de query
linenumbers	true

Function u_FwBrwQry()
    Local oDlg      As Object
    Local aColumns  As Array
    Local nContFlds As Numeric
    Local aFields   As Array
    Local oBrowse   As Object
    Local cAliasQry As Character
	Local aFilter   As Array	

    DEFINE MSDIALOG oDlg TITLE "Browse de Query" FROM 0,0 TO 600, 800 PIXEL

    cAliasQry := GetNextAlias()

    oBrowse := FWBrowse():New()
    oBrowse:SetDataQuery()
    oBrowse:SetAlias(cAliasQry)
    oBrowse:SetQuery("SELECT C5_FILIAL, C5_NUM, C5_TIPO, C5_CLIENTE, C5_PEDEXP FROM " + RetSqlName("SC5") + " WHERE D_E_L_E_T_ = ' '")
    oBrowse:SetOwner(oDlg)
    oBrowse:SetDescription("Browse de Query")

    //-------------------------------------------------------------------
    // Adiciona as colunas do Browse
    //-------------------------------------------------------------------
    aColumns    := {}
    aFields     := {}
	aFilter		:= {}

    aAdd( aFields, "C5_FILIAL" )
    aAdd( aFields, "C5_NUM" )
    aAdd( aFields, "C5_TIPO" )
    aAdd( aFields, "C5_CLIENTE" )
    aAdd( aFields, "C5_PEDEXP"  )
	
	aAdd(aFilter, { "C5_NUM", "Numero", "C", 006, 0, "@X"}) //"Numero do Pedido"

    For nContFlds := 1 To Len( aFields )

        AAdd( aColumns, FWBrwColumn():New() )

        aColumns[Len(aColumns)]:SetData( &("{ || " + aFields[nContFlds] + " }") )
        aColumns[Len(aColumns)]:SetTitle( aFields[nContFlds] )
        aColumns[Len(aColumns)]:SetSize( 15 )
        aColumns[Len(aColumns)]:SetID( aFields[nContFlds] )
    Next nContFlds
	
 	oBrowse:SetFieldFilter(aFilter)
    oBrowse:SetColumns(aColumns)
    oBrowse:Activate()

    ACTIVATE MSDIALOG oDlg
Return

Abrangência

Todas as versões

Define os campos chave de um browse de query ou array para conseguir reposicionar posteriormente em atualizações que forcem a reconstrução do browse. Não será realizado controle de inserção em duplicidade de registros no browse.

AddLegend

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 10

Nova versão Atual

Chave

Fornece

um

objeto

do

tipo

grid

que

permite

a

exibição

de

dados

do

tipo

array,

texto,

tabela

e

query.

Construtor da classe

SintaxeFWBrowse(): New ( [ oOwner] ) --> oSelfParâmetros

Ativação da classe.

Permite adicionar a informacao de um browse relacionado.

Adiciona uma coluna no Browse em tempo de execução.

Permite adicionar uma configuração customizada na opção de configuração do Browse.

Permite adicionar um filtro na lista de opções de filtros do Browse.

Permite adicionar legendas no Browse.

Permite adicionar um linha no Browse.

Permite adicionar uma coluna com a opção de marca e desmarca.

Permite adicionar uma coluna

de status.

Retorna o Alias utilizado no Browse.

Executa o Code-Block definido no método SetAllOK(bAllOK).

Retorna a posição atual do registro.

Retorna o componente Browse (TGRID).

Retorna o nome da classe (FWBROWSE).

Executa a limpeza dos filtros estendidos realizados no Browse.

Realizada a limpeza dos filtros utilizados no Browse.

Elimina as configurações realizadas no Browse do perfil do usuário.

Retorna a coluna posicionada no Browse

Retorna o objeto de dados no Browse.

Retorna se o dados apresentados no Browse é de Array.

Retorna se o dados apresentados no Browse é de Query.

Retorna se o dados apresentados no Browse é de Tabela.

Retorna se o dados apresentados no Browse é de Texto.

Indica se utiliza filtro para tabelas CODEBASE.

Método de destruição da classe.

Compatibilização com a MBrowse antiga.

Indica que uma determinada coluna está deletada.

Permite realizar a exclusão de filtros.

Executa o Code-Block, definido no método SetDelete(lDelete,bDelete), para deleção de uma linha no Browse.

Executa o Code-Block, definido no método SetDelOk(bDelOK), para validar a deleção de uma linha no Browse.

Desabilita a utilização do Browse.

Desabilita a utilização das configurações do Browse.

Desabilita a utilização do filtro no Browse.

Desabilita a utilização do localizador de registro no Browse.

Desabilita a impressão das informações disponíveis no Browse.

Desabilita a gravação das configurações realizadas no Browse.

Desabilita a utilização da pesquisa no Browse.

Habilita a utilização do Browse.

Aplica os filtros realizados no Browse.

Indica se o Browse está filtrado.

Retorna o objeto FWFilter.

Retorna a cor de fundo do Browse.

Retorna a cor alternada do Browse.

Retorno um objeto tipo FWBrwColumn da coluna passada.

Retorna a descrição do Browse.

Retorna o filtro padrão do Browse

Retorna a cor da fonte do Browse.

Retorna o objeto FWMARKBROWSE utilizado na passagem de parâmetros na execução das rotinas na FWFORMBROWSE;

Retorna o identificador do Browse utiliza na gravação das configurações no profile do usuário. Deve ser utilizado quando existir mais de um Browse na rotina.

Retorna a Query que esta sendo utilizada no Browse.

Posiciona no último registro do Browse.

Posiciona na coluna desejada.

Sintaxe
FWBrowse(): New ( [ oOwner] ) --> oSelf

Parâmetros

Sintaxe
FWBrowse():

Sintaxe
FWBrowse():