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(< componentReferencecComponentReference >,"ALIGN") ==> cALign

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReference` `cComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"CAN_GOT_FOCUS ") ==> lCanGotFocus

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReferencecComponentReference	CHAR	Referência do componente.	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 componentReferencecComponentReference = _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(< componentReferencecComponentReference >,"CHANGE_EVENT ") ==> cFunctionName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"CLICK_EVENT") ==> cFunctionName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"CLICK_EVENT")

Expandir

title	GET COMPONENT_TYPE

Método GET: COMPONENT_TYPE

Tipo do componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"COMPONENT_TYPE") ==> cType

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"DOUBLE_CLICK_EVENT") ==> cFunctionName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReference,"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(< componentReferencecComponentReference >,"EDITABLE") ==> lEditable

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"EDITABLE")

Expandir

title	GET ENABLE

Método GET: ENABLE

Retorna se o componente está habilitado.

Sintaxe

Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"ENABLE") ==> lEnable

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"FORM_REFERENCE") ==> cFormReference

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"GOT_FOCUS_EVENT") ==> cFunctionName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"GOT_FOCUS_EVENT")

Expandir

title	GET HANDLER

Método GET: HANDLER

Código nativo do componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"HANDLER") ==> nHandlerID

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	Sim

Retorno

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

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_hadler = _ADVPL_get_property(componentReferencecComponentReference,"HANDLER")

Expandir

title	GET HEIGHT

Método GET: HEIGHT

Altura do componente em pixels.

Sintaxe

Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"ENABLE") ==> nHeight

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	Sim

Retorno

Tipo	Descrição
NUMERIC	Altura em pixels do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_height = _ADVPL_get_property(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"HELP_NAME") ==> cText

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReference,"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(< componentReferencecComponentReference >,"LOST_FOCUS_EVENT") ==> functionName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"PARENT_REFERENCE") ==> cParentRerence

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"PARENT_REFERENCE")

Expandir

title	GET RIGHT_CLICK_EVENT

Método GET: RIGHT_CLICK_EVENT

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

Sintaxe

Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"RIGHT_CLICK_EVENT") ==> cFunctionName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"SHOW_TOOLTIP") ==> lShowTooTip

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"TOOLTIP") ==> cText

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"VALID") ==> cFunctionName

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"VALID")

Expandir

title	GET VALUE

Método GET: VALUE

Valor definido para o componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"VALUE") ==> uValue

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	Sim

Retorno

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

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_value = _ADVPL_get_property(componentReferencecComponentReference,"VALUE")

Expandir

title	GET VISIBLE

Método GET: VISIBLE

Retorna se o componente está visível.

Sintaxe

Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"VISIBLE") ==> lVisible

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	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(componentReferencecComponentReference,"VISIBLE")

Expandir

title	GET WIDTH

Método GET: WIDTH

Largura do componente em pixels.

Sintaxe

Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"WIDTH") ==> nWidth

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	Sim

Retorno

Tipo	Descrição
INTEGER	Largura em pixels do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_width = _ADVPL_get_property(componentReference,"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(< componentReferencecComponentReference >,"X") ==> nPos

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	Sim

Retorno

Tipo	Descrição
INTEGER	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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"Y") ==> nPos

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	CHAR	Referência do componente.	Sim

Retorno

Tipo	Descrição
INTEGER	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(componentReference,"Y")

Métodos SET

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

Expandir

title	SET ALIGN

Método SET: ALIGN

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

Sintaxe

