Pagetitle

	LGX - LComponentLCOMPONENT
	LGX - LComponentLCOMPONENT

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

Hierarquia

LCOMPONENTLCOMPONENT

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_referencecComponentReference >,"ALIGN") ==> AlinhamentocALign

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_reference` `cComponentReference`	CHAR	Referência do formuláriocomponente.	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_referencecComponentReference,"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_referencecComponentReference >,"CAN_GOT_FOCUS ") ==> Permite ganhar foco?lCanGotFocus

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`m_form_reference`cComponentReference	CHAR	Referência do formuláriocomponente.	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_referencecComponentReference = _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_referencecComponentReference >,"CHANGE_EVENT ") ==> FunçãocFunctionName

Parâmetros

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

Retorno

Tipo

Descrição

CODEBLOCK

(advpl)

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_referencecComponentReference,"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_referencecComponentReference >,"CLICK_EVENT") ==> FunçãocFunctionName

Parâmetros

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

Retorno

Tipo

Descrição

CODEBLOCK

CHAR

(advpl)

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_referencecComponentReference,"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_referencecComponentReference >,"COMPONENT_TYPE") ==> TipocType

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_referencecComponentReference`	CHAR	Referência do formuláriocomponente.	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_referencecComponentReference,"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_referencecComponentReference >,"DOUBLE_CLICK_EVENT") ==> FunçãocFunctionName

Parâmetros

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

Retorno

Tipo

Descrição

CODEBLOCK

CHAR

(advpl)

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_referencecomponentReference,"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_referencecComponentReference >,"EDITABLE") ==> Editável?lEditable

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_referencecComponentReference`	CHAR	Referência do formuláriocomponente.	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_referencecComponentReference,"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 cComponentReference >,"ENABLE") ==> Habilitado?lEnable

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_referencecComponentReference`	CHAR	Referência do formuláriocomponente.	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_referencecComponentReference,"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_referencecComponentReference >,"FORM_REFERENCE") ==> ReferênciacFormReference

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_referencecComponentReference`	CHAR	Referência do formuláriocomponente.	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_referencecComponentReference,"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_referencecComponentReference >,"GOT_FOCUS_EVENT") ==> FunçãocFunctionName

Parâmetros

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

Retorno

Tipo

Descrição

CODEBLOCK

CHAR

(advpl)

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_referencecComponentReference,"GOT_FOCUS_EVENT")

Expandir

title	GET HANDLER

Método GET: HANDLER

Código nativo do componente ADVPL.

Sintaxe

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

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_referencecComponentReference`	CHAR	Referência do formuláriocomponente.	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(l_component_reference,cComponentReference,"HANDLER")

Expandir

title	GET HEIGHT

Método GET: HEIGHT

Altura do componente em pixels.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_referencecComponentReference >,"ENABLE") ==> AlturanHeight

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_referencecComponentReference`	CHAR	Referência do formuláriocomponente.	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(l_component_referencecComponentReference,"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_referencecComponentReference >,"HELP_NAME") ==> TextocText

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_referencecComponentReference`	CHAR	Referência do formuláriocomponente.	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_referencecomponentReference,"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_referencecComponentReference >,"LOST_FOCUS_EVENT") ==> FunçãofunctionName

Parâmetros

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

Retorno

Tipo

Descrição

CODEBLOCK

CHAR

(advpl)

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_referencecComponentReference,"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_referencecComponentReference >,"PARENT_REFERENCE") ==> ReferênciacParentRerence

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`l_form_referencecComponentReference`	CHAR	Referência do formuláriocomponente.	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_referencecComponentReference,"PARENT_REFERENCE")

Expandir

title	GET RIGHT_CLICK_EVENT REQUIRED

Método GET:

GOT_FOCUS_EVENT

REQUIRED

Recupera se o componente tem conteúdo obrigatório ou não. 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_referencecComponentReference >,"RIGHT_CLICK_EVENT REQUIRED") ==> FunçãolRequired

Parâmetros

l_form_reference formulário

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

Retorno

Tipo	Descrição

CHAR

BOOLEAN

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

Indicador que define se o conteúdo do componente é obrigatório ou não.

Exemplo

Bloco de código

language	ruby
theme	EclipseConfluence
linenumbers	true

LET l_right_click_eventrequired = _ADVPL_getset_property(l_component_referencecComponentReference,"RIGHT_CLICK_EVENTREQUIRED")

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

Expandir

title	GET SHOWRIGHT_CLICK_TOOLTIPEVENT

Método GET:

SHOW

RIGHT_CLICK_

TOOLTIP

EVENT

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

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_referencecComponentReference >,"SHOWRIGHT_CLICK_TOOLTIPEVENT") ==> Exibe texto de ajuda?cFunctionName

Parâmetros

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

Retorno

Tipo	Descrição

BOOLEAN

CODEBLOCK

(advpl)

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_showclick_tooltipevent = _ADVPL_get_property(l_component_referencecComponentReference,"SHOWRIGHT_CLICK_TOOLTIPEVENT")

Expandir

title	GET SHOW_TOOLTIP

Texto 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_referencecComponentReference >,"SHOW_TOOLTIP") ==> TextolShowTooTip

Parâmetros

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

Retorno

Tipo	Descrição

CHAR

BOOLEAN

Texto que é

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_referencecComponentReference,"SHOW_TOOLTIP")

Expandir

title	GET VALID TOOLTIP

Método GET:

VALID

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_referencecComponentReference >,"VALIDTOOLTIP") ==> FunçãocText

Parâmetros

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

Retorno

