FWFormBrowse-050612-1959-122

FWFormBrowse

Colapse ALLExpand ALLClasse: FWFormBrowse

O FWFOrmBrowse fornece um objeto do tipo grid, que possibilita ainclusão de botões laterais e detalhes das colunas.

HierarquiaTGrid -> FWBrowse

ConstrutoresNewNew

Construtor da classe.

SintaxeFWFormBrowse(): New ( [ ] ) --> oSelf

ParâmetrosNome Tipo Descrição Obrigatório Referência

Array of Record

Retorno()oSelf

Retorbna o objeto da classe

Observações

MétodosActivate

http://tdn.totvs.com/display/softwaregestao/FWBrowse

Activate

Ativação da classe.

SintaxeFWFormBrowse(): Activate ( [ oOwner] ) -->


oOwner Objeto Objeto do tipocontainer que indicao local que serácriado o Browse.

Observações

AddButtonAddButton

Adiciona um botão na área lateral do Browse.

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


cTitle Caracter Título do botão. X

xAction Qualquer Ação que seráexecutada no cliquedo botão. Pode seruma função ou umCode Block.

uParam1 Qualquer Parâmetroreservado.

nOption Lógico Tipo de operação(1=Visualizar,2=Visualizar,3=Incluir, 4=Alterar,5=Excluir, 6=Alterarsem inclusão denovas linhas,7=Cópia e8=Impressão daregra de negócios)

nVerify Numérico Número do acessoa ser verificada apermissão para ousuário.

lNeedFind Lógico Indica anecessidade depesquisar antes damanutenção doregistro (MenuFuncional).

nRealOpc Numérico Indica a opção real(ordem de criação)do aRotina antigo -Compatibilizaçãocom a MBrowseantiga.

cOperatId Caracter Identificador daopção do menu.Utilizado pararelacionar o o botãoà uma opção demenu.

cToolBar Caracter Indica orelacionamentocom os botões datela (FormBar).

Observações

AfterOptionAfterOption

Permite realizar tratamentos após a execução da ação do botão.

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


cFunction Caracter Nome da funçãodefinida para obotão.

X

nOption Numérico Tipo de operação(1=Visualizar,2=Visualizar,3=Incluir,4=Alterae,5=Excluir,6=Alterar seminclusão de novaslinhas,7=Cópia e8=Impressão daregra de negócios).

X

nVerify Numérico Número do acessoa ser validada apermissão dousuário.

Observações

BeforeOptionBeforeOption

Permite realizar tratamentos antes da execução da ação do botão.

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


cFunction Caracter Indica o nome dafunção definidapara o botão.

X

nOption Numérico Tipo de operação(1=Visualizar,2=Visualizar,3=Incluir,4=Alterae,5=Excluir,6=Alterar seminclusão de novaslinhas,7=Cópia e8=Impressão daregra de negócios).

X

nVerify Numérico Número do acessoa ser validada apermissão dousuário.

cTitle Caracter Indica o título dajanela.

nRealOpc Numérico Indica a popsiçãodo botãoselecionado.

Retorno(logico)lReturn

Indica se a ação pode ser executada.

Observações

ClassNameClassName

Retorna o nome da classe (FWFORMBROWSE)

SintaxeFWFormBrowse(): ClassName ( ) --> cClassName

Retorno(caracter)cClassName

Retorna o nome da classe (FWFORMBROWSE)

Observações

CleanFilter

CleanFilter

Realiza a limpeza dos filtros utilizados no Browse.

SintaxeFWFormBrowse(): CleanFilter ( ) -->

Observações

DeActivateDeActivate

Método que permite destruir a classe.

SintaxeFWFormBrowse(): DeActivate ( [ lFreeChildren] ) -->


lFreeChildren Lógico Indica se deve serrealizada a limpezados componentesdo objeto do tipocontainer. (oOwner)

Observações

DisableDisable

Desabilita a utilização do Browse.

SintaxeFWFormBrowse(): Disable ( ) -->

Observações

DisableDetailsDisableDetails

Desabilita a apresentação dos detalhes no Browse.

SintaxeFWFormBrowse(): DisableDetails ( ) -->

Observações

EnableEnable

Habilita a utilização do Browse.

SintaxeFWFormBrowse(): Enable ( ) -->

Observações

ExecuteFilterExecuteFilter

Realiza a aplicação dos filtros realizados no Browse.

SintaxeFWFormBrowse(): ExecuteFilter ( [ lBrwUpdate] ) -->


lBrwUpdate Lógico Indica se deve serrealizado o refreshdo Browse.

Observações

ForceQuitButtonForceQuitButton

Força a exibição sair para Browses não ancorados diretamente em alguns containers.

SintaxeFWFormBrowse(): ForceQuitButton ( [ lSet] ) -->


lSet Lógico Indica se força aexibiçao do botãoSair.

Observações

FWBrowseFWBrowse

Retorna o objeto Browse (FWBROWSE)

