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.

TGrid

...

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

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
[n][16] Opções de carga dos dados (Ex: 1=Sim, 2=Não)
[n][17] Id da coluna

[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: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.


aFilParser	Array of Record	Array contendo informações parseadas do filtro.


cID	Caracter	Nome do identificador do filtro

Exemplos oBrowse:AddFilter(cTitle,xCondition)

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.

AddStatusColumns

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.

Alias

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

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.

At

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

Browse

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

ClassName

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

CleanExFilter

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

CleanFilter

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

CleanProfile

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

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.

Data

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

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.

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.

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.

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.

DBFFilter

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

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)

Default

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

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

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

DelLine

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

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

Disable

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

DisableConfig

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

DisableFilter

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

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 ( ) -->

DisableSaveConfig

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

DisableSeek

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

Enable

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

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.

Filtrate

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

FWFilter

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

GetBackColor

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

GetClrAlterRow

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

GetColumn

Retorno um objeto tipo FWBrwColumn da coluna passada. Sintaxe FWBrowse(): GetColumn ([nCol]) Retorno oCol Retorna o objeto da coluna posicionada.

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.

GetForeColor

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

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

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

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.

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. Sintaxe FWBrowse(): GoColumn ( [ nColumn] ) --> Parâmetros

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

GoDown 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.

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 ( ) -->

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.

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.

GoUp

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.

Hide

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

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.

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.

ObligateFilter

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

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.

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.

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.

Report

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

Reset

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

ResetLen

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

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

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

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

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

SetBlkBackColor

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

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

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

SetDataArray

Indica que o Browse exibe dados através de um array. Sintaxe FWBrowse(): SetDataArray ( ) -->

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

Indica que o Browse exibe dados através de uma tabela. Sintaxe FWBrowse(): SetDataTable ( ) -->

SetDataText

Indica que o Browse exibe dados através de um arquivo texto. Sintaxe FWBrowse(): SetDataText ( ) -->

SetDelete

