Pagetitle

	LGX - LComponent
	LGX - LComponent

Componente abstrato base para outros componentes. Todos os métodos contidos neste componente poderão ser executados pelos componentes que o herdam.

Hierarquia

LCOMPONENT

Métodos GET

Métodos acessíveis utilizando a função _ADVPL_get_property, que permite recuperar e manipular os valores do componente:

Expandir

title	GET ALIGN

Método GET: ALIGN

Alinhamento do componente em relação ao seu componente pai.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ALIGN") ==> Alinhamento

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Alinhamento do componente em relação ao componente pai, sendo: NONE: nenhum alinhamento. TOP: alinhamento ao topo. LEFT: alinhamento à esquerda. RIGHT: alinhamento à direita. CENTER: alinhamento central. BOTTOM: alinhamento ao fundo.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_align = _ADVPL_get_property(l_component_reference,"ALIGN")

Expandir

title	GET CAN_GOT_FOCUS

Método GET: CAN_GOT_FOCUS

Retorna se o componente poderá ganhar foco.

Sintaxe

Bloco de código
_ADVPL_get_property(< m_form_reference >,"CAN_GOT_FOCUS ") ==> Permite ganhar foco?

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`m_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
BOOLEAN	Indicador que define se o componente pode ganhar foco.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_component_reference = _ADVPL_get_property(m_form_reference,"CAN_GOT_FOCUS ")

Expandir

title	GET CHANGE_EVENT

Método GET: CHANGE_EVENT

Evento executado quando o valor do componente for alterado.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"CHANGE_EVENT ") ==> Função

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Função que é executada quando o valor do componente for alterado.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_change_event = _ADVPL_get_property(l_component_reference,"CHANGE_EVENT")

Expandir

title	GET CLICK_EVENT

Método GET: CLICK_EVENT

Evento executado ao clicar no componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"CLICK_EVENT") ==> Função

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Função que é executada ao clicar no componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_click_event = _ADVPL_get_property(l_component_reference,"CLICK_EVENT")

Expandir

title	GET COMPONENT_TYPE

Método GET: COMPONENT_TYPE

Tipo do componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"COMPONENT_TYPE") ==> Tipo

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Tipo do componente criado (LDialog, LCheckBox, LTextField, etc).

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_component_type = _ADVPL_get_property(l_component_reference,"COMPONENT_TYPE")

Expandir

title	GET DOUBLE_CLICK_EVENT

Método GET: DOUBLE_CLICK_EVENT

Evento executado ao efetuar um duplo clique no componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"DOUBLE_CLICK_EVENT") ==> Função

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Função que é executada ao efetuar um duplo clique no componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_double_click_event = _ADVPL_get_property(l_component_reference,"DOUBLE_CLICK_EVENT")

Expandir

title	GET EDITABLE

Método GET: EDITABLE

Retorna se o componente está editável.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"EDITABLE") ==> Editável?

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
BOOLEAN	Indicador que define se o componente está editável.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_editable = _ADVPL_get_property(l_component_reference,"EDITABLE")

Expandir

title	GET ENABLE

Método GET: ENABLE

Retorna se o componente está habilitado.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ENABLE") ==> Habilitado?

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
BOOLEAN	Indicador que define se o componente está habilitado.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_enable = _ADVPL_get_property(l_component_reference,"ENABLE")

Expandir

title	GET FORM_REFERENCE

Método GET: FORM_REFERENCE

Referência da janela em que o componente está criado.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"FORM_REFERENCE") ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Referência da janela onde o componente foi criado.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_form_reference = _ADVPL_get_property(l_component_reference,"FORM_REFERENCE")

Expandir

title	GET GOT_FOCUS_EVENT

Método GET: GOT_FOCUS_EVENT

Evento executado quando o componente ganhar foco.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"GOT_FOCUS_EVENT") ==> Função

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Função que é executada quando o componente ganhar foco.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_got_focus = _ADVPL_get_property(l_component_reference,"GOT_FOCUS_EVENT")

Expandir

title	GET HANDLER

Método GET: HANDLER

Código nativo do componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"HANDLER") ==> Código

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
()	Código nativo AdvPL do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_hadler = _ADVPL_get_property(l_component_reference,"HANDLER")

Expandir

title	GET HEIGHT

Método GET: HEIGHT

Altura do componente em pixels.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"ENABLE") ==> Altura

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
( )	Altura em pixels do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_height = _ADVPL_get_property(l_component_reference,"HEIGHT")

Expandir

title	GET HELP_NAME

Método GET: HELP_NAME

Código do campo a ser identificado na ajuda online do componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"HELP_NAME") ==> Texto

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Texto que identifica o componente na URL da ajuda online.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_help_name = _ADVPL_get_property(l_component_reference,"HELP_NAME")

Expandir

title	GET LOST_FOCUS_EVENT

Método GET: LOST_FOCUS_EVENT

Evento executado quando o componente perder seu foco.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"LOST_FOCUS_EVENT") ==> Função

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Função que é executada quando o componente perder seu foco.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_lost_focus = _ADVPL_get_property(l_component_reference,"LOST_FOCUS_EVENT")

Expandir

title	GET PARENT_REFERENCE

Método GET: PARENT_REFERENCE

Referência do componente pai do componente atual.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"PARENT_REFERENCE") ==> Referência

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Referência do componente pai do componente atual.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_parent_reference = _ADVPL_get_property(l_component_reference,"PARENT_REFERENCE")

Expandir

title	GET RIGHT_CLICK_EVENT

Método GET: GOT_FOCUS_EVENT

Evento executado ao efetuar um clique com o botão direito do mouse no componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"RIGHT_CLICK_EVENT ") ==> Função

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Função que é executada ao efetuar um clique com o botão direito do mouse no componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_right_click_event = _ADVPL_get_property(l_component_reference,"RIGHT_CLICK_EVENT")

Expandir

title	GET SHOW_TOOLTIP

Retorna se está sendo exibido o texto de ajuda (exibido quando o usuário posicionar o cursor do mouse em cima do componente) informado.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"SHOW_TOOLTIP") ==> Exibe texto de ajuda?

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
BOOLEAN	Indicador que define se está sendo exibido o texto de ajuda (exibido quando o usuário posicionar o cursor do mouse em cima do componente) informado.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_show_tooltip = _ADVPL_get_property(l_component_reference,"SHOW_TOOLTIP")

Expandir

title	GET TOOLTIP

Método GET: TOOLTIP

Texto de ajuda exibido quando o usuário posicionar o cursor do mouse em cima do componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"TOOLTIP") ==> Texto

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Texto que é exibido quando o usuário posicionar o cursor do mouse em cima do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_tooltip = _ADVPL_get_property(l_component_reference,"TOOLTIP")

Expandir

title	GET VALID

Método GET: VALID

Texto de ajuda exibido quando o usuário posicionar o cursor do mouse em cima do componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"VALID") ==> Função

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
CHAR	Função que é executada para validar o conteúdo do componente quando este perder o foco.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_valid = _ADVPL_get_property(l_component_reference,"VALID")

Expandir

title	GET VALUE

Método GET: VALUE

Valor definido para o componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"VALUE") ==> Valor

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
( )	Valor que está definido para o componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_value = _ADVPL_get_property(l_component_reference,"VALUE")

Expandir

title	GET VISIBLE

Método GET: VISIBLE

Retorna se o componente está visível.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"VISIBLE") ==> Visível?

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
BOOLEAN	Indicador que define se o componente está visível.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_visible = _ADVPL_get_property(l_component_reference,"VISIBLE")

Expandir

title	GET WIDTH

Método GET: WIDTH

Largura do componente em pixels.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"WIDTH") ==> Largura

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
( )	Largura em pixels do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_width = _ADVPL_get_property(l_component_reference,"WIDTH")

Expandir

title	GET X

Método GET: X

Posição em pixels do eixo X (horizontal) do componente em relação ao componente pai.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"X") ==> Posição do eixo X (Horizontal)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
( )	Posição em pixels do eixo X do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_x = _ADVPL_get_property(l_component_reference,"X")

Expandir

title	GET Y

Método GET: Y

Posição em pixels do eixo Y (vertical) do componente em relação ao componente pai.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_reference >,"Y") ==> Posição eixo Y (Vertical)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	CHAR	Referência do formulário.	Sim

Retorno

Tipo	Descrição
( )	Posição em pixels do eixo Y do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_y = _ADVPL_get_property(l_component_reference,"Y")

Métodos SET

Métodos acessíveis utilizando a função _ADVPL_set_property que permite alterar e manipular os valores do componente.

Se este método não for informado, será utilizada a modificação do formulário no cadastro do metadado (em programas metadado) ou a modificação do 4GL (para programas freeform).

Exemplo

Expandir

title	SET ACTIVATEALIGN

Método SET:

ACTIVATE

ALIGN

Alinhamento do componente em relação ao seu componente paiAtiva/Desativa a janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_formlabel_reference >,"ACTIVATEALIGN", < l_statusalinhamento >)

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_referencealinhamento

CHAR

Referência do formulário.

Sim

l_status

SMALLINT

Indicador que define se será ativado ou desativado o formulário.

TRUE - Ativa o formulário

FALSE - Desativa/Fecha o formulário.

Sim

Para ativar ou desativar um formulário, deverá ter executado previamente o método "FORM" ou "INIT_FORM" para o mesmo.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"ACTIVATE",TRUE)

Expandir

title	SET CENTER

Alinhamento do componente em relação ao componente pai, sendo:

NONE: nenhum alinhamento.
TOP: alinhamento ao topo.
LEFT: alinhamento à esquerda.
RIGHT: alinhamento à direita.
CENTER: alinhamento central.
BOTTOM: alinhamento ao fundo.

Sim

Importante: Cada tipo de alinhamento possui um comportamento diferente, conforme descrito abaixo para cada tipo de alinhamento:

TOP: ocupa a largura total do componente pai, necessitando definir apenas a altura do componente.
LEFT: ocupa a altura total do componente pai, necessitando definir apenas a largura do componente.
RIGHT: ocupa a altura total do componente pai, necessitando definir apenas a largura do componente.
CENTER: ocupa todo o espaço útil do componente pai, dispensando a necessidade de definir tamanho para o componente.
BOTTOM: ocupa a largura total do componente pai, necessitando definir apenas a altura do componente.

Exemplo

Bloco de código

Método SET: CENTER

Centraliza a janela da aplicação na área de trabalho do usuário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,"CENTER")

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_reference

CHAR

Referência do formulário.

Sim

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"CENTER")

Expandir

title	SET CENTERED

Método SET: CENTERED

Define se a tela abrirá no centro da área de trabalho.

Sintaxe

Bloco de código

#---------------------# FUNCTION TesteAlign()#---------------------#
     DEFINE l_dialog_reference VARCHAR(10)
     DEFINE l_label_reference  VARCHAR(10)

     LET l_dialog_reference = _ADVPL_create_component(NULL,"LDIALOG")
     CALL _ADVPL_set_property(< l_formdialog_reference >,"CENTEREDSIZE",< l_status >)

Parâmetros

NomeTipoDescriçãoObrigatório?l_form_reference

CHAR

Referência do formulário.Siml_status

BOOLEAN

Indicador que define se a tela será aberta no centro da área de trabalho do usuário.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

,640,480)
     CALL _ADVPL_set_property(l_dialog_reference,"TITLE","Teste de Alinhamento")
     
#Alinhamento ao topo.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_formlabel_reference,"CENTEREDHEIGHT",TRUE)

Expandir

title	SET ENABLE_ESC_CLOSE

Método SET: ENABLE_ESC_CLOSE

Define se habilita o encerramento da janela com a tecla ESC.

Sintaxe

Bloco de código
80) CALL _ADVPL_set_property(l_label_reference,"ALIGN","TOP") CALL _ADVPL_set_property(< l_formlabel_reference >,"ENABLEBACKGROUND_ESC_CLOSECOLOR",< l_status >)

Parâmetros

NomeTipoDescriçãoObrigatório?l_form_reference

CHAR

Referência do formulário.Siml_status

BOOLEAN

Indicador que define se a janela poderá ser encerrada com a tecla ESC.Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

,255,255,0)
    
 #Alinhamento à esquerda.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_formlabel_reference,"ENABLE_ESC_CLOSEWIDTH",FALSE)

Expandir

title	SET FORM_INFO

Método SET: FORM_INFO

Define se habilita o encerramento da janela com a tecla ESC.

Sintaxe

Bloco de código

80)
     CALL _ADVPL_set_property(< l_formlabel_reference >,"FORM_INFOALIGN",< informação >)"LEFT")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",255,0,0)
    
 #Alinhamento central.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","CENTER")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",0,255,0)
    
 #Alinhamento à direita.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_label_reference,"WIDTH",80)
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","RIGHT")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",0,0,255)
    
 #Alinhamento ao fundo.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_label_reference,"HEIGHT",80)
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","BOTTOM")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",0,255,255)
     CALL _ADVPL_set_property(l_dialog_reference,"MAXIMIZED",FALSE)
     CALL _ADVPL_set_property(l_dialog_reference,"ACTIVATE",TRUE) END FUNCTION

Expandir

title	SET BACKGROUND_COLOR

Método SET: BACKGROUND_COLOR

Cor de fundo do componente em RGB (Red, Green and Blue).

Sintaxe

Bloco de código
_ADVPL_set_property(< l_component_reference >,"BACKGROUND_COLOR",< Nível de vermelho >, < Nível de verde >, < Nível de azul >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Nível de vermelho	`INTEGER`	Número correspondente ao nível de vermelho da cor (R do RGB).	Sim
Nível de verde	`INTEGER`	Número correspondente ao nível de verde da cor (G do RGB).	Sim
Nível de azul	`INTEGER`	Número correspondente ao nível de azul da cor (B do RGB).	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"BACKGROUND_COLOR",255,0,0)

Expandir

title	SET BOUNDS

Método SET: BOUNDS

Limite do componente (posição horizontal e vertical, altura e largura) em relação ao componente pai.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_component_reference >,"BOUNDS",< Eixo X (Horizontal)>, < Eixo Y (Vertical)>, < Largura>, < Altura>)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Eixo X (Horizontal)	`INTEGER`	Posição em pixels do eixo X do componente.	Sim
Eixo Y (Vertical)	`INTEGER`	Posição em pixels do eixo Y do componente.	Sim
Largura	`INTEGER`	Largura em pixels do componente.	Sim
Altura	`INTEGER`	Altura em pixels do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"BOUNDS",10,10,320,240)

Expandir

title	SET CAN_GOT_FOCUS

Método SET: CAN_GOT_FOCUS

Define se o componente poderá ganhar foco.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_component_reference >,"CAN_GOT_FOCUS",< Permite ganhar foco?>)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Permite ganhar foco?	`BOOLEAN`	Indicador que define se o componente poderá ganhar foco.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"CAN_GOT_FOCUS",FALSE)

======> Cleane, Verificar!

Expandir

title	SET CHANGE_EVENT

Método SET: CHANGE_EVENT ======> Cleane, Verificar!

Evento executado quando o valor do componente for alterado.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_component_reference > ,"CHANGE_EVENT",< Função >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Função	`CHAR`	Função executada quando o valor do componente for alterado.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"CHANGE_EVENT","job0003_execucao_gatilho_select_all")

======> Cleane, Verificar!

Expandir

title	SET CLICK_EVENT

Método SET: CLICK_EVENT ======> Cleane, Verificar!

Evento executado ao clicar no componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< m_button_reference >,"CLICK_EVENT",< Função >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Função	`CHAR`	Função executada ao clicar no componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(m_button_stop_process,"CLICK_EVENT","job0005_stop_process_monitor")

Expandir

title	SET CSS

Método SET: CSS

Estilo CSS (Cascading Style Sheets) definido para o componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_component_reference >,"CSS",< Cod CSS >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Cod CSS	`CHAR`	Código CSS que será definido para o componente.	Sim

Importante: nem todos comandos de estilos disponíveis para o componente QT poderão ser compatíveis com a tecnologia Totvstec.

Para definir o código CSS para o componente, deverá ser utilizado o nome dos componentes nativos do AdvPL (QT).

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"CSS","QPushButton { background-image: url(rpo:BTPESQ.PNG); }")

Expandir

title	SET DOUBLE_CLICK_EVENT

Método SET: DOUBLE_CLICK_EVENT

Evento executado ao efetuar um duplo clique no componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< m_tree_parameter >,"DOUBLE_CLICK_EVENT",< Função >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Função	`CHAR`	Função executada ao efetuar um duplo clique no componente.	Sim

Se este método não for informado, será utilizada a modificação do formulário no cadastro do metadado (em programas metadado) ou a modificação do 4GL (para programas freeform).

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(m_tree_parameter,"DOUBLE_CLICK_EVENT","job0003_parametros_update_variable")

Expandir

title	SET EDITABLE

Método SET: EDITABLE

Habilita ou desabilita a edição do componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_component_reference >,"EDITABLE",< Editável? >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Editável?	`BOOLEAN`	Indicador que define se o componente será editável.	Sim

Independente se o componente é editável ou não, este sempre ganhará foco.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"EDITABLE",FALSE)

Se este método não for informado, será utilizada a modificação do formulário no cadastro do metadado (em programas metadado) ou a modificação do 4GL (para programas freeform).

Exemplo

Expandir

title	SET ENABLE

Método SET: ENABLE

Habilita ou desabilita o componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_component_reference >,"ENABLE",< Habilita? >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Habilita?	BOOLEAN	Indicador que define se o componente será habilitado.	Sim

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_reference

CHAR

Referência do formulário.

Sim

informação

CHAR

Breve informação sobre o formulário.

Sim

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_formcomponent_reference,"FORM_INFO","Formulário de manutenção de usuário Logix."ENABLE",FALSE)

Se este método não for informado, será utilizada a modificação do formulário no cadastro do metadado (em programas metadado) ou a modificação do 4GL (para programas freeform)

Expandir

title	SET FORM_MODIFICATION FONT

Método SET:

FORM_INFO

FONT

Configurações de fonte utilizados para os textos do componenteModificação do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_formcomponent_reference >,"FORM_MODIFICATION",< informação >FONT", [ Fonte], [ Tamanho], [ Negrito?], [ Itálico?])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?

l_form_reference

Fonte

CHAR

Referência do formulário.

Sim

informação

CHAR

Breve informação sobre o formulário.

Não

Nome do fonte que será utilizado pelo componente.
Tamanho	`INTEGER`	Tamanho do fonte que será utilizado.
Negrito?	BOOLEAN	Indicador que define se o texto será negrito.
Itálico?	BOOLEAN	Indicador que define se o texto será itálico.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_formcomponent_reference,"FORM_MODIFICATIONFONT","01"Courier New",10,TRUE,FALSE)

Se este método não for informado, será utilizada a modificação do formulário no cadastro do metadado (em programas metadado) ou a modificação do 4GL (para programas freeform)

Expandir

title	SET FORMFORCE_GET_NAME FOCUS

Método SET:

FORM

FORCE_GET_

NAME

FOCUS

Força o foco para o componente

Modificação do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_formcomponent_namereference >,"FORMFORCE_GET_INFOFOCUS",< formulário >)

Parâmetros

Nome Tipo Descrição Obrigatório?

l_form_name

CHAR

Referência do formulário.

Sim

formulário

CHAR

Nome do formulário.

Sim

[ Força foco na aba?])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Força foco na aba?	`BOOLEAN`	Indicador que define se, caso o componente estiver em uma aba, esta também ganhe foco.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_formcomponent_namereference,"FORMFORCE_GET_NAMEFOCUS","LOG5500"TRUE)

Expandir

title	SET FORMFOREGROUND_RELEASE COLOR

Método SET:

FORM

FOREGROUND_

RELEASE

COLOR

Release do formulárioCor da fonte do componente em RGB (Red, Green and Blue).

Sintaxe

Bloco de código
_ADVPL_set_property(< l_formcomponent_reference >,"FORMFOREGROUND_RELEASE",< release >COLOR",[ Nível de vermelho ], [ Nível de verde], [ Nível de azul])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Nível de vermelho	`INTEGER`	Número correspondente ao nível de vermelho da cor (R do RGB)	`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`release`Nível de verde	`CHAR`	Release do formulário.	Sim

