Páginas filhas
  • LGX - LFORM

Componente abstrato herdado pelos componentes de criação de janelas LDIALOG e LFRAME.


Hierarquia



Métodos GET


Métodos acessíveis através da função _ADVPL_get_property que permite recuperar e manipular os valores do componente.

Método GET: ACTIVATE

Retorna se a janela da aplicação está ativada.

Sintaxe



_ADVPL_get_property(< lFormReference >,"ACTIVATE") => lIsActive

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR
  • Referência do componente que está em foco na tela.
Sim


Retorno



TipoDescrição
SMALLINTVerdadeiro se a janela da aplicação está ativada.

Exemplo



LET l_active = _ADVPL_get_property(m_form_reference,"ACTIVATE")

Método GET: COMPONENT_FOCUS_REFERENCE

Retorna a referência do componente em foco.

Sintaxe



_ADVPL_get_property(< lFormReference >,"COMPONENT_FOCUS_REFERENCE") => cComponentReference

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
CHARReferência do componente em foco

Exemplo



LET l_componentReference = _ADVPL_get_property(m_form_reference,"COMPONENT_FOCUS_REFERENCE")

Método GET: COMPONENT_REFERENCE_BY_HELP_NAME

Retorna a referência do componente pelo nome do atalho de ajuda (propriedade HELP_NAME).

Sintaxe



_ADVPL_get_property(< lFormReference >,"COMPONENT_REFERENCE_BY_HELP_NAME") => cComponentReference

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
CHARReferência do componente correspondente ao HELP_NAME indicado.

Exemplo



LET l_componentReference = _ADVPL_get_property(m_form_reference,"COMPONENT_REFERENCE_BY_HELP_NAME")

Método GET: CONTAINER_HEIGHT

Altura da janela da aplicação.

Sintaxe



_ADVPL_get_property(< lFormReference >,"CONTAINER_HEIGHT") => nHeight

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
INTEGERAltura do componente LFORM

Exemplo



LET l_height = _ADVPL_get_property(m_form_reference,"CONTAINER_HEIGHT")

Método GET: CONTAINER_WIDTH

Largura da janela da aplicação.

Sintaxe



_ADVPL_get_property(< lFormReference >,"CONTAINER_WIDTH") => nWidth

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
INTEGERLargura do componente LFORM

Exemplo



LET l_width = _ADVPL_get_property(m_form_reference,"CONTAINER_WIDTH")

Método GET: FORM_INFO

Breve informação sobre o formulário.

Sintaxe



_ADVPL_get_property(< lFormReference >,"FORM_INFO") => cInfo

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
CHARBreve informação sobre o formulário.

Exemplo



LET l_info = _ADVPL_get_property(m_form_reference,"FORM_INFO")

Método GET: FORM_MODIFICATION

Número revisão de modificação do formulário.

Sintaxe



_ADVPL_get_property(< lFormReference >,"FORM_MODIFICATION") => nModification

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
INTEGERNúmero da revisão de modificação do formulário.

Exemplo



LET l_modification = _ADVPL_get_property(m_form_reference,"FORM_MODIFICATION")

Método GET: FORM_NAME

Nome do formulário.

Sintaxe



_ADVPL_get_property(< lFormReference >,"FORM_NAME") => cName

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
CHARNome do formulário.

Exemplo



LET l_name = _ADVPL_get_property(m_form_reference,"FORM_NAME")

Método GET: FORM_RELEASE

Retorna a release do formulário.

Sintaxe



_ADVPL_get_property(< lFormReference >,"FORM_RELEASE") => cRelease

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
CHARCódigo da release do formulário.

Exemplo



LET l_release = _ADVPL_get_property(m_form_reference,"FORM_RELEASE")

Método GET: FORM_VERSION

Retorna a versão do formulário.

Sintaxe



_ADVPL_get_property(< lFormReference >,"FORM_VERSION") => cVersion

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
CHARCódigo da revisão do formulário.

Exemplo



LET l_version = _ADVPL_get_property(m_form_reference,"FORM_VERSION")

Método GET: INIT_EVENT

Retorna a lista de eventos executados na abertura da janela da aplicação.

Sintaxe