Tipo	Descrição
CHAR	Função Texto que é executada para validar o conteúdo do componente quando este perder o focoexibido 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_validtooltip = _ADVPL_get_property(l_component_referencecComponentReference,"VALIDTOOLTIP")

Expandir

title	GET VALUEVALID

Método GET:

VALUE

VALID

Retorna o bloco de código, em ADVPL, que foi registrado para acionar uma função 4GL.

Esta propriedade somente é válida pra uso em código ADVPL.

Sintaxe

Bloco de código

Valor definido para o componente.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_referencecComponentReference >,"VALUEVALID") ==> ValorcFunctionName

Parâmetros

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

Retorno

Tipo	Descrição
CODEBLOCK (advpl)

Valor que está definido para o componente

Bloco de código ADVPL que é executado 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_valuevalid = _ADVPL_get_property(l_component_referencecComponentReference,"VALUEVALID")

Expandir

title	GET VISIBLEVALUE

Método GET:

VISIBLE

VALUE

Valor definido para Retorna se o componente está visível.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_referencecComponentReference >,"VISIBLEVALUE") ==> Visível?uValue

Parâmetros

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

Retorno

Tipo	Descrição

BOOLEAN

ANY

Indicador que define se

Valor que está definido para o componente

está visível

.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_visiblevalue = _ADVPL_get_property(l_component_referencecComponentReference,"VISIBLEVALUE")

Expandir

title	GET WIDTHVISIBLE

Método GET:

WIDTH

VISIBLE

Retorna se o componente está visívelLargura do componente em pixels.

Sintaxe

Bloco de código
_ADVPL_get_property(< l_form_referencecComponentReference >,"WIDTHVISIBLE") ==> LarguralVisible

Parâmetros

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

Retorno

Tipo	Descrição
BOOLEAN	Indicador que define se o componente está visível	( )	Largura em pixels do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_widthvisible = _ADVPL_get_property(l_component_referencecComponentReference,"WIDTHVISIBLE")

Expandir

title	GET XWIDTH

Método GET:

X

WIDTH

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

Sintaxe

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

Parâmetros

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

Retorno

Tipo	Descrição

( )

INTEGER

Posição

Largura em pixels

do eixo X

do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_xwidth = _ADVPL_get_property(l_component_referencecomponentReference,"XWIDTH")

Expandir

title	GET YX

Método GET:

Y

X

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

Sintaxe

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

Parâmetros

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

Retorno

Tipo	Descrição

( )

INTEGER

Posição em pixels do eixo

Y

X do componente.

Exemplo

Bloco de código

language	ruby
theme	Eclipse
linenumbers	true

LET l_yx = _ADVPL_get_property(l_component_referencecComponentReference,"YX")

Métodos SET

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

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

Expandirexpand

title	SET ALIGNGET Y

Método

SET

GET:

ALIGN

Y

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

Sintaxe

Bloco de código
_ADVPL_setget_property(l_label_reference< cComponentReference >,"ALIGNY",< alinhamento >)) ==> nPos

Parâmetros

Nome	Tipo	Descrição	Obrigatório?

alinhamento

cComponentReference

CHAR

Alinhamento

Referência 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

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,"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

.

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( cComponentReference ,"ALIGN",< cAlign >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cComponentReference	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,"LTITLEDPANEL",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(< cComponentReference >,"BACKGROUND_COLOR",< nRed >, < nGreen >, < nBlue >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(cComponentReference,"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(< cComponentReference >,"BOUNDS",< nXPos >, < nYPos > , < nWidht >, < nHeight >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(cComponentReference,"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(< cComponentReference >,"CAN_GOT_FOCUS",< lCanGotFocus >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(cComponentReference,"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(< cComponentReference > ,"CHANGE_EVENT",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`cComponentReference`	`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(cComponentReference,"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(< cButtonReference >,"CLICK_EVENT",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cButtonReference	`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(cButtonReference,"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(< cComponentReference >,"CSS",< cCodeCSS >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
`cComponentReference`	`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(cComponentReference,"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(< cComponentReference >,"DOUBLE_CLICK_EVENT",< cFunctionName >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cComponentReference	`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(cComponentReference,"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(< cComponentReference >,"EDITABLE",< lEditable >)

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(cComponentReference,"EDITABLE",FALSE)

Expandir

title	SET ENABLE

Método SET: ENABLE

Habilita ou desabilita o componente.

Sintaxe

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

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(cComponentReference,"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( < cComponentReference > ,"FONT", [ cFont ], [ nLength ], [ lBold ], [ lItalic ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(cComponentReference,"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( < cComponentReference >,"FORCE_GET_FOCUS", [ lForce ] )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(cComponentReference,"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(< cComponentReference >,"FOREGROUND_COLOR", [ nRed ], [ nGreen ], [ nBlue ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(< cComponentReference >,"GOT_FOCUS_EVENT", < cFunctionName > )

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
cComponentReference	`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(cComponentReference,"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(< cComponentReference >,"HEIGHT", [ nHeight ])

Parâmetros

Nome	Tipo	Descrição	Obrigatório?
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(cComponentReference,"HEIGHT",200)

Número correspondente ao nível de azul da cor (B do RGB)

Expandir

title	SET HELP_NAME

Método SET: HELP_NAME

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

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_referencecComponentReference >,"BACKGROUNDHELP_COLORNAME",<[ Nível de vermelho >, < Nível de verde >, < Nível de azul >)

Parâmetros

cText ])

Parâmetros

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

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

.

Sim

Exemplo

Bloco de código

language	ruby
theme	Confluence
linenumbers	true

CALL _ADVPL_set_property(l_component_reference,"BACKGROUND_COLOR",255,0,0cComponentReference,"HELP_NAME","frm_toolbar_parent_name")

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 13

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