Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Corrigir documentação do comportamento do bloco de código de pós-validação - bValid

...

Portuguese

Pagetitle
TGet
TGet

Classe: TGet

Cria um objeto para entrada de dados editáveis.Esta classe permite armazenar ou alterar o conteúdo de uma variável através da digitação. No entanto, o conteúdo da variável será alterado quando o objeto perder o foco de edição para outro objeto.

TSrvObject -> TControl -> TGet


Create

Método construtor da classe.


TGet(): Create ( [ oWnd], [ bSetGet], [ nRow], [ nCol], [ nWidth], [ nHeight], [ cPict], [ bValid], [ nClrFore], [ nClrBack], [ oFont], [ uParam12], [ uParam13], [ lPixel], [ uParam15], [ uParam16], [ bWhen], [ lCenter], [ lRight], [ bChange], [ lReadOnly], [ lPassword], [ uParam23], [ cReadVar], [ uParam25], [ uParam26], [ uParam27], [ uParam28], [ uParam29], [ uParam30], [cLabelText] ,[nLabelPos], [oLabelFont], [nLabelColor], [cPlaceHold]) --> oObjeto


 

NomeTipoDescriçãoObrigatórioReferência
oWndObjetoIndica a janela ou controle visual onde o objeto será criado.  
bSetGetBloco de códigoIndica o bloco de código, no formato {|u| if( Pcount( )>0, := u, ) }, que será executado para atualizar a variável (essa variável deve ser do tipo caracter). Desta forma, se a lista for sequencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado.  
nRowNuméricoIndica a coordenada vertical em pixels ou caracteres.  
nColNuméricoIndica a coordenada horizontal em pixels ou caracteres.  
nWidthNuméricoIndica a largura em pixels do objeto.  
nHeightNuméricoIndica a altura em pixels do objeto.  
cPictCaracterIndica a máscara de formatação, do conteúdo, que será apresentada. Verificar Tabela de Pictures de Formatação  
bValidBloco de código

Indica o bloco de código de validação, que será executado quando

o conteúdo do objeto for modificado. Retorna verdadeiro (

este objeto estiver em foco, e o operador tentar mover o foco para outro componente da interface. Caso o bloco executado retorne .T.

), se o conteúdo é válido; caso contrário, falso (.F.)

, será permitida a mudança de foco. Caso o bloco executado retorne .F., não será permitido a remoção do foco do componente.

  
nClrForeNuméricoIndica a cor do texto do objeto.  
nClrBackNuméricoIndica a cor de fundo do objeto.  
oFontObjetoIndica o objeto, do tipo TFont, que será utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual.  
uParam12LógicoCompatibilidade.  
uParam13ObjetoCompatibilidade.  
lPixelLógicoIndica se considera as coordenadas passadas em pixels (.T.) ou caracteres (.F.).  
uParam15CaracterCompatibilidade.  
uParam16LógicoCompatibilidade.  
bWhenBloco de códigoIndica o bloco de código que será executado quando a mudança de foco da entrada de dados, no objeto criado, estiver sendo realizada. Se o retorno for verdadeiro (.T.), o objeto continua habilitado; caso contrário, falso (.F.).  
lCenterLógicoCompatibilidade.  
lRightLógicoCompatibilidade.  
bChangeBloco de códigoIndica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual.  
lReadOnlyLógicoIndica se o objeto pode ser editado.  
lPasswordLógicoIndica se, verdadeiro (.T.), o objeto apresentará asterisco (*) para entrada de dados de senha; caso contrário, falso (.F.).  
uParam23CaracterCompatibilidade.  
cReadVarCaracterIndica o nome da variável, configurada no parâmetro , que será manipulada pelo objeto. Além disso, esse parâmetro será o retorno da função ReadVar().  
uParam25CaracterCompatibilidade.  
uParam26CaracterCompatibilidade.  
uParam27LógicoCompatibilidade.  
uParam28NuméricoCompatibilidade.  
uParam29LógicoCompatibilidade.  
uParam30LógicoCompatibilidade  
cLabelTextCaractereindica o texto que será apresentado na Label.  
nLabelPosNuméricoIndica a posição da label, sendo 1=Topo e 2=Esquerda  
oLabelFontObjetoIndica o objeto, do tipo TFont, que será utilizado para definir as características da fonte aplicada na exibição da label.  
nLabelColorNuméricoIndica a cor do texto da Label.  
cPlaceHoldCaractereDefine o texto a ser utilizado como place holder, ou seja, o texto que ficará escrito em cor mais opaca quando nenhuma informação tiver sido digitada no campo. (disponível em builds superiores a 7.00.121227P)  

 

oObjeto
    ()
  • Retorna o objeto criado.

Em versões superiores à 120420A foi implementada a opção para definição de uma label(descrição) do componente visual. Preenchendo os parâmetros cLabelText, nLabelPos, oLabelFont e nLabelColor será disponibilizada, ao topo ou à esquerda, a descrição definida para o componente. Esta característica visa diminuir a quantidade de interações entre o SmartClient e o AppServer na construção de telas, otimizando assim este processo.

 Quando utilizada esta opção não será possível alinhar o componente, sendo a Label um objeto independente ela não será alinhada juntamente com o Controle principal, nesta situação é necessário fazer o posicionamento manualmente.

