TOTVSTEC

Árvore de páginas

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 7 Atual »

Classe: TListBox

Cria um objeto do tipo lista de itens com barra de rolagem.

Hierarquia

TSrvObject -> TControl -> TListBox


Construtores
Create

Create

Método construtor da classe.


Sintaxe

TListBox(): Create ( [ oWnd], [ nRow], [ nCol], [ bSetGet], [ aItems], [ nWidth], [ nHeight], [ bChange], [ bValid], [ uParam10], [ uParam11], [ lPixel], [ uParam13], [ bLDBLClick], [ oFont], [ uParam16], [ uParam17], [ bWhen], [ uParam19], [ uParam20], [ uParam21], [ uParam22], [ bRClicked] ) --> oObjeto


Parâmetros

 

NomeTipoDescriçãoObrigatórioReferência
oWndObjetoIndica a janela ou controle visual onde o objeto será criado.  
nRowNuméricoIndica a coordenada vertical em pixels ou caracteres.  
nColNuméricoIndica a coordenada horizontal em pixels ou caracteres.  
bSetGetBloco de códigoIndica o bloco de código, no formato {|u| if( Pcount( )>0, := u, ) }, que será executado para atualizar a variável (essa variável deve ser do tipo caracter). Desta forma, se a lista for seqüencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado.  
aItemsVetorIndica uma lista de itens e caracteres que serão apresentados. Essa lista pode ter os seguintes formatos: Seqüencial (Exemplo: {"item1","item2",...,"itemN"}) ou Indexada (Exemplo: {"a=item1","b=item2",...,"n=itemN"}).  
nWidthNuméricoIndica a largura em pixels do objeto.  
nHeightNuméricoIndica a altura em pixels do objeto.  
bChangeBloco de códigoIndica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual.  
bValidObjetoIndica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro (.T.), se o conteúdo é válido; caso contrário, falso (.F.).  
uParam10NuméricoCompatibilidade.  
uParam11NuméricoCompatibilidade.  
lPixelLógicoIndica se considera as coordenadas passadas em pixels (.T.) ou caracteres (.F.).  
uParam13LógicoCompatibilidade.  
bLDBLClickBloco de códigoIndica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto.  
oFontObjetoIndica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual.  
uParam16CaracterCompatibilidade.  
uParam17LógicoCompatibilidade.  
bWhenBloco de códigoIndica o bloco de código que será executado quando a mudança de foco da entrada de dados, na janela em que o controle foi criado, estiver sendo efetuada. Observação: O bloco de código retornará verdadeiro (.T.) se o controle permanecer habilitado; caso contrário, retornará falso (.F.).  
uParam19LógicoCompatibilidade.  
uParam20Bloco de códigoCompatibilidade.  
uParam21LógicoCompatibilidade.  
uParam22LógicoCompatibilidade.  
bRClickedBloco de códigoIndica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto.  

 

Retorno
oObjeto
    (objeto)
  • Retorna o objeto criado.

Exemplos
oList := TListBox():Create(oDlg,001,110,{|u|if(Pcount()>0,nList:=u,nList)},;                           aItems,100,100,,,,,.T.)
New

New

Método construtor da classe.


Sintaxe

TListBox(): New ( [ nRow], [ nCol], [ bSetGet], [ aItems], [ nWidth], [ nHeight], [ bChange], [ oWnd], [ bValid], [ uParam10], [ uParam11], [ lPixel], [ uParam13], [ bLDBLClick], [ oFont], [ uParam16], [ uParam17], [ bWhen], [ uParam19], [ uParam20], [ uParam21], [ uParam22], [ bRClicked] ) --> oObjeto


Parâmetros

 

