mp-FWBrowse-060513-0946-37861

FWBrowse

Colapse ALLExpand ALLClasse: FWBrowse

Fornece um objeto do tipo grid que permite aexibição de dados do tipo array, texto, tabelae query.

HierarquiaTGrid

ConstrutoresNewNew

Construtor da classe.

SintaxeFWBrowse(): New ( [ oOwner] ) --> oSelf

Parâmetros

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

oOwner Objeto Objeto proprietário

RetornooSelf

()Objeto FWBrowse

ExemplosoBrowse := FWBrowse():New()

http://tdn.totvs.com/display/tec/TGrid

MétodosActivateActivate

Ativação da classe.

SintaxeFWBrowse(): Activate ( [ lFWBrowse] ) -->

Parâmetros


lFWBrowse Lógico Indica se achamada foiacionada pelaclasseFWBROWSE

ExemplosoBrowse:Activate()

AddBrwRelationAddBrwRelation

Permite adicionar a informacao de um browse relacionado.

SintaxeFWBrowse(): AddBrwRelation ( < oBrwRel> ) -->

Parâmetros


oBrwRel Objeto Browse que sedeseja informarcomo relacionado

X

Observaçõesnull

AddColumnAddColumn

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

SintaxeFWBrowse(): AddColumn ( < aColumn> ) -->

Parâmetros


aColumn Array of Record Indica o array cominformações paracriação da coluna.

X

Observaçõesnull

AddCustomConfigAddCustomConfig

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

SintaxeFWBrowse(): AddCustomConfig ( < cTitle>, < bView>, [ bSave] ) -->

Parâmetros


cTitle Caracter Título a ser exibidona configuração.

X

bView Bloco de código Code-Block decarga da janela deconfiguração

X

bSave Bloco de código Code-Block degravação dasconfiguraçõesefetuadas pelousuário.

Observaçõesnull

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

AddFilterAddFilter

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

SintaxeFWBrowse(): AddFilter ( < cFilter>, < cExpAdvPL>, [ lNoCheck], [ lSelected], [ cAlias], [ lFilterAsk], [ aFilParser], [cID] ) -->

Parâmetros


cFilter Caracter Título que seráexibido no filtro

X

cExpAdvPL Caracter Expressão do filtroem formato AdvPL.

X

lNoCheck Lógico Indica que o filtronão poderá sermarcado/desmarcado.

lSelected Lógico Indica que o filtrodeverá serapresentado comomarcado/desmarcado.

cAlias Caracter Indica que o filtro éde relacionamentoentre as tabelas e aexpressão AdvPLdeve ser informadoobrigatoriamentecom expressõesSQL.

lFilterAsk Lógico Indica se o filtropergunta asinformações naexecução.

aFilParser Array of Record Array contendoinformaçõesparseadas do filtro.

cID Caracter Nome doidentificador do filtro

Observaçõesnull

ExemplosoBrowse:AddFilter(cTitle,xCondition)

AddLineAddLine

Permite adicionar um linha no Browse.

SintaxeFWBrowse(): AddLine ( ) -->

Observaçõesnull

AddMarkColumnsAddMarkColumns

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

SintaxeFWBrowse(): AddMarkColumns ( < bMark>, [ bLDblClick], [ bHeaderClick] ) -->

Parâmetros


bMark Bloco de código Code-Block com aregra e deveráretornar a imagemreferente amarcado/desmarcado.

X

bLDblClick Bloco de código Code-Block com aexecução do duploclique na coluna.

bHeaderClick Bloco de código Code-Block com aexecução do cliqueno header dacoluna.

Observaçõesnull

AddStatusColumns

AddStatusColumns

Permite adicionar uma coluna de status.

SintaxeFWBrowse(): AddStatusColumns ( < bStatus>, [ bLDblClick] ) -->

Parâmetros


bStatus Bloco de código Code-Block com aregra e deveráretornar a imagemreferente ao status.