cTGet2 := "Teste TGet 02"oTGet2 := TGet():Create( oDlg,{||cTGet2},14,01,096,009,;"@!",,0,,,.F.,,.T.,,.F.,,.F.,.F.,,.F.,.F.,,cTGet2,,,, )

New

Método construtor da classe.


TGet(): New ( [ nRow], [ nCol], [ bSetGet], [ oWnd], [ nWidth], [ nHeight], [ cPict], [ bValid], [ nClrFore], [ nClrBack], [ oFont], [ uParam12], [ uParam13], [ lPixel], [ uParam15], [ uParam16], [ bWhen], [ uParam18], [ uParam19], [ bChange], [ lReadOnly], [ lPassword], [ uParam23], [ cReadVar], [ uParam25], [ uParam26], [ uParam27], [ lHasButton], [ lNoButton], [cLabelText] ,[nLabelPos], [oLabelFont], [nLabelColor], [cPlaceHold] ) --> oObjeto


 

NomeTipoDescriçãoObrigatórioReferência
nRowNuméricoIndica a coordenada vertical em pixels ou caracteres.  
nColNuméricoIndica a coordenada horizontal em pixels ou caracteres.  
bSetGetBloco de códigoIndica o bloco de código, no formato {|u| if( Pcount( )>0, := u, ) }, que será executado para atualizar a variável (essa variável deve ser do tipo caracter). Desta forma, se a lista for sequencial, o controle atualizará com o conteúdo do item selecionado, se for indexada, será atualizada com o valor do índice do item selecionado.  
oWndObjetoIndica a janela ou controle visual onde o objeto será criado.  
nWidthNuméricoIndica a largura em pixels do objeto.  
nHeightNuméricoIndica a altura em pixels do objeto.  
cPictCaracterIndica a máscara de formatação, do conteúdo, que será apresentada. Verificar Tabela de Pictures de Formatação  
bValidBloco de códigoIndica o bloco de código de validação que será executado quando o conteúdo do objeto for modificado. Retorna verdadeiro (.T.), se o conteúdo é válido; caso contrário, falso (.F.).  
nClrForeNuméricoIndica a cor do texto do objeto.  
nClrBackNuméricoIndica a cor de fundo do objeto.  
oFontObjetoIndica o objeto, do tipo TFont, que será utilizado para definir as características da fonte aplicada na exibição do conteúdo do controle visual.  
uParam12LógicoCompatibilidade.  
uParam13ObjetoCompatibilidade.  
lPixelLógicoIndica se considera as coordenadas passadas em pixels (.T.) ou caracteres (.F.).  
uParam15CaracterCompatibilidade.  
uParam16LógicoCompatibilidade.  
bWhenBloco de códigoIndica o bloco de código que será executado quando a mudança de foco da entrada de dados, no objeto criado, estiver sendo realizada. Se o retorno for verdadeiro (.T.), o objeto continua habilitado; caso contrário, falso (.F.).  
uParam18LógicoCompatibilidade.  
uParam19LógicoCompatibilidade.  
bChangeBloco de códigoIndica o bloco de código que será executado quando o estado ou conteúdo do objeto é modificado pela ação sobre o controle visual.  
lReadOnlyLógicoIndica se o objeto pode ser editado.  
lPasswordLógicoIndica se, verdadeiro (.T.), o objeto apresentará asterisco (*) para entrada de dados de senha; caso contrário, falso (.F.).  
uParam23CaracterCompatibilidade.  
cReadVarCaracterIndica o nome da variável, configurada no parâmetro bSetGet, que será manipulada pelo objeto. Além disso, esse parâmetro será o retorno da função ReadVar().  
uParam25CaracterCompatibilidade.  
uParam26CaracterCompatibilidade.  
uParam27LógicoCompatibilidade.  
lHasButtonLógicoIndica se, verdadeiro (.T.), o uso dos botões padrão, como calendário e calculadora.  
lNoButtonLógicoOculta o botão F3 (HasButton).  
cLabelTextCaractereindica o texto que será apresentado na Label.  
nLabelPosNuméricoIndica a posição da label, sendo 1=Topo e 2=Esquerda  
oLabelFontObjetoIndica o objeto, do tipo TFont, que será utilizado para definir as características da fonte aplicada na exibição da label.  
nLabelColorNuméricoIndica a cor do texto da Label.  
cPlaceHoldCaractereDefine o texto a ser utilizado como place holder, ou seja, o texto que ficará escrito em cor mais opaca quando nenhuma informação tiver sido digitada no campo. (disponível em builds superiores a 7.00.121227P)  

 

oObjeto
    ()
  • Retorna o objeto criado.
Em versões superiores à 120420A foi implementada a opção para definição de uma label(descrição) do componente visual. Preenchendo os parâmetros cLabelText, nLabelPos, oLabelFont e nLabelColor será disponibilizada, ao topo ou à esquerda, a descrição definida para o componente. Esta característica visa diminuir a quantidade de interações entre o SmartClient e o AppServer na construção de telas, otimizando assim este processo.