Se este método não for informado, será utilizada a modificação do formulário no cadastro do metadado (em programas metadado) ou a modificação do 4GL (para programas freeform).

`INTEGER`	Número correspondente ao nível de verde da cor (G do RGB).	Sim
Nível de azul	`INTEGER`	Número correspondente ao nível de azul da cor (B do RGB).	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_formcomponent_reference,"FORMFOREGROUND_RELEASECOLOR","02",255,0,0)

Expandir

title	SET FORMGOT_FOCUS_VERSION EVENT

Método SET:

FORM

GOT_FOCUS_

VERSION

EVENT

Evento executado quando o componente ganhar foco

Versão do formulário.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_formgrid_reference >,"FORMGOT_FOCUS_VERSIONEVENT",< versaoFunção >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`versao`	`CHAR`	Versão do formulário.	Sim

Se este método não for informado, será utilizada a modificação do formulário no cadastro do metadado (em programas metadado) ou a modificação do 4GL (para programas freeform).

Função

CHAR

Função executada quando o componente ganhar foco.

Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_formgrid_reference,"FORMGOT_FOCUS_VERSIONEVENT","10 "eai100001_got_focus_event_mensagem")

Expandir

title	SET HOTKEY HEIGHT

Método SET:

HOTKEY

HEIGHT

