Páginas filhas
  • LGX - LCOMPONENT

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

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



Métodos GET


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


Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_align = _ADVPL_get_property(l_component_referencecComponentReference,"ALIGN")




Expandir
titleGET 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



NomeTipoDescriçãoObrigatório?
m_form_referencecComponentReference
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
languageruby
themeEclipse
linenumberstrue
LET l_component_referencecComponentReference = _ADVPL_get_property(m_form_reference,"CAN_GOT_FOCUS ")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_change_event = _ADVPL_get_property(l_component_referencecComponentReference,"CHANGE_EVENT")




Expandir
titleGET 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



NomeTipoDescriçãoObrigatório?
l_form_referencecComponentReference
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
languageruby
themeEclipse
linenumberstrue
LET l_click_event = _ADVPL_get_property(l_component_referencecComponentReference,"CLICK_EVENT")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_component_type = _ADVPL_get_property(l_component_referencecComponentReference,"COMPONENT_TYPE")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_double_click_event = _ADVPL_get_property(l_component_referencecomponentReference,"DOUBLE_CLICK_EVENT")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_editable = _ADVPL_get_property(l_component_referencecComponentReference,"EDITABLE")




Expandir
titleGET ENABLE

Método GET: ENABLE 

Retorna se o componente está habilitado.

Sintaxe



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


Parâmetros



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_enable = _ADVPL_get_property(l_component_referencecComponentReference,"ENABLE")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_form_reference = _ADVPL_get_property(l_component_referencecComponentReference,"FORM_REFERENCE")




Expandir
titleGET 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



NomeTipoDescriçãoObrigatório?
l_form_referencecComponentReference
CHAR

Referência do formuláriocomponente.

Sim


Retorno



Tipo

Descrição

CODEBLOCK

(advpl)

CHAR

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

Exemplo



Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_got_focus = _ADVPL_get_property(l_component_referencecComponentReference,"GOT_FOCUS_EVENT")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_hadler = _ADVPL_get_property(l_component_referencecComponentReference,"HANDLER")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_height = _ADVPL_get_property(l_component_referencecComponentReference,"HEIGHT")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_help_name = _ADVPL_get_property(l_component_referencecomponentReference,"HELP_NAME")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_lost_focus = _ADVPL_get_property(l_component_referencecComponentReference,"LOST_FOCUS_EVENT")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_parent_reference = _ADVPL_get_property(l_component_referencecComponentReference,"PARENT_REFERENCE")




Expandir
titleGET RIGHT_CLICK_EVENT REQUIRED

Método GET:

RIGHT_CLICK_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_EVENTREQUIRED") ==> FunçãolRequired

Parâmetros



l_form_reference formulário
NomeTipoDescriçãoObrigató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
languageruby
themeEclipseConfluence
linenumberstrue
LET l_right_click_eventrequired = _ADVPL_getset_property(l_component_referencecComponentReference,"RIGHT_CLICK_EVENTREQUIRED")




Expandir
titleGET 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



NomeTipoDescriçãoObrigatório?
l_form_referencecComponentReference
CHAR

Referência do formuláriocomponente.

Sim


Retorno



Tipo

Descrição

CODEBLOCK

BOOLEAN

(advpl)

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

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

Exemplo



Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_showright_click_tooltipevent = _ADVPL_get_property(l_component_referencecComponentReference,"SHOWRIGHT_CLICK_TOOLTIPEVENT")




Expandir
titleGET SHOW_TOOLTIP

Método 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_show_tooltip = _ADVPL_get_property(l_component_referencecComponentReference,"SHOW_TOOLTIP")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_validtooltip = _ADVPL_get_property(l_component_referencecComponentReference,"VALIDTOOLTIP")




Expandir
titleGET VALUEVALID

Método GET:

VALUE  

VALID 

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

(aviso) Esta propriedade somente é válida pra uso em código ADVPLValor definido para o componente.

Sintaxe



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


Parâmetros



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_valuevalid = _ADVPL_get_property(l_component_referencecComponentReference,"VALUEVALID")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_visiblevalue = _ADVPL_get_property(l_component_referencecComponentReference,"VISIBLEVALUE")




