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


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



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

Parâmetros



NomeTipoDescriçãoObrigató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
languageruby
themeEclipse
linenumberstrue
LET componentReferencecComponentReference = _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(< componentReferencecComponentReference >,"CHANGE_EVENT ") ==> functionNamecFunctionName


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

Sim

Retorno



Tipo

Descrição

CODEBLOCK

CHAR

(advpl)

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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"CLICK_EVENT") ==> functionNamecFunctionName


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do formuláriocomponente.

Sim

Retorno



Tipo

Descrição

CODEBLOCK

(advpl)

CHAR

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

Exemplo



Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_click_event = _ADVPL_get_property(componentReferencecComponentReference,"CLICK_EVENT")




Expandir
titleGET COMPONENT_TYPE

Método GET: COMPONENT_TYPE

Tipo do componente.

Sintaxe



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


Parâmetros



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


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

Sim

Retorno



Tipo

Descrição

CODEBLOCK

(advpl)

CHAR

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(componentReference,"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(< componentReferencecComponentReference >,"EDITABLE") ==> lEditable


Parâmetros



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




Expandir
titleGET ENABLE

Método GET: ENABLE 

Retorna se o componente está habilitado.

Sintaxe



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


Parâmetros



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


Parâmetros



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


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
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
languageruby
themeEclipse
linenumberstrue
LET l_got_focus = _ADVPL_get_property(componentReferencecComponentReference,"GOT_FOCUS_EVENT")




Expandir
titleGET HANDLER

Método GET: HANDLER

Código nativo do componente ADVPL.

Sintaxe



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


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

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(componentReferencecComponentReference,"HANDLER")




Expandir
titleGET HEIGHT

Método GET: HEIGHT

Altura do componente em pixels.

Sintaxe



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


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

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


Parâmetros



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


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"PARENT_REFERENCE") ==> cParentRerence


Parâmetros



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

Parâmetros



componentReference
NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno




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

Tipo

Descrição

BOOLEAN

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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"SHOWRIGHT_CLICK_TOOLTIPEVENT") ==> lShowTooTipcFunctionName


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

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_right_showclick_tooltipevent = _ADVPL_get_property(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"SHOW_TOOLTIP") ==> cTextlShowTooTip


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

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


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

Sim


Retorno



Tipo

Descrição

CHAR
Função

Texto que é

executada para validar o conteúdo do componente quando este perder o foco

exibido 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(componentReferencecComponentReference,"VALIDTOOLTIP")




Valor que está definido para o componente
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(< componentReferencecComponentReference >,"VALUEVALID") ==> uValuecFunctionName


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

Sim


Retorno



Tipo

Descrição

ANY

CODEBLOCK (advpl)

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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"VISIBLEVALUE") ==> lVisibleuValue


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"WIDTHVISIBLE") ==> LarguralVisible


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

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(componentReferencecComponentReference,"WIDTHVISIBLE")




Expandir
titleGET XWIDTH

Método GET:

WIDTH 

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

Sintaxe



Bloco de código
_ADVPL_get_property(< componentReferencecComponentReference >,"XWIDTH") ==> nPosnWidth


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

Sim


Retorno



Tipo

Descrição

NUMERIC
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(componentReference,"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(< componentReferencecComponentReference >,"YX") ==> nPos


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference
CHAR

Referência do componente.

Sim


Retorno



Tipo

Descrição

NUMERIC
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(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"ALIGNY",< cAlign >)) ==> nPos


Parâmetros



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

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.


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 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
languageruby
themeConfluence
linenumberstrue
#-

(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 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,"ALIGNTITLE","CENTERTeste 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")
     ","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

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



NomeTipoDescriçãoObrigató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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_label_referencecComponentReference,"BACKGROUND_COLOR",0,255,255)
     CALL _ADVPL_set_property(l_dialog_reference,"MAXIMIZED",FALSE)
     CALL _ADVPL_set_property(l_dialog_reference,"ACTIVATE",TRUE) END FUNCTION255,0,0)




Número correspondente ao nível de verde da cor (G do RGB)
Expandir
titleSET BACKGROUND_COLORBOUNDS

Método SET:

BACKGROUND_COLOR 

BOUNDS 

Limite Cor de fundo do componente em RGB (Red, Green and Blue)(posição horizontal e vertical, altura e largura) em relação ao componente pai.

