Sei sulla pagina 1di 63

FWBrowse Colapse ALL Expand ALL

Classe: FWBrowse

Fornece um objeto do tipo grid que permite a exibio de dados do tipo array, texto, tabela e query. Hierarquia TGrid Construtores New
New
Construtor da classe.

Sintaxe
FWBrowse(): New ( [ oOwner] ) --> oSelf

Parmetros
Nome oOwner Tipo Objeto Descrio Objeto proprietrio Obrigatrio Referncia

Retorno oSelf
() Objeto FWBrowse

Exemplos oBrowse := FWBrowse():New()

Mtodos Activate
Activate
Ativao da classe.

Sintaxe
FWBrowse(): Activate ( [ lFWBrowse] ) -->

Parmetros
Nome lFWBrowse Tipo Lgico Descrio Indica se a chamada foi acionada pela classe FWBROWSE Obrigatrio Referncia

Exemplos oBrowse:Activate() AddBrwRelation


AddBrwRelation
Permite adicionar a informacao de um browse relacionado.

Sintaxe
FWBrowse(): AddBrwRelation ( < oBrwRel> ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

oBrwRel

Objeto

Browse que se deseja informar como relacionado

Observaes
null

AddColumn
AddColumn
Adiciona uma coluna no Browse em tempo de execuo.

Sintaxe
FWBrowse(): AddColumn ( < aColumn> ) -->

Parmetros
Nome aColumn Tipo Array of Record Descrio Indica o array com informaes para criao da coluna. Obrigatrio X Referncia

Observaes
null

AddCustomConfig
AddCustomConfig
Permite adicionar uma configurao customizada na opo de configurao do Browse.

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

Parmetros
Nome cTitle bView Tipo Caracter Bloco de cdigo Descrio Ttulo a ser exibido na configurao. Code-Block de carga da janela de configurao Code-Block de gravao das configuraes efetuadas pelo usurio. Obrigatrio X X Referncia

bSave

Bloco de cdigo

Observaes
null

Exemplos oBrowse:AddCustomConfig("Filial",{|o| MBrFilialCfg(o,Self) }, { || MBrSaveFilCfg(Self) } ) AddFilter


AddFilter
Permite adicionar um filtro na lista de opes de filtros do Browse.

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

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

cFilter cExpAdvPL lNoCheck

Caracter Caracter Lgico

Ttulo que ser exibido no filtro Expresso do filtro em formato AdvPL. Indica que o filtro no poder ser marcado/desmarca do. Indica que o filtro dever ser apresentado como marcado/desmarca do. Indica que o filtro de relacionamento entre as tabelas e a expresso AdvPL deve ser informado obrigatoriamente com expresses SQL. Indica se o filtro pergunta as informaes na execuo. Array contendo informaes parseadas do filtro. Nome do identificador do filtro

X X

lSelected

Lgico

cAlias

Caracter

lFilterAsk

Lgico

aFilParser

Array of Record

cID

Caracter

Observaes
null

Exemplos oBrowse:AddFilter(cTitle,xCondition) AddLine


AddLine

Permite adicionar um linha no Browse.

Sintaxe
FWBrowse(): AddLine ( ) -->

Observaes
null

AddMarkColumns
AddMarkColumns
Permite adicionar uma coluna com a opo de marca e desmarca.

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

Parmetros
Nome bMark Tipo Bloco de cdigo Descrio Code-Block com a regra e dever retornar a imagem referente a marcado/desmarca do. Code-Block com a execuo do duplo clique na coluna. Code-Block com a execuo do clique no header da coluna. Obrigatrio X Referncia

bLDblClick

Bloco de cdigo

bHeaderClick

Bloco de cdigo

Observaes
null

AddStatusColumns

AddStatusColumns
Permite adicionar uma coluna de status.

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

Parmetros
Nome bStatus Tipo Bloco de cdigo Descrio Code-Block com a regra e dever retornar a imagem referente ao status. Code-Block com a execuo do duplo clique na coluna. Obrigatrio X Referncia

bLDblClick

Bloco de cdigo

Observaes
null

Alias
Alias
Retorna o Alias utilizado no Browse.

Sintaxe
FWBrowse(): Alias ( ) --> cAlias

Retorno cAlias
(caracter) Alias utilizado no Browse.

Observaes
null

AllOk
AllOk
Executa o Code-Block definido no mtodo SetAllOK(bAllOK).

Sintaxe
FWBrowse(): AllOk ( ) --> lReturn

Retorno lReturn
(logico) Retorno da execuo do Code-Block.

Observaes
null

At
At
Retorna a posio atual do registro.

Sintaxe
FWBrowse(): At ( ) --> nAt

Retorno nAt
() Posio atual do registro.

Observaes
null

Browse
Browse
Retorna o componente Browse (TGRID).

Sintaxe

FWBrowse(): Browse ( ) --> oBrowse

Retorno oBrowse
() Objeto Browse (TGRID).

Observaes
null

ClassName
ClassName
Retorna o nome da classe (FWBROWSE).

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

Retorno cClassName
(caracter) Nome da classe.

Observaes
null

CleanExFilter
CleanExFilter
Executa a limpeza dos filtros extendidos realizados no Browse.

Sintaxe
FWBrowse(): CleanExFilter ( ) -->

Observaes
null

CleanFilter

CleanFilter
Realizada a limpeza dos filtros utilizados no Browse.

Sintaxe
FWBrowse(): CleanFilter ( ) -->

Observaes
null

CleanProfile
CleanProfile
Elimina as configuraes realizadas no Browse do perfil do usurio.

Sintaxe
FWBrowse(): CleanProfile ( ) -->

Observaes
null

ColPos
ColPos
Retorna a coluna posicionada no Browse

Sintaxe
FWBrowse(): ColPos ( [ lDeleted] ) --> nColPos

Parmetros
Nome lDeleted Tipo Lgico Descrio Indica que deve considerar as colunas deletadas. Obrigatrio Referncia

Retorno nColPos
() Coluna posicionada.

Observaes
null

Data
Data
Retorna o objeto de dados no Browse.

Sintaxe
FWBrowse(): Data ( ) --> oData

Retorno oData
() Retorna o objeto de dados do Browse

Observaes
null

DataArray
DataArray
Retorna se o dados apresentados no Browse de Array.

Sintaxe
FWBrowse(): DataArray ( ) --> lDataArray

Retorno lDataArray
(logico) Indica que o Browse utiliza informaes de um array.

Observaes

null

DataQuery
DataQuery
Retorna se o dados apresentados no Browse de Query.

Sintaxe
FWBrowse(): DataQuery ( ) --> lDataQuery

Retorno lDataQuery
(logico) Indica que o Browse utiliza informaes de uma Query.

Observaes
null

DataTable
DataTable
Retorna se o dados apresentados no Browse de Tabela.

Sintaxe
FWBrowse(): DataTable ( ) --> lDataTable

Retorno lDataTable
(logico) Indica que o Browse utiliza informaes de uma Tabela.

Observaes
null

DataText
DataText
Retorna se o dados apresentados no Browse de Texto.

Sintaxe
FWBrowse(): DataText ( ) --> lDataText

Retorno lDataText
(logico) Indica que o Browse utiliza informaes de um arquivo Texto.

Observaes
null

DBFFilter
DBFFilter
Indica se utiliza filtro para tabelas CODEBASE.

Sintaxe
FWBrowse(): DBFFilter ( ) --> lDBFFilter

Retorno lDBFFilter
(logico) Indica se utiliza filtro para tabelas CODEBASE.

Observaes
null

DeActivate
DeActivate
Mtodo de destruio da classe.

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

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

lFreeChildren

Lgico

Indica se necessrio limpar a classe proprietria. (oOwner)

Observaes
null

Default
Default
Compatibilizao com a MBrowse antiga.

Sintaxe
FWBrowse(): Default ( ) -->

Observaes
null

DelColumn
DelColumn
Indica que uma determinada coluna est deletada.

Sintaxe
FWBrowse(): DelColumn ( < nColumn> ) -->

Parmetros
Nome nColumn Tipo Numrico Descrio Indica a coluna que ser marcada como deletada. Obrigatrio X Referncia

Observaes
null

DeleteFilter
DeleteFilter
Permite realizar a excluso de filtros.

Sintaxe
FWBrowse(): DeleteFilter ( [ cID] ) -->

Parmetros
Nome cID Tipo Caracter Descrio Identificador do Filtro Obrigatrio Referncia

Observaes
null

DelLine
DelLine
Executa o Code-Block, definido no mtodo SetDelete(lDelete,bDelete), para deleo de uma linha no Browse.

Sintaxe
FWBrowse(): DelLine ( ) -->

Observaes
null

DelOk
DelOk

Executa o Code-Block, definido no mtodo SetDelOk(bDelOK), para validar a deleo de uma linha no Browse.

Sintaxe
FWBrowse(): DelOk ( ) --> lReturn

Retorno lReturn
()

Observaes
null

Disable
Disable
Desabilita a utilizao do Browse.

Sintaxe
FWBrowse(): Disable ( ) -->

Observaes
null

DisableConfig
DisableConfig
Desabilita a utilizao das configuraes do Browse.

Sintaxe
FWBrowse(): DisableConfig ( ) -->

Observaes
null

DisableFilter
DisableFilter

Desabilita a utilizao do filtro no Browse.

Sintaxe
FWBrowse(): DisableFilter ( ) -->

Observaes
null

DisableLocate
DisableLocate
Desabilita a utilizao do localizador de registro no Browse.

Sintaxe
FWBrowse(): DisableLocate ( ) -->

DisableReport
DisableReport
Desabilita a impresso das informaes disponveis no Browse.

Sintaxe
FWBrowse(): DisableReport ( ) -->

Observaes
null

DisableSaveConfig
DisableSaveConfig
Desabilita a gravao das configuraes realizadas no Browse.

Sintaxe
FWBrowse(): DisableSaveConfig ( ) -->

Observaes

null

DisableSeek
DisableSeek
Desabilita a utilizao da pesquisa no Browse.

Sintaxe
FWBrowse(): DisableSeek ( ) -->

Observaes
null

Enable
Enable
Habilita a utilizao do Browse.

Sintaxe
FWBrowse(): Enable ( ) -->

Observaes
null

ExecuteFilter
ExecuteFilter
Aplica os filtros realizados no Browse.

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

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

lBrwUpdate

Lgico

Atualiza o Browse e posiciona no primeiro registro.

Observaes
null

Filtrate
Filtrate
Indica se o Browse est filtrado.

Sintaxe
FWBrowse(): Filtrate ( ) --> lFiltrate

Retorno lFiltrate
(logico) Indica se o Browse est filtrado.

Observaes
null

FWFilter
FWFilter
Retorna o objeto FWFilter.

Sintaxe
FWBrowse(): FWFilter ( ) --> oFWFilter

Retorno oFWFilter
() Retorna o objeto FWFilter.

Observaes

null

GetBackColor
GetBackColor
Retorna a cor de fundo do Browse.

Sintaxe
FWBrowse(): GetBackColor ( ) --> nBackColor

Retorno nBackColor
() Retorna a cor de fundo do Browse

Observaes
null

GetClrAlterRow
GetClrAlterRow
Retorna a cor alternada do Browse.

Sintaxe
FWBrowse(): GetClrAlterRow ( ) --> nClrAlterRow

Retorno nClrAlterRow
() Retorna a cor alternada do Browse

Observaes
null

GetColumn
GetColumn
Retorno um objeto tipo FWBrwColumn da coluna passada.

Sintaxe
FWBrowse(): GetColumn ( ) --> nCol

Retorno nCol
() Retorna a coluna posicionada.

Observaes
null

GetDescription
GetDescription
Retorna a descrio do Browse.

Sintaxe
FWBrowse(): GetDescription ( ) --> cDescription

Retorno cDescription
(caracter) Retorna a descrio do Browse

GetFilterDefault
GetFilterDefault
Retorna o filtro padro do Browse

Sintaxe
FWBrowse(): GetFilterDefault ( ) --> cFilterDefault

Retorno cFilterDefault
(caracter) Retorna o filtro padro do Browse.

Observaes
null

GetForeColor
GetForeColor
Retorna a cor da fonte do Browse.

Sintaxe
FWBrowse(): GetForeColor ( ) --> cForeColor

Retorno cForeColor
(caracter) Retorna a cor da fonte do Browse.

Observaes
null

GetObjMark
GetObjMark
Retorna o objeto FWMARKBROWSE utilizado na passagem de parmetros na execuo das rotinas na FWFORMBROWSE;

Sintaxe
FWBrowse(): GetObjMark ( ) --> oObjMark

Retorno oObjMark
() Indica o objeto FWMARKBROWSE

Observaes
null

GetProfileID
GetProfileID
Retorna o identificador do Browse utiliza na gravao das configuraes no profile do usurio. Deve ser utilizado quando existir mais de um Browse na rotina.

Sintaxe
FWBrowse(): GetProfileID ( ) --> cProfileID

Retorno cProfileID
(caracter) Identificador do Browse

Observaes
null

GetQuery
GetQuery
Retorna a Query que esta sendo utilizada no Browse.

Sintaxe
FWBrowse(): GetQuery ( ) --> cQuery

Retorno cQuery
(caracter) Indica a Query para a criao do Browse.

Observaes
null

GoBottom
GoBottom
Posiciona no ltimo registro do Browse.

Sintaxe
FWBrowse(): GoBottom ( [ lCallRefresh] ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

lCallRefresh

Lgico

Indica que foi chamado atravs do mtodo Refresh().

Observaes
null

GoColumn
GoColumn
Posiciona na coluna desejada.

Sintaxe
FWBrowse(): GoColumn ( [ nColumn] ) -->

Parmetros
Nome nColumn Tipo Numrico Descrio Indica a coluna que deseja posicionar. Obrigatrio Referncia

Observaes
null

GoDown
GoDown
Salta uma ou mais linhas para baixo do item posicionado.

Sintaxe
FWBrowse(): GoDown ( [ nOffSet], [ lReport] ) -->

Parmetros
Nome nOffSet Tipo Numrico Descrio Indica a quantidade de linhas a serem saltadas. Indica se impresso dos itens do Browse. Obrigatrio Referncia

lReport

Lgico

Observaes
null

GoPgDown
GoPgDown
Salta uma pgina para baixo do item posicionado.

Sintaxe
FWBrowse(): GoPgDown ( ) -->

GoPgUp
GoPgUp
Salta uma pgina para cima do item posicionado.

Sintaxe
FWBrowse(): GoPgUp ( ) -->

Observaes
null

GoTo
GoTo
Posiciona em um determinado registro do Browse.

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

Parmetros
Nome nGoto Tipo Numrico Descrio Indica o item que dever ser posicionado. Indica se dever forar a atualizao do Browse. Obrigatrio X Referncia

lRefresh

Lgico

Observaes
null

GoTop
GoTop
Posiciona no primeiro registro do Browse.

Sintaxe
FWBrowse(): GoTop ( [ lForce] ) -->

Parmetros
Nome lForce Tipo Lgico Descrio Indica que dever forar o posicionamento. Obrigatrio Referncia

Observaes

null

GoUp
GoUp
Salta uma ou mais linhas para cima do item posicionado.

Sintaxe
FWBrowse(): GoUp ( [ nOffSet] ) -->

Parmetros
Nome nOffSet Tipo Numrico Descrio Indica a quantidade de linhas a serem saltadas. Obrigatrio Referncia

Observaes
null

Hide
Hide
Permite tornar o Browse invisvel

Sintaxe
FWBrowse(): Hide ( ) -->

Observaes
null

LineOk
LineOk
Executa o Code-Block, definido no mtodo SetLineOk(bLineOk), para validao da linha posicionada.

Sintaxe
FWBrowse(): LineOk ( ) --> lRet

Retorno lRet
(logico) Indica se a linha vlida.

LineRefresh
LineRefresh
Executa a atualizao das informaes de uma determinada linha do Browse.

Sintaxe
FWBrowse(): LineRefresh ( [ nAt] ) -->

Parmetros
Nome nAt Tipo Numrico Descrio Indica a linha que ser atualizada. Obrigatrio Referncia

Observaes
null

LogicLen
LogicLen
Retorna a quantidade de registros disponveis para o browse.

Sintaxe
FWBrowse(): LogicLen ( ) --> nLogicLen

Retorno nLogicLen

() Indica a quantidade de registros disponveis.Quando o Browse for de tabela ou Query ser retornado o ltimo registro para a orderm selecionada.

Observaes
null

ObligateFilter
ObligateFilter
Retorna se a seleco de um filtro obrigatrio para a apresentao do browse.

Sintaxe
FWBrowse(): ObligateFilter ( ) --> lObligateFilter

Retorno lObligateFilter
(logico) Indica se a seleco de um filtro obrigatrio para a apresentao do browse

Observaes
null

OptionConfig
OptionConfig
Indica se a opo de configurao do Browse est habilitada.

Sintaxe
FWBrowse(): OptionConfig ( ) --> lOptionConfig

Retorno lOptionConfig
(logico) Indica se a opo de configurao est habilitada.

Observaes
null

OptionReport
OptionReport
Indica se a opo de impresso das informaes do Browse est habilitada.

Sintaxe
FWBrowse(): OptionReport ( ) --> lOptionReport

Retorno lOptionReport
(logico) Indica se a opo de impresso est habilitada.

Observaes
null

Refresh
Refresh
Executa a atualizao das informaes no Browse.

Sintaxe
FWBrowse(): Refresh ( [ lGoTop] ) -->

Parmetros
Nome lGoTop Tipo Lgico Descrio Indica que dever ser posicionado no primeiro registro do Browse. Obrigatrio Referncia

Observaes
null

Report

Report
Executa a impresso das informaes do Browse.

Sintaxe
FWBrowse(): Report ( ) -->

Reset
Reset
Compatibilidade com o Browse antigo.

Sintaxe
FWBrowse(): Reset ( ) -->

Observaes
null

ResetLen
ResetLen
Compatibilidade com o Browse antigo.

Sintaxe
FWBrowse(): ResetLen ( ) -->

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

Sintaxe
FWBrowse(): SetAddLine ( < bAdd> ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

bAdd

Bloco de cdigo

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

Observaes
null

SetAfterAddLine
SetAfterAddLine
Indica o Code-Block que ser executado aps a incluso de uma linha.

Sintaxe
FWBrowse(): SetAfterAddLine ( < bAfterAddLine> ) -->

Parmetros
Nome bAfterAddLine Tipo Bloco de cdigo Descrio Code-Block a ser executado aps a incluso de uma linha. Obrigatrio X Referncia

Observaes
null

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

Sintaxe
FWBrowse(): SetAlias ( < cAlias> ) -->

Parmetros
Nome cAlias Tipo Caracter Descrio Indica o alias da tabela Obrigatrio X Referncia

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

Sintaxe
FWBrowse(): SetAllOk ( < bAllOk> ) -->

Parmetros
Nome bAllOk Tipo Bloco de cdigo Descrio Code-Block para validar todos itens do Browse. Obrigatrio X Referncia

Observaes
null

SetArray
SetArray
Indica o array utilizado para apresentao dos dados no Browse.

Sintaxe
FWBrowse(): SetArray ( < aArray> ) -->

Parmetros
Nome aArray Tipo Array of Record Descrio Array utilizado para apresentao dos dados no Browse. Obrigatrio X Referncia

Observaes
null

SetBackColor
SetBackColor
Indica a cor de fundo do Browse.

Sintaxe
FWBrowse(): SetBackColor ( < nBackColor> ) -->

Parmetros
Nome nBackColor Tipo Numrico Descrio Cor de fundo do Browse. Obrigatrio X Referncia

Observaes
null

SetBlkBackColor
SetBlkBackColor
Indica a cor de fundo para a linha atual.

Sintaxe

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

Parmetros
Nome bBackColor Tipo Bloco de cdigo Descrio Codigo de bloco que retorna a cor de fonte para a linha atual. Obrigatrio X Referncia

SetBlkColor
SetBlkColor
Indica a cor de fonte para a linha atual.

Sintaxe
FWBrowse(): SetBlkColor ( < bBlkColor> ) -->

Parmetros
Nome bBlkColor Tipo Bloco de cdigo Descrio Codigo de bloco que retorna a cor de fonte para a linha atual. Obrigatrio X Referncia

Observaes
null

SetChange
SetChange
Indica a Code-Block executado aps a mudana de uma linha.

Sintaxe
FWBrowse(): SetChange ( < bChange> ) -->

Parmetros
Nome bChange Tipo Bloco de cdigo Descrio Code-Block executado aps a mudana de uma linha. Obrigatrio X Referncia

Observaes
null

SetClrAlterRow
SetClrAlterRow
Indica a cor alternada do Browse.

Sintaxe
FWBrowse(): SetClrAlterRow ( < nClrAlterRow> ) -->

Parmetros
Nome nClrAlterRow Tipo Numrico Descrio Indica a cor de alternada do Browse. Obrigatrio X Referncia

Observaes
null

SetColumns

SetColumns
Adiciona uma coluna no Browse em tempo de execuo.

Sintaxe
FWBrowse(): SetColumns ( < aColumns> ) -->

Parmetros
Nome aColumns Tipo Array of Record Descrio Array contendo as informaes da coluna. Obrigatrio X Referncia

SetDataArray
SetDataArray
Indica que o Browse exibe dados atravs de um array.

Sintaxe
FWBrowse(): SetDataArray ( ) -->

Observaes
null

SetDataQuery
SetDataQuery
Indica que o Browse exibe dados atravs de uma Query, porm, a Query cria um arquivo temporrio atualizando de acordo com a demanda.

Sintaxe
FWBrowse(): SetDataQuery ( ) -->

Observaes

null

SetDataTable
SetDataTable
Indica que o Browse exibe dados atravs de uma tabela.

Sintaxe
FWBrowse(): SetDataTable ( ) -->

Observaes
null

SetDataText
SetDataText
Indica que o Browse exibe dados atravs de um arquivo texto.

Sintaxe
FWBrowse(): SetDataText ( ) -->

Observaes
null

SetDelete
SetDelete
Indica que o usurio pode excluir linhas no Browse.

Sintaxe
FWBrowse(): SetDelete ( [ lDelete], [ bDelete] ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

lDelete

Lgico

Indica se o usurio pode excluir linhas no Browse. Code-Block executado na excluso da linha.

bDelete

Bloco de cdigo

Observaes
null

SetDelOk
SetDelOk
Indica o Code-Block executado para validar a excluso da linha.

Sintaxe
FWBrowse(): SetDelOk ( < bDelOK> ) -->

Parmetros
Nome bDelOK Tipo Bloco de cdigo Descrio Code-Block executado para validar a excluso da linha. Obrigatrio X Referncia

Observaes
null

SetDescription
SetDescription
Indica a descrio do Browse.

Sintaxe
FWBrowse(): SetDescription ( < cDescription> ) -->

Parmetros
Nome cDescription Tipo Caracter Descrio Indica a descrio do Browse Obrigatrio X Referncia

Observaes
null

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

Sintaxe
FWBrowse(): SetDoubleClick ( < bLDblClick> ) -->

Parmetros
Nome bLDblClick Tipo Bloco de cdigo Descrio Code-Block executado no duplo clique do item no Browse. Obrigatrio X Referncia

Observaes
null

SetEditCell
SetEditCell

Indica que ser permitido a edio da clula no Browse.

Sintaxe
FWBrowse(): SetEditCell ( [ lEditCell], [ bValidEdit] ) -->

Parmetros
Nome lEditCell bValidEdit Tipo Lgico Bloco de cdigo Descrio Indica se permite a edio de clulas. Code-Block executado para validar a edio da clula. Obrigatrio Referncia

Observaes
null

SetFieldFilter
SetFieldFilter
Indica os campos que sero apresentados na edio de filtros.

Sintaxe
FWBrowse(): SetFieldFilter ( < aFields> ) -->

Parmetros
Nome aFields Tipo Array of Record Descrio Array contendo os campos apresentados na edio de filtros. Obrigatrio X Referncia

Observaes
null

SetFile
SetFile
Indica o arquivo texto que ser utilizado no Browse.

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

Parmetros
Nome cFile cCharSeparator Tipo Caracter Caracter Descrio Arquivo texto. Ex.: "\Browse\Teste.txt" Indica o caracter separador dos dados. Ex.: ";" para "dados1;dados2;da dos3" Obrigatrio X Referncia

SetFilter
SetFilter
Indica o limite superior e inferior de um campo respeitando a classificao das informaes atual.

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

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

cCpoFil

Caracter

Indica o campo a ser considerado o limite superior e inferior. Indica o limite superior. Indica o limite inferior.

cTopFun cBotFun

Caracter Array of Record

Observaes
null

SetFilterDefault
SetFilterDefault
Indica o filtro padro do Browse.

Sintaxe
FWBrowse(): SetFilterDefault ( < cFilterDefault> ) -->

Parmetros
Nome cFilterDefault Tipo Caracter Descrio Indica o filtro AdvPL para o Browse. Obrigatrio X Referncia

Observaes
null

SetFilterRelation
SetFilterRelation
Indica o relacionamento de filtros para o Browse.

Sintaxe
FWBrowse(): SetFilterRelation ( < aFilterRelation>, < bChgFields> ) -->

Parmetros
Nome aFilterRelation Tipo Array of Record Descrio Array contendo os itens do relacionamento. Indica o Code-Block executado para trocar os campos para o filtro. Obrigatrio X Referncia

bChgFields

Bloco de cdigo

Observaes
null

SetFocus
SetFocus
Fora o foco no objeto Browse.

Sintaxe
FWBrowse(): SetFocus ( ) -->

SetFontBrowse
SetFontBrowse
Indica a fonte do Browse.

Sintaxe
FWBrowse(): SetFontBrowse ( [ oFont] ) -->

Parmetros

Nome oFont

Tipo Objeto

Descrio Indica o objeto TFont utilizado no Browse.

Obrigatrio

Referncia

Observaes
null

SetForeColor
SetForeColor
Indica a cor da fonte no Browse.

Sintaxe
FWBrowse(): SetForeColor ( < nForeColor> ) -->

Parmetros
Nome nForeColor Tipo Numrico Descrio Cor da fonte no Browse. Obrigatrio X Referncia

Observaes
null

SetGroup
SetGroup
Indica que o Browse utiliza agrupamento de informaes.

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

Parmetros
Nome bGroup Tipo Bloco de cdigo Descrio Code-Block com a regra do agrupamento retornando um valor lgico (.T. = Quebra, .F. = Filho ). Indica que o agrupamento ser apresentado com os sub-itens visveis na abertura do Browse. Obrigatrio X Referncia

lOpen

Lgico

Observaes
null

SetHeaderImage
SetHeaderImage
Indica a imagem que ser apresentada ao lado do ttulo da coluna.

Sintaxe
FWBrowse(): SetHeaderImage ( < nColumn>, < cResource> ) -->

Parmetros
Nome nColumn Tipo Numrico Descrio Indica coluna que ser apresentada a imagem. Indica a imagem que ser apresentada ao lado da coluna. Obrigatrio X Referncia

cResource

Caracter

Observaes
null

SetIdAlias
SetIdAlias
Indica o ID para Browses que trabalham com Left Join.

Sintaxe
FWBrowse(): SetIdAlias ( < cIdAlias> ) -->

Parmetros
Nome cIdAlias Tipo Caracter Descrio Indica o ID para Browses que trabalham com Left Join. Obrigatrio X Referncia

Observaes
null

SetInsert
SetInsert
Indica que o usurio poder inserir novas linhas no Browse.

Sintaxe
FWBrowse(): SetInsert ( [ lInsert] ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

lInsert

Lgico

Indica que poder inserir novas linhas.

Observaes
null

SetItemDoubleClick
SetItemDoubleClick
Indica os itens que sero disponibilizados para a configurao do duplo clique pelo usurio.

Sintaxe
FWBrowse(): SetItemDoubleClick ( < aItemDoubleClick> ) -->

Parmetros
Nome aItemDoubleClick Tipo Array of Record Descrio Array contendo as informaes que sero apresentadas para configurao do duplo clique. Obrigatrio X Referncia

SetItemHeaderClick
SetItemHeaderClick
Indica os itens que sero disponibilizados para a configurao do clique no header pelo usurio.

Sintaxe
FWBrowse(): SetItemHeaderClick ( < aItemHeaderClick> ) -->

Parmetros

Nome aItemHeaderClick

Tipo Array of Record

Descrio Indica os itens que sero disponibilizados para a configurao do clique no header pelo usurio.

Obrigatrio X

Referncia

Observaes
null

SetLineBegin
SetLineBegin
Indica a linha do arquivo texto que dever ser considerado para nicio da leitura no Browse.

Sintaxe
FWBrowse(): SetLineBegin ( < nLineBegin> ) -->

Parmetros
Nome nLineBegin Tipo Numrico Descrio Indica a linha inicial do arquivo texto. Obrigatrio X Referncia

Observaes
null

SetLineHeight
SetLineHeight
Indica a altura da linha no Browse.

Sintaxe
FWBrowse(): SetLineHeight ( [ nHeight] ) -->

Parmetros
Nome nHeight Tipo Numrico Descrio Indica a altura da linha Obrigatrio Referncia

Observaes
null

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

Sintaxe
FWBrowse(): SetLineOk ( < bLineOk> ) -->

Parmetros
Nome bLineOk Tipo Bloco de cdigo Descrio Code-Block executado na troca de linha. Obrigatrio X Referncia

Observaes
null

SetLocate
SetLocate

Habilita a utilizao do localizador de registros no Browse.

Sintaxe
FWBrowse(): SetLocate ( [ bAction] ) -->

Parmetros
Nome bAction Tipo Bloco de cdigo Descrio Code-Block executado para localizao das informaes, caso no seja informado ser utilizado o padro. Obrigatrio Referncia

Observaes
null

SetNumberLegend
SetNumberLegend
Indica que a legenda ser representada por nmeros.

Sintaxe
FWBrowse(): SetNumberLegend ( [ lNumber] ) -->

Parmetros
Nome lNumber Tipo Lgico Descrio Indica que a legenda ser representada por nmeros. Obrigatrio Referncia

Observaes
null

SetObjMark
SetObjMark
Indica o objeto FWMARKBROWSE utilizado na passagem de parmetros na execuo das rotinas na FWFORMBROWSE.

Sintaxe
FWBrowse(): SetObjMark ( < oObjMark> ) -->

Parmetros
Nome oObjMark Tipo Objeto Descrio Indica o objeto FWMARKBROWSE Obrigatrio X Referncia

Observaes
null

SetObligateFilter
SetObligateFilter
Indica se a seleco de um filtro obrigatrio para a apresentao do browse.

Sintaxe
FWBrowse(): SetObligateFilter ( [ lObligateFilter], [ lCanCancel] ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

lObligateFilter

Lgico

Indica que o filtro ser solicitado na entrada do Browse Indica que permite o cancelamento na tela de filtros.

lCanCancel

Lgico

Observaes
null

SetOwner
SetOwner
Indica o container para criao do Browse.

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

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

Observaes
null

SetPreEditCell
SetPreEditCell
Indica o bloco de pr-validao para a edio de celula, o bloco devera retorna .T. para abrir a edio e .F. para nao abrir.

Sintaxe
FWBrowse(): SetPreEditCell ( < bBlock> ) -->

Parmetros
Nome bBlock Tipo Bloco de cdigo Descrio Code-Block com a funcao de validao. O bloco recebe como parametro o objeto do Browse, a coluna ,e o caracter precionado. Obrigatrio X Referncia

Observaes
null

SetProfileID
SetProfileID
Define o identificador do Browse utiliza na gravao das configuraes no profile do usurio. Deve ser utilizado quando existir mais de um Browse na rotina.

Sintaxe
FWBrowse(): SetProfileID ( < cProfileID> ) -->

Parmetros
Nome cProfileID Tipo Caracter Descrio Identificador do Browse Obrigatrio X Referncia

Observaes

null

SetQuery
SetQuery
Indica a Query que ser utilizada para criao do Browse.

Sintaxe
FWBrowse(): SetQuery ( < cQuery> ) -->

Parmetros
Nome cQuery Tipo Caracter Descrio Indica a Query para a criao do Browse. Obrigatrio X Referncia

Observaes
null

SetQueryIndex
SetQueryIndex
Indica os ndices utilizados pela Query na criao do Browse.

Sintaxe
FWBrowse(): SetQueryIndex ( < aIndex> ) -->

Parmetros
Nome aIndex Tipo Array of Record Descrio Indica os ndices utilizados pela Query na criao do Browse. Obrigatrio X Referncia

Observaes
null

SetSeek
SetSeek
Habilita a utilizao da pesquisa de registros no Browse.

Sintaxe
FWBrowse(): SetSeek ( [ bAction], [ aOrder] ) -->

Parmetros
Nome bAction Tipo Bloco de cdigo Descrio Code-Block executado para a pesquisa de registros, caso no seja informado ser utilizado o padro. Array contendo as informaes para criao dos detalhes da pesquisa. Obrigatrio Referncia

aOrder

Array of Record

Observaes
null

SetSeekChange
SetSeekChange
Indica o Code-Block executado na mudana da ordem de pesquisa.

Sintaxe

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

Parmetros
Nome bSeekChange Tipo Bloco de cdigo Descrio Code-Block executado na mudana da ordem de pesquisa. Obrigatrio Referncia

Observaes
null

SetShowLimit
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] ) -->

Parmetros
Nome lShowLimit Tipo Lgico Descrio Indica se apresenta somente o limite de informacoes do Browse do tipo Query quando a Query ultrapassar o limite definido. Obrigatrio Referncia

Observaes
null

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

Sintaxe
FWBrowse(): SetSuperDel ( < bSuperDel> ) -->

Parmetros
Nome bSuperDel Tipo Bloco de cdigo Descrio Code-Block executado no CTRL+Del. Obrigatrio X Referncia

Observaes
null

SetTypeMove
SetTypeMove
Indica o tipo de navegao do Browse

Sintaxe
FWBrowse(): SetTypeMove ( < nTypeMove> ) -->

Parmetros
Nome nTypeMove Tipo Numrico Descrio Indica o tipo de navegao no Browse 0=Linha ou 1=Coluna Obrigatrio X Referncia

Observaes
null

SetUseCaseFilter
SetUseCaseFilter
Habilita a utilizao do filtro case no Browse.

Sintaxe
FWBrowse(): SetUseCaseFilter ( [ nAlign] ) -->

Parmetros
Nome nAlign Tipo Numrico Descrio Indica o alinhamento do filtro no Browse. Obrigatrio Referncia

Observaes
null

SetUseFilter
SetUseFilter
Habilita a utilizao do filtro no Browse.

Sintaxe
FWBrowse(): SetUseFilter ( [ nAlign], [ bOnStart] ) -->

Parmetros
Nome Tipo Descrio Obrigatrio Referncia

nAlign

Numrico

Indica o alinhamento do filtro no Browse. Code-Block executado na criao do componente de filtro.

bOnStart

Bloco de cdigo

SetVldExecFilter
SetVldExecFilter
Define um bloco de cdigos para validar se o filtro deve ser executado.

Sintaxe
FWBrowse(): SetVldExecFilter ( < bVldExecFilter> ) -->

Parmetros
Nome bVldExecFilter Tipo Bloco de cdigo Descrio Code-Block para validar se o filtro deve ser executado. Obrigatrio X Referncia

Observaes
null

Show
Show
Permite tornar o Browse visvel.

Sintaxe
FWBrowse(): Show ( ) -->

Observaes
null

Observaes
null

Exemplos #INCLUDE "FWBROWSE.CH"User Function BrwTable()Local oBrowseLocal 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 FWBROWSE 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 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 FWBROWSE oBrowse//------------------------------------------------------------------// Ativao do janela//---------------------------------------

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

Potrebbero piacerti anche