Expandir
titleGET 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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_widthvisible = _ADVPL_get_property(l_component_referencecComponentReference,"WIDTHVISIBLE")




Expandir
titleGET XWIDTH

Método GET:

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_referencecComponentReference >,"XWIDTH") ==> Posição do eixo X (Horizontal)nWidth


Parâmetros



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET l_xwidth = _ADVPL_get_property(l_component_referencecomponentReference,"XWIDTH")




Expandir
titleGET YX

Método GET:

Y

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



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
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.





Retorno



Expandir
titleSET 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



NomeTipoDescriçãoObrigatório?
l_label_reference
cComponentReference
CHAR

Referência do componente.

Sim
alinhamento
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

Tipo

Descrição

INTEGER

Posição em pixels do eixo Y do componente.

Exemplo



Bloco de código
languageruby
themeEclipse
linenumberstrue
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.


Método SET: BACKGROUND_COLOR 

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

Sintaxe

Expandir
titleSET 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



NomeTipoDescriçãoObrigató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

(informação) Importante: Cada tipo de alinhamento possui um comportamento diferente, conforme descrito abaixo para cada tipo de alinhamento:

  • TOP: ocupa a largura

(informação) 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 altura do componente.
  • CENTERLEFTocupa todo o espaço útil 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
languageruby
themeConfluence
linenumberstrue
#---------------------# 
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
titleSET BACKGROUND_COLOR
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

NomeTipoDescriçãoObrigatório?l_component_reference CHARReferência do componente.SimNível de vermelho
INTEGER
Número correspondente ao nível de vermelho da cor (R do RGB).SimNível de verdeINTEGERNúmero correspondente ao nível de verde da cor (G do RGB).SimNível de azulINTEGERNúmero correspondente ao nível de azul da cor (B do RGB).Sim

Exemplo

Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"BACKGROUND_COLOR",255,0,0)
Expandir
titleSET 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

NomeTipoDescriçãoObrigatório?l_component_reference CHARReferência do componente.SimEixo X (Horizontal)
INTEGER
Posição em pixels do eixo X do componente.SimEixo Y (Vertical)
INTEGER
Posição em pixels do eixo Y do componente.SimLarguraINTEGERLargura em pixels do componente.SimAlturaINTEGERAltura em pixels do componente.Sim

Exemplo

Bloco de código
languageruby
themeConfluence
linenumberstrue
,"ALIGN","BOTTOM")
     CALL _ADVPL_set_property(l_componentlabel_reference,"BOUNDS",10,10,320,240)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
titleSET CANBACKGROUND_GOT_FOCUSCOLOR

Método SET:

CAN

BACKGROUND_

GOT_FOCUS

COLOR 

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

Define se o componente poderá ganhar foco.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"CANBACKGROUND_GOT_FOCUS",< Permite ganhar foco?COLOR",< nRed >, < nGreen >, < nBlue >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference CHARReferência do componente.Sim
?
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)Permite ganhar foco?
BOOLEAN
Indicador que define se o componente poderá ganhar foco.Sim

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"CANBACKGROUND_GOT_FOCUSCOLOR",255,FALSE0,0)

======> Cleane, Verificar!




Referência
Expandir
titleSET CHANGE_EVENTBOUNDS

Método SET: BOUNDS 

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

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_referencecComponentReference > ,"CHANGE_EVENT",< Função >)

Parâmetros

BOUNDS",< nXPos >, < nYPos > , < nWidht >, < nHeight >)

Parâmetros



NomeTipoDescriçãoObrigató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
NomeTipoDescriçãoObrigatório?
l_component_reference CHAR
do componente.Sim
 Função 
nHeight
CHAR
Função executada quando o valor
INTEGER
Altura em pixels do componente
for alterado
.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"CHANGE_EVENT","job0003_execucao_gatilho_select_all")BOUNDS",10,10,320,240)




======> Cleane, Verificar!

Função executada ao clicar no componente
Expandir
titleSET CLICKCAN_GOT_EVENTFOCUS

Método SET:

CLICK_EVENT    ======> Cleane, Verificar!

CAN_GOT_FOCUS

