- Criado por Ieda Ferreira Alves Flock, última alteração em 07 mar, 2023
Métodos SET
utilizando a função _ADVPL_set_property
que permite alterar e manipular os valores do componente.
Método SET: CANCEL_EVENT
Evento executado ao cancelar a operação.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference >,"CANCEL_EVENT",< Função >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Função | CHAR | Função executada quando o usuário cancelar a operação. | Sim |
Importante: este método é valido apenas para botões que habilitam confirmação, método TYPE igual a CONFIRM. Esta função espera retorno verdadeiro ou falso, caso o evento retornar falso, a operação não será cancelada.
Método SET: CANCEL_MESSAGE
Mensagem exibida para o usuário ao cancelar a operação.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference>,"CANCEL_MESSAGE",< Mensagem >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Mensagem | CHAR | Mensagem exibida para o usuário ao cancelar a operação. Esta mensagem será exibida em vermelho na barra de status. | Sim |
Importante: este método é valido apenas para botões que habilitam confirmação, método TYPE igual a CONFIRM.
Exemplo
CALL _ADVPL_set_property(l_menubutton_reference,"CANCEL_MESSAGE","Atualização cancelada.")
Método SET: CONFIRM_EVENT
Evento executado ao confirmar a operação.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference >,"CONFIRM_EVENT",< Função >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Função | CHAR | Função executada quando o usuário confirmar a operação. | Sim |
Importante: este método é valido apenas para botões que habilitam confirmação, método TYPE igual a CONFIRM. Esta função espera retorno verdadeiro ou falso, caso o evento retornar falso, a operação não será confirmada.
Método SET: CONFIRM_MESSAGE
Mensagem exibida para o usuário ao confirmar a operação.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference >,"CONFIRM_MESSAGE",< Mensagem >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Mensagem | CHAR | Mensagem exibida para o usuário ao confirmar a operação. Esta mensagem será exibida em azul na barra de status. | Sim |
Importante: este método é valido apenas para botões que habilitam confirmação, método TYPE igual a CONFIRM.
Exemplo
CALL _ADVPL_set_property(l_menubutton_reference,"CONFIRM_MESSAGE","Atualização executada com sucesso.")
Método SET: CONTROL_BUTTON
Sintaxe
_ADVPL_set_property(< l_menubutton_reference >,"CONTROL_BUTTON",< Botão de controle? >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Botão de controle? | BOOLEAN | Indicador que define se o botão será um botão de controle, ou seja, não será manipulado pelas operações do tipo CONFIRM. | Sim |
Exemplo
CALL _ADVPL_set_property(l_menubutton_reference,"CONTROL_BUTTON",FALSE)
Método SET: EVENT
Evento principal, executado ao clicar sobre o botão.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference >," EVENT ",< Função >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Função | BOOLEAN | Função que será executada ao clicar sobre o botão. | Sim |
Importante: para os botões de menu que possuem habilitação de confirmação, método TYPE igual a CONFIRM, este evento espera retorno verdadeiro ou falso. Caso o evento retornar falso, a operação será cancelada.
Método SET: EVENT_MESSAGE
Mensagem exibida para o usuário ao executar a operação.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference >,"EVENT_MESSAGE",< Mensagem >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Mensagem | CHAR | Mensagem exibida para o usuário ao executar a operação. Esta mensagem será exibida em um alerta. | Sim |
Importante: Este método é válido apenas para a operação de excluir (delete) e processar (process).
Exemplo
CALL _ADVPL_set_property(l_menubutton_reference,"EVENT_MESSAGE","Deseja excluir o registro atual?")
Método SET: HELP_NAME
Nome atribuído para o botão na ajuda online.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference>,"HELP_NAME",< Operação >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Operação | CHAR | Nome atribuído para o botão na ajuda online. | Sim |
Exemplo
CALL _ADVPL_set_property(l_menubutton_reference,"HELP_NAME","atualizar")
Método SET: IMAGE
Imagem atribuída para o botão.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference>,"IMAGE",< Imagem >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Imagem | CHAR | Imagem compilada no RPO a ser atribuída para o botão. | Sim |
Importante: é necessário a criação de uma imagem exatamente igual em preto-e-branco e com o nome do arquivo iniciando com a letra D, para ser visualizada quando o botão estiver desabilitado.
Exemplo
CALL _ADVPL_set_property(l_menubutton_reference,"IMAGE","LANCAMENTOS_EX")
Método SET: OPERATION
Nome da operação do botão.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference>,"OPERATION",< Operação >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Operação | CHAR | Nome da operação do botão. | Sim |
Importante: esta operação é o texto que será retornado pelo método CURRENT_OPERATION do componente LMenuBar.
Exemplo
CALL _ADVPL_set_property(l_menubutton_reference,"OPERATION","ATUALIZAR")
Método SET: TYPE
Tipo do botão.
Sintaxe
_ADVPL_set_property(< l_menubutton_reference>,"TYPE",< Tipo >)
Parâmetros
Nome | Tipo | Descrição | Obrigatório? |
---|---|---|---|
Tipo | CHAR | Tipo do botão de operação, sendo:
| Sim |
Importante: caso seja definido que o botão é do tipo CONFIRM, é necessário efetuar a chamada dos métodos CONFIRM_EVENT e CANCEL_EVENT.
Exemplo
CALL _ADVPL_set_property(l_menubutton_reference,"TYPE","NO_CONFIRM")
Exemplo
#----------------------# FUNCTION LMenuButton() #----------------------# DEFINE l_dialog_reference VARCHAR(10) DEFINE l_menubar_reference VARCHAR(10) DEFINE l_menubutton_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","Ex.: LMENUBAR") CALL _ADVPL_set_property(l_dialog_reference,"BACKGROUND_COLOR",210,210,210) LET l_menubar_reference = _ADVPL_create_component(NULL,"LMENUBAR",l_dialog_reference) CALL _ADVPL_set_property(l_menubar_reference,"HELP_VISIBLE",FALSE) LET l_menubutton_reference = _ADVPL_create_component(NULL,"LMENUBUTTON",l_menubar_reference) CALL _ADVPL_set_property(l_menubutton_reference,"IMAGE","QUIT_EX") CALL _ADVPL_set_property(l_menubutton_reference,"TYPE","NO_CONFIRM") CALL _ADVPL_set_property(l_menubutton_reference,"EVENT","LMenuButton_fecha_tela") LET l_label_reference = _ADVPL_create_component(NULL,"LCLABEL",l_dialog_reference) CALL _ADVPL_set_property(l_label_reference,"ALIGN","CENTER") CALL _ADVPL_set_property(l_label_reference,"TEXT","Exemplo de uma aplicação com menu.") CALL _ADVPL_set_property(l_dialog_reference,"MAXIMIZED",FALSE) CALL _ADVPL_set_property(l_dialog_reference,"ACTIVATE",TRUE) END FUNCTION