SintaxeFWFormBrowse(): FWBrowse ( ) --> oBrowse

Retorno()oBrowse

Retorna o componente Browse (FWBROWSE).

Observações

GetButtonGetButton

Retorna os botões disponíveis no menu lateral do Browse.

SintaxeFWFormBrowse(): GetButton ( [ nButton] ) --> aButtons


nButton Numérico Indica o botão quedeverá serretornado e quandonão informado seráretornado todos osbotões.

Retorno(array_of_record)aButtons

Retorna os botões disponíveis no menu lateral do Browse.

Observações

GetOwnerGetOwner

Retorna o container de criação do Browse.

SintaxeFWFormBrowse(): GetOwner ( ) --> oOwner

Retorno()oOwner

Retorna o container de criação do Browse

Observações

SetAfterExecSetAfterExec

Indica o Code-Block executado após a execução da operação definida para o botão.

SintaxeFWFormBrowse(): SetAfterExec ( < bAfterExec> ) -->


bAfterExec Bloco de código Code-Blockexecutado após aexecução daoperação definidapara o botão.

X

Observações

SetBeforeExecSetBeforeExec

Indica o Code-Block executado antes a execução da operação definida para o botão.

SintaxeFWFormBrowse(): SetBeforeExec ( < bBeforeExec> ) -->


bBeforeExec Bloco de código Code-Blockexecutado antes aexecução daoperação definidapara o botão.

X

Observações

SetbOKMVCWindowSetbOKMVCWindow

Indica o Code-Block executado ao clicar na opção OK da MVCWINDOW.

SintaxeFWFormBrowse(): SetbOKMVCWindow ( < bOKMVCWindow> ) -->


bOKMVCWindow Bloco de código Code-Blockexecutado ao clicarna opção OK daMVCWINDOW.

X

Observações

SetCacheViewSetCacheView

Define se o browse faz o cache do View, o default do browse é fazer o cache, porém setivermos varios views condicionais devemos não utilizar o cache.

SintaxeFWFormBrowse(): SetCacheView ( [ lCacheView] ) -->


lCacheView Lógico Indica se deveativar o cache deView.

Observações

SetCheckLoopSetCheckLoop

Indica o Code-Block executado na verificação do Loop da execução da rotina.

SintaxeFWFormBrowse(): SetCheckLoop ( < bCheckLoop> ) -->


bCheckLoop Bloco de código Code-Blockexecutado naverificação do Loopda execução darotina.

X

Observações

SetDetailsSetDetails

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

SintaxeFWFormBrowse(): SetDetails ( [ lDetails], [ bDetails] ) -->


lDetails Lógico Indica que deveráser disponibilizadaa barra de detalhesno Browse.

bDetails Bloco de código Code-Blockexecutado na cargado container dosdetalhes. Quandonão informado seráutilizado o padrão.

Observações

SetEditDetailSetEditDetail

Indica que deve ser disponibilizada a edição no detalhes do browse.

SintaxeFWFormBrowse(): SetEditDetail ( [ lEditDetail], [ oModel] ) -->


lEditDetail Lógico Indica que deveráser disponibilizadaedição no browse

oModel Objeto Objeto do tipoFWFormModel quecontem o modelode edição paraedição da linha nodetalhes.

Observações

SetMenuDefSetMenuDef

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

SintaxeFWFormBrowse(): SetMenuDef ( [ cMenuDef] ) -->


cMenuDef Caracter Indica o programaque será utilizadopara a carga domenu funcional

Observações

SetNoBrowseSetNoBrowse

Indica que a execução das operações dos botões não deverão atualizar o Browse.

SintaxeFWFormBrowse(): SetNoBrowse ( [ lNoBrowse] ) -->


lNoBrowse Lógico Indica que aexecução dasoperações dosbotões não deverãoatualizar o Browse.

Observações

SetOwner

SetOwner

Indica o container para criação do Browse.

SintaxeFWFormBrowse(): SetOwner ( [ oOwner] ) -->


oOwner Objeto Indica o containerpara criação doBrowse.

Observações

SetParamSetParam

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

SintaxeFWFormBrowse(): SetParam ( < bParam> ) -->


bParam Bloco de código Code-Blockexecutado aopressionar a teclaF12.

X

Observações

SetSizeBrowse

SetSizeBrowse

Indica o tamanho em percentual do Browse na tela.

SintaxeFWFormBrowse(): SetSizeBrowse ( < nPerc> ) -->


nPerc Numérico Indica o tamanhoem percentual doBrowse na tela.

X

Observações

SetSizeDetailsSetSizeDetails

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

SintaxeFWFormBrowse(): SetSizeDetails ( < nPerc> ) -->


nPerc Numérico Indica o percentualdo tamanho dosdetalhes.

X

Observações

SetTemporarySetTemporary

Indica que o Browse utiliza tabela temporária.

SintaxeFWFormBrowse(): SetTemporary ( [ lTemporary] ) -->