Define se o componente poderá ganhar focoEvento executado ao clicar no componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< m_button_referencecComponentReference >,"CLICKCAN_GOT_EVENTFOCUS",< FunçãolCanGotFocus >)

Parâmetros



NomeTipoDescriçãoObrigatório?
 m_button_reference 
cComponentReference 
CHAR
Referência do componente.Sim
Função
lCanGotFocus
CHAR
BOOLEAN
Indicador que define se o componente poderá ganhar foco.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(m_button_stop_processcComponentReference,"CLICKCAN_GOT_EVENTFOCUS","job0005_stop_process_monitor"FALSE)




(informação)  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). 
Expandir
titleSET CSSCHANGE_EVENT

Método SET:

CSS  

CHANGE_EVENT     

Evento executado quando o valor do componente for alteradoEstilo CSS (Cascading Style Sheets) definido para o componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference > ,"CSSCHANGE_EVENT",< CodcFunctionName CSS >)

Parâmetros



NomeTipoDescriçãoObrigatório?
cComponentReference 
l_component_reference 
CHAR
Referência do componente.Sim
Cod CSS
cFunctionName 
CHAR
Código CSS que será definido para o componente.Sim
Função executada quando o valor do componente for alterado.Sim

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"CSS","QPushButton { background-image: url(rpo:BTPESQ.PNG); }CHANGE_EVENT","job0003_execucao_gatilho_select_all")




(informação) 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
titleSET DOUBLE_ CLICK_EVENT

Método SET:

DOUBLE_

CLICK_

EVENT

EVENT   

Evento executado ao efetuar um duplo clique clicar no componente.

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
m_tree_parameter
cButtonReference 
CHAR
Referência do componente.Sim
Função
cFunctionName 
CHAR
Função executada
ao efetuar um duplo clique no componente.
Sim
ao clicar no componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(m_tree_parametercButtonReference,"DOUBLE_CLICK_EVENT","job0003job0005_parametrosstop_updateprocess_variablemonitor")




Expandir
titleSET EDITABLECSS

Método SET:

EDITABLE

CSS  

Estilo CSS (Cascading Style Sheets) definido para o Habilita ou desabilita a edição do componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"EDITABLECSS",< Editável?cCodeCSS >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_referencecComponentReference CHARReferência do componente.Sim
Editável?
BOOLEAN
Indicador que define se o componente será editável.Sim
cCodeCSS
CHAR
Código CSS que será definido para o componente.Sim

(informação)  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). (informação) Independente se o componente é editável ou não, este sempre ganhará foco.


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"EDITABLE",FALSECSS","QPushButton { background-image: url(rpo:BTPESQ.PNG); }")




Indicador que define se o componente será habilitado
Expandir
titleSET ENABLEDOUBLE_CLICK_EVENT

Método SET:

ENABLE

DOUBLE_CLICK_EVENT  

Evento executado ao efetuar um duplo clique no Habilita ou desabilita o componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"ENABLEDOUBLE_CLICK_EVENT",< Habilita?cFunctionName >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference
CHARReferência do componente.Sim
Habilita?
cFunctionName
BOOLEAN
CHAR
Função executada ao efetuar um duplo clique no componente.Sim

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"ENABLE",FALSEcComponentReference,"DOUBLE_CLICK_EVENT","job0003_parametros_update_variable")




Expandir
titleSET FONTEDITABLE

Método SET:

FONT 

EDITABLE

Habilita ou desabilita a edição Configurações de fonte utilizados para os textos do componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_reference >,"FONT", [ Fonte], [ Tamanho], [ Negrito?], [ Itálico?]< cComponentReference >,"EDITABLE",< lEditable >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
Tamanho
INTEGER 
Tamanho do fonte que será utilizado.Negrito?
cComponentReference 
CHAR
Referência do componente.Sim
Fonte
CHAR
Nome do fonte que será utilizado pelo componente.
lEditable
BOOLEAN
Indicador que define se o
texto
componente será
negrito
editável.
Itálico?BOOLEANIndicador que define se o texto será itálico
Sim

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

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"FONT","Courier New",10,TRUEEDITABLE",FALSE)




Expandir
titleSET FORCE_GET_FOCUSENABLE