_ADVPL_get_property(< lFormReference >,"INIT_EVENT") => aList

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
ARRAY OF CHARArray contendo a lista de funções executadas na abertura da janela.

Exemplo



LET la_initEvent = _ADVPL_get_property(m_form_reference,"INIT_EVENT")

Método GET: MAIN_FORM_NAME

Nome do formulário principal em execução.

Sintaxe



_ADVPL_get_property(< lFormReference >,"MAIN_FORM_NAME") => cName

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
CHARNome do formulário principal em execução.

Exemplo



LET l_name = _ADVPL_get_property(m_form_reference,"MAIN_FORM_NAME")

Método GET: MAXIMIZED

Retorna se a janela da aplicação está maximizada.

Sintaxe



_ADVPL_get_property(< lFormReference >,"MAXIMIZED") => lIsMaximized

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim


Retorno



TipoDescrição
BOOLEANTRUE se a janela está maximizada

Exemplo



LET la_initEvent = _ADVPL_get_property(m_form_reference,"MAXIMIZED")

Método GET: TITLE 

Retorna o título da janela.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"TITLE") => cTitle

Retorno



TipoDescrição
CHARTítulo definido na janela.

Exemplo



LET l_title = _ADVPL_get_property(m_form_reference,"TITLE")





Métodos SET


Métodos acessíveis através da função _ADVPL_set_property que permite alterar e manipular os valores do componente:


Método SET: ACTIVATE

Define o título da janela.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"ACITVATE", < l_activate >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_referenceCHARReferência do formulárioSim
l_activateSMALLINT

TRUE - Ativa a janela.

FALSE - Desativa/Fecha a janela

Sim

Exemplo



CALL _ADVPL_set_property(m_form_reference,"ACTIVATE",)




Método SET: CENTER

Define se a janela (ainda não exibida) abrirá no centro da área de trabalho.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"CENTER", < l_center >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_center
SMALLINT

TRUE para centralizar a janela na abertura.

FALSE não centraliza a janela na abertura.

Sim

Exemplo



CALL _ADVPL_set_property(m_form_reference,"CENTER",TRUE)

Observação


  • Este método só tem efeito se a janela não está maximizada.




Método SET: CENTERED

Centraliza a janela já aberta na área de trabalho.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"CENTERED", < l_centered >)

Parâmetros



NomeTipoDescriçãoObrigatório?
l_centered
SMALLINTVerdadeiro para centralizar a janela, falso para manter na posição definida.Sim

Exemplo



CALL _ADVPL_set_property(m_form_reference,"CENTERED",TRUE)

Observação


  • Este método só tem efeito se a janela não está maximizada.




Método SET: CLEAR_HOTKEYS

Remove todas as teclas de atalho disponíveis na janela.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"CLEAR_HOTKEYS")

Exemplo



CALL _ADVPL_set_property(m_form_reference,"CLEAR_HOTKEYS")




Método SET: ENABLE_ESC_CLOSE

Habilita/desabilita o encerramento da janela através do botão ESC.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"ENABLE_ESC_CLOSE", < l_enable >)

Parâmetros



NomeTipoDescriçãoObrigatório?Padrão
l_enableSMALLINTVerdadeiro para habilitar o encerramento da janela através do botão ESC, falso para desabilitar.Sim

Exemplo



CALL _ADVPL_set_property(m_form_reference,"ENABLE_ESC_CLOSE",FALSE)




Método SET: FORM_INFO

Define uma breve informação sobre o formulário.

Sintaxe



CALL _ADVPL_set_property(< lFormReference >,"FORM_INFO", < cInfo > ) 

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim
cInfoCHARBreve informação sobre o formulário.Sim


Exemplo



CALL_ADVPL_get_property(m_form_reference,"FORM_INFO","Programa de cadastro de Usuários.")

Método SET: FORM_MODIFICATION

Ajusta o número revisão de modificação do formulário.

Sintaxe



CALL _ADVPL_get_property(< lFormReference >,"FORM_MODIFICATION", < nModification > ) 

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim
nModification INTEGERNúmero da modificação do formulário.Sim


Exemplo



CALL _ADVPL_get_property(m_form_reference,"FORM_MODIFICATION",48)