NomeTipoDescriçãoObrigatórioReferência
nRowNuméricoIndica a coordenada vertical em pixels ou caracteres.  
nColNuméricoIndica a coordenada horizontal em pixels ou caracteres.  
bSetGetBloco de códigoIndica o bloco de código, no formato {|u| if( Pcount( )>0, := u, ) }, que será executado para atualizar a variável (essa variável deve ser do tipo caracter). Desta forma, se a lista for seqüencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado.  
aItemsVetorIndica uma lista de itens e caracteres que serão apresentados. Essa lista pode ter os seguintes formatos: Seqüencial (Exemplo: {"item1","item2",...,"itemN"}) ou Indexada (Exemplo: {"a=item1","b=item2",...,"n=itemN"}).  
nWidthNuméricoIndica a largura em pixels do objeto.  
nHeightNuméricoIndica a altura em pixels do objeto.  
bChangeBloco de códigoIndica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual.  
oWndObjetoIndica a janela ou controle visual onde o objeto será criado.  
bValidBloco de códigoIndica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro (.T.), se o conteúdo é válido; caso contrário, falso (.F.).  
uParam10NuméricoCompatibilidade.  
uParam11NuméricoCompatibilidade.  
lPixelLógicoIndica se considera as coordenadas passadas em pixels (.T.) ou caracteres (.F.).  
uParam13LógicoCompatibilidade.  
bLDBLClickBloco de códigoIndica o bloco de código que será executado quando clicar duas vezes, com o botão esquerdo do mouse, sobre o objeto.  
oFontObjetoIndica o objeto do tipo TFont utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual.  
uParam16CaracterCompatibilidade.  
uParam17LógicoCompatibilidade.  
bWhenBloco de códigoIndica o bloco de código que será executado quando a mudança de foco da entrada de dados, no objeto criado, estiver sendo realizada. Se o retorno for verdadeiro (.T.), o objeto continua habilitado; caso contrário, falso (.F.).  
uParam19Array of RecordCompatibilidade.  
uParam20Bloco de códigoCompatibilidade.  
uParam21LógicoCompatibilidade.  
uParam22LógicoCompatibilidade.  
bRClickedBloco de códigoIndica o bloco de código que será executado quando clicar, com o botão direito do mouse, sobre o objeto.  

 

Retorno
oObjeto
    ()
  • Retorna o objeto criado.

Exemplos
oList := TListBox():New(001,001,{|u|if(Pcount()>0,nList:=u,nList)},;                        aItems,100,100,,oDlg,,,,.T.)

Métodos
Change

Change

Executa o bloco de código, configurado no parâmetro <bChange>, ao mudar de linha.


Sintaxe

TListBox(): Change ( ) -->


Exemplos
oList:Change()
Del

Del

Exclui um item.


Sintaxe

TListBox(): Del ( < nPos> ) -->


Parâmetros

 

NomeTipoDescriçãoObrigatórioReferência
nPosNuméricoIndica a posição do item que será excluído. Observação: Essa posição deve ser maior que 0 e menor ou igual que o número de itens.X 

 


Exemplos
oList:Del(2)
GetPos

GetPos

Retorna a posição do item selecionado na lista.


Sintaxe

TListBox(): GetPos ( ) --> nRet

Retorno
nRet
    (numerico)
  • Retorna a posição do item selecionado.

Exemplos
oList:GetPos()   // Result: 1
GetSelText

GetSelText

Retorna o texto do item selecionado na lista.


Sintaxe

TListBox(): GetSelText ( ) --> cRetTexto

Retorno
cRetTexto
    (caracter)
  • Retorna o texto do item selecionado na lista.

Exemplos
oList:GetSelText()   // Result: "Item 1"
GoBottom

GoBottom

Posiciona no último item da lista.


Sintaxe

TListBox(): GoBottom ( ) -->


Exemplos
oList:GoBottom()
GoTop

GoTop

Posiciona no primeiro item da lista.


Sintaxe

TListBox(): GoTop ( ) -->


Exemplos
oList:GoTop()
Insert

Insert

Insere um novo item.


Sintaxe

TListBox(): Insert ( < cText>, < nPos> ) -->