Método SET:

FORCE_GET_FOCUS 

ENABLE

Habilita ou desabilita o Força o foco para o componente.

Sintaxe



Bloco de código
_ADVPL_set_property( < l_component_referencecComponentReference > ,"FORCE_GET_FOCUSENABLE",[ Força< focolEnable na> aba?])

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
Força foco na aba?
lEnable
BOOLEAN
Indicador que define se , caso o componente estiver em uma aba, esta também ganhe foco.será habilitado.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"FORCE_GET_FOCUSENABLE",TRUEFALSE)




Expandir
titleSET FOREGROUND_COLORFONT

Método SET:

FOREGROUND_COLOR

FONT 

Configurações de fonte utilizados para os textos do componenteCor da fonte do componente em RGB (Red, Green and Blue).

Sintaxe



Bloco de código
_ADVPL_set_property( < l_component_referencecComponentReference > ,"FOREGROUND_COLORFONT", [ Nível de vermelhocFont ], [ nLength ], [ NívellBold de verde], [ Nível delItalic azul])

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
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 azulINTEGERNúmero correspondente ao nível de azul da cor (B do RGB).
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
Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"FOREGROUND_COLOR",255,0,0cComponentReference,"FONT","Courier New",10,TRUE,FALSE)






Expandir
titleSET GOTFORCE_GET_FOCUS_EVENT

Método SET:

GOT

FORCE_

FOCUS

GET_

EVENT 

FOCUS 

Força o foco para

Evento executado quando o componente ganhar foco.

Sintaxe



Bloco de código
_ADVPL_set_property( < l_grid_referencecComponentReference >,"GOTFORCE_GET_FOCUS_EVENT",< Função > [ lForce ] )

Parâmetros



NomeTipoDescriçãoObrigatório?
l_grid_reference 
cComponentReference 
CHAR
Referência do componente.Sim
 Função
lForce
CHAR
BOOLEAN
Indicador que define se, caso o componente estiver em uma aba, esta também ganhe Função executada quando o componente ganhar foco.SimNão


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_grid_referencecComponentReference,"GOTFORCE_GET_FOCUS_EVENT", "eai100001_got_focus_event_mensagem"TRUE)




Expandir
titleSET HEIGHTFOREGROUND_COLOR

Método SET:

HEIGHT

FOREGROUND_COLOR

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
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
  Altura 
nBlue
INTEGER
Altura
em pixels do componenteNúmero correspondente ao nível de azul da cor (B do RGB).Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecomponentReference,"HEIGHT",200FOREGROUND_COLOR",255,0,0)




Expandir
titleSET HELPGOT_FOCUS_NAMEEVENT

Método SET:

HELP

GOT_FOCUS_

NAME

EVENT 

Evento executado quando o componente ganhar foco

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

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_namecComponentReference >,"HELPGOT_FOCUS_NAMEEVENT",[ Texto ] < cFunctionName > )

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_name 
cComponentReference
CHAR
Referência do componente.Sim
   Texto 
cFunctionName
CHAR
Texto que será identificado na URL da ajuda online do componente
Função executada quando o componente ganhar foco.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_namecComponentReference,"HELPGOT_FOCUS_NAMEEVENT", "frmeai100001_got_toolbarfocus_parentevent_namemensagem")




Expandir
titleSET HOTKEY HEIGHT

Método SET:

HOTKEY 

HEIGHT

Altura do componente em pixelsTecla de atalho definida para o componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >, "HOTKEYHEIGHT",< tecla[ >,< função >,< descrição >,< Executa somente em foco? >nHeight ])

Parâmetros



componente
NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
nHeight
INTEGER
Altura em pixels do componente.Sim
tecla
CHAR
Tecla de atalho conforme teclas disponíveis na lista de teclas de atalhos.Sim
funçãoCHARFunção que será executada ao acionar a tecla de atalho.Sim
descriçãoCHARDescriçã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


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cComponentReference,"HEIGHT",200)




(informação) Para acessar a lista de teclas de atalhos válidas disponíveis, clique aqui.
Expandir
titleSET 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(< cComponentReference >,"HELP_NAME",[ cText ])

