FWFormBrowse Colapse ALL Expand ALL

Classe: FWFormBrowse
O FWFOrmBrowse fornece um objeto do tipo grid, que possibilita a incluso de botes laterais e detalhes das colunas.

Hierarquia
TGrid -> FWBrowse

Construtores New
New
Construtor da classe.

Sintaxe
FWFormBrowse(): New ( [ ] ) --> oSelf

Parmetros
Nome Tipo Array of Record Descrio Obrigatrio Referncia

Retorno
oSelf() Retorbna o objeto da classe

Observaes

Mtodos Activate

Activate
Ativao da classe.

Sintaxe
FWFormBrowse(): Activate ( [ oOwner] ) -->

Parmetros
Nome oOwner Tipo Objeto Descrio Objeto do tipo container que indica o local que ser criado o Browse. Obrigatrio Referncia

Observaes AddButton
AddButton
Adiciona um boto na rea lateral do Browse.

Sintaxe
FWFormBrowse(): AddButton ( < cTitle>, [ xAction], [ uParam1], [ nOption], [ nVerify], [ lNeedFind], [ nRealOpc], [ cOperatId], [ cToolBar] ) -->

Parmetros
Nome cTitle xAction Tipo Caracter Qualquer Descrio Ttulo do boto. Ao que ser executada no clique do boto. Pode ser uma funo ou um Code Block. Parmetro reservado. Obrigatrio X Referncia

uParam1

Qualquer

nOption

Lgico

Tipo de operao (1=Visualizar, 2=Visualizar, 3=Incluir, 4=Alterar, 5=Excluir, 6=Alterar sem incluso de novas linhas, 7=Cpia e 8=Impresso da regra de negcios) Nmero do acesso a ser verificada a permisso para o usurio. Indica a necessidade de pesquisar antes da manuteno do registro (Menu Funcional). Indica a opo real (ordem de criao) do aRotina antigo Compatibilizao com a MBrowse antiga. Identificador da opo do menu. Utilizado para relacionar o o boto uma opo de menu. Indica o relacionamento com os botes da tela (FormBar).

nVerify

Numrico

lNeedFind

Lgico

nRealOpc

Numrico

cOperatId

Caracter

cToolBar

Caracter

Observaes AfterOption
AfterOption
Permite realizar tratamentos aps a execuo da ao do boto.

Sintaxe
FWFormBrowse(): AfterOption ( < cFunction>, < nOption>, [ nVerify] ) -->

Parmetros
Nome cFunction Tipo Caracter Descrio Nome da funo definida para o boto. Tipo de operao (1=Visualizar,2=Vis ualizar,3=Incluir,4= Alterae,5=Excluir,6 =Alterar sem incluso de novas linhas,7=Cpia e 8=Impresso da regra de negcios). Nmero do acesso a ser validada a permisso do usurio. Obrigatrio X Referncia

nOption

Numrico

nVerify

Numrico

Observaes BeforeOption
BeforeOption
Permite realizar tratamentos antes da execuo da ao do boto.

Sintaxe
FWFormBrowse(): BeforeOption ( < cFunction>, < nOption>, [ nVerify], [ cTitle], [ nRealOpc] ) --> lReturn

Parmetros
Nome cFunction Tipo Caracter Descrio Indica o nome da funo definida para o boto. Obrigatrio X Referncia

nOption

Numrico

Tipo de operao (1=Visualizar,2=Vis ualizar,3=Incluir,4= Alterae,5=Excluir,6 =Alterar sem incluso de novas linhas,7=Cpia e 8=Impresso da regra de negcios). Nmero do acesso a ser validada a permisso do usurio. Indica o ttulo da janela. Indica a popsio do boto selecionado.

nVerify

Numrico

cTitle nRealOpc

Caracter Numrico

Retorno
lReturn(logico) Indica se a ao pode ser executada.

Observaes ClassName
ClassName
Retorna o nome da classe (FWFORMBROWSE)

Sintaxe
FWFormBrowse(): ClassName ( ) --> cClassName

