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


Hierarquia

  • LCOMPONENT


Métodos GET

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


Método GET: ALIGN 

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

Sintaxe


_ADVPL_get_property(< cComponentReference >,"ALIGN") ==> cALign

Parâmetros


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


LET l_align = _ADVPL_get_property(cComponentReference,"ALIGN")



Método GET: CAN_GOT_FOCUS

Retorna se o componente poderá ganhar foco.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"CAN_GOT_FOCUS ") ==> lCanGotFocus

Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

BOOLEAN

Indicador que define se o componente pode ganhar foco.

Exemplo


LET cComponentReference = _ADVPL_get_property(m_form_reference,"CAN_GOT_FOCUS ")



Método GET: CHANGE_EVENT

Evento executado quando o valor do componente for alterado.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"CHANGE_EVENT ") ==> cFunctionName


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

CHAR

Função que é executada quando o valor do componente for alterado.

Exemplo


LET l_change_event = _ADVPL_get_property(cComponentReference,"CHANGE_EVENT")



Método GET: CLICK_EVENT 

Evento executado ao clicar no componente.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"CLICK_EVENT") ==> cFunctionName


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

CHAR

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

Exemplo


LET l_click_event = _ADVPL_get_property(cComponentReference,"CLICK_EVENT")



Método GET: COMPONENT_TYPE

Tipo do componente.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"COMPONENT_TYPE") ==> cType


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

CHAR

Tipo do componente criado (LDialog, LCheckBox, LTextField, etc).

Exemplo


LET l_component_type = _ADVPL_get_property(cComponentReference,"COMPONENT_TYPE")



Método GET: DOUBLE_CLICK_EVENT 

Evento executado ao efetuar um duplo clique no componente.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"DOUBLE_CLICK_EVENT") ==> cFunctionName


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

CHAR

Função que é executada ao efetuar um duplo clique no componente.

Exemplo


LET l_double_click_event = _ADVPL_get_property(componentReference,"DOUBLE_CLICK_EVENT")



Método GET: EDITABLE

Retorna se o componente está editável.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"EDITABLE") ==> lEditable


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

BOOLEAN

Indicador que define se o componente está editável.

Exemplo


LET l_editable = _ADVPL_get_property(cComponentReference,"EDITABLE")



Método GET: ENABLE 

Retorna se o componente está habilitado.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"ENABLE") ==> lEnable


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

BOOLEAN

Indicador que define se o componente está habilitado.

Exemplo


LET l_enable = _ADVPL_get_property(cComponentReference,"ENABLE")



Método GET: FORM_REFERENCE

Referência da janela em que o componente está criado.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"FORM_REFERENCE") ==> cFormReference


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

CHAR

Referência da janela onde o componente foi criado.

Exemplo


LET l_form_reference = _ADVPL_get_property(cComponentReference,"FORM_REFERENCE")



Método GET: GOT_FOCUS_EVENT 

Evento executado quando o componente ganhar foco.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"GOT_FOCUS_EVENT") ==> cFunctionName


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

CHAR

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

Exemplo


LET l_got_focus = _ADVPL_get_property(cComponentReference,"GOT_FOCUS_EVENT")



Método GET: HANDLER

Código nativo do componente.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"HANDLER") ==> nHandlerID


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

NUMERIC

Código nativo AdvPL do componente.

Exemplo


LET l_hadler = _ADVPL_get_property(cComponentReference,"HANDLER")



Método GET: HEIGHT

Altura do componente em pixels.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"ENABLE") ==> nHeight


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

NUMERIC

Altura em pixels do componente.

Exemplo


LET l_height = _ADVPL_get_property(cComponentReference,"HEIGHT")



Método GET: HELP_NAME

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

Sintaxe


_ADVPL_get_property(< cComponentReference >,"HELP_NAME") ==> cText


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

CHAR

Texto que identifica o componente na URL da ajuda online.

Exemplo


LET l_help_name = _ADVPL_get_property(componentReference,"HELP_NAME")



Método GET: LOST_FOCUS_EVENT

Evento executado quando o componente perder seu foco.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"LOST_FOCUS_EVENT") ==> functionName


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

CHAR

Função que é executada quando o componente perder seu foco.

Exemplo


LET l_lost_focus = _ADVPL_get_property(cComponentReference,"LOST_FOCUS_EVENT")



Método GET: PARENT_REFERENCE

Referência do componente pai do componente atual.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"PARENT_REFERENCE") ==> cParentRerence


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim

Retorno


Tipo

Descrição

CHAR

Referência do componente pai do componente atual.

Exemplo


LET l_parent_reference = _ADVPL_get_property(cComponentReference,"PARENT_REFERENCE")



Método GET: RIGHT_CLICK_EVENT

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

Sintaxe


_ADVPL_get_property(< cComponentReference >,"RIGHT_CLICK_EVENT") ==> cFunctionName


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

CHAR

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

Exemplo


LET l_right_click_event = _ADVPL_get_property(cComponentReference,"RIGHT_CLICK_EVENT")



Método GET: SHOW_TOOLTIP

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

Sintaxe


_ADVPL_get_property(< cComponentReference >,"SHOW_TOOLTIP") ==> lShowTooTip


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

BOOLEAN

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

Exemplo


LET l_show_tooltip = _ADVPL_get_property(cComponentReference,"SHOW_TOOLTIP")



Método GET: TOOLTIP

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

Sintaxe


_ADVPL_get_property(< cComponentReference >,"TOOLTIP") ==> cText


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

CHAR

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

Exemplo


LET l_tooltip = _ADVPL_get_property(cComponentReference,"TOOLTIP")



Método GET: VALID 

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

Sintaxe