Parâmetros



NomeTipoDescriçãoObrigatório?
cComponentReference 
CHAR
Referência do componente
do qual pertence a tecla de atalho
.Sim
Executa somente em foco?BOOLEANIndicador 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
cText
CHAR
Texto que será identificado na URL da ajuda online do componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"HOTKEYHELP_NAME","F4","Zoom de empresas.",TRUEfrm_toolbar_parent_name")




Expandir
titleSET LOST_FOCUS_EVENTHOTKEY

Método SET:

LOST_FOCUS_EVENT

HOTKEY 

Tecla de atalho definida para o Código do campo a ser identificado na ajuda online do componente.

Sintaxe



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

Parâmetros

NomeTipoDescriçãoObrigatório?
l_textfield CHARReferência do componente.Sim
   Função
CHAR
Função executada quando o componente perder seu foco.
HOTKEY",< cKey >,< functioName >,< cDescription >,< lOnlyExecuteOnFocus >)

Parâmetros



NomeTipoDescriçãoObrigatório?
cComponentReference CHARReferência do componente.Sim
cKey
CHAR
Tecla de atalho conforme teclas disponíveis na lista de teclas de atalhos.Sim
functionNameCHARFunção que será executada ao acionar a tecla de atalho.Sim
cDescriptionCHARDescriçã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
lOnlyExecuteOnFocusBOOLEANIndicador 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

(informação) Para acessar a lista de teclas de atalhos válidas disponíveis, clique aqui.

Sim

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_textfieldcComponentReference,"HOTKEY","LOST_FOCUS_EVENTF4","log08100_zoom_tabela"Zoom de empresas.",TRUE)




Expandir
titleSET POSITIONLOST_FOCUS_EVENT

Método SET:

POSITION

LOST_FOCUS_EVENT

Código do campo a ser identificado na ajuda online do componentePosição (horizontal e vertical) em pixels do componente em relação ao componente pai.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_reference >,"POSITION",[ Eixo X (Horizontal)], [ Eixo Y (Vertical)])cComponentReference>,"LOST_FOCUS_EVENT",< cFunctionName >)

Parâmetros



NomeTipoDescriçãoObrigatório?
cComponentReference
l_component_reference 
CHAR
Referência do componente.Sim
cFunctionName
CHAR
Função executada quando o componente perder seu focoEixo X (Horizontal)
INTEGER
Posição em pixels do eixo X do componente.SimEixo Y (Vertical)INTEGERPosição em pixels do eixo Y do componente.


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"POSITION",05,10cComponentReference,"LOST_FOCUS_EVENT","log08100_zoom_tabela")




Expandir
titleSET PROPERTYPOSITION

Método SET:

PROPERTY

POSITION

Posição (horizontal e vertical) em pixels do componente em relação ao componente paiAtribui novas propriedades para o componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"PROPERTY","POSITION",[ nXPos ], [ PropriedadesnYPos ])

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_referencecComponentReference CHARReferência do componente.Sim
nXPos
INTEGER
Posição em pixels do eixo X (horizontal) do componente.Sim
nYPos
INTEGERPosição em pixels do eixo Y (vertical) do  Propriedades 
CHAR
Texto com as propriedades que serão atribuídas para o componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"PROPERTYPOSITION","{'PICTURE','@!'}{'LENGTH',10}"05,10)




Expandir
titleSET REFRESH_SIZEPROPERTY

Método SET:

REFRESH_SIZE

PROPERTY

Atribui novas propriedades para o componente.Atualiza as propriedades de coordenadas do componente (posição e tamanho)

Sintaxe



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

Parâmetros

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


NomeTipoDescriçãoObrigatório?
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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"REFRESH_SIZEcComponentReference,"PROPERTY","{'PICTURE','@!'}{'LENGTH',10}")




Expandir
titleSET REMOVEREFRESH_VARIABLESSIZE

Método SET:

REMOVE

REFRESH_

VARIABLES

SIZE

Remove as variáveis definidas para o componente.Atualiza as propriedades de coordenadas do componente (posição e tamanho)

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"REMOVEREFRESH_VARIABLES")SIZE")


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


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"REMOVEREFRESH_VARIABLESSIZE")