Retorno
cClassName(caracter) Retorna o nome da classe (FWFORMBROWSE)

Observaes CleanFilter

CleanFilter
Realiza a limpeza dos filtros utilizados no Browse.

Sintaxe
FWFormBrowse(): CleanFilter ( ) -->

Observaes DeActivate
DeActivate
Mtodo que permite destruir a classe.

Sintaxe
FWFormBrowse(): DeActivate ( [ lFreeChildren] ) -->

Parmetros
Nome lFreeChildren Tipo Lgico Descrio Indica se deve ser realizada a limpeza dos componentes do objeto do tipo container. (oOwner) Obrigatrio Referncia

Observaes Disable
Disable
Desabilita a utilizao do Browse.

Sintaxe
FWFormBrowse(): Disable ( ) -->

Observaes DisableDetails
DisableDetails
Desabilita a apresentao dos detalhes no Browse.

Sintaxe
FWFormBrowse(): DisableDetails ( ) -->

Observaes Enable
Enable
Habilita a utilizao do Browse.

Sintaxe
FWFormBrowse(): Enable ( ) -->

Observaes ExecuteFilter
ExecuteFilter
Realiza a aplicao dos filtros realizados no Browse.

Sintaxe
FWFormBrowse(): ExecuteFilter ( [ lBrwUpdate] ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

lBrwUpdate

Lgico

Indica se deve ser realizado o refresh do Browse.

Observaes ForceQuitButton
ForceQuitButton
Fora a exibio sair para Browses no ancorados diretamente em alguns containers.

Sintaxe
FWFormBrowse(): ForceQuitButton ( [ lSet] ) -->

Parmetros
Nome lSet Tipo Lgico Descrio Indica se fora a exibiao do boto Sair. Obrigatrio Referncia

Observaes FWBrowse
FWBrowse
Retorna o objeto Browse (FWBROWSE)

Sintaxe
FWFormBrowse(): FWBrowse ( ) --> oBrowse

Retorno
oBrowse() Retorna o componente Browse (FWBROWSE).

Observaes

GetButton
GetButton
Retorna os botes disponveis no menu lateral do Browse.

Sintaxe
FWFormBrowse(): GetButton ( [ nButton] ) --> aButtons

Parmetros
Nome nButton Tipo Numrico Descrio Indica o boto que dever ser retornado e quando no informado ser retornado todos os botes. Obrigatrio Referncia

Retorno
aButtons(array_of_record) Retorna os botes disponveis no menu lateral do Browse.

Observaes GetOwner
GetOwner
Retorna o container de criao do Browse.

Sintaxe
FWFormBrowse(): GetOwner ( ) --> oOwner

Retorno
oOwner() Retorna o container de criao do Browse

Observaes

SetAfterExec
SetAfterExec
Indica o Code-Block executado aps a execuo da operao definida para o boto.

Sintaxe
FWFormBrowse(): SetAfterExec ( < bAfterExec> ) -->

Parmetros
Nome bAfterExec Tipo Bloco de cdigo Descrio Code-Block executado aps a execuo da operao definida para o boto. Obrigatrio X Referncia

Observaes SetBeforeExec
SetBeforeExec
Indica o Code-Block executado antes a execuo da operao definida para o boto.

Sintaxe
FWFormBrowse(): SetBeforeExec ( < bBeforeExec> ) -->

Parmetros
Nome bBeforeExec Tipo Bloco de cdigo Descrio Code-Block executado antes a execuo da operao definida para o boto. Obrigatrio X Referncia

Observaes SetbOKMVCWindow
SetbOKMVCWindow
Indica o Code-Block executado ao clicar na opo OK da MVCWINDOW.

Sintaxe
FWFormBrowse(): SetbOKMVCWindow ( < bOKMVCWindow> ) -->

Parmetros
Nome bOKMVCWindow Tipo Bloco de cdigo Descrio Code-Block executado ao clicar na opo OK da MVCWINDOW. Obrigatrio X Referncia

Observaes SetCacheView
SetCacheView
Define se o browse faz o cache do View, o default do browse fazer o cache, porm se tivermos varios views condicionais devemos no utilizar o cache.

Sintaxe
FWFormBrowse(): SetCacheView ( [ lCacheView] ) -->

Parmetros
Nome lCacheView Tipo Lgico Descrio Indica se deve ativar o cache de View. Obrigatrio Referncia

Observaes SetCheckLoop
SetCheckLoop
Indica o Code-Block executado na verificao do Loop da execuo da rotina.

Sintaxe
FWFormBrowse(): SetCheckLoop ( < bCheckLoop> ) -->

Parmetros
Nome bCheckLoop Tipo Bloco de cdigo Descrio Code-Block executado na verificao do Loop da execuo da rotina. Obrigatrio X Referncia

Observaes SetDetails
SetDetails
Indica que deve ser disponibilizada a barra de detalhes no Browse.

Sintaxe
FWFormBrowse(): SetDetails ( [ lDetails], [ bDetails] ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

lDetails

Lgico

Indica que dever ser disponibilizada a barra de detalhes no Browse. Code-Block executado na carga do container dos detalhes. Quando no informado ser utilizado o padro.

bDetails

Bloco de cdigo

Observaes SetEditDetail
SetEditDetail
Indica que deve ser disponibilizada a edio no detalhes do browse.

Sintaxe
FWFormBrowse(): SetEditDetail ( [ lEditDetail], [ oModel] ) -->

Parmetros
Nome lEditDetail Tipo Lgico Descrio Indica que dever ser disponibilizada edio no browse Objeto do tipo FWFormModel que contem o modelo de edio para edio da linha no detalhes. Obrigatrio Referncia

oModel

Objeto

Observaes SetMenuDef
SetMenuDef

Indica o programa que utilizado para a carga do menu funcional.

Sintaxe
FWFormBrowse(): SetMenuDef ( [ cMenuDef] ) -->

Parmetros
Nome cMenuDef Tipo Caracter Descrio Indica o programa que ser utilizado para a carga do menu funcional Obrigatrio Referncia

Observaes SetNoBrowse
SetNoBrowse
Indica que a execuo das operaes dos botes no devero atualizar o Browse.

Sintaxe
FWFormBrowse(): SetNoBrowse ( [ lNoBrowse] ) -->

Parmetros
Nome lNoBrowse Tipo Lgico Descrio Indica que a execuo das operaes dos botes no devero atualizar o Browse. Obrigatrio Referncia

Observaes SetOwner

SetOwner
Indica o container para criao do Browse.

Sintaxe
FWFormBrowse(): SetOwner ( [ oOwner] ) -->

Parmetros
Nome oOwner Tipo Objeto Descrio Indica o container para criao do Browse. Obrigatrio Referncia

Observaes SetParam
SetParam
Indica o Code-Block executado ao pressionar a tecla F12.

Sintaxe
FWFormBrowse(): SetParam ( < bParam> ) -->

Parmetros
Nome bParam Tipo Bloco de cdigo Descrio Code-Block executado ao pressionar a tecla F12. Obrigatrio X Referncia

Observaes SetSizeBrowse

SetSizeBrowse
Indica o tamanho em percentual do Browse na tela.

Sintaxe
FWFormBrowse(): SetSizeBrowse ( < nPerc> ) -->

Parmetros
Nome nPerc Tipo Numrico Descrio Indica o tamanho em percentual do Browse na tela. Obrigatrio X Referncia

Observaes SetSizeDetails
SetSizeDetails
Indica o tamanho em percentual dos detalhes do Browse na tela.

Sintaxe
FWFormBrowse(): SetSizeDetails ( < nPerc> ) -->

Parmetros
Nome nPerc Tipo Numrico Descrio Indica o percentual do tamanho dos detalhes. Obrigatrio X Referncia

Observaes SetTemporary
SetTemporary

Indica que o Browse utiliza tabela temporria.

Sintaxe
FWFormBrowse(): SetTemporary ( [ lTemporary] ) -->

Parmetros
Nome lTemporary Tipo Lgico Descrio Indica que o Browse utiliza tabela temporria. Obrigatrio Referncia

Observaes SetUseCaseFilter
SetUseCaseFilter
Indica que permitido o filtro case-sensitive no Browse.

Sintaxe
FWFormBrowse(): SetUseCaseFilter ( [ lFilter] ) -->

Parmetros
Nome lFilter Tipo Lgico Descrio Indica que ser permitido o filtro case-sensitive no Browse. Obrigatrio Referncia

Observaes SetUseCursor
SetUseCursor

Define se as rotinas em MVC tem os botes de navegao.

Sintaxe
FWFormBrowse(): SetUseCursor ( [ lUseCursor] ) -->

Parmetros
Nome lUseCursor Tipo Lgico Descrio Indica se as rotinas em MVC teram os botes de navegao. Obrigatrio Referncia

Observaes SetUseFilter
SetUseFilter
Indica que permitido o filtro no Browse.

Sintaxe
FWFormBrowse(): SetUseFilter ( [ lFilter], [ bOnStart] ) -->

Parmetros
Nome lFilter Tipo Lgico Descrio Indica que ser permitido o filtro no Browse. Code-Block executado na criao do componente de filtro. Obrigatrio Referncia

bOnStart

Bloco de cdigo

Observaes

Temporary
Temporary
Retorna se o Browse utiliza tabela temporria.

Sintaxe
FWFormBrowse(): Temporary ( ) --> lTemporary

Retorno
lTemporary(logico) Indica que o Browse utiliza tabela temporria.

Observaes UpdateDetails
UpdateDetails
Executa a atualizao das informaes nos detalhes do Browse.

Sintaxe
FWFormBrowse(): UpdateDetails ( ) -->

Observaes

Propriedade
Propriedade Descrio Tipo Array of Record

Observaes

Exemplos

#INCLUDE "FWBROWSE.CH"User Function FormBrwTable()Local oBrowseLocal oButtonLocal oColumnLocal oDlg//------------------------------------------------------------------// Abertura da tabela//------------------------------------------------------------------DbUseArea(.T.,,"SX2 990","SX2",.T.,.F.)DbSetOrder(1)//-----------------------------------------------------------------// Define a janela do Browse//------------------------------------------------------------------DEFINE MSDIALOG oDlg FROM 0,0 TO 600,800 PIXEL //------------------------------------------------------------------ // Define o Browse //------------------------------------------------------------------ DEFINE FWFORMBROWSE oBrowse DATA TABLE ALIAS "SX2" OF oDlg //------------------------------------------------------- // Cria uma coluna de marca/desmarca //------------------------------------------------------- ADD MARKCOLUMN oColumn DATA { || If(.T./* Funo com a regra*/,'LBOK','LBNO') } DOUBLECLICK { |oBrowse| /* Funo que atualiza a regra*/ } HEADERCLICK { |oBrowse| /* Funo executada no clique do header */ } OF oBrowse //------------------------------------------------------- // Cria uma coluna de status //------------------------------------------------------- ADD STATUSCOLUMN oColumn DATA { || If(.T./* Funo com a regra*/,'BR_VERDE','BR_VERMELHO') } DOUBLECLICK { |oBrowse| /* Funo 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 BUTTON oButton TITLE "Boto 1" ACTION { || MsgAlert(oBrowse:At()) } OF oBrowse ADD BUTTON oButton TITLE "Boto 2" ACTION { || MsgAlert(oBrowse:At()) } 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 "Descrio" SIZE 40 OF oBrowse ADD COLUMN oColumn DATA { || X2_MODO } TITLE "Modo" SIZE 1 OF oBrowse //------------------------------------------------------------------ // Ativao do Browse //------------------------------------------------------------------ ACTIVATE FWFORMBROWSE oBrowse//------------------------------------------------------------------// Ativao do

janela//------------------------------------------------------------------ACTIVATE MSDIALOG oDlg CENTEREDReturn Abrangncia Microsiga Protheus 11 , Protheus 10