_ADVPL_get_property(< cComponentReference >,"VALID") ==> cFunctionName


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

CHAR

Função que é executada para validar o conteúdo do componente quando este perder o foco.

Exemplo


LET l_valid = _ADVPL_get_property(cComponentReference,"VALID")



Método GET: VALUE  

Valor definido para o componente.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"VALUE") ==> uValue


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

ANY

Valor que está definido para o componente.

Exemplo


LET l_value = _ADVPL_get_property(cComponentReference,"VALUE")



Método GET: VISIBLE 

Retorna se o componente está visível.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"VISIBLE") ==> lVisible


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

BOOLEAN

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

Exemplo


LET l_visible = _ADVPL_get_property(cComponentReference,"VISIBLE")



Método GET: WIDTH 

Largura do componente em pixels.

Sintaxe


_ADVPL_get_property(< cComponentReference >,"WIDTH") ==> nWidth


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

INTEGER

Largura em pixels do componente.

Exemplo


LET l_width = _ADVPL_get_property(componentReference,"WIDTH")



Método GET: X 

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

Sintaxe


_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


LET l_x = _ADVPL_get_property(cComponentReference,"X")



Método GET: Y

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

Sintaxe


_ADVPL_get_property(< cComponentReference >,"Y") ==> nPos


Parâmetros


NomeTipoDescriçãoObrigatório?
cComponentReference
CHAR

Referência do componente.

Sim


Retorno


Tipo

Descrição

INTEGER

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

Exemplo


LET l_y = _ADVPL_get_property(componentReference,"Y")



Métodos SET

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


Método SET: ALIGN 

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

Sintaxe


_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


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



Método SET: BACKGROUND_COLOR 

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

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"BACKGROUND_COLOR",255,0,0)



Método SET: BOUNDS 

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

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"BOUNDS",10,10,320,240)



Método SET: CAN_GOT_FOCUS

Define se o componente poderá ganhar foco.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"CAN_GOT_FOCUS",FALSE)



Método SET: CHANGE_EVENT     

Evento executado quando o valor do componente for alterado.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"CHANGE_EVENT","job0003_execucao_gatilho_select_all")



Método SET: CLICK_EVENT   

Evento executado ao clicar no componente.

Sintaxe


_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


CALL _ADVPL_set_property(cButtonReference,"CLICK_EVENT","job0005_stop_process_monitor")



Método SET: CSS  

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

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"CSS","QPushButton { background-image: url(rpo:BTPESQ.PNG); }")



Método SET: DOUBLE_CLICK_EVENT  

Evento executado ao efetuar um duplo clique no componente.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"DOUBLE_CLICK_EVENT","job0003_parametros_update_variable")



Método SET: EDITABLE

Habilita ou desabilita a edição do componente.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"EDITABLE",FALSE)



Método SET: ENABLE

Habilita ou desabilita o componente.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"ENABLE",FALSE)



Método SET: FONT 

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

Sintaxe


_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


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





Método SET: FORCE_GET_FOCUS 

Força o foco para o componente.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"FORCE_GET_FOCUS",TRUE)



Método SET: FOREGROUND_COLOR

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

Sintaxe


_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


CALL _ADVPL_set_property(componentReference,"FOREGROUND_COLOR",255,0,0)



Método SET: GOT_FOCUS_EVENT 

Evento executado quando o componente ganhar foco.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"GOT_FOCUS_EVENT", "eai100001_got_focus_event_mensagem")



Método SET: HEIGHT

Altura do componente em pixels.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"HEIGHT",200)



Método SET: HELP_NAME

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

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"HELP_NAME","frm_toolbar_parent_name")



Método SET: HOTKEY 

Tecla de atalho definida para o componente.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"HOTKEY","F4","Zoom de empresas.",TRUE)



Método SET: LOST_FOCUS_EVENT

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

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"LOST_FOCUS_EVENT","log08100_zoom_tabela")



Método SET: POSITION

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

Sintaxe


_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


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



Método SET: PROPERTY

Atribui novas propriedades para o componente.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"PROPERTY","{'PICTURE','@!'}{'LENGTH',10}")



Método SET: REFRESH_SIZE

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

Sintaxe


_ADVPL_set_property(< cComponentReference >,"REFRESH_SIZE")


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


Exemplo


CALL _ADVPL_set_property(cComponentReference,"REFRESH_SIZE")



Método SET: REMOVE_VARIABLES

Remove as variáveis definidas para o componente.

Sintaxe


_ADVPL_set_property(< cComponentReference >,"REMOVE_VARIABLES")

Exemplo


CALL _ADVPL_set_property(cComponentReference,"REMOVE_VARIABLES")



Método SET: RIGHT_CLICK_EVENT  

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


Sintaxe



_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


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



Método SET: SAVE_IMAGE

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

Sintaxe


_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


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



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


_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


CALL _ADVPL_set_property(cComponentReference,"SHOW_TOOLTIP",FALSE)



Método SET: SIZE

Tamanho (largura e altura) em pixels do componente.

Sintaxe


_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


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



Método SET: TOOLTIP

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

Sintaxe


_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


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



Método SET: VALID

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

Sintaxe


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



Método SET: VALUE

Valor definido para o componente.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"VALUE",10)



Método SET: VARIABLE

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

Sintaxe


_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


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



Método SET: VISIBLE

Habilita ou desabilita a visualização do componente.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"VISIBLE",FALSE)



Método SET: WIDTH

Largura do componente em pixels.

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"WIDTH",250)



Método SET: X

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

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"X",10)



Método SET: Y

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

Sintaxe


_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


CALL _ADVPL_set_property(cComponentReference,"Y",10)