========> Cleane, verificar!

Expandir
titleSET RIGHTREMOVE_CLICK_EVENTVARIABLES

Método SET: REMOVE_VARIABLES

Remove as variáveis definidas para o

Método SET: RIGHT_CLICK_EVENT   ========> Cleane, verificar!

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

Sintaxe



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

Parâmetros

NomeTipoDescriçãoObrigatório?
l_component_reference CHARReferência do componente.Sim
  Função 
CHAR
Função executada ao efetuar um clique com o botão direito do mouse no componente.Sim
VARIABLES")

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstruetrue
CALL _ADVPL_set_property(cComponentReference,"REMOVE_VARIABLES")IF cName == "RIGHT_CLICK_EVENT"
        RETURN ::bRightClick




Exemplo



Expandir
titleSET SAVE_IMAGEREQUIRED

Método SET:

SAVE_IMAGE

REQUIRED

Permite apenas registrar o indicador de obrigatoriedade de conteúdo do componente. 

(aviso) Esta propriedade pode ser utilizada para obrigar usuário informar conteúdo, no entanto, essa validação não ocorre de forma automática. Neste caso é preciso implementar uma ação de VALID para o componente ou janela de diálogo, ou então para um evento de CLICK de um botão para validar a obrigatoriedade de conteúdo do componente com base na propriedade REQUIRED definidaSalva uma imagem (print) do componente em uma imagem do tipo bitmap (BMP).

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"SAVE_IMAGEREQUIRED",< Caminho >)

Parâmetros

<nRequired>)
NomeTipoDescriçãoObrigatório?
l_component_reference CHARReferência do componente.Sim
  Função 
CHAR
Caminho completo onde será salva a imagem do componente.Sim
Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"SAVE_IMAGE","C:\\totvs\\temp\\component_image.bmp"_property(cComponentReference,"REQUIRED",TRUE)




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
Expandir
titleSET SHOWRIGHT_CLICK_TOOLTIPEVENT

Método SET:

SHOW_TOOLTIP

 RIGHT_CLICK_EVENT  

Evento executado ao efetuar um clique com o botão direito do mouse no componenteDefine 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(< l_component_referencecComponentReference >,"SHOWRIGHT_CLICK_TOOLTIPEVENT",< Exibe texto de ajuda? cFunctionName >)


Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference
CHAR
Referência do componente
.
Sim  Exibe texto de ajuda?
BOOLEAN
Sim
cfunctionName
CHAR
Função executada ao efetuar um clique com o botão direito do mouse no componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"SHOW_TOOLTIP",FALSEcComponentReference,"RIGHT_CLICK_EVENT","sup2033_marca_desmarca_nos")




Expandir
titleSET SIZESAVE_IMAGE

Método SET:

SIZE

SAVE_IMAGE

Salva uma imagem (print) do componente em uma imagem do tipo bitmap (BMP)Tamanho (largura e altura) em pixels do componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"SIZE",< Largura >, < AlturaSAVE_IMAGE",< cPath >)

Parâmetros



Altura
NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
Largura
cPath
INTEGER
CHAR
Caminho completo onde será salva a imagem Largura em pixels do componente.SimINTEGERAltura em pixels do componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"SIZE",640,480cComponentReference,"SAVE_IMAGE","C:\\totvs\\temp\\component_image.bmp")




Expandir
titleSET SHOW_TOOLTIP

Método SET: SHOW_TOOLTIP

Texto 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(< l_component_referencecComponentReference >,"SHOW_TOOLTIP",< TextolShowToolTip >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
 Texto 
lShowToolTip
CHAR
BOOLEAN
Texto
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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"SHOW_TOOLTIP","Código da empresa corrente."FALSE)




Texto que será exibido quando o usuário posicionar o cursor do mouse em cima
Expandir
titleSET TOOLTIPSIZE

Método SET:

TOOLTIP

SIZE

Tamanho (largura e altura) em pixels 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(< l_component_referencecComponentReference >,"TOOLTIPSIZE",< TextonWidth >, < nHeight >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
 Texto 
nWidth
CHAR
INTEGER
Largura em pixels do componente.Sim
nHeight
INTEGER
Altura em pixels do componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"TOOLTIPSIZE","Código da empresa corrente.",640,480)