lTemporary Lógico Indica que oBrowse utilizatabela temporária.

Observações

SetUseCaseFilterSetUseCaseFilter

Indica que é permitido o filtro case-sensitive no Browse.

SintaxeFWFormBrowse(): SetUseCaseFilter ( [ lFilter] ) -->


lFilter Lógico Indica que serápermitido o filtrocase-sensitive noBrowse.

Observações

SetUseCursorSetUseCursor

Define se as rotinas em MVC tem os botões de navegação.

SintaxeFWFormBrowse(): SetUseCursor ( [ lUseCursor] ) -->


lUseCursor Lógico Indica se as rotinasem MVC teram osbotões denavegação.

Observações

SetUseFilterSetUseFilter

Indica que é permitido o filtro no Browse.

SintaxeFWFormBrowse(): SetUseFilter ( [ lFilter], [ bOnStart] ) -->


lFilter Lógico Indica que serápermitido o filtro noBrowse.

bOnStart Bloco de código Code-Blockexecutado nacriação docomponente defiltro.

Observações

TemporaryTemporary

Retorna se o Browse utiliza tabela temporária.

SintaxeFWFormBrowse(): Temporary ( ) --> lTemporary

Retorno(logico)lTemporary

Indica que o Browse utiliza tabela temporária.

Observações

UpdateDetailsUpdateDetails

Executa a atualização das informações nos detalhes do Browse.

SintaxeFWFormBrowse(): UpdateDetails ( ) -->

Observações

PropriedadePropriedade Descrição Tipo

Array of Record

Observações

Exemplos

#INCLUDE "FWBROWSE.CH"User FunctionFormBrwTable()Local oBrowseLocal oButtonLocaloColumnLocaloDlg//-------------------------------------------------------------------// Abertura databela//-------------------------------------------------------------------DbUseArea(.T.,,"SX2990","SX2",.T.,.F.)DbSetOrder(1)//-------------------------------------------------------------------// Define a janela doBrowse//-------------------------------------------------------------------DEFINE MSDIALOGoDlg FROM 0,0 TO 600,800 PIXEL//------------------------------------------------------------------- // Define o Browse//------------------------------------------------------------------- DEFINE FWFORMBROWSEoBrowse DATA TABLE ALIAS "SX2" OF oDlg //-------------------------------------------------------- // Cria uma coluna demarca/desmarca //-------------------------------------------------------- ADD MARKCOLUMN oColumn DATA { ||If(.T./* Função com a regra*/,'LBOK','LBNO') }DOUBLECLICK { |oBrowse| /* Função que atualizaa regra*/ } HEADERCLICK { |oBrowse| /* Funçãoexecutada no clique do header */ } OF oBrowse //-------------------------------------------------------- // Cria uma coluna de status //-------------------------------------------------------- ADD STATUSCOLUMN oColumn DATA { ||If(.T./* Função com aregra*/,'BR_VERDE','BR_VERMELHO') } DOUBLECLICK{ |oBrowse| /* Função executada no duplo cliquena coluna*/ } OF oBrowse

//-------------------------------------------------------- // Adiciona legenda no Browse //-------------------------------------------------------- ADD LEGEND DATA 'X2_CHAVE $"AA1|AA2"' COLOR "GREEN" TITLE "Chave teste1" OF oBrowse ADD LEGEND DATA '!(X2_CHAVE $"AA1|AA2")' COLOR "RED" TITLE "Chave teste 2"OF oBrowse //------------------------------------------------------------------- // Adiciona as colunasdo Browse //------------------------------------------------------------------- ADD BUTTON oButtonTITLE "Botão 1" ACTION { ||MsgAlert(oBrowse:At()) } OF oBrowse ADD BUTTONoButton TITLE "Botão 2" ACTION { ||MsgAlert(oBrowse:At()) } OF oBrowse //------------------------------------------------------------------- // Adiciona as colunasdo Browse //------------------------------------------------------------------- ADD COLUMN oColumn DATA{ || X2_CHAVE } TITLE "Chave" SIZE 3 OFoBrowse ADD COLUMN oColumn DATA { ||X2_ARQUIVO } TITLE "Arquivo" SIZE 10 OFoBrowse ADD COLUMN oColumn DATA { || X2_NOME } TITLE "Descrição" SIZE 40 OF oBrowse ADDCOLUMN oColumn DATA { || X2_MODO } TITLE"Modo" SIZE 1 OF oBrowse//------------------------------------------------------------------- // Ativação do Browse//------------------------------------------------------------------- ACTIVATE FWFORMBROWSEoBrowse//-------------------------------------------------------------------// Ativação do

janela//-------------------------------------------------------------------ACTIVATE MSDIALOGoDlg CENTEREDReturn

AbrangênciaMicrosiga Protheus 11 , Protheus 10

FWFormBrowse-050612-1959-122

Documents

Transcript of FWFormBrowse-050612-1959-122