Bloco de código
_ADVPL_set_property( componentReferencecComponentReference ,"ALIGN",< cAlign >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReferencecComponentReference	CHAR	Referência do componente.	Sim
cAlign	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.	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

language	ruby
theme	Confluence
linenumbers	true

#---------------------# 
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_dialog_reference,"SIZE",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_label_reference,"HEIGHT",80)
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","TOP")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",255,255,0)
    
 #Alinhamento à esquerda.
     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","LEFT")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",255,0,0)
    
 #Alinhamento central.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANELLTITLEDPANEL",l_dialog_reference)       
     CALL _ADVPL_set_property(l_label_reference,"TITLE","Teste de Alinhamento")
     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(< componentReferencecComponentReference >,"BACKGROUND_COLOR",< nRed >, < nGreen >, < nBlue >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
nRed	`INTEGER`	Número correspondente ao nível de vermelho da cor (R do RGB).	Sim
nGreen	`INTEGER`	Número correspondente ao nível de verde da cor (G do RGB).	Sim
nBlue	`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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"BOUNDS",< nXPos >, < nYPos > , < nWidht >, < nHeight >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
nXPos	`INTEGER`	Posição em pixels do eixo X (horizontal) do componente.	Sim
nYPos	`INTEGER`	Posição em pixels do eixo Y (vertical) do componente.	Sim
nWidht	`INTEGER`	Largura em pixels do componente.	Sim
nHeight	`INTEGER`	Altura em pixels do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"CAN_GOT_FOCUS",< lCanGotFocus >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
lCanGotFocus	`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(componentReferencecComponentReference,"CAN_GOT_FOCUS",FALSE)

Expandir

title	SET CHANGE_EVENT

Método SET: CHANGE_EVENT

Evento executado quando o valor do componente for alterado.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference > ,"CHANGE_EVENT",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	`CHAR`	Referência do componente.	Sim
`cFunctionName`	`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(componentReferencecComponentReference,"CHANGE_EVENT","job0003_execucao_gatilho_select_all")

Expandir

title	SET CLICK_EVENT

Método SET: CLICK_EVENT

Evento executado ao clicar no componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< buttonReferencecButtonReference >,"CLICK_EVENT",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
buttonReferencecButtonReference	`CHAR`	Referência do componente.	Sim
`cFunctionName`	`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_processcButtonReference,"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(< componentReferencecComponentReference >,"CSS",< cCodeCSS >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	`CHAR`	Referência do componente.	Sim
`cCodeCSS`	`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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"DOUBLE_CLICK_EVENT",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReferencecComponentReference	`CHAR`	Referência do componente.	Sim
`cFunctionName`	`CHAR`	Função executada ao efetuar um duplo clique no componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(m_tree_parametercComponentReference,"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(< componentReferencecComponentReference >,"EDITABLE",< lEditable >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
lEditable	`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(componentReferencecComponentReference,"EDITABLE",FALSE)

Expandir

title	SET ENABLE

Método SET: ENABLE

Habilita ou desabilita o componente.

Sintaxe

Bloco de código
_ADVPL_set_property( < componentReferencecComponentReference > ,"ENABLE", < lEnable > )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
lEnable	`BOOLEAN`	Indicador que define se o componente será habilitado.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"ENABLE",FALSE)

Expandir

title	SET FONT

Método SET: FONT

Configurações de fonte utilizados para os textos do componente.

Sintaxe

