Caixa de listagem

Nome	Caixa de listagem
Tecla de atalho	Nenhuma
Ícone
Objeto gráfico	Sim

Esta página apresenta descrição e propriedades do item ListBox.

ListBox

ico Este objeto exibe uma lista de opções associadas a valores para serem escritos em um Tag.

Propriedades de identificação do objeto
Propriedade	Descrição	Default
Nome do item	Define o nome do item que será exibido na árvore do painel de projeto e será utilizado quando necessário referenciar o mesmo.	Item_NNN
Comentário	Permite a inclusão de um comentário acerca do objeto. Este campo não é obrigatório.	(Nenhum)
Argumentos	Neste campo pode-se inserir uma string que será o valor da propriedade Argument do item. A string fornecida é uma forma geral de passagem de parâmetros para os scripts associados ao objeto durante sua execução.	(Nenhum)

Propriedades Comuns
Propriedade	Descrição	Default
Descrição	Pode-se acrescentar uma breve descrição sobre o objeto. Este campo é apenas documental não sendo utilizado no projeto. Este campo não é obrigatório.	(Nenhuma)
Dica	Texto a ser apresentado quando o mouse é posicionado sobre o objeto. Este campo não é obrigatório.	(Nenhuma)
Topo	Define a distância, em pixels, entre a borda superior do objeto e a borda superior da tela.	Depende
Esquerda	Define a distância, em pixels, entre a borda esquerda do objeto e a borda esquerda da tela.	Depende
Largura	Largura, em pixels, do objeto.	Depende
Altura	Altura, em pixels, do objeto.	Depende
Habilitado	Define se o objeto pode responder a interação do usuário.	Sim
Grupo com permissão de execução	Neste campo é possível selecionar qual grupo de usuários terá permissão para executar a imagem na tela da aplicação.	Todos os grupos
Visível	Define se o objeto será ou não exibido na tela.	Sim
Grupo com permissão de visualização	Neste campo é possível selecionar qual grupo de usuários terá permissão para executar imagem na tela da aplicação.	Todos os grupos

obs

As propriedades Topo, Esquerda, Largura e Altura tem seus valores default definidos no momento da criação do objeto. Então, esses valores podem variar para os diferentes tipos de objeto.

Propriedades Específicas
Propriedade	Descrição	Default
Utiliza lista de texto global	Define se o objeto utilizará lista de texto global ou não. Opções: SIM - Um novo campo “Identificador de lista” será apresentado. NÃO - O usuário pode inserir itens do tipo Text3 para serem utilizados pelo objeto.	Não
Identificador de lista	Neste campo deve-se inserir o nome da Listas de textos globais a ser utilizada pelo objeto.	(Nenhum)
Modo de edição	Define se a alteração da Tag será feita automaticamente ou se dependerá de algum script associado. Opções: Automático - O modo de edição do Tag associado ao objeto é automático. Via Script - O modo de edição do Tag associado ao objeto passa a ser via script.”	Automático
Padrão: cor de Fundo	Define a cor de fundo do objeto.	RGB(255,255,255)
Propriedades da Fonte	Abre tela para definições das propriedades da fonte.	Arial, 10, Preto
Ordenação	Define se os itens do ListBox serão ordenados ou não.	Não

obs

Este atributo está disponível para o HIscada Pro a partir da versão 1.3.00

Tags
Propriedade	Descrição	Default
Nome Tag	Nome do Tag associado ao objeto.	(Nenhum)
Índice	Offset para o valor do Tag associado caso ele seja um vetor.	1

Eventos
Propriedade	Descrição	Default
On Click	Executa uma ação após o evento de um clique simples sobre o objeto. Necessita do nome do script a ser executado. Para esse objeto, o evento OnClick está disponível via Objeto de Ação. Este campo não é obrigatório.	(Nenhum)
On Select	Ação a ser executada quando o atributo da lista for selecionado com botão esquerdo do mouse. Necessita do nome do script a ser executado. Para esse objeto, o evento OnSelect está disponível via Script. Este campo não é obrigatório.	(Nenhum)

Text

ico1 Item utilizado para definição do texto a ser apresentado dentro dos itens TextList, ListBox e ComboBox. Válido somente quando não há definição de Lista de Texto.

Identificação
Propriedade	Descrição	Default
Nome do item	Define o nome do item que será exibido na árvore do painel de projeto e será utilizado quando necessário referenciar o mesmo.	Item_NNN
Comentário	Permite a inclusão de um comentário acerca do objeto. Este campo não é obrigatório.	(Nenhum)

Propriedades Específicas do objeto
Propriedade	Descrição	Default
Texto	Texto a ser exibido pelo objeto.	Text_NNN
Valor	Valor associado ao texto.	0

API Lua

A lista das propriedades e atributos deste e outros componentes estão documentadas em Scripts e Acesso a atributos e funções de Componentes de Tela. A seguir apresentamos as tabelas com as propriedades e atributos de gerenciamento que podem ser utilizados via scripts, para o objeto descrito nessa página:

Atributos Comuns

São apresentados neste item os atributos que são comuns à grande maioria dos componentes de tela.

Atributos Comuns
Nome da Propriedade	Descrição
Visible	Torna o componente visível ou não.
Enabled	Habilita ou não a interação com o componente.
Top	Distância em pixels do topo do componente ao topo da tela em que está contido.
Left	Distância em pixels da lateral esquerda do componente à lateral esquerda da tela em que está contido.
Width	Largura em pixels do componente.
Height	Altura em pixels do componente.
Arguments	Texto preenchido no IDE na propriedade Argumentos.

ListBox

ListBox
Propriedades Específicas	Descrição
DisplayedValue	Texto associado ao elemento da lista correntemente selecionado. Este atributo é somente para leitura. {HIscada Pro>=0.4.05}
ItemIndex	Valor inteiro que indica a posição que está selecionada no componente. A primeira posição tem índice 0. O índice -1 significa que não há nenhuma seleção. Esta propriedade pode ser lida ou escrita. No caso de escrita da propriedade !ItemIndex, fica a ressalva de que o Tag associado ao controle não será alterado (como ocorre quando a seleção é feita manualmente pelo usuário ao invés de usar esta API.) {HIscada Pro>=0.4.05}
RefreshNow	Atribuir 1 a esta propriedade para atualizar a lista interna com o conteúdo da lista de texto global associada a este componente.
UpdatePending	Quando a propriedade “Mode de Edição” estiver configurada para “via script”, a propriedade UpdatePending (booleano) indica se o valor do campo foi alterado significando que a atualização no respectivo Tag está pendente.
SaveEdit	Quando a propriedade “Mode de Edição” estiver configurada para “via script”, atribuir 1 grava os dados do Edit no Tag somente se houver alteração, atribuir 2 sempre grava os dados do Edit no Tag associado.
CancelEdit	Quando a propriedade “Mode de Edição” estiver configurada para “via script”, atribuir 1 cancela a edição somente se houver alteração, atribuir 2 sempre cancela a edição.

Exemplo de uso do ListBox

local scr = Screens.Get("Screen_001")

-- Mostra qual a linha da lista que está correntemente selecionada
print(scr.ListBox_001.ItemIndex)

-- A cada 2s seleciona um novo item em uma lista de 3 elementos
for i=0,2 do
  scr.ListBox_001.ItemIndex = i
  Sleep(2000)
end

Ver também