Altura do componente em pixelsTecla de atalho a ser executada quando a janela da aplicação estiver ativa.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,< tecla >,< função >,< descrição >,< componente >, < status >< l_component_reference >,"HEIGHT",[ Altura ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
tecla	`CHAR`	Tecla de atalho conforme teclas disponíveis na lista de teclas de atalhos.	Sim
função	CHAR	Função que será executada ao acionar a tecla de atalho.	Sim
descrição	CHAR	Descrição da execução da tecla de atalho, esta descrição será exibida na janela de tecla disponíveis no formulário para o usuário.	Sim
componente	CHAR	Referência do componente do qual pertence a tecla de atalho.	Não
status	BOOLEAN	Indicador lógico que define se o atalho deverá ser executado sempre ou somente quando o componente informado no método estiver focado em tela.	Não

Para acessar a lista de teclas de atalhos válidas disponíveis, clique aqui.

Altura

INTEGER

Altura em pixels do componente.

Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"HEIGHT",200)

Expandir

title	SET HELP_NAME

Método SET: HELP_NAME

Código do campo a ser identificado na ajuda online do componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_component_name >,"HELP_NAME",[ Texto ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Texto	`CHAR`	Texto que será identificado na URL da ajuda online do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_form_reference,"HOTKEY","CTRL-I","Incluir um novo registro.",l_menubutton_reference,FALSEcomponent_name,"HELP_NAME","frm_toolbar_parent_name")