X

bLDblClick Bloco de código Code-Block com aexecução do duploclique na coluna.

Observaçõesnull

AliasAlias

Retorna o Alias utilizado no Browse.

SintaxeFWBrowse(): Alias ( ) --> cAlias

RetornocAlias

(caracter)Alias utilizado no Browse.

Observaçõesnull

AllOkAllOk

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

SintaxeFWBrowse(): AllOk ( ) --> lReturn

RetornolReturn

(logico)Retorno da execução do Code-Block.

Observaçõesnull

AtAt

Retorna a posição atual do registro.

SintaxeFWBrowse(): At ( ) --> nAt

RetornonAt

()Posição atual do registro.

Observaçõesnull

BrowseBrowse

Retorna o componente Browse (TGRID).

Sintaxe

FWBrowse(): Browse ( ) --> oBrowse

RetornooBrowse

()Objeto Browse (TGRID).

Observaçõesnull

ClassNameClassName

Retorna o nome da classe (FWBROWSE).

SintaxeFWBrowse(): ClassName ( ) --> cClassName

RetornocClassName

(caracter)Nome da classe.

Observaçõesnull

CleanExFilterCleanExFilter

Executa a limpeza dos filtros extendidos realizados no Browse.

SintaxeFWBrowse(): CleanExFilter ( ) -->

Observaçõesnull

CleanFilter

CleanFilter

Realizada a limpeza dos filtros utilizados no Browse.

SintaxeFWBrowse(): CleanFilter ( ) -->

Observaçõesnull

CleanProfileCleanProfile

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

SintaxeFWBrowse(): CleanProfile ( ) -->

Observaçõesnull

ColPosColPos

Retorna a coluna posicionada no Browse

SintaxeFWBrowse(): ColPos ( [ lDeleted] ) --> nColPos

Parâmetros


lDeleted Lógico Indica que deveconsiderar ascolunas deletadas.

RetornonColPos

()Coluna posicionada.

Observaçõesnull

DataData

Retorna o objeto de dados no Browse.

SintaxeFWBrowse(): Data ( ) --> oData

RetornooData

()Retorna o objeto de dados do Browse

Observaçõesnull

DataArrayDataArray

Retorna se o dados apresentados no Browse é de Array.

SintaxeFWBrowse(): DataArray ( ) --> lDataArray

RetornolDataArray

(logico)Indica que o Browse utiliza informações de um array.

Observações

null

DataQueryDataQuery

Retorna se o dados apresentados no Browse é de Query.

SintaxeFWBrowse(): DataQuery ( ) --> lDataQuery

RetornolDataQuery

(logico)Indica que o Browse utiliza informações de uma Query.

Observaçõesnull

DataTableDataTable

Retorna se o dados apresentados no Browse é de Tabela.

SintaxeFWBrowse(): DataTable ( ) --> lDataTable

RetornolDataTable

(logico)Indica que o Browse utiliza informações de uma Tabela.

Observaçõesnull

DataTextDataText

Retorna se o dados apresentados no Browse é de Texto.

SintaxeFWBrowse(): DataText ( ) --> lDataText

RetornolDataText

(logico)Indica que o Browse utiliza informações de um arquivo Texto.

Observaçõesnull

DBFFilterDBFFilter

Indica se utiliza filtro para tabelas CODEBASE.

SintaxeFWBrowse(): DBFFilter ( ) --> lDBFFilter

RetornolDBFFilter

(logico)Indica se utiliza filtro para tabelas CODEBASE.

Observaçõesnull

DeActivateDeActivate

Método de destruição da classe.

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

Parâmetros


lFreeChildren Lógico Indica se énecessário limpar aclasse proprietária.(oOwner)

Observaçõesnull

DefaultDefault

Compatibilização com a MBrowse antiga.

SintaxeFWBrowse(): Default ( ) -->

Observaçõesnull