Expandir
titleSET VALIDTOOLTIP

Método SET:

VALID

TOOLTIP

Texto de ajuda exibido quando o usuário posicionar o cursor do mouse em cima do componenteEvento executado para validar o conteúdo do componente quando este perder seu foco.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"VALIDTOOLTIP",< FunçãocText >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_referencecomponentReference CHARReferência do componente.Sim
cText
CHAR
Texto que será exibido quando o usuário posicionar o cursor do mouse em cima Referência do componente.Sim
 Função
CHAR
Função executada para validar o conteúdo do componente quando este perder o foco.Sim

(informação) 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.

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


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cComponentReference,"TOOLTIP","Código da empresa corrente.")




Exemplo

Expandir
titleSET VALUEVALID

Método SET:

VALUE

VALID

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

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"VALUEVALID",< ValorcFunctionName >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
cFunctionName
CHAR
Função executada para validar o conteúdo do componente
.
Sim
 Valor
CHAR
Valor que será definido para o componente.Sim
Bloco de código
languageruby
themeConfluence
linenumberstrue
quando este perder o foco.Sim

(informação) 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.

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

CALL _ADVPL_set_property(l_component_reference,"VALUE",10)




(informaçã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.
Expandir
titleSET VARIABLEVALUE

Método SET:

VARIABLE

VALUE

Valor definido para o Adiciona uma variável que será controlada pelo componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"VARIABLE",< Record >, VALUE",< VariáveluValue >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference
cComponentReference 
CHAR
Referência do componente.Sim
Record 
uValue
OBJECT
ANY
Record 4GL que contém a variável de controle do
Valor que será definido para o componente.Sim
VariávelCHARNome da variável do Record 4GL que controlará o componente.


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"VARIABLE",mr_tela,"cod_item"_property(cComponentReference,"VALUE",10)




Expandir
titleSET VISIBLEVARIABLE

Método SET:

VISIBLE

VARIABLE

Adiciona uma variável que será controlada pelo Habilita ou desabilita a visualização do componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"VARIABLE",< Visível? record4GL >, < cVariableName >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
record4GL 
OBJECT
Record 4GL que contém a variável de controle do componente.Sim
Visível?
cVariableName
BOOLEAN
Indicador que define se o componente será visível.Sim
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

(informaçã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 (informação) Mesmo o componente sendo invisível, o espaço ocupado pelo mesmo continuará em tela.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_reference,"VISIBLE",FALSEcomponentReference,"VARIABLE",mr_tela,"cod_item")




Expandir
titleSET VISIBLE

Método SET: VISIBLE

Habilita ou desabilita a visualização do componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"VARIABLE",< Visível?lVisible >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
Visível?
lVisible
BOOLEAN
Indicador que define se o componente será visível.Sim

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

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"VISIBLE",FALSE)




Expandir
titleSET WIDTH

Método SET: WIDTH

Largura do componente em pixels.

Sintaxe



Bloco de código
_ADVPL_set_property(< l_component_referencecComponentReference >,"WIDTH",< LarguranWidth >)

|

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_reference 
cComponentReference 
CHAR
Referência do componente.Sim
 Largura 
nWidth
INTEGER
Largura em pixels do componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"WIDTH",250)




Expandir
titleSET 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(l_component_reference< cComponentReference >,"X",< Posição do eixo X (Horizontal)nPos >)

|

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_referencecComponentReference CHARReferência do componente.Sim
Posição do eixo X (Horizontal)nPos
INTEGER
Posição em pixels do eixo X (horizontal) do componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"X",10)




Expandir
titleSET 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(l_component_referencecComponentReference,"Y",< Posição do eixo Y (Vertical)nPos >)

|

Parâmetros



NomeTipoDescriçãoObrigatório?
l_component_referencecComponentReference 
CHAR
Referência do componente.Sim
Posição do eixo Y (Vertical)
nPos
INTEGER
Posição em pixels do eixo Y (horizontal) do componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_component_referencecComponentReference,"Y",10)