Expandir

title	SET INIT_EVENT HOTKEY

Método SET:

INIT_EVENT

HOTKEY

Tecla de atalho definida para o componenteAdiciona um evento a ser executado ao iniciar a janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_referencecomponent_reference >, "HOTKEY",< tecla >,< função >,< descrição >,< função>Executa somente em foco? >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
tecla	`CHAR`	Tecla de atalho conforme teclas disponíveis na lista de teclas de atalhos.	Sim
função	CHAR	Função que será executada ao acionar a tecla de atalho.	Sim
descrição	CHAR	Descrição	Obrigatório?	da execução da tecla de atalho, esta descrição será exibida na janela de tecla disponíveis no formulário para o usuário.	Sim
componente`l_form_reference`	CHAR	Referência do formuláriocomponente do qual pertence a tecla de atalho.	Sim
`função`	`CHAR`	Função executada executada ao iniciar a janela de aplicação.	Sim

Este método pode ser chamado mais de uma vez, sendo que as funções serão empilhadas e executadas na ordem em que foram enviadas.


Executa somente em foco?	BOOLEAN	Indicador lógico que define se o atalho deverá ser executado sempre ou somente quando o componente informado no método estiver focado em tela.	Sim

Para acessar a lista de teclas de atalhos válidas disponíveis, clique aqui.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"HOTKEY","F4","Zoom de empresas.",TRUE)