DelColumnDelColumn

Indica que uma determinada coluna está deletada.

SintaxeFWBrowse(): DelColumn ( < nColumn> ) -->

Parâmetros


nColumn Numérico Indica a coluna queserá marcada comodeletada.

X

Observaçõesnull

DeleteFilterDeleteFilter

Permite realizar a exclusão de filtros.

SintaxeFWBrowse(): DeleteFilter ( [ cID] ) -->

Parâmetros


cID Caracter Identificador doFiltro

Observaçõesnull

DelLineDelLine

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

SintaxeFWBrowse(): DelLine ( ) -->

Observaçõesnull

DelOkDelOk

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

SintaxeFWBrowse(): DelOk ( ) --> lReturn

RetornolReturn

()

Observaçõesnull

DisableDisable

Desabilita a utilização do Browse.

SintaxeFWBrowse(): Disable ( ) -->

Observaçõesnull

DisableConfigDisableConfig

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

SintaxeFWBrowse(): DisableConfig ( ) -->

Observaçõesnull

DisableFilterDisableFilter

Desabilita a utilização do filtro no Browse.

SintaxeFWBrowse(): DisableFilter ( ) -->

Observaçõesnull

DisableLocateDisableLocate

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

SintaxeFWBrowse(): DisableLocate ( ) -->

DisableReportDisableReport

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

SintaxeFWBrowse(): DisableReport ( ) -->

Observaçõesnull

DisableSaveConfigDisableSaveConfig

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

SintaxeFWBrowse(): DisableSaveConfig ( ) -->

Observações

null

DisableSeekDisableSeek

Desabilita a utilização da pesquisa no Browse.

SintaxeFWBrowse(): DisableSeek ( ) -->

Observaçõesnull

EnableEnable

Habilita a utilização do Browse.

SintaxeFWBrowse(): Enable ( ) -->

Observaçõesnull

ExecuteFilterExecuteFilter

Aplica os filtros realizados no Browse.

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

Parâmetros


lBrwUpdate Lógico Atualiza o Browse eposiciona noprimeiro registro.

Observaçõesnull

FiltrateFiltrate

Indica se o Browse está filtrado.

SintaxeFWBrowse(): Filtrate ( ) --> lFiltrate

RetornolFiltrate

(logico)Indica se o Browse está filtrado.

Observaçõesnull

FWFilterFWFilter

Retorna o objeto FWFilter.

SintaxeFWBrowse(): FWFilter ( ) --> oFWFilter

RetornooFWFilter

()Retorna o objeto FWFilter.

Observações

null

GetBackColorGetBackColor

Retorna a cor de fundo do Browse.

SintaxeFWBrowse(): GetBackColor ( ) --> nBackColor

RetornonBackColor

()Retorna a cor de fundo do Browse

Observaçõesnull

GetClrAlterRowGetClrAlterRow

Retorna a cor alternada do Browse.

SintaxeFWBrowse(): GetClrAlterRow ( ) --> nClrAlterRow

RetornonClrAlterRow

()Retorna a cor alternada do Browse

Observaçõesnull

GetColumnGetColumn

Retorno um objeto tipo FWBrwColumn da coluna passada.

SintaxeFWBrowse(): GetColumn ( ) --> nCol

RetornonCol

()Retorna a coluna posicionada.

Observaçõesnull

GetDescriptionGetDescription

Retorna a descrição do Browse.

SintaxeFWBrowse(): GetDescription ( ) --> cDescription

RetornocDescription

(caracter)Retorna a descrição do Browse

GetFilterDefaultGetFilterDefault

Retorna o filtro padrão do Browse

SintaxeFWBrowse(): GetFilterDefault ( ) --> cFilterDefault

RetornocFilterDefault

(caracter)Retorna o filtro padrão do Browse.

Observaçõesnull

GetForeColorGetForeColor

Retorna a cor da fonte do Browse.

