Escolar Documentos
Profissional Documentos
Cultura Documentos
Base de Conhecimento
FwBrowse
Tempo aproximado para leitura: superior a 15 minutos
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
Parâmetros
Retorno
oSelf
()
Objeto FWBrowse
Exemplos
oBrowse := FWBrowse():New()
Métodos
Activate
Ativação da classe.
Sintaxe
Parâmetros
Exemplos
oBrowse:Activate()
AddBrwRelation
Sintaxe
Parâmetros
AddColumn
Adiciona uma coluna no Browse em tempo de execução.
Sintaxe
Parâmetros
aColumn Array of Record Indica o array com informações para criação da coluna. X
[n][04] Máscara
[n][06] Tamanho
[n][07] Decimal
[n][17] Id da coluna
[n][18] Indica se a coluna é virtual
AddCustomConfig
Sintaxe
Parâmetros
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
Sintaxe
FWBrowse(): AddFilter ( < cFilter>, < cExpAdvPL>, [ lNoCheck], [ lSelected], [ cAlias], [ lFilterAsk], [ aFilParser], [ cID] ) -->
Parâmetros
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.
Record
Exemplos
oBrowse:AddFilter(cTitle,xCondition)
Observação
Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )
AddLegend
Sintaxe
FWBrowse(): AddLegend ( < xCondition>, < cColor>, <cTitle>, <cID>, <lFilter>) -->
Parâmetros
cID Caracter Id
Exemplos
oBrowse:AddLegend(xCondition,cColor,cTitle)
AddLine
Sintaxe
AddMarkColumns
Sintaxe
Parâmetros
bMark Bloco de código Code-Block com a regra e deverá retornar a imagem referente a marcado/desmarcado. X
AddStatusColumns
Sintaxe
Parâmetros
bStatus Bloco de código Code-Block com a regra e deverá retornar a imagem referente ao status. X
Alias
Retorna o Alias utilizado no Browse.
Sintaxe
AllOk
Sintaxe
At
Sintaxe
Browse
Sintaxe
ClassName
Sintaxe
CleanExFilter
Sintaxe
CleanFilter
Sintaxe
CleanProfile
Sintaxe
Sintaxe
Parâmetros
Retorno
nColPos
()
Coluna posicionada.
Data
Sintaxe
DataArray
Sintaxe
DataQuery
Sintaxe
DataTable
Sintaxe
DataText
Sintaxe
DBFFilter
Indica se utiliza filtro para tabelas CODEBASE.
Sintaxe
DeActivate
Sintaxe
Parâmetros
Default
Sintaxe
DelColumn
Sintaxe
Parâmetros
DeleteFilter
Sintaxe
Parâmetros
DelLine
Executa o Code-Block, definido no método SetDelete(lDelete,bDelete), para deleção de uma linha no Browse.
Sintaxe
DelOk
Executa o Code-Block, definido no método SetDelOk(bDelOK), para validar a deleção de uma linha no Browse.
Sintaxe
Sintaxe
DisableConfig
Sintaxe
DisableFilter
Sintaxe
DisableLocate
Sintaxe
Sintaxe
FWBrowse(): DisableLocate ( ) -->
DisableSaveConfig
Sintaxe
DisableSeek
Sintaxe
Enable
Sintaxe
ExecuteFilter
Aplica os filtros realizados no Browse.
Sintaxe
Parâmetros
Observação
Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )
Filtrate
Sintaxe
(logico)
Indica se o Browse está filtrado.
FWFilter
Sintaxe
()
Retorna o objeto FWFilter.
GetBackColor
Sintaxe
()
Retorna a cor de fundo do Browse
GetClrAlterRow
Sintaxe
()
Retorna a cor alternada do Browse
GetColumn
Retorno um objeto tipo FWBrwColumn da coluna passada.
Sintaxe
GetDescription
Sintaxe
(caracter)
Retorna a descrição do Browse
GetFilterDefault
Sintaxe
(caracter)
Retorna o filtro padrão do Browse.
GetForeColor
Sintaxe
(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
()
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
(caracter)
Identificador do Browse
GetQuery
Sintaxe
FWBrowse(): GetQuery ( ) --> cQuery
Retorno
cQuery
(caracter)
Indica a Query para a criação do Browse.
GoBottom
Sintaxe
Parâmetros
GoColumn
Sintaxe
Parâmetros
GoDown
Parâmetros
GoPgDown
Salta uma página para baixo do item posicionado.
Sintaxe
Sintaxe
FWBrowse(): GoPgUp ( ) -->
GoTo
Sintaxe
Parâmetros
GoTop
Sintaxe
Parâmetros
GoUp
Sintaxe
Parâmetros
Hide
Sintaxe
LineOk
Executa o Code-Block, definido no método SetLineOk(bLineOk), para validação da linha posicionada.
Sintaxe
(logico)
Indica se a linha é válida.
LineRefresh
Sintaxe
Parâmetros
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
Sintaxe
()
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
Sintaxe
(logico)
Indica se a selecão de um filtro é obrigatório para a apresentação do browse
Observação
Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )
OptionConfig
Sintaxe
(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
(logico)
Indica se a opção de impressão está habilitada.
Refresh
Sintaxe
Parâmetros
lGoTop Lógico Indica que deverá ser posicionado no primeiro registro do Browse.
Report
Sintaxe
Reset
Sintaxe
ResetLen
Sintaxe
SetAddLine
Sintaxe
Parâmetros
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
Parâmetros
bAfterAddLine Bloco de código Code-Block a ser executado após a inclusão de uma linha. X
SetAlias
Sintaxe
Parâmetros
SetAllOk
Sintaxe
Parâmetros
SetArray
Sintaxe
Parâmetros
aArray Array of Record Array utilizado para apresentação dos dados no Browse. X
SetBackColor
Indica a cor de fundo do Browse.
Sintaxe
Parâmetros
SetBlkBackColor
Sintaxe
Parâmetros
bBackColor Bloco de código Codigo de bloco que retorna a cor de fonte para a linha atual. X
SetBlkColor
Sintaxe
Parâmetros
bBlkColor Bloco de código Codigo de bloco que retorna a cor de fonte para a linha atual. X
SetChange
Sintaxe
Parâmetros
SetClrAlterRow
Indica a cor alternada do Browse.
Sintaxe
Parâmetros
SetDataArray
Sintaxe
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
SetDataTable
Sintaxe
SetDataText
Sintaxe
SetDelete
Sintaxe
Parâmetros
SetDelOk
Indica o Code-Block executado para validar a exclusão da linha.
Sintaxe
Parâmetros
SetDescription
Sintaxe
Parâmetros
SetDoubleClick
Sintaxe
Parâmetros
SetFieldFilter
Sintaxe
Parâmetros
[n][01] Campo
[n][02] Título
[n][04] Tamanho
[n][05] Decimal
[n][06] Picture
Exemplo:
{ {"CAMPO1", "Campo 1", "C", 10, 0, "@!"}, {"CAMPO2", "Campo 2", "D", 8, 0, ""} }
Observação
Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )
SetFile
Sintaxe
Parâmetros
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
Parâmetros
Observação
Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )
SetFilterDefault
Sintaxe
Parâmetros
Observação
Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )
SetFilterRelation
Sintaxe
Parâmetros
bChgFields Bloco de código Indica o Code-Block executado para trocar os campos para o filtro. X
Observação
Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )
SetFocus
Sintaxe
SetFontBrowse
Sintaxe
Parâmetros
SetForeColor
Sintaxe
Parâmetros
SetGroup
Sintaxe
Parâmetros
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
Parâmetros
SetInsert
Sintaxe
Parâmetros
SetItemDoubleClick
Indica os itens que serão disponibilizados para a configuração do duplo clique pelo usuário.
Sintaxe
Parâmetros
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
Parâmetros
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
Parâmetros
SetLineHeight
Sintaxe
Parâmetros
SetLineOk
Sintaxe
Parâmetros
SetLocate
Sintaxe
Parâmetros
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
Parâmetros
SetObjMark
Indica o objeto FWMARKBROWSE utilizado na passagem de parâmetros na execução das rotinas na FWFORMBROWSE.
Sintaxe
Parâmetros
SetObligateFilter
Sintaxe
Parâmetros
Observação
Não recomendamos o uso dos filtros da classe FwBrowse com Browses do tipo Array ( DataArray() == .T. )
SetOwner
Sintaxe
Parâmetros
SetEditCell
Indica que será permitido a edição de células no Browse
Sintaxe
Parâmetros
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
Parâmetros
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
Parâmetros
SetQuery
Sintaxe
Parâmetros
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
Parâmetros
aIndex Array of Record Indica os índices utilizados pela Query na criação do Browse. X
SetSeek
Sintaxe
Parâmetros
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.
Estrutura do array:
[n,2,n,1] LookUp
[n,2,n,3] Tamanho
[n,2,n,4] Decimal
[n,2,n,6] Máscara
SetSeekChange
Sintaxe
Parâmetros
SetShowLimit
Indica se apresenta somente o limite de informacoes do Browse do tipo Query quando a Query ultrapassar o limite definido.
Sintaxe
Parâmetros
lShowLimit Lógico Indica se apresenta somente o limite de informacoes do Browse do tipo Query quando a Query ultrapassar o limite definido.
SetSuperDel
Sintaxe
Parâmetros
SetTypeMove
Sintaxe
Parâmetros
SetUseCaseFilter
Sintaxe
Parâmetros
SetUseFilter
Habilita a utilização do filtro no Browse.
Sintaxe
Parâmetros
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
Sintaxe
Parâmetros
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
Parâmetros
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
Retorno
Array, lista com os campos definidos como chave do browse.
GetUniqueDataKey()
Sintaxe
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)
Sintaxe
Parâmetros
aDataKey Array Lista com os pares de campos e valores identificados. Quando browse por query: { { “CAMPO”, VALOR }, { “CAMPO”, VALOR } }. X
Retorno
Lógico, indica se foi possível realizar o posicionamento no registro do browse conforme o parâmetro informado.
Show
Sintaxe
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
Parâmetros
lResetSeek Lógico Indica se deve refazer a construção das ordens de pesquisa no browse.
Retorno
NIL
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
1 #INCLUDE "PROTHEUS.CH"
2 #INCLUDE "FWBROWSE.CH"
3 User Function BrwTable()
4
5 Local oBrowse
6 Local oColumn
7 Local oDlg
8
9 //-------------------------------------------------------------------// Abertura da tabela//------------------------------------------------------
10 DbSelectArea("SX2")
11 DbSetOrder(1)
12
13 //-------------------------------------------------------------------// Define a janela do Browse//-----------------------------------------------
14 DEFINE DIALOG oDlg FROM 0,0 TO 600,800 PIXEL
15
16 //------------------------------------------------------------------- // Define o Browse //-------------------------------------------------------
17 DEFINE FWBROWSE oBrowse DATA TABLE ALIAS "SX2" OF oDlg
18
19 //-------------------------------------------------------- // Cria uma coluna de marca/desmarca//----------------------------------------------
20 ADD MARKCOLUMN oColumn DATA { || If(.T./* Função com a regra*/,'LBOK','LBNO') };
21 DOUBLECLICK { |oBrowse| /* Função que atualiza a regra*/ };
22 HEADERCLICK { |oBrowse| /* Função executada no clique do header */ } OF oBrowse
23
24 //-------------------------------------------------------- // Cria uma coluna de status //--------------------------------------------------------
25 ADD STATUSCOLUMN oColumn DATA { || If(.T./* Função com a regra*/,'BR_VERDE','BR_VERMELHO') };
26 DOUBLECLICK { |oBrowse| /* Função executada no duplo clique na coluna*/ } OF oBrowse
27
28 //-------------------------------------------------------- // Adiciona legenda no Browse //-------------------------------------------------------
29 ADD LEGEND DATA 'X2_CHAVE $ "AA1|AA2"' COLOR "GREEN" TITLE "Chave teste 1" OF oBrowse
30 ADD LEGEND DATA '!(X2_CHAVE $ "AA1|AA2")' COLOR "RED" TITLE "Chave teste 2" OF oBrowse
31
32 //------------------------------------------------------------------- // Adiciona as colunas do Browse //-----------------------------------------
33 ADD COLUMN oColumn DATA { || X2_CHAVE } TITLE "Chave" SIZE 3 OF oBrowse
34 ADD COLUMN oColumn DATA { || X2_ARQUIVO } TITLE "Arquivo" SIZE 10 OF oBrowse
35 ADD COLUMN oColumn DATA { || X2_NOME } TITLE DecodeUTF8("Descrição") SIZE 40 OF oBrowse
36 ADD COLUMN oColumn DATA { || X2_MODO } TITLE "Modo" SIZE 1 OF oBrowse
37
38 //------------------------------------------------------------------- // Ativação do Browse//-----------------------------------------------------
39 ACTIVATE FWBROWSE oBrowse
40
41 //-------------------------------------------------------------------// Ativação do janela//------------------------------------------------------
42 ACTIVATE DIALOG oDlg CENTERED
43
44 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
4 Comentários
Everson Da Costa Almeida
Bom dia,
Não encontrei a documentação referente ao método SetColumns.
Política de Termos
privacidade de uso