Parâmetros

 

NomeTipoDescriçãoObrigatórioReferência
cTextCaracterIndica o texto do item que será inserido.X 
nPosNuméricoIndica a posição do novo item, deslocando o item (anterior) daquela posição para baixo. Obs.: É necessário que exista um item naquela posição para inserir outro em seu lugar.X 

 


Exemplos
oList:Insert("Novo item", 2)

Preview
Exemplo do método Insert
Len

Len

Retorna o número de itens.


Sintaxe

TListBox(): Len ( ) --> nRet

Retorno
nRet
    (numerico)
  • Retorna o número de itens.

Exemplos
oList:Len()   // Result: 4
Modify

Modify

Altera o texto do item.


Sintaxe

TListBox(): Modify ( < cText>, < nPos> ) -->


Parâmetros

 

NomeTipoDescriçãoObrigatórioReferência
cTextCaracterIndica o novo texto do item.X 
nPosNuméricoIndica a posição do item que terá seu texto alterado. Observação: A posição deve ser maior que 0 e menor ou igual que o número de itens.X 

 


Exemplos
oList:Modify("Item 2 modificado", 2)

Preview
Exemplo do método Modify
Reset

Reset

Limpa todos os itens da ListBox.


Sintaxe

TListBox(): Reset ( ) -->


Exemplos
oList:Reset()
Select

Select

Força a seleção de um item.


Sintaxe

TListBox(): Select ( [ nItem] ) -->


Parâmetros

 

NomeTipoDescriçãoObrigatórioReferência
nItemNuméricoIndica a posição do item que será selecionado.  

 


Exemplos
oList:Select(2)
SetArray

SetArray

Define o vetor de itens para a lista. Caso exista uma definição anterior ela será substituida.


Sintaxe

TListBox(): SetArray ( < aVetor> ) -->


Parâmetros

 

NomeTipoDescriçãoObrigatórioReferência
aVetorVetorIndica um array, no formato texto, com os itens para a lista.X 

 


Exemplos
oList:SetArray({'Item novo 1','Item novo 2','Item novo 3','Item novo 4'})
SetItems

SetItems

Define o array de itens para a lista. Caso exista uma definição anterior ela será substituída.


Sintaxe

TListBox(): SetItems ( < aVetor> ) -->


Parâmetros

 

NomeTipoDescriçãoObrigatórioReferência
aVetorVetorIndica o array, no formato texto, que contêm os itens para a lista.X 

 


Exemplos
oList:SetItems({'Item novo 1','Item novo 2','Item novo 3','Item novo 4'})

Propriedade

 

PropriedadeDescriçãoTipo
aItemsIndica a lista de itens para seleção.Vetor
nAtIndica a posição do item selecionado.Numérico

 


Observações

Sempre que um item é selecionado, uma variável é atualizada com o conteúdo do item.


 

Exemplo
#INCLUDE "TOTVS.CH"

USER FUNCTION TListBox()
	DEFINE DIALOG oDlg TITLE "Exemplo TListBox" FROM 180,180 TO 550,700 PIXEL
		aItems := {'Item 1','Item 2','Item 3','Item 4'}
		nList := 1
		// Usando o New
		oList1 := TListBox():New(001,001,{|u|if(Pcount()>0,nList:=u,nList)},;
									aItems,100,100,,oDlg,,,,.T.)
		// Usando o Create    
		oList2 := TListBox():Create(oDlg,001,110,{|u|if(Pcount()>0,nList:=u,nList)},;
									aItems,100,100,,,,,.T.)
	ACTIVATE DIALOG oDlg CENTERED
RETURN

 


Preview
Exemplo da classe TListBox

Abrangência
Advanced Protheus 6.09 , Advanced Protheus 7.10 , Microsiga Protheus 8.11 , Microsiga Protheus 11 , Protheus 10 , TOTVS Application Server 10 , ByYou Application Server

 

 

 

  • Sem rótulos