SintaxeFWBrowse(): GetForeColor ( ) --> cForeColor

RetornocForeColor

(caracter)Retorna a cor da fonte do Browse.

Observaçõesnull

GetObjMarkGetObjMark

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

SintaxeFWBrowse(): GetObjMark ( ) --> oObjMark

RetornooObjMark

()Indica o objeto FWMARKBROWSE

Observaçõesnull

GetProfileIDGetProfileID

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

SintaxeFWBrowse(): GetProfileID ( ) --> cProfileID

RetornocProfileID

(caracter)Identificador do Browse

Observaçõesnull

GetQueryGetQuery

Retorna a Query que esta sendo utilizada no Browse.

SintaxeFWBrowse(): GetQuery ( ) --> cQuery

RetornocQuery

(caracter)Indica a Query para a criação do Browse.

Observaçõesnull

GoBottomGoBottom

Posiciona no último registro do Browse.

SintaxeFWBrowse(): GoBottom ( [ lCallRefresh] ) -->

Parâmetros


lCallRefresh Lógico Indica que foichamado atravésdo métodoRefresh().

Observaçõesnull

GoColumnGoColumn

Posiciona na coluna desejada.

SintaxeFWBrowse(): GoColumn ( [ nColumn] ) -->

Parâmetros


nColumn Numérico Indica a coluna quedeseja posicionar.

Observaçõesnull

GoDownGoDown

Salta uma ou mais linhas para baixo do item posicionado.

SintaxeFWBrowse(): GoDown ( [ nOffSet], [ lReport] ) -->

Parâmetros


nOffSet Numérico Indica a quantidadede linhas a seremsaltadas.

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

Observaçõesnull

GoPgDownGoPgDown

Salta uma página para baixo do item posicionado.

SintaxeFWBrowse(): GoPgDown ( ) -->

GoPgUpGoPgUp

Salta uma página para cima do item posicionado.

SintaxeFWBrowse(): GoPgUp ( ) -->

Observaçõesnull

GoToGoTo

Posiciona em um determinado registro do Browse.

SintaxeFWBrowse(): GoTo ( < nGoto>, [ lRefresh] ) -->

Parâmetros


nGoto Numérico Indica o item quedeverá serposicionado.

X

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

Observaçõesnull

GoTopGoTop

Posiciona no primeiro registro do Browse.

SintaxeFWBrowse(): GoTop ( [ lForce] ) -->

Parâmetros


lForce Lógico Indica que deveráforçar oposicionamento.

Observações

null

GoUpGoUp

Salta uma ou mais linhas para cima do item posicionado.

SintaxeFWBrowse(): GoUp ( [ nOffSet] ) -->

Parâmetros


nOffSet Numérico Indica a quantidadede linhas a seremsaltadas.

Observaçõesnull

HideHide

Permite tornar o Browse invisível

SintaxeFWBrowse(): Hide ( ) -->

Observaçõesnull

LineOkLineOk

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

SintaxeFWBrowse(): LineOk ( ) --> lRet

RetornolRet

(logico)Indica se a linha é válida.

LineRefreshLineRefresh

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

SintaxeFWBrowse(): LineRefresh ( [ nAt] ) -->

Parâmetros


nAt Numérico Indica a linha queserá atualizada.

Observaçõesnull

LogicLenLogicLen

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

SintaxeFWBrowse(): LogicLen ( ) --> nLogicLen

RetornonLogicLen

()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çõesnull

ObligateFilterObligateFilter

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

SintaxeFWBrowse(): ObligateFilter ( ) --> lObligateFilter

RetornolObligateFilter

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

Observaçõesnull

OptionConfigOptionConfig

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

SintaxeFWBrowse(): OptionConfig ( ) --> lOptionConfig

RetornolOptionConfig

(logico)Indica se a opção de configuração está habilitada.

Observaçõesnull

OptionReportOptionReport

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