Método SET: FORM_NAME

Nome do formulário.

Sintaxe



CALL _ADVPL_set_property(< lFormReference >,"FORM_NAME", < cName > )

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim
cNameCHARNome do Formulário.Sim


Exemplo



CALL _ADVPL_get_property(m_form_reference,"FORM_NAME","log03948")

Método SET: FORM_RELEASE

Ajusta a release do formulário.

Sintaxe



CALL _ADVPL_set_property(< lFormReference >,"FORM_RELEASE", < cRelease > ) 

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReferenceCHAR

Referência do formulário.

Sim
cReleaseCHARCódigo da release do formulárioSim


Exemplo



CALL _ADVPL_get_property(m_form_reference,"FORM_RELEASE", "2305")

Método SET: FORM_VERSION

Ajusta a versão do formulário.

Sintaxe



CALL _ADVPL_set_property(< lFormReference >,"FORM_VERSION", < cVersion >) 

Parâmetros



NomeTipoDescriçãoObrigatório?
lFormReference
CHAR

Referência do formulário.

Sim
cVersion
CHAR
Versão do formulárioSim


Exemplo



CALL _ADVPL_get_property(m_form_reference,"FORM_VERSION","12.1")

Método SET: HOTKEY

Define uma tecla de atalho para a janela.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"HOTKEY", < l_hotkey >, [ l_event ], [ l_info ], [ l_component ], [ l_focus ])

Parâmetros



NomeTipoDescriçãoObrigatório?Padrão
l_hotkey
SMALLINTCódigo da tecla de atalho. 1Sim
l_event
CHARFunção 4GL que será executada na tecla de atalho. 2Não
l_info
CHARBreve descrição da tecla de atalho (utilizada na tela de exibição das teclas de atalho disponíveis na janela).Não
l_component
VARCHARReferência do componente FREEFORM para o qual será definida a tecla de atalho. 3Não
l_focus
SMALLINTVerdadeiro para limitar a execução da tecla de atalho apenas quando o componente informado estiver focado.Não

1 As teclas de atalho disponíveis encontram-se no link Teclas de atalhos disponíveis atualmente para formulários Freeform e Metadado.
2
Se não informada a função 4GL, a tecla de atalho será removida da janela.
3 Se informado um componente, a execução da tecla de atalho não será realizada quando este estiver desabilitado ou invisível.

Exemplo



CALL _ADVPL_set_property(m_form_reference,"HOTKEY",116,"job005_refresh","Atualiza os valores da tela")




Método SET: INIT_EVENT

Adiciona um evento que será executado na ativação da janela.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"INIT_EVENT", < l_event >)

Parâmetros



NomeTipoDescriçãoObrigatório?Padrão
l_event
CHARFunção 4GL que será executada na ativação da janela.Sim

Exemplo



CALL _ADVPL_set_property(m_form_reference,"INIT_EVENT","job0005_init_event")




Método SET: MAXIMIZE_EVENT

Define um evento que será executado quando o usuário maximizar a janela.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"MAXIMIZE_EVENT", < l_event >)

Parâmetros



NomeTipoDescriçãoObrigatório?Padrão
l_event
CHARFunção 4GL que será executada quando o usuário maximizar a janela.Sim

Exemplo



CALL _ADVPL_set_property(m_form_reference,"MAXIMIZE_EVENT","job0005_maximize_event")




Método SET: MAXIMIZED

Maximiza a janela.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"MAXIMIZED", < l_maximized >)

Parâmetros



NomeTipoDescriçãoObrigatório?Padrão
l_maximized
SMALLINTVerdadeiro para maximizar a janela, falso para manter o tamanho definido.Sim

Exemplo



CALL _ADVPL_set_property(m_form_reference,"MAXIMIZED",TRUE)




Método SET: TITLE 

Define o título da janela.

Sintaxe



CALL _ADVPL_set_property(< l_reference >,"TITLE", < l_title >)

Parâmetros



NomeTipoDescriçãoObrigatório?Padrão
l_titleCHARTítulo que será definido para a janela.Sim

Exemplo



CALL _ADVPL_set_property(m_form_reference,"TITLE","Manutenção de Pedidos")