Linha Logix

Páginas filhas
  • LGX - LCOMPONENT

Versões comparadas

Versão antiga 3

changes.mady.by.user Usuário desconhecido (ieda.alves)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Cleane Hermann

Gravado em

Chave

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

Pagetitle
LGX - LCOMPONENT
LGX - LCOMPONENTLFormLForm
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:

COMPONENT

CAN_GOT_FOCUS

_REFERENCE

Retorna se o componente poderá ganhar

Referência do componente em 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?
cComponentReferencel_form_reference
CHAR

Referência do formuláriocomponente.

Sim

Retorno


Tipo

Descrição

CHAR

CODEBLOCK

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

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

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

ENABLE 

Retorna se o componente está habilitado.

Sintaxe


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


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

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



Indicador que define se a janela da aplicação está maximizada
Expandir
titleGET MAXIMIZED HEIGHT

Método GET:

MAXIMIZED 

HEIGHT

Altura do componente em pixelsRetorna se a janela da aplicação está maximizada.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_referencecComponentReference >,"MAXIMIZEDENABLE") ==> Maximizada?nHeight


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR
l_form_reference
CHAR

Referência do formuláriocomponente.

Sim

Retorno


Tipo

Descrição

BOOLEAN
NUMERIC

Altura em pixels do componente.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_maximizedheight = _ADVPL_get_property(l_form_referencecComponentReference,"MAXIMIZEDHEIGHT")



Título da janela da aplicação
Expandir
titleGET TITLE HELP_NAME

Método GET:

TITLE

HELP_NAME

Código do campo a ser identificado na ajuda online do componenteTítulo da janela da aplicação.

Sintaxe


Bloco de código
_ADVPL_get_property(< l_form_referencecComponentReference >,"TITLEHELP_NAME") ==> TítulocText


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_referencecComponentReference
CHAR

Referência do formuláriocomponente.

Sim

Retorno


Tipo

Descrição

BOOLEAN
CHAR

Texto que identifica o componente na URL da ajuda online.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_titlehelp_name = _ADVPL_get_property(l_form_referencecomponentReference,"TITLEHELP_NAME")

Métodos SET

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



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

Exemplo

Retorno


Expandir
titleSET ACTIVATEGET LOST_FOCUS_EVENT

Método

SET: ACTIVATE

GET: LOST_FOCUS_EVENT

Evento executado quando o componente perder seu focoAtiva/Desativa a janela da aplicação.

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,"ACTIVATE", < l_status >)LOST_FOCUS_EVENT") ==> functionName


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

Sim
l_statusSMALLINT

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

   TRUE - Ativa o formulário

   FALSE - Desativa/Fecha o formulário.

Sim

Tipo

Descrição

CODEBLOCK

(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(cComponentReference,"LOST_FOCUS_EVENT"
Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"ACTIVATE",TRUE)



Expandir
titleSET CENTERGET PARENT_REFERENCE

Método

SET

GET:

CENTER

PARENT_REFERENCE

Referência do componente pai do componente atualCentraliza a janela da aplicação na área de trabalho do usuário.

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,"CENTERPARENT_REFERENCE") ==> cParentRerence


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

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

Retorno


Tipo

Descrição

CHAR

Referência do componente pai do componente atual.

Exemplo


Bloco de código
languageruby
themeConfluenceEclipse
linenumberstrue
CALLLET l_ADVPL_set_property(l_form_reference,"CENTERparent_reference = _ADVPL_get_property(cComponentReference,"PARENT_REFERENCE")



Expandir
titleSET CENTERED GET REQUIRED

Método

SET

GET:

CENTERED

REQUIRED

Define se a tela abrirá no centro da área de trabalho.Recupera se o componente tem conteúdo obrigatório ou não. 


Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,"CENTEREDREQUIRED",< l_status >)) => lRequired

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

Sim
l_status


Retorno



Tipo

Descrição

BOOLEAN

Indicador que define se

a tela será aberta no centro da área de trabalho do usuário

o conteúdo do componente é obrigatório ou não.

Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALLLET l_required = _ADVPL_set_property(l_form_referencecComponentReference,"CENTEREDREQUIRED",TRUE)