Bloco de código
_ADVPL_set_property( < componentReferencecComponentReference > ,"FONT", [ cFont ], [ nLength ], [ lBold ], [ lItalic ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
cFont	`CHAR`	Nome do fonte que será utilizado pelo componente.	Não
nLength	`INTEGER`	Tamanho do fonte que será utilizado.	Não
lBold	`BOOLEAN`	Indicador que define se o texto será negrito.	Não
lItalic	`BOOLEAN`	Indicador que define se o texto será itálico.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"FONT","Courier New",10,TRUE,FALSE)

Expandir

title	SET FORCE_GET_FOCUS

Método SET: FORCE_GET_FOCUS

Força o foco para o componente.

Sintaxe

Bloco de código
_ADVPL_set_property( < componentReferencecComponentReference >,"FORCE_GET_FOCUS", [ lForce ] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
lForce	`BOOLEAN`	Indicador que define se, caso o componente estiver em uma aba, esta também ganhe foco.	Não

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"FORCE_GET_FOCUS",TRUE)

Expandir

title	SET FOREGROUND_COLOR

Método SET: FOREGROUND_COLOR

Cor da fonte do componente em RGB (Red, Green and Blue).

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"FOREGROUND_COLOR", [ nRed ], [ nGreen ], [ nBlue ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
nRed	`INTEGER`	Número correspondente ao nível de vermelho da cor (R do RGB).	Sim
nGreen	`INTEGER`	Número correspondente ao nível de verde da cor (G do RGB).	Sim
nBlue	`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(componentReference,"FOREGROUND_COLOR",255,0,0)

Expandir

title	SET GOT_FOCUS_EVENT

Método SET: GOT_FOCUS_EVENT

Evento executado quando o componente ganhar foco.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"GOT_FOCUS_EVENT", < cFunctionName > )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReferencecComponentReference	`CHAR`	Referência do componente.	Sim
cFunctionName	`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_grid_referencecComponentReference,"GOT_FOCUS_EVENT", "eai100001_got_focus_event_mensagem")

Expandir

title	SET HEIGHT

Método SET: HEIGHT

Altura do componente em pixels.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"HEIGHT", [ nHeight ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
nHeight	INTEGER	Altura em pixels do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"HELP_NAME",[ cText ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?

componentReference

cComponentReference	`CHAR`	Referência do componente.	Sim
cText	`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(componentReferencecComponentReference,"HELP_NAME","frm_toolbar_parent_name")

Expandir

title	SET HOTKEY

Método SET: HOTKEY

Tecla de atalho definida para o componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >, "HOTKEY",< cKey >,< functioName >,< cDescription >,< lOnlyExecuteOnFocus >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	`CHAR`	Referência do componente.	Sim
cKey	`CHAR`	Tecla de atalho conforme teclas disponíveis na lista de teclas de atalhos.	Sim
functionName	`CHAR`	Função que será executada ao acionar a tecla de atalho.	Sim
cDescription	`CHAR`	Descrição do objetvo da tecla de atalho. Esta descrição será exibida na janela de teclas disponível no formulário para o usuário.	Sim
lOnlyExecuteOnFocus	`BOOLEAN`	Indicador lógico que define se a 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(componentReferencecComponentReference,"HOTKEY","F4","Zoom de empresas.",TRUE)

Expandir

title	SET LOST_FOCUS_EVENT

Método SET: LOST_FOCUS_EVENT

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

Sintaxe

Bloco de código
_ADVPL_set_property(< l_textfield >cComponentReference>,"LOST_FOCUS_EVENT",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
l_textfield cComponentReference	`CHAR`	Referência do componente.	Sim
cFunctionName	`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_textfieldcComponentReference,"LOST_FOCUS_EVENT","log08100_zoom_tabela")

Expandir

title	SET POSITION

Método SET: POSITION

Posição (horizontal e vertical) em pixels do componente em relação ao componente pai.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"POSITION",[ nXPos ], [ nYPos ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	`CHAR`	Referência do componente.	Sim
nXPos	`INTEGER`	Posição em pixels do eixo X (horizontal) do componente.	Sim
nYPos	`INTEGER`	Posição em pixels do eixo Y (vertical) do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"POSITION",05,10)

Expandir

title	SET PROPERTY

Método SET: PROPERTY

Atribui novas propriedades para o componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"PROPERTY",[ cProperties ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
cProperties	`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(componentReferencecComponentReference,"PROPERTY","{'PICTURE','@!'}{'LENGTH',10}")

Expandir

title	SET REFRESH_SIZE

Método SET: REFRESH_SIZE

Atualiza as propriedades de coordenadas do componente (posição e tamanho)

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"REFRESH_SIZE")

Esta função atualiza as propriedades de coordenadas do componente (X, Y, WIDTH e HEIGHT).

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"REFRESH_SIZE")

Expandir

title	SET REMOVE_VARIABLES

Método SET: REMOVE_VARIABLES

Remove as variáveis definidas para o componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"REMOVE_VARIABLES")

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"REMOVE_VARIABLES")

Expandir

title	SET RIGHT_CLICK_EVENT

Método SET: RIGHT_CLICK_EVENT

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

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"RIGHT_CLICK_EVENT",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReferencecComponentReference	`CHAR`	Referência do componenteSIM	Sim
cfunctionName	`CHAR`	Função executada ao efetuar um clique com o botão direito do mouse no componente.SIM	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

          CALL _ADVPL_set_property(l_node_ativid_endcComponentReference,"RIGHT_CLICK_EVENT","sup2033_marca_desmarca_nos")

Expandir

title	SET SAVE_IMAGE

Método SET: SAVE_IMAGE

Salva uma imagem (print) do componente em uma imagem do tipo bitmap (BMP).

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"SAVE_IMAGE",< cPath >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
cPath	`CHAR`	Caminho completo onde será salva a imagem do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"SAVE_IMAGE","C:\\totvs\\temp\\component_image.bmp")

Expandir

title	SET SHOW_TOOLTIP

Define se será 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_set_property(< componentReferencecComponentReference >,"SHOW_TOOLTIP",< lShowToolTip >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
lShowToolTip	`BOOLEAN`	Indicador que define se será exibido o texto de ajuda (exibido quando o usuário posicionar o cursor do mouse em cima do componente) informado.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"SHOW_TOOLTIP",FALSE)

Expandir

title	SET SIZE

Método SET: SIZE

Tamanho (largura e altura) em pixels do componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"SIZE",< nWidth >, < nHeight >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
nWidth	`INTEGER`	Largura em pixels do componente.	Sim
nHeight	`INTEGER`	Altura em pixels do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"SIZE",640,480)

Expandir

title	SET TOOLTIP

Método SET: TOOLTIP

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

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"TOOLTIP",< cText >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReference`	`CHAR`	Referência do componente.	Sim
cText cText	`CHAR`	Texto que será exibido quando o usuário posicionar o cursor do mouse em cima do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"TOOLTIP","Código da empresa corrente.")

Expandir

title	SET VALID

Método SET: VALID

Evento executado para validar o conteúdo do componente quando este perder seu foco.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"VALID",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
cFunctionName	`CHAR`	Função executada para validar o conteúdo do componente quando este perder o foco.	Sim

Importante: esta função deverá retornar um indicador lógico de sucesso na validação do conteúdo do campo. Se a mesma retornar falso, o foco continua no campo, caso contrário a entrada de dados continua normalmente.

Este evento será executado antes da execução do evento do método LOST_FOCUS_EVENT.

Expandir

title	SET VALUE

Método SET: VALUE

Valor definido para o componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"VALUE",< uValue >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?

componentReference

cComponentReference

CHAR

Referência do componente.

Sim

uValue

ANY

Valor que será definido para o componente.

Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"VALUE",10)

Expandir

title	SET VARIABLE

Método SET: VARIABLE

Adiciona uma variável que será controlada pelo componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"VARIABLE",< record4GL >, < cVariableName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?

componentReference

cComponentReference	`CHAR`	Referência do componente.	Sim
record4GL	`OBJECT`	Record 4GL que contém a variável de controle do componente.	Sim
cVariableName	`CHAR`	Nome da variável do Record 4GL que controlará o componente. Quando não for informado , tenta procurar uma variável com o mesmo nome do campo	Não

Ao alterar o valor em tela, automaticamente o valor da variável definida também será alterada, mas quando o valor da variável for alterada no 4GL, deverá ser utilizado o método REFRESH no componente para atualizar o valor em tela.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReference,"VARIABLE",mr_tela,"cod_item")