Sintaxe



Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"BACKGROUND_COLORBOUNDS",< nRed nXPos >, < nYPos > , < nGreennWidht >, < nBluenHeight >)

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference 
CHAR
Referência do componente.Sim
Nível de vermelho
nXPos
INTEGER
Número correspondente ao nível de vermelho da cor (R do RGB)
Posição em pixels do eixo X (horizontal) do componente.Sim
nYPos
INTEGER
Posição em pixels do eixo Y (vertical) do componente.Sim
Nível de verde
INTEGER
nWidht
INTEGER
Largura em pixels do componente.Sim
Nível de azul
nHeight
INTEGER
Número correspondente ao nível de azul da cor (B do RGB)
Altura em pixels do componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"BACKGROUND_COLORBOUNDS",10,25510,0320,0240)




Expandir
titleSET BOUNDSCAN_GOT_FOCUS

Método SET:

BOUNDS 

CAN_GOT_FOCUS

Define se o componente poderá ganhar focoLimite do componente (posição horizontal e vertical, altura e largura) em relação ao componente pai.

Sintaxe



Bloco de código
_ADVPL_set_property(< componentReference >,"BOUNDS",< nXPos >, < nYPos > , < nWidht >, < nHeight_set_property(< cComponentReference >,"CAN_GOT_FOCUS",< lCanGotFocus >)

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference 
CHAR
Referência do componente.Sim
nXPos
lCanGotFocus
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
BOOLEAN
Indicador que define se o componente poderá ganhar foco.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"BOUNDSCAN_GOT_FOCUS",10,10,320,240FALSE)




Indicador que define se o componente poderá ganhar foco
Expandir
titleSET CANCHANGE_GOT_FOCUSEVENT

Método SET:

CAN_GOT_FOCUS

CHANGE_EVENT     

Evento executado quando o valor do componente for alteradoDefine se o componente poderá ganhar foco.

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference 
CHAR
Referência do componente.Sim
lCanGotFocus
cFunctionName 
BOOLEAN
CHAR
Função executada quando o valor do componente for alterado.Sim

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"CHANGE_EVENT","CAN_GOT_FOCUS",FALSEjob0003_execucao_gatilho_select_all")




Expandir
titleSET CHANGECLICK_EVENT

Método SET:

CHANGE

CLICK_EVENT 

 

 

Evento executado quando o valor do componente for alteradoao clicar no componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< componentReferencecButtonReference > ,"CHANGECLICK_EVENT",< cFunctionName functionName >>)

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cButtonReference 
CHAR
Referência do componente.Sim
functionName
cFunctionName 
CHAR
Função executada
quando o valor do componente for alterado
ao clicar no componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecButtonReference,"CHANGECLICK_EVENT","job0003job0005_execucaostop_gatilhoprocess_select_allmonitor")




(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). 


Exemplo



Expandir
titleSET CLICK_EVENTCSS

Método SET:

CLICK_EVENT   

CSS  

Estilo CSS (Cascading Style Sheets) definido para o Evento executado ao clicar no componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< buttonReferencecComponentReference >,"CLICK_EVENTCSS",< functionNamecCodeCSS >)

Parâmetros



NomeTipoDescriçãoObrigatório?
buttonReference
cComponentReference CHARReferência
do
do componente.Sim
cCodeCSS
CHAR
Código CSS que será definido para o componente.Sim
functionName 
CHAR
Função executada ao clicar no componente.Sim
Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(m_button_stop_processcComponentReference,"CLICK_EVENTCSS","job0005_stop_process_monitorQPushButton { background-image: url(rpo:BTPESQ.PNG); }")




(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 CSSDOUBLE_CLICK_EVENT

Método SET:

CSS  

DOUBLE_CLICK_EVENT  

Evento executado ao efetuar um duplo clique no Estilo CSS (Cascading Style Sheets) definido para o componente.

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference
CHARReferência do componente.Sim
codeCSS
CHAR
Código CSS que será definido para o componente.Sim
cFunctionName
CHAR
Função executada ao efetuar um duplo clique no componente.Sim

Exemplo



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




Função executada ao efetuar um duplo clique no componente
Expandir
titleSET DOUBLE_CLICK_EVENTEDITABLE

Método SET:

DOUBLE_CLICK_EVENT  

EDITABLE

Habilita ou desabilita a edição do Evento executado ao efetuar um duplo clique no componente.

Sintaxe



Bloco de código
_ADVPL_set_property(< treeReferencecComponentReference >,"DOUBLE_CLICK_EVENTEDITABLE",< functionNamelEditable >)

Parâmetros



NomeTipoDescriçãoObrigatório?
treeReference
cComponentReference 
CHAR
Referência do componente.Sim
functionName
lEditable
CHAR
BOOLEAN
Indicador que define se o componente será editável.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(m_tree_parametercComponentReference,"DOUBLE_CLICK_EVENTEDITABLE","job0003_parametros_update_variable"FALSE)




Expandir
titleSET EDITABLEENABLE

Método SET:

EDITABLE

ENABLE

Habilita ou desabilita a edição do o componente.

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference cComponentReference 
CHAR
Referência do componente.Sim
lEditablelEnable
BOOLEAN
Indicador que define se o componente será editávelhabilitado.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(componentReferencecComponentReference,"EDITABLEENABLE",FALSE)




Expandir
titleSET ENABLEFONT

Método SET:

ENABLE

FONT 

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference 
CHAR
Referência do componente.Sim
lEnable
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
componente
texto será
habilitado
itálico.
Sim
Não


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReference(cComponentReference,"FONT","ENABLE"Courier New",10,TRUE,FALSE)






lItalic
Expandir
titleSET FONTFORCE_GET_FOCUS

Método SET:

FONT 

FORCE_GET_FOCUS 

Força o foco para o Configurações de fonte utilizados para os textos do componente.

Sintaxe



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

Parâmetros

lForce ] )