SintaxeFWBrowse(): OptionReport ( ) --> lOptionReport

RetornolOptionReport

(logico)Indica se a opção de impressão está habilitada.

Observaçõesnull

RefreshRefresh

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

SintaxeFWBrowse(): Refresh ( [ lGoTop] ) -->

Parâmetros


lGoTop Lógico Indica que deveráser posicionado noprimeiro registro doBrowse.

Observaçõesnull

Report

Report

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

SintaxeFWBrowse(): Report ( ) -->

ResetReset

Compatibilidade com o Browse antigo.

SintaxeFWBrowse(): Reset ( ) -->

Observaçõesnull

ResetLenResetLen

Compatibilidade com o Browse antigo.

SintaxeFWBrowse(): ResetLen ( ) -->

SetAddLineSetAddLine

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

SintaxeFWBrowse(): SetAddLine ( < bAdd> ) -->

Parâmetros


bAdd Bloco de código Indica a Code-Blockexecutado paraadicionar linha nobrowse.

X

Observaçõesnull

SetAfterAddLineSetAfterAddLine

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

SintaxeFWBrowse(): SetAfterAddLine ( < bAfterAddLine> ) -->

Parâmetros


bAfterAddLine Bloco de código Code-Block a serexecutado após ainclusão de umalinha.

X

Observaçõesnull

SetAliasSetAlias

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

SintaxeFWBrowse(): SetAlias ( < cAlias> ) -->

Parâmetros


cAlias Caracter Indica o alias databela

X

SetAllOkSetAllOk

Indica o Code-Block executado para validar todos itens do Browse.

SintaxeFWBrowse(): SetAllOk ( < bAllOk> ) -->

Parâmetros


bAllOk Bloco de código Code-Block paravalidar todos itensdo Browse.

X

Observaçõesnull

SetArraySetArray

Indica o array utilizado para apresentação dos dados no Browse.

SintaxeFWBrowse(): SetArray ( < aArray> ) -->

Parâmetros


aArray Array of Record Array utilizado paraapresentação dosdados no Browse.

X

Observaçõesnull

SetBackColorSetBackColor

Indica a cor de fundo do Browse.

SintaxeFWBrowse(): SetBackColor ( < nBackColor> ) -->

Parâmetros


nBackColor Numérico Cor de fundo doBrowse.

X

Observaçõesnull

SetBlkBackColorSetBlkBackColor

Indica a cor de fundo para a linha atual.

Sintaxe

FWBrowse(): SetBlkBackColor ( < bBackColor> ) -->

Parâmetros


bBackColor Bloco de código Codigo de blocoque retorna a corde fonte para alinha atual.

X

SetBlkColorSetBlkColor

Indica a cor de fonte para a linha atual.

SintaxeFWBrowse(): SetBlkColor ( < bBlkColor> ) -->

Parâmetros


bBlkColor Bloco de código Codigo de blocoque retorna a corde fonte para alinha atual.

X

Observaçõesnull

SetChangeSetChange

Indica a Code-Block executado após a mudança de uma linha.

SintaxeFWBrowse(): SetChange ( < bChange> ) -->

Parâmetros


bChange Bloco de código Code-Blockexecutado após amudança de umalinha.

X

Observaçõesnull

SetClrAlterRowSetClrAlterRow

Indica a cor alternada do Browse.

SintaxeFWBrowse(): SetClrAlterRow ( < nClrAlterRow> ) -->

Parâmetros


nClrAlterRow Numérico Indica a cor dealternada doBrowse.

X

Observaçõesnull

SetColumns

SetColumns

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

SintaxeFWBrowse(): SetColumns ( < aColumns> ) -->

Parâmetros


aColumns Array of Record Array contendo asinformações dacoluna.

X

SetDataArraySetDataArray

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

SintaxeFWBrowse(): SetDataArray ( ) -->

Observaçõesnull

SetDataQuerySetDataQuery

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