Sim


Retorno


Expandir
titleSET ENABLEGET RIGHT_ESCCLICK_CLOSEEVENT

Método

SET

GET:

ENABLE

RIGHT_

ESC

CLICK_

CLOSE

EVENT

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

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

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,"ENABLERIGHT_ESCCLICK_CLOSEEVENT",< l_status >)) ==> cFunctionName


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

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

Tipo

Descrição

CODEBLOCK

(advpl)

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

Exemplo


Bloco de código
languageruby
themeConfluenceEclipse
linenumberstrue
CALLLET l_right_click_event = _ADVPL_setget_property(l_form_referencecComponentReference,"ENABLERIGHT_ESCCLICK_CLOSEEVENT",FALSE)



(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 FORMGET SHOW_INFO TOOLTIP

Método

SET

GET:

FORM

SHOW_

INFO 

TOOLTIP

Define se habilita o encerramento da janela com a tecla ESCRetorna 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_setget_property(< l_form_referencecComponentReference >,"FORMSHOW_INFOTOOLTIP",< informação >)) ==> lShowTooTip


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

Sim
informação


Retorno

CHAR
Breve informação sobre o formulário.Sim

Tipo

Descrição

BOOLEAN

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

Exemplo


Bloco de código
languageruby
themeConfluenceEclipse
linenumberstrue
CALLLET l_show_tooltip = _ADVPL_setget_property(l_form_referencecComponentReference,"FORMSHOW_INFO","Formulário de manutenção de usuário Logix.")TOOLTIP")



(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 FORM_MODIFICATION GET TOOLTIP

Método

SET

GET:

FORM_INFO 

TOOLTIP

Texto de ajuda exibido quando o usuário posicionar o cursor do mouse em cima do componenteModificação do formulário.

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,"FORM_MODIFICATION",< informação >)TOOLTIP") ==> cText


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

Sim


Retorno


Tipo

Descrição

informação

CHAR
Breve informação sobre o formulário.Não

Texto que é exibido quando o usuário posicionar o cursor do mouse em cima do componente.

Exemplo


Bloco de código
languageruby
themeConfluenceEclipse
linenumberstrue
CALLLET l_tooltip = _ADVPL_setget_property(l_form_referencecComponentReference,"FORM_MODIFICATION","01"TOOLTIP")



(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 FORM_NAME GET VALID

Método

SET

GET:

FORM_NAME 

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 ADVPLModificação do formulário.

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_namecComponentReference >,"FORM_INFO",< formulário >)VALID") ==> cFunctionName


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_name
cComponentReference
CHAR

Referência do

formulário

componente.

Sim
formulário


Retorno

CHAR
Nome do formulário.Sim

Tipo

Descrição

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
themeConfluenceEclipse
linenumberstrue
CALLLET l_valid = _ADVPL_setget_property(l_form_namecComponentReference,"FORM_NAME","LOG5500VALID")



(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 FORM_RELEASE GET VALUE

Método

SET

GET:

FORM_RELEASE 

VALUE  

Valor definido para o componenteRelease do formulário.

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,"FORM_RELEASE",< release >)VALUE") ==> uValue


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

Sim
release


Retorno

CHAR
Release do formulário.Sim

Tipo

Descrição

ANY

Valor que está definido para o componente.

Exemplo


Bloco de código
languageruby
themeConfluenceEclipse
linenumberstrue
CALLLET l_value = _ADVPL_setget_property(l_form_referencecComponentReference,"FORM_RELEASE","02"VALUE")



(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 FORM_VERSION GET VISIBLE

Método

SET

GET:

FORM_VERSION 

VISIBLE 

Retorna se o componente está visívelVersão do formulário.

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,"FORM_VERSION",< versao >)VISIBLE") ==> lVisible


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

Sim
versao


Retorno

CHAR
Versão do formulário.Sim

Tipo

Descrição

BOOLEAN

Indicador que define se o componente está visível.

Exemplo


Bloco de código
languageruby
themeConfluenceEclipse
linenumberstrue
CALLLET l_visible = _ADVPL_setget_property(l_form_referencecComponentReference,"FORM_VERSION","10VISIBLE")



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

Exemplo

Expandir
titleSET HOTKEY GET WIDTH

Método

SET

GET:

HOTKEY 

WIDTH 

Largura do componente em pixels.Tecla de atalho a ser executada quando a janela da aplicação estiver ativa.

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,< tecla >,< função >,< descrição >,< componente >, < status >)"WIDTH") ==> nWidth


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