Indica que o usuário pode excluir linhas no Browse. Sintaxe FWBrowse(): SetDelete ( [ lDelete], [ bDelete] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lDelete	Lógico	Indica se 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(): SetDelOk ( < bDelOK> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bDelOK	Bloco de código	Code-Block executado para validar a exclusão da linha.	X

SetDescription

Indica a descrição do Browse. Sintaxe FWBrowse(): SetDescription ( < cDescription> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cDescription	Caracter	Indica a descrição do Browse	X

SetDoubleClick

Indica o Code-Block executado no duplo clique do item no Browse. Sintaxe FWBrowse(): SetDoubleClick ( < bLDblClick> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bLDblClick	Bloco de código	Code-Block executado no duplo clique do item no Browse.	X

SetEditCell

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

Esse método só é válido para browse de tabela ou de array. Para browse de array é necessário na criação da FWBrwColumn definir as colunas como editáveis através do método SetEdit e definir o readvar da coluna (pelo método SetReadVar)

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.


bValidEdit	Bloco de código	Code-Block executado para validar a edição da célula.

SetFieldFilter

Indica os campos que serão apresentados na edição de filtros. Sintaxe FWBrowse(): SetFieldFilter ( < aFields> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aFields	Array of Record	Array contendo os campos apresentados na edição de filtros.	X

SetFile

Indica o arquivo texto que será utilizado no Browse. Sintaxe FWBrowse(): SetFile ( < cFile>, [ cCharSeparator] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cFile	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. Sintaxe FWBrowse(): SetFilter ( < cCpoFil>, < cTopFun>, [ cBotFun] ) --> 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.

SetFilterDefault

Indica o filtro padrão do Browse. Sintaxe FWBrowse(): SetFilterDefault ( < cFilterDefault> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cFilterDefault	Caracter	Indica o filtro AdvPL para o Browse.	X

SetFilterRelation

Indica o relacionamento de filtros para o Browse. Sintaxe FWBrowse(): SetFilterRelation ( < aFilterRelation>, < bChgFields> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aFilterRelation	Array of Record	Array contendo os itens do relacionamento.	X


bChgFields	Bloco de código	Indica o Code-Block executado para trocar os campos para o filtro.	X

SetFocus

Força o foco no objeto Browse. Sintaxe FWBrowse(): SetFocus ( ) -->

SetFontBrowse

Indica a fonte do Browse. Sintaxe FWBrowse(): SetFontBrowse ( [ oFont] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
oFont	Objeto	Indica o objeto TFont utilizado no Browse.

SetForeColor

Indica a cor da fonte no Browse. Sintaxe FWBrowse(): SetForeColor ( < nForeColor> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nForeColor	Numérico	Cor da fonte no Browse.	X

SetGroup

Indica que o Browse utiliza agrupamento de informações. 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(): SetHeaderImage ( < nColumn>, < cResource> ) --> 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

SetIdAlias

Indica o ID para Browses que trabalham com Left Join. Sintaxe FWBrowse(): SetIdAlias ( < cIdAlias> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cIdAlias	Caracter	Indica o ID para Browses que trabalham com Left Join.	X

SetInsert

Indica que o usuário poderá inserir novas linhas no Browse. Sintaxe FWBrowse(): SetInsert ( [ lInsert] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lInsert	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. Sintaxe FWBrowse(): SetItemDoubleClick ( < aItemDoubleClick> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aItemDoubleClick	Array of Record	Array 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> ) --> 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. Sintaxe FWBrowse(): SetLineBegin ( < nLineBegin> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nLineBegin	Numérico	Indica a linha inicial do arquivo texto.	X

SetLineHeight

Indica a altura da linha no Browse. Sintaxe FWBrowse(): 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. Sintaxe FWBrowse(): SetLineOk ( < bLineOk> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bLineOk	Bloco de código	Code-Block executado na troca de linha.	X

SetLocate

Habilita a utilização do localizador de registros no Browse. Sintaxe FWBrowse(): 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. Sintaxe FWBrowse(): SetNumberLegend ( [ lNumber] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lNumber	Lógico	Indica 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. Sintaxe FWBrowse(): SetObjMark ( < oObjMark> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
oObjMark	Objeto	Indica o objeto FWMARKBROWSE	X

SetObligateFilter

Indica se a selecão de um filtro é obrigatório para a apresentação do browse. Sintaxe FWBrowse(): SetObligateFilter ( [ lObligateFilter], [ lCanCancel] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
lObligateFilter	Lógico	Indica que o filtro será solicitado na entrada do Browse


lCanCancel	Lógico	Indica que permite o cancelamento na tela de filtros.

SetOwner SetOwner

Indica o container para criação do Browse. Sintaxe FWBrowse(): SetOwner ( [ oOwner] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
oOwner	Objeto	Indica o container para criação do Browse.

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

SetProfileID

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

SetQuery

Indica a Query que será utilizada para criação do Browse. Sintaxe FWBrowse(): SetQuery ( < cQuery> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
cQuery	Caracter	Indica a Query para a criação do Browse.	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. 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(): SetSeek ( [ bAction], [ aOrder] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bAction	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.

SetSeekChange

Indica o Code-Block executado na mudança da ordem de pesquisa. Sintaxe FWBrowse(): SetSeekChange ( [ bSeekChange] ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
bSeekChange	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. 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

SetTypeMove SetTypeMove

Indica o tipo de navegação do Browse Sintaxe FWBrowse(): SetTypeMove ( < nTypeMove> ) --> Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
nTypeMove	Numérico	Indica o tipo de navegação no Browse 0=Linha ou 1=Coluna	X

SetUseCaseFilter

Habilita a utilização do filtro case no Browse. Sintaxe FWBrowse(): SetUseCaseFilter ( [ nAlign] ) --> Parâmetros

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

SetUseFilter

Habilita a utilização do filtro no Browse. Sintaxe FWBrowse(): SetUseFilter ( [ nAlign], [ bOnStart] ) --> 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

Define um bloco de códigos para validar se o filtro deve ser executado. 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

(): 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(): SetUniqueKey(aSetKey) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aSetKey	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.

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.

Sintaxe

FWBrowse(): GetUniqueKey() -->

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.

Sintaxe

FWBrowse(): SetUniqueKey(aSetKey) -->

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.

Sintaxe

FWBrowse(): SetUniqueKey(aDataKey) -->

Parâmetros

Nome	Tipo	Descrição	Obrigatório	Referência
aDataKey	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 } }.

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 ( ) -->

Bloco de código

title	Exemplo com Define
linenumbers	true

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

Local oBrowse
Local oColumn
Local oDlg

//-------------------------------------------------------------------// Abertura da tabela//-------------------------------------------------------------------
DbSelectArea("SX2")
DbSetOrder(1)

//-------------------------------------------------------------------// Define a janela do Browse//-------------------------------------------------------
DEFINE 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//-------------------------------------------------------------------
ACTIVATE DIALOG oDlg CENTERED

Return

Bloco de código

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

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.

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 19

Nova versão 20

Chave

Fornece um objeto do tipo grid que permite a exibição de dados do tipo array, texto, tabela e query.

Construtor da classe.

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 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.

Salta uma ou mais linhas para baixo do item posicionado.

Salta uma página para baixo do item posicionado.

Salta uma página para cima do item posicionado.

Posiciona em um determinado registro do Browse.

Posiciona no primeiro registro do Browse.

Salta uma ou mais linhas para cima do item posicionado.

Permite tornar o Browse invisível

Executa o Code-Block, definido no método SetLineOk(bLineOk), para validação da linha posicionada.

Executa a atualização das informações de uma determinada linha do Browse.

Retorna a quantidade de registros disponíveis para o browse.

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

Indica se a opção de configuração do Browse está habilitada.

Indica se a opção de impressão das informações do Browse está habilitada.

Executa a atualização das informações no Browse.

Executa a impressão das informações do Browse.

Compatibilidade com o Browse antigo.

Compatibilidade com o Browse antigo.

Indica a Code-Block executado para adicionar linha no browse.

Indica o Code-Block que será executado após a inclusão de uma linha.

Indica o alias da tabela que será utilizada no Browse.

SetAllOk