Expandir

title	SET MAXIMIZED LOST_FOCUS_EVENT

Método SET:

MAXIMIZED

LOST_FOCUS_EVENT

Código do campo a ser identificado na ajuda online do componenteDefine se a tela abrirá maximizada.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_referencetextfield >,"MAXIMIZEDLOST_FOCUS_EVENT",< statusFunção >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`status`	`BOOLEAN`	Indicador que define se a janela abrirá maximizada.	Sim

Importante: por padrão no Logix, caso não definido este método, toda janela pai (primeira execução) são abertas maximizadas. As janelas abertas na mesma thread por outras janelas são abertas no modo normal.

Função

CHAR

Função executada quando o componente perder seu foco.

Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_textfield,"LOST_formFOCUS_referenceEVENT","MAXIMIZED",FALSElog08100_zoom_tabela")

Expandir

title	SET TITLE POSITION

Método SET:

TITLE

POSITION

Posição (horizontal e vertical) em pixels do componente em relação ao componente paiTítulo da janela.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_formcomponent_reference >,"TITLE",< título>POSITION",[ Eixo X (Horizontal)], [ Eixo Y (Vertical)])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
Eixo X (Horizontal)	`INTEGER`	Posição em pixels do eixo X do componente	`l_form_reference`	`CHAR`	Referência do formulário.	Sim
`título`	`CHAR`	Título da janela.	Sim
Eixo Y (Vertical)	INTEGER	Posição em pixels do eixo Y do componente.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_formcomponent_reference,"TITLEPOSITION","Central do Usuário",05,10)