Sim
tecla


Retorno

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
componenteCHARReferência do componente do qual pertence a tecla de atalho.Não
statusBOOLEANIndicador lógico que define se o atalho deverá ser executado sempre ou somente quando o componente informado no método estiver focado em tela.Não
Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"HOTKEY","CTRL-I","Incluir um novo registro.",l_menubutton_reference,FALSE)
Expandir
titleSET INIT_EVENT

Método SET: INIT_EVENT 

Adiciona um evento a ser executado ao iniciar a janela da aplicação.

Sintaxe

Bloco de código
_ADVPL_set_property(< l_form_reference >,< função>)

Parâmetros


Tipo

Descrição

INTEGER

Largura em pixels do componente.

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_width = _ADVPL_get_property(componentReference,"WIDTH")



Expandir
titleGET X

Método GET: X 

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

Sintaxe


Bloco de código
_ADVPL_get_property(< cComponentReference >,"X") ==> nPos


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

INTEGER

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

Exemplo


Bloco de código
languageruby
themeEclipse
linenumberstrue
LET l_x = _ADVPL_get_property(cComponentReference,"X")



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

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


Expandir
titleGET Y

Método GET: Y

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

NomeTipoDescriçãoObrigatório?
l_form_reference
CHAR
Referência do formulário.Sim
função
CHAR
Função executada executada ao iniciar a janela de aplicação.Sim
Expandir
titleSET MAXIMIZED

Método SET: MAXIMIZED 

Define se a tela abrirá maximizada.

Sintaxe


Bloco de código
_ADVPL_setget_property(< l_form_referencecComponentReference >,"MAXIMIZEDY",< status >)) ==> nPos


Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR

Referência do

formulário

componente.

Sim
status


Retorno

BOOLEAN
Indicador que define se a janela abrirá maximizada.Sim

Tipo

Descrição

INTEGER

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

Exemplo


Bloco de código
languageruby
themeConfluenceEclipse
linenumberstrue
CALLLET _ADVPL_setl_y = _ADVPL_get_property(l_form_referencecomponentReference,"MAXIMIZEDY",FALSE)



Métodos SET

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


Exemplo

Expandir
titleSET TITLE ALIGN

Método SET:

MAXIMIZED 

ALIGN 

Alinhamento do componente em relação ao seu componente paiTítulo da janela.

Sintaxe


Bloco de código
_ADVPL_set_property(< l_form_referencecComponentReference >," TITLE ALIGN",< título>cAlign >)

Parâmetros


NomeTipoDescriçãoObrigatório?
l_form_reference
cComponentReference
CHAR
Referência do
formulário
componente.Sim
título
cAlign
CHAR
Título da janela.Sim
Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(l_form_reference,"TITLE","Central do Usuário")
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
#---------------------# 
FUNCTION TesteAlign()
#---------------------#
     DEFINE l_dialog_reference VARCHAR(10)
     DEFINE l_label_reference  VARCHAR(10)

     LET l_dialog_reference = _ADVPL_create_component(NULL,"LDIALOG")
     CALL _ADVPL_set_property(l_dialog_reference,"SIZE",640,480)
     CALL _ADVPL_set_property(l_dialog_reference,"TITLE","Teste de Alinhamento")
     