Expandir

title	SET VISIBLE

Método SET: VISIBLE

Habilita ou desabilita a visualização do componente.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"VARIABLE",< lVisible >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
lVisible	`BOOLEAN`	Indicador que define se o componente será visível.	Sim

Mesmo o componente sendo invisível, o espaço ocupado pelo mesmo continuará em tela.

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"VISIBLE",FALSE)

Expandir

title	SET WIDTH

Método SET: WIDTH

Largura do componente em pixels.

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"WIDTH",< nWidth >)

|

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
componentReference cComponentReference	`CHAR`	Referência do componente.	Sim
nWidth	`INTEGER`	Largura em pixels do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"WIDTH",250)

Expandir

title	SET X

Método SET: X

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

Sintaxe

Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"X",< nPos >)

|

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	`CHAR`	Referência do componente.	Sim
nPos	`INTEGER`	Posição em pixels do eixo X (horizontal) do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"X",10)

Expandir

title	SET Y

Método SET: Y

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

Sintaxe

Bloco de código
_ADVPL_set_property(componentReferencecComponentReference,"Y",< nPos >)

|

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`componentReferencecComponentReference`	`CHAR`	Referência do componente.	Sim
nPos	`INTEGER`	Posição em pixels do eixo Y (horizontal) do componente.	Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(componentReferencecComponentReference,"Y",10)

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 27

Nova versão Atual

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