Expandir

title	SET VALID PROPERTY

Método SET:

VALID

PROPERTY

Atribui novas propriedades para o componenteDefine se a tela abrirá maximizada.

Sintaxe

Bloco de código
_ADVPL_set_property(< funçao >set_property(< l_component_reference >,"PROPERTY",[ Propriedades ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`função`	`CHAR`	Função que será executada quando o usuário fechar a janela de diálogo.	Sim

Importante: este evento é executado tanto na chamada do método ACTIVATE (para desativar a janela de diálogo), quanto no fechamento da janela pelo sistema operacional (pelo X da janela de diálogo). Este evento não é o mesmo evento definido no método EVENT para o botão LQuitButton.

Importante: caso a função informada neste método retornar falso, a tela não será finalizada.

Propriedades

CHAR

Texto com as propriedades que serão atribuídas para o componente.

Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"PROPERTY","{'PICTURE','@!'}{'LENGTH',10}")

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 12

Nova versão 13

Chave

Hierarquia

Métodos GET

Método GET: ALIGN

Sintaxe

Parâmetros

Exemplo

Método GET: CAN_GOT_FOCUS

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: CHANGE_EVENT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: CLICK_EVENT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: COMPONENT_TYPE

Sintaxe

Retorno

Exemplo

Método GET: DOUBLE_CLICK_EVENT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: EDITABLE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: ENABLE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: FORM_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: GOT_FOCUS_EVENT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: HANDLER

Sintaxe

Parâmetros

Exemplo

Método GET: HEIGHT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: HELP_NAME

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: LOST_FOCUS_EVENT

Sintaxe

Parâmetros

Retorno

Exemplo

Método GET: PARENT_REFERENCE

Sintaxe

Parâmetros

Retorno

Exemplo