#Alinhamento ao topo.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_label_reference,"HEIGHT",80)
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","TOP")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",255,255,0)
    
 #Alinhamento à esquerda.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_label_reference,"WIDTH",80)
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","LEFT")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",255,0,0)
    
 #Alinhamento central.
     LET l_label_reference = _ADVPL_create_component(NULL,"LTITLEDPANEL",l_dialog_reference)       
     CALL _ADVPL_set_property(l_label_reference,"TITLE","Teste de Alinhamento")
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","CENTER")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",0,255,0)
    
 #Alinhamento à direita.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_label_reference,"WIDTH",80)
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","RIGHT")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",0,0,255)
    
 #Alinhamento ao fundo.
     LET l_label_reference = _ADVPL_create_component(NULL,"LPANEL",l_dialog_reference)
     CALL _ADVPL_set_property(l_label_reference,"HEIGHT",80)
     CALL _ADVPL_set_property(l_label_reference,"ALIGN","BOTTOM")
     CALL _ADVPL_set_property(l_label_reference,"BACKGROUND_COLOR",0,255,255)
     CALL _ADVPL_set_property(l_dialog_reference,"MAXIMIZED",FALSE)
     CALL _ADVPL_set_property(l_dialog_reference,"ACTIVATE",TRUE) 
END FUNCTION



Expandir
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(cComponentReference,"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(< cComponentReference >,"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 do componente.Sim
nHeight
INTEGER
Altura em pixels do componente.Sim


Exemplo


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



Expandir
titleSET CAN_GOT_FOCUS

Método SET: CAN_GOT_FOCUS

Define se o componente poderá ganhar foco.

Sintaxe


Bloco de código
_ADVPL_set_property(< cComponentReference >,"CAN_GOT_FOCUS",< lCanGotFocus >)

Parâmetros


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


Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cComponentReference,"CAN_GOT_FOCUS",FALSE)



Expandir
titleSET CHANGE_EVENT

Método SET: CHANGE_EVENT     

Evento executado quando o valor do componente for alterado.

Sintaxe


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

Parâmetros


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

Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cComponentReference,"CHANGE_EVENT","job0003_execucao_gatilho_select_all")



Expandir
titleSET CLICK_EVENT

Método SET: CLICK_EVENT   

Evento executado ao clicar no componente.

Sintaxe


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

Parâmetros


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


Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cButtonReference,"CLICK_EVENT","job0005_stop_process_monitor")



Expandir
titleSET CSS

Método SET: CSS  

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

Sintaxe


Bloco de código
_ADVPL_set_property(< cComponentReference >,"CSS",< cCodeCSS >)

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference CHARReferência do componente.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). 


Exemplo


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



Expandir
titleSET DOUBLE_CLICK_EVENT

Método SET: DOUBLE_CLICK_EVENT  

Evento executado ao efetuar um duplo clique no componente.

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHARReferência do 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(cComponentReference,"DOUBLE_CLICK_EVENT","job0003_parametros_update_variable")



Expandir
titleSET EDITABLE

Método SET: EDITABLE

Habilita ou desabilita a edição do componente.

Sintaxe


Bloco de código
_ADVPL_set_property(< cComponentReference >,"EDITABLE",< lEditable >)

Parâmetros


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



Expandir
titleSET ENABLE

Método SET: ENABLE

Habilita ou desabilita o componente.

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference 
CHAR
Referência do componente.Sim
lEnable
BOOLEAN
Indicador que define se o componente será habilitado.Sim


Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cComponentReference,"ENABLE",FALSE)



Expandir
titleSET FONT

Método SET: FONT 

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

Sintaxe


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

Parâmetros


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


Exemplo


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





Expandir
titleSET FORCE_GET_FOCUS

Método SET: FORCE_GET_FOCUS 

Força o foco para o componente.

Sintaxe


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

Parâmetros


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


Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cComponentReference,"FORCE_GET_FOCUS",TRUE)



Expandir
titleSET FOREGROUND_COLOR

Método SET: FOREGROUND_COLOR

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

Sintaxe


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

Parâmetros


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(componentReference,"FOREGROUND_COLOR",255,0,0)



Expandir
titleSET GOT_FOCUS_EVENT

Método SET: GOT_FOCUS_EVENT 

Evento executado quando o componente ganhar foco.

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR
Referência do componente.Sim
cFunctionName
CHAR
Função executada quando o componente ganhar foco.Sim


Exemplo


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



Expandir
titleSET HEIGHT

Método SET: HEIGHT

Altura do componente em pixels.

Sintaxe


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

Parâmetros


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


Exemplo


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



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.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(cComponentReference,"HELP_NAME","frm_toolbar_parent_name")



