Histórico da Página
| Pagetitle | ||||
|---|---|---|---|---|
|
Hierarquia
- LCOMPONENTLCOMPONENT
Métodos GET
Métodos acessíveis utilizando a função _ADVPL_get_property, que permite recuperar e manipular os valores do componente:
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: ALIGNAlinhamento do componente em relação ao seu componente pai. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: CAN_GOT_FOCUSRetorna se o componente poderá ganhar foco. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: CHANGE_EVENTEvento executado quando o valor do componente for alterado. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: CLICK_EVENTEvento executado ao clicar no componente. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: COMPONENT_TYPETipo do componente. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: DOUBLE_CLICK_EVENTEvento executado ao efetuar um duplo clique no componente. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: EDITABLERetorna se o componente está editável. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: ENABLERetorna se o componente está habilitado. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: FORM_REFERENCEReferência da janela em que o componente está criado. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: GOT_FOCUS_EVENTEvento executado quando o componente ganhar foco. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: HANDLERCódigo nativo do componente ADVPL. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: HEIGHTAltura do componente em pixels. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: HELP_NAMECódigo do campo a ser identificado na ajuda online do componente. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: LOST_FOCUS_EVENTEvento executado quando o componente perder seu foco. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: PARENT_REFERENCEReferência do componente pai do componente atual. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Método GET:RIGHT_CLICK_EVENTREQUIREDRecupera se o componente tem conteúdo obrigatório ou não. Evento executado ao efetuar um clique com o botão direito do mouse no componente. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Método GET:SHOWRIGHT_CLICK_TOOLTIPEVENTEvento executado ao efetuar um clique com o botão direito do mouse no componente Retorna se está sendo exibido o texto de ajuda (exibido quando o usuário posicionar o cursor do mouse em cima do componente) informado. Sintaxe
Parâmetros
Retorno
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
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET: SHOW_TOOLTIPTexto 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
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET:VALIDTOOLTIPTexto de ajuda exibido quando o usuário posicionar o cursor do mouse em cima do componente. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método GET:VALUEVALIDRetorna o bloco de código, em ADVPL, que foi registrado para acionar uma função 4GL.
Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Método GET:VISIBLEVALUEValor definido para Retorna se o componente está visível. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
Método GET:WIDTHVISIBLERetorna se o componente está visívelLargura do componente em pixels. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Método GET:XWIDTHPosição em pixels do eixo X (horizontal) do componente em relação ao componente paiLargura do componente em pixels. Sintaxe
Parâmetros
Retorno
Exemplo
|
| Expandir | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Método GET:YXPosição em pixels do eixo Y X (verticalhorizontal) do componente em relação ao componente pai. Sintaxe
Parâmetros
Retorno
Exemplo
|
Métodos SET
Métodos acessíveis utilizando a função_ADVPL_set_property que permite alterar e manipular os valores do componente.| Expandir | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||
MétodoSETGET:ALIGNYPosição em pixels do eixo Y (vertical) Alinhamento do componente em relação ao seu componente pai. Sintaxe
Parâmetros
l_label_reference
Retorno
alinhamento
Alinhamento do componente em relação ao componente pai, sendo: |
Sim |
Exemplo
|
Métodos SET
Métodos acessíveis utilizando a função _ADVPL_set_property que permite alterar e manipular os valores do componente.
| Expandir | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
Método SET: ALIGNAlinhamento do componente em relação ao seu componente pai. Sintaxe
Parâmetros
Exemplo
Exemplo
|
| Expandir | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Método SET: BACKGROUND_COLORCor de fundo do componente em RGB (Red, Green and Blue). Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
Método SET: BOUNDSLimite do componente (posição horizontal e vertical, altura e largura) em relação ao componente pai. Sintaxe
Parâmetros
componentReference
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: CAN_GOT_FOCUSDefine se o componente poderá ganhar foco. Sintaxe
Parâmetros
componentReference
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: CHANGE_EVENTEvento executado quando o valor do componente for alterado. Sintaxe
Parâmetros
componentReference
functionName
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: CLICK_EVENTEvento executado ao clicar no componente. Sintaxe
Parâmetros
functionName
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: CSSEstilo CSS (Cascading Style Sheets) definido para o componente. Sintaxe
Parâmetros
Para definir o código CSS para o componente, deverá ser utilizado o nome dos componentes nativos do AdvPL (QT). Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: DOUBLE_CLICK_EVENTEvento executado ao efetuar um duplo clique no componente. Sintaxe
Parâmetros
treeReference
functionName
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: EDITABLEHabilita ou desabilita a edição do componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: ENABLEHabilita ou desabilita o componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
Método SET: FONTConfigurações de fonte utilizados para os textos do componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: FORCE_GET_FOCUSForça o foco para o componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Método SET: FOREGROUND_COLORCor da fonte do componente em RGB (Red, Green and Blue). Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: GOT_FOCUS_EVENTEvento executado quando o componente ganhar foco. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: HEIGHTAltura do componente em pixels. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: HELP_NAMECódigo do campo a ser identificado na ajuda online do componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Método SET: HOTKEYTecla de atalho definida para o componente. Sintaxe
Parâmetros
Tipo | Descrição | Obrigatório? | componentReference CHAR | Referência do componente. | Sim | tecla | Tecla de atalho conforme teclas disponíveis na lista de teclas de atalhos. | Sim | função | CHAR | Função que será executada ao acionar a tecla de atalho. | Sim | descrição | CHAR | Descriçã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 | componente | CHAR | Referência do componente do qual pertence a tecla de atalho. | Sim | Executa somente em foco? | BOOLEAN | Indicador lógico que define se o atalho deverá ser executado sempre ou somente quando o componente informado no método estiver focado em tela. | Sim |
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: LOST_FOCUS_EVENTCódigo do campo a ser identificado na ajuda online do componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
Método SET:LOST_FOCUS_EVENTPOSITIONPosição (horizontal e vertical) em pixels do componente em relação ao componente paiCódigo do campo a ser identificado na ajuda online do componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||
Método SET:POSITIONPROPERTYAtribui novas propriedades para o componentePosição (horizontal e vertical) em pixels do componente em relação ao componente pai. Sintaxe
Parâmetros
Exemplo
|
| Expandir | ||||||
|---|---|---|---|---|---|---|
| ||||||
Método SET:PROPERTYREFRESH_SIZEAtualiza as propriedades de coordenadas do componente (posição e tamanho)Atribui novas propriedades para o componente. Sintaxe
Parâmetros | ||||||
| Nome | Tipo | Descrição | Obrigatório? | |||
componentReference | CHAR | Referência do componente. | Sim | Propriedades | | Texto com as propriedades que serão atribuídas para o componente. |
REFRESH_SIZE") |
Esta função atualiza as propriedades de coordenadas do componente (X, Y, WIDTH e HEIGHT).
Exemplo
| Bloco de código | ||||||
|---|---|---|---|---|---|---|
| ||||||
CALL _ADVPL_set_property(componentReference,"PROPERTY","{'PICTURE','@!'}{'LENGTH',10}ADVPL_set_property(cComponentReference,"REFRESH_SIZE") |
| Expandir | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
Método SET:REFRESHREMOVE_SIZEVARIABLESAtualiza as propriedades de coordenadas do componente (posição e tamanho)Remove as variáveis definidas para o componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
Método SET:REMOVE_VARIABLESREQUIREDPermite apenas registrar o indicador de obrigatoriedade de conteúdo do componente.
Sintaxe
Exemplo
|
========> Cleane, verificar!
| Expandir | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
Método SET: RIGHT_CLICK_EVENT ========> Cleane, verificar!EVENTEvento executado ao efetuar um clique com o botão direito do mouse no componente. Sintaxe
Parâmetros
componentReference
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: SAVE_IMAGESalva uma imagem (print) do componente em uma imagem do tipo bitmap (BMP). Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: SHOW_TOOLTIPDefine se será exibido o texto de ajuda (exibido quando o usuário posicionar o cursor do mouse em cima do componente) informado. Sintaxe
Parâmetros
componentReference
Exemplo
|
| Expandir | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Método SET: SIZETamanho (largura e altura) em pixels do componente. Sintaxe
Parâmetros
componentReference
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: TOOLTIPTexto de ajuda exibido quando o usuário posicionar o cursor do mouse em cima do componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Método SET: VALIDEvento executado para validar o conteúdo do componente quando este perder seu foco. Sintaxe
Parâmetros
componentReference
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: VALUEValor definido para o componente. Sintaxe
Parâmetros
componentReference
CHAR
Exemplo
|
| Expandir | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Método SET: VARIABLEAdiciona uma variável que será controlada pelo componente. Sintaxe
Parâmetros
componentReference
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: VISIBLEHabilita ou desabilita a visualização do componente. Sintaxe
Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: WIDTHLargura do componente em pixels. Sintaxe
| Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: XPosição em pixels do eixo X (horizontal) do componente em relação ao componente pai. Sintaxe
| Parâmetros
Exemplo
|
| Expandir | |||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||
Método SET: YPosição em pixels do eixo X (horizontal) do componente em relação ao componente pai. Sintaxe
| Parâmetros
Exemplo
|