Parâmetros



NomeTipoDescriçãoObrigatório?
cComponentReference 
CHAR
Referência do componente.Sim
lForce
NomeTipoDescriçãoObrigatório?
componentReference 
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
BOOLEAN
Indicador que define se
o texto será itálico
, caso o componente estiver em uma aba, esta também ganhe foco.Não


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"FONTFORCE_GET_FOCUS","Courier New",10,TRUE,FALSE)




Expandir
titleSET FORCEFOREGROUND_GET_FOCUSCOLOR

Método SET:

FORCE

FOREGROUND_

GET_FOCUS 

COLOR

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

Força o foco para o componente.

Sintaxe



Bloco de código
_ADVPL_set_property( < componentReferencecComponentReference >,"FORCEFOREGROUND_GET_FOCUS"COLOR", [ nRed ], [ lForcenGreen ], [ nBlue ])

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
CHAR
Referê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).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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReference,"FORCEFOREGROUND_GET_FOCUS",TRUECOLOR",255,0,0)




Número correspondente ao nível de vermelho da cor (R do RGB)
Expandir
titleSET FOREGROUNDGOT_FOCUS_COLOREVENT

Método SET:

FOREGROUND

GOT_FOCUS_

COLOR

EVENT 

Evento executado quando o componente ganhar foco

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference
CHAR
Referência do componente.Sim
nRed
cFunctionName
INTEGER
CHAR
Função executada quando o componente ganhar foco.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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"FOREGROUNDGOT_FOCUS_COLOR",255,0,0EVENT", "eai100001_got_focus_event_mensagem")




Função executada quando o componente ganhar foco
Expandir
titleSET GOT_FOCUS_EVENTHEIGHT

Método SET:

GOT_FOCUS_EVENT 

HEIGHT

Altura do componente em pixelsEvento executado quando o componente ganhar foco.

Sintaxe



Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"GOT_FOCUS_EVENTHEIGHT", <[ functionNamenHeight > ])

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference
cComponentReference 
CHAR
Referência do componente.Sim
functionName
nHeight
CHAR
INTEGER
Altura em pixels do componente.Sim


Exemplo



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




Altura em pixels
Expandir
titleSET HEIGHTHELP_NAME

Método SET:

HEIGHT

HELP_NAME

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

Sintaxe



Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"HEIGHTHELP_NAME", [ nHeightcText ])

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference 
CHAR
Referência do componente.Sim
nHeight
cText
INTEGER
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(componentReferencecComponentReference,"HEIGHTHELP_NAME",200"frm_toolbar_parent_name")




Expandir
titleSET HELP_NAMEHOTKEY

Método SET:

HELP_NAME

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(< componentReferencecComponentReference >, "HELP_NAME",[ cText ]HOTKEY",< cKey >,< functioName >,< cDescription >,< lOnlyExecuteOnFocus >)

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference
cComponentReference CHARReferência do componente.Sim
cKey
CHAR
Tecla de atalho conforme teclas disponíveis na lista de teclas de atalhos.Sim
cText
functionNameCHAR
Texto que será identificado na URL da ajuda online do componente.Sim
Funçã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.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"HOTKEY","HELP_NAMEF4","frm_toolbar_parent_name"Zoom de empresas.",TRUE)




Expandir
titleSET HOTKEY LOST_FOCUS_EVENT

Método SET:

HOTKEY 

LOST_FOCUS_EVENT

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

Sintaxe



Bloco de código
_ADVPL_set_property(< componentReference >cComponentReference>, "HOTKEY",< cKey >,< functioName >,< cDescription >"LOST_FOCUS_EVENT",< lOnlyExecuteOnFocuscFunctionName >)

Parâmetros



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

quando o componente perder seu foco.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"HOTKEYLOST_FOCUS_EVENT","F4","Zoom de empresas.",TRUElog08100_zoom_tabela")




Expandir
titleSET LOST_FOCUS_EVENTPOSITION

Método SET:

LOST_FOCUS_EVENT

POSITION

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

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
l_textfield cComponentReference CHARReferência do componente.Sim
nXPos
INTEGER
Posição em pixels do eixo X (horizontal) do componente.Sim
cFunctionNamenYPos
CHAR
INTEGERPosição em pixels do eixo Y (vertical) do componenteFunção executada quando o componente perder seu foco.Sim


Exemplo



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




Expandir
titleSET POSITIONPROPERTY

Método SET:

POSITION

PROPERTY

Atribui novas propriedades para o componentePosiçã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 ], PROPERTY",[ nYPoscProperties ])