SintaxeFWBrowse(): SetDataQuery ( ) -->

Observações

null

SetDataTableSetDataTable

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

SintaxeFWBrowse(): SetDataTable ( ) -->

Observaçõesnull

SetDataTextSetDataText

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

SintaxeFWBrowse(): SetDataText ( ) -->

Observaçõesnull

SetDeleteSetDelete

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

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

Parâmetros


lDelete Lógico Indica se o usuáriopode excluir linhasno Browse.

bDelete Bloco de código Code-Blockexecutado naexclusão da linha.

Observaçõesnull

SetDelOkSetDelOk

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

SintaxeFWBrowse(): SetDelOk ( < bDelOK> ) -->

Parâmetros


bDelOK Bloco de código Code-Blockexecutado paravalidar a exclusãoda linha.

X

Observaçõesnull

SetDescriptionSetDescription

Indica a descrição do Browse.

SintaxeFWBrowse(): SetDescription ( < cDescription> ) -->

Parâmetros


cDescription Caracter Indica a descriçãodo Browse

X

Observaçõesnull

SetDoubleClickSetDoubleClick

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

SintaxeFWBrowse(): SetDoubleClick ( < bLDblClick> ) -->

Parâmetros


bLDblClick Bloco de código Code-Blockexecutado no duploclique do item noBrowse.

X

Observaçõesnull

SetEditCellSetEditCell

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

SintaxeFWBrowse(): SetEditCell ( [ lEditCell], [ bValidEdit] ) -->

Parâmetros


lEditCell Lógico Indica se permite aedição de células.

bValidEdit Bloco de código Code-Blockexecutado paravalidar a edição dacélula.

Observaçõesnull

SetFieldFilterSetFieldFilter

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

SintaxeFWBrowse(): SetFieldFilter ( < aFields> ) -->

Parâmetros


aFields Array of Record Array contendo oscamposapresentados naedição de filtros.

X

Observaçõesnull

SetFileSetFile

Indica o arquivo texto que será utilizado no Browse.

SintaxeFWBrowse(): SetFile ( < cFile>, [ cCharSeparator] ) -->

Parâmetros


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

X

cCharSeparator Caracter Indica o caracterseparador dosdados. Ex.: ";" para"dados1;dados2;dados3"

SetFilterSetFilter

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

SintaxeFWBrowse(): SetFilter ( < cCpoFil>, < cTopFun>, [ cBotFun] ) -->

Parâmetros


cCpoFil Caracter Indica o campo aser considerado olimite superior einferior.

X

cTopFun Caracter Indica o limitesuperior.

X

cBotFun Array of Record Indica o limiteinferior.

Observaçõesnull

SetFilterDefaultSetFilterDefault

Indica o filtro padrão do Browse.

SintaxeFWBrowse(): SetFilterDefault ( < cFilterDefault> ) -->

Parâmetros


cFilterDefault Caracter Indica o filtro AdvPLpara o Browse.

X

Observaçõesnull

SetFilterRelationSetFilterRelation

Indica o relacionamento de filtros para o Browse.

SintaxeFWBrowse(): SetFilterRelation ( < aFilterRelation>, < bChgFields> ) -->

Parâmetros


aFilterRelation Array of Record Array contendo ositens dorelacionamento.

X

bChgFields Bloco de código Indica o Code-Blockexecutado paratrocar os campospara o filtro.

X

Observaçõesnull

SetFocusSetFocus

Força o foco no objeto Browse.

SintaxeFWBrowse(): SetFocus ( ) -->

SetFontBrowseSetFontBrowse

Indica a fonte do Browse.

SintaxeFWBrowse(): SetFontBrowse ( [ oFont] ) -->

Parâmetros


oFont Objeto Indica o objetoTFont utilizado noBrowse.

Observaçõesnull

SetForeColorSetForeColor

Indica a cor da fonte no Browse.