cTGet1 := "Teste TGet 01"oTGet1 := TGet():New( 01,01,{||cTGet1},oDlg,096,009,;"@!",,0,,,.F.,,.T.,,.F.,,.F.,.F.,,.F.,.F.,,cTGet1,,,, )

CtrlRefresh

Força a atualização do objeto.


TGet(): CtrlRefresh ( ) -->


 

oTGet:CtrlRefresh()

SelectAll

Seleciona todo o conteúdo da Get.


TGet(): SelectAll ( ) -->


 

oTGet:SelectAll()

SetContentAlign

Alinha o conteúdo interno do objeto.


TGet(): SetContentAlign ( < nAlign> ) -->


 

NomeTipoDescriçãoObrigatórioReferência
nAlignNuméricoIndica o tipo de alinhamento. Para informações dos tipos disponíveis, consulte a área Observações.X 

 


Os valores disponíveis para o parâmetro  são:

ValorDescrição
-1Alinha conteúdo à esquerda.
0Centraliza conteúdo.
1Alinha conteúdo à direita.

 

 

Importante
Método disponível para builds da TOTVS Tec superiores a "7.00.080806P - Oct  2 2008 - 11:47:14"

 


#include "TOTVS.CH"
user function tstGet()
local oDlglocal oGet1, nGet1:= 0.00
local oGet2, cGet2:="texto"
local oGet3, dGet3:= Date()
local oBtn1, oBtn2, oBtn3

DEFINE DIALOG oDlg FROM 0,0 TO 500,500 PIXEL @ 10,10

GET oGet1
VAR nGet1 SIZE 100,10 OF oDlg PIXEL PICTURE "@E 999999.99"@ 30,10
GET oGet2
VAR cGet2 SIZE 100,10 OF oDlg PIXEL @ 50,10
GET oGet3
VAR dGet3 SIZE 100,10 OF oDlg PIXEL @ 70,10
BUTTON oBtn1 PROMPT "Align Left" ACTION (SetGtAlign(oGet1,-1),SetGtAlign(oGet2,-1),SetGtAlign(oGet3,-1)) OF oDlg PIXEL@ 90,10
BUTTON oBtn2 PROMPT "Align Center" ACTION (SetGtAlign(oGet1,0),SetGtAlign(oGet2,0),SetGtAlign(oGet3,0)) OF oDlg PIXEL@ 110,10
BUTTON oBtn3 PROMPT "Align Right" ACTION (SetGtAlign(oGet1,1),SetGtAlign(oGet2,1),SetGtAlign(oGet3,1)) OF oDlg PIXEL

ACTIVATE DIALOG oDlg CENTEREDreturnfunction SetGtAlign(oGet,nAlign)
// Testa build que o método SetContentAlign() está disponívelif GetBuild()>="7.00.080806P-20081002" oGet:SetContentAlign(nAlign)endifreturn

 

PropriedadeDescriçãoTipo
cBufferRetorna o texto definido para o objeto.Caracter
cPictVarIndica a máscara de formatação, do conteúdo, que será apresentada. Verificar Tabela de Pictures de FormataçãoCaracter
cTextRetorna o texto definido para o objeto.Caracter
lPasswordIndica se, verdadeiro (.T.), o objeto apresentará asterisco (*) para entrada de dados de senha; caso contrário, falso (.F.).Lógico
cPlaceHoldTexto a ser usado como place holder, ou seja, que será exibido em cor mais opaca quando não tiver sido digitada nenhuma informação no campo. (disponível em builds superiores a 7.00.121227P)Caractere

 


Em builds superiores a 7.00.111010P o idioma do calendário, chamado a partir do componente TGet, respeitará o idioma definido no arquivo de inicialização do AppServer, na tag rpolanguage.
Em builds superiores a 7.00.121227P, caso o TGet tenha botão (calculadora, calendário, etc.), o CSS deste botão pode ser passado para o TGet que ele irá repassar para o botão.

#include "TOTVS.CH"
User Function TGet()
DEFINE DIALOG oDlg TITLE "Exemplo TGet" FROM 180,180 TO 550,700 PIXEL
// Usando o New
cTGet1 := "Teste TGet 01"
oTGet1 := TGet():New( 01,01,{||cTGet1},oDlg,096,009,; "@!",,0,,,.F.,,.T.,,.F.,,.F.,.F.,,.F.,.F.,,cTGet1,,,, )
// Usando o Create
cTGet2 := "Teste TGet 02"
oTGet2 := TGet():Create( oDlg,{||cTGet2},14,01,096,009,; "@!",,0,,,.F.,,.T.,,.F.,,.F.,.F.,,.F.,.F.,,cTGet2,,,, )
ACTIVATE DIALOG oDlg CENTERED Return

Exemplo da classe TGet

Advanced Protheus 6.09 , Advanced Protheus 7.10 , Microsiga Protheus 8.11 , Microsiga Protheus 11 , Protheus 10 , TOTVS Application Server 10 , ByYou Application Server

 

...