Parâmetros



INTEGER
NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference 
CHAR
Referência do componente.Sim
nXPos
cProperties
INTEGER
CHAR
Texto com as propriedades que serão atribuídas para o Posição em pixels do eixo X (horizontal) do componente.SimnYPosPosição em pixels do eixo Y (vertical) do componente.Sim


Exemplo



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




Expandir
titleSET PROPERTYREFRESH_SIZE

Método SET:

PROPERTY

REFRESH_SIZE

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

Sintaxe



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

Parâmetros

NomeTipoDescriçãoObrigatório?
componentReference 
CHAR
Referência do componente.Sim
cProperties
CHAR
Texto com as propriedades que serão atribuídas para o componente.Sim
REFRESH_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(componentReferencecComponentReference,"PROPERTY","{'PICTURE','@!'}{'LENGTH',10}"REFRESH_SIZE")




Expandir
titleSET REFRESHREMOVE_SIZEVARIABLES

Método SET:

REFRESH

REMOVE_

SIZE

VARIABLES

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

Sintaxe



Bloco de código
_ADVPL_set_property(< componentReferencecComponentReference >,"REFRESHREMOVE_SIZE")
(informação) Esta função atualiza as propriedades de coordenadas do componente (X, Y, WIDTH e HEIGHT).
VARIABLES")

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"REFRESHREMOVE_SIZEVARIABLES")




Expandir
titleSET REMOVE_VARIABLESREQUIRED

Método SET: 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 definida

Método SET: REMOVE_VARIABLES

Remove as variáveis definidas para o componente.

Sintaxe



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

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"REMOVE_VARIABLESREQUIRED",TRUE)




Expandir
titleSET 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(< 
componentReference
cComponentReference >,"RIGHT_CLICK_EVENT",< 
Função
cFunctionName >)


Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference
cComponentReference
CHAR
Referência do componente
SIM
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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(
l_node_ativid_end
cComponentReference,"RIGHT_CLICK_EVENT","sup2033_marca_desmarca_nos")




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



NomeTipoDescriçãoObrigató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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"SAVE_IMAGE","C:\\totvs\\temp\\component_image.bmp")




Expandir
titleSET SHOW_TOOLTIP

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



NomeTipoDescriçãoObrigató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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"SHOW_TOOLTIP",FALSE)




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



NomeTipoDescriçãoObrigató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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"SIZE",640,480)




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



NomeTipoDescriçãoObrigatório?
componentReference CHARReferê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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"TOOLTIP","Código da empresa corrente.")




Expandir
titleSET 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",< functionNamecFunctionName >)

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference cComponentReference 
CHAR
Referência do componente.Sim
functionNamecFunctionName
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.




Expandir
titleSET VALUE

Método SET: VALUE

Valor definido para o componente.

Sintaxe



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

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference
cComponentReference 
CHAR
Referência do componente.Sim
 
uValue
ANY
Valor que será definido para o componente.Sim


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"VALUE",10)




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



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

(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.

Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReference,"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(< componentReferencecComponentReference >,"VARIABLE",< lVisible >)

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReference 
cComponentReference 
CHAR
Referência do componente.Sim
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(componentReferencecComponentReference,"VISIBLE",FALSE)




Expandir
titleSET WIDTH

Método SET: WIDTH

Largura do componente em pixels.

Sintaxe



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

|

Parâmetros



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


Exemplo



Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"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(< componentReferencecComponentReference >,"X",< nPos >)

|

Parâmetros



NomeTipoDescriçãoObrigatório?
componentReferencecComponentReference CHARReferência do componente.Sim
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(componentReferencecComponentReference,"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(componentReferencecComponentReference,"Y",< nPos >)

|

Parâmetros



NomeTipoDescriçãoObrigató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
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(componentReferencecComponentReference,"Y",10)