SintaxeFWBrowse(): SetForeColor ( < nForeColor> ) -->

Parâmetros


nForeColor Numérico Cor da fonte noBrowse.

X

Observaçõesnull

SetGroupSetGroup

Indica que o Browse utiliza agrupamento de informações.

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

Parâmetros


bGroup Bloco de código Code-Block com aregra doagrupamentoretornando um valorlógico (.T. =Quebra, .F. = Filho).

X

lOpen Lógico Indica que oagrupamento seráapresentado comos sub-itens visíveisna abertura doBrowse.

Observaçõesnull

SetHeaderImageSetHeaderImage

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

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

Parâmetros


nColumn Numérico Indica coluna queserá apresentada aimagem.

X

cResource Caracter Indica a imagemque seráapresentada aolado da coluna.

X

Observaçõesnull

SetIdAliasSetIdAlias

Indica o ID para Browses que trabalham com Left Join.

SintaxeFWBrowse(): SetIdAlias ( < cIdAlias> ) -->

Parâmetros


cIdAlias Caracter Indica o ID paraBrowses quetrabalham com LeftJoin.

X

Observaçõesnull

SetInsertSetInsert

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

SintaxeFWBrowse(): SetInsert ( [ lInsert] ) -->

Parâmetros


lInsert Lógico Indica que poderáinserir novas linhas.

Observaçõesnull

SetItemDoubleClickSetItemDoubleClick

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

SintaxeFWBrowse(): SetItemDoubleClick ( < aItemDoubleClick> ) -->

Parâmetros


aItemDoubleClick Array of Record Array contendo asinformações queserão apresentadaspara configuraçãodo duplo clique.

X

SetItemHeaderClickSetItemHeaderClick

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

SintaxeFWBrowse(): SetItemHeaderClick ( < aItemHeaderClick> ) -->

Parâmetros


aItemHeaderClick Array of Record Indica os itens queserãodisponibilizadospara a configuraçãodo clique no headerpelo usuário.

X

Observaçõesnull

SetLineBeginSetLineBegin

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

SintaxeFWBrowse(): SetLineBegin ( < nLineBegin> ) -->

Parâmetros


nLineBegin Numérico Indica a linha inicialdo arquivo texto.

X

Observaçõesnull

SetLineHeightSetLineHeight

Indica a altura da linha no Browse.

SintaxeFWBrowse(): SetLineHeight ( [ nHeight] ) -->

Parâmetros


nHeight Numérico Indica a altura dalinha

Observaçõesnull

SetLineOkSetLineOk

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

SintaxeFWBrowse(): SetLineOk ( < bLineOk> ) -->

Parâmetros


bLineOk Bloco de código Code-Blockexecutado na trocade linha.

X

Observaçõesnull

SetLocateSetLocate

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

SintaxeFWBrowse(): SetLocate ( [ bAction] ) -->

Parâmetros


bAction Bloco de código Code-Blockexecutado paralocalização dasinformações, casonão seja informadoserá utilizado opadrão.

Observaçõesnull

SetNumberLegendSetNumberLegend

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

SintaxeFWBrowse(): SetNumberLegend ( [ lNumber] ) -->

Parâmetros


lNumber Lógico Indica que alegenda serárepresentada pornúmeros.

Observaçõesnull

SetObjMarkSetObjMark

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

SintaxeFWBrowse(): SetObjMark ( < oObjMark> ) -->

Parâmetros


oObjMark Objeto Indica o objetoFWMARKBROWSE

X

Observaçõesnull

SetObligateFilterSetObligateFilter

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

SintaxeFWBrowse(): SetObligateFilter ( [ lObligateFilter], [ lCanCancel] ) -->

Parâmetros


lObligateFilter Lógico Indica que o filtroserá solicitado naentrada do Browse

lCanCancel Lógico Indica que permiteo cancelamento natela de filtros.

Observaçõesnull