Expandir
titleSET HOTKEY

Método SET: HOTKEY 

Tecla de atalho definida para o componente.

Sintaxe


Bloco de código
_ADVPL_set_property(< cComponentReference >, "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.

Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cComponentReference,"HOTKEY","F4","Zoom de empresas.",TRUE)



Expandir
titleSET LOST_FOCUS_EVENT

Método SET: LOST_FOCUS_EVENT

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

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR
Referência do componente.Sim
cFunctionName
CHAR
Função executada quando o componente perder seu foco.Sim


Exemplo


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



Expandir
titleSET POSITION

Método SET: POSITION

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

Sintaxe


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

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference 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 componente.Sim


Exemplo


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



Expandir
titleSET PROPERTY

Método SET: PROPERTY

Atribui novas propriedades para o componente.

Sintaxe


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

Parâmetros


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(cComponentReference,"PROPERTY","{'PICTURE','@!'}{'LENGTH',10}")



Expandir
titleSET REFRESH_SIZE

Método SET: REFRESH_SIZE

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

Sintaxe


Bloco de código
_ADVPL_set_property(< cComponentReference >,"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(cComponentReference,"REFRESH_SIZE")



Expandir
titleSET REMOVE_VARIABLES

Método SET: REMOVE_VARIABLES

Remove as variáveis definidas para o componente.

Sintaxe


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

Exemplo


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



Expandir
titleSET REQUIRED

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.

Sintaxe


Bloco de código
_ADVPL_set_property(< cComponentReference >,"REQUIRED",<nRequired>)

Exemplo


Bloco de código
languageruby
themeConfluence
linenumberstrue
CALL _ADVPL_set_property(cComponentReference,"REQUIRED",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(< cComponentReference >,"RIGHT_CLICK_EVENT",< cFunctionName >)


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR
Referência do componenteSim
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(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(< cComponentReference >,"SAVE_IMAGE",< cPath >)

Parâmetros


NomeTipoDescriçãoObrigatório?
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(cComponentReference,"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(< cComponentReference >,"SHOW_TOOLTIP",< lShowToolTip >)

Parâmetros


NomeTipoDescriçãoObrigatório?
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(cComponentReference,"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(< cComponentReference >,"SIZE",< nWidth >, < nHeight >)

Parâmetros


NomeTipoDescriçãoObrigatório?
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(cComponentReference,"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(< cComponentReference >,"TOOLTIP",< cText >)

Parâmetros


NomeTipoDescriçãoObrigatório?
componentReference CHARReferência do componente.Sim
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(cComponentReference,"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(< cComponentReference >,"VALID",< cFunctionName >)

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference 
CHAR
Referência do componente.Sim
cFunctionName
CHAR
Função executada para validar o conteúdo do componente quando este perder o foco.Sim

(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(< cComponentReference >,"VALUE",< uValue >)

Parâmetros


NomeTipoDescriçãoObrigatório?
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(cComponentReference,"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(< cComponentReference >,"VARIABLE",< record4GL >, < cVariableName >)

Parâmetros


NomeTipoDescriçãoObrigatório?
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(< cComponentReference >,"VARIABLE",< lVisible >)

Parâmetros


NomeTipoDescriçãoObrigatório?
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(cComponentReference,"VISIBLE",FALSE)



Expandir
titleSET WIDTH

Método SET: WIDTH

Largura do componente em pixels.

Sintaxe


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

|

Parâmetros


NomeTipoDescriçãoObrigatório?
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(cComponentReference,"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(< cComponentReference >,"X",< nPos >)

|

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference 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(cComponentReference,"X",10)



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

(informação)Importante: caso a função informada neste método retornar falso, a tela não será finalizada.
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(cComponentReference,"Y",< nPos >)

|

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference 
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(cComponentReference,"Y",10)
Expandir
titleSET VALID

Método SET: VALID 

Define se a tela abrirá maximizada.

Sintaxe

Bloco de código
_ADVPL_set_property(< funçao >)

Parâmetros

NomeTipoDescriçãoObrigatório?
função
CHAR
Função que será executada quando o usuário fechar a janela de diálogo.Sim