SetOwnerSetOwner

Indica o container para criação do Browse.

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

Parâmetros


oOwner Objeto Indica o containerpara criação doBrowse.

Observaçõesnull

SetPreEditCellSetPreEditCell

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

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

Parâmetros


bBlock Bloco de código Code-Block com afuncao devalidação. O blocorecebe comoparametro o objetodo Browse, acoluna ,e o caracterprecionado.

X

Observaçõesnull

SetProfileIDSetProfileID

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

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

Parâmetros


cProfileID Caracter Identificador doBrowse

X

Observações

null

SetQuerySetQuery

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

SintaxeFWBrowse(): SetQuery ( < cQuery> ) -->

Parâmetros


cQuery Caracter Indica a Query paraa criação doBrowse.

X

Observaçõesnull

SetQueryIndexSetQueryIndex

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

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

Parâmetros


aIndex Array of Record Indica os índicesutilizados pelaQuery na criaçãodo Browse.

X

Observaçõesnull

SetSeekSetSeek

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

SintaxeFWBrowse(): SetSeek ( [ bAction], [ aOrder] ) -->

Parâmetros


bAction Bloco de código Code-Blockexecutado para apesquisa deregistros, caso nãoseja informado seráutilizado o padrão.

aOrder Array of Record Array contendo asinformações paracriação dosdetalhes dapesquisa.

Observaçõesnull

SetSeekChangeSetSeekChange

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

Sintaxe

FWBrowse(): SetSeekChange ( [ bSeekChange] ) -->

Parâmetros


bSeekChange Bloco de código Code-Blockexecutado namudança da ordemde pesquisa.

Observaçõesnull

SetShowLimitSetShowLimit

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

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

Parâmetros


lShowLimit Lógico Indica se apresentasomente o limite deinformacoes doBrowse do tipoQuery quando aQuery ultrapassar olimite definido.

Observaçõesnull

SetSuperDelSetSuperDel

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

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

Parâmetros


bSuperDel Bloco de código Code-Blockexecutado noCTRL+Del.

X

Observaçõesnull

SetTypeMoveSetTypeMove

Indica o tipo de navegação do Browse

SintaxeFWBrowse(): SetTypeMove ( < nTypeMove> ) -->

Parâmetros


nTypeMove Numérico Indica o tipo denavegação noBrowse 0=Linha ou1=Coluna

X

Observaçõesnull

SetUseCaseFilterSetUseCaseFilter

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

SintaxeFWBrowse(): SetUseCaseFilter ( [ nAlign] ) -->

Parâmetros


nAlign Numérico Indica oalinhamento dofiltro no Browse.

Observaçõesnull

SetUseFilterSetUseFilter

Habilita a utilização do filtro no Browse.

SintaxeFWBrowse(): SetUseFilter ( [ nAlign], [ bOnStart] ) -->

Parâmetros


nAlign Numérico Indica oalinhamento dofiltro no Browse.

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

SetVldExecFilterSetVldExecFilter

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

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

Parâmetros


bVldExecFilter Bloco de código Code-Block paravalidar se o filtrodeve serexecutado.

X

Observaçõesnull

ShowShow

Permite tornar o Browse visível.

SintaxeFWBrowse(): Show ( ) -->

Observaçõesnull

Observaçõesnull

Exemplos#INCLUDE "FWBROWSE.CH"User FunctionBrwTable()Local oBrowseLocal oColumnLocaloDlg//-------------------------------------------------------------------// 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 FWBROWSE oBrowseDATA 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 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 FWBROWSEoBrowse//-------------------------------------------------------------------// Ativação dojanela//---------------------------------------

----------------------------ACTIVATE MSDIALOGoDlg CENTEREDReturn

AbrangênciaMicrosiga Protheus 11 , Protheus 10

mp-FWBrowse-060513-0946-37861

Documents

Transcript of mp-FWBrowse-060513-0946-37861