Você está na página 1de 489

Manual de Referncia de Scripts

Copyright 1999 - 2015 Elipse Software Ltda. Todos os direitos reservados.


Verso 4.6.162 (03/03/2015)

Sumrio
1 Introduo
................................................................................................................................................. 1
1.1 Objetos
.......................................................................................................................................... 1
1.2 Scripts
.......................................................................................................................................... 2
1.3 Picks
.......................................................................................................................................... 7
1.4 ..........................................................................................................................................
Eventos Definidos pelo Usurio
14
2 .................................................................................................................................................
Programando no E3
17
2.1 ..........................................................................................................................................
Ambiente de Programao
17
2.2 ..........................................................................................................................................
Declarando Variveis
18
2.3 ..........................................................................................................................................
Obtendo Referncias aos Objetos
18
2.4 ..........................................................................................................................................
Acessando Objetos
37
2.5 ..........................................................................................................................................
Trabalhando com Colees
38
2.6 ..........................................................................................................................................
Comando Set
39
2.7 ..........................................................................................................................................
E3Globals
40
2.8 ..........................................................................................................................................
Eventos, Mtodos e Propriedades Gerais dos Objetos
48
3 .................................................................................................................................................
Bibliotecas do Usurio
71
3.1 ..........................................................................................................................................
XControls e XObjects
71
3.2 ..........................................................................................................................................
Propriedades de um ElipseX
73
4 .................................................................................................................................................
Visualizao
76
4.1 ..........................................................................................................................................
Viewer
76
4.2
..........................................................................................................................................
Quadros e Divisores
104
4.3
..........................................................................................................................................
Telas e Objetos de Tela
111
4.4
..........................................................................................................................................
E3Alarm
232
4.5
..........................................................................................................................................
E3Browser
248
4.6
..........................................................................................................................................
E3Chart
255
4.7
..........................................................................................................................................
E3Playback
300
4.8
..........................................................................................................................................
Relatrios
301
5.................................................................................................................................................
Objetos de Servidor
342
5.1
..........................................................................................................................................
Propriedades Comuns
342
5.2
..........................................................................................................................................
Coleo de Campos de Usurio de Alarmes
344
5.3
..........................................................................................................................................
Objetos em Tempo de Execuo do Servidor
347
5.4
..........................................................................................................................................
Objetos em Tempo de Configurao
350
5.5
..........................................................................................................................................
Drivers
353
5.6
..........................................................................................................................................
Servidor de Dados
413
5.7
..........................................................................................................................................
Banco de Dados
436
5.8
..........................................................................................................................................
Histricos
439
5.9
..........................................................................................................................................
Storage
443
I

5.10
..........................................................................................................................................
Frmulas
451
5.11
..........................................................................................................................................
Alarmes
456
6.................................................................................................................................................
Dvidas Mais Frequentes
482

II

CAPTULO

Introduo

Os Scripts so mdulos de linguagem de programao nos quais se pode criar


procedimentos associados a eventos especficos, permitindo uma maior
flexibilidade no desenvolvimento de aplicaes. Cada objeto (item de um
aplicativo) do E3 possui uma lista de eventos previamente definidos, mas tambm
possvel definir novos eventos prprios do usurio.

1.1 Objetos
Os Objetos so componentes de software reutilizveis que permitem maximizar o
uso e aumentar a qualidade e produtividade em seus aplicativos.
Um objeto no E3 encapsula ou contm trs diferentes partes (propriedades,
mtodos e eventos) que podem ser manipuladas para a utilizao das vantagens de
sua funcionalidade na aplicao.
Propriedades definem atributos de um objeto, como a aparncia de um objeto de
Tela ou o valor inicial de um objeto quando o aplicativo iniciado.
Mtodos so funes que realizam uma ao especfica dentro ou com um objeto.
Eventos so notificaes geradas por um objeto em resposta a alguma ocorrncia
em particular, como um clique de mouse ou uma mudana no valor de um Tag,
entre outros.
Uma das principais caractersticas dos objetos e das linguagens orientadas a
objeto a capacidade de herana entre eles, ou seja, estes podem herdar as
caractersticas de um ou mais objetos, tendo as mesmas funcionalidades
especficas. Assim, pode se ter vrios objetos trabalhando em conjunto para prover
caractersticas de um outro objeto derivado.
Tome como exemplo o objeto E3Chart. Ele composto internamente de vrios
objetos, como ttulos, legendas, escalas, divises, consultas e penas. Note que cada
objeto contribui para a funcionalidade do todo: as escalas ajudam a localizar os
valores dos pontos no E3Chart; as legendas, a identificar a pena e seus valores; e a
pena realiza o desenho dos valores no E3Chart.
Atravs da manipulao de objetos dentro do E3Chart, pode-se criar duas
instncias deste objeto bastante diferentes entre si. Para se manipular um objeto
especfico, deve-se acess-lo atravs de uma hierarquia. Se os dois objetos E3Chart
estiverem na mesma Tela, deve-se acessar primeiro a Tela, depois o E3Chart
desejado, depois uma de suas propriedades ou objetos filhos. Quando h vrios
objetos de um mesmo tipo, geralmente eles podem ser acessados atravs de uma
coleo (collection). Uma coleo um objeto especial que gerencia um conjunto de
objetos semelhantes. Um exemplo no objeto E3Chart a coleo Pens, que permite
Introduo

o acesso a todas as penas do E3Chart.

1.2 Scripts
A linguagem que o E3 Studio usa em seus scripts o VBScript, um subconjunto da
linguagem Visual Basic desenvolvida pela Microsoft. O VBScript possui um
interpretador rpido, leve e portvel, desenvolvido para uso em navegadores para
a Internet e outras aplicaes que usam ActiveX Controls, Automation Servers e Java
Applets.
Conforme visto anteriormente, os scripts so associados a eventos de um objeto.
Entretanto, para facilitar e aumentar a velocidade de desenvolvimento, o E3 j
incorpora algumas aes mais comuns que poderiam ser realizadas com scripts,
atravs de assistentes chamados Picks. Pode-se portanto definir que um
determinado evento executar um script, um Pick ou uma combinao deles, em
uma sequncia tambm pr-definida.
Cada view do E3 Studio apresenta pelo menos duas abas na parte inferior: Design e
Scripts, com exceo dos objetos Banco de Dados e Servidor de Alarmes, que no
possuem a aba Design. Os objetos e seus filhos podem ser manipulados na aba
Design; para manipular seus scripts, utilize a aba Scripts. As opes disponveis
nesta ltima so:
Opes disponveis na aba Scripts
CONE

OPO
Lista de Objetos

DESCRIO
Sel eci ona o objeto
cujo s cri pt s er
ma ni pul a do.
Sel eci ona o
Lista de Eventos
evento a s er
a pl i ca do a o
objeto.
Adi ci ona um s cri pt
Script
a s s oci a do a o
evento.
Adi ci ona um Pi ck
Pick Abrir Tela
Abrir Tela.
Adi ci ona um Pi ck
Pick Abrir Tela
Abrir Tela Modal.
Modal
Adi ci ona um Pi ck
Pick Executar
Executar Aplicao.
Aplicao
Pick Carregar Valor Adi ci ona um Pi ck
Carregar Valor.
Pick Inverter Valor Adi ci ona um Pi ck
Inverter Valor.
Adi ci ona um Pi ck
Pick Imprimir
Imprimir Relatrio.
Relatrio

Introduo

CONE

OPO
Remover script ou
Pick selecionado
Mover script ou Pick
selecionado para
cima

Mover script ou Pick


selecionado para
baixo
AppBrowser
Procurar

Procurar anterior
Procurar prxima

Substituir

Criar evento do
usurio
Remover evento do
usurio
Editar evento do
usurio
Compila o script
selecionado

Compilar todos os
scripts deste evento

Introduo

DESCRIO
Remove o s cri pt
ou o Pi ck
s el eci ona do na
Li s ta de Aes .
Move a a o
s el eci ona da pa ra
ci ma , na ordem da
Li s ta de Aes
pa ra o evento.
Move a a o
s el eci ona da pa ra
ba i xo, na ordem
da Li s ta de Aes
pa ra o evento.
Abre a ja nel a do
AppBrows er.
Bus ca por
ocorrnci a s de um
determi na do
texto.
Sel eci ona na l i s ta
de res ul ta dos a
ocorrnci a
a nteri or.
Sel eci ona na l i s ta
de res ul ta dos a
ocorrnci a
s egui nte.
Subs ti tui a s
ocorrnci a s
encontra da s por
outro texto
es peci fi ca do.
Cri a um evento de
us u ri o.
Remove o evento
de us u ri o
s el eci ona do.
Edi ta o evento de
us u ri o
s el eci ona do.
Compi l a o s cri pt
s el eci ona do,
mos tra ndo os
erros no pa i nel
Mens a gens .
Compi l a todos os
s cri pts a s s oci a dos
a o evento.

CONE

OPO
Compila todos os
eventos deste
objeto

DESCRIO
Compi l a todos os
eventos
a s s oci a dos a o
objeto.

A ordem de execuo das aes de cima para baixo. Para alterar a ordem, pode-se
utilizar as opes e . Utilize a opo
para verificar se no h erros no script
especificado para o evento. As mensagens de erro do compilador so apresentadas
no painel Mensagens, que pode estar em uma janela flutuante ou ancorado na
parte inferior ou superior da aba Scripts. Clique duas vezes no erro caso deseje que
ele seja selecionado no script.

Mensagem do compilador

1.2.1 Adicionando um Script


Para adicionar um script a um objeto, siga estes passos:
1. Selecione o objeto para o qual se deseja criar o script e clique na aba Scripts.
4
Introduo

Aba Scripts

2. Clique sobre o cone


seguir.

Introduo

. O Editor de Scripts aberto, conforme a figura a

Adicionando um script ao objeto

3. Digite os comandos VBScript desejados na caixa de edio de texto.


NOTA: Uti l i ze o ca ra ctere de s ubl i nha do qua ndo des eja r a cres centa r uma quebra de
l i nha , pa ra dei xa r o cdi go ma i s l egvel . O ca ra ctere de s ubl i nha do i ndi ca que o
cdi go conti nua na l i nha s ubs equente.

Por exemplo:
If intTemperaturaCaldeira3 > 120 and _
intTemperaturaCaldeira4 > 120 Then
bEnviarAlarme = True
bAlarmeLigado = True
End If

Cada evento pode ter vrios scripts e vrios Picks associados, chamados Aes do
Evento. A lista das aes pode ser vista na parte superior da janela de edio de
scripts. Cada objeto pode ter qualquer quantidade de eventos com scripts ou Picks
associados.

Introduo

NOTA: Ao cl i ca r com o bot o di rei to do mous e s obre qua l quer des ta s a es


des cri ta s a nteri ormente, a bre-s e um menu contextua l que pos s i bi l i ta recorta r,
copi a r e col a r s cri pts e Picks entre eventos .

1.3 Picks
Os Picks implementam uma forma mais amigvel de realizar procedimentos mais
comuns, poupando tempo de configurao. Entre eles, esto aes como troca de
Tela ou atribuio de valores, bastante comuns na criao de um projeto. A seguir
so descritos os Picks disponveis na aba Scripts.

1.3.1 Abrir Tela


Abre uma determinada Tela ou Quadro.

Configuraes do Pick Abrir Tela


Opes disponveis no Pick Abrir Tela
OPO
Abrir a tela

Introduo

DESCRIO
Indi ca qua l Tel a deve s er a berta .

OPO
No quadro

Zoom inicial
Parmetro
Habilitar scroll da tela
Especificar posio da tela
Especificar tamanho da tela
Estilo da janela

DESCRIO
Indi ca o Qua dro onde a Tel a s er
vi s ua l i za da . Se es ti ver em bra nco, s er o
Qua dro pri nci pa l (_top).
Defi ne o zoom da Tel a , qua ndo
mos tra da .
Indi ca um pa r metro a s er pa s s a do na
cha ma da da Tel a .
Ha bi l i ta o us o da s ba rra s de rol a gem na
Tel a .
Indi ca a pos i o da Tel a , em pi xel s .
Indi ca o ta ma nho da Tel a , em pi xel s ou
Hi metri c.
Abre a ca i xa de di l ogo Estilo de janela.

1.3.1.1 Caixa de Dilogo Estilo de Janela


Permite configurar o estilo da janela a ser mostrada, definindo ttulo e a
disponibilidade das bordas e botes de fechar, maximizar e minimizar, entre outras
opes. Se a opo Usar configurao padro das janelas for marcada, o sistema
desabilita as opes desta janela e assume a configurao padro do Viewer,
conforme o que pode ser visto na aba Visualizador das propriedades do objeto
Viewer.

Introduo

Caixa de dilogo Estilo de Janela

1.3.2 Abrir Tela Modal


Abre uma Tela Modal, isto , uma Tela que no permite a interao do usurio com
outras Telas enquanto esta estiver ativa.

Introduo

Configuraes do Pick Abrir Tela Modal


Opes disponveis no Pick Abrir Tela Modal
OPO
Abrir a tela
Ttulo
Zoom inicial
Parmetro
Habilitar scroll da tela
Especificar a posio da tela
Especificar o tamanho da tela
Estilo da janela

10

DESCRIO
Sel eci ona a Tel a a s er a berta .
Defi ne o ttul o da ja nel a . Es s e texto s er
conca tena do com o nome da Tel a .
Defi ne o zoom da Tel a , qua ndo
mos tra da .
Indi ca um pa r metro a s er pa s s a do na
cha ma da da Tel a .
Ha bi l i ta o us o da s ba rra s de rol a gem na
Tel a .
Determi na a pos i o, em pi xel s , do
qua dro na Tel a , a pa rti r do ca nto
s uperi or es querdo da Tel a .
Determi na a l a rgura e a a l tura , em pi xel s
ou Hi metri c, da Tel a .
Permi te confi gura r o es ti l o da ja nel a a
s er mos tra da , defi ni ndo ttul o e a
di s poni bi l i da de da s borda s e botes de
fecha r, entre outra s opes (ver o tpi co
Caixa de Dilogo Estilo de Janela).

Introduo

1.3.3 Executar Aplicao


Executa uma aplicao especfica.

Configuraes do Pick Executar Aplicao


Opes disponveis no Pick Executar Aplicao
OPO
Aplicao

Argumentos
Executar no diretrio
Modo de exibio

Introduo

DESCRIO
Cl i ca ndo-s e em
pode-s e na vega r no
di s co pa ra i ndi ca r o a rqui vo da a pl i ca o
a s er executa da .
Permi te es peci fi ca r a rgumentos pa ra a
cha ma da da a pl i ca o.
Determi na o di retri o de tra ba l ho da
a pl i ca o que s er executa da .
Determi na o ti po de ja nel a de execu o
da a pl i ca o: Normal, Minimizado ou
Maximizado.

11

1.3.4 Carregar Valor


Carrega um valor em um Tag.

Configuraes do Pick Carregar Valor


Opes disponveis no Pick Carregar Valor
Nome do Tag

OPO

DESCRIO
Es peci fi ca o nome do Ta g no qua l s er
ca rrega do o va l or. Pode-s e es col her o Ta g

Valor

no AppBrows er cl i ca ndo em
.
Determi na o va l or que s er ca rrega do no
Ta g. Pode-s e es col her o ti po de da dos
cl i ca ndo na ca i xa de s el e o.

1.3.5 Inverter Valor


Permite inverter o valor de um Tag. Se o valor do Tag for igual a Valor1, ento o Tag
recebe Valor2. Se o valor do Tag for igual a Valor2, ento o Tag recebe Valor1. Se o
valor do Tag no for igual a Valor1 nem Valor2, o Tag recebe Valor1.
possvel colocar tantos Picks Inverter Valor quantos se desejar. Isso permite a
12

Introduo

verificao de mltiplos valores para um mesmo Tag ou at mesmo para diversos


Tags em um mesmo evento.

Configuraes do Pick Inverter Valor


Opes disponveis no Pick Inverter Valor
OPO
Nome do Tag
Valor 1
Valor 2

Introduo

DESCRIO
Cl i ca ndo em
, a bre-s e o AppBrows er
pa ra a es col ha do Ta g des eja do.
Determi na o pri mei ro va l or a s er
compa ra do. Se o va l or do Ta g for i gua l a
Valor1, ent o o Ta g recebe Valor2.
Determi na o s egundo va l or a s er
compa ra do. Se o va l or do Ta g for i gua l a
Valor2, ent o o Ta g recebe Valor1.

13

1.3.6 Imprimir Relatrio


Permite imprimir um Relatrio na tela ou na impressora.

Configuraes do Pick Imprimir Relatrio


Opes disponveis no Pick Imprimir Relatrio
OPO
Imprimir relatrio
Sada

DESCRIO
Permi te es col her o rel a tri o a s er
i mpres s o.
Determi na o ti po de s a da do rel a tri o:
Impressora: Envi a o rel a tri o pa ra a
i mpres s ora . Corres ponde a o mtodo Print
Tela: Executa uma prvi a de i mpres s o
do rel a tri o na tel a . Corres ponde a o
mtodo PrintPreview

1.4 Eventos Definidos pelo Usurio


Apesar do E3 vir com uma extensa gama de eventos, muitas vezes o usurio pode
desejar criar um evento especfico para sua aplicao.
14

Introduo

Um exemplo para a utilizao de eventos definidos pelo usurio seria a realizao


de um clculo ou tarefa mais complexa em um objeto, quando o evento gerador vem
de um outro Tag ou propriedade.
Apesar de se poder criar e executar este mesmo tipo de trabalho a partir do prprio
Tag ou da propriedade geradora do evento, existem vantagens em manter-se o
script junto ao objeto que sofrer a ao. Dentre elas, pode-se citar o trabalho
adicional necessrio para fazer um objeto apontar para outro, alm de facilidades
de manuteno, pois se por algum motivo for necessrio modificar ou apagar o Tag
ou a propriedade que seja o evento gerador, no necessrio modificar um
segundo objeto.
Outra vantagem o fato de que se o Tag gerador do evento for apagado, o objeto
no perder o script, basta que se indique uma outra fonte geradora de evento.
A gerao de eventos internos facilita ainda a criao de bibliotecas, pois cada vez
que um componente de biblioteca inserido em uma aplicao, ele traz consigo os
scripts e clculos que podem ser necessrios, diminuindo o trabalho de
configurao.
Para gerar um novo evento interno em um objeto, siga estes procedimentos:
1. Clique em Criar evento do usurio , ou ento em Criar novo evento na
Lista de Eventos. O E3 abrir uma janela para a definio das propriedades do
evento.

Janela para a adio de eventos definidos pelo usurio

Introduo

15

Opes disponveis na janela Eventos


OPO
Nome do Evento
Propriedade ou expresso

DESCRIO
Nome que i denti fi ca o evento.
Expres s o gera dora do evento. Pode s er
copi a da a tra vs do AppBrows er, a o cl i ca r

em
.
Sempre que a propriedade for uma condio Indi ca que o evento s er do ti po etOnEvent
(o evento ocorre no momento que a
verdadeira
expres s o for verda dei ra ) ou etWhileEvent
(o evento ocorre ci cl i ca mente, em
i nterva l os pr-defi ni dos ).
Qua ndo preenchi do, i ndi ca que o evento
Repetir o evento
s er do ti po etWhileEvent. Indi ca o ci cl o de
repeti o do evento em mi l i s s egundos ,
i s to , de qua nto em qua nto tempo el e i r
ocorrer, enqua nto a expres s o gera dora
for verda dei ra .
Indi ca que o evento s er do ti po
Sempre que a propriedade alterar o seu
etOnValueChanged, i s to , o evento i r
valor
ocorrer s empre que a expres s o gera dora
muda r de va l or.
Indi ca s e a conex o ou des conex o da
Tratar a desconexo como mudana de
expres s o gera dora do evento dever s er
valor
tra ta da como muda na .

2. Clique em OK para completar o processo e inserir o evento. Ele ir aparecer na


lista de eventos.
3. Para alterar este evento, selecione-o e clique em Editar evento do usurio
janela anterior ser aberta novamente para a edio de dados do evento.

.A

4. Para apagar este evento, selecione-o e clique em Remover evento do usurio


.
IMPORTANTE: Qua ndo s e cl i ca em Remover evento do usurio, os s cri pts des te evento
s er o perdi dos .

16

Introduo

CAPTULO

Programando no E3

Apesar de a maioria dos aspectos do VBScript se aplicarem programao de


scripts no E3, algumas particularidades devem ser destacadas no que diz respeito
s implementaes do conceito de orientao a objetos no sistema.
O VBScript uma linguagem baseada no Visual Basic que traz a capacidade de
scripting (roteirizao) para aplicaes que rodam no sistema operacional
Windows.
O VBScript troca informaes com as aplicaes utilizando a tecnologia ActiveX
Scripting. Com o ActiveX Scripting, navegadores e outras aplicaes cliente, como o
Viewer, podem compilar scripts e chamar funes, dentre outros procedimentos.
Isso possibilita que scripts desenvolvidos para uma aplicao ou biblioteca, que
devam ser executados na interface grfica, possam ser executados tanto no Viewer
quanto em um navegador de Internet, sem a necessidade de qualquer adaptao do
aplicativo.
Mais informaes sobre o VBScript podem ser obtidas no manual Guia de
Referncia do VBScript, no Grupo de Programas Elipse E3.

2.1 Ambiente de Programao


O ambiente de programao de scripts no E3 Studio pode ser acessado atravs do
clique com o boto direito do mouse sobre qualquer objeto, escolhendo-se a opo
Propriedades. Na aba Scripts da view do objeto, pode-se ver a caixa de seleo onde
se define qual evento ser o gerador do script. Como visto no captulo anterior,
existem dois tipos de eventos em um objeto do E3, os Pr-Definidos e os Definidos
pelo Usurio.
Os eventos pr-definidos variam de objeto para objeto, dependendo da sua
utilizao e funcionalidade. Um objeto de Tela, por exemplo, possui eventos
relacionados interface grfica, como Click (chamado ao clicar sobre o objeto) ou
DbClick (chamado com um duplo clique do mouse); j um objeto como um Driver de
Comunicao possui eventos relacionados comunicao, como OnCommError
(chamado quando h um erro de comunicao). Pode-se tambm definir outros
eventos para o objeto, como visto anteriormente.
Quando um script associado a um evento em um objeto, o campo de digitao
apresenta uma declarao de procedimento (procedure), cuja definio
automtica e composta do seguinte texto:
Sub NomeDoObjeto_NomeDoEvento()
End Sub

Onde NomeDoObjeto o nome do objeto associado e NomeDoEvento o nome do


Programando no E3

17

evento em questo. Os comandos do script devero estar entre essas duas linhas.
Para ajudar na digitao do script, pode-se utilizar o AppBrowser. Ao se escolher o
mtodo ou propriedade desejada, pode-se utilizar a opo Copiar. O Tag,
propriedade ou mtodo escolhidos sero inseridos na posio do cursor na rea
de edio do script. O local do cursor mostrado atravs de uma animao com
seta piscante.

2.2 Declarando Variveis


possvel declarar variveis de duas maneiras: implicitamente ou explicitamente.
Para declarar uma varivel implicitamente, basta usar seu nome no script.
Automaticamente, a varivel ser criada e inicializada com o valor da atribuio,
ou permanecer com o valor EMPTY (vazia, sem nenhum valor), caso no receba
nenhum valor antes de ser utilizada.
Esta uma prtica rpida, porm se o script for muito extenso, isto pode causar
confuso e a criao de mais de uma varivel com o mesmo nome, gerando bugs no
script.
Para declarar variveis explicitamente, utiliza se o comando Dim, como no
exemplo:
Dim Temperatura

Pode-se declarar mltiplas variveis separando cada nome de varivel com uma
vrgula. Por exemplo:
Dim Esquerda, Direita, Topo, Base

Em virtude dos scripts no E3 serem todos associados a um objeto em particular, as


variveis so sempre locais, vlidas apenas para o escopo do script. Para ter-se
variveis pblicas ou globais, deve-se criar um Tag Interno e utiliz-lo para
armazenar o valor desejado.

2.3 Obtendo Referncias aos Objetos


Uma das caractersticas mais importantes ao se trabalhar com scripts dentro do E3
considerar a separao existente entre os processos que so executados no
servidor e aqueles executados na interface do cliente (Viewer). Para se trabalhar
com scripts, pode-se manipular:
Objetos do servidor atravs do servidor
Objetos do servidor atravs do(s) Viewer(s)
Objetos do Viewer atravs do mesmo Viewer
No entanto, no se pode manipular diretamente:
18

Programando no E3

Objetos do Viewer atravs do servidor (s possvel atravs da criao de


eventos no Viewer, ligados a variveis que esto no servidor)
Objetos de um Viewer a partir de outro Viewer (s possvel atravs da criao
de eventos ligados a variveis que esto no servidor)
Tais limitaes so decorrentes do fato de que, por definio, existe uma
independncia entre o que cada uma das estaes Viewer est executando ou
visualizando e o servidor, e vice-versa. Por isso, todas as atividades, tanto do
servidor como do Viewer, necessitam ser coordenadas de forma assncrona ou
atravs de eventos para operarem de forma harmoniosa.
Logo, devido a esta independncia ao se criar um script, primeiro deve-se obter
uma referncia correta dos objetos que se deseja manipular, ou seja, necessrio
que o objeto seja primeiramente encontrado nos vrios mdulos do E3.
Vale repetir que, ao se editar um script, o usurio poder utilizar o AppBrowser,
que permite copiar para o script o caminho de um mtodo ou propriedade de forma
completa, auxiliando-o na criao de scripts.
Portanto, para acessar os objetos externos que esto sendo manipulados em um
script, so utilizadas algumas diretivas bsicas. Por exemplo, para se manipular o
valor de um Tag de Comunicao, o caminho Servidor - Driver - Pasta (se houver) Tag. J se o objetivo manipular um boto na Tela, o caminho Viewer - Quadro
(se houver) - Tela - Boto.
Existem basicamente trs localizaes de origem de scripts, do ponto de vista da
metodologia para acesso dos objetos:
Servidor
Telas e Quadros (Viewer)
ElipseX (bibliotecas): podem ser XObjects (rodam no servidor) e XControls
(rodam no Viewer)

2.3.1 Acessando Propriedades do Servidor


Para se acessar um objeto que est sendo executado no servidor a partir de um
objeto de Tela ou um ElipseX, deve-se usar o mtodo Application.GetObject.
A palavra Application retorna o objeto de aplicao relacionado ao contexto atual
do objeto, e o mtodo GetObject procura no servidor por um objeto dentro de
Application com o nome fornecido. Exemplo:
Sub Button1_Click()
Application.GetObject("Driver1")._
Item("tag001").AllowRead = False
End Sub

Ou ainda:
Programando no E3

19

Sub Button1_Click()
Application.GetObject("Driver1.tag001").AllowRead = False
End Sub

O mtodo Item foi utilizado para, a partir da referncia de Driver1, localizar o


tag001, pois o Driver uma coleo de Tags. Depois de localizado o objeto, suas
propriedades e funes podem ser acessadas livremente.
Caso alguma outra operao tivesse que ser realizada com Driver1 ou tag001,
outra alternativa para o script anterior seria:
Sub Retangulo1_Click()
Set obj = Application.GetObject("Driver1")
obj.Item("tag001").AllowRead = False
obj.Item("tag002").AllowRead = False
End Sub

Neste caso, a varivel obj est apontando para o objeto Driver1 e na prxima vez
que se quiser acessar algum objeto que descende de Driver1 dentro do script,
pode-se utilizar a varivel obj diretamente. Isto traz um ganho de performance, j
que cada chamada do mtodo GetObject faz um acesso ao servidor. Atravs desta
tcnica, chamadas desnecessrias ao servidor so evitadas. Este exemplo usa o
comando Set, que ser explicado mais adiante. Note que a utilizao de variveis
tambm torna o cdigo mais claro e de modificao mais fcil. Caso seja
necessrio alterar o objeto no qual queremos executar comandos, basta mudar a
linha de atribuio dessa varivel.
A palavra Application nos scripts pode indicar tanto funes que so executadas no
Viewer quanto no servidor. Neste caso, o objeto Application sabe de antemo quais
funes devem ser executadas tanto para um quanto para o outro caso. No
possvel, entretanto, executar funes de Viewer dentro do servidor, assim como
tambm no possvel executar funes de servidor dentro do Viewer.

2.3.2 Acessando Propriedades do Studio


Para acessar um objeto de servidor qualquer em um script que roda no Studio
pode-se usar a diretiva Application.GetObject. A palavra Application retorna o
objeto de aplicao relacionado ao contexto atual do objeto, e o mtodo GetObject
procura no Domnio carregado no Studio por um objeto de servidor com o caminho
fornecido. Exemplo (o evento CustomConfig disparado no Studio):
Sub XControl1_CustomConfig
Application.GetObject("Dados.TagDemo1").DocString =
"Documentao"
End Sub

20

Programando no E3

2.3.3 Acessando Propriedades do Servidor de dentro do


Servidor
Caso seja necessrio acessar as propriedades de um Tag a partir de outro, origem e
destino esto no servidor ligados via um mdulo pai, que Driver1.
Nesta situao, deve ser usada a propriedade Parent. Isto faz com que seja
acessado primeiro o objeto pai onde est o script, para depois descer-se na
hierarquia em busca de outro elemento.

Driver1 o objeto pai de Tag1 e de Tag2

Exemplo:
Sub Tag1_OnRead()
Parent.Item("Tag2").AllowRead = False
End Sub

Estando-se dentro de um grupo, e desejando-se acessar o mesmo Tag2, pode-se


aninhar vrios comandos Parent.

Programando no E3

21

Pasta1 o objeto pai de Tag1

Exemplo:
Sub Tag1_OnRead()
Parent.Parent.Item("Tag2").AllowRead = False
End Sub

2.3.4 Acessando Objetos de uma Tela a partir de um Script


na Tela
Deve-se usar somente o mtodo Item, j que os objetos so filhos da Tela. Exemplo:
Sub Tela1_OnPreShow(vArg)
Item("Retangulo1").Visible = True
End Sub

22

Programando no E3

Retangulo1 um item da TelaInicial

2.3.5 Acessando Objetos de uma Tela a partir de um Script


em outro Objeto na Tela
Pode-se usar a propriedade Parent ou o mtodo Screen.

TelaInicial o objeto pai de Retangulo1 e


Retangulo2

Exemplo:
Sub Retangulo1_Click()
Parent.Item("Retangulo2").Visible = True
End Sub

Programando no E3

23

2.3.6 Modificando a Tela ou Objetos de Tela a partir do


Servidor
A modificao de um comportamento qualquer em uma Tela s pode ser feita a
partir de Associaes (o servidor reporta automaticamente para os Viewers todas
as mudanas das variveis escolhidas), ou atravs de uma busca explcita do
Viewer por informaes no servidor. Toda a operao de associao da interface
grfica feita do cliente para o servidor, e no do servidor para o cliente. Assim,
no possvel modificar Telas ou objetos a partir do servidor via scripts, pois cada
cliente de dados uma cpia diferente das Telas.
Um exemplo prtico mudar a cor de um texto na Tela para verde quando um Tag
for ligado (valor um) e para vermelho quando for desligado (valor zero). Neste caso,
deve-se simplesmente criar uma Associao Digital entre a propriedade TextColor
de Texto1 com o Tag1. Associaes so preferveis devido rapidez de execuo e
simplicidade de manuteno e construo da aplicao.

Associando a cor do texto ao valor de Tag1

Uma outra forma de executar o procedimento anterior criar um script no Viewer


que verifique constantemente se o Tag1 mudou ou no de valor, para ento mudar
a cor do texto. Este tipo de script possvel de ser realizado, mas degrada muito a
performance da aplicao. Por isto, esta prtica no aconselhvel.

24

Programando no E3

2.3.7 Acessando Objetos de um ElipseX a partir do prprio


ElipseX
Na criao de um ElipseX, pode-se declarar propriedades (XProperties) e inserir
objetos, que podem ser objetos de Tela (XControl) ou objetos do servidor (XObject).
Para se acessar as XProperties atravs de scripts, basta acessar o nome da
propriedade diretamente.

Aba Design

Programando no E3

25

Aba Propriedades

Por exemplo, na figura anterior temos o XControl1 com a propriedade


Propriedade1, e os objetos Texto1 e Retangulo1.
A propriedade Propriedade1, do tipo Booleano, pode ser acessada com o script a
seguir:
Sub XControl1_OnStartRunning()
XControl1.Propriedade1 = True
End Sub

Ou ainda:
Sub XControl1_OnStartRunning()
Propriedade1 = True
End Sub

Se o ElipseX possui objetos internos, ento possvel utilizar o mtodo Item para
obter uma referncia destes objetos. Por exemplo:
Sub XControl1_OnStartRunning()
Item("Texto1").Value = "motor"
Item("Retangulo1").ForegroundColor = RGB(212, 208, 20)
End Sub

26

Programando no E3

2.3.8 Acessando Objetos de um ElipseX Externamente


O acesso externo a um objeto ElipseX s pode ser feito atravs de suas
propriedades, utilizando suas instncias criadas. No possvel acessar objetos
internos diretamente.
Se o ElipseX em questo for um XControl, ele se comporta como um objeto de Tela.
Por exemplo, considere a aplicao da figura a seguir.

XControl (exemplo)

Para alterar a propriedade Propriedade1 do XControl pode-se fazer o seguinte


script no evento Click de um boto:
Sub CommandButton1_Click()
Screen.Item("XControl11").Propriedade1 = True
End Sub

Ou ainda:
Sub CommandButton1_Click()
Parent.Item("XControl11").Propriedade1 = True

Programando no E3

27

End Sub

No caso de um XObject, deve-se inseri-lo em um Servidor de Dados:

XObject (exemplo)

Um script para alterar a propriedade Valor do XObject seria:


Sub CommandButton1_Click()
Application.GetObject("Dados.XObject11").Valor = 123
End Sub

Ou ainda:
Sub CommandButton1_Click()
Application.GetObject("Dados").Item("XObject11").Valor = 123
End Sub

Pode-se ainda ter um XControl acessando um XObject, atravs de uma XProperty.


Por exemplo, a figura mostra um XControl chamado "XControl1" que possui uma
propriedade XValor do tipo XObject1, que o nome do XObject criado.

28

Programando no E3

XObject

Programando no E3

29

XControl

Faz-se, por exemplo, uma Associao do valor do objeto "Texto1" com a


propriedade Valor do "XObject1". Isso feito atravs da propriedade XValor, criada
no "XControl1". Assim, o valor da propriedade Valor do "XObject1" mostrada no
objeto "Texto1" do "XControl1".

30

Programando no E3

Propriedade Valor

No projeto, o vnculo da instncia "XObject11" instncia "XControl11" pode ser


feito atravs de uma Associao na propriedade XValor.

Programando no E3

31

XValor (Associao)

2.3.8.1 Exemplo de Criao de um ElipseX


Suponha que determinada aplicao necessite supervisionar e comandar 10
motores. Cada motor precisa ser representado por um desenho na Tela, que exibe a
cor verde quando estiver operando, e vermelho quando estiver desligado. Tambm
deve ser permitido o comando do motor na Tela, enviando instrues para ligar e
desligar, e sua velocidade tambm deve ser exibida.
Uma possibilidade a criao de um XControl chamado MotorA, com as
propriedades Estado igual a Boolean e Velocidade igual a Double, conforme a figura
a seguir:

32

Programando no E3

Aba Design

Programando no E3

33

Aba Propriedades

1. Para a indicao da cor, a propriedade OverrideFillColor do motor deve estar


associada propriedade Estado do XControl, atravs de uma Associao
Digital. Configure a propriedade OverrideFillMode para 2 - SolidFill.
2. Para exibir a velocidade, a propriedade Value do Display deve ser associada
propriedade Velocidade do XControl.
3. O Boto Liga-Desliga troca o valor da propriedade Estado atravs de uma
Associao Simples.
Note que:
As Associaes dentro da biblioteca so internas, e seu formato
Nome_do_Controle.Nome_da_Propriedade
O objeto, depois de inserido na Tela, dever ter essas propriedades associadas
aos Tags verdadeiros, para cada um dos motores
Uma Associao de um Tag para a propriedade Estado ter que ser feita para
cada MotorA
34

Programando no E3

Viewer

Outra possibilidade, mais abrangente, utiliza um XObject para o motor. Desta


forma, todas as informaes relativas aos motores residem em objetos que ficam
no servidor. Assim, pode-se construir vrios tipos de interface para o motor
(XControls) que trazem do servidor, atravs do XObject, somente as informaes
necessrias.
Desta maneira, o objeto MotorA teria que ser modificado para apontar para um
XObject, ao invs de declarar em si mesmo todas as propriedades.
1. Crie um XObject chamado MotorADados, e declare nele as propriedades Estado
e Velocidade.
2. Crie um XControl MotorA que possua apenas uma propriedade, chamada
MeusDados, do tipo MotorADados.
3. MotorADados dever ser inserido em uma Pasta de Dados no servidor, e
corresponder a cada um dos motores. MotorA por sua vez ir apontar para o
MotorADados desejado, no sendo necessria a criao de novos Tags.
Programando no E3

35

Configurao na view do XObject

36

Programando no E3

Configurao na view do XControl

4. A propriedade Estado, associada propriedade OverrideFillColor do motor,


fica MotorA.MeusDados.Estado.
5. A propriedade Velocidade, associada ao Display, fica
MotorA.MeusDados.Velocidade.

2.4 Acessando Objetos


Seguindo o conceito de encapsulamento de programao orientada a objetos, os
mtodos e propriedades ficam associados a seus objetos de origem. Isto significa
que sempre se deve indicar o objeto do qual se est acessando o mtodo ou
propriedade.

2.4.1 Propriedades
Para referenciar as propriedades de um objeto, deve-se usar o mtodo GetObject. A
sintaxe a seguinte:
Application.GetObject("<objeto>").<propriedade>

Programando no E3

37

Onde <objeto> o nome do objeto e <propriedade>, a propriedade desejada.


Exemplo:
Application.GetObject("Dados.TempTanque2").Type

Para facilitar a digitao, aconselhvel sempre utilizar o AppBrowser, que j traz


a sintaxe correta.

2.4.1.1 Propriedade Value


No E3, muitos objetos possuem uma propriedade em comum chamada Value. Neste
caso especfico, pode-se acessar esta propriedade utilizando se o prprio nome do
objeto:
Button1 = False

Que equivalente a:
Button1.Value = False

2.4.2 Mtodos
A sintaxe a seguir exemplifica a chamada de um mtodo que no precisa de
parmetros:
Application.GetObject("<objeto>").<metodo>

Onde <objeto> o objeto em questo e <metodo>, o mtodo desejado.


Se o mtodo aceita parmetros, use a sintaxe a seguir:
Application.GetObject("<objeto>").<metodo>(<parametro>)

Onde <parametro> o parmetro a ser passado para o mtodo. Quando houver


mais de um parmetro, utilize vrgulas para separ-los.
Se o mtodo retorna um resultado, e for desejvel guard-lo, ento os parmetros
devem ser colocados obrigatoriamente entre parnteses:
<V> =Application.GetObject("<objeto>").<metodo>(<parametro>)

Onde <V> a varivel que ir receber o resultado do mtodo.

2.5 Trabalhando com Colees


Uma coleo (ou collection) um objeto que gerencia um conjunto de objetos
similares. Os objetos contidos em uma coleo so referenciados por ndices,
semelhante referncia de arrays. Pode-se adicionar ou remover objetos
individuais de uma coleo, conforme o exemplo a seguir.
Sub CommandButton1_Click()
' Adiciona uma pena no objeto E3Chart1

38

Programando no E3

Screen.Item("E3Chart1").Pens.AddPen "Pena"
End Sub
Sub CommandButton2_Click()
' Remove a primeira pena
Screen.Item("E3Chart1").Pens.Remove 0
End Sub
NOTA: o pri mei ro objeto em uma col e o pos s ui ndi ce 1 (um).

Todas as colees possuem uma propriedade em comum chamada Count, que o


nmero de objetos (ou filhos) existentes. Exemplo:
Sub CommandButton1_Click()
' Mostra uma caixa de dilogo com o nmero de penas
MsgBox Screen.Item("E3Chart1").Pens.Count
End Sub

2.5.1 Acessando Objetos com o Mtodo Item


Toda coleo possui um mtodo Item, que pode ser usado para acessar qualquer
objeto dentro da coleo. O mtodo Item aceita um parmetro Item, que pode ser
um nmero (inteiro positivo) ou o nome do objeto dentro da coleo que se deseja
acessar. Os exemplos a seguir so de ajustes da cor da segunda Pena do objeto
E3Chart:
Sub CommandButton1_Click()
' Modifica a cor da terceira pena
Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(212, 208,
20)
End Sub

Ou ainda:
Sub CommandButton1_Click()
' Modifica a cor da pena com nome "Pena2"
Screen.Item("E3Chart1").Pens.Item("Pena2").Color = RGB(212,
208, 20)
End Sub

Os comandos anteriores so equivalentes, o primeiro indicando o ndice da Pena


na coleo, e o segundo indicando o nome da Pena.

2.6 Comando Set


O VBScript implementa o conceito de polimorfismo das linguagens orientadas a
objeto, permitindo que uma varivel do tipo Variant assuma a forma de um objeto
qualquer, atravs do comando Set. Deste modo, a varivel funciona como um
ponteiro para o objeto desejado, permitindo acessar seus mtodos e propriedades.
Programando no E3

39

Exemplo:
Sub CommandButton1_Click()
Set E3Chart = Screen.Item("E3Chart1")
E3Chart.Pens.Item(2).Color = RGB(212, 208, 20)
End Sub

Neste exemplo foi feita a mesma tarefa que na seo anterior, porm a parte
referente a como chegar at o objeto especfico havia sido omitida. Sem o comando
Set, a mesma chamada teria que ser escrita da seguinte forma:
Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(212, 208, 20)

Aparentemente, no existe vantagem neste caso, pois pode-se fazer tudo em uma
nica linha de cdigo. Porm, se logo abaixo no mesmo script outras operaes
forem necessrias, o processo se torna mais simples e rpido se a chamada ao
mtodo Item no tiver sido colocada em todas as linhas.
Sub CommandButton1_Click()
' Exemplo ruim
Screen.Item("E3Chart1").Pens.Item(0).Color = RGB(212, 208,
20)
Screen.Item("E3Chart1").Pens.Item(1).Color = RGB(200, 208,
20)
Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(100, 208,
20)
End Sub
Sub CommandButton2_Click()
' Exemplo melhor
Set Penas = Screen.Item("E3Chart1").Pens
Penas.Item(0).Color = RGB(212, 208, 20)
Penas.Item(1).Color = RGB(200, 208, 20)
Penas.Item(2).Color = RGB(100, 208, 20)
End Sub

2.7 E3Globals
O E3Globals um mdulo do E3 que contm mtodos de uso global. Os mtodos
GetCurrentWindowsUserName, GetLocalTime e GetLocalTimeUTC no podem ser
utilizados em Associaes, somente em scripts. O restante dos mtodos pode ser
utilizado tanto em scripts quanto em Associaes.
A forma de utilizao destes mtodos admite duas sintaxes, E3Globals.<mtodo>
ou simplesmente <mtodo>, exceto no caso do objeto Relatrio, onde a sintaxe
E3Globals.<mtodo> obrigatria.

2.7.1 Mtodos
Esta seo contm informaes sobre os mtodos do mdulo E3Globals.
40

Programando no E3

2.7.1.1 BShl
BShl(Value, Bits)
Retorna o valor passado no parmetro Value deslocado esquerda o nmero de
bits especificado no parmetro Bits. Este mtodo retorna um erro caso o parmetro
Bits esteja fora da faixa permitida (entre 0 e 31). Este mtodo est disponvel tanto
em Associaes quanto em scripts.

2.7.1.2 BShr
BShr(Value, Bits[, PreserveSign])
Retorna o valor passado no parmetro Value deslocado direita o nmero de bits
especificado no parmetro Bits. Este mtodo retorna um erro caso o parmetro Bits
esteja fora da faixa permitida (entre 0 e 31). O parmetro PreserveSign um
Booleano opcional que, se verdadeiro, preenche os bits esquerda com uma cpia
do bit de sinal. O valor padro deste parmetro (Falso) preenche os bits esquerda
com zeros. Este mtodo est disponvel tanto em Associaes quanto em scripts.

2.7.1.3 Choose
Choose(Index, Values)
Retorna um dos itens especificados em Values, baseado no parmetro Index
(iniciando em zero). Este mtodo retorna Null caso o valor de Index seja menor que
0 ou maior ou igual ao nmero de valores em Values. Este mtodo est disponvel
tanto em Associaes quanto em scripts.
NOTA: O mtodo Choose n o propa ga a qua l i da de nem o timestamp dos va l ores . Se
uma As s oci a o conti ver a expres s o Choose(TagIndex, Tag1.Value,
Tag2.Value, Tag3.Value), o res ul ta do s er o va l or es col hi do, porm com
qua l i da de Boa (192) e timestamp a tua l . Pa ra que es s a s i nforma es s eja m
pres erva da s , neces s ri o es peci fi ca r s omente o objeto, como por exempl o
Choose(TagIndex, Tag1, Tag2, Tag3).

2.7.1.4 E3Format
E3Format(Value, Format)
Formata a expresso em Value utilizando o formato especificado em Format. Este
formato utiliza as mesmas definies da propriedade Format de objetos Texto,
Display e SetPoint. Este mtodo est disponvel tanto em Associaes quanto em
scripts.

Programando no E3

41

2.7.1.5 GetBit
GetBit(Value, BitIndex)
Retorna o valor (verdadeiro ou falso) do bit de Value especificado em BitIndex. Este
mtodo retorna um erro caso o parmetro BitIndex esteja fora da faixa permitida
(entre 0 e 31). Este mtodo est disponvel tanto em Associaes quanto em scripts.

2.7.1.6 GetComputerName
GetComputerName()
Retorna uma String contendo o nome do computador atual. Este mtodo est
disponvel tanto em Associaes quanto em scripts.

2.7.1.7 GetCurrentWindowsUserName
GetCurrentWindowsUserName()
Retorna uma String contendo o nome do usurio logado no processo corrente. Este
mtodo no est disponvel em Associaes, somente em scripts.

2.7.1.8 GetLocalTime
GetLocalTime()
Retorna a data e hora do computador local, com preciso de milissegundos e no
fuso horrio local. Este mtodo no est disponvel em Associaes, somente em
scripts.

2.7.1.9 GetLocalTimeUTC
GetLocalTimeUTC()
Retorna a data e hora do computador local, com preciso de milissegundos e no
fuso horrio UTC (Tempo Universal Coordenado). Este mtodo no est disponvel
em Associaes, somente em scripts.

2.7.1.10 IIf
IIf(Condition, ExprTrue, ExprFalse)
Retorna a expresso contida em ExprTrue se a condio avaliada em Condition for
verdadeira, e a expresso contida em ExprFalse se a condio avaliada for falsa.
Este mtodo est disponvel tanto em Associaes quanto em scripts.

42

Programando no E3

NOTA: O mtodo IIf n o propa ga a qua l i da de nem o timestamp dos va l ores . Se uma
As s oci a o conti ver a expres s o IIf(Tag1.Value == 0, Tag2.Value,
Tag3.Value), o res ul ta do s er o va l or de Tag2 ou Tag3, porm com qua l i da de Boa
(192) e timestamp a tua l . Pa ra que es s a s i nforma es s eja m pres erva da s ,
neces s ri o es peci fi ca r s omente o objeto, como por exempl o IIf(Tag1.Value ==
0, Tag2, Tag3).

2.7.1.11 OPCGetLimit
OPCGetLimit(Quality)
Retorna a informao de Limite de uma Qualidade OPC especificada no parmetro
Quality. Este mtodo est disponvel tanto em Associaes quanto em scripts. Os
valores possveis de retorno deste mtodo so:
0: Livre
1: Baixo
2: Alto
3: Constante

2.7.1.12 OPCGetQuality
OPCGetQuality(Quality)
Retorna a informao de Qualidade de uma Qualidade OPC especificada no
parmetro Quality. Este mtodo est disponvel tanto em Associaes quanto em
scripts. Os valores possveis de retorno deste mtodo so:
0: Ruim
1: Incerta
2: No utilizada
3: Boa

2.7.1.13 OPCGetSubStatus
OPCGetSubStatus(Quality)
Retorna a informao de Substatus (de 0 a 15) de uma Qualidade OPC especificada
no parmetro Quality. Este mtodo est disponvel tanto em Associaes quanto em
scripts. O Padro OPC especifica os seguintes valores:
Qualidade Boa:
0: no especificado
1: sobrescrita local
Programando no E3

43

Qualidade Ruim:
0: no especificado
1: erro de configurao
2: no conectado
3: falha no dispositivo
4: ltimo valor conhecido
5: falha de comunicao
6: fora de servio
Qualidade Incerta:
0: no especificado
1: ltimo valor utilizvel
4: sensor no confivel
5: unidade de engenharia excedida
6: sub-normal

2.7.1.14 OPCGetVendor
OPCGetVendor(Quality)
Retorna a informao de Reservado para o Fabricante (de 0 a 255) de uma
Qualidade OPC especificada em Quality. Este mtodo est disponvel tanto em
Associaes quanto em scripts.

2.7.1.15 OPCIsBad
OPCIsBad(Quality)
Retorna verdadeiro se a Qualidade OPC Ruim, ou falso caso contrrio. Este
mtodo est disponvel tanto em Associaes quanto em scripts.

2.7.1.16 OPCIsGood
OPCIsGood(Quality)
Retorna verdadeiro se a Qualidade OPC Boa, ou falso caso contrrio. Este mtodo
est disponvel tanto em Associaes quanto em scripts.

44

Programando no E3

2.7.1.17 OPCIsUncertain
OPCIsUncertain(Quality)
Retorna verdadeiro se a Qualidade OPC Incerta, ou falso caso contrrio. Este
mtodo est disponvel tanto em Associaes quanto em scripts.

2.7.1.18 OPCMakeQuality
OPCMakeQuality(QualityFlag, SubStatus, Limit, Vendor)
Retorna um novo valor de Qualidade OPC utilizando os valores passados nos
parmetros QualityFlag, SubStatus, Limit e Vendor. Este mtodo est disponvel tanto
em Associaes quanto em scripts. Os valores possveis para cada um dos
parmetros so os seguintes:
QualityFlag: Especifica a qualidade do valor
0: Ruim
1: Incerta
3: Boa
SubStatus: Especifica o substatus do valor (entre 0 e 15, veja o mtodo
OPCGetSubStatus para os valores possveis). Se este parmetro for omitido,
assume o valor 0
Limit: Especifica o limite do valor. Se este parmetro for omitido, assume o valor
0
0: Livre
1: Baixo
2: Alto
3: Constante
Vendor: Valor especfico do fabricante (entre 0 e 255). Se este parmetro for
omitido, assume o valor 0

2.7.1.19 OPCSetLimit
OPCSetLimit(Quality, Limit)
Modifica a informao de Limite de uma Qualidade OPC e retorna o valor
modificado. Este mtodo est disponvel tanto em Associaes quanto em scripts.
Os valores possveis para o parmetro Limit so:
0: Livre
1: Baixo
Programando no E3

45

2: Alto
3: Constante

2.7.1.20 OPCSetQuality
OPCSetQuality(Quality, QualityFlag)
Modifica a informao de Qualidade de uma Qualidade OPC e retorna o valor
modificado. Este mtodo est disponvel tanto em Associaes quanto em scripts.
Os valores possveis para o parmetro QualityFlag so:
0: Ruim
1: Incerta
2: No utilizada
3: Boa

2.7.1.21 OPCSetSubStatus
OPCSetSubStatus(Quality, SubStatus)
Modifica a informao de Substatus de uma Qualidade OPC (de 0 a 15) e retorna o
valor modificado. Este mtodo est disponvel tanto em Associaes quanto em
scripts. O Padro OPC especifica os seguintes valores:
Qualidade Boa:
0: no especificado
1: sobrescrita local
Qualidade Ruim:
0: no especificado
1: erro de configurao
2: no conectado
3: falha no dispositivo
4: ltimo valor conhecido
5: falha de comunicao
6: fora de servio
Qualidade Incerta:
0: no especificado
1: ltimo valor utilizvel
46

Programando no E3

4: sensor no confivel
5: unidade de engenharia excedida
6: sub-normal

2.7.1.22 OPCSetVendor
OPCSetVendor(Quality, Vendor)
Modifica a informao de Reservado para o Fabricante (de 0 a 255) de uma
Qualidade OPC e retorna o valor modificado. Este mtodo est disponvel tanto em
Associaes quanto em scripts.

2.7.1.23 SetBit
SetBit(Value, BitIndex, BitValue)
Ajusta o valor de Value (verdadeiro ou falso) do bit especificado em BitIndex para
BitValue. Este mtodo retorna um erro caso o parmetro BitIndex esteja fora da
faixa permitida (entre 0 e 31). Este mtodo est disponvel tanto em Associaes
quanto em scripts.

2.7.1.24 SourceTypeName
SourceTypeName(SourceType)
Retorna uma String com a descrio da Fonte de Medida ativa (propriedade
ActiveSource dos objetos Medida Analgica e Medida Discreta do Elipse Power).
Este mtodo est disponvel tanto em Associaes quanto em scripts. Os valores
possveis para o parmetro SourceType so os seguintes:
-1: String vazia
0: Fonte Ativa
1: SCADA
2: Operador
3: Centro de Comando
4: Faturamento
5: Calculada
6: Banco de Dados
100: Processador Topolgico
101: Fluxo de Potncia
102: Estimador de Estados
Programando no E3

47

103: Descarte de Cargas


NOTA: Ca s o o va l or pa s s a do no pa r metro SourceType n o es teja entre os va l ores
pos s vei s , es te mtodo retorna "???".

2.8 Eventos, Mtodos e Propriedades Gerais dos


Objetos
Esta seo contm informaes sobre eventos, mtodos e propriedades gerais dos
objetos.

2.8.1 Eventos
Eventos so ocorrncias relacionadas a um objeto, que permitem disparar aes
programadas. Existem basicamente, dois tipos de eventos: Fsicos (ou Externos) e
Internos. Os Eventos Fsicos so, por exemplo, aes do usurio. No caso do usurio
digitar algo no teclado, a informao relevante pode ser a tecla pressionada, ou se
o usurio apontar e clicar com o mouse, a informao relevante a posio do
cursor e o status dos botes. Os Eventos Internos so, por exemplo, mudanas de
valor de uma varivel (Tag) na aplicao. Como o Tag pode ser associado a um
dispositivo externo, diz-se que os eventos internos podem ter associaes fsicas,
como a mudana da temperatura de uma cmara, por exemplo.

2.8.1.1 Variveis de Evento


Variveis de Evento so criadas quando o evento inicia. Para serem utilizadas,
devem ser associadas a parmetros na chamada do script do evento. O exemplo a
seguir a chamada de um procedimento associado ao evento KeyDown de
AlgumObjeto.
Sub AlgumObjeto_KeyDown(KeyCode, Shift)

Note que na chamada tem-se duas variveis, KeyCode e Shift. O E3 ir atribuir


valores a essas variveis automaticamente no momento da ocorrncia do evento.
Neste caso, KeyCode ir receber o cdigo da tecla pressionada e Shift receber
Verdadeiro ou Falso, conforme a tecla SHIFT esteja pressionada ou no.

2.8.1.2 OnStartRunning
OnStartRunning()
Ocorre to logo um objeto seja iniciado. Exemplo (Meses um Tag Interno e utiliza
o evento OnStartRunning para inicializar o vetor):
Sub Meses_OnStartRunning()
Value = Array ("Janeiro", "Fevereiro", "Maro", "Abril",_
"Maio", "Junho", "Julho", "Agosto", "Setembro", "Outubro",_

48

Programando no E3

"Novembro", "Dezembro")
End Sub
NOTA: Pa ra a ces s a r es te array, neces s ri o copi a r a propri eda de Value pa ra uma
va ri vel l oca l .

2.8.1.3 OnStopRunning
OnStopRunning()
Ocorre quando termina a execuo de uma instncia deste objeto. Utilize o evento
OnStopRunning para realizar operaes de finalizao para o objeto. Exemplo:
Sub TagInterno1_OnStopRunning()
' Quando finaliza o objeto TagInterno1
' atribui False ao TagInterno2
Set tag2 = Application.GetObject("Dados.TagInterno2")
tag2.Value = False
End Sub

2.8.2 Mtodos
Neste captulo so listados os mtodos comuns aos objetos do E3. Cada entrada
mostra o nome do mtodo com seus respectivos parmetros, na sintaxe correta, e
um exemplo de utilizao do mtodo.

2.8.2.1 Chamadas de Mtodos


Muitos mtodos pr-definidos possuem parmetros, que podem (ou devem) ser
passados na chamada do mtodo. Para isso, o VBScript possui uma regra que deve
ser seguida: se o mtodo for utilizado em uma atribuio, seus parmetros devem
estar entre parnteses. Por exemplo, veja esta chamada do mtodo GetObject:
obj = Application.GetObject("dados.tag001")

J se o mtodo for chamado sozinho, deve-se retirar os parnteses. Por exemplo,


veja esta chamada do mtodo SetVariableValue:
Screen.Item("Consulta").SetVariableValue Valor, 12

Os parnteses usados nas citaes de mtodos neste manual servem apenas como
indicativo para diferenci-los das propriedades. Nos scripts, deve-se seguir esta
mesma regra.

2.8.2.2 Activate
Activate()
Ativa um objeto que est inativo no momento. Exemplo:
Sub CommandButton1_Click()

Programando no E3

49

Dim obj, tag


Set obj = Application.GetObject("Dados")
' Cria o objeto novo e deixa desativado (False).
Set tag = obj.AddObject("DemoTag", False)
' Inicializa os parmetros do objeto novo.
tag.Name = "tag001"
tag.Type = 3
' Ativa o objeto (coloca em execuo).
tag.Activate()
End Sub

2.8.2.3 AddObject
AddObject(ClassName[, Activate[, ObjectName]])
O mtodo AddObject adiciona um novo objeto aplicao. Este mtodo possui o
parmetro ClassName, que indica o tipo de objeto que ser criado. Por exemplo,
para se criar um retngulo na Tela, o parmetro ClassName deve ser "DrawRect". O
objeto criado fica contido no objeto que chamou o mtodo AddObject e pode ser
acessado atravs do mtodo Item.
O parmetro Activate opcional e indica se o objeto ser ativado aps a criao.
Se o objeto for ativado, as Associaes e scripts ficam habilitados. Se o objeto for
criado com Activate em False, mais tarde ele pode ser ativado pelo mtodo Activate.
O parmetro ObjectName tambm opcional e indica um nome para o objeto
criado. Caso o nome j exista, o novo nome ser automaticamente incrementado. Se
o parmetro no for informado, o novo objeto ser nomeado a partir do nome da
classe definida no parmetro ClassName.
O objeto s ser criado se ele for de um tipo compatvel com o objeto que o contm.
Para se ter certeza que o objeto foi criado, pode-se utilizar o mtodo IsObject.
NOTA: Apena s os objetos que pos s uem a op o Inserir no menu de contexto podem
a ces s a r es te mtodo.

2.8.2.4 Context
Context(ContextName)
Retorna o objeto que implementa o contexto indicado pelo parmetro ContextName,
que deve ser uma String entre aspas duplas. Este mtodo ir falhar se nenhum
objeto na hierarquia superior do objeto que est chamando este mtodo
implementar o contexto indicado. Os seguintes contextos esto disponveis:
Container: Objetos de servidor e do Viewer (objetos inseridos em arquivos de
projeto ou em pastas dentro de projetos)
Area: reas de Alarme, ou qualquer objeto de servidor cuja propriedade
IsAlarmArea esteja configurada para Verdadeiro
50

Programando no E3

NOTA: Os nomes dos contextos es t o s empre em i ngl s , e n o di ferenci a m


ma i s cul a s de mi ns cul a s . Pa ra veri fi ca r o contexto a que um objeto pertence,
ba s ta a bri r s ua ja nel a de Propri eda des , s el eci ona r a a ba Item, e veri fi ca r os
contextos v l i dos no qua dro Contextos. Ca s o um objeto defi na ma i s de um contexto,
os nomes s er o a pres enta dos em ordem a l fa bti ca , s epa ra dos por vrgul a s .

2.8.2.5 Deactivate
Deactivate()
Este mtodo desativa um objeto criado ou previamente ativado pelo mtodo
Activate. Pode-se desativar um objeto quando for necessrio realizar uma
configurao prvia (inicializao de propriedades, por exemplo), ou quando se
desejar realizar testes nos quais o objeto no pode estar presente e ativo. Exemplo:
Sub CommandButton1_Click()
Dim obj, novo
Set obj = Application.GetObject("Dados")
Set novo = obj.AddObject("DemoTag", True)
' Desativa o objeto.
novo.Deactivate()
End Sub

2.8.2.6 DeleteObject
DeleteObject(ChildName)
Apaga do projeto o objeto especificado. O parmetro ChildName uma String
(ignora maisculas e minsculas) que indica o objeto filho que se deseja apagar. O
mtodo retorna True caso tenha conseguido apagar o objeto, ou False caso o objeto
filho no exista.
Para se apagar um objeto a partir de uma referncia a um elemento, utiliza-se o
mtodo DeleteObject do objeto pai. Exemplo:
Sub CommandButton1_Click()
Set obj = Application.GetObject("Dados")
If obj.DeleteObject("Tag001") Then
MsgBox("Tag apagado com sucesso!")
Else
MsgBox("Falha em apagar: o tag no existe.")
End If
End Sub
NOTA: Apena s os objetos que pos s uem a op o Inserir no menu de contexto podem
a ces s a r es te mtodo.

Programando no E3

51

2.8.2.7 GetChildObject
GetChildObject(ObjectPath)
O mtodo GetChildObject retorna uma referncia para o objeto filho apontado pelo
parmetro ObjectPath. Com isso possvel acessar todas as propriedades e
mtodos deste objeto, semelhante ao funcionamento do mtodo GetObject. O
mtodo falhar se o caminho apontado por ObjectPath contiver uma propriedade
ou mtodo ao final. O caminho apontado pelo objeto filho no um caminho desde
a raiz (o arquivo .prj) e sim um caminho sempre a partir do objeto onde o mtodo
chamado.
NOTA: Es te mtodo NO exi s te no objeto Appl i ca ti on do s ervi dor e nem na s Pa s ta s
de Apl i ca ti vo, porm exi s te no objeto Appl i ca ti on do Vi ewer, s endo a ces s vel
mes mo em um Vi ewer em modo Somente Leitura.

2.8.2.8 GetObject
GetObject(ObjectPath)
O mtodo GetObject retorna a referncia do objeto especificado em ObjectPath. Isto
permite acessar todas as propriedades ou mtodos do objeto. Esta uma prtica
bastante comum na programao de scripts no E3. Ela facilita a manipulao de
objetos e deixa o cdigo mais inteligvel. Exemplo:
Sub CommandButton1_Click()
' Atribui o valor 20 propriedade Value do objeto
' TagInterno1 que est em Dados.
Set tag = Application.GetObject("Dados.TagInterno1")
tag.Value = 20
End Sub

2.8.2.9 Item
Item(ItemId)
Retorna a referncia para o objeto filho ItemId do objeto que chamou o mtodo. O
mtodo Item pode buscar um objeto tanto pelo nome quanto pelo ndice (inteiro, de
1 at o especificado na propriedade Count). Se o ndice ou o nome especificado for
vlido, o mtodo Item retorna a referncia do objeto. Caso contrrio, o mtodo
retorna um erro de "Parmetro Invlido". Exemplo:
Sub Tela1_Click()
' Atribui a obj a referncia para o objeto filho Botao1
' de Tela1.
Set obj = Item("Botao1")
' Configura a propriedade BackColor de obj, ou seja,
' de Botao1.
obj.BackColor = RGB(255, 0, 0)
End Sub

52

Programando no E3

2.8.2.10 Save
Save()
Este mtodo salva o objeto especificado, que foi modificado em tempo de execuo
(runtime). Os objetos filhos tambm sero salvos, conforme as especificaes do
objeto pai. Este mtodo no vlido para os objetos Tela e Viewer. Exemplo:
Sub CommandButton1_Click()
Set area = Application.GetObject("ConfigAlarms")._
AddObject("Area", True)
Application.GetObject("ConfigAlarms").Save()
End Sub
NOTA: As modi fi ca es fei ta s em tempo de execu o e s a l va s no objeto s s er o
vi s vei s no Studi o a ps a a tua l i za o do projeto, que pode s er fei ta cl i ca ndo-s e com
o bot o di rei to do mous e s obre o nome do projeto e s el eci ona ndo a op o
Atualizar.

2.8.3 Propriedades
Todo objeto possui Propriedades, que servem para guardar informaes a respeito
de suas caractersticas. Por exemplo, um objeto do tipo Retngulo possui a
propriedade Name, que contm seu nome, e as propriedades Width e Height, que
guardam a sua largura e a sua altura, respectivamente, entre outras propriedades.
Neste captulo so listadas todas as propriedades gerais dos objetos do E3. Cada
entrada traz o nome da propriedade, descrio e, quando aplicvel, um exemplo de
seu uso.
As propriedades so identificadas por um cone que indica o tipo de dado
suportado em seu contedo. Os tipos de dados disponveis so os seguintes:
Tipos de dados disponveis
CONE

TIPO DE DADO
Booleano
Numrico

Data
Texto
Variant

Programando no E3

DESCRIO
Retorna Verda dei ro (True)
ou Fa l s o (Fa l s e).
Retorna um i ntei ro ou
double (pos i ti vo ou
nega ti vo), a s er defi ni do
pel a propri eda de.
Retorna uma da ta no
ca l end ri o Gregori a no
(i ni ci a ndo em 1899).
Retorna um texto.
Retorna um ti po va ri vel ,
que pode a s s umi r v ri os
forma tos .

53

CONE

TIPO DE DADO
Cor
Link
Enumerao

DESCRIO
Retorna uma cor no
forma to RGB.
Retorna uma As s oci a o
entre objetos .
Retorna um conjunto
determi na do de va l ores .

Algumas propriedades podem propagar seus valores mesma propriedade em seus


objetos filhos. Neste caso, so chamadas de propriedades propagveis. Pode-se, no
entanto, forar a propriedade do objeto filho a se comportar de modo diferente.
NOTA: O E3 uti l i za pa ra defi ni o de coordena da s e es pes s ura o s i s tema Hi metri c.
Nes te s i s tema , ca da uni da de l gi ca equi va l e a um mi l s i mo de centmetro; ou s eja ,
ca da 1000 uni da des equi va l em a um centmetro. As s i m, es te o pa dr o a dota do na
des cri o da s propri eda des do E3, qua ndo a pl i c vel .

2.8.3.1 Application
A propriedade Application retorna o objeto de aplicao relacionado ao
contexto atual do objeto. Com o objeto Aplicao possvel, por exemplo, buscar
outros objetos presentes no aplicativo. Exemplo:
Sub Tela1_Click()
' Quando clica na tela, atribui um valor e abre um MessageBox
set obj = Application.GetObject("Dados.TagInterno1")
obj.Value = 100
MsgBox "Valor do TagInterno1: " & obj.Value
End Sub

2.8.3.2 Count
Retorna o nmero de objetos filhos (itens) que o objeto possui. Esta propriedade
funciona em conjunto com o mtodo Item. Se o objeto no possuir filhos, o valor
retornado ser 0 (zero). Exemplo:
Sub Tela1_Click()
' Busca todos os objetos de tela
' e ajusta a propriedade
' ForegroundColor para vermelho
Dim obj
For i = 1 To Count
Set obj = Item(i) ' Objeto filho
obj.ForegroundColor = RGB(255, 0, 0)
Next
End Sub

54

Programando no E3

2.8.3.3 DocString
Texto livre que tem por objetivo possibilitar a documentao das
funcionalidades ou caractersticas do objeto pelos programadores do projeto.
Exemplo:
Sub CommandButton1_Click()
Docstring = "Este boto ativa o condensador do sistema."
MsgBox Docstring
End Sub

2.8.3.4 Links
Retorna um objeto que uma coleo das conexes (ou Associaes) de um
objeto qualquer do E3. Esta propriedade acessvel apenas em tempo de execuo.
Veja o item Coleo de Associaes para maiores informaes sobre a coleo de
objetos retornados por esta propriedade.

2.8.3.5 Name
Identifica cada um dos objetos presentes no sistema. Alterar esta propriedade
implica em modificar todas as outras propriedades ou scripts que utilizam este
objeto. No aconselhvel a alterao desta propriedade em tempo de execuo.
Exemplo:
Sub CommandButton9_Click()
MsgBox "O nome da Tela " & (Screen.Name)
End Sub

2.8.3.6 Parent
Retorna o objeto pai deste objeto. Sendo assim, se um objeto est inserido na
Tela, a propriedade Parent retorna "Tela". Da mesma forma, se um Tag Interno est
inserido diretamente abaixo de um Servidor de Dados, a propriedade Parent do Tag
Interno apontar para o Servidor de Dados. Exemplo:
Sub Retangulo1_Click()
' Ao clicar no Retangulo1,
' troca a cor do Retangulo2
Parent.Item("Retangulo2").ForegroundColor = RGB(255, 0, 0)
End Sub

2.8.3.7 PathContainer
Retorna uma String contendo o caminho do objeto que contm o objeto atual,
incluindo as Pastas. Este valor determinado apenas no momento em que for
requisitado, por isso no recomendado criar Associaes para esta propriedade.

Programando no E3

55

2.8.3.8 PathName
Identifica o caminho do objeto na aplicao. Esta propriedade acessvel apenas
em tempo de execuo. Exemplo:
Sub CommandButton9_Click()
MsgBox "O caminho da Tela " & (Screen.PathName)
End Sub

2.8.3.9 PathVolume
Retorna uma String contendo o nome do arquivo .prj ou .lib que contm o objeto.
No Studio, a propriedade retorna o caminho completo do projeto ou biblioteca (c:
\folder\folder\volume.prj). Em tempo de execuo, os objetos que rodam no Viewer
retornam sempre uma String vazia. J os que rodam no servidor retornam o
caminho relativo do projeto ou biblioteca, conforme ele esteja armazenado no
Domnio (volume.prj). Este valor determinado apenas no momento em que for
requisitado, por isso no recomendado criar Associaes para esta propriedade.

2.8.4 Coleo de Associaes


Esta seo contm informaes sobre mtodos e propriedades comuns coleo
das conexes (ou Associaes) de um objeto qualquer do E3, retornada pela
propriedade Links.

2.8.4.1 Mtodos Comuns


Esta seo contm informaes sobre os mtodos comuns coleo de
Associaes retornada pela propriedade Links.

2.8.4.1.1 CreateLink
CreateLink(Property, Source[, Type])
Este mtodo permite criar uma Associao com uma propriedade do objeto. Em
caso de sucesso, o mtodo retorna o objeto criado. Caso contrrio, ocorrer um
erro de script e o mtodo retornar Nothing. O mtodo possui os seguintes
parmetros:
Property: especifica o nome da propriedade para qual ser criada a Associao
Source: especifica o nome do objeto de origem da Associao
Type (opcional): especifica o tipo de Associao a ser criada. Quando este
parmetro for omitido, ser criada uma Associao Simples

56

Programando no E3

NOTA: Nem toda s a s propri eda des exi s tentes em um objeto permi tem a cri a o de
As s oci a es . Pa ra veri fi ca r qua i s a s propri eda des permi tem es te recurs o, a ces s e a
a ba Associaes. Se a propri eda de for i nv l i da pa ra a As s oci a o, n o exi s ti r ou j
pos s ui r uma As s oci a o, ocorrer um erro de s cri pt.
Opes disponveis para o parmetro Type
OPO
0 - Associao Simples

1 - Associao Bidirecional

2 - Associao Analgica

3 - Associao Digital

4 - Associao por Tabela

5 - Associao Reversa

6 - Associao Mltipla

DESCRIO
Na As s oci a o Si mpl es , o va l or da
ori gem copi a do pa ra a propri eda de
toda vez que el e for modi fi ca do.
Na As s oci a o Bi di reci ona l ocorre o
mes mo que na Si mpl es ; porm, ca s o
ha ja uma va ri a o na propri eda de, s eu
va l or s er copi a do pa ra a ori gem,
gera ndo a s s i m uma As s oci a o de dua s
di rees .
A As s oci a o Ana l gi ca es ta bel ece uma
es ca l a de convers es entre a va ri vel de
ori gem e a propri eda de.
Na As s oci a o Di gi ta l , s o es peci fi ca dos
va l ores fi xos ou a l terna ntes pa ra a
propri eda de, que s o a tri budos de
a cordo com a fonte s er verda dei ra ou
fa l s a .
Na As s oci a o por Ta bel a , pode-s e
es ta bel ecer condi es entre a va ri vel ,
os va l ores e o des ti no. Na ta bel a s o
es peci fi ca dos os va l ores mni mos e
m xi mos e dema i s confi gura es .
A As s oci a o Revers a uma As s oci a o
uni di reci ona l da propri eda de pa ra a
fonte.
A As s oci a o Ml ti pl a s emel ha nte a
uma As s oci a o por Ta bel a , exceto que
ca da l i nha da As s oci a o permi te bus ca r
s eu va l or de uma fonte di ferente.

Exemplo:
Sub CommandButton1_Click()
On Error Resume Next
Dim Bind
Set Bind = Screen.Item("Texto1").Links.Item("Value")
If Bind Is Nothing Then
MsgBox "Texto1 no est associado a nenhum objeto."
Dim Source
Source = "Dados.TagInterno1.Value"
MsgBox "Criando uma conexo em '" & Source & "'."

Programando no E3

57

Set Bind = Screen.Item("Texto1").Links._


CreateLink("Value", Source, 0)
Bind.BiDirectional = Screen.Item("BiDirectional").Value
Bind.Reverse = Screen.Item("Reverse").Value
MsgBox "Tipo: " & TypeName(Bind)
Else
MsgBox "Texto1 j est ligado " & Bind.Source & "."
End If
End Sub

2.8.4.1.2 Item
Item(Property, Index)
Este mtodo retorna um objeto Associao de uma determinada propriedade de um
objeto. Se for um texto, Property especifica o nome da propriedade cuja Associao
deseja-se acessar. A Associao tambm pode ser acessada numericamente pelo
ndice Index. Este ndice deve ser de 1 at Count. Caso no exista Associao com a
propriedade, ou o ndice seja invlido, ocorrer um erro de script. Como as demais
colees, Links permite o uso do comando For Each do VBScript. Exemplo:
Sub Texto1_Click()
For Each Link In Links
MsgBox "Origem do link: " & Link.Source
Next
End Sub

2.8.4.1.3 RemoveLink
RemoveLink(Property)
Este mtodo remove uma Associao com a propriedade especificada por Property,
caso ela exista. Caso no exista Associao com a propriedade especificada, o
mtodo no tem efeito. Exemplo:
Sub CommandButton2_Click()
On Error Resume Next
Dim Bind
Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")
If Bind Is Nothing Then
' Se a conexo no existe
MsgBox "ScrollBar1 no est conectado."
Else
MsgBox "ScrollBar1 est ligado " & Bind.Source & "."
MsgBox "Removendo o link."
Screen.Item("ScrollBar1").Links.RemoveLink("Value")
End If
End Sub

58

Programando no E3

2.8.4.2 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns coleo de
Associaes retornada pela propriedade Links.

2.8.4.2.1 Count
Retorna o nmero de objetos filhos (itens) de uma coleo de Associaes. Esta
propriedade trabalha em conjunto com o mtodo Item. Se a coleo no possui
objetos filhos, o valor retornado 0 (zero).

2.8.4.3 Associaes
Esta seo contm informaes sobre os objetos do tipo Associao contidos na
coleo de Associaes retornada pela propriedade Links. Os tipos de Associaes
disponveis so os seguintes:
Simples
Bidirecional
Analgica
Digital
Tabela
Reversa
Mltipla

2.8.4.3.1 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns aos objetos
contidos na coleo de Associaes retornada pela propriedade Links.
2.8.4.3.1.1 Property
Especifica o nome da propriedade que est conectada. Ao ser modificada,
permite deslocar a Associao para outra propriedade do mesmo objeto. Exemplo:
Sub CommandButton1_Click()
Dim bind
Set bind = Screen.Item("TableBind").Links.Item(1)
bind.Property = "Caption"
End Sub

Programando no E3

59

2.8.4.3.1.2 Source
Especifica a fonte da Associao, que pode ser o nome de outro objeto da
aplicao ou uma expresso mais complexa, acessando vrios objetos. Exemplo:
Sub CommandButton25_Click()
Dim bind
Set bind = Screen.Item("TableBind").Links.Item(1)
bind.Source = "Dados.TagDemo1.Value"
End Sub

2.8.4.3.1.3 Type
Esta propriedade apenas para leitura e informa o tipo de Associao. Os
valores disponveis so os seguintes:
Opes disponveis para Type
OPO
0 - bsSimple
1 - bsSimpleBiDir
2 - bsAnalog
3 - bsAnimation
4 - bsTable
5 - bsReverse
6 - bsMultiSource

DESCRIO
Associao Simples.
Associao Bidirecional.
Associao Analgica.
Associao Digital.
Associao por Tabela.
Associao Reversa.
Associao Mltipla.

2.8.4.3.2 Associao Simples


O objeto Associao Simples no tem eventos, mtodos ou propriedades
associadas.

2.8.4.3.3 Associao Bidirecional


Esta seo contm informaes sobre propriedades do objeto Associao
Bidirecional. Este objeto no possui eventos nem mtodos associados.
2.8.4.3.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Associao
Bidirecional.

BiDirectional
True se a Associao for Bidirecional. False se a Associao for Reversa ou
Simples.

60

Programando no E3

2.8.4.3.4 Associao Analgica


Esta seo contm informaes sobre propriedades do objeto Associao
Analgica. Este objeto no possui eventos nem mtodos associados.
2.8.4.3.4.1 Propriedades
Esta seo contm informaes sobre as propriedades da Associao Analgica.

DstHiValue
Especifica o valor mximo atingido na propriedade. Exemplo:
Sub DstHiValue_ValueChange()
On Error Resume Next
Dim Bind
Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")
Screen.Item("ScrollBar1").Max = Value
If Bind Is Nothing Then
MsgBox "ScrollBar1 no tem associao."
Else
MsgBox "ScrollBar1 est associado a '" & Bind.Source & "'"
MsgBox "Mudando DstHiValue de " &_
Bind.DstHiValue & " para " & Value
Bind.DstHiValue = Value
End If
End Sub

DstLoValue
Especifica o valor mnimo atingido na propriedade. Exemplo:
Sub DstLoValue_ValueChange()
On Error Resume Next
Dim Bind
Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")
Screen.Item("ScrollBar1").Min = Value
If Bind Is Nothing Then
MsgBox "ScrollBar1 no tem associao."
Else
MsgBox "ScrollBar1 est associado a '" & Bind.Source & "'"
MsgBox "Mudando DstLoValue de " &_
Bind.DstLoValue & " para " & Value
Bind.DstLoValue = Value
End If
End Sub

SrcHiValue
Especifica o valor mximo atingido na fonte. Exemplo:
Sub SrcHiValue_ValueChange()
On Error Resume Next

Programando no E3

61

Dim Bind
Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")
Screen.Item("ScrollBar2").Max = Value
If Bind Is Nothing Then
MsgBox "ScrollBar1 no tem associado."
Else
MsgBox "ScrollBar1 est associado a '" & Bind.Source & "'"
MsgBox "Mudando SrcHiValue de " &_
Bind.SrcHiValue & " para " & Value
Bind.SrcHiValue = Value
End If
End Sub

SrcLoValue
Especifica o valor mnimo atingido na fonte. Exemplo:
Sub SrcLoValue_ValueChange()
On Error Resume Next
Dim Bind
Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")
Screen.Item("ScrollBar2").Min = Value
If Bind Is Nothing Then
MsgBox "ScrollBar1 no tem associado."
Else
MsgBox "ScrollBar1 est associado a '" & Bind.Source & "'"
MsgBox "Mudando SrcLoValue de " &_
Bind.SrcLoValue & " para " & Value
Bind.SrcLoValue = Value
End If
End Sub
NOTA: Ca s o os va l ores es peci fi ca dos pa ra a s propri eda des SrcHiValue e SrcLoValue
s eja m i gua i s , n o pos s vel fa zer a es ca l a , e a As s oci a o funci ona r como s e
fos s e uma As s oci a o Si mpl es .

2.8.4.3.5 Associao Digital


Esta seo contm informaes sobre propriedades do objeto Associao Digital.
Este objeto no possui eventos nem mtodos associados.
2.8.4.3.5.1 Propriedades
Esta seo contm informaes sobre as propriedades da Associao Digital.

BlinkOff
Quando esta propriedade estiver configurada para True, a propriedade
conectada ir alternar periodicamente entre os valores das propriedades OffValue
e BlinkOffValue, caso a fonte retorne False. Exemplo:
Sub BlinkOff_Change()

62

Programando no E3

On Error Resume Next


Dim Bind
Set Bind = Screen.Item("Retangulo1")._
Links.Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 no tem associao."
Else
MsgBox "Retangulo1 est associado a '" & Bind.Source & "'"
MsgBox "Mudando BlinkOff de " & _
Bind.BlinkOff & " para " & Value
Bind.BlinkOff = Value
End If
End Sub

BlinkOffValue
Especifica o valor alternativo a ser assumido periodicamente pela propriedade
quando a expresso da fonte resultar em False, e a propriedade BlinkOff estiver
configurada em True. Exemplo:
Sub BlinkOffValue_Click()
On Error Resume Next
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = Screen.Item("Retangulo1").Links._
Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 no tem associao."
Else
MsgBox "Retangulo1 est associado a '"& Bind.Source & "'"
MsgBox "Mudando BlinkOffValue de " &_
Bind.BlinkOffValue & " para " & Value
Bind.BlinkOffValue = Value
End If
ForegroundColor = Value
End If
End Sub

BlinkOn
Quando esta propriedade estiver configurada para True, a propriedade
conectada ir alternar periodicamente entre os valores das propriedades OnValue
e BlinkOnValue, caso a fonte retorne True. Exemplo:
Sub BlinkOn_Change()
On Error Resume Next
Dim Bind
Set Bind =_
Screen.Item("Retangulo1").Links.Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 no tem associao."
Else

Programando no E3

63

MsgBox "Retangulo1 est associado a '" & Bind.Source & "'"


MsgBox "Mudando BlinkOn de " & Bind._
BlinkOn & " para " & Value
Bind.BlinkOn = Value
End If
End Sub

BlinkOnValue
Especifica o valor alternativo a ser assumido periodicamente pela propriedade
quando a expresso da fonte resultar em True e a propriedade BlinkOn estiver
configurada para True. Exemplo:
Sub BlinkOnValue_Click()
On Error Resume Next
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = Screen.Item("Retangulo1").Links._
Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 no tem associao."
Else
MsgBox "Retangulo1 est associado a '"& Bind.Source & "'"
MsgBox "Mudando BlinkOnValue de " &_
Bind.BlinkOnValue & " para " & Value
Bind.BlinkOnValue = Value
End If
ForegroundColor = Value
End If
End Sub

OffValue
Especifica o valor assumido pela propriedade quando a expresso da fonte
resultar em False. Exemplo:
Sub OffValue_Click()
On Error Resume Next
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = Screen.Item("Retangulo1").Links._
Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 no tem associao."
Else
MsgBox "Retangulo1 est associado a '"& Bind.Source & "'"
MsgBox "Mudando OffValue de " &_
Bind.OffValue & " para " & Value
Bind.OffValue = Value
End If

64

Programando no E3

ForegroundColor = Value
End If
End Sub

OnValue
Especifica o valor assumido pela propriedade quando a expresso da fonte for
True. Exemplo:
Sub OnValue_Click()
On Error Resume Next
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = Screen.Item("Retangulo1").Links._
Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 no tem associao."
Else
MsgBox "Retangulo1 est associado a '"& Bind.Source & "'"
MsgBox "Mudando OnValue de " &_
Bind.OnValue & " para " & Value
Bind.OnValue = Value
End If
ForegroundColor = Value
End If
End Sub

2.8.4.3.6 Associao por Tabela


Esta seo contm informaes sobre mtodos e propriedades do objeto
Associao por Tabela. Este objeto no possui eventos associados.
2.8.4.3.6.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Associao por Tabela.

InsertRow
InsertRow([Row])
Insere uma nova linha na tabela. O parmetro Row opcional e especifica em que
posio da tabela deve ser inserida a linha. Quando omitido, assume o
comportamento padro de inserir a linha no fim da tabela, o que equivale a usar
Row igual a -1. Quando informado e no for -1, deve ser um valor entre 1 e Count, e
a nova linha criada desloca as linhas de ndice maior ou igual para a direo
ascendente dos ndices. Uma linha nova sempre assume os seguintes valores
padro para as propriedades:
Min: 0.0
Programando no E3

65

Max: 1.0
Blink: False
BlinkValue: 0.0
Value: 0.0
Exemplo:
Sub Retangulo1_Click()
On Error Resume Next
Dim Bind
Set Bind = _
Screen.Item("Retangulo1").Links.Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 no tem nenhuma associao."
Else
Dim row
row = Screen.Item("SetPointRow").Value
MsgBox Bind.RowCount
If (row < 1 OR row > Bind.RowCount) Then
MsgBox "Nmero de linha invlido: " & row
Else
MsgBox "Acrescentando uma linha em: " & row
Bind.InsertRow(row)
If row = -1 Then
row = Bind.RowCount
Bind.Value(line) = _
Screen.Item("RectangleValue").ForegroundColor
Bind.BlinkValue(line) = _
Screen.Item("RectangleBlinkValue").ForegroundColor
Bind.Max(line) = Screen.Item("SetPointMax").Value
Bind.Min(line) = Screen.Item("SetPointMin").Value
Bind.Blink(line) = _
Screen.Item("CheckBoxBlink").Value
End If
End If
End If
End Sub

Item
Item(ItemId)
Retorna uma referncia para o objeto Linha da Conexo por Tabela, indicado por
ItemId.

RemoveRow
RemoveRow(Row)
Remove a linha no ndice especificado. O parmetro Row determina a linha da
66

Programando no E3

tabela a ser removida (deve ser de 1 at Count). Exemplo:


Sub RemoveRow_Click()
On Error Resume Next
Dim Bind
Set Bind =_
Screen.Item("Retangulo1").Links.Item("ForegroundColor")
If Bind Is Nothing Then
MsgBox "Retangulo1 no tem associao!"
Else
MsgBox "Retangulo1 est ligado '" & Bind.Source & "'"
Dim row
row = Screen.Item("Row").Value
MsgBox "Removendo a linha " & row
Bind.RemoveRow row
End If
End Sub

2.8.4.3.6.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Associao por
Tabela.

Count
A propriedade Count informa o nmero de linhas da tabela. Esta propriedade
somente de leitura.
2.8.4.3.6.3 Linha da Associao por Tabela
Esta seo contm informaes sobre propriedades do objeto Linha da Associao
por Tabela. Este objeto no possui eventos nem mtodos associados.

Propriedades
Esta seo contm informaes sobre as propriedades do objeto Linha da
Associao por Tabela.

Blink
Determina que quando a fonte estiver no intervalo desta Linha, a propriedade ir
alternar periodicamente entre os valores especificados nas propriedades Value e
BlinkValue. Exemplo:
Sub CheckBox1_Click()
Screen.Item("Retangulo1").Links.Item("ForegroundColor")._
Item(1).Blink = Value
Screen.Item("Retangulo1").Links.Item("ForegroundColor")._
Item(2).Blink = Value
End Sub

Programando no E3

67

BlinkValue
Especifica o valor alternativo (para piscar) da propriedade a ser assumido
quando a fonte estiver no intervalo especificado na Linha, e a propriedade Blink
estiver configurada para True. Exemplo:
Sub CommandButton1_Click()
Dim Cor
' Escolhe uma cor
Application.ShowPickColor Cor, 0, 100, 100
Screen.Item("Retangulo1").Links.Item("ForegroundColor")._
Item(1).BlinkValue = Cor
End Sub

Max
Especifica o valor mximo da fonte para uma Linha da Tabela.

Min
Especifica o valor mnimo da fonte para uma Linha da Tabela. Exemplo (para Max
e Min):
Sub CommandButton1_Click()
Set Bind = _
Screen.Item("Retangulo1").Links.Item("ForegroundColor")
Set Linha1 = Bind.Item(1)
Linha1.Min = 0
Linha1.Max = 20
Set Linha2 = Bind.Item(2)
Linha2.Min = 21
Linha2.Max = 100
End Sub

Value
Especifica o valor da propriedade a ser assumido quando a fonte estiver no
intervalo especificado na Linha. Exemplo:
Sub CommandButton1_Click()
Dim Cor
' Escolhe uma cor
Application.ShowPickColor Cor, 0, 100, 100
Screen.Item("Retangulo1").Links.Item("ForegroundColor")._
Item(1).Value = Cor
End Sub

2.8.4.3.7 Associao Reversa


Esta seo contm informaes sobre propriedades do objeto Associao Reversa.
Este objeto no possui eventos nem mtodos associados.

68

Programando no E3

2.8.4.3.7.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Associao
Reversa.

Reverse
True se a Associao for Reversa. False se a Associao for Bidirecional ou
Simples.

2.8.4.3.8 Associao Mltipla


Esta seo contm informaes sobre mtodos e propriedades do objeto
Associao Mltipla. Este objeto no possui eventos associados.
2.8.4.3.8.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Associao Mltipla.

InsertRow
InsertRow(InsertAtRow)
Insere uma nova Linha na tabela de Associaes Mltiplas.

Item
Item(ItemId)
Retorna uma referncia para o objeto Linha da Conexo Mltipla, indicado por
ItemId.

RemoveRow
RemoveRow(Row)
Remove a Linha no ndice indicado pelo parmetro Row.
2.8.4.3.8.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Associao
Mltipla.

AdviseAll
Esta propriedade mantm todas as Associaes da tabela de Associaes
Mltiplas em modo Advise (ativas). O valor padro desta propriedade Verdadeiro.
Para aplicaes criadas em verses anteriores, esta propriedade tem o valor Falso,
por compatibilidade.

Programando no E3

69

Count
Esta propriedade retorna o nmero de Linhas da tabela de Associaes Mltiplas.
2.8.4.3.8.3 Linha da Associao Mltipla
Esta seo contm informaes sobre propriedades do objeto Linha da Associao
Mltipla. Este objeto no possui eventos nem mtodos associados.

Propriedades
Esta seo contm informaes sobre as propriedades do objeto Linha da
Associao Mltipla.

Max
Intervalo mximo para o valor da Associao indicada na propriedade Source.

Min
Intervalo mnimo para o valor da Associao indicada na propriedade Source.

Source
Especifica a fonte da Associao da Linha da Conexo Mltipla, que pode ser o
nome de outro objeto da aplicao ou uma expresso mais complexa, acessando
vrios objetos.

70

Programando no E3

CAPTULO

Bibliotecas do Usurio

Esta seo contm informaes sobre os objetos XControls, XObjects e as


Propriedades de um ElipseX.

3.1 XControls e XObjects


Esta seo contm informaes sobre eventos e propriedades dos objetos
XControls e XObjects. Estes objetos no possuem mtodos associados.

3.1.1 Eventos
Esta seo contm informaes sobre os eventos dos objetos XControls e XObjects.

3.1.1.1 Constructor
Constructor()
Disparado quando o ElipseX iniciado. Pode-se utilizar este evento para rodar um
script que inicie valores internos de um ElipseX, por exemplo.

3.1.1.2 CustomConfig
CustomConfig()
Permite configuraes automatizadas nas instncias de ElipseX. Uma opo de
configurao aparece no menu contextual das instncias de ElipseX sempre que
existir um script associado ao evento CustomConfig da definio do ElipseX.
Quando a opo selecionada no menu, o evento disparado. O texto que aparece
na opo do menu pode ser informado na propriedade CustomConfigText da
definio do ElipseX. Se esta propriedade estiver em branco, aparece o texto
"Configurar".

Bibliotecas do Usurio

71

Menu contextual da instncia do ElipseX


NOTA: O s cri pt a s s oci a do a o evento CustomConfig roda no E3 Studi o, onde os objetos
n o es t o a ti vos . Porta nto, o comporta mento di ferente do us ua l .

3.1.2 Propriedades
Esta seo contm informaes sobre as propriedades dos objetos XControls e
XObjects.
72

Bibliotecas do Usurio

3.1.2.1 CustomConfigText
Indica o texto que dever aparecer no menu para a opo de configurao da
instncia do ElipseX. A opo s ir aparecer se existir um script associado ao
evento CustomConfig da definio do ElipseX. Se o valor da propriedade estiver em
branco, aparecer o texto "Configurar" na opo do menu. O valor padro desta
propriedade uma String vazia.

3.2 Propriedades de um ElipseX


Esta seo contm informaes sobre eventos e propriedades do objeto
Propriedade de um ElipseX. Este objeto no possui mtodos associados.

3.2.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Propriedade de um
ElipseX.

3.2.1.1 OnPropertyChanged
OnPropertyChanged()
Ocorre quando uma propriedade de um ElipseX modificada. Pode-se utilizar este
evento para disparar scripts que executem aes de acordo com determinado
status de um ElipseX.

3.2.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Propriedade de
um ElipseX.

3.2.2.1 DefaultValue
Define o valor inicial para a Propriedade quando uma nova instncia do objeto
criada. Se a Propriedade est configurada como retentiva, ela ser inicializada
com este valor cada vez que o objeto for carregado. O valor padro desta
propriedade vazio (Empty).

3.2.2.2 HelpString
Texto contendo a descrio da Propriedade. Este texto ser mostrado na parte
inferior da Lista de Propriedades no Studio quando a Propriedade for selecionada.
O valor padro desta propriedade uma String vazia.

Bibliotecas do Usurio

73

3.2.2.3 Persistable
Indica se a Propriedade salva no arquivo de projeto (Verdadeiro) ou se est
disponvel apenas em tempo de execuo (Falso). O valor padro desta propriedade
Verdadeiro. Se esta propriedade for configurada com o valor Falso, a Propriedade
no pode ser editada no Studio, nem salva ou lida do arquivo de projeto.
Entretanto, a Propriedade ainda visvel no AppBrowser. Esta propriedade
representada pelo cone .
Quando esta propriedade est configurada para Verdadeiro, a Propriedade recebe
seu valor padro (propriedade DefaultValue) apenas na criao de uma instncia.
Se a propriedade DefaultValue for alterada, as instncias do objeto j criadas no
so afetadas.
Quando esta propriedade est configurada para Falso, a Propriedade recebe seu
valor padro sempre que uma instncia carregada, ou seja, sempre que a
propriedade DefaultValue for alterada, todas as instncias j criadas so
inicializadas com o novo valor padro.

3.2.2.4 Public
Quando uma Propriedade de um ElipseX pblica (True), ela ser visvel fora da
Biblioteca. Caso contrrio, a Propriedade ser interna e somente visvel para o
objeto. O valor padro desta propriedade True. A Propriedade pblica
representada pelo cone .

3.2.2.5 Retentive
Indica se o valor atual da Propriedade em tempo de execuo ser persistido no
arquivo de Domnio (Verdadeiro), enquanto o Domnio estiver carregado.
Propriedades retentivas tm o seguinte comportamento:
Propagam o seu valor para o servidor em Standby
Mantm o seu valor se a aplicao atualizada em tempo de execuo
Mantm o seu valor se a aplicao parada (desde que o Domnio no seja
fechado)
NOTAS:
Es ta propri eda de s omente es t di s ponvel pa ra Propri eda des cujo ti po de da dos
n o s eja um objeto (Variant, Double, Integer, etc.)
O us o des s a propri eda de em Verda dei ro i mpl i ca em um a umento no us o de
memri a e CPU por pa rte do E3Run, por i s s o deve s er uti l i za da com ca utel a

74

Bibliotecas do Usurio

3.2.2.6 Type
Determina o tipo de valores que a Propriedade ir aceitar (por exemplo, Boolean,
Double, Integer, Variant, etc.). Quando for especificado um objeto como tipo (por
exemplo DemoTag, IOTag, XObject, etc.), esta propriedade ter o seguinte
comportamento:
Caso o ElipseX esteja inativo: A propriedade funciona como uma String, que
especifica o caminho da instncia de um objeto do tipo configurado
Caso o ElipseX esteja ativo: Na escrita, a propriedade funciona da mesma maneira
de quando o objeto est desativado. Porm, na leitura a propriedade retorna o
objeto especificado, caso ele exista. Se o caminho no aponta para um objeto
existente no momento, a propriedade retorna Nothing

Bibliotecas do Usurio

75

CAPTULO

Visualizao

Esta seo contm informaes sobre eventos, mtodos e propriedades dos objetos
de visualizao do E3:
Viewer
Quadros e Divisores
Telas e Objetos de Tela
E3Alarm
E3Browser
E3Chart
E3Playback
Relatrios

4.1 Viewer
Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Viewer.

4.1.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Viewer.

4.1.1.1 OnInactive
OnInactive()
Este evento ocorre enquanto o Viewer estiver inativo, se a propriedade
EnableInactivity estiver em True. Ele inicia quando constatado que o usurio est
sem utilizar o Viewer por um perodo de tempo igual ou superior ao valor da
propriedade InactivityTime.
Em um script para esse evento, o usurio pode programar o que deseja fazer
quando o Viewer estiver inativo por um determinado perodo de tempo. Por
exemplo, possvel determinar que aps 20 minutos sem uso, ser feito logout do
Viewer. Exemplo:
Sub Viewer_OnInactive()
Logout(false)
If MsgBox("Essa sesso do Viewer foi fechada devido
inatividade.") = 0 Then

76

Visualizao

Application.GetFrame("").OpenScreen "TelaInicial", 0
End Sub

4.1.1.2 Eventos de Usurio


Esta seo contm informaes sobre eventos de usurio do objeto Viewer. Os
eventos disponveis nesta seo so os seguintes:
OnLogin
OnLogout

4.1.1.2.1 OnLogin
OnLogin()
Ocorre quando um usurio executa um login de sistema (autenticao de usurio)
com sucesso. O login de sistema pode ser feito atravs da execuo do mtodo
Login ou quando um objeto que s pode ser acessado por usurios com um
determinado nvel de autorizao exige autenticao.

4.1.1.2.2 OnLogout
OnLogout()
Ocorre quando executado um logout, ou seja, a sada do usurio do sistema. O
logout feito atravs da chamada ao mtodo Logout.

4.1.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Viewer.

4.1.2.1 CaptureScreen
CaptureScreen(Filename)
O mtodo CaptureScreen captura a Tela atual e a salva em um arquivo. Este mtodo
semelhante ao efeito realizado pela tecla PRINT SCREEN no Windows. O
parmetro Filename determina o nome do arquivo no qual a Tela ser salva.
NOTA: O forma to fi na l do a rqui vo Bi tma p (.bmp), mes mo que no pa r metro
Filename s eja i nforma da outra extens o (.gi f, .jpg, etc.).

Exemplo:
Sub CommandButton1_Click()
Screen.Frame.CaptureScreen "c:\temp\tela.bmp"
End Sub

Visualizao

77

4.1.2.2 ChangePassword
ChangePassword()
Este mtodo abre uma caixa de dilogo para permitir a troca de senha do usurio
atual. O mtodo retorna Verdadeiro se o usurio atual tem permisso para trocar a
senha. Caso contrrio, retorna Falso, indicando que houve falha na operao, ou
que no possvel trocar a senha, porque o usurio no tem autorizao.
NOTA: Es te mtodo s es ta r di s ponvel s e o us u ri o l oga do for um us u ri o do
Domni o do E3.

4.1.2.3 DoModal
DoModal(Screen, Title, Left, Top, Width, Height, Arg, Flags)
Abre uma Tela modal. Uma Tela modal uma janela que no permite clicar em
outras Telas ou janelas enquanto ela no for fechada. O parmetro Title passado
neste mtodo s ser utilizado se a propriedade Caption estiver vazia; do contrrio,
este parmetro ser ignorado.
Este mtodo possui os seguintes parmetros:
Screen: determina o nome da Tela
Title: determina o ttulo da janela modal
Left, Top: posio XY da janela modal em pixels
Width: largura da janela modal em pixels ou Himetric
Height: altura da janela modal em pixels ou Himetric
Arg: determina a varivel a ser usada no evento OnPreShow da Tela
Flags: determina a combinao utilizada na janela modal. Tal combinao feita
somando-se os valores da tabela correspondentes s opes que o usurio
deseja. Quando o valor especificado for -1, sero adotadas as configuraes do
Viewer para a janela modal. Quando este valor for diferente de -1, pode-se fazer
as combinaes descritas na tabela a seguir.
Combinaes possveis para o parmetro Flags
VALOR
1
2
4
8
16
32

78

DESCRIO
Ha bi l i ta a ba rra de ttul o na ja nel a
Ha bi l i ta o bot o Fechar na ja nel a .
Ha bi l i ta o bot o Minimizar na ja nel a .
Ha bi l i ta o bot o Maximizar na ja nel a .
Ha bi l i ta a borda na ja nel a .
Es peci fi ca que a ja nel a pode s er
di mens i ona da .

Visualizao

VALOR
64
256
512
1024
2048

DESCRIO
Es peci fi ca que a ja nel a pode s er movi da .
Es peci fi ca que a ja nel a fi ca r no topo da
Tel a .
Es peci fi ca que a ja nel a s er confi gura da
no es ti l o Ba rra de Ferra menta s .
Des a bi l i ta os botes de objeto.
Centra l i za a Tel a moda l no Qua dro ta nto
hori zonta l qua nto verti ca l mente.

Exemplo:
Sub Botao1_Click()
' Ao clicar no Boto abre uma outra Tela modal
Application.DoModal "Tela1", "Titulo", 0, 0, 400, 200, 0, 3
End Sub
NOTA: Os va l ores de ta ma nho nes te mtodo podem s er i nforma dos como nmeros
ou Strings. No ca s o de nmeros , s o cons i dera dos em pi xel s . No ca s o de Strings, s e
vi erem a compa nha dos da uni da de "hm", s er o i nterpreta dos como Hi metri c.
Qua l quer outro ca s o cons i dera do em pi xel s .

4.1.2.4 ESign
ESign(ObjName[, Description[, Action[, From[, To[, User[, Comment]]]]]])
O mtodo ESign utilizado para executar uma validao da alterao de um campo,
atravs de assinatura eletrnica. Quando este mtodo utilizado, a seguinte caixa
de dilogo mostrada:

Visualizao

79

Caixa de Dilogo de Assinatura Eletrnica


Parmetros do mtodo ESign
PARMETRO
ObjName
Description

Action

From

To

80

DESCRIO
Texto que contm o nome de um Ta g ou
outro objeto da a pl i ca o.
Texto que contm a des cri o de
ObjName. Es te pa r metro opci ona l e, s e
for omi ti do, a ca i xa de di l ogo tenta r
bus ca r os da dos da propri eda de
DocString de ObjName.
Texto que contm a a o a s er executa da
(por exempl o, "Al tera o do va l or"). Es te
pa r metro opci ona l e o s eu va l or
pa dr o uma String va zi a .
Variant que contm o va l or ori gi na l , ou o
es ta do que s er a l tera do. Es te
pa r metro opci ona l .
Variant que contm o novo va l or do Ta g,
ou o va l or a s er a pl i ca do em Action. Es te
pa r metro opci ona l .

Visualizao

PARMETRO
User

Comment

DESCRIO
Texto de retorno. Recebe o nome de login
s el eci ona do na ca i xa de di l ogo. Es te
pa r metro opci ona l .
Texto de retorno. Recebe o coment ri o
di gi ta do na ca i xa de di l ogo. Es te
pa r metro opci ona l .

Ao clicar em , abre-se uma janela que permite autenticar o usurio. Se a opo


Windows for selecionada, os campos Nome do usurio e Senha sero
automaticamente desabilitados. Clique em Outro usurio para selecionar um
usurio pertencente ao domnio de rede. Caso a opo E3 seja selecionada, digite
as informaes de um usurio pertencente ao Domnio do E3 nos campos Nome do
usurio e Senha.

Login integrado

Este mtodo retorna Verdadeiro se o usurio clicar em OK, e se os campos Usurio e


Senha forem vlidos. Caso contrrio, se a caixa de dilogo for cancelada ou se o
login ou a senha estiverem errados, aps trs tentativas o mtodo retorna Falso. Em
caso de falha, User e Comment so configurados para uma String vazia.
Os comentrios pr-definidos so guardados no Registro do Windows. Apenas os
ltimos 26 comentrios so salvos. Cada vez que a janela criada, os ltimos
comentrios so buscados no Registro e usados para preencher a lista de seleo.
Se um novo comentrio for informado pelo usurio, ele ser salvo e o mais antigo
ser descartado, caso no haja posio livre. Se for utilizado um comentrio j
existente, este passa a ser o primeiro da lista de mais recentes. Exemplo:
Sub Button1_Click()
Dim Tag, User, Comment

Visualizao

81

Set Tag = Application.GetObject("IO.Inputs.I001")


If Application.ESign(Tag.PathName, , "Alterao do Valor", _
Tag.Value, 1, User, Comment) Then
If Tag.WriteEx = 1 Then
Application.TrackEvent _
"Tag IO.Inputs.I001 alterado para 1 " &_
"pelo usurio" & User, Comment
End If
End If
End Sub

4.1.2.5 ExecuteExternalApp
ExecuteExternalApp(AppPath, Arguments, InitialDir, CmdShow[, ProcessId])
Este mtodo executa um aplicativo externo de nome e caminho AppPath, com os
argumentos Arguments, iniciando no diretrio de trabalho InitialDir. Quando
especificado um documento em AppPath, o aplicativo associado a este documento
executado, e o documento passado como um dos parmetros do aplicativo.
ProcessID recebe o nmero que identifica o processo (esse nmero utilizado no
mtodo IsAppRunning e o mesmo valor que aparece no Gerenciador de Tarefas do
Windows, na coluna PID). O parmetro CmdShow especifica o modo de abertura da
janela do aplicativo, como na tabela a seguir:
Opes disponveis para o parmetro CmdShow
OPO
0
1

2
3
4

5
6
7
8

82

DESCRIO
Es conde a ja nel a e a ti va outra ja nel a .
Ati va e mos tra a ja nel a . Se a ja nel a
es ti ver ma xi mi za da ou mi ni mi za da , el a
s er res ta ura da pa ra o ta ma nho e
pos i o ori gi na i s . Uma a pl i ca o deve
es peci fi ca r es s e va l or qua ndo es ti ver
mos tra ndo uma ja nel a pel a pri mei ra vez.
Ati va a ja nel a e mos tra -a mi ni mi za da .
Ati va a ja nel a e mos tra -a ma xi mi za da .
Mos tra a ja nel a com s eu ta ma nho e
pos i o ma i s recentes . A ja nel a a ti va
perma nece a ti va .
Ati va a ja nel a e mos tra -a com s eu
ta ma nho e pos i o a tua i s .
Mi ni mi za a ja nel a e a ti va a prxi ma
ja nel a de nvel s uperi or.
Mos tra a ja nel a mi ni mi za da . A ja nel a
a ti va perma nece a ti va .
Mos tra a ja nel a em s eu es ta do a tua l . A
ja nel a a ti va perma nece a ti va .

Visualizao

OPO
9

DESCRIO
Ati va e mos tra a ja nel a . Se a ja nel a
es ti ver ma xi mi za da ou mi ni mi za da , el a
s er res ta ura da pa ra o ta ma nho e
pos i o ori gi na i s . Uma a pl i ca o deve
es peci fi ca r es s e va l or qua ndo es ti ver
res ta ura ndo uma ja nel a que es ta va
mi ni mi za da .

Exemplo:
Sub CommandButton1_Click()
Dim ret
Application.ExecuteExternalApp "calc.exe", "", "", 1, ret
Application.GetObject("Dados.TagInterno1").Value = ret
End Sub
NOTA: O pa r metro retorna do em ProcessID pode s er 0, ca s o nenhum proces s o tenha
s i do i ni ci a do. Por exempl o, s e um documento a berto for uma URL e uma i ns t nci a
do Internet Expl orer j es ti ver roda ndo, el a mos tra r o documento. Nenhum
proces s o novo i ni ci a do, porta nto ProcessID s er 0.

4.1.2.6 Exit
Exit()
Este mtodo fecha a janela no Viewer. Exemplo:
Sub_Botao1.Click()
Application.Exit()
EndSub

4.1.2.7 GetFormulaUnitDataObj
GetFormulaUnitDataObj(FormulaName)
Este mtodo obtm a configurao das Unidades existentes em uma determinada
Frmula. As Unidades so o destino dos dados salvos na Frmula (valores). Este
mtodo possui o parmetro FormulaName, que o nome da Frmula.
Utilize o mtodo GetFormulaUnitDataObj para obter uma coleo das unidades de
uma Frmula. Este mtodo retorna True se conseguir realizar a operao, ou False,
caso no consiga. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no boto, mostra uma caixa de
' mensagem(MessageBox) com o nmero de Units e o nome da
' Primeira Unit
Set obj = Application.GetFormulaUnitDataObj("Formula1")
MsgBox CStr(obj.Count)

Visualizao

83

MsgBox CStr(obj.Name(1))
End Sub

4.1.2.8 GetFormulaValueDataObj
GetFormulaValueDataObj(FormulaName)
Este mtodo obtm a configurao dos valores existentes em uma determinada
Frmula. Os valores so o conjunto de dados salvos na Frmula. Este mtodo
possui o parmetro FormulaName, que o nome da Frmula.
Utilize o mtodo GetFormulaValueDataObj para obter uma coleo de valores na
Frmula. Este mtodo retorna True se conseguir realizar a operao, ou False, caso
no consiga. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no boto, mostra uma caixa de mensagem
' (MessageBox) com o nmero de Conjuntos
' e o nome do Primeiro Conjunto.
Set obj = Application.GetFormulaValueDataObj("Formula1")
MsgBox CStr(Obj.Count)
MsgBox CStr(obj.Name(1))
End Sub

4.1.2.9 GetFrame
GetFrame([FrameName])
O mtodo GetFrame procura por um objeto Divisor que j esteja aberto no Viewer
atual. Este mtodo possui o parmetro FrameName, que opcional e determina o
nome do Quadro a ser buscado. Caso o valor especificado em FrameName seja
vazio, ele retornar um Quadro que contm todos os Divisores ou a Tela ativa no
momento. Com o retorno deste mtodo, utilize os mtodos do Divisor, como por
exemplo, o mtodo OpenScreen para abrir uma outra Tela. Exemplo:
Sub Botao1_Click()
' Ao clicar no Boto pega o quadro Menu
' e substitui a Tela atual deste quadro pela tela Opes
Set frame = Application.GetFrame("Menu")
' frame possui um objeto do tipo divisor
frame.OpenScreen "Opes", 0
End Sub

4.1.2.10 GetFullUserName
GetFullUserName()
O mtodo GetFullUserName retorna o nome completo do usurio logado no E3.
Caso no haja nenhum usurio logado, retornada uma String vazia.

84

Visualizao

4.1.2.11 GetKeyPad
GetKeyPad()
Retorna uma referncia para o objeto Elipse KeyPad, permitindo manipular um
teclado virtual flutuante em aplicaes desenvolvidas com o E3. Veja o Manual do
Usurio do E3 para maiores informaes sobre este objeto. Os mtodos e
propriedades do Elipse KeyPad esto descritos no captulo ActiveX - Elipse KeyPad.

4.1.2.12 GetMouseX
GetMouseX()
Retorna a coordenada X do mouse, em pixels, referente rea total da tela do
computador.
NOTA: Es te mtodo i r fa l ha r em um s cri pt s e a pos i o a tua l do mous e n o puder
s er determi na da . Uma da s s i tua es onde es s a fa l ha pode s er veri fi ca da o ca s o
de es ta r a berta a ja nel a de Logon do Wi ndows (a o pres s i ona r a combi na o de
tecl a s CTRL + ALT + DEL). Es te comporta mento de i mpedi r o a ces s o pos i o a tua l
do mous e pa dr o do Wi ndows em a l guma s s i tua es e n o pode s er contorna do.
Sugere-s e uti l i za r o coma ndo On Error Resume Next a ntes da uti l i za o des te
mtodo pa ra evi ta r erros de s cri pt.

4.1.2.13 GetMouseY
GetMouseY()
Retorna a coordenada Y do mouse, em pixels, referente rea total da tela do
computador.
NOTA: Es te mtodo i r fa l ha r em um s cri pt s e a pos i o a tua l do mous e n o puder
s er determi na da . Uma da s s i tua es onde es s a fa l ha pode s er veri fi ca da o ca s o
de es ta r a berta a ja nel a de Logon do Wi ndows (a o pres s i ona r a combi na o de
tecl a s CTRL + ALT + DEL). Es te comporta mento de i mpedi r o a ces s o pos i o a tua l
do mous e pa dr o do Wi ndows em a l guma s s i tua es e n o pode s er contorna do.
Sugere-s e uti l i za r o coma ndo On Error Resume Next a ntes da uti l i za o des te
mtodo pa ra evi ta r erros de s cri pt.

4.1.2.14 GetValue
GetValue(TagName)
O mtodo GetValue busca pelo valor de um objeto especificado no parmetro
TagName. Se TagName apontar para uma propriedade, este mtodo retornar o
valor da propriedade. Se por outro lado o parmetro TagName especificar um
objeto, o mtodo retornar o valor da propriedade Value do objeto. Exemplo:
Sub Botao1_Click()

Visualizao

85

'
'
X
End

Ao clicar no Boto pega o valor de um tag


sendo executado em um DataServer
= Application.GetValue("DataServer1.InternalTag1")
Sub

4.1.2.15 IsAppRunning
IsAppRunning(ProcessId)
Indica se uma aplicao iniciada pelo mtodo ExecuteExternalApp est sendo
executada. Retorna True se o aplicativo identificado no sistema operacional por
ProcessId estiver rodando. Caso contrrio, retorna False. Exemplo:
Sub CommandButton1_Click()
Application.ExecuteExternalApp _
"www.elipse.com.br", "", "", 1, processID
While Application.IsAppRunning(processID)
' Espera pelo final da aplicao
Wend
MsgBox "Terminou a aplicao!"
End Sub
NOTA: O pa r metro ProcessId o mes mo va l or que a pa rece no Gerenci a dor de
Ta refa s do Wi ndows , na col una PID.

4.1.2.16 IsUserMemberOfGroup
IsUserMemberOfGroup(GroupName[, UserName])
Este mtodo verifica se um usurio pertence a um determinado grupo. Possui os
seguintes parmetros:
GroupName: Nome do grupo de usurios que se quer verificar
UserName: Nome do usurio que se quer verificar. Se este parmetro for omitido,
ou for igual a uma String vazia, o mtodo considera o usurio atualmente logado
no Viewer
O mtodo retorna Verdadeiro se o usurio pertencer ao grupo indicado por
GroupName, ou Falso caso contrrio.

4.1.2.17 IsWebViewer
IsWebViewer()
Verifica se o aplicativo est sendo visualizado pelo WebViewer. O mtodo retorna
True se a aplicao estiver sendo executada no WebViewer. Caso contrrio, retorna
False.

86

Visualizao

4.1.2.18 LoadFormulaDlg
LoadFormulaDlg(FormulaName[, UnitName[, ValueName]])
Este mtodo apresenta uma caixa de dilogo que permite ao usurio escolher o
conjunto de valores e a unidade de destino, carregando uma Frmula. Este mtodo
possui o parmetro FormulaName, que determina o nome do objeto Frmula que
ser operado.
Utilize o mtodo LoadFormulaDlg para chamar uma caixa de dilogo para
carregamento dos dados do objeto Frmula especificado por FormulaName. Nesta
caixa possvel especificar qual conjunto de valores (UnitName) ser enviado para
qual conjunto de Tags (ValueName). Nesta caixa de mensagem o usurio conta com
todos os conjuntos de valores e unidades disponveis no objeto Frmula, podendo
atribuir um a outro livremente. Quando o usurio clicar em OK, o conjunto de
valores ser carregado na unidade especificada. Exemplo:
Sub Botao1_Click()
' Chama a caixa de dilogo para operar
Dim val
Application.LoadFormulaDlg("Formula1")
End Sub

4.1.2.19 LoadFormulaValues
LoadFormulaValues(FormulaName, UnitName, ValueName)
Este mtodo carrega automaticamente um conjunto de valores para uma unidade
de destino, apresentando uma caixa de dilogo que permite ao usurio informar
valores diferentes daqueles definidos na Frmula. Este mtodo possui os seguintes
parmetros: FormulaName determina o nome da Frmula e UnitName determina o
nome da unidade. O nome do conjunto de valores configurado no parmetro
ValueName.
Uma caixa de mensagem aparecer permitindo ao usurio informar valores
diferentes daqueles definidos para cada um dos valores da Frmula.
NOTA: O mtodo retorna um va l or l gi co, ou s eja , retorna True qua ndo executa da
com s uces s o, e Fa l s e qua ndo fa l ha , o que n o s i gni fi ca que houve um erro no
s cri pt.

Exemplo:
Sub Botao1_Click()
Application.LoadFormulaValues "Formula1", "Unit1", "Value1"
End Sub

Visualizao

87

4.1.2.20 LoadFormulaValuesQuiet
LoadFormulaValuesQuiet(FormulaName, UnitName, ValueName)
Carrega um conjunto de valores para uma unidade de destino, sem apresentar
nenhuma mensagem. Este mtodo possui os seguintes parmetros: FormulaName
determina o nome da Frmula e UnitName determina o nome da unidade. O nome
do conjunto de valores configurado no parmetro ValueName. Exemplo:
Sub Botao1_Click()
Application.LoadFormulaValuesQuiet "Formula1", "Unidade3",
"Valor1"
End Sub
NOTA: Es te mtodo ta mbm a ces s a do a tra vs do objeto Frmula.

4.1.2.21 LoadReport
LoadReport(ReportName)
Carrega um modelo de Relatrio. O parmetro ReportName o nome do Relatrio a
ser carregado. Exemplo:
Sub Rect_Click()
' Carregando o relatrio pr-definido
Set strRep = Application.LoadReport("[Relatrio3]")
strRep.PrintPreview ' Visualizando a impresso
End Sub

4.1.2.22 Login
Login([Mode])
Abre uma caixa de dilogo para o login (autenticao de usurio) na aplicao. O
usurio logado permanece na memria at que seja feito outro login ou logout
(sada do usurio da aplicao). Este mtodo possui o parmetro Mode, que um
Booleano que determina se uma mensagem de confirmao ou falha da operao
dever ser mostrada (o padro Falso). Quando uma Tela estiver para ser aberta
(atravs do mtodo OpenScreen), verificado se existe alguma configurao de
segurana. Caso exista, a Tela s ser aberta se o usurio logado tiver permisso.
Caso no tenha permisso, aberto um dilogo para o login.

4.1.2.23 LoginUser
LoginUser(Username, UserPassword)
Executa o login de um usurio especfico sem mostrar nenhuma mensagem. O
parmetro Username o nome do usurio e o parmetro UserPassword a senha
desse usurio. O mtodo retorna Verdadeiro se o login do usurio foi bemsucedido, e Falso caso contrrio. Se o usurio passado no parmetro Username
88

Visualizao

estiver configurado para trocar de senha no prximo login, o mtodo retorna Falso.
NOTA: Es te mtodo s es ta r di s ponvel s e o us u ri o l oga do for um us u ri o do
Domni o do E3.

4.1.2.24 Logout
Logout([Mode])
Executa o logout (sada do usurio atual da aplicao) do Viewer. Caso no haja
um usurio logado, este mtodo no tem efeito. A partir deste momento, ser
considerado que um usurio "annimo" est utilizando a aplicao. (Pode-se
utilizar o evento OnLogout para executar um script para ir para a Tela inicial ou
finalizar a aplicao). Este mtodo possui o parmetro opcional Mode, que um
Booleano que determina se uma mensagem de confirmao ou falha da operao
dever ser mostrada (o padro Falso).

4.1.2.25 PasswordConfirm
PasswordConfirm(Mode)
Este mtodo abre uma caixa de dilogo solicitando a reconfirmao da senha do
usurio atualmente logado. Retorna Verdadeiro se a senha for confirmada, ou
Falso caso contrrio. O parmetro Booleano Mode determina se deve ser executado
um logout em caso de falha na confirmao (Verdadeiro) ou no (Falso).

Confirmao de senha

Se a caixa de dilogo for fechada atravs do boto Cancelar, o mtodo retorna


Falso. Caso no haja usurio logado, o mtodo retorna Falso, mas sem abrir a
caixa de dilogo. Caso a senha digitada no esteja correta, a solicitao repetida
at no mximo trs vezes. Se o usurio digitar a senha incorreta nestas trs vezes, a
caixa de dilogo fechada e o mtodo retorna Falso.

Visualizao

89

NOTA: Es te mtodo s es ta r di s ponvel s e o us u ri o l oga do for um us u ri o do


Domni o do E3.

4.1.2.26 Playsound
Playsound(Filename)
Toca um arquivo de som cujo caminho e nome esto indicados no parmetro
Filename. O arquivo deve seguir as seguintes especificaes:
Dever estar no formato de som do Windows (extenso .wav)
Se o arquivo estiver no projeto (adicionado atravs do comando Inserir recurso),
o nome do arquivo dever estar entre colchetes
Se foi criada uma pasta no projeto e o arquivo foi adicionado atravs do
comando Inserir recurso, o caminho dever ser especificado entre aspas (por
exemplo, "c:\som\ding.wav"). Se o arquivo estiver no diretrio local, o nome no
precisa de aspas, basta colocar o caminho (por exemplo: c:\som\ding.wav).
Exemplo:
Sub TelaInicial_OnAlarm()
' Se existir um alarme ativo, ser tocado um som de alerta.
' Quando o alarme reconhecido, o som pra.
Set Alarme = Application._
GetObject("ConfigAlarmes1.Area1.FonteAlarme1")
If Alarme.ActiveNACKAlarms = True Then
Application.PlaySound("[ringin.wav]")
End If
End Sub

4.1.2.27 SelectMenu
SelectMenu(Menu[, Left, Top])
Este mtodo mostra um menu contextual conforme especificado pelo parmetro
Menu. Este parmetro um texto que consiste em vrias opes delimitadas pela
barra vertical (|), sendo que cada uma destas Strings ser uma opo do menu.
Caso haja um conjunto de dois delimitadores sucessivos (||), um separador ser
inserido. Use os caracteres de abre e fecha chaves para criar um submenu. Um
asterisco na frente de uma String indica que a opo estar marcada. J um sinal
de exclamao far com que a opo esteja desabilitada.
A posio da caixa de dilogo pode ser configurada atravs dos parmetros Left e
Top, que indicam a distncia da margem esquerda e do topo da Tela em pixels,
respectivamente. Caso estes parmetros no sejam informados, o menu
posicionado de acordo com o local onde o clique do mouse foi acionado.
Este mtodo retornar 0 se nenhuma opo foi selecionada, ou o nmero da opo,
sendo que 1 seria para a primeira opo contida no texto, 2 para a segunda e
90

Visualizao

assim por diante. Exemplo:


Sub Botao1_Click()
op = _
Application.SelectMenu("Opo1||Opo2{*Opo2|Opo3}|
Opo4|!Opo5")
If op = 1 Then
MsgBox "Opo 1 foi escolhida"
ElseIf op = 2 Then
MsgBox "Opo 2 foi escolhida"
ElseIf op = 3 Then
MsgBox "Opo 3 foi escolhida"
ElseIf op = 4 Then
MsgBox "Opo 4 foi escolhida"
ElseIf op = 0 Then
MsgBox "Nenhuma opo foi escolhida"
End If
End Sub

4.1.2.28 SetValue
SetValue(TagName, NewVal)
Este mtodo configura o valor de um objeto dentro do servidor. O mtodo SetValue
procura por um objeto ou propriedade sendo executado no servidor e atribui o
valor especificado no parmetro definido em TagName. O tipo e o valor do
parmetro NewVal devero ser suportados pelo objeto especificado em TagName.
Exemplo:
Sub Botao1_Click()
' Ao clicar em Botao1 atribui o valor 20
' para a propriedade Value do tag
Application.SetValue "DataServer1.InternalTag1", 20
End Sub

4.1.2.29 ShowDatePicker
ShowDatePicker(DateValue, Left, Top[, DefaultDate])
Abre uma caixa de dilogo para a alterao de data e hora. Este mtodo retorna
True se o usurio confirmar a data, ou False se o usurio cancelar a edio. A nova
data retornada no parmetro DateValue. A posio da caixa de dilogo pode ser
configurada atravs dos parmetros Left e Top, que indicam a distncia da margem
esquerda e do topo da tela em pixels, respectivamente. Caso estes parmetros no
sejam informados, a caixa de dilogo centralizada. O valor do parmetro
DefaultDate a data e a hora iniciais quando a caixa de dilogo for aberta. Se no
for informada a data, o sistema assume a data atual; se no for informada a hora,
iniciar como 00:00:00. Se nem a data nem a hora forem informadas, iniciar com
data e hora atuais. Exemplos:
Sub Texto2_Click()
Dim novaHora

Visualizao

91

Application.ShowDatePicker novaHora, 300, 300


MsgBox "A hora : " & novaHora
End Sub

4.1.2.30 ShowFilePicker
ShowFilePicker(Open, FileName[, Extension, Flags, Filter])
Exibe as caixas de dilogo Salvar e Abrir Arquivo, do Windows. O parmetro Open
indica o dilogo a ser aberto; se True, abre a janela Abrir Arquivo; se False, abre a
janela Salvar. O parmetro FileName indica a varivel onde ser armazenado o
nome do arquivo a ser salvo ou carregado, caso o mtodo retorne True. Este
parmetro deve ser obrigatoriamente uma varivel. O parmetro Extension
opcional e informa a extenso do arquivo padro a ser anexada ao nome do
arquivo na caixa de entrada, quando a extenso no for informada. Caso esteja
vazio, nenhuma extenso ser concatenada ao final do nome do arquivo. Extenses
mltiplas podem ser especificadas usando-se o caractere de ponto e vrgula como
delimitador. A String deve terminar com os caracteres ||.
O parmetro Flags opcional e define o comportamento da caixa de dilogo. um
nmero inteiro, a soma dos valores da tabela a seguir. O parmetro Filter
opcional e define um conjunto de pares de Strings que especificam filtros que
podem ser aplicados aos arquivos. A primeira String descreve o filtro, e a segunda
indica o tipo de extenso a ser utilizada.
Combinaes possveis para o parmetro Flags
VALOR
1

92

DESCRIO
CREATEPROMPT: Se o us u ri o es peci fi ca r
um a rqui vo que n o exi s te, es te flag fa z
com que el e s eja ques ti ona do s obre a
cri a o do a rqui vo. Se el e es col her cri a r
o a rqui vo, a ca i xa de di l ogo fecha da e
o nome do a rqui vo retorna do no
pa r metro Filename. Ca s o contr ri o, a
ca i xa de di l ogo perma nece a berta .
FILEMUSTEXIST: Es peci fi ca que o us u ri o
s pode di gi ta r nomes de a rqui vos
exi s tentes . Ca s o contr ri o, a ca i xa de
di l ogo mos tra um a vi s o na ca i xa de
mens a gens .
NOCHANGEDIR: Recupera o di retri o
a tua l pa ra o va l or ori gi na l ca s o o us u ri o
tenha muda do de di retri o enqua nto
bus ca va o a rqui vo. N o tem efei to pa ra a
ja nel a Abri r Arqui vo no Wi ndows XP.

Visualizao

VALOR
8

16

32

64
128

DESCRIO
NODEREFERENCELINKS: Confi gura a ca i xa
de di l ogo pa ra retorna r o a rqui vo de
a ta l ho (.l nk) s el eci ona do. Se es te flag
n o for es peci fi ca do, a ca i xa de di l ogo
retorna o ca mi nho e nome de a rqui vo
referenci a dos pel o a rqui vo de a ta l ho.
NOREADONLYRETURN: Determi na que o
a rqui vo retorna do n o s eja s omente
pa ra l ei tura , e o di retri o n o
protegi do contra gra va o.
PATHMUSTEXIST: Es peci fi ca que o us u ri o
pode i nforma r a pena s a rqui vos e
di retri os v l i dos , ca s o contr ri o uma
ca i xa de mens a gem mos tra da pa ra
a vi s a r o us u ri o.
READONLY: Fa z o bot o de op o Somente
Leitura s er s el eci ona do i ni ci a l mente
qua ndo o di l ogo cri a do.
OVERWRITEPROMPT: Fa z a ca i xa de
di l ogo de Sa l va r Como gera r uma
mens a gem i nforma ndo da exi s tnci a do
a rqui vo, e pede confi rma o pa ra
s obres crever o a rqui vo.

Exemplo de filtro:
"Arquivos de Chart (*.xlc)|*.xlc|Planilhas Excel (*.xls)|*.xls|
_
Arquivos de Dados (*.xlc;*.xls)|*.xlc; *.xls|Todos os
arquivos (*.*)|*.*||"

4.1.2.31 ShowPickColor
ShowPickColor(ColorValue[, Color, Left, Top])
Abre a caixa de dilogo Cores do Windows para a escolha de uma cor. O valor
decimal da cor escolhida retornado no parmetro ColorValue. O parmetro Color
indica uma cor previamente selecionada na paleta de cores. Se este parmetro no
for informado, assume o valor 0 (preto). A posio da caixa de dilogo pode ser
configurada atravs dos parmetros Left e Top, que indicam respectivamente, a
distncia da margem esquerda e do topo da tela, em pixels. Caso estes parmetros
no sejam informados, a caixa de dilogo centralizada. Exemplo:
Sub CommandButton_Click()
Dim novaCor
Dim corPadrao
corPadrao = 65280 ' Verde Claro
If Application.ShowPickColor(novaCor, corPadrao, 90, 90) Then
Screen.Item("Retangulo1").ForegroundColor = novaCor

Visualizao

93

Screen.Item("Texto1").Value = novaCor
End If
End Sub

4.1.2.32 Stopsound
Stopsound()
Para um som que esteja tocando.

4.1.2.33 ToggleValue
ToggleValue(TagName, ValA, ValB)
O mtodo ToggleValue busca o valor do objeto ou propriedade sendo executado no
servidor e compara com os parmetros ValA e ValB. Se o valor buscado for igual a
ValB, o objeto ou propriedade especificado em TagName receber o valor de ValA.
Caso contrrio, receber o valor de ValB. Caso o valor de TagName no seja nem
ValA nem ValB, o mtodo ToggleValue atribuir o valor especificado em ValA.
Exemplo:
Sub Botao1_Click()
' Ao clicar no Boto atribui o valor
' a um tag sendo executado em um DataServer.
' Atribui o valor 20 para o tag.
Application.SetValue "DataServer1.InternalTag1", 20
' J que o valor do InternalTag1 j 20,
' o mtodo ToggleValue alternar o valor para 30.
Application.ToggleValue "DataServer1.InternalTag1", 30, 20
End Sub

4.1.2.34 TrackEvent
TrackEvent(EventMessage[, Comment, TimeStamp])
O mtodo TrackEvent permite gerar eventos via script manualmente. Estes eventos
podem ser gerados tanto no Viewer como no Servidor, e so registrados em uma
tabela no banco de dados do aplicativo.
Parmetros do mtodo TrackEvent
NOME
EventMessage
Comment

TimeStamp

94

DESCRIO
Contm a mens a gem do evento (m xi mo
de 200 ca ra cteres ).
(Opci ona l ) Contm coment ri os
a di ci ona i s s obre o evento (m xi mo de
200 ca ra cteres ).
(Opci ona l ) Indi ca a da ta e hora em que o
evento ocorreu. Se n o for es peci fi ca do,
o E3 a s s ume a da ta e hora a tua i s .

Visualizao

O mtodo TrackEvent s vai registrar os eventos caso a opo de Registro de


Eventos nas Opes do Domnio esteja habilitada. Os eventos so registrados em
uma tabela de um banco de dados, que definida tambm nas configuraes de
Registro de Eventos.
Para maiores informaes sobre o Registro de Eventos do Domnio, consulte o
Manual do Usurio do E3. Exemplo:
Sub Button1_Click()
Dim Tag, User, Comment
Set Tag = Application.GetObject("IO.Inputs.I001")
If Application.ESign(Tag.PathName, , "Alterao do Valor", _
Tag.Value, 1, User, Comment) Then
If Tag.WriteEx 1 Then
Application.TrackEvent _
"Tag IO.Inputs.I001 alterado para 1 " &_
"pelo usurio" & User, Comment
End If
End If
End Sub

4.1.2.35 UserAdministration
UserAdministration()
Este mtodo abre uma caixa de dilogo que permite editar a lista de usurios do
Servidor. As funes disponveis so:
Mostrar a lista de todos os usurios
Excluir usurios (no possvel excluir o usurio atual)
Adicionar e editar usurios
Editar as configuraes de um usurio
Alterar a senha do usurio
Alterar os demais dados do usurio (login, nome, etc.)
IMPORTANTE: Apena s o Admi ni s tra dor pode ter a ces s o a o mtodo UserAdministration.
A ca i xa de di l ogo de confi gura o dos us u ri os a ces s vel s omente a o us u ri o
ha bi l i ta do como Admi ni s tra dor.

4.1.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Viewer.

Visualizao

95

4.1.3.1 BlinkTime
Define o tempo, em milissegundos, entre cada mudana de estado quando um
objeto tem que piscar (ou seja, toda vez que algum objeto de Tela tem uma
associao e marcada a opo Piscar). O valor padro desta propriedade
200ms.
NOTA: O tempo mni mo de a tua l i za o da Tel a 55ms ; porta nto, s e es ta
propri eda de for confi gura da com tempo i nferi or a 55ms , a confi gura o n o ter
efei to a l gum.

4.1.3.2 CacheEnable
Mantm em memria as Telas j abertas instanciadas no Viewer, permitindo uma
troca mais rpida entre elas. Se a propriedade for habilitada, ento o cache de
Telas tambm habilitado.

4.1.3.3 Caption
Determina o nome da aplicao que est utilizando o Viewer. O valor padro
desta propriedade vazio.

4.1.3.4 CenterWindow
Quando habilitada, determina que a janela de visualizao do Viewer dever
iniciar centralizada. Caso contrrio, ser utilizada a configurao padro. O valor
padro desta propriedade True.

4.1.3.5 CloseButton
Se a opo estiver habilitada, o boto Fechar habilitado no Viewer, e possvel
utilizar este boto. Caso contrrio, este boto no aparece na janela. O valor
padro desta propriedade True.

4.1.3.6 CommErrorBkColor
Propriedade utilizada para definir a cor de fundo do Setpoint quando uma
Associao ou Conexo falhou. O valor padro desta propriedade vermelho
(RGB(255, 0, 0)). Verificar tambm a propriedade EnableCommError.

4.1.3.7 CommErrorText
Propriedade utilizada para definir o texto de alerta quando uma Associao ou
Conexo falhou. O valor padro desta propriedade "???". Verificar tambm a
propriedade EnableCommError.
96

Visualizao

4.1.3.8 CommErrorTextColor
Propriedade utilizada para definir a cor do texto do Setpoint quando uma
Associao ou Conexo falhou. O valor padro desta propriedade amarelo
(RGB(255, 255, 0)). Verificar tambm a propriedade EnableCommError.

4.1.3.9 DisableTaskSwitching
Se estiver configurada para True, desabilita a troca de janelas no Viewer. Caso
contrrio, a troca de janelas habilitada. O valor padro desta propriedade
False. Essa propriedade pode ser modificada em tempo de execuo utilizando o
mtodo SetDisableTaskSwitching.

4.1.3.10 EnableCommError
Habilita ou desabilita a visualizao dos erros de comunicao. Por exemplo,
caso haja na Tela um Setpoint associado a um Tag de Comunicao, e a
comunicao do E3 com este Tag falhe, ser mostrado no Setpoint o texto
configurado na propriedade CommErrorText, com a cor informada na propriedade
CommErrorTextColor e a cor de fundo do Setpoint definida na propriedade
CommErrorBkColor. O valor padro desta propriedade True.

4.1.3.11 EnableHeartbeat
Habilita ou desabilita o envio de heartbeat (mensagem enviada em intervalos
fixos, que indica que o Servidor est ativo) entre o Viewer e o servidor. Caso o
Viewer pare de receber as mensagens de heartbeat, sinal de que algum problema
ocorreu, portanto a conexo deve ser abortada. O valor padro desta propriedade
False.

4.1.3.12 EnableInactivity
Habilita ou desabilita a verificao do perodo de inatividade do usurio. Para
maiores informaes, veja o evento OnInactive, do objeto Viewer. O valor padro
desta propriedade False.

4.1.3.13 EnableZoomMenu
Se estiver configurada como True, habilita a exibio do menu de configurao
do zoom da Tela atravs do boto direito do mouse em tempo de execuo, exceto
quando algum script estiver configurado com informao divergente nos eventos
MouseDown ou MouseUp. Caso contrrio, o menu no ser mostrado. O valor
padro desta propriedade True.

Visualizao

97

4.1.3.14 HeartbeatPeriodMs
Indica o intervalo (em milissegundos) entre as mensagens de heartbeat enviadas
pelo Servidor. A mensagem de heartbeat sempre enviada quando o servidor fica o
perodo indicado por esta propriedade sem enviar nenhuma mensagem para o
Viewer. O valor padro desta propriedade 2000 (dois segundos).

4.1.3.15 HeartbeatTimeoutMs
Indica o tempo, em milissegundos, que o Viewer tolera sem receber nenhuma
mensagem do Servidor. Se este tempo passar, e nenhuma mensagem for recebida, o
Viewer assume que a conexo foi perdida, e inicia o processo de reconexo. Este
tempo deve ser maior que o tempo determinado na propriedade
HeartbeatPeriodMs, de preferncia maior que o dobro. O valor padro desta
propriedade 5000 (cinco segundos).

4.1.3.16 InactivityTime
Define o tempo mximo de espera por um evento de mouse ou de teclado antes do
perodo de inatividade, em minutos. Para maiores informaes, veja o evento
OnInactive do objeto Viewer. O valor padro desta propriedade 5 (cinco) minutos.
Exemplo:
Sub CommandButton3_Click()
MsgBox "A aplicao ficar inativa em " & _
Application.InactivityTime & " minuto(s)."
End Sub

4.1.3.17 InitialScreen
Indica a Tela ou Quadro inicial que dever ser mostrado quando o Viewer
chamado. Atravs da propriedade WindowStyle, possvel determinar se a janela
dever iniciar maximizada, janelada ou minimizada. O valor padro desta
propriedade "TelaInicial".

4.1.3.18 IsPlaybackMode
Se True, indica que o Viewer est rodando dentro de um E3Playback, em modo
playback. Esta propriedade somente de leitura e s est disponvel em tempo de
execuo.

4.1.3.19 IsReadOnly
Se ajustada para True, indica que o Viewer est no modo Somente Leitura
(acesso restrito).

98

Visualizao

4.1.3.20 LoginRetries
Especifica o nmero de retentativas de login do Viewer, isto , quantas vezes a
caixa de dilogo de login ser exibida alm da primeira vez. O valor padro desta
propriedade 2.

4.1.3.21 MaximizeButton
Se a opo estiver habilitada (True), o boto Maximizar habilitado no Viewer, e
possvel utilizar esse boto. Caso contrrio, esse boto no aparece na janela. O
valor padro desta propriedade True.

4.1.3.22 MinimizeButton
Se a opo estiver habilitada (True), o boto Minimizar habilitado no Viewer, e
possvel utilizar esse boto. Caso contrrio, esse boto no aparece na janela. O
valor padro desta propriedade True.

4.1.3.23 Params
Esta propriedade um vetor de pares chave-valor, que retorna os parmetros
passados para o Viewer atravs da opo de linha de comando -params. Todos os
valores so retornados como Strings. Por exemplo, se a linha de comando do
Viewer contiver os seguintes parmetros:
Viewer -params Idioma=PTB

Pode-se utilizar o seguinte cdigo para verificar qual o idioma de inicializao do


Viewer.
Sub TelaInicial_OnStartRunning()
Select Case Application.Params("Idioma")
Case "PTB"
Item("Texto1").Value = "Portugus do Brasil"
Case Else
Item("Texto1").Value = "Idioma no reconhecido"
End Select
End Sub
NOTA: A String da cha ve n o fa z di ferena entre ma i s cul a s e mi ns cul a s (pode s er
ta nto "i di oma " qua nto "Idi oma "), ma s os va l ores retorna dos , pri nci pa l mente s e
uti l i za dos com um coma do Select, fa zem a di ferenci a o entre ma i s cul a s e
mi ns cul a s .

4.1.3.24 ReconnectDialogDelaySec
Indica o nmero de segundos que o Viewer ir esperar durante uma possvel
reconexo ao servidor antes de mostrar uma mensagem avisando o usurio desta
Visualizao

99

ao (esta propriedade no afeta a primeira conexo). Se for igual a 0, a mensagem


de reconexo sempre ser mostrada. Para evitar que a mensagem seja mostrada,
recomendvel colocar um nmero muito grande (1 bilho, por exemplo).
NOTA: Qua ndo a reconex o ocorre em s i l nci o, toda s a s ja nel a s do Vi ewer a ti vo
fi ca m des a bi l i ta da s e uma a mpul heta mos tra da , i ndi ca ndo que o a pl i ca ti vo es t
i ndi s ponvel . Dura nte o tempo da reconex o, n o permi ti do a o us u ri o ca ncel a r o
proces s o.

4.1.3.25 RenderQuality
Controla a qualidade de desenho de todas as Telas, somente se o valor da
propriedade RenderQuality das Telas seja igual a 0 - rqDefault. Os valores
possveis para esta propriedade so os seguintes:
0 - rqDefault: Utiliza o modo de qualidade normal, GDI (Graphics Device Interface).
Corresponde ao item Utilizar Padro do menu contextual Qualidade (todas as
telas) do Viewer, em tempo de execuo. Este o valor padro para aplicaes
criadas em verses anteriores 4.0
1 - rqNormal: Fora o modo de qualidade normal (GDI) para o desenho de todas
as Telas. Corresponde ao item Forar Qualidade Normal do menu contextual
Qualidade (todas as telas) do Viewer, em tempo de execuo
2 - rqHighQuality: Fora o modo de alta qualidade (GDI+) para o desenho de todas
as Telas. Corresponde ao item Forar Alta Qualidade do menu contextual
Qualidade (todas as telas) do Viewer, em tempo de execuo. Este o valor padro
para aplicaes criadas a partir da verso 4.0
A figura a seguir mostra o menu contextual do Viewer em tempo de execuo, com
as respectivas opes de configurao desta propriedade:

100

Visualizao

Menu contextual do Viewer em tempo de execuo

4.1.3.26 ShowKeyPadOnEdit
Esta propriedade automaticamente habilita a exibio do Elipse KeyPad, sempre
que um objeto de Tela que permita edio receba o foco.

4.1.3.27 TargetDPIX
Define o valor de pontos por polegada, na horizontal, do monitor do computador
de destino. O valor padro desta propriedade -1, que faz com que seja assumido o
valor do computador atual.

Visualizao

101

4.1.3.28 TargetDPIY
Define o valor de pontos por polegada, na vertical, do monitor do computador de
destino. O valor padro desta propriedade -1, que faz com que seja assumido o
valor do computador atual.

4.1.3.29 TargetMarginX
Define o nmero de pixels que devem ser descontados da resoluo horizontal da
Tela (a rea til do Viewer). O valor padro da propriedade -1, que faz com que
seja assumida a configurao da janela do Viewer (com ou sem a barra de ttulo,
com ou sem borda) em conjunto com a configurao do computador atual (largura
de borda e barra de ttulo definidas pelo Windows).

4.1.3.30 TargetMarginY
Define o nmero de pixels que devem ser descontados da resoluo vertical da
Tela (a rea til do Viewer). O valor padro da propriedade -1, que faz com que
seja assumida a configurao da janela do Viewer (com ou sem a barra de ttulo,
com ou sem borda) em conjunto com a configurao do computador atual (largura
de borda e barra de ttulo definidas pelo Windows).

4.1.3.31 TargetResolutionX
Define a resoluo horizontal da Tela para a qual esta aplicao est destinada
(em pixels). O valor padro da propriedade -1, que faz com que seja assumida a
resoluo do computador atual.

4.1.3.32 TargetResolutionY
Define a resoluo vertical da Tela para a qual esta aplicao est destinada (em
pixels). O valor padro da propriedade -1, que faz com que seja assumida a
resoluo do computador atual.

4.1.3.33 TitleBar
Se a opo estiver habilitada (True), a barra de ttulo do Viewer mostrada,
conforme as especificaes da propriedade Caption. Do contrrio, ela escondida.
O valor padro desta propriedade True.

4.1.3.34 User
Contm o nome do usurio que est utilizando o Viewer. Esta propriedade
somente para leitura.

102

Visualizao

4.1.3.35 ViewerLanguageId
Retorna o cdigo do idioma do Viewer em execuo. Os valores possveis para
esta propriedade esto descritos na tabela a seguir. Esta propriedade somente de
leitura e s est disponvel em tempo de execuo.
Valores disponveis para ViewerLanguageId
DECIMAL
4
1031
1033
1034
1046

HEXADECIMAL
0x0004
0x0407
0x0409
0x040A
0x0416

IDIOMA
Chi ns Si mpl i fi ca do
Al em o
Ingl s Ameri ca no
Es pa nhol
Portugus do Bra s i l

NOTA: Es ta propri eda de NO corres ponde a o i di oma de i ns ta l a o do Wi ndows e


nem a o i di oma confi gura do no pa i nel de control e Opes Regionais e de Idioma
(Relgio, Idioma e Regio no Wi ndows 7) do Wi ndows .

4.1.3.36 WindowBorder
Habilita ou desabilita uma borda na janela do Viewer. O valor padro dessa
propriedade verdadeiro. Essa propriedade de leitura e escrita, mas alterar seu
valor em tempo de execuo no altera a configurao do Viewer j aberto, apenas
das janelas que forem abertas utilizando a configurao do Viewer.

4.1.3.37 WindowHeight
Determina a altura da janela do Viewer, em pixels. O valor padro dessa
propriedade 300.

4.1.3.38 WindowMovable
Indica se a janela pode ser movida. O valor padro dessa propriedade
verdadeiro. Essa propriedade de leitura e escrita, mas alterar seu valor em tempo
de execuo no altera a configurao do Viewer j aberto, apenas das janelas que
forem abertas utilizando a configurao do Viewer.

4.1.3.39 WindowResizable
Indica se a janela pode ser redimensionada. Esta propriedade s tem efeito se a
propriedade WindowBorder for verdadeira. O valor padro dessa propriedade
verdadeiro. Essa propriedade de leitura e escrita, mas alterar seu valor em tempo
de execuo no altera a configurao do Viewer j aberto, apenas das janelas que
forem abertas utilizando a configurao do Viewer.
Visualizao

103

4.1.3.40 WindowSmallTitle
Indica se a janela do Viewer deve ter a barra de ttulo pequena. Esta propriedade
s tem efeito se a propriedade TitleBar for verdadeira. O valor padro dessa
propriedade Falso. Essa propriedade de leitura e escrita, mas alterar seu valor
em tempo de execuo no altera a configurao do Viewer j aberto, apenas das
janelas que forem abertas utilizando a configurao do Viewer.

4.1.3.41 WindowStayOnTop
Indica se a janela do Viewer deve sempre se sobrepor s outras janelas. O valor
padro dessa propriedade Falso. Essa propriedade de leitura e escrita, mas
alterar seu valor em tempo de execuo no altera a configurao do Viewer j
aberto, apenas das janelas que forem abertas utilizando a configurao do Viewer.

4.1.3.42 WindowStyle
Define o estilo inicial de janela do Viewer. As opes disponveis so:
0 - Maximized: inicia o Viewer maximizado
1 - Windowed: inicia o Viewer janelado
2 - Minimized: inicia o Viewer minimizado

4.1.3.43 WindowWidth
Determina a largura da janela do Viewer, em pixels. O valor padro dessa
propriedade 400.

4.2 Quadros e Divisores


Esta seo contm informaes sobre mtodos e propriedades do objeto Divisor e
sobre as propriedades do objeto Quadro. O objeto Divisor no possui eventos
associados e o objeto Quadro no possui eventos nem mtodos associados.

4.2.1 Mtodos do Divisor


Esta seo contm informaes sobre os mtodos do objeto Divisor.

4.2.1.1 BringToFront
BringToFront()
Traz para a frente um Divisor que esteja escondido ou abaixo de outro.

104

Visualizao

4.2.1.2 CaptureScreen
CaptureScreen(Filename)
Captura o contedo de um Divisor, gravando-o no arquivo de nome e caminho
Filename, no formato BMP. Exemplo:
Sub CommandButton1_Click()
' Quando o boto clicado, copia o contedo
' do Divisor para o arquivo Frame.bmp.
Screen.Frame.CaptureScreen("c:\temp\frame.bmp")
End Sub

4.2.1.3 Close
Close(Code)
Utilize o mtodo Close para fechar a janela do Quadro. O parmetro Code ter o
valor de retorno para o mtodo DoModal, se a janela em questo tiver sido
chamada por este mtodo. Exemplo:
Sub BotaoFecha_Click()
' Quando BotaoFecha for clicado, fecha a janela.
Screen.Close(0)
End Sub

4.2.1.4 FlashWindow
FlashWindow(Number, Time)
Este mtodo faz com que cone do Viewer comece a piscar na barra de tarefas do
Windows. O parmetro Number determina o nmero de vezes que a Barra de
Tarefas deve piscar e Time determina o tempo (em milissegundos) entre um piscar e
outro. Exemplo:
Sub Texto1_Click()
Set quadro = Application.GetFrame("_top")
quadro.FlashWindow 50, 500
End Sub

4.2.1.5 MaximizeFrame
MaximizeFrame()
Maximiza um Quadro ou Tela modal.

4.2.1.6 MinimizeFrame
MinimizeFrame()
Minimiza um Quadro ou Tela modal.
Visualizao

105

4.2.1.7 MoveFrame
MoveFrame([PosX, ][PosY, ][SizeX, ][SizeY])
Move e redimensiona um Divisor (Frame) para uma coordenada e um tamanho
especficos. Os parmetros PosX e PosY informam a nova posio, em pixels, com
relao esquerda e ao topo, respectivamente. Os parmetros SizeX e SizeY
informam o novo comprimento e a nova altura, respectivamente, em pixels ou em
Himetric. Todos os parmetros so opcionais. Exemplo:
Sub Tela2_OnPreShow(vArg)
' Quando a Tela2 aberta no Divisor Teste, altera a posio
' e o tamanho do Divisor
Application.GetFrame("Teste").MoveFrame 100, 100, 200, 200
End Sub
NOTA: Os va l ores de ta ma nho nes te mtodo podem s er i nforma dos como nmeros
ou Strings. No ca s o de nmeros , s o cons i dera dos em pi xel s . No ca s o de Strings, s e
vi erem a compa nha dos da uni da de "hm", s er o i nterpreta dos como Hi metri c.
Qua l quer outro ca s o cons i dera do em pi xel s .

4.2.1.8 OpenScreen
OpenScreen(ScreenName, Arg)
O mtodo OpenScreen abre uma Tela dentro de um Divisor. O parmetro
ScreenName determina o nome da Tela a ser aberta. possvel tambm especificar o
percentual de zoom da Tela e a habilitar a barra de rolagem atravs da chave "?"
como no modelo a seguir.
<nome-da-tela>?<zoom>?<habilitar-rolagem>

Onde nome-da-tela o nome da Tela a ser aberta, zoom o percentual de zoom e


habilitar-rolagem habilita ou desabilita a rolagem de Tela. O percentual de zoom da
Tela pode assumir os seguintes valores:
1: toda a pgina
2: a largura da Tela ocupa 100% da largura do Divisor, com altura proporcional
3: a altura da Tela ocupa 100% da altura do Divisor, com largura proporcional
4: a Tela preenche totalmente o Divisor
5 a 100: equivale ao percentual de zoom da Tela propriamente dito
A habilitao de rolagem pode assumir os seguintes valores:
0: desabilita a rolagem
1: habilita a rolagem
106

Visualizao

O parmetro Arg permite repassar o valor especificado Tela atravs do evento


OnPreShow. Exemplo:
Sub Botao1_Click()
' Quando clica no botao abre a Tela2 no frame Teste
' e passa o valor 1 que ser usado no evento OnPreShow
Application.GetFrame("Teste")._
OpenScreen "Tela2?100?0", "Isso um teste."
End Sub
Sub Tela2_OnPreShow(vArg)
' A caixa de mensagem vai mostrar a
' frase "Isso um Teste."
MsgBox vArg
End Sub

4.2.1.9 Refresh
Refresh(Force)
O mtodo Refresh permite forar o redesenho do contedo de uma Tela ou Divisor.
Ele deve ser usado em scripts de Viewer com processamento massivo (por exemplo,
laos), ou em chamadas de mtodos que demandem muito tempo e exijam
indicaes visuais ao usurio do progresso do processo.
Devido ao redesenho em geral ser uma operao pesada, a verso padro do
mtodo Refresh (sem parmetros) otimizada de forma a ignorar pedidos de
redesenho muito prximos, incluindo redesenho do prprio E3. Este
comportamento padro ideal para indicaes de progresso em laos, onde
muitos redesenhos so feitos em sequncia. O parmetro Force desabilita esta
otimizao, garantindo que para cada chamada do mtodo Refresh seja feito um
redesenho. Porm, ao utilizar-se esta opo, o mtodo Refresh no pode ser
chamado repetidamente, como dentro de um lao. Exemplo:
Sub CommandButton1_Click()
' Desenha uma barra de progresso de uma operao
While i < 31
Screen.Item("Retangulo2")_
.HorizontalPercentFill = (i / 30) * 100
Frame.Refresh True
' <-- alguma operao demorada -->
Wend
End Sub

4.2.1.10 RestoreFrame
RestoreFrame()
Permite restaurar a janela do Quadro para o seu tamanho original.

Visualizao

107

4.2.1.11 SetDisableTaskSwitching
SetDisableTaskSwitching(Disable)
Habilita ou desabilita a troca de janelas. O parmetro Disable um valor Booleano
que indica se a troca de janelas ser habilitada ou no. Este mtodo atualiza a
propriedade DisableTaskSwitching do objeto Viewer.
NOTAS:
Se ma i s de uma i ns t nci a do Vi ewer es ti ver roda ndo em uma mes ma m qui na , e
pel o menos uma des ta s i ns t nci a s uti l i za r o mtodo SetDisableTaskSwitching, a
a l tera o a feta r todos os Vi ewers des ta m qui na
Ca s o s eja neces s ri o modi fi ca r o ttul o ou o es ti l o da ja nel a , o mtodo
SetFrameOptions deve s er uti l i za do a ps a cha ma da a o mtodo
SetDisableTaskSwitching

4.2.1.12 SetForegroundWnd
SetForegroundWnd()
O mtodo SetForegroundWnd ativa e move o foco para a janela do Viewer. Este
mtodo til quando se deseja chamar a ateno do operador para algum evento
ocorrido, quando a janela do Viewer encontra-se escondida ou minimizada.

4.2.1.13 SetFrameOptions
SetFrameOptions(Title, Flags)
Utilizado para configurar o ttulo do Frame na janela e o estilo da janela. O
parmetro Title uma String que contm o ttulo da janela. Este texto ser mostrado
se a propriedade Caption da Tela estiver vazia.
O parmetro Flags especifica o estilo da janela. Se este parmetro for omitido, o
valor padro ser -1. Este valor usado para manter a configurao anterior da
janela. Quando o valor especificado no for -1, pode-se modificar o estilo da
janela especificando a soma dos valores das combinaes descritas na tabela a
seguir.
Combinaes possveis para o parmetro Flags
VALOR
1
2
4
8
16
32

108

DESCRIO
Ha bi l i ta a ba rra de ttul o na ja nel a .
Ha bi l i ta o bot o Fechar na ja nel a .
Ha bi l i ta o bot o Minimizar na ja nel a .
Ha bi l i ta o bot o Maximizar na ja nel a .
Ha bi l i ta a borda na ja nel a .
Es peci fi ca que a ja nel a pode s er
di mens i ona da . Pa ra i s s o, neces s ri o
que a ja nel a tenha uma borda .

Visualizao

VALOR
64
256
512
1024
2048

DESCRIO
Es peci fi ca que a ja nel a pode s er movi da .
Es peci fi ca que a ja nel a fi ca r no topo da
Tel a .
Es peci fi ca que a ja nel a s er confi gura da
no es ti l o Ba rra de Ferra menta s .
Des a bi l i ta os botes de objeto.
Centra l i za a ja nel a .

Exemplo:
Sub Tela_OnPreShow()
Frame.SetFrameOptions("Tela de Alarmes", 114)
End Sub

No exemplo anterior, o valor 114 (2 + 16 + 32 + 64) indica que a janela ter o boto
Fechar habilitado (2), ter uma borda (16), poder ser dimensionada (32) e poder
ser movida (64). O ttulo da janela ser "Tela de Alarmes".
Nos Picks Abrir Tela e Abrir Tela Modal tambm possvel configurar o estilo da
janela durante a edio, atravs da caixa de dilogo Estilo da Janela. Para mais
informaes veja o tpico Picks.
NOTA: o mtodo SetFrameOptions deve s er us a do a ps a cha ma da a o mtodo
SetDisableTaskSwitching, ca s o s eja neces s ri o modi fi ca r o ttul o ou o es ti l o da
ja nel a .

4.2.2 Propriedades do Divisor


Esta seo contm informaes sobre as propriedades do objeto Divisor.

4.2.2.1 IsHTML
A propriedade IsHTML retorna True se o divisor contm cdigos HTML inseridos
no Quadro. Caso contrrio, retorna False.

4.2.2.2 SplitBorder
Habilita ou desabilita a borda do Divisor, e determina se a borda entre o Divisor
mandante e o Divisor restante deve ser exibida em tempo de execuo. Esta
propriedade no tem efeito no Divisor restante. O valor padro desta propriedade
True.

Visualizao

109

4.2.2.3 SplitDockPosition
Indica a posio do Divisor desejado na Tela. As opes disponveis so:
Opes disponveis para SplitDockPosition
OPO
0 - dockRemaining

1 - dockTop
2 - dockBottom
3 - dockLeft
4 - dockRight

DESCRIO
Pos i ci ona o Di vi s or como res ta nte, ou
s eja , el e ocupa r o es pa o que s obra na
di vi s o hori zonta l ou verti ca l .
Pos i ci ona o Di vi s or como ma nda nte,
a ci ma do res ta nte.
Pos i ci ona o Di vi s or como ma nda nte,
a ba i xo do res ta nte.
Pos i ci ona o Di vi s or como ma nda nte,
es querda do res ta nte.
Pos i ci ona o Di vi s or como ma nda nte,
di rei ta do res ta nte.

4.2.2.4 SplitLink
A propriedade SplitLink contm um link que deve ser mostrado no Divisor.
possvel especificar uma Tela do projeto, um executvel ou um link na Internet. No
caso de Telas, possvel especificar um percentual de zoom e a habilitao das
barras de rolagem usando a chave "?", como no modelo <nome-da-tela>?
<zoom>?<barra-de-rolagem>, onde nome-da-tela o nome da Tela a ser aberta;
zoom o percentual de zoom e barra-de-rolagem 1 para habilitar ou 0 para
desabilitar. Os parmetros zoom e barra-de-rolagem so vlidos apenas se o link
indicado se tratar de uma Tela. Caso contrrio, sero ignorados. Se o parmetro
zoom no for informado, assumido 100%. Se o parmetro barra-de-rolagem no
for informado, assumido 1, ou seja, habilitado. Exemplo:
Sub CommandButton1_Click()
Application.GetFrame("Divisor1").SplitLink = "Tela1?10?1"
End Sub

4.2.2.5 SplitResizable
Determina se o Divisor mandante pode ser redimensionado em tempo de
execuo. Esta propriedade no tem efeito no Divisor restante. O valor padro
desta propriedade True.

4.2.2.6 SplitValue
A propriedade SplitValue determina o valor que ser atribudo ao Divisor do
Quadro, que tanto pode ser % (percentagem), hm (HIMETRIC) ou px (pixels). Se a
unidade for omitida, o valor ser considerado em Himetric.

110

Visualizao

4.2.3 Propriedades do Quadro


Esta seo contm informaes sobre as propriedades do objeto Quadro.

4.2.3.1 Caption
A propriedade Caption define o ttulo da Quadro a ser mostrado na barra de ttulo
no Viewer.

4.3 Telas e Objetos de Tela


Esta seo contm informaes sobre eventos, mtodos e propriedades de Telas e
Objetos de Tela.

4.3.1 Tela
Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Tela.

4.3.1.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Tela.

4.3.1.1.1 Click
Click()
Ocorre quando o boto esquerdo do mouse pressionado sobre a Tela. Este evento
no ocorrer se a Tela no estiver visvel ou sua propriedade Enabled estiver
configurada para False. A visibilidade da Tela depende de trs fatores: propriedade
Visible igual a True; objeto pai visvel; e propriedade Layer do objeto presente na
camada da Tela.

4.3.1.1.2 DbClick
DbClick()
Ocorre quando h um duplo-clique, ou seja, o boto esquerdo do mouse
pressionado rapidamente duas vezes sobre a Tela. Este evento no ocorrer se o
objeto no estiver visvel ou sua propriedade Enabled estiver configurada para
False. A visibilidade do objeto depende de trs fatores: propriedade Visible igual a
True; objeto pai visvel; e propriedade Layer do objeto presente na camada da Tela.

Visualizao

111

4.3.1.1.3 KeyDown
KeyDown(KeyCode, Shift)
Ocorre no momento em que uma tecla pressionada, independentemente do foco
na Tela.
Variveis do evento KeyDown
NOME
KeyCode
Shift

DESCRIO
Nmero i ntei ro que i denti fi ca o ca ra ctere
ASCII da tecl a que foi pres s i ona da .
Mos tra a tecl a pres s i ona da junta mente
com o mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT

Exemplo:
Sub Tela1_KeyDown(KeyCode, Shift)
' Mostra uma caixa de mensagem quando
' o usurio pressiona uma tecla
MsgBox "Cdigo da tecla: " & KeyCode
End Sub

4.3.1.1.4 KeyUp
KeyUp(KeyCode, Shift)
Ocorre no momento em que uma tecla solta, independentemente do foco na Tela.
Variveis do evento KeyUp
NOME
KeyCode
Shift

DESCRIO
Nmero i ntei ro que i denti fi ca o ca ra ctere
ASCII da tecl a que foi pres s i ona da .
Mos tra a tecl a pres s i ona da junta mente
com o mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT

Exemplo:
Sub Tela1_KeyUp(KeyCode, Shift)
' Mostra uma caixa de mensagem quando o usurio
' soltar uma tecla
MsgBox "Cdigo da tecla: " & KeyCode
End Sub

112

Visualizao

4.3.1.1.5 MouseDown
MouseDown(Button, ShiftState, MouseX, MouseY)
Ocorre quando se pressiona qualquer boto do mouse sobre a Tela. Utilize o
evento MouseDown para determinar aes especficas quando a Tela for clicada
pelo usurio.
Variveis do evento MouseDown
NOME
Button

ShiftState

MouseX
MouseY

DESCRIO
Mos tra o bot o do mous e pres s i ona do:
1: O bot o do mous e pres s i ona do o
es querdo
2: O bot o do mous e pres s i ona do o
di rei to
Mos tra a tecl a pres s i ona da junta mente
com o mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
Mos tra a coordena da X onde o mous e foi
cl i ca do na Tel a .
Mos tra a coordena da Y onde o mous e foi
cl i ca do na Tel a .

Exemplo:
Sub TelaInicial_MouseDown(Button, ShiftState, MouseX, MouseY)
' Encerra a aplicao quando houver um clique de mouse
' no objeto TelaInicial.
Application.Exit()
End Sub

4.3.1.1.6 MouseUp
MouseUp(Button, ShiftState, MouseX, MouseY)
Ocorre quando se solta qualquer boto do mouse previamente clicado. Utilize o
evento MouseUp para especificar aes que sero disparadas somente quando o
boto do mouse for solto.
Variveis do evento MouseUp
NOME
Button

Visualizao

DESCRIO
Mos tra o bot o do mous e pres s i ona do:
1: O bot o do mous e pres s i ona do o
es querdo
2: O bot o do mous e pres s i ona do o
di rei to

113

NOME
ShiftState

MouseX
MouseY

DESCRIO
Mos tra a tecl a pres s i ona da junta mente
com o mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
Mos tra a coordena da X onde o mous e foi
cl i ca do na Tel a .
Mos tra a coordena da Y onde o mous e foi
cl i ca do na Tel a .

Exemplo:
Sub TelaInicial_MouseUp(Button, ShiftState, MouseX, MouseY)
' Encerra a aplicao apenas quando o usurio soltar o boto.
Application.Exit()
End Sub

4.3.1.1.7 OnHide
OnHide()
Ocorre quando uma Tela est prestes a ser fechada. Utilize o evento OnHide quando
for necessrio efetuar alguma operao antes do objeto Tela ser fechado. Este
evento pode ocorrer de diversas maneiras:
Quando a Tela for substituda por outra atravs do mtodo OpenScreen
Quando o usurio fechar a janela onde est a Tela
Quando for chamado o mtodo Close do objeto Tela
Quando o Viewer for fechado ou encerrado

4.3.1.1.8 OnPreShow
OnPreShow(Arg)
Ocorre antes da Tela ser mostrada. A varivel de evento Arg recebe o contedo do
parmetro Arg do mtodo OpenScreen, que gera esse evento. Logo aps, gerado o
evento OnShow. Exemplo:
Sub Screen1_OnPreShow(Arg)
' O ttulo da Tela Screen1 a ser mostrada
' foi passado como parmetro na chamada do mtodo
' OpenScreen que gerou o evento.
Caption = Arg
End Sub

114

Visualizao

4.3.1.1.9 OnShow
OnShow()
Ocorre no momento exato que uma Tela mostrada. Utilize o evento OnPreShow
para efetuar alguma operao antes que a Tela seja exibida. Exemplo:
Sub TelaPrincipal_OnShow()
MsgBox "Seja bem-vindo ao sistema!"
End Sub

4.3.1.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Tela.

4.3.1.2.1 Close
Close(Code)
Utilize o mtodo Close para fechar a Tela. Este mtodo gera o evento OnHide antes
de ser efetivamente executado. O parmetro Code ter o valor de retorno para o
mtodo DoModal, se a Tela em questo tiver sido chamada por este mtodo.
Exemplo:
Sub BotaoFecha_Click()
' Quando BotaoFecha for clicado, fecha a janela
Screen.Close(0)
End Sub

4.3.1.2.2 FromPixelX
FromPixelX(XPixel)
Converte a coordenada X da Tela, indicada pelo parmetro XPixel, de pixels para
Himetric. Este mtodo complementar ao mtodo ToPixelX.

4.3.1.2.3 FromPixelY
FromPixelY(YPixel)
Converte a coordenada Y da Tela, indicada pelo parmetro YPixel, de pixels para
Himetric. Este mtodo complementar ao mtodo ToPixelY.

4.3.1.2.4 ToPixelX
ToPixelX(XHimetric)
Converte a coordenada X da Tela, indicada pelo parmetro XHimetric, de Himetric
para pixels. Este mtodo complementar ao mtodo FromPixelX.

Visualizao

115

4.3.1.2.5 ToPixelY
ToPixelY(YHimetric)
Converte a coordenada Y da Tela, indicada pelo parmetro YHimetric, de Himetric
para pixels. Este mtodo complementar ao mtodo FromPixelY.

4.3.1.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Tela.
NOTA: O E3 uti l i za pa ra defi ni o de coordena da s e es pes s ura o s i s tema Hi metri c.
Nes te s i s tema , ca da uni da de l gi ca equi va l e a um mi l s i mo de centmetro; ou s eja ,
ca da 1000 uni da des equi va l em a 1 centmetro. As s i m, es te o pa dr o a dota do na
des cri o da s propri eda des do E3, qua ndo a pl i c vel .

4.3.1.3.1 BackgroundColor
Especifica a cor de preenchimento do fundo da Tela. Nos scripts, utilize a funo
do VBScript RGB para montar a cor a ser associada a esta propriedade. O valor
padro desta propriedade cinza (RGB(192, 192, 192)).

4.3.1.3.2 Caption
A propriedade Caption define o ttulo da Tela a ser mostrado na barra de ttulo no
Viewer.

4.3.1.3.3 FillStyle
Esta propriedade especifica o estilo do preenchimento da Tela e dos objetos de
Tela. A tabela a seguir contm os valores vlidos para a propriedade FillStyle.
Opes disponveis para a propriedade FillStyle
OPO
0 - Solid
1 - Hollow
2 - Horizontal
3 - Vertical
4 - Downward
5 - Upward

116

DESCRIO
O preenchi mento s er s l i do (pa dr o).
N o h preenchi mento. Es te va l or n o
es t di s ponvel pa ra o objeto Tel a .
O preenchi mento s er com l i s tra s
hori zonta i s .
O preenchi mento s er com l i s tra s
verti ca i s .
O preenchi mento s er com l i s tra s
des cendo da es querda pa ra a di rei ta em
ngul o de 45 gra us .
O preenchi mento s er com l i s tra s
s ubi ndo da es querda pa ra a di rei ta em
ngul o de 45 gra us .

Visualizao

OPO
6 - Cross
7 - DiagonalCross
8 - Gradient

9 - SemiTransparent
10 - MouseArea

11 - Background
12 - Picture

DESCRIO
O preenchi mento s er com l i s tra s
hori zonta i s e verti ca i s .
O preenchi mento s er com l i s tra s
des cendo e s ubi ndo da es querda pa ra a
di rei ta em ngul o de 45 gra us .
O preenchi mento s er em degra d
uti l i za ndo ta nto ForegroundColor qua nto
BackgroundColor. O efei to s er defi ni do
pel a propri eda de GradientStyle.
Dei xa o objeto tra ns l ci do. Es te va l or
n o es t di s ponvel pa ra o objeto Tel a .
O preenchi mento s er va zi o, ma s o
objeto conti nua s ens vel a os eventos
(pa dr o). Es te va l or n o es t di s ponvel
pa ra o objeto Tel a .
Preenche o objeto com a cor de fundo.
Preenche o objeto com a fi gura
s el eci ona da na propri eda de PictureFile.
Es te va l or s es t di s ponvel pa ra o
objeto Tel a .

NOTA: A propri eda de FillStyle n o es t di s ponvel pa ra o objeto Figura.

4.3.1.3.4 ForegroundColor
Especifica a cor do preenchimento da frente da Tela. Nos scripts, utilize a funo
RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor
padro para esta propriedade preto (RGB(0, 0, 0)). Aplicaes anteriores
introduo desta propriedade tero ambas as propriedades ForegroundColor e
BackgroundColor configuradas com a cor antes armazenada na propriedade
BackgroundColor, e o estilo de preenchimento configurado como 11 - Background,
que pinta toda a Tela com a cor de fundo (comportamento antigo, anterior
criao dos estilos). Exemplo:
Sub Tela1_Click()
' Troca a cor de fundo da Tela para azul
ForegroundColor = RGB(0, 0, 255)
End Sub

4.3.1.3.5 GradientStyle
Esta propriedade especifica o estilo de preenchimento degrad da Tela. Esta
propriedade s ser utilizada quando o valor da propriedade FillStyle estiver
configurada para 8 (Gradient). Os degrads consideram a mudana da cor partindo
de ForegroundColor e indo para BackgroundColor.

Visualizao

117

Opes disponveis para GradientStyle


OPO
0 - LeftToRight
1 - RightToLeft
2 - VerFromCenter
3 - VerToCenter
4 - BottonUp
5 - TopDown
6 - HorzFromCenter
7 - HorzToCenter
8 - DiagUpRight
9 - DiagUpLeft
10 - DiagUpFromCenter
11 - DiagUpToCenter
12 - DiagDownLeft
13 - DiagDownRight
14 - DiagDownFromCenter
15 - DiagDownToCenter
16 - SpotSouthEast
17 - SpotSouthWest
18 - SpotNorthWest
19 - SpotNorthEast
20 - SpotFromCenter
21 - SpotToCenter

DESCRIO
Degra d verti ca l da es querda pa ra a
di rei ta .
Degra d verti ca l da di rei ta pa ra a
es querda .
Degra d verti ca l do centro pa ra a s
borda s .
Degra d verti ca l da s borda s pa ra o
centro.
Degra d hori zonta l de ba i xo pa ra ci ma .
Degra d hori zonta l de ci ma pa ra ba i xo.
Degra d do centro pa ra a s borda s .
Degra d da s borda s pa ra o centro.
Degra d di a gona l pa ra ci ma com a cor de
frente na di rei ta (pa dr o).
Degra d di a gona l pa ra ci ma com a cor de
frente na es querda .
Degra d di a gona l pa ra ci ma do centro
pa ra a s borda s .
Degra d di a gona l pa ra ci ma da s borda s
pa ra o centro.
Degra d di a gona l pa ra ba i xo com cor de
frente na es querda .
Degra d di a gona l pa ra ba i xo com cor de
frente na di rei ta .
Degra d di a gona l pa ra ba i xo do centro
pa ra a s borda s .
Degra d di a gona l pa ra ba i xo da s borda s
pa ra o centro.
Degra d com cor de frente pa rti ndo do
ca nto i nferi or di rei to.
Degra d com cor de frente pa rti ndo do
ca nto i nferi or es querdo.
Degra d com cor de frente pa rti ndo do
ca nto s uperi or es querdo.
Degra d com cor de frente pa rti ndo do
ca nto s uperi or di rei to.
Degra d com cor de fundo do centro pa ra
a s borda s .
Degra d com cor de fundo da s borda s
pa ra o centro.

4.3.1.3.6 Layer
Esta propriedade define em quais camadas o objeto deve aparecer. O valor
representa uma mscara de 32 bits, um bit para cada camada. Portanto, podem ser
118

Visualizao

definidas at 32 camadas individuais. Assim, objetos podem ser agrupados


logicamente e mostrados ou escondidos apenas com a modificao da mscara da
propriedade Layer.

Opes disponveis na Lista de Propriedades


NOTA: A vi s i bi l i da de do objeto depende de trs fa tores : a propri eda de Visible tem
que es ta r confi gura da pa ra True; o objeto que pa i des te objeto tem que es ta r
vi s vel ; a propri eda de Layer des te objeto tem que es ta r ha bi l i ta da pa ra a Tel a .

4.3.1.3.7 PictureFile
Contm o nome do arquivo da figura que ser utilizada como fundo na Tela.
Pode ser qualquer formato j suportado no E3 pelo objeto DrawPicture (*.bmp,
*.gif, *.jpg, *.cur, *.ico, *.emf, *.wmf). O valor padro desta propriedade uma
String em branco. Esta propriedade s ser vlida se a propriedade FillStyle estiver
selecionada como 12 - Picture.

4.3.1.3.8 PicturePosition
Indica a posio da figura selecionada na propriedade PictureFile na Tela. Esta
propriedade s ser vlida se a propriedade FillStyle estiver selecionada como 12 Picture. As opes vlidas so:

Visualizao

119

Opes disponveis para PicturePosition


OPO
0 - Center
1 - Tile
2 - Stretch
3 - TopLeft
4 - BottomLeft
5 - BottomRight
6 - TopRight

DESCRIO
Fi gura no ta ma nho ori gi na l , centra l i za da
na Tel a .
Fi gura no ta ma nho ori gi na l , repeti da
ta nta s vezes qua nta s forem neces s ri a s
pa ra preencher a Tel a .
Fi gura redi mens i ona da pa ra preencher a
Tel a .
Fi gura no ta ma nho ori gi na l , no ca nto
es querdo s uperi or da Tel a .
Fi gura no ta ma nho ori gi na l , no ca nto
es querdo i nferi or da Tel a .
Fi gura no ta ma nho ori gi na l , no ca nto
di rei to i nferi or da Tel a .
Fi gura no ta ma nho ori gi na l , no ca nto
di rei to s uperi or da Tel a .

4.3.1.3.9 RenderQuality
Controla a qualidade de desenho de uma Tela. Os valores possveis para esta
propriedade so os seguintes:
0 - rqDefault: A qualidade de desenho da Tela utiliza o valor definido na
propriedade RenderQuality do Viewer. Este o valor padro desta propriedade,
mesmo em aplicaes criadas em verses anteriores 4.0
1 - rqNormal: Fora o modo de qualidade normal (GDI) para o desenho da Tela
2 - rqHighQuality: Fora o modo de alta qualidade (GDI+) para o desenho da Tela
A figura a seguir mostra o menu contextual de uma Tela em tempo de execuo, com
as respectivas opes de configurao desta propriedade:

120

Visualizao

Menu contextual da Tela em tempo de execuo

4.3.2 Objetos de Tela


Esta seo contm informaes sobre eventos, mtodos e propriedades dos Objetos
de Tela.

4.3.2.1 Eventos Comuns


Esta seo contm informaes sobre os eventos comuns a todos os Objetos de
Tela.

Visualizao

121

4.3.2.1.1 Click
Click()
Ocorre quando o boto esquerdo do mouse pressionado sobre o objeto. Este
evento no ocorrer se o objeto no estiver visvel ou se sua propriedade Enabled
estiver configurada para False. A visibilidade do objeto depende de trs fatores:
propriedade Visible igual a True; objeto pai visvel; e propriedade Layer do objeto
presente na camada da Tela.

4.3.2.1.2 DbClick
DbClick()
Ocorre quando h um duplo-clique, ou seja, o boto esquerdo do mouse
pressionado rapidamente duas vezes sobre o objeto. Este evento no ocorrer se o
objeto no estiver visvel ou se sua propriedade Enabled estiver configurada para
False. A visibilidade do objeto depende de trs fatores: propriedade Visible igual a
True; objeto pai visvel; e propriedade Layer do objeto presente na camada da Tela.

4.3.2.1.3 KeyDown
KeyDown(KeyCode, Shift)
Ocorre no momento em que uma tecla pressionada e o objeto est com o foco do
teclado. Note que este evento no ser gerado se o objeto no estiver habilitado
(propriedade Enabled igual a False) ou este objeto no possuir o foco do teclado.
Variveis do evento KeyDown
NOME
KeyCode
Shift

DESCRIO
Nmero i ntei ro que i denti fi ca o ca ra ctere
ASCII da tecl a que foi pres s i ona da .
Mos tra a tecl a pres s i ona da junta mente
com o mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT

4.3.2.1.4 KeyUp
KeyUp(KeyCode, Shift)
Ocorre no momento em que uma tecla solta e o objeto est com o foco do teclado.
Note que este evento no ser gerado se o objeto no estiver habilitado
(propriedade Enabled igual a False) ou este objeto no possuir o foco do teclado.

122

Visualizao

Variveis do evento KeyUp


NOME
KeyCode
Shift

DESCRIO
Nmero i ntei ro que i denti fi ca o ca ra ctere
ASCII da tecl a que foi pres s i ona da .
Mos tra a tecl a pres s i ona da junta mente
com o mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT

4.3.2.1.5 MouseDown
MouseDown(Button, ShiftState, MouseX, MouseY)
Ocorre quando se pressiona qualquer boto do mouse sobre o objeto.
Variveis de evento MouseDown
NOME
Button

ShiftState

MouseX
MouseY

DESCRIO
Mos tra o bot o do mous e pres s i ona do:
1: O bot o do mous e pres s i ona do o
es querdo
2: O bot o do mous e pres s i ona do o
di rei to
Mos tra a tecl a pres s i ona da junta mente
com o mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
Mos tra a coordena da X onde o mous e foi
cl i ca do na Tel a .
Mos tra a coordena da Y onde o mous e foi
cl i ca do na Tel a .

4.3.2.1.6 MouseUp
MouseUp(Button, ShiftState, MouseX, MouseY)
Ocorre quando se solta qualquer boto do mouse previamente clicado sobre o
objeto. Utilize o evento MouseUp para especificar aes que sero disparadas
somente quando o boto do mouse for solto.

Visualizao

123

Variveis do evento MouseUp


NOME
Button

ShiftState

MouseX
MouseY

DESCRIO
Mos tra o bot o do mous e pres s i ona do:
1: O bot o do mous e pres s i ona do o
es querdo
2: O bot o do mous e pres s i ona do o
di rei to
Mos tra a tecl a pres s i ona da junta mente
com o mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
Mos tra a coordena da X onde o mous e foi
cl i ca do na Tel a .
Mos tra a coordena da Y onde o mous e foi
cl i ca do na Tel a .

4.3.2.2 Mtodos Comuns


Esta seo contm informaes sobre os mtodos comuns a todos os Objetos de
Tela.

4.3.2.2.1 BringToFront
BringToFront()
Faz com que o objeto se posicione frente de todos os outros objetos da Tela.

4.3.2.2.2 SendToBack
SendToBack()
Faz com que o objeto se posicione atrs de todos os outros objetos da Tela.

4.3.2.2.3 SetFocus
SetFocus()
Utilize o mtodo SetFocus para mover o foco do mouse ou do teclado para um
objeto determinado.

4.3.2.3 Propriedades Comuns


Neste tpicos so listadas as propriedades comuns a todos os objetos de Tela. As
propriedades explicadas a seguir no se aplicam nos seguintes objetos: MSForms,
E3Chart, E3Browser e E3Alarm. Estes so citados posteriormente, em captulos
especficos para estes objetos.
124

Visualizao

NOTA 1: O E3 uti l i za pa ra defi ni o de coordena da s e es pes s ura o s i s tema Hi metri c.


Nes te s i s tema , ca da uni da de l gi ca equi va l e a um mi l s i mo de centmetro; ou s eja ,
ca da 1000 uni da des equi va l em a 1 centmetro. As s i m, es te o pa dr o a dota do na
des cri o da s propri eda des do E3, qua ndo a pl i c vel .
NOTA 2: As propri eda des l i s ta da s a s egui r s o comuns a todos os objetos ci ta dos
a ci ma , i ncl us i ve o Grupo de objetos e movi mentos de Rota o e Tra ns l a o.

4.3.2.3.1 Angle
A propriedade Angle define o ngulo de rotao em graus, no sentido antihorrio, que o objeto deve ser rotacionado. Isto tambm se aplica aos filhos que
este objeto tiver, respeitando as limitaes de rotao de cada objeto filho. O
objeto rotacionar de acordo com o seu centro, que pode ser editado durante a
operao de rotao. O valor padro desta propriedade 0 (sem rotao).

4.3.2.3.2 BackgroundColor
Esta propriedade especifica a cor de preenchimento do fundo do objeto. Esta cor
utilizada quando a propriedade BackgroundStyle est configurada para 1 (opaco)
e umas das propriedades VerticalPercentFill ou HorizontalPercentFill est com
valores diferentes de 100. Outro uso desta cor quando a propriedade FillStyle est
configurada entre os valores 2 e 8. Isto faz com que a rea restante utilize a cor de
fundo para preenchimento. Nos scripts, utilize a funo RGB do VBScript para
montar a cor a ser associada a esta propriedade. O valor padro desta
propriedade cinza (RGB(192, 192, 192)).

4.3.2.3.3 BackgroundStyle
Esta propriedade especifica o modo do preenchimento do fundo do objeto. Esta
propriedade habilita a utilizao das propriedades VerticalPercentFill e
HorizontalPercentFill com valores diferentes de 100 e tambm da propriedade
FillStyle configurada entre os valores 2 e 8. Isto faz com que a rea restante utilize a
cor de fundo configurada em BackgroundColor para preenchimento. A tabela a
seguir contm os valores vlidos para a propriedade BackgroundStyle.
Opes disponveis para BackgroundStyle
OPO
0 - Transparente
1 - Opaco

Visualizao

DESCRIO
Nenhum fundo des te objeto s er
des enha do.
Ca s o vi s vel , o fundo s er des enha do.

125

4.3.2.3.4 BorderColor
Especifica a cor da borda ou a cor da linha deste objeto. Esta propriedade s
utilizada quando a propriedade BorderStyle no est configurada para o valor 5
(null), onde o objeto fica sem borda. Nos scripts, utilize a funo RGB do VBScript
para montar a cor a ser associada a esta propriedade. O valor padro desta
propriedade branco (RGB(255, 255, 255)), exceto para os objetos Display e
SetPoint, cujo valor padro da propriedade cinza escuro (RGB(128,128,128)).

4.3.2.3.5 BorderStyle
A propriedade BorderStyle determina o estilo de borda que ser aplicada ao
objeto.
Opes disponveis para BorderStyle
OPO
0 - Normal
1 - Dash
2 - Dot
3 - Dashdot
4 - Dashdotdot
5 - Null

DESCRIO
Apl i ca uma borda s l i da no objeto
(pa dr o).
Apl i ca uma borda com l i nha tra ceja da no
objeto.
Apl i ca uma borda ponti l ha da no objeto.
Apl i ca uma borda com tra o-ponto no
objeto.
Apl i ca uma borda com tra o-ponto-ponto
no objeto.
O objeto n o ter borda .

4.3.2.3.6 BorderWidth
Define a espessura, em unidades Himetric, da linha ou da borda do objeto. S
utilizada se a propriedade BorderStyle no estiver configurada para o valor 5
(null). O valor padro desta propriedade 0 (zero). Esta uma exceo no sistema
de medidas do E3, pois quando seu valor zero, a espessura da linha ou da borda
no definida em unidades Himetric, mas sim em pixels. A propriedade
BorderWidth com valor igual a zero indica a espessura de um pixel.

4.3.2.3.7 Effect3D
Determina a aplicao de um efeito 3D no objeto selecionado. As opes
disponveis para esta propriedade so descritas na tabela a seguir.
Opes disponveis para Effect3D
OPO
0 - No3D
1 - Raised
2 - Sunken

126

DESCRIO
Tra ns pa rente (pa dr o).
Apl i ca um efei to 3D em a l to rel evo.
Apl i ca um efei to 3D em ba i xo rel evo.

Visualizao

4.3.2.3.8 Effect3D_X
Especifica a dimenso do efeito 3D no eixo horizontal do objeto (eixo X). O valor
padro desta propriedade 30.

4.3.2.3.9 Effect3D_Y
Especifica a dimenso do efeito 3D no eixo vertical do objeto (eixo Y). O valor
padro desta propriedade 30.

4.3.2.3.10 Effect3DColorBase
Determina a cor da base do efeito 3D no objeto. O valor padro desta
propriedade preto (RGB(0, 0, 0)).

4.3.2.3.11 Effect3DColorTop
Determina a cor do topo do efeito 3D no objeto. O valor padro desta
propriedade branco (RGB(255, 255, 255)).

4.3.2.3.12 Enabled
Habilita ou desabilita o objeto, isto , o foco e a resposta aos eventos gerados
pelo usurio. Se a propriedade estiver configurada para True, o objeto pode receber
o foco, responder a eventos gerados pelo usurio e estar acessvel atravs de
scripts (padro). Caso contrrio, o usurio no poder interagir com o objeto
usando o mouse, pressionando teclas ou teclas de atalho e o objeto aparece
esmaecido. Alm disso, se o objeto exibir um bitmap, o bitmap fica esmaecido
sempre que este objeto estiver desabilitado.
As propriedades Enabled e Locked (presente nos objetos Caixa de Seleo, Boto de
Opo, Lista de Seleo, Boto de Comando, Lista, Boto Liga-Desliga e Editor de
Texto) so interligadas. Quando as propriedades Enabled e Locked estiverem
ambas configuradas em True, o objeto pode receber foco e aparecer normalmente
na Tela, e os dados podem ser copiados, mas no editados. Quando Enabled for
True, mas Locked for False, os dados podem ser no s copiados, mas tambm
editados. No entanto, quando Enabled for False, o objeto no recebe foco e fica
esmaecido na Tela, independentemente do status de Locked. Alm disso, os dados
no podem ser copiados nem tampouco editados.
possvel combinar as configuraes das propriedades Enabled e TabStop para
impedir que o usurio selecione um boto de comando com a tecla TAB, embora
ainda seja permitido ao usurio clicar no boto. Definir a propriedade TabStop
como False significa que o Boto de Comando no aparecer na ordem de
tabulao. Entretanto, se Enabled for True, o usurio ainda poder clicar no Boto
de Comando, desde que a propriedade TakeFocusOnClick esteja definida como True.
Visualizao

127

4.3.2.3.13 FillStyle
Esta propriedade especifica o estilo do preenchimento do objeto. A tabela a
seguir contm os valores vlidos para a propriedade FillStyle.
Opes disponveis para FillStyle
OPO
0 - Solid
1 - Hollow
2 - Horizontal
3 - Vertical
4 - Downward
5 - Upward
6 - Cross
7 - DiagonalCross
8 - Gradient

9 - SemiTransparent
10 - MouseArea

DESCRIO
O preenchi mento s er s l i do (pa dr o).
N o ha ver preenchi mento.
O preenchi mento s er com l i s tra s
hori zonta i s .
O preenchi mento s er com l i s tra s
verti ca i s .
O preenchi mento s er com l i s tra s
des cendo da es querda pa ra a di rei ta em
ngul o de 45 gra us .
O preenchi mento s er com l i s tra s
s ubi ndo da es querda pa ra a di rei ta em
ngul o de 45 gra us .
O preenchi mento s er com l i s tra s
hori zonta i s e verti ca i s .
O preenchi mento s er com l i s tra s
des cendo e s ubi ndo da es querda pa ra a
di rei ta em ngul o de 45 gra us .
O preenchi mento s er em degra d
uti l i za ndo ta nto o va l or da propri eda de
ForegroundColor qua nto o va l or da
propri eda de BackgroundColor. O efei to
s er defi ni do pel a propri eda de
GradientStyle.
Dei xa o objeto tra ns l ci do.
N o ha ver preenchi mento, ma s o objeto
conti nua s ens vel a os eventos .

4.3.2.3.14 ForegroundColor
Esta propriedade especifica a cor do preenchimento da frente do objeto. Esta cor
utilizada quando a propriedade FillStyle est configurada para 0 (slido) ou entre
2 e 9. Nos scripts, utilize a funo RGB do VBScript para montar a cor a ser
associada a esta propriedade. O valor padro para esta propriedade azul (RGB(0,
0, 255)), exceto para os objetos Display e SetPoint, cujo valor padro para esta
propriedade branco (RGB(255, 255, 255)).

4.3.2.3.15 Frame
Retorna o Quadro pai do objeto. Esta propriedade acessvel apenas em tempo
de execuo.
128

Visualizao

4.3.2.3.16 GradientStyle
Esta propriedade especifica o estilo de preenchimento degrad do objeto. Esta
propriedade s ser utilizada quando a valor da propriedade FillStyle estiver
configurada para 8 (Gradient). Os degrads consideram a mudana partindo da cor
configurada na propriedade ForegroundColor e indo para a cor configurada na
propriedade BackgroundColor.
Opes disponveis para GradientStyle
OPO
0 - LeftToRight
1 - RightToLeft
2 - VerFromCenter
3 - VerToCenter
4 - BottomUp
5 - TopDown
6 - HorzFromCenter
7 - HorzToCenter
8 - DiagUpRight
9 - DiagUpLeft
10 - DiagUpFromCenter
11 - DiagUpToCenter
12 - DiagDownLeft
13 - DiagDownRight
14 - DiagDownFromCenter
15 - DiagDownToCenter
16 - SpotSouthEast
17 - SpotSouthWest
18 - SpotNorthWest
19 - SpotNorthEast
20 - SpotFromCenter

Visualizao

DESCRIO
Degra d verti ca l da es querda pa ra a
di rei ta .
Degra d verti ca l da di rei ta pa ra a
es querda .
Degra d verti ca l do centro pa ra a s
borda s .
Degra d verti ca l da s borda s pa ra o
centro.
Degra d hori zonta l de ba i xo pa ra ci ma .
Degra d hori zonta l de ci ma pa ra ba i xo.
Degra d do centro pa ra a s borda s .
Degra d da s borda s pa ra o centro.
Degra d di a gona l pa ra ci ma com a cor de
frente na di rei ta (pa dr o).
Degra d di a gona l pa ra ci ma com a cor de
frente na es querda .
Degra d di a gona l pa ra ci ma do centro
pa ra a s borda s .
Degra d di a gona l pa ra ci ma da s borda s
pa ra o centro.
Degra d di a gona l pa ra ba i xo com a cor
de frente na es querda .
Degra d di a gona l pa ra ba i xo com a cor
de frente na di rei ta .
Degra d di a gona l pa ra ba i xo do centro
pa ra a s borda s .
Degra d di a gona l pa ra ba i xo da s borda s
pa ra o centro.
Degra d com a cor de frente pa rti ndo do
ca nto i nferi or di rei to.
Degra d com a cor de frente pa rti ndo do
ca nto i nferi or es querdo.
Degra d com a cor de frente pa rti ndo do
ca nto s uperi or es querdo.
Degra d com a cor de frente pa rti ndo do
ca nto s uperi or di rei to.
Degra d com a cor de fundo do centro
pa ra a s borda s .

129

OPO
21 - SpotToCenter

DESCRIO
Degra d com a cor de fundo da s borda s
pa ra o centro.

IMPORTANTE: Um gra nde nmero de objetos s endo mos tra dos com degra d,
s i mul ta nea mente, a ca rreta m uma perda de performa nce na a tua l i za o da Tel a . O
us o de fi gura s no l uga r pode res ol ver o probl ema .

4.3.2.3.17 HasFocus
Esta propriedade determina que o objeto selecionado est com o foco. Esta
propriedade acessvel apenas em tempo de execuo.

4.3.2.3.18 Height
Determina a altura do objeto.

4.3.2.3.19 HorizontalFillStyle
Define como ser o preenchimento horizontal do objeto. Esta propriedade
trabalha em conjunto com a propriedade HorizontalPercentFill, que informa qual
porcentagem do objeto dever ser preenchida. Estas duas propriedades permitem
uma simulao de um preenchimento de nvel em um objeto, como ocorre em um
nvel de um tanque, por exemplo.
Opes disponveis para HorizontalFillStyle
OPO
0 - FillLeftToRight
1 - FillRightToLeft
2 - FillCenterToEdgesH

DESCRIO
A porcenta gem de preenchi mento s er
da es querda pa ra a di rei ta (pa dr o).
A porcenta gem de preenchi mento s er
da di rei ta pa ra a es querda .
A porcenta gem de preenchi mento s er
do centro pa ra a s borda s .

4.3.2.3.20 HorizontalPercentFill
Utilize a propriedade HorizontalPercentFill para especificar qual a porcentagem
da rea horizontal do objeto dever ser preenchida. Os valores aceitos por esta
propriedade variam de 0 a 100. Esta propriedade trabalha em conjunto com a
propriedade HorizontalFillStyle, que informa como este preenchimento ocorrer. O
valor padro desta propriedade 100.

4.3.2.3.21 Layer
Esta propriedade define em quais camadas o objeto deve aparecer. O valor
representa uma mscara de 32 bits, um bit para cada camada. Portanto, podem ser
130

Visualizao

definidas at 32 camadas individuais. Assim, objetos podem ser agrupados


logicamente e mostrados ou escondidos apenas com a modificao da mscara da
propriedade Layer.

4.3.2.3.22 MouseOver
A propriedade MouseOver informa se o ponteiro do mouse encontra-se em cima
da Tela. Caso afirmativo, a propriedade MouseOver habilitada; do contrrio, ser
False. Esta propriedade apenas de leitura, e acessvel apenas em tempo de
execuo. O valor padro desta propriedade False.

4.3.2.3.23 MouseOverChild
A propriedade MouseOverChild informa se o ponteiro do mouse encontra-se em
cima de um dos objetos inseridos na Tela. Caso afirmativo, a propriedade
MouseOverChild habilitada; do contrrio, ser False. Esta propriedade apenas
de leitura, e acessvel apenas em tempo de execuo. O valor padro desta
propriedade False.

4.3.2.3.24 Screen
Retorna a Tela pai do objeto. Esta propriedade acessvel apenas em tempo de
execuo.

4.3.2.3.25 Shadow
Indica a presena do efeito de sombra no objeto. Se True, o objeto possui uma
sombra, cujas coordenadas so estabelecidas pelas propriedades ShadowX e
ShadowY. Do contrrio, o objeto no possui o efeito de sombra. O valor padro
desta propriedade False.

4.3.2.3.26 ShadowColor
Especifica a cor do preenchimento da sombra do objeto. Esta cor utilizada
quando a propriedade Shadow est configurada para True. Nos scripts, utilize a
funo RGB do VBScript para montar a cor a ser associada a esta propriedade. O
valor padro desta propriedade cinza escuro (RGB(128, 128, 128)).

4.3.2.3.27 ShadowX
Define a coordenada vertical esquerda da sombra do objeto, em unidades
Himetric. Este sombra sempre relativa propriedade X do objeto. Valores
positivos indicam que a sombra est direita do objeto, e negativos, esquerda. O
valor padro desta propriedade 200.

Visualizao

131

4.3.2.3.28 ShadowY
Define a coordenada horizontal superior da sombra do objeto, em unidades
Himetric. Este sombra sempre relativa propriedade Y do objeto. Valores
positivos indicam que a sombra est abaixo do objeto, e negativos, acima. O valor
padro desta propriedade 200.

4.3.2.3.29 TabStop
Esta propriedade determina a utilizao da tecla TAB no sistema. Se o campo
estiver em True, possvel utilizar a tecla; caso contrrio, a tecla no pode ser
utilizada.

4.3.2.3.30 Tip
A propriedade Tip mostra um texto popup quando o mouse estiver por um breve
momento sobre o objeto em execuo.

4.3.2.3.31 VerticalFillStyle
Define como ser o preenchimento vertical do objeto. Esta propriedade trabalha
em conjunto com a propriedade VerticalPercentFill, que informa qual porcentagem
do objeto dever ser preenchida. Estas duas propriedades permitem uma
simulao de um preenchimento de nvel em um objeto.
Opes disponveis para VerticalFillStyle
OPO
0 - FillBottomToTop
1 - FillTopToBottom
2 - FillCenterToEdgesV

DESCRIO
A porcenta gem de preenchi mento s er
de ba i xo pa ra ci ma .
A porcenta gem de preenchi mento s er
de ci ma pa ra ba i xo.
A porcenta gem de preenchi mento s er
do centro pa ra a s borda s .

4.3.2.3.32 VerticalPercentFill
Utilize a propriedade VerticalPercentFill para especificar qual a porcentagem da
rea vertical do objeto dever ser preenchida. Os valores aceitos por esta
propriedade variam de 0 a 100. Esta propriedade trabalha em conjunto com a
propriedade VerticalFillStyle, que informa como este preenchimento ocorre. O valor
padro desta propriedade 100.

4.3.2.3.33 Visible
Esta propriedade define a visibilidade do objeto. Se configurada como True, o
objeto fica visvel, desde que tambm sejam obedecidos os seguintes fatores: o
132

Visualizao

objeto pai deste objeto tambm deve estar visvel, e a propriedade Layer deste
objeto tambm deve estar presente na camada da Tela.

4.3.2.3.34 Width
Determina a largura do objeto, em unidades Himetric.

4.3.2.3.35 X
A propriedade X define a coordenada horizontal esquerda, em unidades Himetric,
do objeto.

4.3.2.3.36 Y
Esta propriedade define a coordenada vertical superior, em unidades Himetric, do
objeto.

4.3.2.4 Grupo
Esta seo contm informaes sobre propriedades do Grupo de objetos. Este
objeto no possui eventos nem mtodos associados.

4.3.2.4.1 Propriedades
Esta seo contm informaes sobre propriedades do Grupo de objetos.
4.3.2.4.1.1 EnableOverrideLineColor
Esta propriedade habilita ou desabilita o objeto Grupo a sobrescrever as cores
originais das linhas dos objetos contidos no Grupo. Se a propriedade
EnableOverrideLineColor estiver habilitada, faz com que sejam modificadas as
cores originais das linhas dos objetos do Grupo pela cor definida na propriedade
OverrideLineColor. Caso contrrio, cada objeto contido no Grupo apresentar sua
cor de linha original. O valor padro desta propriedade False.
4.3.2.4.1.2 OverrideFillColor
Quando a propriedade OverrideFillMode estiver configurada para 2 ou 3, a
propriedade OverrideFillColor ser usada para definir a cor a ser usada no
preenchimento dos objetos contguos no Grupo, ao invs da cor original. Nos
scripts, utilize a funo RGB do VBScript para montar a cor a ser associada a esta
propriedade. O valor padro desta propriedade vermelho (RGB(255, 0, 0)).

Visualizao

133

4.3.2.4.1.3 OverrideFillMode
A propriedade OverrideFillMode especifica o modo do preenchimento dos
objetos que esto dentro do Grupo. Ela altera o modo original de preenchimento da
imagem sem alterar a configurao original de preenchimento dos objetos.
Opes disponveis para OverrideFillMode
OPO
0 - NoOverride
1 - WireFrame
2 - SolidFill

3 - ByBrightness

DESCRIO
Preenchi mento ori gi na l do objeto.
Os objetos n o s er o preenchi dos ,
des enha r o s omente s ua s borda s .
O preenchi mento dos objetos conti dos
no Grupo s er s l i do com a cor
es peci fi ca da na propri eda de
OverrideFillColor.
O preenchi mento dos objetos conti dos
no Grupo s er s l i do com a cor
es peci fi ca da pel a propri eda de
OverrideFillColor, porm l eva r em conta
qua l era a i ntens i da de da cor ori gi na l de
preenchi mento de ca da objeto.

4.3.2.4.1.4 OverrideLineColor
Quando a propriedade EnableOverrideLineColor estiver configurada para True, a
propriedade OverrideLineColor ser usada para definir a cor a ser usada na cor da
linha dos objetos do Grupo, ao invs da cor original. Nos scripts, utilize a funo
RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor
padro desta propriedade vermelho (RGB(255, 0, 0)).

4.3.2.5 Retngulo Arredondado


Esta seo contm informaes sobre propriedades do objeto Retngulo
Arredondado. Este objeto no possui eventos nem mtodos associados.

4.3.2.5.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Retngulo
Arredondado.
4.3.2.5.1.1 RoundAspectX
A propriedade RoundAspectX define o tamanho da dimenso das laterais do
Retngulo no eixo X. Sendo assim, de acordo com o valor definido na propriedade,
os cantos do Retngulo iro mudar a sua forma, desde um retngulo at uma
elipse. Esta propriedade pode variar seu valor de 0.1 at 1.0. Exemplo:
134

Visualizao

Sub RetanguloArred_Click()
RoundAspectX = 0.5
End Sub

4.3.2.5.1.2 RoundAspectY
A propriedade RoundAspectY define o tamanho da dimenso da altura do
Retngulo no eixo Y. Sendo assim, de acordo com o valor definido na propriedade,
os cantos do Retngulo iro mudar a sua forma, desde um retngulo at uma
elipse. Esta propriedade pode variar seu valor de 0.1 at 1.0. Exemplo:
Sub RetanguloArred_Click()
RoundAspectY = 0.5
End Sub

4.3.2.6 Arco de Elipse


Esta seo contm informaes sobre propriedades do objeto Arco de Elipse. Este
objeto no possui eventos nem mtodos associados.

4.3.2.6.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Arco de Elipse.
4.3.2.6.1.1 ArcBeginAngle
Esta propriedade configura o ngulo inicial do arco do objeto, em graus. O
intervalo aceito por essa propriedade vai de 0 at 359. O estilo e forma do arco
dependero tambm das configuraes das propriedades ArcEndAngle e ArcStyle. O
valor padro desta propriedade 0. Exemplo:
Sub CommandButton9_Click()
Screen.Item("Arco1").ArcBeginAngle = 12
End Sub

4.3.2.6.1.2 ArcEndAngle
Esta propriedade configura o ngulo final do arco do objeto, em graus. O
intervalo aceito por essa propriedade vai de 0 at 359. O estilo e forma do arco
dependero tambm das configuraes das propriedades ArcBeginAngle e ArcStyle.
O valor padro desta propriedade 270. Exemplo:
Sub CommandButton9_Click()
Screen.Item("Arco1").ArcEndAngle = 12
End Sub

4.3.2.6.1.3 ArcStyle
Esta propriedade especifica o estilo da borda ou linha do objeto. A borda do
objeto ser desenhada conforme o estilo definido, utilizando a cor especificada em
BorderColor com a espessura BorderWidth. A seguinte tabela contm os valores
Visualizao

135

vlidos para a propriedade ArcStyle:


Opes disponveis para ArcStyle
OPO
0 - arc
1 - chord
2 - pie

DESCRIO
O es ti l o do des enho s er um a rco.
O es ti l o do des enho s er uma corda ,
uni ndo o ponto i ni ci a l e fi na l .
O es ti l o do des enho s er uma pi zza
(pa dr o).

Exemplo:
Sub CommandButton9_Click()
Screen.Item("Arco1").ArcStyle = 1
End Sub

4.3.2.7 Figura
Esta seo contm informaes sobre propriedades do objeto Figura. Este objeto
no possui eventos nem mtodos associados.

4.3.2.7.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Figura.
4.3.2.7.1.1 BackgroundColor
Esta propriedade especifica a cor de preenchimento do fundo do objeto. Esta cor
utilizada quando a propriedade BackgroundStyle est configurada para 1 (opaco)
e umas das propriedades VerticalPercentFill ou HorizontalPercentFill est com
valores diferentes de 100. Outro uso desta cor quando a propriedade FillStyle est
configurada entre os valores 2 e 8. Isto faz com que a rea restante utilize a cor de
fundo para preenchimento. Nos scripts, utilize a funo do VBScript RGB para
montar a cor a ser associada a esta propriedade. O valor padro desta
propriedade cinza (RGB(192, 192, 192)).
4.3.2.7.1.2 BackgroundStyle
Esta propriedade especifica o modo do preenchimento do fundo do objeto. Esta
propriedade habilita a utilizao das propriedades VerticalPercentFill e
HorizontalPercentFill com valores diferentes de 100 e tambm da propriedade
FillStyle configurada entre os valores 2 e 8. Isto faz com que a rea restante utilize a
cor de fundo BackgroundColor para preenchimento. A seguinte tabela contm os
valores vlidos para a propriedade BackgroundStyle.

136

Visualizao

Opes disponveis para BackgroundStyle


OPO

DESCRIO
Nenhum fundo des te objeto s er
des enha do.
Ca s o vi s vel , o fundo s er des enha do.

0 - Transparente
1 - Opaco

4.3.2.7.1.3 Convert
Esta propriedade permite a converso da figura. Se a opo do campo estiver em
0 possvel visualizar a converso. Caso contrrio, no ser possvel visualizar a
converso. O campo s aceita os valores 0 e 1. O valor padro desta propriedade
0.
4.3.2.7.1.4 EnableOverrideLineColor
Esta propriedade habilita ou desabilita o objeto a sobrescrever a cor original da
linha da imagem pela cor definida na propriedade OverrideLineColor. Se a
propriedade EnableOverrideLineColor estiver habilitada, faz com que sejam
modificadas a cor original da linha do objeto pela cor de OverrideLineColor. Caso
contrrio, o objeto Figura exibir a cor original.
4.3.2.7.1.5 Filename
Define o nome do arquivo de imagem associado a esse objeto. O caminho do
arquivo pode ser tanto o caminho completo do arquivo no disco quanto o caminho
relativo aplicao (quando inserido o arquivo de imagem como um Recurso da
aplicao). O valor padro desta propriedade vazio. Os seguintes tipos de
arquivos de imagem so suportados:
PROPRIEDADE
Bitmap file
Graphics Interchange
Format
Joint Picture Expert
Group
Icon File

FILTRO

DESCRIO

FILTRO

BMP
GIF

N o
N o

Si m
Si m

JPG

N o

Si m

ICO

N o

Si m

4.3.2.7.1.6 HorizontalFillStyle
Define como ser o preenchimento horizontal do objeto. Esta propriedade
trabalha em conjunto com a propriedade HorizontalPercentFill, que informa qual
porcentagem do objeto dever ser preenchida. Estas duas propriedades permitem
uma simulao de um preenchimento de nvel em um objeto, como ocorre em um
nvel de um tanque, por exemplo.

Visualizao

137

Opes disponveis para HorizontalFillStyle


OPO
0 - FillLeftToRight
1 - FillRightToLeft
2 - FillCenterToEdgesH

DESCRIO
A porcenta gem de preenchi mento s er
da es querda pa ra a di rei ta (pa dr o).
A porcenta gem de preenchi mento s er
da di rei ta pa ra a es querda .
A porcenta gem de preenchi mento s er
do centro pa ra a s borda s .

4.3.2.7.1.7 HorizontalPercentFill
Utilize a propriedade HorizontalPercentFill para especificar qual a porcentagem
da rea horizontal do objeto dever ser preenchida. Os valores aceitos por esta
propriedade variam de 0 a 100. Esta propriedade trabalha em conjunto com a
propriedade HorizontalFillStyle, que informa como este preenchimento ocorrer. O
valor padro desta propriedade 100. Exemplo:
Sub Circulo1_OnStartRunning()
HorizontalPercentFill = 200
End Sub

4.3.2.7.1.8 OverrideFillColor
Quando a propriedade OverrideFillMode estiver especificada para os valores 2
ou 3, a propriedade OverrideFillColor ser usada para definir a cor a ser usada no
preenchimento da imagem, ao invs da cor original. Nos scripts, utilize a funo do
VBScript RGB para montar a cor a ser associada a esta propriedade. O valor padro
desta propriedade vermelho (RGB(255, 0, 0)). Exemplo:
Sub DrawPicture1_Click()
' Ao clicar no objeto seta o modo
' Override para slido e troca a cor de
' preenchimento da imagem para azul
OverrideFillMode = 2
OverrideFillColor = RGB(0, 0, 255)
End Sub
NOTA: Es ta propri eda de s funci ona qua ndo o objeto Fi gura es t tra ba l ha ndo com
a rqui vos meta fi l e (WMF ou EMF).

4.3.2.7.1.9 OverrideFillMode
A propriedade OverrideFillMode especifica o modo do preenchimento da
imagem do objeto, quando este est mostrando um arquivo Windows Metafile. Ela
altera o modo original de preenchimento da imagem sem alterar o arquivo definido
pela propriedade Filename. A seguinte tabela contm os valores vlidos para a
propriedade OverrideFillMode.

138

Visualizao

Opes disponveis para OverrideFillMode


OPO
0 - NoOverride
1 - WideFrame
2 - SolidFill

3 - ByBrightness

DESCRIO
A i ma gem ma nter s eu preenchi mento
ori gi na l (pa dr o).
A i ma gem n o s er preenchi da .
A i ma gem s er preenchi da com a cor
es peci fi ca da pel a propri eda de
OverrideFillColor.
A i ma gem s er preenchi da com a cor
es peci fi ca da pel a propri eda de
OverrideFillColor, porm l eva r em conta
qua l era a i ntens i da de da cor ori gi na l da
i ma gem.

Exemplo:
Sub DrawPicture1_Click()
' Ao clicar no objeto seta o modo
' Override para slido e troca a cor de
' preenchimento da imagem para azul
OverrideFillMode = 2
OverrideFillColor = RGB(0, 0, 255)
End Sub
NOTA: Es ta propri eda de s funci ona qua ndo o objeto Fi gura es t tra ba l ha ndo com
a rqui vos meta fi l e (WMF ou EMF).

4.3.2.7.1.10 OverrideLineColor
Quando a propriedade EnableOverrideLineColor estiver configurada para True, a
propriedade OverrideLineColor ser usada para definir a cor a ser usada na cor da
linha da figura, ao invs da cor original. Nos scripts, utilize a funo do VBScript
RGB para montar a cor a ser associada a esta propriedade. O valor padro desta
propriedade vermelho (RGB(255, 0, 0)). Exemplo:
Sub DrawPicture1_Click()
OverrideLineColor = RGB(0, 0, 255)
End Sub
NOTA: Es ta propri eda de s funci ona qua ndo o objeto Fi gura es t tra ba l ha ndo com
a rqui vos meta fi l e (WMF ou EMF).

4.3.2.7.1.11 Shadow
Indica a presena do efeito de sombra no objeto. Se True, o objeto possui uma
sombra, cujas coordenadas so estabelecidas pelas propriedades ShadowX e
ShadowY. Do contrrio, o objeto no possui o efeito de sombra. O valor padro
Visualizao

139

desta propriedade False.


4.3.2.7.1.12 ShadowColor
Especifica a cor do preenchimento da sombra do objeto. Esta cor utilizada
quando a propriedade Shadow est configurada para True. Nos scripts, utilize a
funo do VBScript RGB para montar a cor a ser associada a esta propriedade. O
valor padro desta propriedade cinza escuro (RGB(128, 128, 128)). Exemplo:
Sub Botao1_Click()
' Troca a cor de fundo do botao para cinza claro
' quando se clica no objeto
ShadowColor = RGB(192, 192, 192)
End Sub
NOTA: Es ta propri eda de s funci ona qua ndo o objeto Fi gura es t tra ba l ha ndo com
a rqui vos meta fi l e (WMF ou EMF).

4.3.2.7.1.13 ShadowX
Define a coordenada vertical esquerda da sombra deste objeto, em unidades
Himetric. Esta sombra sempre relativa propriedade X do objeto. Valores
positivos indicam que a sombra estar direita do objeto, e negativos esquerda.
O valor padro desta propriedade 200.
4.3.2.7.1.14 ShadowY
Define a coordenada horizontal superior da sombra deste objeto, em unidades
Himetric. Esta sombra sempre relativa a propriedade Y do objeto. Valores
positivos indicam que a sombra estar abaixo do objeto, e negativos acima. O
valor padro desta propriedade 200. Exemplo:
Sub Botao1_Click()
ShadowY = 250
End Sub
NOTA: Es ta propri eda de s funci ona qua ndo o objeto Fi gura es t tra ba l ha ndo com
a rqui vos meta fi l e (WMF ou EMF).

4.3.2.7.1.15 TransparentColor
Quando a propriedade TransparentMode estiver configurada para 1, esta
propriedade definir qual cor da imagem no ser desenhada, e a imagem ficar
transparente nestes pontos. Nos scripts, utilize a funo do VBScript RGB para
montar a cor a ser associada a esta propriedade. O valor padro desta
propriedade branco (RGB(255, 255, 255)). Exemplo:
Sub DrawPicture1_Click()
' Deixa a cor da imagem azul transparente

140

Visualizao

' quando se clica no objeto Figura


TransparentMode = 1 ' ByColor
TransparentColor = RGB(0, 0, 255)
End Sub
NOTA: Es ta propri eda de s funci ona qua ndo o objeto Fi gura es t tra ba l ha ndo com
a rqui vos meta fi l e (WMF ou EMF).

4.3.2.7.1.16 TransparentMode
A propriedade TransparentMode especifica o modo como a imagem ter o efeito
de transparncia.
Opes disponveis para TransparentMode
OPO
0 - Disabled
1 - ByColor
2 - ByPercent

DESCRIO
Nenhuma tra ns pa rnci a s er efetua da .
A tra ns pa rnci a s er de a cordo com a cor
defi ni da na propri eda de TransparentColor.
A i ma gem fi ca r tra ns l ci da com
porcenta gem de tra ns pa rnci a
es peci fi ca da na propri eda de
TransparentPercent.

Exemplo:
Sub DrawPicture1_Click()
' Deixa a cor da imagem azul transparente
' quando se clica no objeto Figura
TransparentMode = 1 ' ByColor
TransparentColor = RGB(0, 0, 255)
End Sub
NOTA: Es ta propri eda de s funci ona qua ndo o objeto Fi gura es t tra ba l ha ndo com
a rqui vos meta fi l e (WMF ou EMF).

4.3.2.7.1.17 TransparentPercent
Quando a propriedade TransparentMode estiver configurada para 2, esta
propriedade define quo translcida a imagem ser exibida, variando de 0
(totalmente translcido) a 100 (opaco ou slido). Exemplo:
Sub DrawPicture1_Click()
' Deixa a imagem translcida quando se clica no objeto
TransparentMode = 1 ' ByPercent
TransparentPercent = 50 ' 50% translcido
End Sub

Visualizao

141

NOTA: Es ta propri eda de s funci ona qua ndo o objeto Fi gura es t tra ba l ha ndo com
a rqui vos meta fi l e (WMF ou EMF).

4.3.2.7.1.18 VerticalFillStyle
Define como ser o preenchimento vertical do objeto. Esta propriedade trabalha
em conjunto com a propriedade VerticalPercentFill, que informa qual porcentagem
do objeto dever ser preenchida. Estas duas propriedades permitem uma
simulao de um preenchimento de nvel em um objeto.
Opes disponveis para VerticalFillStyle
OPO
0 - FillBottomToTop
1 - FillTopToBottom
2 - FillCenterToEdgesV

DESCRIO
A porcenta gem de preenchi mento s er
de ba i xo pa ra ci ma .
A porcenta gem de preenchi mento s er
de ci ma pa ra ba i xo.
A porcenta gem de preenchi mento s er
do centro pa ra a s borda s .

4.3.2.7.1.19 VerticalPercentFill
Utilize a propriedade VerticalPercentFill para especificar qual a porcentagem da
rea vertical do objeto dever ser preenchida. Os valores aceitos por esta
propriedade variam de 0 a 100. Esta propriedade trabalha em conjunto com a
propriedade VerticalFillStyle, que informa como este preenchimento ocorrer. O
valor padro desta propriedade 100.

4.3.2.8 Texto, Display e SetPoint


Esta seo contm informaes sobre eventos e propriedades dos objetos Texto,
Display e SetPoint. Estes objetos no possuem mtodos associados.

4.3.2.8.1 Eventos
Esta seo contm informaes sobre os eventos dos objetos Texto, Display e
SetPoint.
4.3.2.8.1.1 Validate
Validate(Cancel, NewValue)
Ocorre aps os testes de limites do SetPoint (ver propriedades MinLimit, MaxLimit,
EnableLimits) e antes do valor do SetPoint ser enviado para o Tag. A finalidade
deste evento permitir que o usurio cancele o envio do valor do SetPoint para o
Tag.
O parmetro Cancel booleano e indica se a operao de atribuio do valor do
SetPoint ao Tag deve ser cancelada (Cancel igual a True). O padro False, ou seja,
142

Visualizao

o valor do SetPoint ser enviado ao Tag. NewValue o valor que est sendo
avaliado. O valor antigo pode ser acessado pela propriedade Value do SetPoint.
Exemplo:
Sub Texto1_Validate(Cancel, NewValue)
' Mostra um MessageBox que pergunta ao usurio
' se ele deseja usar o novo valor digitado no SetPoint
message = "Valor atual: " & value & vbnewline & _
"Valor novo: " & NewValue & vbnewline & vbnewline & _
"Aceita o novo valor?"
If MsgBox (message, vbQuestion + vbYesNo, _
Cancel = True
End If
End Sub

4.3.2.8.2 Propriedades
Esta seo contm informaes sobre as propriedades dos objetos Texto, Display e
SetPoint.
4.3.2.8.2.1 EnableLimits
Indica se ser feita a verificao de limites no texto. Quando EnableLimits for
True, e o usurio inserir um valor no-numrico ou colocar um valor fora dos
limites definidos em MinLimit e MaxLimit, uma mensagem de erro mostrada (a
propriedade IsSetPoint deve ser True). Exemplo:
Sub CommandButton1_Click()
Screen.Item("Texto1").EnableLimits = _
Not(Screen.Item("Texto1").EnableLimits)
End Sub

4.3.2.8.2.2 Format
A propriedade Format especifica que tipo de formato ser atribudo ao objeto.
Permite mudar a forma como os dados so apresentados sem mudar o valor que
existe por trs deles. Esta propriedade pode ser editada manualmente ou
configurada atravs da janela de formatao. Seu uso semelhante aos
formatadores usados nas planilhas de dados, seguindo a mesma sintaxe. So
suportados os seguintes tipos de dados:
Tipos de dados suportados por Format
DADOS
Numrico
Texto
Booleano
Data/Hora

Visualizao

DESCRIO
Sa da deci ma l , ci entfi ca , hexa deci ma l ,
bi n ri a e octa l .
Textos em gera l .
Va l ores bol ea nos .
Ca l end ri o Gregori a no.

143

4.3.2.8.2.3 IsSetPoint
A propriedade IsSetPoint utilizada para determinar se o objeto tem
comportamento de SetPoint, ou seja, permite edio da propriedade Value. A
propriedade Value consiste em um Variant, que pode assumir valores de todo e
qualquer tipo. A propriedade IsSetPoint booleana e assume o seguinte
comportamento: se a opo for True, ser permitida a edio; j se a opo estiver
False, a edio no ser permitida. Isto pode ser visualizado quando o objeto
Viewer est em execuo. O valor padro desta propriedade False.
4.3.2.8.2.4 KeepFormatWhenEditing
Permite que o valor do objeto seja editado com ou sem formatao. As opes
disponveis so:
0 - kfNever: neste caso o valor sempre editado sem formatao (padro)
1 - kfAutomatic: permite que o valor seja editado no valor formatado, caso o E3
detecte que o texto formatado passvel de ser interpretado como um valor
Caso o formato seja considerado incompatvel, o valor editado sem formatao.
4.3.2.8.2.5 MaxLimit
Contm o valor mximo permitido no objeto (a propriedade EnableLimits deve ser
True). Exemplo:
Sub CommandButton3_Click()
Screen.Item("Texto1").MaxLimit = Screen.Item("Texto6").Value
End Sub

4.3.2.8.2.6 MinLimit
Contm o valor mnimo permitido no objeto (a propriedade EnableLimits deve ser
True). Exemplo:
Sub CommandButton2_Click()
Screen.Item("Texto1").MinLimit = Screen.Item("Texto5").Value
End Sub

4.3.2.8.2.7 Multiline
A propriedade Multiline indica se o texto ter mltiplas linhas (True) ou se ser
uma caixa de texto simples (False). Isto pode ser visualizado quando o objeto
Viewer est em execuo. O valor padro desta propriedade False.

144

Visualizao

4.3.2.8.2.8 SetPointDataType
Determina o tipo de valor que enviado do SetPoint para o Tag.
Opes disponveis para SetPointDataType
OPO
0 - stCurrentType
1 - stChar
2 - stByte
3 - stWord
4 - stInteger
5 - stLong
6 - stDWord
7 - stSingle
8 - stDouble
9 - stDateTime
10 - stString

DESCRIO
Ma ntm o ti po do va l or a tua l no SetPoi nt
(ver a s egui r).
Va l or i ntei ro de 8 bi ts com s i na l .
Va l or i ntei ro de 8 bi ts s em s i na l .
Va l or i ntei ro de 16 bi ts s em s i na l .
Va l or i ntei ro de 16 bi ts com s i na l .
Va l or i ntei ro de 32 bi ts com s i na l .
Va l or i ntei ro de 16 bi ts s em s i na l .
Va l or de ponto fl utua nte de 32 bi ts .
Va l or de ponto fl utua nte de 64 bi ts .
Va l or de da ta e hora .
Texto.

Quando o texto digitado enviado pelo SetPoint, este primeiro tentar converter o
valor para o tipo configurado (Word, String, Double, etc.). Se a converso no for
possvel - ou seja, o valor digitado invlido para o tipo escolhido - nenhum valor
enviado (por exemplo, se o usurio digitar -1 e o tipo for Byte). J quando o valor
da propriedade for 0 - stCurrentType, o tipo de dado enviado pelo SetPoint ser
extrado do valor anterior presente no objeto. Caso o valor anterior seja Empty ou
Null, nenhuma converso ser feita e o valor digitado ser enviado como texto.
Exemplo:
Sub Combobox1_Change()
Screen.Item("Texto1").SetPointDataType = CInt(Left(Value, 2))
End Sub

4.3.2.8.2.9 StretchText
Redimensiona o tamanho do objeto. A partir do momento em que a propriedade
StretchText for habilitada, o objeto automaticamente redimensiona o tamanho da
fonte do texto para que a rea ocupada por ele continue sempre a mesma. De outra
forma, se a propriedade StretchText estiver configurada para False, nenhum
redimensionamento ser efetuado.
4.3.2.8.2.10 TextAlignment
Esta propriedade especifica o alinhamento horizontal do texto mostrado no
objeto.

Visualizao

145

Opes disponveis para TextAlignment


OPO

DESCRIO
O a l i nha mento hori zonta l do texto s er
es querda .
O a l i nha mento hori zonta l do texto s er
centra l i za do.
O a l i nha mento hori zonta l do texto s er
di rei ta .

0 - LeftAlignment
1 - CenterAlignment
2 - RightAlignment

4.3.2.8.2.11 TextColor
Esta propriedade especifica a cor da fonte do texto a ser exibido. Nos scripts,
utilize a funo do VBScript RGB para montar a cor a ser associada a esta
propriedade. O valor padro desta propriedade preto (RGB(0, 0, 0)).
4.3.2.8.2.12 TextFont
Define as informaes da fonte a ser utilizado pelo objeto. Esta propriedade no
pode ser utilizada em Associaes e possui as seguintes subpropriedades,
modificveis via script:
Subpropriedades de TextFont
Name
Size

NOME

TIPO
Stri ng
Ponto Fl utua nte

Bold

Bool ea no

Italic

Bool ea no

Underline

Bool ea no

Strikethrough

Bool ea no

Weight

Intei ro

Charset

Intei ro

146

DESCRIO
O nome da fonte.
O ta ma nho, em pontos , da
fonte.
Indi ca s e o texto es t em
negri to.
Indi ca s e o texto es t em
i t l i co.
Indi ca s e o texto es t
s ubl i nha do.
Indi ca s e o texto es t
ta cha do.
Indi ca a va ri a o do efei to
de negri to (a
s ubpropri eda de Bold) na
fonte. Os va l ores pa ra es ta
s ubpropri eda de podem
va ri a r entre 0 (n o
i nterfere no efei to de
negri to) e 1000.
O conjunto de ca ra cteres
da fonte. Veja a ta bel a de
conjuntos de ca ra cteres a
s egui r, com os va l ores
di s ponvei s pa ra es ta
s ubpropri eda de.

Visualizao

Valores disponveis para a subpropriedade Charset


VALOR
0
1
2
128
129
134
136
161
162
177
178
186
204
222
238
255

DESCRIO
ANSI (American National Standards Institute)
Pa dr o (mos tra o conjunto de ca ra cteres
di s ponvel na fonte)
Smbol os
Ja pons (Shi ft-JIS)
Corea no
Chi ns Si mpl i fi ca do (GBK)
Chi ns Tra di ci ona l (Bi g5)
Grego
Turco
Hebra i co
ra be
B l ti co
Ci rl i co
Ta i l a nds
Centro-Europeu
OEM (Original Equipment Manufacturer)

4.3.2.8.2.13 Value
A propriedade Value consiste em um Variant, que pode assumir valores de todo e
qualquer tipo, e que ser exibido pelo objeto. Geralmente esta propriedade conter
um texto, pois automaticamente preenchida quando ocorre a criao de um novo
objeto Texto. A propriedade IsSetPoint utilizada para determinar se o objeto Texto
ter o mesmo comportamento de um SetPoint, ou seja, permitir a edio da
propriedade Value. Exemplo:
Sub DrawString1_OnStartRunning()
' L o valor de um tag e mostra o Texto
Dim obj
Set obj = Application.GetObject("DataServer1.DemoTag1")
Value = "Valor de DemoTag1 = " & obj.Value
End Sub

4.3.2.8.2.14 VertTextAlignment
Determina o alinhamento vertical do texto do objeto.
Opes disponveis para VertTextAlignment
OPO
0 - TopAlignment

Visualizao

DESCRIO
Al i nha mento verti ca l do texto no topo do
objeto.

147

1 - MidAlignment
2 - BottomAlignment

Al i nha mento verti ca l do texto no centro


do objeto.
Al i nha mento verti ca l do texto na ba s e do
objeto.

4.3.2.8.2.15 WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a True.

4.3.2.9 Escala
Esta seo contm informaes sobre propriedades do objeto Escala. Este objeto
no possui eventos nem mtodos associados.

4.3.2.9.1 Propriedades
Esta seo contm informaes sobre propriedades do objeto Escala.
4.3.2.9.1.1 BackgroundColor
Esta propriedade especifica a cor de preenchimento do fundo do objeto. Esta cor
utilizada quando a propriedade BackgroundStyle est configurada para 1 (opaco)
e umas das propriedades VerticalPercentFill ou HorizontalPercentFill est com
valores diferentes de 100. Outro uso desta cor quando a propriedade FillStyle est
configurada entre os valores 2 e 8. Isto faz com que a rea restante utilize a cor de
fundo para preenchimento. Nos scripts, utilize a funo do VBScript RGB para
montar a cor a ser associada a esta propriedade. O valor padro desta
propriedade cinza (RGB(192, 192, 192)).
4.3.2.9.1.2 BorderColor
Esta propriedade determina a cor da borda que ser aplicada no objeto Escala.
Com esta propriedade, possvel aplicar a cor padro ou personaliz-la atravs da
sua edio. O valor padro desta propriedade branco (RGB(255, 255, 255)).
Exemplo:
Sub Escala1_Click()
BorderColor = RGB (255, 0, 0)
End Sub

4.3.2.9.1.3 BorderStyle
A propriedade BorderStyle determina o estilo de borda que ser aplicada ao
objeto Escala.

148

Visualizao

Opes disponveis para BorderStyle


OPO

DESCRIO
Apl i ca uma borda s l i da na gra de
verti ca l da es ca l a (pa dr o).
Apl i ca uma borda l i nha tra ceja da na
es ca l a .
Apl i ca uma borda ponti l ha da na es ca l a .
Apl i ca uma borda tra o e ponto na
es ca l a .
Apl i ca uma borda tra o ponto ponto na
es ca l a .
O objeto n o ter borda .

0 - Normal
1 - Dash
2 - Dot
3 - Dashdot
4 - Dashdotdot
5 - Null

4.3.2.9.1.4 BorderWidth
Esta propriedade determina a largura (em pixels) da borda do objeto Escala.
Atravs desta propriedade, possvel configurar a largura da borda, sem precisar
modificar sua estrutura. O valor padro desta propriedade 0.
4.3.2.9.1.5 ForegroundColor
Esta propriedade especifica a cor do preenchimento do frente do objeto. Esta cor
utilizada quando a propriedade FillStyle est configurada para 0 (slido) ou entre
2 e 9. Nos scripts, utilize a funo do VBScript RGB para montar a cor a ser
associada a esta propriedade. O valor padro para esta propriedade azul (RGB(0,
0, 255)). Exemplo:
Sub Botao1_Click()
' Troca a cor de fundo do botao para verde
'quando se clica no objeto
ForegroundColor = RGB(0, 255, 0)
End Sub

4.3.2.9.1.6 Format
A propriedade Format especifica que tipo de formato ser atribudo ao objeto.
Permite mudar a forma como os dados so apresentados sem mudar o valor que
existe por trs deles. Esta propriedade pode ser editada manualmente ou
configurada atravs da janela de formatao. Seu uso semelhante aos
formatadores usados nas planilhas de dados, seguindo a mesma sintaxe. So
suportados os seguintes tipos de dados:
Tipos de dados suportados por Format
DADOS
Numrico
Texto

Visualizao

DESCRIO
Sa da deci ma l , ci entfi ca , hexa deci ma l ,
bi n ri a e octa l .
Textos em gera l .

149

DADOS

DESCRIO
Va l ores Bol ea nos .
Ca l end ri o Gregori a no.

Booleano
Data/Hora

4.3.2.9.1.7 GradientStyle
Esta propriedade especifica o estilo de preenchimento degrad do objeto. Esta
propriedade s ser utilizada quando a valor da propriedade FillStyle estiver
configurada para 8 (Gradient). Os degrads consideram a mudana da cor partindo
de ForegroundColor e indo para BackgroundColor.
Opes disponveis para GradientStyle
OPO
0 - LeftToRight
1 - RightToLeft
2 - VerFromCenter
3 - VerToCenter
4 - BottomUp
5 - TopDown
6 - HorzFromCenter
7 - HorzToCenter
8 - DiagUpRight
9 - DiagUpLeft
10 - DiagUpFromCenter
11 - DiagUpToCenter
12 - DiagDownLeft
13 - DiagDownRight
14 - DiagDownFromCenter
15 - DiagDownToCenter
16 - SpotSouthEast
17 - SpotSouthWest
18 - SpotNorthWest

150

DESCRIO
Degra d verti ca l da es querda pa ra a
di rei ta .
Degra d verti ca l da di rei ta pa ra a
es querda .
Degra d verti ca l do centro pa ra a s
borda s .
Degra d verti ca l da s borda s pa ra o
centro.
Degra d hori zonta l de ba i xo pa ra ci ma .
Degra d hori zonta l de ci ma pa ra ba i xo.
Degra d do centro pa ra a s borda s .
Degra d da s borda s pa ra o centro.
Degra d di a gona l pa ra ci ma com a cor de
frente na di rei ta (pa dr o).
Degra d di a gona l pa ra ci ma com a cor de
frente na es querda .
Degra d di a gona l pa ra ci ma do centro
pa ra a s borda s .
Degra d di a gona l pa ra ci ma da s borda s
pa ra o centro.
Degra d di a gona l pa ra ba i xo com cor de
frente na es querda .
Degra d di a gona l pa ra ba i xo com cor de
frente na di rei ta .
Degra d di a gona l pa ra ba i xo do centro
pa ra a s borda s .
Degra d di a gona l pa ra ba i xo da s borda s
pa ra o centro.
Degra d com cor de frente pa rti ndo do
ca nto i nferi or di rei to.
Degra d com cor de frente pa rti ndo do
ca nto i nferi or es querdo.
Degra d com cor de frente pa rti ndo do
ca nto s uperi or es querdo.

Visualizao

OPO
19 - SpotNorthEast
20 - SpotFromCenter
21 - SpotToCenter

DESCRIO
Degra d com cor de frente pa rti ndo do
ca nto s uperi or di rei to.
Degra d com cor de fundo do centro pa ra
a s borda s .
Degra d com cor de fundo da s borda s
pa ra o centro.

IMPORTANTE: Um gra nde nmero de objetos s endo mos tra dos com degra d
s i mul ta nea mente a ca rreta uma perda de performa nce na a tua l i za o da Tel a . O
us o de fi gura s no l uga r pode res ol ver o probl ema .

Exemplo:
Sub Botao1_Click()
' Objeto fica com degrade
FillStyle = 8 ' GradientFill
GradientStyle = 0 ' leftToRight
End Sub

4.3.2.9.1.8 LineColor
Determina a cor da linha com as marcas divisrias e subdivisrias da Escala.
Para determinar a cor da legenda com nmeros do objeto, use a propriedade
TextColor. O valor padro desta propriedade preto (RGB(0, 0, 0)).
4.3.2.9.1.9 MaximumValue
Esta propriedade determina o valor mximo atingido pela Escala. O valor padro
desta propriedade 100. Exemplo:
Sub CommandButton_Click()
' Ao clicar no boto, abre um MessageBox indicando
' o valor mximo da propriedade da escala
MsgBox CSTr(Screen.Item("Escala1").MaximumValue)
End Sub

4.3.2.9.1.10 MinimumValue
Esta propriedade determina o valor mnimo requerido pela Escala. O valor padro
desta propriedade 0. Exemplo:
Sub CommandButton1_Click()
' Ao clicar no boto, abre um MessageBox indicando
' o valor da propriedade Minimum do Escala1
MsgBox _
CSTr(Application.GetObject("Dados.Escala1").MinimumValue)
End Sub

Visualizao

151

4.3.2.9.1.11 MinorTicks
Esta propriedade determina a quantidade de marcas da Escala. O valor padro
desta propriedade 3. Exemplo:
Sub CommandButton1_Click()
' Mostra o total de marcas da escala
MsgBox CStr(Screen.Item("Escala1").MinorTicks)
End Sub

4.3.2.9.1.12 MinorTicksPercentSize
Esta propriedade determina o tamanho das marcas que subdividem cada medida
do objeto Escala. O valor padro desta propriedade 10.
4.3.2.9.1.13 ScaleAlignment
Esta propriedade determina o tipo de alinhamento que ser atribudo Escala:
0 - RightSide: direita (valor padro)
1 - LeftSide: esquerda
4.3.2.9.1.14 ShowText
Esta propriedade determina a visibilidade do texto na legenda do objeto Escala.
Se a opo estiver habilitada, o texto mostrado. Caso contrrio, o objeto mostra
somente as linhas e subdivises da Escala. O valor padro desta propriedade
True.
4.3.2.9.1.15 StretchText
Esta propriedade determina a aplicao de extenso (stretch) ao texto do objeto
Escala (caso a largura ou altura da Escala sejam alteradas, o texto acompanha
esta variao). Se a propriedade estiver habilitada, o objeto acompanha as
variaes de altura e largura do objeto conforme for transformado. Caso contrrio,
o texto permanece com as configuraes iniciais. O valor padro desta
propriedade False.
4.3.2.9.1.16 TextAlignment
A propriedade TextAlignment determina o alinhamento do texto no objeto.
Opes disponveis para TextAlignment
OPO
0 - leftAlignment

152

DESCRIO
O a l i nha mento do texto s er es querda
(pa dr o).

Visualizao

OPO
1 - centerAlignment
2 - rightAlignment

DESCRIO
O a l i nha mento do texto s er
centra l i za do.
O a l i nha mento do texto s er di rei ta .

4.3.2.9.1.17 TextColor
Determina a cor da fonte aplicada na legenda com nmeros do objeto Escala.
Para determinar a cor da linha com as marcas divisrias e subdivisrias da
Escala, utilize a propriedade LineColor. O valor padro desta propriedade preto
(RGB(0, 0, 0)).
4.3.2.9.1.18 TextFont
A propriedade TextFont determina a fonte que ser aplicada na Escala. A fonte
escolhida ser aplicada em todo o objeto Escala. Esta propriedade no pode ser
utilizada em Associaes. Veja a propriedade TextFont dos objetos Texto, Display e
SetPoint para maiores informaes sobre as subpropriedades que podem ser
modificadas via script.
4.3.2.9.1.19 Ticks
Determina a quantidade de divisrias que a Escala ter. O valor padro desta
propriedade 5.
4.3.2.9.1.20 TicksPercentSize
Determina o tamanho das linhas que dividem o objeto Escala. Conforme for o
valor especificado nesta propriedade, maior ou menor ficar o tamanho da linha
da divisria padro da Escala. O valor padro desta propriedade 20.

4.3.2.10 Animao com Translao


Esta seo contm informaes sobre propriedades do objeto Animao com
Translao. Este objeto no possui eventos nem mtodos associados.

4.3.2.10.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Animar com
Translao.
4.3.2.10.1.1 Detents
Atravs da propriedade Detents determinado o nmero de passos do movimento
no objeto. Exemplo:
Sub CommandButton1_Click()

Visualizao

153

MsgBox Screen.Item("DynamicRotate1").Detents
End Sub

4.3.2.10.1.2 EnableOverrideLineColor
Esta propriedade habilita ou desabilita o objeto a sobrescrever a cor original da
linha da imagem pela cor definida na propriedade OverrideLineColor. Se a
propriedade EnableOverrideLineColor estiver habilitada, faz com que seja
modificada a cor original da linha do objeto pela cor de OverrideLineColor. Caso
contrrio, o objeto Figura exibir a cor original. O valor padro desta propriedade
False.
4.3.2.10.1.3 EnableSlider
A propriedade EnableSlider habilita o slider no movimento do objeto. Se a
propriedade estiver habilitada, o slider do movimento habilitado. Caso contrrio,
isto no ocorre.
4.3.2.10.1.4 OverrideFillColor
Quando a propriedade OverrideFillMode estiver especificada para os valores 2
ou 3, a propriedade OverrideFillColor ser usada para definir a cor a ser usada no
preenchimento dos objetos no movimento, ao invs da cor original. Nos scripts,
utilize a funo do VBScript RGB para montar a cor a ser associada a esta
propriedade. O valor padro desta propriedade vermelho (RGB(255, 0, 0)).
Exemplo:
Sub DrawGroup1_Click()
' Ao clicar no objeto seta o modo
' Override para slido e troca a cor de
' preenchimento da imagem para azul
OverrideFillMode = 2
OverrideFillColor = RGB(0, 0, 255)
End Sub

4.3.2.10.1.5 OverrideFillMode
A propriedade OverrideFillMode especifica o modo do preenchimento dos
objetos que esto em movimento. Ela altera o modo original de preenchimento da
imagem sem alterar a configurao original de preenchimento dos objetos.
Opes disponveis para OverrideFillMode
OPO
0 - NoOverride
1 - WireFrame

154

DESCRIO
Preenchi mento ori gi na l do objeto.
Os objetos n o s er o preenchi dos ,
des enha r o s omente s ua s borda s .

Visualizao

OPO
2 - SolidFill

3 - ByBrightness

DESCRIO
O preenchi mento dos objetos conti dos
no grupo s er s l i do com a cor
es peci fi ca da na propri eda de
OverrideFillColor.
O preenchi mento dos objetos conti dos
no grupo s er s l i do com a cor
es peci fi ca da pel a propri eda de
OverrideFillColor, porm l eva r em conta
qua l era a i ntens i da de da cor ori gi na l de
preenchi mento de ca da objeto.

Exemplo:
Sub DrawGroup1_Click()
' Ao clicar no objeto seta o modo
' Override para slido e troca a cor de
' preenchimento da imagem para azul
OverrideFillMode = 2
OverrideFillColor = RGB(0, 0, 255)
End Sub

4.3.2.10.1.6 OverrideLineColor
Quando a propriedade EnableOverrideLineColor estiver configurada para True, a
propriedade OverrideLineColor ser usada para definir a cor a ser usada na cor da
linha do objeto em movimento, ao invs da cor original. Nos scripts, utilize a
funo do VBScript RGB para montar a cor a ser associada a esta propriedade. O
valor padro desta propriedade vermelho (RGB(255, 0, 0)). Exemplo:
Sub Grupo1_Click()
OverrideLineColor = RGB(255, 0, 0)
End Sub

4.3.2.10.1.7 RangeMax
Atravs da propriedade RangeMax determinado o alcance mximo do
movimento linear no objeto.
4.3.2.10.1.8 RangeMin
Atravs da propriedade RangeMin determinado o alcance mnimo do movimento
linear no objeto.
4.3.2.10.1.9 Value
o valor inicial do movimento. Deve ser um valor entre os valores nas
propriedades RangeMax e RangeMin.
Visualizao

155

4.3.2.11 Animao com Rotao


Esta seo contm informaes sobre propriedades do objeto Animao com
Rotao. Este objeto no possui eventos nem mtodos associados.

4.3.2.11.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Animao com
Rotao.
4.3.2.11.1.1 Detents
Atravs da propriedade Detents determinado o nmero de passos do movimento
no objeto.
4.3.2.11.1.2 EnableOverrideLineColor
Esta propriedade habilita ou desabilita o objeto a sobrescrever a cor original da
linha da imagem pela cor definida na propriedade OverrideLineColor. Se a
propriedade EnableOverrideLineColor estiver habilitada, faz com que seja
modificada a cor original da linha do objeto pela cor da propriedade
OverrideLineColor. Caso contrrio, o objeto exibir a cor original. O valor padro
desta propriedade False.
4.3.2.11.1.3 EnableSlider
A propriedade EnableSlider habilita o slider no movimento do objeto.
4.3.2.11.1.4 OverrideFillColor
Quando a propriedade OverrideFillMode estiver especificada para os valores 2
ou 3, a propriedade OverrideFillColor ser usada para definir a cor a ser usada no
preenchimento dos objetos no movimento, ao invs da cor original. Nos scripts,
utilize a funo do VBScript RGB para montar a cor a ser associada a esta
propriedade. O valor padro desta propriedade vermelho (RGB(255, 0, 0)).
4.3.2.11.1.5 OverrideFillMode
A propriedade OverrideFillMode especifica o modo do preenchimento dos
objetos que esto em movimento. Ela altera o modo original de preenchimento da
imagem sem alterar a configurao original de preenchimento dos objetos.
Opes disponveis para OverrideFillMode
OPO
0 - NoOverride

156

DESCRIO
Preenchi mento ori gi na l do objeto.

Visualizao

OPO
1 - WireFrame
2 - SolidFill

3 - ByBrightness

DESCRIO
Os objetos n o s er o preenchi dos ,
des enha r o s omente s ua s borda s .
O preenchi mento dos objetos conti dos
no grupo s er s l i do com a cor
es peci fi ca da na propri eda de
OverrideFillColor.
O preenchi mento dos objetos conti dos
no grupo s er s l i do com a cor
es peci fi ca da pel a propri eda de
OverrideFillColor, porm l eva r em conta
qua l era a i ntens i da de da cor ori gi na l de
preenchi mento de ca da objeto.

4.3.2.11.1.6 OverrideLineColor
Quando a propriedade EnableOverrideLineColor estiver configurada para True, a
propriedade OverrideLineColor ser usada para definir a cor a ser usada na cor da
linha do objeto em movimento, ao invs da cor original. Nos scripts, utilize a
funo do VBScript RGB para montar a cor a ser associada a esta propriedade. O
valor padro desta propriedade vermelho (RGB(255, 0, 0)).
4.3.2.11.1.7 RangeMax
Atravs da propriedade RangeMax determinado o alcance mximo do
movimento rotacional no objeto.
4.3.2.11.1.8 RangeMin
Atravs da propriedade RangeMin determinado o alcance mnimo do movimento
rotacional no objeto.
4.3.2.11.1.9 RotationAngle
Esta propriedade determina o ngulo de rotao do movimento no objeto.
4.3.2.11.1.10 RotationDirection
Atravs da propriedade RotationDirection determinada a direo do ngulo de
rotao do movimento no objeto.
Opes disponveis para RotationDirection
OPO
0 - Clockwise
1 - CounterClockWise

Visualizao

DESCRIO
Di reci ona o ngul o de rota o a di rei ta
do objeto.
Di reci ona o ngul o de rota o a
es querda do objeto.

157

4.3.2.11.1.11 Value
o valor inicial do movimento. Deve ser um valor entre os valores nas
propriedades RangeMax e RangeMin.

4.3.2.12 Microsoft Forms


Esta seo contm informaes sobre eventos e propriedades comuns de objetos
Microsoft Forms. Estes objetos no possuem mtodos comuns associados.

4.3.2.12.1 Eventos Comuns


Esta seo contm informaes sobre os eventos comuns aos objetos Microsoft
Forms.
4.3.2.12.1.1 BeforeDragOver
BeforeDragOver(Index, Cancel, Data, X, Y, DragState, Effect, Shift)
Ocorre quando h uma ao de arrastar e soltar (drag-and-drop) sobre o objeto.
Utiliza-se este evento para monitorar se o mouse entrou, deixou ou ficou sobre um
objeto alvo. O evento disparado quando o usurio move o mouse ou pressiona ou
solta algum boto do mouse. A posio do ponteiro do mouse vai indicar qual o
objeto que ir gerar o evento. Pode-se determinar o status do ponteiro do mouse
examinando a varivel DragState.
Muitos objetos no suportam operaes de arrastar e soltar enquanto a varivel
Cancel False, que o padro. Isso significa que o objeto rejeita qualquer tentativa
de arrastar ou soltar algum outro objeto sobre si e consequentemente, no dispara
o evento BeforeDropOrPaste. O objeto Text Box (caixa de texto) e o objeto Combo
(caixa de seleo) so excees; elas aceitam operaes de arrastar e soltar
mesmo quando Cancel False.
Variveis do evento BeforeDragOver
NOME
Index

Cancel

Data
X, Y

158

DESCRIO
Indi ca o ndi ce da p gi na , em um objeto
mul ti -p gi na s , que s er a feta da pel a
opera o que gerou o evento. Pa ra outros
objetos i gnora da .
Sta tus do evento. O pa dr o Fa l s e e i ndi ca
que s er o objeto a l vo que tra ta r o evento,
e n o a a pl i ca o pri nci pa l .
Da dos s endo a rra s ta dos pa ra o objeto a l vo,
propri a mente di tos .
Pos i o do mous e dentro do objeto a l vo,
em pontos . X medi do a pa rti r do l a do
es querdo do objeto; Y medi do a pa rti r do
topo.

Visualizao

NOME

DESCRIO
Indi ca a condi o do mous e qua ndo
gera do o evento:
0 - fmDragStateEnter: o mous e es t dentro
do a l ca nce do objeto
1 - fmDragStateLeave: o mous e es t fora
do a l ca nce do objeto
2 - fmDragStateOver: o mous e es t em
uma nova pos i o, ma s a i nda es t
dentro do a l ca nce do objeto
Indi ca a s a es que o objeto a l vo s uporta ,
ou s eja , o efei to de a rra s ta r s obre o objeto
em ques t o:
0 - fmDropEffectNone: objeto a l vo n o
a cei ta copi a r ou mover de a l guma ori gem
1 - fmDropEffectCopy: objeto a l vo permi te
copi a r de a l guma ori gem pa ra s i
2 - fmDropEffectMove: objeto a l vo permi te
mover de a l guma ori gem pa ra s i
3 - fmDropEffectCopyOrMove: objeto a l vo
permi te copi a r ou mover de a l guma
ori gem pa ra s i
Intei ro cuja s oma dos fa tores i ndi ca o
s ta tus da s tecl a s SHIFT, CTRL e ALT:
1: tecl a SHIFT pres s i ona da
2: tecl a CTRL pres s i ona da
4: tecl a ALT pres s i ona da
Por exempl o, um va l or i gua l a 5 i ndi ca que
a s tecl a s SHIFT e ALT es ta va m
pres s i ona da s (1 + 4 = 5).

DragState

Effect

Shift

4.3.2.12.1.2 BeforeDropOrPaste
BeforeDropOrPaste(Index, Cancel, Ctrl, Action, Data, X, Y, Effect, Shift)
Disparado no momento imediatamente anterior a uma operao de arrastar e
soltar. Normalmente, isto ocorre logo aps o evento BeforeDragOver.
Variveis do evento BeforeDropOrPaste
NOME
Index

Cancel
Ctrl

Visualizao

DESCRIO
Indi ca o ndi ce da p gi na , em um objeto
mul ti -p gi na s , que s er a feta da pel a
opera o que gerou o evento. Pa ra outros
objetos i gnora da .
Sta tus do evento. O pa dr o Fa l s e e i ndi ca
que s er o objeto a l vo que tra ta r o evento,
e n o a a pl i ca o pri nci pa l .
Objeto a l vo.

159

NOME
Data
Action

X, Y

DragState

Effect

Shift

160

DESCRIO
Da dos s endo a rra s ta dos pa ra o objeto a l vo,
propri a mente di tos .
Indi ca o res ul ta do, ba s ea do na s
confi gura es do tecl a do, de uma opera o
a rra s ta r e s ol ta r pendente:
2 - fmActionPaste: col a o objeto
s el eci ona do no objeto a l vo
3 - fmActionDragDrop: i ndi ca que o
us u ri o a rra s tou o objeto s el eci ona do
de s ua ori gem e s ol tou-o s obre o objeto
a l vo
Pos i o do mous e dentro do objeto a l vo,
em pontos . X medi do a pa rti r do l a do
es querdo do objeto; Y medi do a pa rti r do
topo.
Indi ca a condi o do mous e qua ndo
gera do o evento:
0 - fmDragStateEnter: o mous e es t dentro
do a l ca nce do objeto
1 - fmDragStateLeave: o mous e es t fora
do a l ca nce do objeto
2 - fmDragStateOver: o mous e es t em
uma nova pos i o, ma s a i nda es t
dentro do a l ca nce do objeto
Indi ca a s a es que o objeto a l vo s uporta ,
ou s eja , o efei to de a rra s ta r s obre o objeto
em ques t o:
0 - fmDropEffectNone: objeto a l vo n o
a cei ta copi a r ou mover de a l guma ori gem
1 - fmDropEffectCopy: objeto a l vo permi te
copi a r de a l guma ori gem pa ra s i
2 - fmDropEffectMove: objeto a l vo permi te
mover de a l guma ori gem pa ra s i
3 - fmDropEffectCopyOrMove: objeto a l vo
permi te copi a r ou mover de a l guma
ori gem pa ra s i
Intei ro cuja a s oma dos fa tores i ndi ca o
s ta tus da s tecl a s SHIFT, CTRL e ALT:
1: tecl a SHIFT pres s i ona da
2: tecl a CTRL pres s i ona da
4: tecl a ALT pres s i ona da
Por exempl o, um va l or i gua l a 5 i ndi ca que
a s tecl a s SHIFT e ALT es ta va m
pres s i ona da s (1 + 4 = 5).

Visualizao

4.3.2.12.1.3 Change
Change()
Ocorre quando o valor da propriedade Value do objeto modificada. A seguir esto
alguns exemplos de aes que disparam o evento Change:
Clicar em uma Caixa de Seleo, em um Boto de Opes ou Boto IncrementoDecremento
Clicar ou selecionar palavras em uma Lista de Seleo ou Editor de Texto
Selecionar diferentes abas em uma caixa de dilogo
Mover a barra de rolagem em um objeto Barra de Rolagem
Clicar nas setas de um Boto Incremento-Decremento
Selecionar diferentes pginas em um objeto multi-pginas
4.3.2.12.1.4 KeyPress
KeyPress(KeyAscii)
Ocorre quando o objeto tem o foco de teclado e o usurio pressiona uma tecla que
corresponde a um caractere que pode ser mostrado em tela (uma tecla ANSI, de
cdigo indicado na varivel KeyAscii). Ou seja, o evento ocorre quando alguma das
teclas a seguir so pressionadas:
Qualquer caractere do teclado que possa ser impresso
Tecla CTRL combinada com qualquer caractere do alfabeto padro
Tecla CTRL combinada com qualquer caractere especial
Tecla BACKSPACE
Tecla ESC
Este evento no ocorre nas seguintes condies:
Pressionando a tecla TAB
Pressionando a tecla ENTER
Pressionando a tecla DEL (essa tecla no padro ANSI)
Pressionando as setas do teclado
Quando uma tecla faz com que o foco v de um objeto a outro
Enquanto um usurio pressiona uma tecla que produz um cdigo ANSI, o objeto
Visualizao

161

recebe os eventos KeyDown e KeyPress repetidamente. Quando o usurio libera a


tecla, o evento KeyUp ocorre. Para monitorar o estado fsico do teclado ou
manipular teclas no reconhecidas pelo evento KeyPress (como teclas de funo,
navegao, etc.), utiliza-se os eventos KeyDown e KeyUp.
4.3.2.12.1.5 OnError
OnError(Number, Description, SCode, Source, HelpFile, HelpContext, CancelDisplay)
Gerado por um erro interno no objeto. Se este evento no for tratado, o E3 ir
mostrar uma mensagem de erro genrica.
Variveis do evento OnError
NOME
Number
Description
SCode
Source
HelpFile
HelpContext
CancelDisplay

DESCRIO
Nmero i ntei ro i denti fi ca dor do erro.
String com a des cri o do erro.
Intei ro com o cdi go de erro do
s ubs i s tema OLE (n o uti l i za do).
String com o objeto que ori gi nou o erro.
String com o nome e o ca mi nho do
a rqui vo de a juda .
Nmero de contexto do tpi co de a juda
referente a o erro (i ntei ro).
Bool ea no. Indi ca s e o erro deve s er
mos tra do em uma ca i xa de mens a gem.

4.3.2.12.2 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns aos objetos
Microsoft Forms.
NOTA: O E3 uti l i za pa ra defi ni o de coordena da s e es pes s ura o s i s tema Hi metri c.
Nes te s i s tema , ca da uni da de l gi ca equi va l e a um mi l s i mo de centmetro; ou s eja ,
ca da 1000 uni da des equi va l em a 1 centmetro. As s i m, es te o pa dr o a dota do na
des cri o da s propri eda des do E3, qua ndo a pl i c vel .

4.3.2.12.2.1 BackColor
Determina a cor de fundo do objeto. Nos scripts, utilize a funo do VBScript RGB
para montar a cor a ser associada a esta propriedade. O valor padro desta
propriedade para os objetos Lista de Seleo, Lista e Editor de Texto a cor branca
(RGB(255, 255, 255)), e para os demais objetos a cor bege (RGB(236, 233, 216)).
4.3.2.12.2.2 ForeColor
Especifica a cor do preenchimento do fundo do objeto. Nos scripts, utilize a
funo do VBScript RGB para formar a cor a ser associada a esta propriedade. O
162

Visualizao

valor padro desta propriedade para todos os objetos MSForms a cor preta
(RGB(0, 0, 0)).
4.3.2.12.2.3 MouseIcon
A propriedade MouseIcon atribui uma imagem ao ponteiro do mouse, quando
este movido sobre o objeto. Esta propriedade vlida somente quando a
propriedade MousePointer definida como 99 - fmMousePointerCustom.
Um arquivo com imagem pode ser selecionado para o ponteiro do mouse de duas
formas: atravs da Lista de Propriedades (extenses .cur ou .ico); ou via scripts,
utilizando-se a funo LoadPicture para especificar o caminho e o nome do arquivo
que contm o cone personalizado (somente extenso .cur). Exemplo:
Sub CommandButton1_Click()
' Atribuindo o item 99 - fmMousePointerCustom propriedade
' para que ela aceite a customizao do cone do mouse
Screen.Item("CheckBox1").MousePointer = 99
Screen.Item("CheckBox1").MouseIcon = LoadPicture("C:\a.cur")
End Sub

4.3.2.12.2.4 MousePointer
A propriedade MousePointer especifica o tipo de ponteiro do mouse que
mostrado quando o usurio posiciona o mesmo sobre um objeto. As opes
disponveis para esta propriedade so as seguintes:
Opes disponveis para MousePointer
OPO
0 - fmMousePointerDefault
1 - fmMousePointerArrow
2 - fmMousePointerCross
3 - fmMousePointerBeam
6 - fmMousePointerSizeNesw
7 - fmMousePointerSizeNS
8 - fmMousePointerNWse
9 - fmMousePointerWE
10 - fmMousePointerUpArrow
11 - MousePointerStarHourGlassring
12 - fmMousePointerHelpNoDrop

13 - fmMousePointerAppStarting
14 - fmMousePointerHelp

Visualizao

DESCRIO
Pontei ro pa dr o. A i ma gem
determi na da pel o objeto.
Seta .
Pontei ro em forma de cruz.
Em forma de I.
Seta dupl a a ponta ndo pa ra nordes te e
s udoes te.
Seta dupl a a ponta ndo pa ra norte e s ul .
Seta dupl a a ponta ndo pa ra noroes te e
s udes te.
Seta dupl a a ponta ndo pa ra oes te e
l es te.
Seta pa ra ci ma .
Ampul heta .
Smbol o de Not (crcul o com uma l i nha
di a gona l ) na pa rte s uperi or do objeto
s endo a rra s ta do. Indi ca um des ti no de
s ol ta r i nv l i do.
Seta com uma a mpul heta .
Seta com um ponto de i nterroga o.

163

OPO
15 - fmMousePointerSizeAll

99 - fmMousePointerCustom

DESCRIO
Di mens i ona todo o curs or (s eta s
a ponta ndo pa ra norte, s ul , l es te e
oes te).
Us a o cone es peci fi ca do pel a
propri eda de MouseIcon.

Use a propriedade MousePointer para indicar alteraes de funcionalidade


conforme o ponteiro do mouse passar sobre os objetos em uma Tela. Por exemplo,
a configurao de ampulheta (opo 11) til para indicar que o usurio precisa
esperar algum tempo um processo ou operao ser finalizado. Alguns cones podem
variar, dependendo das configuraes do sistema, como os cones associados aos
temas da rea de trabalho. O valor padro desta propriedade 0 fmMousePointerDefault.

4.3.2.12.3 Caixa de Seleo


Esta seo contm informaes sobre propriedades do objeto Caixa de Seleo. Este
objeto no possui eventos nem mtodos associados.
4.3.2.12.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Caixa de Seleo.

Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora uma
tecla de atalho que, usada em conjunto com a tecla ALT, d o foco ao objeto. O
valor padro desta propriedade vazio.

Alignment
A propriedade Alignment especifica a posio do objeto relativa a sua legenda.
As opes disponveis para esta propriedade so as seguintes:
0 - fmAlignmentLeft: coloca a legenda esquerda do objeto
1 - fmAligmentRight: coloca a legenda direita do objeto

AutoSize
A propriedade AutoSize ajusta a largura do texto, caso a rea disponvel para o
mesmo ultrapasse o tamanho do objeto. Quando a propriedade estiver configurada
para True, o texto ser redimensionado para coincidir com o tamanho atual do
objeto.

BackStyle
A propriedade BackStyle define o estilo do plano de fundo para os objetos. As
opes disponveis para esta propriedade so as seguintes:
164
Visualizao

0 - fmBackStyleTransparent: define o objeto como transparente, isto , nenhum


fundo deste objeto ser desenhado
1 - fmBackStyleOpaque: define o objeto como opaco, isto , o fundo ser
desenhado (valor padro)
NOTA: Es ta propri eda de n o a feta a tra ns pa rnci a de bi tma ps . Deve-s e us a r um
edi tor de i ma gens como o Pa i ntbrus h, por exempl o, pa ra torna r um bi tma p
tra ns pa rente. Nem todos os objetos Acti veX s uporta m bi tma ps tra ns pa rentes .

Caption
Define o texto que ser mostrado no objeto.

Font
A propriedade Font utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada unicamente via Studio.

GroupName
A propriedade GroupName utilizado para criar um grupo de objetos
mutuamente exclusivos.
NOTA: Es ta propri eda de n o uti l i za da no E3 e foi ma nti da por moti vos de
compa ti bi l i da de com a es peci fi ca o pa dr o dos objetos Mi cros oft Forms .

Locked
A propriedade Locked habilita ou desabilita a edio do objeto. Se esta
propriedade estiver configurada para True, a edio no permitida. Caso
contrrio, possvel editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padro desta propriedade False.

Picture
A propriedade Picture especifica a figura (bitmap) atribuda ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: atravs da Lista de
Propriedades ou via scripts, utilizando-se a funo LoadPicture para especificar o
caminho e o nome do arquivo que contm a figura. Para remover a figura, clique no
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
espao do teclado) no remove a figura. Exemplo:
Sub CommandButton1_Click()
Screen.Item("CheckBox1").Picture = LoadPicture("C:\aba.gif")
End Sub

PicturePosition
A propriedade PicturePosition especifica a posio da figura atribuda ao objeto
Visualizao

165

em relao a sua legenda. As opes disponveis para esta propriedades so as


seguintes:
Opes disponveis para PicturePosition
OPO
0 - fmPicturePositionLeftTop

1 - fmPicturePositionLeftCenter
2 - fmPicturePositionLeftBotton
3 - fmPicturePositionRightTop
4 - fmPicturePositionRightCenter
5 - fmPicturePositionRightBotton
6 - fmPicturePositionAboveLeft
7 - fmPicturePositionAboveCenter
8 - fmPicturePositionAboveRight
9 - fmPicturePositionBelowLeft
10 - fmPicturePositionBelowCenter
11 - fmPicturePositionBelowRight

DESCRIO
A fi gura a pa rece es querda de s ua
l egenda . A l egenda a l i nha da com a
pa rte s uperi or da fi gura .
A fi gura a pa rece es querda da
l egenda . A l egenda centra l i za da
rel a ti va mente i ma gem.
A fi gura a pa rece es querda da
l egenda . A l egenda a l i nha da com a
pa rte i nferi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte
s uperi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda centra l i za da rel a ti va mente
fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte i nferi or
da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda centra l i za da a ba i xo da fi gura
(pa dr o).
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda centra l i za da a ci ma da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .

SpecialEffect
A propriedade SpecialEffect especifica a aparncia de um objeto. As opes
disponveis para esta propriedade so as seguintes:

166

Visualizao

Opes disponveis para SpecialEffect


OPO
0 - fmButtonEffectFlat
2 - fmButtonlEffectSunken

DESCRIO
O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera o de cor
ou a mbos .
O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta , como s e es ti ves s e
a funda do na Tel a .

TextAlign
Especifica como o texto alinhado no objeto. As opes disponveis so as
seguintes:
1 - fmTextAlignLeft: alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: centraliza o texto com a extremidade direita do objeto
3 - fmTextAlignRight: alinha o texto com a extremidade direita do objeto

TripleState
A propriedade TripleState determina at trs estados de valores para o objeto. Se
a propriedade estiver configurada para True, o usurio poder escolher entre trs
opes de estados: Falso, verdadeiro ou Nulo. O valor Nulo exibido como um
boto sombreado. Caso contrrio, o usurio pode escolher entre os valores False
ou True. O valor padro desta propriedade False.

Value
Indica o valor inicial do objeto. Tem comportamento Booleano; se True, o objeto
inicia marcado, do contrrio, seu estado inicial no marcado. O valor padro
desta propriedade False.

WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto.

4.3.2.12.4 Boto de Opo


Esta seo contm informaes sobre propriedades do objeto Boto de Opo. Este
objeto no possui eventos nem mtodos associados.
4.3.2.12.4.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Boto de Opo.

Visualizao

167

Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora uma
tecla de atalho que, usada em conjunto com a tecla ALT, d o foco ao objeto. O
valor padro desta propriedade vazio.

Alignment
A propriedade Alignment especifica a posio do objeto relativa a sua legenda.
As opes disponveis para esta propriedade so as seguintes:
0 - fmAlignmentLeft: coloca a legenda esquerda do objeto
1 - fmAligmentRight: coloca a legenda direita do objeto

AutoSize
A propriedade AutoSize ajusta a largura do texto, caso a rea disponvel para o
mesmo ultrapasse o tamanho do objeto. Quando a propriedade estiver configurada
para True, o texto ser redimensionado para coincidir com o tamanho atual do
objeto.

BackStyle
A propriedade BackStyle define o estilo do plano de fundo para os objetos. As
opes disponveis para esta propriedade so as seguintes:
0 - fmBackStyleTransparent: define o objeto como transparente, isto , nenhum
fundo deste objeto ser desenhado
1 - fmBackStyleOpaque: define o objeto como opaco, isto , o fundo ser
desenhado (valor padro)
NOTA: Es ta propri eda de n o a feta a tra ns pa rnci a de bi tma ps . Deve-s e us a r um
edi tor de i ma gens como o Pa i ntbrus h, por exempl o, pa ra torna r um bi tma p
tra ns pa rente. Nem todos os objetos Acti veX s uporta m bi tma ps tra ns pa rentes .

Caption
Define o texto que ser mostrado no objeto.

Font
A propriedade Font utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada unicamente via Studio.

GroupName
A propriedade GroupName utilizado para criar um grupo de objetos
mutuamente exclusivos.

168

Visualizao

NOTA: Es ta propri eda de n o uti l i za da no E3 e foi ma nti da por moti vos de


compa ti bi l i da de com a es peci fi ca o pa dr o dos objetos Mi cros oft Forms .

Locked
A propriedade Locked habilita ou desabilita a edio do objeto. Se esta
propriedade estiver configurada para True, a edio no permitida. Caso
contrrio, possvel editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padro desta propriedade False.

Picture
A propriedade Picture especifica a figura (bitmap) atribuda ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: atravs da Lista de
Propriedades ou via scripts, utilizando-se a funo LoadPicture para especificar o
caminho e o nome do arquivo que contm a figura. Para remover a figura, clique no
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
espao do teclado) no remove a figura. Exemplo:
Sub CommandButton1_Click()
Screen.Item("OptionButton1").Picture = LoadPicture("C:
\aba.gif")
End Sub

PicturePosition
A propriedade PicturePosition especifica a posio da figura atribuda ao objeto
em relao a sua legenda. As opes disponveis para esta propriedades so as
seguintes:
Opes disponveis para PicturePosition
OPO
0 - fmPicturePositionLeftTop

1 - fmPicturePositionLeftCenter
2 - fmPicturePositionLeftBotton
3 - fmPicturePositionRightTop
4 - fmPicturePositionRightCenter
5 - fmPicturePositionRightBotton

Visualizao

DESCRIO
A fi gura a pa rece es querda de s ua
l egenda . A l egenda a l i nha da com a
pa rte s uperi or da fi gura .
A fi gura a pa rece es querda da
l egenda . A l egenda centra l i za da
rel a ti va mente i ma gem.
A fi gura a pa rece es querda da
l egenda . A l egenda a l i nha da com a
pa rte i nferi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte
s uperi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda centra l i za da rel a ti va mente
fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte i nferi or
da fi gura .

169

OPO
6 - fmPicturePositionAboveLeft

7 - fmPicturePositionAboveCenter
8 - fmPicturePositionAboveRight

9 - fmPicturePositionBelowLeft
10 - fmPicturePositionBelowCenter
11 - fmPicturePositionBelowRight

DESCRIO
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda centra l i za da a ba i xo da fi gura
(pa dr o).
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda centra l i za da a ci ma da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .

SpecialEffect
A propriedade SpecialEffect especifica a aparncia de um objeto. As opes
disponveis para esta propriedade so as seguintes:
Opes disponveis para SpecialEffect
OPO
0 - fmButtonEffectFlat
2 - fmButtonlEffectSunken

DESCRIO
O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera o de cor
ou a mbos .
O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta , como s e es ti ves s e
a funda do na Tel a .

TextAlign
Especifica como o texto alinhado no objeto. As opes disponveis so as
seguintes:
1 - fmTextAlignLeft: alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: centraliza o texto com a extremidade direita do objeto
3 - fmTextAlignRight: alinha o texto com a extremidade direita do objeto

TripleState
A propriedade TripleState determina at trs estados de valores para o objeto. Se
a propriedade estiver configurada para True, o usurio poder escolher entre trs
opes de estados: Falso, Verdadeiro ou Nulo. O valor Nulo exibido como um
boto sombreado. Caso contrrio, o usurio pode escolher entre os valores False
170

Visualizao

ou True. O valor padro desta propriedade False.

Value
Indica o valor inicial do objeto. Tem comportamento Booleano; se True, o objeto
inicia marcado, do contrrio, seu estado inicial no marcado. O valor padro
desta propriedade False.

WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a True.

4.3.2.12.5 Lista de Seleo


Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Lista de Seleo.
4.3.2.12.5.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Lista de Seleo.

DropButtonClick
DropButtonClick()
Ocorre quando a Lista de Opes aparece ou desaparece ao se clicar no objeto.
4.3.2.12.5.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Lista de Seleo.

AddItem
AddItem([pvargItem[, pvargIndex]])
O mtodo AddItem utilizado para se adicionar itens a uma Lista de Seleo.
pvargItem uma String que contm o texto que ser adicionado na lista; se for
omitido, ser acrescentada uma String em branco. pvargIndex o ndice do texto na
lista; se for omitido, pvargItem adicionado como ltimo item da lista. Exemplo:
Sub CommandButton1_Click()
EntryCount = EntryCount + 1
ComboBox1.AddItem(EntryCount & " - Selection")
End Sub

Clear
Clear()
Limpa o texto do objeto.
Visualizao

171

Copy
Copy()
Copia o texto previamente selecionado para a rea de Transferncia. Utilize o
mtodo Paste para colar o texto no local indicado. Exemplo:
Sub CommandButton1_Click()
Screen.Item("ComboBox1").Copy()
End Sub

Cut
Cut()
Recorta o texto previamente selecionado para a rea de Transferncia. Utilize o
mtodo Paste para colar o texto no local indicado. Exemplo:
Sub CommandButton1_Click()
Screen.Item("ComboBox1").Cut()
End Sub

DropDown
DropDown()
O mtodo DropDown abre a lista de itens de uma Lista de Seleo. A chamada deste
mtodo tem o mesmo efeito que clicar, em tempo de execuo, no boto com a seta
ao lado direito do objeto. Exemplo:
Sub CommandButton1_Click()
Dim ComboBox1
ComboBox1.AddItem "Abacaxi"
ComboBox1.AddItem "Morango"
ComboBox1.AddItem "Uva"
ComboBox1.AddItem "Laranja"
ComboBox1.DropDown()
End Sub

Paste
Paste()
Insere no objeto o contedo da rea de Transferncia. Exemplo:
Sub CommandButton1_Click()
Screen.Item("ComboBox1").Paste()
End Sub

RemoveItem
RemoveItem(pvargIndex)
Remove itens de uma Lista ou de uma Lista de Seleo. Este mtodo possui o
parmetro pvargIndex, que especifica a linha que ser excluda, iniciando em zero.
Ou seja, o primeiro elemento 0, o segundo 1, e assim por diante. Exemplo:
Sub CommandButton2_Click()
ComboBox1.SetFocus

172

Visualizao

' Verifica se a lista contm dados selecionados


If ComboBox1.ListCount >= 1 Then
' Se no h nenhuma seleo, escolher o ltimo dado da
lista.
If ComboBox1.ListIndex = -1 Then
ComboBox1.ListIndex = ComboBox1.ListCount 1
End If
ComboBox1.RemoveItem(ComboBox1.ListIndex)
End If
End Sub

4.3.2.12.5.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Lista de Seleo.

AutoSize
A propriedade AutoSize ajusta a largura do texto, caso a rea disponvel
ultrapasse o tamanho do objeto. Para o objeto Lista de Seleo (Combo Box),
quando a propriedade estiver configurada para True, a largura do texto
reajustada para a mesma do objeto.

AutoTab
A propriedade AutoTab habilita ou desabilita a tabulao automtica no objeto.
Se a propriedade estiver configurada para True, a tabulao automtica ocorre.
Caso contrrio, no utilizada.
Aps o usurio digitar o nmero mximo de caracteres em um objeto (utilizando a
propriedade MaxLength), o foco se move automaticamente para o prximo objeto
da ordem de tabulao, quando estes caracteres forem atingidos. Por exemplo,
para que uma Lista de Seleo exiba dados de estoque que possuam sempre cinco
caracteres, pode-se usar a propriedade MaxLength para especificar o nmero
mximo de caracteres a serem introduzidos no objeto e a propriedade AutoTab
para tabular automaticamente para o prximo objeto depois que o usurio digitar
cinco caracteres.

AutoWordSelect
Habilita ou desabilita a seleo automtica de palavras no objeto. Se esta
propriedade estiver configurada para True, a palavra indicada selecionada no
texto mais o espao seguinte, caso se tenha selecionado parte dela. Caso contrrio,
somente o caractere indicado na palavra selecionado.

BackStyle
A propriedade BackStyle define o estilo do plano de fundo para os objetos. As
opes disponveis para esta propriedade so as seguintes:
0 - fmBackStyleTransparent: define o objeto como transparente, isto , nenhum
fundo deste objeto ser desenhado
Visualizao

173

1 - fmBackStyleOpaque: define o objeto como opaco, isto , o fundo ser


desenhado (valor padro)
NOTA: Es ta propri eda de n o a feta a tra ns pa rnci a de bi tma ps . Deve-s e us a r um
edi tor de i ma gens como o Pa i ntbrus h, por exempl o, pa ra torna r um bi tma p
tra ns pa rente. Nem todos os objetos Acti veX s uporta m bi tma ps tra ns pa rentes .

BorderColor
Esta propriedade determina a cor da borda que ser aplicada no objeto. Com
esta propriedade, possvel aplicar a cor padro ou personaliz-la atravs da sua
edio. Para que esta propriedade seja aplicvel, necessrio que a propriedade
BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padro desta
propriedade preto (RGB(0, 0, 0)).

BorderStyle
A propriedade BorderStyle determina o estilo de borda que ser aplicada ao
objeto. As opes disponveis so:
0 - fmBorderStyleNone: sem borda
1 - fmBorderStyleSingle: com borda simples

BoundColumn
Determina a coluna da lista onde os dados sero armazenados. Por exemplo, se
cada linha contm oito itens e a propriedade BoundColumn 3, o sistema
armazena as informaes na terceira coluna da linha atualmente selecionada. Se o
valor for igual a 0, este valor passado para a propriedade ListIndex do objeto. Se
o valor for 1 ou superior, o dado indicado atribudo coluna referente ao valor
especificado na propriedade. As colunas so numeradas a partir de 1.
NOTA: Es ta propri eda de n o tem efei to no E3 e foi ma nti da por moti vos de
compa ti bi l i da de com a es peci fi ca o pa dr o dos objetos Mi cros oft Forms .

CanPaste
A propriedade CanPaste especifica se a rea de Transferncia contm os dados
aos quais o objeto d suporte. Se a opo estiver configurada para True, o objeto
pode receber informaes coladas da rea de Transferncia. Se os dados da rea
de Transferncia estiverem em um formato ao qual o objeto no d suporte, a
propriedade CanPaste ser False. Por exemplo, ao tentar colar um bitmap em um
objeto que s d suporte a texto, CanPaste ser False. Esta propriedade acessvel
apenas em tempo de execuo.

Column
Especifica a linha e a coluna no objeto. Se for especificado somente o valor de
coluna, a propriedade Column l ou escreve a coluna especificada na linha atual
174

Visualizao

do objeto. Por exemplo, MinhaListadeSelecao.Column(3) l ou escreve a


terceira coluna do objeto. Esta propriedade acessvel apenas em tempo de
execuo.

ColumnCount
A propriedade ColumnCount especifica o nmero de colunas do objeto. A
configurao de ColumnCount como 0 no exibe nenhuma coluna, e a configurao
desta propriedade como -1 exibe todas as colunas disponveis. O valor padro
desta propriedade 1.

ColumnHeads
A propriedade ColumnHeads habilita ou desabilita a exibio do ttulo das
colunas no objeto. Se a propriedade estiver configurada para True, o ttulo
mostrado. Caso contrrio, o ttulo das colunas no mostrado. O valor padro
False.

ColumnWidths
A propriedade ColumnWidths utilizada para especificar a largura da coluna
do objeto, em pontos. Um valor igual a 1 ou em branco faz com que a largura seja
calculada na coluna (a largura mnima de uma coluna calculada 72 pontos, ou 1
polegada). Um valor igual a 0 oculta a coluna. Para produzir colunas mais
estreitas, deve-se especificar a largura na propriedade ou utilizar alguma dos
valores a seguir:
Opes disponveis para ColumnWidths
OPO
90;72;90

6 cm;0;6 cm

1,5 pol;0;2,5 pol


2 pol;;2 pol

Visualizao

DESCRIO
A pri mei ra col una pos s ui 90 pontos (1,25
pol ega da ); a s egunda col una pos s ui 72
pontos (1 pol ega da ); a tercei ra col una
pos s ui 90 pontos .
A pri mei ra col una pos s ui 6 centmetros ; a
s egunda col una es t ocul ta ; a tercei ra
col una pos s ui 6 centmetros . Como pa rte
da tercei ra col una vi s vel , uma ba rra de
rol a gem hori zonta l a pa rece.
A pri mei ra col una pos s ui 1,5 pol ega da s ,
a s egunda col una es t ocul ta , e a
tercei ra col una pos s ui 2,5 pol ega da s .
A pri mei ra col una pos s ui 2 pol ega da s , a
s egunda col una pos s ui 1 pol ega da
(pa dr o) e a tercei ra col una pos s ui 2
pol ega da s . Como s omente meta de da
tercei ra col una vi s vel , uma ba rra de
rol a gem hori zonta l a pa rece.

175

OPO
(Vazio)

DESCRIO
Toda s a s trs col una s pos s uem a mes ma
l a rgura (1,33 pol ega da s ). O va l or pa dr o
des ta propri eda de va zi o (o E3 i r
uti l i za r o va l or pa dr o do s i s tema ).

CurTargetX
Retorna a posio horizontal de insero de um texto no objeto. Esta posio
medida em unidades himtricas (um himetro igual a 0,0001 de um metro). Pode-se
usar CurTargetX e CurX para mover o ponto de insero de um texto conforme o
usurio percorre o contedo do objeto. Quando o usurio move o ponto de
insero para outra linha do texto, a propriedade CurTargetX especifica a posio
mais indicada para o ponto de insero do texto desejado. A propriedade CurX
definida neste valor, se a linha do texto for maior que o valor de CurTargetX. Caso
contrrio, a propriedade CurX definida como o final da linha do texto. Esta
propriedade acessvel apenas em tempo de execuo.
NOTA: Es ta propri eda de n o tem efei to no E3 e foi ma nti da por moti vos de
compa ti bi l i da de com a es peci fi ca o pa dr o dos objetos Mi cros oft Forms .

CurX
A propriedade CurX especifica a posio atual horizontal do ponto de insero no
objeto. Esta propriedades aplicada em um objeto que possua vrias linhas, isto ,
a propriedade Multiline est habilitada. O valor de retorno vlido quando o
objeto possui o foco. Pode-se usar a propriedade Multiline e a propriedade CurX
para posicionar o ponto de insero do texto conforme o usurio usa a barra de
rolagem pelo contedo do objeto. Quando o usurio move o ponto de insero para
uma outra linha de texto rolando o contedo do objeto, a propriedade CurTargetX
especifica a posio desejada para o ponto de insero. A propriedade CurX
definida com este valor se a linha de texto for maior do que o valor de CurTargetX.
Caso contrrio, CurX definido no fim da linha de texto. Esta propriedade
acessvel apenas em tempo de execuo.

DragBehavior
Habilita ou desabilita o recurso de arrastar e soltar um texto no contedo do
objeto. As opes disponveis para esta propriedade so as seguintes:
0 - fmDragBehaviorDisabled: no permite a ao de arrastar e soltar o texto no
contedo do objeto
1 - fmDragBehaviorEnabled: permite a ao de arrastar e soltar o texto no
contedo do objeto
O valor padro desta propriedade 0 - fmDragBehaviorDisabled.

176

Visualizao

NOTA: A propri eda de DragBehavior n o tem efei to s e a propri eda de Style es ti ver
confi gura da pa ra 2 - fmStyleDropDownList.

DropButtonStyle
Esta propriedade especifica o smbolo exibido no boto da Lista de Seleo. As
opes disponveis para esta propriedade so as seguintes:
Opes disponveis para DropButtonStyle
OPO
0 - fmDropButtonStylePlain
1 - fmDropButtonStyleArrow
2 - fmDropButtonStyleEllipsis
3 - fmDropButtonStyleReduce

DESCRIO
Exi be um bot o pl a no, s em s mbol o.
Exi be um s eta pa ra ba i xo (pa dr o).
Exi be reti cnci a s .
Exi be uma reta hori zonta l como um
ca ra ctere s ubl i nha do.

O valor padro desta propriedade 1 - fmDropButtonStyleArrow.

EnterFieldBehavior
Esta propriedade controla a forma como o contedo do texto selecionado na
rea de edio quando se pressiona a tecla TAB no objeto, e no quando o objeto
recebe o foco como um resultado do mtodo SetFocus. As opes disponveis para
esta propriedade so as seguintes:
0 - fmEnterFieldBehaviorSelectAll: seleciona todo o contedo do texto quando a
tecla TAB pressionada no objeto
1 - fmEnterFieldBehaviorRecallSelection: deixa a seleo inalterada
O valor padro desta propriedade 0 - fmEnterFieldBehaviorSelectAll.

Font
A propriedade Font utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada unicamente via Studio.

HideSelection
A propriedade HideSelection especifica se o texto selecionado continua em
destaque quando um objeto no tiver mais o foco. Se a propriedade estiver
configurada para True, o texto selecionado somente se mantm em destaque caso o
objeto tenha o foco. Caso contrrio, o texto selecionado sempre aparece em
destaque, independente do foco no objeto. O valor padro desta propriedade
True.

IMEMode
A propriedade IMEMode especifica o modo IME (Input Method Editor) de um
Visualizao

177

objeto.
NOTA: Es s a propri eda de a pl i ca -s e a pena s em a pl i ca ti vos es cri tos em i di oma s
a s i ti cos (chi ns s i mpl i fi ca do, chi ns tra di ci ona l , corea no e ja pons ) e i gnora da
em outros a pl i ca ti vos . Foi ma nti da por moti vos de compa ti bi l i da de com a
es peci fi ca o pa dr o dos objetos Mi cros oft Forms .

As opes disponveis so as seguintes:


Opes disponveis para IMEMode
OPO
0 - fmIMEModeNoControl
1 - fmIMEModeOn
2 - fmIMEModeOff
3 - fmIMEModeDisable
4 - fmIMEModeHiragana
5 - fmIMEModeKatakanaFull
6 - fmIMEModeKatakana
7 - fmIMEModeAlphaFull
8 - fmIMEModeAlpha
9 - fmIMEModeHangulFull
10 - fmIMEModeHangul
11 - fmIMEModeHanziFull
12 - fmIMEModeHanzi

DESCRIO
N o control a IME (pa dr o).
IME a ti va do.
IME des a ti va do. Modo i ngl s .
IME des a ti va do. O us u ri o n o pode
a ti va r IME pel o tecl a do.
IME a ti va do com modo Hi ra ga na de
l a rgura tota l .
IME a ti va do com modo Ka ta ka na de
l a rgura tota l .
IME a ti va do com modo Ka ta ka na de mei a
l a rgura .
IME a ti va do com modo Al fa numri co de
l a rgura tota l .
IME a ti va do com modo Al fa numri co de
mei a l a rgura .
IME a ti va do com modo Ha ngul de l a rgura
tota l .
IME a ti va do com modo Ha ngul de mei a
l a rgura .
IME a ti va do com modo Ha nzi de l a rgura
tota l .
IME a ti va do com modo Ha nzi de mei a
l a rgura .

LineCount
A propriedade LineCount retorna o nmero de linhas do objeto. Esta propriedade
acessvel apenas em tempo de execuo.

List
Retorna ou define as entradas da linha e da coluna na lista do objeto. A
numerao de linha e de coluna comea com zero. Isto , o nmero de linha da
primeira linha na lista zero; o nmero de coluna da primeira coluna zero. O
nmero da segunda linha ou coluna 1 e assim por diante. Esta propriedade
acessvel apenas em tempo de execuo.
178

Visualizao

ListCount
Retorna o nmero de itens contidos na lista do objeto. Esta propriedade
acessvel apenas em tempo de execuo.

ListIndex
Identifica o item atualmente selecionado na lista, chamado de ndice. Os valores
de ListIndex vo de 1 ao nmero total de linhas em uma lista menos um (isto ,
ListCount 1). Quando nenhuma linha selecionada, ListIndex retorna 1. Quando
o usurio seleciona uma linha em uma Lista de Seleo, o sistema define o valor da
propriedade ListIndex. O valor da propriedade ListIndex da primeira linha de uma
lista 0, o valor da segunda linha 1 e assim por diante. Esta propriedade
acessvel apenas em tempo de execuo.

ListRows
A propriedade ListRows determina o nmero mximo de linhas na lista do objeto.
O valor padro desta propriedade 8.

ListStyle
A propriedade ListStyle determina o estilo da lista do objeto. As opes
disponveis para esta propriedade so as seguintes:
0 - fmListStylePlain: listagem com os itens do plano de fundo em destaque
1 - fmListStyleOption: exibe botes de opo ou caixas de seleo para uma lista
de vrias opes. Quando o usurio seleciona um item do grupo, o boto de
opo associado ao item selecionado e os botes de opo para outros itens
no grupo so desmarcados
O valor padro desta propriedade 0 - fmListStylePlain.

ListWidth
A propriedade ListWidth determina a largura da lista do objeto. O valor padro
desta propriedade 0.

Locked
A propriedade Locked habilita ou desabilita a edio do objeto. Se esta
propriedade estiver configurada para True, a edio no permitida. Caso
contrrio, possvel editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padro desta propriedade False.

MatchEntry
Procura, atravs do texto digitado pelo usurio, por uma entrada de texto que
coincida com os dados existentes no objeto. Ao encontrar uma incidncia do texto,
a linha contendo a mesma selecionada e o contedo da coluna exibido.
Visualizao

179

As opes disponveis so as seguintes:


0 - fmMatchEntryFirstLetter: procura pela entrada de texto que coincida com o
primeiro caractere digitado no objeto. Se for digitada repetidamente a mesma
letra, passada para a prxima entrada de texto que comece com esta letra e
assim por diante
1 - fmMatchEntryComplete: conforme cada caractere digitado, o objeto procura
por uma entrada de texto que coincida com os caracteres digitados
2 - fmMatchEntryNone: no faz a procura no objeto
O valor padro desta propriedade 1 - fmMatchEntryComplete.

MatchFound
Indica se o texto que o usurio digitou no objeto coincide com qualquer entrada
na lista. Se a propriedade estiver configurada para True, o contedo da
propriedade Value coincide com um dos registros na lista. Caso contrrio, o
contedo da propriedade Value no coincide com nenhum dos registros na lista
(padro).
Esta propriedade acessvel apenas em tempo de execuo, no sendo aplicvel
quando a propriedade MatchEntry definida como 2. O valor padro desta
propriedade False.

MatchRequired
Especifica se o texto digitado deve ou no coincidir com os itens existente na
Lista de Seleo. Se a propriedade estiver configurada para True, o usurio no
pode sair da Lista de Seleo at que o texto inserido coincida com um item
existente do objeto. Caso contrrio, o texto inserido na Lista de Seleo pode ser
diferente de todos os dados existente na Lista.

MaxLength
A propriedade MaxLength determina o nmero mximo de caracteres no objeto.
Configurando esta propriedade como 0, no h limite de caracteres no objeto.

SelectionMargin
Habilita ou desabilita a margem de seleo do objeto. Se esta propriedade estiver
configurada para True, o texto ser selecionado ao se clicar na margem do objeto.
Caso contrrio, o texto no ser selecionado ao se clicar na margem.
NOTA: Se a propri eda de SelectionMargin es ti ver confi gura da pa ra True qua ndo o
objeto for i mpres s o, a ma rgem de s el e o ta mbm s er i mpres s a .

SelLength
Retorna o nmero de caracteres selecionados no objeto. Esta propriedade
180

Visualizao

acessvel apenas em tempo de execuo.

SelStart
Indica o ponto inicial do texto selecionado ou o ponto de insero se nenhum
texto for selecionado. Esta propriedade acessvel apenas em tempo de execuo.

SelText
Retorna o texto selecionado no objeto. Esta propriedade acessvel apenas em
tempo de execuo.

ShowDropButtonWhen
A propriedade ShowDropButtonWhen especifica quando mostrar o boto
suspenso (tecla de navegao do objeto). As opes disponveis para esta
propriedade so as seguintes:
0 - fmShowDropButtonWhenNever: no mostra o boto suspenso em nenhuma
circunstncia
1 - fmShowDropButtonWhenFocus: mostra o boto suspenso quando o objeto
possui o foco
2 - fmShowDropButtonWhenAlways: sempre mostra o boto suspenso

SpecialEffect
A propriedade SpecialEffect especifica a aparncia de um objeto. As opes
disponveis para esta propriedade so as seguintes:
Opes disponveis para SpecialEffect
OPO
0 - fmSpecialEffectFlat
1 - fmSpecialEffectRaised

2 - fmSpecialEffectSunken

3 - fmSpecialEffectEtched
6 - fmSpecialEffectBump

Visualizao

DESCRIO
O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera o de cor
ou a mbos .
O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta , como s e es ti ves s e
em rel evo.
O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda a pa recem a funda dos na Tel a .
A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .

181

Style
Determina o estilo do objeto. As opes disponveis so as seguintes:
0 - fmStyleDropDownCombo: a lista de seleo se comporta como uma caixa de
combinao suspensa. O usurio pode digitar um valor na regio de edio ou
selecionar um valor da lista suspensa (padro)
2 - fmStyleDropDownList: a Lista de seleo se comporta como uma caixa de
listagem. O usurio deve escolher um valor da lista

Text
Retorna o texto da opo selecionada. Esta propriedade acessvel apenas em
tempo de execuo.

TextAlign
Especifica como o texto alinhado no objeto. As opes disponveis so as
seguintes:
1 - fmTextAlignLeft: alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: centraliza o texto com o centro do objeto
3 - fmTextAlignRight: alinha o texto com a extremidade direita do objeto

TextColumn
A propriedade TextColumn identifica a coluna no objeto. Os valores para a
propriedade TextColumn vo de -1 ao nmero de colunas na lista. O valor
TextColumn para a primeira coluna 1, o valor da segunda coluna 2, e assim por
diante. A configurao de TextColumn como 0 exibe os valores para a propriedade
ListIndex. A configurao de TextColumn como -1 exibe a primeira coluna que
possui o valor da propriedade ColumnWidths maior do que 0.

TextLength
Retorna o nmero de caracteres digitados no objeto. Esta propriedade acessvel
apenas em tempo de execuo.

TopIndex
A propriedade TopIndex define ou retorna o item da lista que aparece na posio
mais prxima do topo na lista. Esta propriedade retorna o valor -1 se a lista est
vazia ou no exibida.

Value
o valor da propriedade BoundColumn das linhas atualmente selecionadas. Uma
mudana de valor na propriedade Value no implica em mudana de valor na
propriedade BoundColumn. Para adicionar ou apagar entradas em uma lista de
seleo, pode-se usar os mtodos AddItem ou RemoveItem.
182

Visualizao

4.3.2.12.6 Boto de Comando


Esta seo contm informaes sobre eventos e propriedades do objeto Boto de
Comando. Este objeto no possui mtodos associados.
4.3.2.12.6.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Boto de Comando.

MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse movimentado sobre o boto de comando.
4.3.2.12.6.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Boto de
Comando.

Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora uma
tecla de atalho que usada em conjunto com a tecla ALT, d o foco ao objeto. O valor
padro desta propriedade uma String vazia.

AutoSize
A propriedade AutoSize ajusta a largura do texto, caso a rea disponvel
ultrapasse o tamanho do objeto. Para o objeto Boto de Comando (Command
Button), quando a propriedade estiver configurada para True, a largura do texto
reajustada para a mesma do objeto. O contedo do texto cortado quando ele
excede a rea do objeto.

BackStyle
A propriedade BackStyle define o estilo do plano de fundo para os objetos. As
opes disponveis para esta propriedade so as seguintes:
0 - fmBackStyleTransparent: define o objeto como transparente, isto , nenhum
fundo deste objeto ser desenhado
1 - fmBackStyleOpaque: define o objeto como opaco, isto , o fundo ser
desenhado (valor padro)
NOTA: Es ta propri eda de n o a feta a tra ns pa rnci a de bi tma ps . Deve-s e us a r um
edi tor de i ma gens como o Pa i ntbrus h, por exempl o, pa ra torna r um bi tma p
tra ns pa rente. Nem todos os objetos Acti veX s uporta m bi tma ps tra ns pa rentes .

Visualizao

183

Caption
Define o texto que ser mostrado no objeto.

Font
A propriedade Font utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada unicamente via Studio.

Locked
A propriedade Locked habilita ou desabilita a edio do objeto. Se esta
propriedade estiver configurada para True, a edio no permitida. Caso
contrrio, possvel editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padro desta propriedade False.

Picture
A propriedade Picture especifica a figura (bitmap) atribuda ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: atravs da Lista de
Propriedades ou via scripts, utilizando-se a funo LoadPicture para especificar o
caminho e o nome do arquivo que contm a figura. Para remover a figura, clique no
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
espao do teclado) no remove a figura.

PicturePosition
A propriedade PicturePosition especifica a posio da figura atribuda ao objeto
em relao a sua legenda. As opes disponveis para esta propriedades so as
seguintes:
Opes disponveis para PicturePosition
OPO
0 - fmPicturePositionLeftTop

1 - fmPicturePositionLeftCenter
2 - fmPicturePositionLeftBottom
3 - fmPicturePositionRightTop
4 - fmPicturePositionRightCenter

184

DESCRIO
A fi gura a pa rece es querda de s ua
l egenda . A l egenda a l i nha da com a
pa rte s uperi or da fi gura .
A fi gura a pa rece es querda da
l egenda . A l egenda centra l i za da
rel a ti va mente i ma gem.
A fi gura a pa rece es querda da
l egenda . A l egenda a l i nha da com a
pa rte i nferi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte
s uperi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda centra l i za da rel a ti va mente
fi gura .

Visualizao

OPO
5 - fmPicturePositionRightBottom

6 - fmPicturePositionAboveLeft
7 - fmPicturePositionAboveCenter

8 - fmPicturePositionAboveRight
9 - fmPicturePositionBelowLeft
10 - fmPicturePositionBelowCenter
11 - fmPicturePositionBelowRight

DESCRIO
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte i nferi or
da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda centra l i za da a ba i xo da fi gura
(pa dr o).
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda centra l i za da a ci ma da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .

TakeFocusOnClick
Especifica se o objeto recebe o foco quando clicado. Se a propriedade estiver
configurada para True, o objeto recebe o foco quando clicado. Caso contrrio, o
objeto no recebe o foco.

WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto.

4.3.2.12.7 Texto
Esta seo contm informaes sobre propriedades do objeto Texto. Este objeto no
possui eventos nem mtodos associados.
4.3.2.12.7.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Texto.

Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora uma
tecla de atalho que usada em conjunto com a tecla ALT, d o foco ao objeto. O valor
padro desta propriedade uma String vazia.

AutoSize
A propriedade AutoSize ajusta a largura do texto, caso a rea disponvel
Visualizao

185

ultrapasse o tamanho do objeto. Para o objeto Texto (Label), quando a propriedade


estiver configurada para True, o texto redimensionado para coincidir com o
tamanho atual do objeto, permitindo assim a sua exibio completa.

BackStyle
A propriedade BackStyle define o estilo do plano de fundo para os objetos. As
opes disponveis para esta propriedade so as seguintes:
0 - fmBackStyleTransparent: define o objeto como transparente, isto , nenhum
fundo deste objeto ser desenhado
1 - fmBackStyleOpaque (valor padro): define o objeto como opaco, isto , o fundo
ser desenhado
NOTA: Es ta propri eda de n o a feta a tra ns pa rnci a de bi tma ps . Deve-s e us a r um
edi tor de i ma gens como o Pa i ntbrus h, por exempl o, pa ra torna r um bi tma p
tra ns pa rente. Nem todos os objetos Acti veX s uporta m bi tma ps tra ns pa rentes .

BorderColor
Esta propriedade determina a cor da borda que ser aplicada no objeto. Com
esta propriedade, possvel aplicar a cor padro ou personaliz-la atravs da sua
edio. Para que esta propriedade seja aplicvel, necessrio que a propriedade
BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padro desta
propriedade preto (RGB(0, 0, 0)).

BorderStyle
A propriedade BorderStyle determina o estilo de borda que ser aplicada ao
objeto. As opes disponveis so:
0 - fmBorderStyleNone: sem borda
1 - fmBorderStyleSingle: com borda simples

Caption
Define o texto que ser mostrado no objeto.

Font
A propriedade Font utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada unicamente via Studio.

Picture
A propriedade Picture especifica a figura (bitmap) atribuda ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: atravs da Lista de
Propriedades ou via scripts, utilizando-se a funo LoadPicture para especificar o
caminho e o nome do arquivo que contm a figura. Para remover a figura, clique o
186

Visualizao

valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de


espao do teclado) no remove a figura.

PicturePosition
A propriedade PicturePosition especifica a posio da figura atribuda ao objeto
em relao a sua legenda. As opes disponveis para esta propriedades so as
seguintes:
Opes disponveis para PicturePosition
OPO
0 - fmPicturePositionLeftTop
1 - fmPicturePositionLeftCenter
2 - fmPicturePositionLeftBottom
3 - fmPicturePositionRightTop

4 - fmPicturePositionRightCenter
5 - fmPicturePositionRightBottom
6 - fmPicturePositionAboveLeft
7 - fmPicturePositionAboveCenter
8 - fmPicturePositionAboveRight
9 - fmPicturePositionBelowLeft
10 - fmPicturePositionBelowCenter
11 - fmPicturePositionBelowRight

DESCRIO
A fi gura a pa rece es querda de s ua
l egenda . A l egenda a l i nha da com a
pa rte s uperi or da fi gura .
A fi gura a pa rece es querda da
l egenda . A l egenda centra l i za da
rel a ti va mente i ma gem.
A fi gura a pa rece es querda da
l egenda . A l egenda a l i nha da com a
pa rte i nferi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte
s uperi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda centra l i za da rel a ti va mente
fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte i nferi or
da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda centra l i za da a ba i xo da fi gura
(pa dr o).
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda centra l i za da a ci ma da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .

SpecialEffect
A propriedade SpecialEffect especifica a aparncia de um objeto. As opes
Visualizao

187

disponveis para esta propriedade so as seguintes:


Opes disponveis para SpecialEffect
OPO
0 - fmSpecialEffectFlat
1 - fmSpecialEffectRaised

2 - fmSpecialEffectSunked

3 - fmSpecialEffectEtched
6 - fmSpecialEffectBump

DESCRIO
O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera o de cor
ou a mbos .
O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta . O objeto pa rece
es ta r em rel evo.
O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda pa recem es ta r a funda dos na Tel a .
A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .

TextAlign
Especifica como o texto alinhado no objeto. As opes disponveis so as
seguintes:
1 - fmTextAlignLeft: alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: centraliza o texto com a extremidade direita do objeto
3 - fmTextAlignRight: alinha o texto com a extremidade direita do objeto

WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a True.

4.3.2.12.8 Lista
Esta seo contm informaes sobre mtodos e propriedades do objeto Lista. Este
objeto no possui eventos associados.
4.3.2.12.8.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Lista.

AddItem
AddItem([pvargItem[, pvargIndex]])
188

Visualizao

O mtodo AddItem utilizado para se adicionar itens a uma Lista. O parmetro


pvargItem uma String que contm o texto que ser adicionado lista; se for
omitido, ser acrescentado uma String em branco. O parmetro pvargIndex o
ndice do texto na lista; se for omitido, pvargItem adicionado como ltimo item da
lista. Exemplo:
Sub CommandButton1_Click()
EntryCount = EntryCount + 1
ListBox1.AddItem(EntryCount & " - Selection")
End Sub

Clear
Clear()
Limpa o texto do objeto.

RemoveItem
RemoveItem(pvargIndex)
Remove itens da Lista. Este mtodo possui o parmetro pvargIndex, que especifica a
linha que ser excluda, iniciando em zero. Ou seja, o primeiro elemento 0, o
segundo 1, e assim por diante. Exemplo:
Sub CommandButton2_Click()
List1.SetFocus
' Verifica se a lista contm dados selecionados
If List1.ListCount >= 1 Then
' Se no h nenhuma seleo, escolher o ltimo dado da
lista.
If List1.ListIndex = -1 Then
List1.ListIndex = List1.ListCount 1
End If
List1.RemoveItem(List1.ListIndex)
End If
End Sub

4.3.2.12.8.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Lista.

BorderColor
Esta propriedade determina a cor da borda que ser aplicada no objeto. Com
esta propriedade, possvel aplicar a cor padro ou personaliz-la atravs da sua
edio. Para que esta propriedade seja aplicvel, necessrio que a propriedade
BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padro desta
propriedade preto (RGB(0, 0, 0)).

BorderStyle
A propriedade BorderStyle determina o estilo de borda que ser aplicada ao
objeto. As opes disponveis so:
Visualizao

189

0 - fmBorderStyleNone: sem borda


1 - fmBorderStyleSingle: com borda simples

BoundColumn
Determina a coluna da lista onde os dados sero armazenados. Por exemplo, se
cada linha contm oito itens e a propriedade BoundColumn 3, o sistema
armazena as informaes na terceira coluna da linha atualmente selecionada. Se o
valor for igual a 0, este valor passado para a propriedade ListIndex do objeto. Se
o valor for 1 ou superior, o dado indicado atribudo coluna referente ao valor
especificado na propriedade. As colunas so numeradas a partir de 1.
NOTA: Es ta propri eda de n o tem efei to no E3 e foi ma nti da por moti vos de
compa ti bi l i da de com a es peci fi ca o pa dr o dos objetos Mi cros oft Forms .

Column
Especifica a linha e coluna no objeto. Se for especificado somente o valor de
coluna, a propriedade Column l ou escreve a coluna especificada na linha atual
do objeto. Por exemplo, MinhaListadeSelecao.Column(3) l ou escreve a
terceira coluna do objeto. Esta propriedade acessvel apenas em tempo de
execuo.

ColumnCount
A propriedade ColumnCount especifica o nmero de colunas do objeto. A
configurao de ColumnCount como 0 no exibe nenhuma coluna, e a configurao
desta propriedade como -1 exibe todas as colunas disponveis. O valor padro
desta propriedade 1.

ColumnHeads
A propriedade ColumnHeads habilita ou desabilita a exibio do ttulo das
colunas no objeto. Se a propriedade estiver configurada para True, o ttulo
mostrado. Caso contrrio, o ttulo das colunas no mostrado. O valor padro
False.

ColumnWidths
A propriedade ColumnWidths utilizada para especificar a largura da coluna do
objeto, em pontos. Um valor igual a -1 ou em branco faz com que a largura seja
calculada na coluna (a largura mnima de uma coluna calculada 72 pontos, ou 1
polegada). Um valor igual a 0 (zero) oculta a coluna. Para produzir colunas mais
estreitas, deve-se especificar a largura na propriedade ou utilizar alguma dos
valores a seguir:

190

Visualizao

Opes disponveis para ColumnWidths


OPO
90;72;90

6 cm;0;6 cm

1,5 pol;0;2,5 pol


2 pol;;2 pol

(Vazio)

DESCRIO
A pri mei ra col una pos s ui 90 pontos (1,25
pol ega da ); a s egunda col una pos s ui 72
pontos (1 pol ega da ); a tercei ra col una
pos s ui 90 pontos .
A pri mei ra col una pos s ui 6 centmetros ; a
s egunda col una es t ocul ta ; a tercei ra
col una pos s ui 6 centmetros . Como pa rte
da tercei ra col una vi s vel , uma ba rra de
rol a gem hori zonta l a pa rece.
A pri mei ra col una pos s ui 1,5 pol ega da s ,
a s egunda col una es t ocul ta , e a
tercei ra col una pos s ui 2,5 pol ega da s .
A pri mei ra col una pos s ui 2 pol ega da s , a
s egunda col una pos s ui 1 pol ega da
(pa dr o) e a tercei ra col una pos s ui 2
pol ega da s . Como s omente meta de da
tercei ra col una vi s vel , uma ba rra de
rol a gem hori zonta l a pa rece.
Toda s a s trs col una s pos s uem a mes ma
l a rgura (1,33 pol ega da s ). O va l or pa dr o
des ta propri eda de va zi o (o E3 i r
uti l i za r o va l or pa dr o do s i s tema ).

Font
A propriedade Font utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada unicamente via Studio.

IMEMode
A propriedade IMEMode especifica o modo IME (Input Method Editor) de um
objeto. Essa propriedade aplica-se apenas em aplicativos escritos em idiomas
asiticos (chins simplificado, chins tradicional, coreano e japons) e ignorada
em outros aplicativos. Ela no tem efeito no E3 e foi mantida por motivos de
compatibilidade com a especificao padro dos objetos Microsoft Forms. As
opes disponveis so as seguintes:
Opes disponveis para IMEMode
OPO
0 - fmIMEModeNoControl
1 - fmIMEModeOn
2 - fmIMEModeOff
3 - fmIMEModeDisable
4 - fmIMEModeHiragana

Visualizao

DESCRIO
N o control a IME (pa dr o).
IME a ti va do.
IME des a ti va do. Modo i ngl s .
IME des a ti va do. O us u ri o n o pode
a ti va r IME pel o tecl a do.
IME a ti va do com modo Hi ra ga na de
l a rgura tota l .

191

OPO
5 - fmIMEModeKatakanaFull
6 - fmIMEModeKatakana
7 - fmIMEModeAlphaFull
8 - fmIMEModeAlpha
9 - fmIMEModeHangulFull
10 - fmIMEModeHangul
11 - fmIMEModeHanziFull
12 - fmIMEModeHanzi

DESCRIO
IME a ti va do com modo Ka ta ka na de
l a rgura tota l .
IME a ti va do com modo Ka ta ka na de mei a
l a rgura .
IME a ti va do com modo Al fa numri co de
l a rgura tota l .
IME a ti va do com modo Al fa numri co de
mei a l a rgura .
IME a ti va do com modo Ha ngul de l a rgura
tota l .
IME a ti va do com modo Ha ngul de mei a
l a rgura .
IME a ti va do com modo Ha nzi de l a rgura
tota l .
IME a ti va do com modo Ha nzi de mei a
l a rgura .

IntegralHeight
A propriedade IntegralHeight ajusta a altura da rea de edio do texto, caso a
rea disponvel ultrapasse o tamanho do objeto. Se esta propriedade estiver
configurada para True, a altura da rea de edio do texto reajustada para
coincidir com o tamanho atual do objeto, permitindo assim a exibio completa do
contedo do texto. Caso contrrio, a rea de edio do texto continua com seu
tamanho original. Se os textos so maiores que o espao disponvel, este no
exibido no objeto.

List
Retorna ou define as entradas da linha e da coluna na lista do objeto. A
numerao de linha e de coluna comea com zero. Isto , o nmero de linha da
primeira linha na lista zero; o nmero de coluna da primeira coluna zero. O
nmero da segunda linha ou coluna 1, e assim por diante. Esta propriedade
acessvel apenas em tempo de execuo.

ListCount
Retorna o nmero de itens contidos na lista do objeto. Esta propriedade
acessvel apenas em tempo de execuo.

ListIndex
Identifica o item atualmente selecionado na lista, chamado de ndice. Os valores
de ListIndex vo de -1 ao nmero total de linhas em uma lista menos um (isto ,
ListCount - 1). Quando nenhuma linha selecionada, ListIndex retorna -1. Quando o
usurio seleciona uma linha em uma Lista de Seleo, o sistema define o valor da
propriedade ListIndex. O valor da propriedade ListIndex da primeira linha de uma
lista 0, o valor da segunda linha 1, e assim por diante. Esta propriedade
acessvel apenas em tempo de execuo.
192

Visualizao

ListStyle
A propriedade ListStyle determina o estilo da lista do objeto. As opes
disponveis para esta propriedade so as seguintes:
0 - fmListStylePlain: listagem com os itens do plano de fundo em destaque
1 - fmListStyleOption: exibe botes de opo ou caixas de seleo para uma lista
de vrias opes. Quando o usurio seleciona um item do grupo, o boto de
opo associado ao item selecionado e os botes de opo para outros itens
no grupo so desmarcados
O valor padro desta propriedade 0 - fmListStylePlain.
NOTA: A op o 1 - fmListStyleOption s pode s er ha bi l i ta da s e a propri eda de
MultiSelect es ti ver confi gura da como 1 - fmMultiselectMulti.

Locked
A propriedade Locked habilita ou desabilita a edio do objeto. Se esta
propriedade estiver configurada para True, a edio no permitida. Caso
contrrio, possvel editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padro desta propriedade False.

MatchEntry
Procura, atravs do texto digitado pelo usurio, por uma entrada de texto que
coincida com os dados existentes no objeto. Ao encontrar uma coincidncia no
texto, a linha selecionada e o contedo da coluna exibido. As opes
disponveis so as seguintes:
0 - fmMatchEntryFirstLetter: procura pela entrada de texto que coincida com o
primeiro caractere digitado no objeto. Se for digitada repetidamente a mesma
letra, passada para a prxima entrada de texto que comece com esta letra, e
assim por diante
1 - fmMatchEntryComplete: conforme cada caractere digitado, o objeto procura
por uma entrada de texto que coincida com os caracteres digitados
2 - fmMatchEntryNone: no faz a procura no objeto
O valor padro desta propriedade 1 - fmMatchEntryComplete.

MultiSelect
A propriedade MultiSelect indica se o objeto permite mltiplas selees. As
opes disponveis para esta propriedade so as seguintes:
0 - fmMultiSelectSingle: somente um item pode ser selecionado
Visualizao

193

1 - fmMultiSelectMulti: permite selecionar um item atravs da barra de espao


ou clique com o mouse, fazendo com que marque ou desmarque um item na lista
2 - fmMultiSelectExtended: permite selecionar um item atravs da tecla SHIFT,
clicando com o mouse ou pressionando SHIFT e uma das teclas de seta,
estendendo a seleo para o item atual. Pressionando a tecla CTRL e clicando
com o mouse, marca ou desmarca um item
O valor padro desta propriedade 0 - fmMultiSelectSingle.

Selected
Seleciona ou desfaz a seleo de um item, e verifica se um item est selecionado,
quando a propriedade Multiline est configurada como True. Para saber se um
determinado item est selecionado, o ndice do item a ser consultado deve ser
passado, e a propriedade retorna se o item est selecionado ou no. Dessa forma,
possvel ver quais itens esto selecionados quando o usurio selecionar mais de
um. Esta propriedade acessvel apenas em tempo de execuo. Quando o usurio
no estiver utilizando mltiplas selees, recomenda-se que sejam usadas as
propriedades Value ou ListIndex.

SpecialEffect
A propriedade SpecialEffect especifica a aparncia de um objeto. As opes
disponveis para esta propriedade so as seguintes:
Opes disponveis para SpecialEffect
OPO
0 - fmSpecialEffectFlat
1 - fmSpecialEffectRaised

2 - fmSpecialEffectSunken

3 - fmSpecialEffectEtched
6 - fmSpecialEffectBump

DESCRIO
O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera o de cor
ou a mbos .
O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta . O objeto pa rece
es ta r em rel evo.
O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda pa recem es ta r a funda dos na Tel a .
A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .

Text
Retorna o texto da opo selecionada. Esta propriedade acessvel apenas em
tempo de execuo.
194

Visualizao

TextAlign
Especifica como o texto alinhado no objeto. As opes disponveis so as
seguintes:
1 - fmTextAlignLeft: alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: alinha o texto com o centro do objeto
3 - fmTextAlignRight: alinha o texto com a extremidade direita do objeto

TextColumn
A propriedade TextColumn identifica a coluna no objeto. Os valores para a
propriedade TextColumn vo de -1 ao nmero de colunas na lista. O valor
TextColumn para a primeira coluna 1, o valor da segunda coluna 2, e assim por
diante. A configurao de TextColumn como 0 exibe os valores para a propriedade
ListIndex. A configurao de TextColumn como -1 exibe a primeira coluna que
possui o valor da propriedade ColumnWidths maior do que zero.

TopIndex
A propriedade TopIndex define ou retorna o item da lista que aparece na posio
mais prxima do topo na lista. Esta propriedade retorna o valor -1 se a lista est
vazia ou no exibida.

Value
o valor da propriedade BoundColumn das linhas atualmente selecionadas. Esta
propriedade no tem efeito no E3 e foi mantida por motivos de compatibilidade
com a especificao padro dos objetos Microsoft Forms.

4.3.2.12.9 Boto Liga-Desliga


Esta seo contm informaes sobre eventos e propriedades do objeto Boto LigaDesliga. Este objeto no possui mtodos associados.
4.3.2.12.9.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Boto Liga-Desliga.

MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse movimentado sobre o boto Liga-Desliga.
4.3.2.12.9.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Boto LigaDesliga.
Visualizao

195

Accelerator
Define ou recupera a tecla aceleradora do objeto. Esta tecla aceleradora uma
tecla de atalho que, usada em conjunto com a tecla ALT, d o foco ao objeto. O
valor padro desta propriedade uma String vazia.

Alignment
A propriedade Alignment especifica a posio do objeto, relativa a sua legenda.
As opes disponveis para esta propriedade so as seguintes:
0 - fmAlignmentLeft: coloca a legenda esquerda do objeto
1 - fmAligmentRight: coloca a legenda direita do objeto
Esta propriedade acessvel apenas em tempo de execuo.

AutoSize
A propriedade AutoSize ajusta a largura do texto, caso a rea disponvel
ultrapasse o tamanho do objeto. Para o objeto Boto Liga-Desliga (Toggle Button),
quando a propriedade estiver configurada para True, o texto redimensionado
para coincidir com o tamanho atual o objeto, permitindo assim a sua exibio
completa.

BackStyle
A propriedade BackStyle define o estilo do plano de fundo para o objeto. As
opes disponveis para esta propriedade so as seguintes:
0 - fmBackStyleTransparent: define o objeto como transparente, isto , nenhum
fundo deste objeto ser desenhado
1 - fmBackStyleOpaque: define o objeto como opaco, isto , o fundo ser
desenhado (valor padro)
NOTA: Es ta propri eda de n o a feta a tra ns pa rnci a de bi tma ps . Deve-s e us a r um
edi tor de i ma gens como o Pa i ntbrus h, por exempl o, pa ra torna r um bi tma p
tra ns pa rente. Nem todos os objetos Acti veX s uporta m bi tma ps tra ns pa rentes .

Caption
Define o texto que ser mostrado no objeto.

Font
A propriedade Font utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada unicamente via Studio.

196

Visualizao

GroupName
A propriedade GroupName utilizado para criar um grupo de objetos
mutuamente exclusivos. Esta propriedade acessvel apenas em tempo de
execuo.
NOTA: Es ta propri eda de n o uti l i za da no E3 e foi ma nti da por moti vos de
compa ti bi l i da de com a es peci fi ca o pa dr o dos objetos Mi cros oft Forms .

Locked
A propriedade Locked habilita ou desabilita a edio do objeto. Se esta
propriedade estiver configurada para True, a edio no permitida. Caso
contrrio, possvel editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padro desta propriedade False.

Picture
A propriedade Picture especifica a figura (bitmap) atribuda ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: atravs da Lista de
Propriedades ou via scripts, utilizando-se a funo LoadPicture para especificar o
caminho e o nome do arquivo que contm a figura. Para remover a figura, clique no
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
espao do teclado) no remove a figura.

PicturePosition
A propriedade PicturePosition especifica a posio da figura atribuda ao objeto
em relao a sua legenda. As opes disponveis para esta propriedades so as
seguintes:
Opes disponveis para PicturePosition
OPO
0 - fmPicturePositionLeftTop

1 - fmPicturePositionLeftCenter
2 - fmPicturePositionLeftBottom
3 - fmPicturePositionRightTop
4 - fmPicturePositionRightCenter

Visualizao

DESCRIO
A fi gura a pa rece es querda de s ua
l egenda . A l egenda a l i nha da com a
pa rte s uperi or da fi gura .
A fi gura a pa rece es querda da l egenda .
A l egenda centra l i za da rel a ti va mente
i ma gem.
A fi gura a pa rece es querda da l egenda .
A l egenda a l i nha da com a pa rte
i nferi or da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte s uperi or
da fi gura .
A fi gura a pa rece di rei ta da l egenda . A
l egenda centra l i za da rel a ti va mente
fi gura .

197

OPO
5 - fmPicturePositionRightBottom

6 - fmPicturePositionAboveLeft
7 - fmPicturePositionAboveCenter

8 - fmPicturePositionAboveRight
9 - fmPicturePositionBelowLeft
10 - fmPicturePositionBelowCenter
11 - fmPicturePositionBelowRight

DESCRIO
A fi gura a pa rece di rei ta da l egenda . A
l egenda a l i nha da com a pa rte i nferi or
da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ci ma da l egenda . A
l egenda centra l i za da a ba i xo da fi gura
(pa dr o).
A fi gura a pa rece a ci ma da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
es querda da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda centra l i za da a ci ma da fi gura .
A fi gura a pa rece a ba i xo da l egenda . A
l egenda a l i nha da com a extremi da de
di rei ta da fi gura .

SpecialEffect
A propriedade SpecialEffect especifica a aparncia de um objeto. Esta
propriedade acessvel apenas em tempo de execuo. As opes disponveis para
esta propriedade so as seguintes:
Opes disponveis para SpecialEffect
OPO
0 - fmSpecialEffectFlat

1 - fmSpecialEffectRaised

2 - fmSpecialEffectSunken

3 - fmSpecialEffectEtched
6 - fmSpecialEffectBump

DESCRIO
O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera o de cor
ou a mbos .
O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta . O objeto pa rece
es ta r em rel evo.
O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda pa recem es ta r a funda dos na Tel a .
A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .

TextAlign
Especifica como o texto alinhado no objeto. As opes disponveis so as
198

Visualizao

seguintes:
1 - fmTextAlignLeft: alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: alinha o texto ao centro do objeto
3 - fmTextAlignRight: alinha o texto com a extremidade direita do objeto

TripleState
A propriedade TripleState determina at trs estados de valores para o objeto. Se
a propriedade estiver configurada para True, o usurio poder escolher entre trs
opes de estados: Falso, Verdadeiro ou Nulo. O valor Nulo exibido como um
boto sombreado. Caso contrrio, o usurio pode escolher entre os valores False
ou True. O valor padro desta propriedade False.

Value
Indica o valor inicial do objeto. Tem comportamento booleano; se True, o objeto
inicia marcado, do contrrio, seu estado inicial no marcado. O valor padro
desta propriedade False.

WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto.

4.3.2.12.10 Editor de Texto


Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Editor de Texto.
4.3.2.12.10.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Editor de Texto.

DropButtonClick
DropButtonClick()
Ocorre quando a lista de opes aparece ou desaparece ao se clicar no objeto.
4.3.2.12.10.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Editor de Texto.

Copy
Copy()
Copia para a rea de Transferncia um texto previamente selecionado. Utilize o
mtodo Paste para colar o texto em outro local.
Visualizao

199

Cut
Cut()
Recorta para a rea de Transferncia um texto previamente selecionado. Utilize o
mtodo Paste para colar o texto em outro local.

Paste
Paste()
Insere em um objeto de texto o contedo da rea de Transferncia.
4.3.2.12.10.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Editor de Texto.

AutoSize
A propriedade AutoSize ajusta a largura do texto, caso a rea disponvel
ultrapasse o tamanho do objeto. Para o objeto Editor de Texto (Text Box), quando a
propriedade estiver configurada para True, a largura do texto reajustada para a
mesma do objeto. O valor padro desta propriedade False.
NOTA: Recomenda -s e evi ta r o us o da propri eda de AutoSize com um Edi tor de Texto
va zi o, que ta mbm uti l i ze a s propri eda des Multiline e WordWrap. Qua ndo o us u ri o
di gi ta em um Edi tor de Texto com es s a s propri eda des a jus ta da s pa ra True, el e
a utoma ti ca mente s e redi mens i ona r como uma ca i xa l onga e es trei ta , como um
ca ra ctere de l a rgura e uma l i nha de texto de compri mento.

AutoTab
A propriedade AutoTab habilita ou desabilita a tabulao automtica no objeto.
Se a propriedade estiver configurada para True, a tabulao automtica ocorre.
Caso contrrio, no utilizada.
Aps o usurio digitar o nmero mximo de caracteres em um objeto (configurado
na propriedade MaxLength), o foco se move automaticamente para o prximo
objeto da ordem de tabulao, quando estes caracteres forem atingidos. Por
exemplo, quando se quer que um Editor de Texto exiba dados de estoque que
possuam sempre cinco caracteres, pode-se usar a propriedade MaxLength para
especificar o nmero mximo de caracteres a serem introduzidos no objeto e a
propriedade AutoTab para tabular automaticamente para o prximo objeto depois
que o usurio digitar cinco caracteres.

AutoWordSelect
Habilita ou desabilita a seleo automtica de palavras no objeto. Se esta
propriedade estiver configurada para True, a palavra indicada selecionada no
texto mais o espao seguinte, caso se tenha selecionado parte dela. Caso contrrio,
somente o caractere indicado na palavra selecionado.
200

Visualizao

BackStyle
A propriedade BackStyle define o estilo do plano de fundo para os objetos. As
opes disponveis para esta propriedade so as seguintes:
0 - fmBackStyleTransparent: define o objeto como transparente, isto , nenhum
fundo deste objeto ser desenhado
1 - fmBackStyleOpaque: define o objeto como opaco, isto , o fundo ser
desenhado (valor padro)
NOTA: Es ta propri eda de n o a feta a tra ns pa rnci a de bi tma ps . Deve-s e us a r um
edi tor de i ma gens como o Pa i ntbrus h, por exempl o, pa ra torna r um bi tma p
tra ns pa rente. Nem todos os objetos Acti veX s uporta m bi tma ps tra ns pa rentes .

BorderColor
Esta propriedade determina a cor da borda que ser aplicada no objeto. Com
esta propriedade, possvel aplicar a cor padro ou personaliz-la atravs da sua
edio. Para que esta propriedade seja aplicvel, necessrio que a propriedade
BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padro desta
propriedade preto (RGB(0, 0, 0)).

BorderStyle
A propriedade BorderStyle determina o estilo de borda que ser aplicada ao
objeto. As opes disponveis so:
0 - fmBorderStyleNone: sem borda
1 - fmBorderStyleSingle: com borda simples

CanPaste
A propriedade CanPaste especifica se a rea de Transferncia contm os dados
aos quais o objeto d suporte. Se a opo estiver configurada para True, o objeto
pode receber informaes coladas da rea de Transferncia. Se os dados da rea
de Transferncia estiverem em um formato ao qual o objeto no d suporte, a
propriedade CanPaste ser False. Por exemplo, ao se tentar colar um bitmap em um
objeto que s d suporte a texto, CanPaste ser False. Esta propriedade acessvel
apenas em tempo de execuo.

CurLine
Especifica a linha corrente do objeto, ou seja, a linha que contm o ponto de
insero de texto. O nmero da primeira linha 0 (zero). O valor padro desta
propriedade zero.

CurTargetX
Retorna a posio horizontal de insero de um texto no objeto. Esta posio
medida em unidades himtricas (um himetro corresponde a 0,0001 de um metro).
Visualizao

201

Pode-se usar CurTargetX e CurX para mover o ponto de insero de um texto


conforme o usurio percorre o contedo do objeto. Quando o usurio move o ponto
de insero para outra linha do texto, a propriedade CurTargetX especifica a
posio mais indicada para o ponto de insero do texto desejado. A propriedade
CurX definida neste valor, se a linha do texto for maior que o valor de CurTargetX.
Caso contrrio, a propriedade CurX definida como o final da linha do texto. Esta
propriedade acessvel apenas em tempo de execuo.

CurX
A propriedade CurX especifica a posio atual horizontal do ponto de insero no
objeto. Esta propriedades aplicada em um objeto que possua vrias linhas, isto ,
a propriedade Multiline est habilitada. O valor de retorno vlido quando o
objeto possui o foco. Pode-se usar a propriedade Multiline e a propriedade CurX
para posicionar o ponto de insero do texto, conforme o usurio usa a barra de
rolagem pelo contedo no objeto. Quando o usurio move o ponto de insero para
uma outra linha de texto rolando o contedo do objeto, a propriedade CurTargetX
especifica a posio desejada para o ponto de insero. A propriedade CurX
definida com este valor se a linha de texto for maior do que o valor de CurTargetX.
Caso contrrio, CurX definido no fim da linha de texto. Esta propriedade
acessvel apenas em tempo de execuo.

DragBehavior
Habilita ou desabilita o recurso de arrastar e soltar um texto no contedo do
objeto. As opes disponveis para esta propriedade so as seguintes:
0 - fmDragBehaviorDisabled: no permite a ao de arrastar e soltar o texto no
contedo do objeto
1 - fmDragBehaviorEnabled: permite a ao de arrastar e soltar o texto no
contedo do objeto
O valor padro desta propriedade 0 - fmDragBehaviorDisabled.
NOTA: A propri eda de DragBehavior n o tem efei to s e a propri eda de Style es ti ver
confi gura da pa ra 2.

EnterFieldBehavior
Esta propriedade controla a forma como o contedo do texto selecionado na
rea de edio, quando se pressiona a tecla TAB no objeto e no quando o objeto
recebe o foco como um resultado do mtodo SetFocus. As opes disponveis para
esta propriedade so as seguintes:
0 - fmEnterFieldBehaviorSelectAll (valor padro): seleciona todo o contedo do
texto quando a tecla TAB pressionada no objeto
1 - fmEnterFieldBehaviorRecallSelection: deixa a seleo inalterada
202

Visualizao

EnterKeyBehavior
Define o efeito da tecla ENTER no objeto. Se esta propriedade estiver configurada
para True, ao pressionar a tecla ENTER uma nova linha criada na rea de edio
do texto no objeto. Caso contrrio, ao pressionar a tecla ENTER o foco passado
para o prximo objeto da ordem de tabulao. Isto tambm ocorre se a
propriedade Multiline estiver configurada para False, independente do valor da
propriedade EnterKeyBehavior.
A combinao das teclas CTRL + ENTER tambm depende do valor da propriedade
Multiline. Se esta propriedade estiver configurada para True, ao pressionar estas
teclas uma nova linha criada na rea de edio do texto do objeto, independente
do valor da propriedade EnterKeyBehavior. Se a propriedade for False, as teclas
no tero efeito sobre o texto.

Font
A propriedade Font utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada unicamente via Studio.

HideSelection
A propriedade HideSelection especifica se o texto selecionado continua em
destaque quando um objeto no tem mais o foco. Se a propriedade estiver
configurada para True, o texto selecionado no est em destaque, a menos que o
objeto tenha o foco. Caso contrrio, o texto selecionado sempre aparece em
destaque. O valor padro desta propriedade True.

IMEMode
A propriedade IMEMode especifica o modo IME (Input Method Editor) de um
objeto. Essa propriedade aplica-se apenas a programas escritos em idiomas
asiticos (chins simplificado, chins tradicional, coreano e japons) e ignorada
em outros aplicativos. Foi mantida por motivos de compatibilidade com a
especificao padro dos objetos Microsoft Forms. As opes disponveis so as
seguintes:
Opes disponveis para IMEMode
OPO
0 - fmIMEModeNoControl
1 - fmIMEModeOn
2 - fmIMEModeOff
3 - fmIMEModeDisable
4 - fmIMEModeHiragana
5 - fmIMEModeKatakanaFull

Visualizao

DESCRIO
N o control a IME (pa dr o).
IME a ti va do.
IME des a ti va do. Modo i ngl s .
IME des a ti va do. O us u ri o n o pode
a ti va r IME pel o tecl a do.
IME a ti va do com modo Hi ra ga na de
l a rgura tota l .
IME a ti va do com modo Ka ta ka na de
l a rgura tota l .

203

OPO
6 - fmIMEModeKatakana
7 - fmIMEModeAlphaFull
8 - fmIMEModeAlpha
9 - fmIMEModeHangulFull
10 - fmIMEModeHangul
11 - fmIMEModeHanziFull
12 - fmIMEModeHanzi

DESCRIO
IME a ti va do com modo Ka ta ka na de mei a
l a rgura .
IME a ti va do com modo Al fa numri co de
l a rgura tota l .
IME a ti va do com modo Al fa numri co de
mei a l a rgura .
IME a ti va do com modo Ha ngul de l a rgura
tota l .
IME a ti va do com modo Ha ngul de mei a
l a rgura .
IME a ti va do com modo Ha nzi de l a rgura
tota l .
IME a ti va do com modo Ha nzi de mei a
l a rgura .

IntegralHeight
A propriedade IntegralHeight ajusta a altura da rea de edio do texto, caso a
rea disponvel ultrapasse o tamanho do objeto. Se esta propriedade estiver
configurada para True, a altura da rea de edio do texto reajustada para
coincidir com o tamanho atual do objeto, permitindo assim a exibio completa do
contedo do texto. Caso contrrio, a rea de edio do texto continua com seu
tamanho original. Se os textos so maiores que o espao disponvel, estes no so
exibidos no objeto.

LineCount
A propriedade LineCount retorna o nmero de linhas do objeto. Esta propriedade
acessvel apenas em tempo de execuo.

Locked
A propriedade Locked habilita ou desabilita a edio do objeto. Se esta
propriedade estiver configurada para True, a edio no permitida. Caso
contrrio, possvel editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padro desta propriedade False.

MaxLength
A propriedade MaxLength determina o nmero mximo de caracteres no objeto.
Configurando esta propriedade como 0 (zero), no h limite de caracteres no
objeto.

Multiline
A propriedade Multiline indica se o texto ter mltiplas linhas (True) ou ser uma
caixa de texto simples (False). Isto pode ser visualizado quando o objeto Viewer
est em execuo. O valor padro desta propriedade False.
204

Visualizao

PasswordChar
Converte o texto do objeto para um caractere especial, configurado na
propriedade. Utilize esta propriedade para proteger informaes sensveis, como
senhas ou cdigos de segurana. O valor de PasswordChar o caractere
(normalmente um asterisco) que aparece em um objeto, ao invs dos caracteres
reais que o usurio digita. Se no for especificado um caractere, o controle exibe os
caracteres digitados pelo usurio.

ScrollBars
Especifica se o objeto possui barras de rolagem verticais, horizontais ou ambas.
As opes disponveis so as seguintes:
0 - fmScrollBarNone: no exibe barras de rolagem
1 - fmScrollBarHorizontal: exibe uma barra de rolagem horizontal
2 - fmScrollBarVertical: exibe uma barra de rolagem vertical
O valor padro desta propriedade 0 - fmScrollBarNone.

SelectionMargin
Habilita ou desabilita a margem de seleo do objeto. Se esta propriedade estiver
configurada para True, ao clicar na margem do objeto, o texto ser selecionado.
Caso contrrio, ao clicar na margem o texto no ser selecionado.
NOTA: Se a propri eda de SelectionMargin es ti ver confi gura da pa ra True qua ndo o
objeto for i mpres s o, a ma rgem de s el e o ta mbm s er i mpres s a .

SelLength
Retorna o nmero de caracteres selecionados no objeto. Esta propriedade
acessvel apenas em tempo de execuo.

SelStart
Indica o ponto inicial do texto selecionado ou o ponto de insero, se nenhum
texto for selecionado. Esta propriedade acessvel apenas em tempo de execuo.

SelText
Retorna o texto selecionado no objeto. Esta propriedade acessvel apenas em
tempo de execuo.

SpecialEffect
A propriedade SpecialEffect especifica a aparncia de um objeto. As opes
disponveis para esta propriedade so as seguintes:

Visualizao

205

Opes disponveis para SpecialEffect


OPO
0 - fmSpecialEffectFlat
1 - fmSpecialEffectRaised

2 - fmSpecialEffectSunken

3 - fmSpecialEffectEtched
6 - fmSpecialEffectBump

DESCRIO
O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera o de cor
ou a mbos .
O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta . O objeto pa rece
es ta r em rel evo.
O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda pa recem es ta r a funda dos na Tel a .
A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .

TabKeyBehavior
Determina se as tabulaes so permitidas na regio de edio. Se a propriedade
estiver configurada para True, ao pressionar a tecla TAB inserido um caractere de
espaamento na regio de edio. Caso contrrio, ao pressionar TAB, o foco
passado para o prximo objeto na ordem de tabulao.

Text
Retorna o texto sendo digitado na opo selecionada. Esta propriedade
acessvel apenas em tempo de execuo.

TextAlign
Especifica como o texto alinhado no objeto. As opes disponveis so as
seguintes:
1 - fmTextAlignLeft: alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: alinha o texto com o centro do objeto
3 - fmTextAlignRight: alinha o texto com a extremidade direita do objeto

TextLength
Retorna o nmero de caracteres digitados no objeto. Esta propriedade acessvel
apenas em tempo de execuo.

Value
o texto na rea de edio. Esta propriedade do tipo Variant, e pode assumir
valores de todo e qualquer tipo (Date, Boolean, String, etc.).
206

Visualizao

WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a True.

4.3.2.12.11 Boto Incremento-Decremento


Esta seo contm informaes sobre eventos e propriedades do objeto Boto
Incremento-Decremento. Este objeto no possui mtodos associados.
4.3.2.12.11.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Boto IncrementoDecremento.

SpinDown
SpinDown()
Ocorre quando o usurio pressiona a seta para baixo. Este evento decrementa a
propriedade Value do objeto.

SpinUp
SpinUp()
Ocorre quando o usurio pressiona a seta para cima. Este evento incrementa a
propriedade Value do objeto.
4.3.2.12.11.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Boto IncrementoDecremento.

Delay
Especifica um tempo de espera para o objeto. A propriedade Delay afeta a
durao de tempo entre os eventos SpinUp, SpinDown e Change consecutivos,
gerados quando o usurio clica e mantm pressionado o boto IncrementoDecremento. O primeiro evento ocorre imediatamente. O tempo de espera at a
segunda ocorrncia do evento de cinco vezes o valor especificado na propriedade
Delay. Aps o tempo inicial, o intervalo entre os eventos o valor especificado
para Delay.
O valor padro de Delay 50ms. Isto significa que o objeto inicia o primeiro evento
depois de 250ms (cinco vezes o valor especificado), e inicia cada evento
subsequente depois de 50ms.

Visualizao

207

Max
A propriedade Max utilizada para determinar o limite mximo do objeto.

Min
A propriedade Min utilizada para determinar o limite mnimo do objeto.

Orientation
A propriedade Orientation utilizada para determinar a orientao do objeto
na Tela. As opes disponveis para esta propriedade so as seguintes:
-1 - fmOrientationAuto: determina automaticamente a orientao com base nas
dimenses do objeto, isto , conforme ele foi criado
0 - fmOrientationVertical: o objeto disposto verticalmente
1 - fmOrientationHorizontal: o objeto disposto horizontalmente
O valor padro desta propriedade -1 - fmOrientationAuto.

SmallChange
A propriedade SmallChange especifica a quantidade de movimento que ocorre
quando o usurio clica em uma seta de rolagem no objeto. O valor padro desta
propriedade 1.

Value
Nmero inteiro entre os valores definidos pelas propriedades Min e Max. Indica a
posio inicial do incremento ou decremento. No aceita valores menores que o
valor de Min, nem maiores que o valor de Max.

4.3.2.12.12 Barra de Rolagem


Esta seo contm informaes sobre eventos e propriedades do objeto Barra de
Rolagem. Este objeto no possui mtodos associados.
4.3.2.12.12.1 Eventos
Esta seo contm informaes sobre eventos do objeto Barra de Rolagem.

Scroll
Scroll()
Gerado quando o ponteiro da barra de rolagem movido para alguma direo.

208

Visualizao

4.3.2.12.12.2 Propriedades
Esta seo contm informaes sobre propriedades do objeto Barra de Rolagem.

Delay
Especifica um tempo de espera para o objeto. A propriedade Delay afeta a
durao de tempo entre eventos Change consecutivos, gerados quando o usurio
clica e mantm pressionada a barra de rolagem. O primeiro evento ocorre
imediatamente. O tempo de espera at a segunda ocorrncia do evento de cinco
vezes o valor especificado na propriedade Delay. Aps o tempo inicial, o intervalo
entre os eventos o valor especificado para Delay.
O valor padro de Delay 50ms. Isto significa que o objeto inicia o primeiro evento
depois de 250ms (cinco vezes o valor especificado), e inicia cada evento
subsequente depois de 50ms.

LargeChange
Especifica a quantidade de passos do cursor da Barra de Rolagem. O valor da
propriedade LargeChange a quantidade pela qual a propriedade Value alterada,
quando o usurio clica na rea entre a caixa de rolagem e o cursor da barra de
rolagem. Qualquer valor inteiro permitido para a propriedade LargeChange, mas
o intervalo recomendado de -32,767 a +32,767, sendo que este valor deve estar
entre os valores determinados nas propriedade Max e Min da Barra de Rolagem.

Max
A propriedade Max utilizada para determinar o limite mximo do objeto.

Min
A propriedade Min utilizada para determinar o limite mnimo do objeto.

Orientation
A propriedade Orientation utilizada para determinar a orientao do objeto
na Tela. As opes disponveis para esta propriedade so as seguintes:
-1 - fmOrientationAuto: determina automaticamente a orientao com base nas
dimenses do objeto, isto , conforme ele foi criado
0 - fmOrientationVertical: o objeto disposto verticalmente
1 - fmOrientationHorizontal: o objeto disposto horizontalmente
O valor padro desta propriedade -1 - fmOrientationAuto.

ProportionalThumb
A propriedade ProportionalThumb especifica se o tamanho da caixa de rolagem
igual dimenso do objeto. Se a propriedade estiver configurada para True, a caixa
Visualizao

209

da Barra de Rolagem tem a mesma dimenso do objeto. Caso contrrio, se for


dimensionado o objeto, a caixa de rolagem permanece com o tamanho original. O
valor padro desta propriedade True.

SmallChange
A propriedade SmallChange especifica a quantidade de movimento que ocorre
quando o usurio clica em uma seta de rolagem no objeto. O valor padro desta
propriedade 1.

Value
Nmero inteiro entre os valores definidos pelas propriedades Min e Max. Indica a
posio inicial da barra de rolagem. No aceita valores menores que o valor de
Min, nem maiores que o valor de Max.

4.3.2.13 E2Controls
Esta seo contm informaes sobre eventos, mtodos e propriedades de objetos
E2Controls.

4.3.2.13.1 Propriedades Comuns


Esta seo contm informaes sobre propriedades comuns aos objetos
E2Controls.
4.3.2.13.1.1 Frame_BorderColor
Define uma cor para a moldura do objeto.
4.3.2.13.1.2 Frame_BorderEnabled
Habilita ou desabilita a moldura do objeto.
4.3.2.13.1.3 Frame_BorderThickness
Define a espessura da moldura do objeto, em pixels.
4.3.2.13.1.4 Frame_Color
Define a cor de fundo da rea de ttulo do objeto. O valor padro desta
propriedade cinza (RGB(192, 192, 192)).
4.3.2.13.1.5 Frame_Enable
Habilita ou desabilita a exibio da moldura do objeto. O valor padro desta
propriedade Verdadeiro, exceto para o objeto E2Button.
210

Visualizao

4.3.2.13.1.6 Frame_Enable3D
Habilita ou desabilita o efeito 3D para a moldura do objeto.
4.3.2.13.1.7 Frame_Separator
Habilita ou desabilita a exibio de uma linha separadora entre o ttulo e o
objeto.
4.3.2.13.1.8 Frame_Set3DInset
Se esta propriedade estiver ajustada para Verdadeiro, a borda do objeto
aparecer rebaixada. Se estiver em Falso (valor padro), a borda do objeto
aparecer ressaltada.
4.3.2.13.1.9 Frame_Thickness3D
Define a espessura da borda 3D da moldura do objeto, em pixels.
4.3.2.13.1.10 Frame_Title
Esta propriedade define o ttulo da moldura do objeto.
4.3.2.13.1.11 Frame_TitleColor
Define a cor da fonte do ttulo da moldura. O valor padro desta propriedade
preto (RGB(0, 0, 0)).
4.3.2.13.1.12 Frame_TitleEnabled
Habilita ou desabilita a exibio do ttulo da moldura. O valor padro desta
propriedade Verdadeiro.
4.3.2.13.1.13 Frame_TitleFont
A propriedade Frame_TitleFont utilizada para determinar a fonte do ttulo da
moldura. Esta propriedade no pode ser utilizada em scripts ou em Associaes,
sendo configurada unicamente via Studio.

4.3.2.13.2 E2Animation
Esta seo contm informaes sobre propriedades do objeto E2Animation. Este
objeto no possui eventos nem mtodos associados.

Visualizao

211

4.3.2.13.2.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E2Animation.

BackgroundColor
Esta propriedade define a cor de fundo do objeto E2Animation. O valor padro
desta propriedade branco (RGB(255, 255, 255)).

BlinkTime
Define o intervalo de tempo, em milissegundos, do efeito de piscar do objeto.

Border
Habilita ou desabilita a exibio de uma borda ao redor do objeto.

DefaultZone
Define a zona padro que ser mostrada quando o Tag associado estiver fora dos
limites das outras zonas definidas para o objeto.

IsTransparent
Se o valor desta propriedade for verdadeiro, define que o fundo do objeto ser
transparente, permitindo que o fundo da Tela aparea. Caso contrrio, a cor de
fundo ser slida, definida em BackgroundColor.

Value
Essa propriedade define o valor que ir determinar qual a Zona ativa. O valor
padro dessa propriedade 0 (zero).

Zones
Coleo de Zonas do objeto E2Animation.
4.3.2.13.2.2 Coleo de Zonas
Esta seo contm informaes sobre os mtodos do objeto Coleo de Zonas. Este
objeto no contm eventos nem propriedades associadas.

Mtodos
Esta seo contm informae sobre os mtodos do objeto Coleo de Zonas.

Add
Add([AxisName])
Adiciona uma nova Zona na Coleo de Zonas. O parmetro AxisName opcional e
no tem efeito, sendo mantido por questes de compatibilidade com verses
anteriores.
212

Visualizao

Remove
Remove(Index)
Remove uma Zona. O parmetro Index indica o ndice da Zona que deve ser
removida.
Define um conjunto de imagens de bitmap que sero usadas para criar o efeito de
animao no objeto. As Zonas podem ser configuradas acessando a janela
Propriedades do objeto, na aba E2Animation. As opes dessa janela so as
seguintes:
Opes disponveis na aba E2Animation
OPO
Zonas
Boto Adicionar
Boto Remover
Zona Padro
Pisca
Dica
Mnimo
Mximo
Arquivo de imagem
Exemplo

DESCRIO
Li s ta gem com toda s a s Zona s defi ni da s
no objeto.
Adi ci ona uma nova Zona .
Apa ga a Zona s el eci ona da .
Defi ne a Zona s el eci ona da como a Zona
pa dr o do objeto.
Defi ne s e o bi tma p i r pi s ca r qua ndo o
va l or do objeto es ti ver dentro do
i nterva l o da Zona .
Mos tra um texto de a juda s obre a Zona .
Va l or mni mo pa ra a va ri a o da Zona .
Va l or m xi mo pa ra a va ri a o da Zona .
Nome do a rqui vo de bi tma p que s er
mos tra do qua ndo o va l or do objeto
es ti ver dentro do i nterva l o da Zona .
Mos tra uma prvi a do a rqui vo de bi tma p
da Zona s el eci ona da .

Propriedades
Esta seo contm informaes sobre as propriedades das Zonas do objeto
E2Animation.

Blink
Indica que esta Zona participa do efeito de piscar. O valor padro dessa
propriedade Falso.

Filename
Indica qual o nome do arquivo de imagem utilizado na Zona.

Maximum
Define o valor mximo para a Zona. O valor padro dessa propriedade 20000.

Visualizao

213

Minimum
Define o valor mnimo para a Zona. O valor padro dessa propriedade 0 (zero).

TipEnable
Habilita ou desabilita a dica para a Zona. O valor padro dessa propriedade
Falso.

TipText
Define a dica para a Zona. O valor padro dessa propriedade uma String em
branco.

4.3.2.13.3 E2Bitmap
Esta seo contm informaes sobre propriedades do objeto E2Bitmap. Este objeto
no possui eventos nem mtodos associados.
4.3.2.13.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E2Bitmap.

Filename
Define o nome do arquivo de imagem associado ao E2Bitmap. O caminho do
arquivo pode ser tanto o caminho completo do arquivo no disco, quanto o caminho
relativo aplicao (quando o arquivo de imagem inserido como um Recurso da
aplicao). O valor padro desta propriedade vazio.

IsTransparent
Esta propriedade habilita ou desabilita a transparncia do objeto, baseada na
cor definida na propriedade TransparentColor.

TransparentColor
Define qual cor ser considerada pela propriedade IsTransparent como sendo
transparente. O valor padro desta propriedade branco (RBG(255, 255, 255)).

4.3.2.13.4 E2Button
Esta seo contm informaes sobre eventos e propriedades do objeto E2Button.
Este objeto no possui mtodos associados.
4.3.2.13.4.1 Eventos
Esta seo contm informaes sobre os eventos do objeto E2Button.

214

Visualizao

OnRelease
OnRelease()
Este evento gerado quando o boto do mouse solto.
4.3.2.13.4.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E2Button.

Action
Esta propriedade define o comportamento do objeto E2Button quando clicado.
Os valores possveis para esta propriedade so:
0 - Momentary: Comportamento normal do boto, aparecendo rebaixado
somente enquanto o mouse est pressionado
1 - Toggle: Possui dois estados, ligado e desligado
2 - Jog: Alterna entre dois valores, um quando o boto pressionado e outro
quando o boto solto
O valor padro desta propriedade 0 - Momentary.

Alignment
Determina o alinhamento do texto do boto. Os valores possveis desta
propriedade so:
0 - HorizontalAlignmentLeft: Alinha o texto esquerda
1 - HorizontalAlignmentCenter: Alinha o texto ao centro
2 - HorizontalAlignmentRight: Alinha o texto direita
O valor padro desta propriedade 1 - HorizontalAlignmentCenter.

BackgroundColor0
Define a cor de fundo do boto, quando no est pressionado. O valor padro
desta propriedade cinza (RGB(192, 192, 192)).

BackgroundColor1
Define a cor de fundo do boto, quando est pressionado. O valor padro desta
propriedade cinza (RGB(192, 192, 192)).

Bitmap0
Define a imagem do boto, quando no est pressionado. O valor padro desta
propriedade vazio.
Visualizao

215

Bitmap1
Define a imagem do boto, quando est pressionado. O valor padro desta
propriedade vazio.

Text0
Define o texto do boto, quando no est pressionado. O valor padro desta
propriedade "DESLIGADO".

Text1
Define o texto do boto, quando est pressionado. O valor padro desta
propriedade "LIGADO".

TextColor0
Define a cor do texto do boto, quando no est pressionado. O valor padro
desta propriedade preto (RGB(0, 0, 0)).

TextColor1
Define a cor do texto do boto, quando est pressionado. O valor padro desta
propriedade preto (RGB(0, 0, 0)).

TextFont0
A propriedade TextFont0 utilizada para determinar a fonte do boto, quando
no est pressionado. Esta propriedade no pode ser utilizada em scripts ou em
Associaes, sendo configurada unicamente via Studio.

TextFont1
A propriedade TextFont1 utilizada para determinar a fonte do boto, quando
est pressionado. Esta propriedade no pode ser utilizada em scripts ou em
Associaes, sendo configurada unicamente via Studio.

Type
Define o tipo do boto. Os valores possveis para esta propriedade so os
seguintes:
0 - ButtonTypeKey: comportamento normal de um boto
1 - ButtonTypeSwitchH: o comportamento do boto o de uma chave dividida
horizontalmente
2 - ButtonTypeSwitchV: o comportamento do boto o de uma chave dividida
verticalmente
3 - ButtonTypeLeverH: o comportamento do boto o de uma alavanca que se
movimenta da esquerda para a direita e vice-versa
4 - ButtonTypeLeverV: o comportamento do boto o de uma alavanca que se
216

Visualizao

movimenta de cima para baixo e vice-versa


5 - ButtonTypeTransparent: o boto transparente
6 - ButtonTypeUserBitmap: o boto alterna a exibio das imagens definidas nas
propriedades Bitmap0 e Bitmap1
7 - ButtonTypeCheckbox: o comportamento do boto o mesmo de uma Caixa de
Seleo
8 - ButtonTypeRadio: o comportamento do boto o mesmo de um Boto de
Opes
O valor padro desta propriedade 0 - ButtonTypeKey.

Value
A propriedade Value um Variant que assume o valor contido na propriedade
Value0 se o boto no est pressionado, e o valor contido na propriedade Value1
se o boto est pressionado.

Value0
Define o valor da propriedade Value, quando o boto no est pressionado.

Value1
Define o valor da propriedade Value, quando o boto est pressionado.

4.3.2.13.5 E2Display
Esta seo contm informaes sobre propriedades do objeto E2Display. Este
objeto no possui eventos nem mtodos associados.
4.3.2.13.5.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E2Display.

BackgroundColor
Esta propriedade define a cor de fundo do objeto. O valor padro desta
propriedade cinza (RGB(192, 192, 192)).

BackgroundStyle
Define o estilo de fundo do objeto. Os valores desta propriedade so os
seguintes:
0 - bsTransparent: o fundo transparente
1 - bsOpaque: a cor definida em BackgroundColor vsivel
Visualizao

217

O valor padro desta propriedade 1 - bsOpaque.

Format
Contm um texto que representa uma mscara, dentro da qual os valores do
objeto sero mostrados. Esta mscara pode representar vrios tipos de valores:
Geral: No possui formatao especfica, adaptando-se automaticamente ao
valor especificado
Nmero: Apresenta nmeros com parte inteira e fracionria. O usurio pode
optar por at 15 casas decimais, por usar ou no um separador de milhares, e
por apresentar nmeros negativos com sinal ou entre parnteses. Para nmeros
muito grandes ou muito pequenos, recomenda-se utilizar o formato Cientfico
Data: Apresenta valores numricos de data e hora (quando vlidos). Para
representar apenas a hora, use o formato equivalente
Hora: Apresenta valores numricos de hora e data (quando vlidos). Para
representar apenas a data, use o formato equivalente
Porcentagem: Multiplica o nmero por 100 e adiciona o smbolo de
porcentagem. Admite at 15 casas decimais
Cientfico: Apresenta o nmero em notao de mantissa e expoente. Ideal para
nmeros de magnitude variada. Admite at 15 casas decimais
Especial: Permite formatar nmeros inteiros em bases no decimais
(hexadecimal, octal ou binria, por exemplo)
Outro: Permite editar diretamente o cdigo de formatao desejado, ou
selecionar um formato criado anteriormente

HorizontalAlignment
Define o alinhamento horizontal do texto do E2Display. Os valores desta
propriedade so os seguintes:
0 - HorizontalAlignmentLeft: alinha horizontalmente esquerda
1 - HorizontalAlignmentCenter: alinha horizontalmente ao centro
2 - HorizontalAlignmentRight: alinha horizontalmente direita
O valor padro desta propriedade 1 - HorizontalAlignmentCenter.

MultiLine
Define se o objeto possui mltiplas linhas ou no. Esta propriedade s ter efeito
se a propriedade Value for do tipo String.

TextColor
Define a cor do texto do objeto. O valor padro desta propriedade preto (RGB(0,
218

Visualizao

0, 0)).

TextFont
A propriedade TextFont utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada em Associaes. Veja a propriedade TextFont
dos objetos Texto, Display e SetPoint para maiores informaes sobre as
subpropriedades que podem ser modificadas via script.

Value
Esta propriedade contm um Variant que pode assumir valores de todo e
qualquer tipo de dados, e a forma de apresentao desses valores ser definida
pela propriedade Format.

VerticalAlignment
Define o alinhamento vertical do texto do E2Display. Os valores desta
propriedade so os seguintes:
0 - VerticalAlignmentTop: alinha verticalmente com a parte superior do objeto
1 - VerticalAlignmentMiddle: alinha verticalmente com o centro do objeto
2 - VerticalAlignmentBottom: alinha verticalmente com a parte inferior do objeto
O valor padro desta propriedade 1 - VerticalAlignmentMiddle.

4.3.2.13.6 E2Gauge
Esta seo contm informaes sobre propriedades do objeto E2Gauge. Este objeto
no possui eventos nem mtodos associados.
4.3.2.13.6.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E2Gauge.

BackgroundColor
Esta propriedade define a cor de fundo do objeto. O valor padro desta
propriedade cinza (RGB(128, 128, 128)).

BulletsVisible
Exibe ou esconde as marcas da escala em forma de bullet.

DecimalPlaces
Esta propriedade define o nmero de casas decimais para o valor nominal do
E2Gauge.

Visualizao

219

FrameColor
Define a cor de fundo do objeto.

HiColorLegend
Define a cor da legenda para o limite Alto. O valor padro desta propriedade
amarelo (RGB(255, 255, 0)).

HiDiv
Marca o incio da escala para o limite Alto. O valor padro dessa propriedade
13300.

HiHiColorLegend
Define a cor da legenda para o limite Muito Alto. O valor padro desta
propriedade vermelho (RGB(255, 0, 0)).

HiHiDiv
Marca o incio da escala para o limite Muito Alto. O valor padro dessa
propriedade 16600.

HiHiLimitVisible
Habilita ou desabilita a exibio do limite Muito Alto.

HiLimit
O valor mximo dessa propriedade 1 e o mnimo limitado pela propriedade
LowLimit. O valor padro dessa propriedade 0,7.

HiLimitVisible
Habilita ou desabilita a exibio do limite Alto.

LegendVisible
Exibe uma barra ao longo do objeto E2Gauge, onde podem ser configuradas
diferentes cores, dependendo da faixa de valores. O valor padro desta
propriedade True.

LimitVisible
Define se os valores mnimos e mximos da escala aparecem ou no no grfico.

LowColorLegend
Define a cor da legenda para o limite Baixo. O valor padro desta propriedade
verde escuro (RGB(0, 128, 0)).

LowDiv
Marca o incio da escala para o limite Baixo. O valor padro dessa propriedade
220

Visualizao

6600.

LowLimit
O valor mnimo dessa propriedade 0,1, e o mximo limitado pela propriedade
HiLimit. O valor padro dessa propriedade 0,62.

LowLimitVisible
Habilita ou desabilita a exibio do limite Baixo.

LowLowColorLegend
Define a cor da legenda para o limite Muito Baixo. O valor padro desta
propriedade verde (RGB(0, 255, 0)).

LowLowDiv
Marca o incio da escala para o limite Muito Baixo. O valor padro dessa
propriedade 3300.

LowLowLimitVisible
Habilita ou desabilita a exibio do limite Muito Baixo.

Maximum
Define o valor mximo da escala do E2Gauge.

Minimum
Define o valor mnimo da escala do E2Gauge.

NeedleColor
Define a cor do ponteiro do E2Gauge. O valor padro desta propriedade branco
(RGB(255, 255, 255)).

NeedleThickness
Define a espessura do ponteiro do E2Gauge, em pixels. O valor padro dessa
propriedade 2, e s so aceitos os valores 1 ou 2.

NormalColor
Define a cor da legenda para o limite Normal. O valor padro desta propriedade
oliva (RGB(128, 128, 0)).

NumberOfPoints
Define o nmero de subdivises que estaro visveis na escala do objeto.

Orientation
Define a orientao do objeto E2Gauge. Os valores possveis desta propriedade
so os seguintes:
Visualizao

221

0 - Left: a parte inferior do objeto est alinhada com o lado esquerdo da moldura
1 - Up: a parte inferior do objeto est alinhada com a parte de cima da moldura
2 - Down: a parte inferior do objeto est alinhada com a parte de baixo da
moldura
3 - Right: a parte inferior do objeto est alinhada com o lado direito da moldura
O valor padro desta propriedade 2 - Down.

Reverted
Habilita ou desabilita a reverso da escala do objeto.

ShowFrame
Habilita ou desabilita a exibio do fundo ao longo do percurso do ponteiro.

StartAngle
Define o ngulo inicial de exibio do ponteiro do objeto E2Gauge.

SubTickColor
Define a cor das subdivises da escala. O valor padro desta propriedade
preto (RGB(0, 0, 0)).

SubTicksVisible
Habilita ou desabilita a exibio das subdivises da escala.

TextColor
Define a cor do texto da escala. O valor padro desta propriedade preto (RGB(0,
0, 0)).

TextFont
A propriedade TextFont utilizada para determinar a fonte do texto da escala.
Esta propriedade no pode ser utilizada em Associaes. Veja a propriedade
TextFont dos objetos Texto, Display e SetPoint para maiores informaes sobre as
subpropriedades que podem ser modificadas via script.

ThickTicks
Habilita ou desabilita a exibio de divisores da escala mais espessos. O valor
padro dessa propriedade Falso.

TickColor
Define a cor dos divisores da escala. O valor padro desta propriedade preto
(RGB(0, 0, 0)).
222

Visualizao

TicksVisible
Habilita ou desabilita a exibio das divises da escala.

TickValues
Habilita ou desabilita a exibio dos valores das divises da escala.

TotalNumberOfSubTicks
Define o nmero total de subdivises que sero mostradas na escala.

Value
Esta propriedade define um valor entre as propriedades Maximum e Minimum da
escala do objeto.

ValueVisible
Habilita ou desabilita a exibio do valor contido na propriedade Value. O valor
padro dessa propriedade Falso.

4.3.2.13.7 E2Setpoint
Esta seo contm informaes sobre propriedades do objeto E2Setpoint. Este
objeto no possui eventos nem mtodos associados.
4.3.2.13.7.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E2Setpoint.

AutoSend
Se esta propriedade estiver em True (valor padro), o valor definido na
propriedade Value atualizado nas Associaes assim que o objeto perder o foco.
Caso contrrio, as Associaes s recebem o valor quando for usada a tecla ENTER.

BackgroundColor
Esta propriedade define a cor de fundo do objeto. O valor padro desta
propriedade cinza (RGB(192, 192, 192)).

BackgroundStyle
Define o estilo de fundo do objeto. Os valores desta propriedade so os
seguintes:
0 - bsTransparent: o fundo transparente
1 - bsOpaque: a cor definida em BackgroundColor vsivel
O valor padro desta propriedade 1 - bsOpaque.
Visualizao

223

EnableMaxLimit
Habilita ou desabilita a definio de um limite mximo para o valor do
E2Setpoint.

EnableMinLimit
Habilita ou desabilita a definio de um limite mnimo para o valor do
E2Setpoint.

Format
Contm um texto que representa uma mscara, dentro da qual os valores do
objeto sero mostrados. Esta mscara pode representar vrios tipos de valores:
Geral: No possui formatao especfica, adaptando-se automaticamente ao
valor especificado
Nmero: Apresenta nmeros com parte inteira e fracionria. O usurio pode
optar por at 15 casas decimais, por usar ou no um separador de milhares, e
por apresentar nmeros negativos com sinal ou entre parnteses. Para nmeros
muito grandes ou muito pequenos, recomenda-se utilizar o formato Cientfico
Data: Apresenta valores numricos de data e hora (quando vlidos). Para
representar apenas a hora, use o formato equivalente
Hora: Apresenta valores numricos de hora e data (quando vlidos). Para
representar apenas a data, use o formato equivalente
Porcentagem: Multiplica o nmero por 100 e adiciona o smbolo de
porcentagem. Admite at 15 casas decimais
Cientfico: Apresenta o nmero em notao de mantissa e expoente. Ideal para
nmeros de magnitude variada. Admite at 15 casas decimais
Especial: Permite formatar nmeros inteiros em bases no decimais
(hexadecimal, octal ou binria, por exemplo)
Outro: Permite editar diretamente o cdigo de formatao desejado, ou
selecionar um formato criado anteriormente

HorizontalAlignment
Define o alinhamento horizontal do texto do E2Setpoint. Os valores desta
propriedade so os seguintes:
0 - HorizontalAlignmentLeft: alinha horizontalmente esquerda
1 - HorizontalAlignmentCenter: alinha horizontalmente ao centro
2 - HorizontalAlignmentRight: alinha horizontalmente direita
O valor padro desta propriedade 1 - HorizontalAlignmentCenter.
224

Visualizao

HScroll
Habilita ou desabilita a exibio de uma barra de rolagem horizontal no texto,
caso a propriedade Multiline esteja em True.

MaxLimit
Limite mximo que pode ser atingido pela propriedade Value do objeto. O valor
padro dessa propriedade 200. O limite s verificado se a propriedade
EnableMaxLimit estiver habilitada.

MinLimit
Limite mnimo que pode ser atingido pela propriedade Value do objeto. O valor
padro dessa propriedade 0. O limite s verificado se a propriedade
EnableMinLimit estiver habilitada.

MultiLine
Define se o objeto possui mltiplas linhas ou no. Esta propriedade s estar
disponvel se a propriedade Value for do tipo String.

ReadOnly
Indica se o objeto pode ser editado ou no em tempo de execuo. O valor
padro dessa propriedade Falso.

Refresh
Indica se o valor do E2Setpoint ser atualizado ou no sempre que o valor do Tag
mudar. O valor padro desta propriedade Verdadeiro.

SelectAllOnFocus
Habilita ou desabilita a seleo de todos os caracteres do E2Setpoint quando o
objeto recebe o foco. O valor padro dessa propriedade Verdadeiro.

TextColor
Define a cor do texto do objeto. O valor padro desta propriedade preto (RGB(0,
0, 0)).

TextFont
A propriedade TextFont utilizada para determinar a fonte do objeto. Esta
propriedade no pode ser utilizada Associaes. Veja a propriedade TextFont dos
objetos Texto, Display e SetPoint para maiores informaes sobre as
subpropriedades que podem ser modificadas via script.

Type
Define o tipo de Setpoint. Os valores possveis desta propriedade so os
seguintes:
Visualizao

225

0 - setpointString: aceita quaisquer caracteres alfanumricos


1 - setpointNumeric: aceita somente caracteres numricos e o separador decimal
(ponto ou vrgula, dependendo das configuraes regionais)
2 - setpointDateTime: aceita somente valores de data e hora, que sero
convertidos para o formato definido nas configuraes regionais
O valor padro desta propriedade 1 - setpointNumeric.

Value
Esta propriedade define um valor para o E2Setpoint. A forma como esse valor
ser visualizado definida na propriedade Format.

VerticalAlignment
Define o alinhamento vertical do texto do E2Setpoint. Os valores desta
propriedade so os seguintes:
0 - VerticalAlignmentTop: alinha verticalmente com a parte superior do objeto
1 - VerticalAlignmentMiddle: alinha verticalmente com o centro do objeto
2 - VerticalAlignmentBottom: alinha verticalmente com a parte inferior do objeto
O valor padro desta propriedade 1 - VerticalAlignmentMiddle.

VScroll
Habilita ou desabilita a exibio de uma barra de rolagem vertical no texto, caso
a propriedade Multiline esteja em True.

4.3.2.13.8 E2Text
Esta seo contm informaes sobre propriedades do objeto E2Text. Este objeto
no possui eventos nem mtodos associados.
4.3.2.13.8.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E2Text.

BlinkTime
Define o intervalo de tempo, em milissegundos, do efeito de piscar do objeto.

DefaultZone
Define a Zona padro do objeto.

226

Visualizao

Value
Esta propriedade contm um Variant que pode assumir valores de todo e
qualquer tipo de dados (Integer, Boolean, String, etc.).

Zones
Coleo de Zonas do objeto E2Text.
4.3.2.13.8.2 Coleo de Zonas
Esta seo contm informaes sobre os mtodos do objeto Coleo de Zonas do
objeto E2Text. Este objeto no possui eventos nem propriedades associadas.

Mtodos
Esta seo contm informaes sobre os mtodos do objeto Coleo de Zonas do
E2Text.

Add
Add([AxisName])
Adiciona uma nova Zona na Coleo de Zonas. O parmetro AxisName opcional e
no tem efeito, sendo mantido por questes de compatibilidade com verses
anteriores.

Remove
Remove(Index)
Remove uma Zona. O parmetro Index indica o ndice da Zona que deve ser
removida.

Zonas
Define um conjunto de Zonas para o objeto E2Text. Estas Zonas podem ser
configuradas acessando a janela de propriedades do objeto, na aba Zonas. As
opes disponveis nesta aba so as seguintes:
Opes disponveis na aba Zonas
OPO
Zonas
Adicionar
Remover
Pisca a cada (ms)
Mensagem

Visualizao

DESCRIO
Li s ta gem com toda s a s Zona s defi ni da s
no objeto.
Adi ci ona uma nova Zona .
Remove a Zona s el eci ona da .
Defi ne s e o texto e o fundo da Zona i r o
pi s ca r qua ndo o va l or do objeto es ti ver
dentro do i nterva l o da Zona .
Texto da mens a gem exi bi da qua ndo o
va l or do objeto es ti ver dentro do
i nterva l o da Zona .

227

OPO
Alinhamento
Fonte
Cor de fundo
Transparente
Zona padro
Pisca
Mnimo
Mximo
Dica
Exemplo

DESCRIO
Defi ne o a l i nha mento do texto.
Defi ne a fonte do texto.
Defi ne a cor de fundo da Zona .
Defi ne s e o fundo do objeto s er
tra ns pa rente qua ndo a Zona es ti ver
a ti va .
Defi ne a Zona s el eci ona da como a Zona
pa dr o do objeto.
Defi ne s e a Zona i r pi s ca r qua ndo o
va l or do objeto es ti ver dentro do
i nterva l o da Zona .
Va l or mni mo pa ra a Zona .
Va l or m xi mo pa ra a Zona .
Mos tra um texto de a juda pa ra a Zona .
Mos tra um exempl o do comporta mento
da Zona em tempo de execu o.

A seo a seguir contm informaes sobre as propriedades do objeto Zona de uma


Coleo de Zonas de um objeto E2Text. Este objeto no possui eventos nem mtodos
associados.

Propriedades
Esta seo contm informaes sobre as propriedades das Zonas do objeto E2Text.

BackgroundColor
Define a cor de fundo do texto da Zona. O valor padro dessa propriedade
branco (RGB(255, 255, 255)).

Blink
Indica que esta Zona participa do efeito de piscar. O valor padro dessa
propriedade Falso. Se estiver habilitada, esta Zona alterna com a Zona padro,
conforme o tempo definido na propriedade BlinkTime do objeto E2Text.

HorizontalAlignment
Define o alinhamento do texto. Os valores possveis so:
0 - HorizontalAlignmentLeft: alinha horizontalmente esquerda
1 - HorizontalAlignmentCenter: alinha horizontalmente ao centro
2 - HorizontalAlignmentRight: alinha horizontalmente direita
O valor padro desta propriedade 1 - HorizontalAlignmentCenter.

228

Visualizao

Maximum
Define o valor mximo para a Zona. O valor padro dessa propriedade 20000.

Message
Define o texto associado Zona. Esta mensagem ser mostrada quando o Tag
associado estiver dentro dos limites da Zona.

Minimum
Define o valor mnimo para a Zona. O valor padro dessa propriedade 0 (zero).

TextColor
Define a cor do texto da Zona. O valor padro dessa propriedade preto (RGB(0,
0, 0)).

TextFont
Define o estilo, a cor e o tamanho da fonte usada para mostrar o texto da
mensagem. Esta propriedade no pode ser utilizada Associaes. Veja a
propriedade TextFont dos objetos Texto, Display e SetPoint para maiores
informaes sobre as subpropriedades que podem ser modificadas via script.

TipEnable
Habilita ou desabilita a dica para a Zona. O valor padro dessa propriedade
Falso.

TipText
Define a dica para a Zona. O valor padro dessa propriedade uma String vazia.

Transparent
Define que o fundo do objeto ser transparente quando esta Zona estiver ativa.

4.3.2.14 Elipse KeyPad


Esta seo contm informaes sobre mtodos e propriedades do objeto Elipse
KeyPad. Este objeto no possui eventos associados.

4.3.2.14.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Elipse KeyPad.
4.3.2.14.1.1 Hide
Hide()
Oculta o Elipse KeyPad. Este mtodo no tem efeito se o KeyPad j est invisvel.
Visualizao

229

4.3.2.14.1.2 Show
Show()
Mostra o Elipse KeyPad. Este mtodo no tem efeito se o KeyPad j est visvel na
tela.

4.3.2.14.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Elipse KeyPad.
4.3.2.14.2.1 AutoHideOnEnter
Automaticamente oculta o KeyPad quando a tecla ENTER do teclado virtual
pressionada.
4.3.2.14.2.2 AutoHideOnEsc
Automaticamente oculta o KeyPad quando a tecla ESC do teclado virtual
pressionada.
4.3.2.14.2.3 Layout
Permite alterar o layout de apresentao do KeyPad. Os valores possveis dessa
propriedade so:
br-simple: Mostra um teclado alfanumrico

Exemplo de KeyPad alfanumrico

num: Mostra um teclado numrico

230

Visualizao

Exemplo de KeyPad numrico

Exemplo:
' Alterna entre os modos Alfanumrico e Numrico
Sub ToggleButton1_Click()
If ToggleButton1.Value Then
Application.GetKeyPad().Layout = "br-simple"
Else
Application.GetKeyPad().Layout = "num"
End If
End Sub

4.3.2.14.2.4 SizeFactor
Aumenta ou diminui o tamanho original do KeyPad, utilizando um fator de
multiplicao. O tamanho original do KeyPad mostrado na tabela a seguir:
Valores padro de tamanho do KeyPad
LAYOUT
Alfanumrico
Numrico

LARGURA
550 px
200 px

ALTURA
250 px
300 px

O exemplo a seguir redimensiona o KeyPad para 75% do tamanho original.


Sub Botao1_Click()
Application.GetKeyPad().SizeFactor = 0.75
Application.GetKeyPad().Show()
End Sub

Visualizao

231

4.3.2.14.2.5 Sound
Permite alterar o som emitido ao clicar-se em uma tecla do KeyPad. O valor
padro desta propriedade uma String vazia, significando que nenhum som
emitido ao clicar-se em uma tecla. Caso seja alterado o valor dessa propriedade,
necessrio que o novo valor seja o caminho absoluto de um arquivo no formato
WAV ou ento que este arquivo esteja includo no Domnio como um Recurso.
4.3.2.14.2.6 X
A coordenada X do canto superior esquerdo do objeto KeyPad. Esta propriedade
pode ser usada para mover o KeyPad no sentido horizontal.
4.3.2.14.2.7 Y
A coordenada Y do canto superior esquerdo do objeto KeyPad. Esta propriedade
pode ser usada para mover o KeyPad no sentido vertical.

4.4 E3Alarm
Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
E3Alarm.

4.4.1 Eventos
Esta seo contm informaes sobre os eventos do objeto E3Alarm.

4.4.1.1 KeyPress
KeyPress(KeyAscii)
Ocorre quando o E3Alarm tem o foco de teclado e o usurio pressiona uma tecla,
que corresponde a um caractere que pode ser mostrado em tela (uma tecla ANSI, de
cdigo indicado na varivel KeyAscii). Ou seja, o evento ocorre quando alguma das
teclas a seguir so pressionadas:
Qualquer caractere do teclado que possa ser impresso
Tecla CTRL combinada com qualquer caractere do alfabeto padro
Tecla CTRL combinada com qualquer caractere especial
Tecla BACKSPACE
Tecla ESC
Este evento no ocorre nas seguintes condies:
232

Visualizao

Pressionando-se a tecla TAB


Pressionando-se a tecla ENTER
Pressionando-se a tecla DEL (essa tecla no padro ANSI)
Pressionando-se as setas do teclado
Quando uma tecla faz com que o foco v de um objeto a outro
Enquanto um usurio pressiona uma tecla que produz um cdigo ANSI, o E3Alarm
recebe os eventos KeyDown e KeyPress repetidamente. Quando o usurio libera a
tecla, o evento KeyUp ocorre. Para monitorar o estado fsico do teclado ou
manipular teclas no reconhecidas pelo evento KeyPress (como teclas de funo,
navegao, etc.), utiliza-se os eventos KeyDown e KeyUp.

4.4.1.2 MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse se move sobre o objeto E3Alarm.

4.4.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto E3Alarm.

4.4.2.1 AboutBox
AboutBox()
Este mtodo exibe uma caixa de dilogo com informaes sobre verso e copyright
do objeto E3Alarm.

4.4.2.2 AckAll
AckAll([Operator])
Permite reconhecer globalmente todos os alarmes. Operator uma String opcional,
que indica o nome do operador que reconheceu o alarme. Esse valor ser mostrado
na coluna Operator do E3Alarm. Se for omitido, ser utilizado o usurio atual do
Viewer, ou ento "(Sem usurio)", caso no haja nenhum usurio logado. Para o
reconhecimento em si necessrio que o usurio logado tenha permisso para
reconhecer alarmes.

4.4.2.3 AckCurrentFilter
AckCurrentFilter([Operator])
Permite reconhecer todos os alarmes do filtro corrente. Operator uma String
Visualizao

233

opcional, que indica o nome do operador que reconheceu o alarme. Esse valor ser
mostrado na coluna Operator do E3Alarm. Se for omitido, ser utilizado o usurio
atual do Viewer, ou ento "(Sem usurio)", caso no haja nenhum usurio logado.
Para o reconhecimento em si necessrio que o usurio logado tenha permisso
para reconhecer alarmes.

4.4.2.4 AckSelected
AckSelected([Operator])
Permite reconhecer os alarmes selecionados. Se no houver alarme selecionado no
E3Alarm, o mtodo falha. O usurio poder reconhecer o alarme (neste caso, ser
inserido um novo registro no Banco de Dados indicando o reconhecimento), e no
E3Alarm a linha correspondente indicar que ele foi reconhecido. Operator uma
String opcional, que indica o nome do operador que reconheceu o alarme. Esse
valor ser mostrado na coluna Operator do E3Alarm. Se for omitido, ser utilizado
o usurio atual do Viewer, ou ento "(Sem usurio)", caso no haja nenhum
usurio logado. Para o reconhecimento em si necessrio que o usurio logado
tenha permisso para reconhecer alarmes.

4.4.2.5 GetFocusedEvent
GetFocusedEvent()
Este mtodo retorna um objeto com as propriedades do evento selecionado (aquele
que tem o foco atual) no E3Alarm, caso haja algum evento selecionado. Se nenhum
evento estiver selecionado, o mtodo retornar um objeto Nothing.
As propriedades do objeto retornado contm os valores dos campos do evento
selecionado. O objeto contm uma cpia dos valores no momento da chamada do
mtodo, portanto se houver uma mudana no evento selecionado, as propriedades
no sero atualizadas automaticamente, sendo necessrio utilizar o mtodo
sempre que houver necessidade de obter informaes atualizadas do evento
selecionado. As propriedades do objeto retornado pelo mtodo so as seguintes:
Propriedades do objeto retornado por GetFocusedEvent
NOME
Acked
AckRequired

234

DESCRIO
Informa s e o a l a rme foi reconheci do ou
n o. Es te ca mpo pode a s s umi r os va l ores 0,
n o reconheci do e 1, reconheci do.
Determi na o reconheci mento a utom ti co
do a l a rme. Es te ca mpo a pres enta os
va l ores 0, reconheci mento a utom ti co e 1,
reconheci mento ma nua l .

Visualizao

NOME
AckTime

ActorID

AlarmSourceName

Area

ConditionActive

Visualizao

DESCRIO
Regi s tra a da ta e hora do E3 no momento
em que o a l a rme reconheci do, ou zero
(30/12/1899), enqua nto o a l a rme n o for
reconheci do. No ca s o de a l a rmes que n o
pedem reconheci mento, o ca mpo a s s ume a
da ta e hora do E3 no momento em que o
a l a rme fi ca a ti vo.
Nome do opera dor que reconheceu o
a l a rme. Pode s er:
O us u ri o l oga do no Vi ewer, qua ndo o
reconheci mento fei to no E3Al a rm (ou
"Sem us u ri o", s e n o h us u ri o
l oga do)
"Sys tem", qua ndo o reconheci mento
a utom ti co (ou s eja , pa ra a l a rmes que
pedem reconheci mento)
Um nome pa s s a do por s cri pt (por
exempl o, us a ndo AckArea, AckAllAlarms,
LogTrackingEvent do Servi dor de Al a rmes ,
ou Ack da Fonte de Al a rmes )
O l i mi te des te ca mpo, qua ndo a rma zena do
no Ba nco de Da dos , de 50 ca ra cteres .
Regi s tra o nome da Fonte de Al a rme. O
l i mi te des te ca mpo, qua ndo a rma zena do
no Ba nco de Da dos , de 100 ca ra cteres . Por
exempl o, FonteAlarme1.
Pa ra eventos de a l a rmes , o nome da rea
a qua l a Fonte de Al a rmes pertence. Pa ra
outros eventos (por exempl o, us a ndo o
mtodo LogTrackingEvent do Servi dor de
Al a rmes ), pode s er um texto defi ni do pel o
us u ri o. O l i mi te des te ca mpo, qua ndo
a rma zena do no Ba nco de Da dos , de 100
ca ra cteres .
Indi ca s e a Fonte de Al a rmes es t em
a l a rme. Es te ca mpo a pres enta os es ta dos
0, condi o n o a ti va e 1, condi o a ti va .

235

NOME
ConditionName

CurrentValue

Enabled

EventCategory

EventCLSID

236

DESCRIO
Nome da condi o, s e for um evento de
a l a rme. Es te ca mpo pode a pres enta r os
s egui ntes va l ores :
Banda Morta: Fonte de Al a rme do ti po
Ba nda Morta
Digital: Fonte de Al a rme do ti po Di gi ta l
Nvel: Fonte de Al a rme do ti po Ana l gi co
TaxaDeVariao: Fonte de Al a rme do ti po
Ta xa de Va ri a o
Se o evento n o for um a l a rme (por
exempl o, us a ndo o mtodo LogTrackingEvent
do Servi dor de Al a rmes ), es te va l or s er
s empre uma String va zi a .O l i mi te des te
ca mpo, qua ndo a rma zena do no Ba nco de
Da dos , de 100 ca ra cteres .
Determi na o va l or da Fonte de Al a rme
(converti do pa ra Double) no momento do
evento. Pa ra outros eventos (por exempl o,
us a ndo o mtodo LogTrackingEvent), o va l or
s er s empre zero (0). O l i mi te des te ca mpo,
qua ndo a rma zena do no Ba nco de Da dos ,
de 100 ca ra cteres .
Determi na s e a veri fi ca o do a l a rme es t
ha bi l i ta da . Es te ca mpo a pres enta os
es ta dos 0, veri fi ca o da Fonte de Al a rme
des a bi l i ta da e 1, veri fi ca o da Fonte de
Al a rme ha bi l i ta da .
Ca tegori a do evento. Pa ra a l a rmes , es te
ca mpo pode a s s umi r os s egui ntes va l ores :
Banda Morta: Fonte de Al a rme do ti po
Ba nda Morta
Digital: Fonte de Al a rme do ti po Di gi ta l
Nvel: Fonte de Al a rme do ti po Ana l gi co
TaxaDeVariao: Fonte de Al a rme do ti po
Ta xa de Va ri a o
Pa ra outros eventos (por exempl o, us a ndo
o mtodo LogTrackingEvent do Servi dor de
Al a rmes ), o ca mpo pode a s s umi r va l ores
defi ni dos pel o us u ri o. O l i mi te des te
ca mpo, qua ndo a rma zena do no Ba nco de
Da dos , de 100 ca ra cteres .
Identi fi ca dor ni co pa ra toda a vi da de um
a l a rme. Qua ndo um a l a rme novo ocorre em
uma Fonte, gera do um novo nmero de
EventCLSID; a s s i m, el e i r ma nter es s e
mes mo CLSID no ba nco de da dos , enqua nto
n o s a i r da l i s ta de a l a rmes a ti vos e n o
reconheci dos .

Visualizao

NOME
EventTime
EventTimeUTC

EventType

FormattedValue

FullAlarmSourceName

InTime
Message

OutTime

Visualizao

DESCRIO
Da ta e hora do va l or da Fonte de Al a rme no
momento do evento.
Da ta e hora do va l or da Fonte de Al a rme no
momento do evento, com rel a o a o
hor ri o de Greenwi ch. O va l or o mes mo
do ca mpo EventTime, s endo ma nti do no E3
por ques tes de compa ti bi l i da de.
Ti po do evento. Pa ra eventos de a l a rme,
s empre Condition. Pa ra outros eventos , pode
s er um texto defi ni do pel o us u ri o, como
por exempl o, us a ndo o mtodo
LogTrackingEvent do Servi dor de Al a rmes
(Tra cki ng, Si mpl e, etc.). O l i mi te des te
ca mpo, qua ndo a rma zena do no Ba nco de
Da dos , de 100 ca ra cteres .
Mos tra o va l or forma ta do da Fonte de
Al a rme que va i pa ra o s eu evento. O l i mi te
des te ca mpo, qua ndo a rma zena do no
Ba nco de Da dos , de 100 ca ra cteres . NOTA:
Es te ca mpo s omente de l ei tura .
Regi s tra o ca mi nho compl eto da Fonte de
Al a rme, i ncl ui ndo rea s , nome da
Confi gura o de Al a rmes e de pos s vei s
Pa s ta s onde es ta pos s a es ta r i ns eri da . Por
exempl o,
Pasta1.ConfigAlarmes1.Area1.FonteA
larme1.
Regi s tra a da ta e hora do va l or no
momento em que el e entra na condi o de
a l a rme.
o texto confi gura do na Fonte de Al a rme,
ou es peci fi ca do por um outro evento (por
exempl o, us a ndo o mtodo LogTrackingEvent
do Servi dor de Al a rmes ). O l i mi te des te
ca mpo, qua ndo a rma zena do no Ba nco de
Da dos , de 200 ca ra cteres .
Regi s tra a da ta e hora do va l or no
momento em que el e s a i da condi o de
a l a rme; ou zero (30/12/1899), enqua nto o
a l a rme a i nda n o tenha s a do da condi o
a ti va .

237

NOME
Quality

Severity

Source

SubConditionName

UserField

238

DESCRIO
Qua l i da de do va l or da Fonte de Al a rme no
momento do evento. Es te ca mpo a s s ume os
va l ores numri cos
0 - 63: qua l i da de rui m
64 - 127: qua l i da de i ncerta
128 - 191: va l or i ndefi ni do
192 - 255: qua l i da de boa
Se o evento n o for um a l a rme (por
exempl o, s e el e es ti ver us a ndo o mtodo
LogTrackingEvent do Servi dor de Al a rmes ),
es te ca mpo s er i gua l a uma String va zi a .
Exempl o: Rui m (0); Incerta (64); ?? (128); Boa
(192).
o va l or de s everi da de confi gura do na
Fonte de Al a rme. Es te ca mpo pode a s s umi r
os va l ores 0, a l ta ; 1, mdi a ; 2, ba i xa . El e
pode ta mbm a s s umi r outro va l or defi ni do
pel o us u ri o s e for um evento, como por
exempl o qua ndo es ti ver us a ndo o mtodo
LogTrackingEvent.
Pa ra eventos de a l a rme, i nforma a
expres s o uti l i za da pa ra a va l i a r a s
condi es de a l a rme. O l i mi te des te
ca mpo, qua ndo a rma zena do no Ba nco de
Da dos , de 100 ca ra cteres . Por exempl o,
Dados.TagDemo1.Value.
Nome da s ubcondi o, s e for um evento de
a l a rme. Es te ca mpo pode a s s umi r os
s egui ntes va l ores :
BM: Al a rme de Ba nda Morta
DIG: Al a rme Di gi ta l
TV: Al a rme Ta xa de Va ri a o
LOLO: Al a rme Ana l gi co na fa i xa Mui to
Ba i xo
LO: Al a rme Ana l gi co na fa i xa Ba i xo
HI: Al a rme Ana l gi co na fa i xa Al to
HIHI: Al a rme Ana l gi co na fa i xa Mui to
Al to
Se o evento n o for um a l a rme (por
exempl o, s e el e es ti ver us a ndo o mtodo
LogTrackingEvent do Servi dor de Al a rmes ),
es te ca mpo s er i gua l a uma String va zi a . O
l i mi te des te ca mpo, qua ndo a rma zena do
no Ba nco de Da dos , de 100 ca ra cteres .
Propri eda de de l ei tura i ndexa da , cujo
ndi ce va ri a de 1 a t o nmero tota l de
ca mpos cri a dos pel o us u ri o.

Visualizao

Exemplo:
Dim evt
Set evt = GetFocusedEvent()
If NOT(evt Is Nothing) Then
Dim str
str = str & "EventTime = " & evt.EventTime & Chr(13)
str = str & "EventTimeUTC = " & evt.EventTimeUTC & Chr(13)
str = str & "InTime = " & evt.InTime & Chr(13)
str = str & "OutTime = " & evt.OutTime & Chr(13)
str = str & "AckTime = " & evt.AckTime & Chr(13)
str = str & "CurrentValue = " & evt.CurrentValue & Chr(13)
str = str & "ActorID = " & evt.ActorID & Chr(13)
str = str & "Area = " & evt.Area & Chr(13)
str = str & "AlarmSourceName = " & evt.AlarmSourceName &
Chr(13)
str = str & "FullAlarmSourceName = " &
evt.FullAlarmSourceName & Chr(13)
str = str & "ConditionName = " & evt.ConditionName & Chr(13)
str = str & "EventCategory = " & evt.EventCategory & Chr(13)
str = str & "EventType = " & evt.EventType & Chr(13)
str = str & "Message = " & evt.Message & Chr(13)
str = str & "Quality = " & evt.Quality & Chr(13)
str = str & "Source = " & evt.Source & Chr(13)
str = str & "SubConditionName = " & evt.SubConditionName &
Chr(13)
str = str & "FormattedValue = " & evt.FormattedValue &
Chr(13)
str = str & "UserField(1) = " & evt.UserField(1) & Chr(13)
str = str & "UserField(2) = " & evt.UserField(2) & Chr(13)
str = str & "UserField(3) = " & evt.UserField(3) & Chr(13)
str = str & "UserField(4) = " & evt.UserField(4) & Chr(13)
str = str & "Severity = " & evt.Severity & Chr(13)
str = str & "Acked = " & evt.Acked & Chr(13)
str = str & "AckRequired = " & evt.AckRequired & Chr(13)
str = str & "ConditionActive = " & evt.ConditionActive &
Chr(13)
str = str & "Enabled = " & evt.Enabled & Chr(13)
str = str & "EventCLSID = " & evt.EventCLSID & Chr(13)
MsgBox str
Else
MsgBox "Nenhum evento selecionado."
End If

4.4.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E3Alarm.

Visualizao

239

NOTA: O E3 uti l i za , pa ra defi ni o de coordena da s e es pes s ura , o s i s tema Hi metri c.


Nes te s i s tema , ca da uni da de l gi ca equi va l e a um mi l s i mo de centmetro; ou s eja ,
ca da 1000 uni da des equi va l em a um centmetro. As s i m, es te o pa dr o a dota do na
des cri o da s propri eda des do E3, qua ndo a pl i c vel .

4.4.3.1 ActiveAlarms
Determina o nmero total de alarmes ativos do objeto. Esta propriedade
somente de leitura.

4.4.3.2 ActiveHighAlarms
Indica o nmero de alarmes ativos com severidade alta. Esta propriedade
somente de leitura.

4.4.3.3 ActiveHighNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade alta. Esta
propriedade somente de leitura.

4.4.3.4 ActiveLowAlarms
Indica o nmero de alarmes ativos com severidade baixa. Esta propriedade
somente de leitura.

4.4.3.5 ActiveLowNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade baixa. Esta
propriedade somente de leitura.

4.4.3.6 ActiveMedAlarms
Indica o nmero de alarmes ativos com severidade mdia. Esta propriedade
somente de leitura.

4.4.3.7 ActiveMedNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade mdia. Esta
propriedade somente de leitura.

4.4.3.8 ActiveNACKAlarms
Indica o nmero total de alarmes que esto sem reconhecimento no objeto (ativos
ou no). Esta propriedade somente de leitura.

240

Visualizao

4.4.3.9 AlarmServer
Nome do Servidor de Alarmes nico existente na aplicao.

4.4.3.10 AllowAckAll
Habilita a opo presente no menu contextual do E3Alarm, que permite o
reconhecimento de todos os alarmes. O valor padro desta propriedade True.

4.4.3.11 AllowAckCurrentFilter
Habilita a opo presente no menu contextual do E3Alarm, que permite o
reconhecimento de todos os alarmes do filtro atual. Se no houverem alarmes
visveis, a propriedade no tem efeito. O valor padro desta propriedade True.

4.4.3.12 AllowAckSelected
Habilita a opo presente no menu contextual do E3Alarm, que permite o
reconhecimento de alarmes selecionados. Se no houver alarmes selecionados, a
propriedade no tem efeito. O valor padro desta propriedade True.

4.4.3.13 AllowColumnClick
Habilita ou desabilita a seleo dos campos e a direo de ordenao destes,
atravs do clique no cabealho das colunas do E3Alarm em tempo de execuo. Se
esta opo estiver configurada para True e o cabealho estiver visvel (ver a
propriedade ColumnHeader), ao clicar no ttulo da coluna os dados sero
ordenados, tendo esta coluna como chave. Clicando novamente nesta mesma
coluna, a ordenao ser feita na direo contrria (muda-se a ordem ascendente
para descendente e vice-versa). Ao clicar na coluna com a tecla SHIFT pressionada,
o campo usado como segunda chave. Como na chave primria, um segundo clique
com SHIFT inverte a ordenao do campo secundrio.

4.4.3.14 AreaFilter
Controla as reas de alarmes visveis no E3Alarm. Se seu valor no for uma String
vazia, so apresentados eventos cujo nome das reas comecem com o texto
indicado. Por exemplo, se AreaFilter igual a "Ana", so mostrados os alarmes de
reas como "Analogicos.Producao" ou "Analise", mas no "Digitais.Analise" ou
"Digitais.Producao". Quando a propriedade SimpleAreaFilter estiver configurada
como False, a rea de Alarme tambm permite o uso de coringas para a filtragem (*
ou ?), e permite mltiplos filtros de rea, separados por dois pontos. Os coringas
permitidos so:
"*": Aceita nenhum ou qualquer quantidade de caracteres
"?": Aceita um caractere qualquer
Visualizao

241

"#": Aceita um dgito qualquer


"[ ]": Permite especificar um conjunto de caracteres
"[ab]": Aceita um caractere se for "a" ou "b"
"[f-h]": Aceita um caractere entre "f" e "h"
"[!cz]": Aceita um caractere que no seja nem "c" nem "z"
"[!m-p]": Aceita um caractere que no esteja entre "m" e "p"
O padro dessa propriedade uma String vazia, ou seja, sem filtragem por rea
(ver tambm as propriedades CustomFilter, SimpleAreaFilter, ShowHighPriority,
ShowMediumPriority e ShowLowPriority).
NOTA: A propri eda de AreaFilter corres ponde propri eda de Filter, di s ponvel a t a
vers o 4.0 do E3.

4.4.3.15 BannerMode
Habilita a visualizao de apenas uma mensagem no E3Alarm. A mensagem
mostrada depender da configurao de ordenao e sempre estar selecionada. O
valor padro desta propriedade Falso. Para maiores informaes sobre a
configurao de ordenao, consulte o tpico Aba Ordenao, no Manual do
Usurio do E3.

4.4.3.16 BorderColor
Define a cor da borda do E3Alarm. O valor padro desta propriedade preto
(RGB(0, 0, 0)).

4.4.3.17 BorderThickness
Define a espessura da borda do E3Alarm. O valor desta propriedade pode variar
entre 0 (zero, que desabilita a borda) e 10, e seu padro 1 (um).

4.4.3.18 ColumnHeader
Quando configurada como True, esta propriedade habilita a visualizao do
cabealho do E3Alarm. O cabealho tambm permite que seja feita a reordenao
dos dados da tabela visualmente (ver propriedade AllowColumnClick). O valor
padro desta propriedade True.

242

Visualizao

4.4.3.19 CustomFilter
Permite informar um filtro customizado para os alarmes, na forma de uma
expresso. Os seguintes campos esto disponveis para utilizao na expresso do
filtro:
AckRequired (Booleano): Indica se necessrio reconhecer esta mensagem.
Acked (Booleano): Indica se esta mensagem j foi reconhecida.
AckTime (Data): Data e hora em que a condio de alarme foi reconhecida (ou
zero se no foi reconhecida).
ActiveSource (Inteiro): -1: None, 0: ActiveSource, 1: Scada, 2: Operator, 3: CCLink,
4: Billing, 5: Calculated, 6: Database, 100: TopologyProcessor, 101: PowerFlow,
102: StateEstimator, 103: LoadShedding.
ActorID (String): Login do usurio que reconheceu a mensagem (ou uma String
vazia se a mensagem ainda no foi reconhecida).
AlarmArea (String): rea deste alarme.
AlarmSourceName (String): Nome do objeto Fonte de Alarme (apenas o nome, no
o caminho completo).
ChangeMask (Inteiro): Campo no utilizado pelo E3 atualmente, sempre em 0
(zero).
ConditionName (String): Nome da ltima condio de alarme ativa.
ConditionActive (Booleano): Indica se a condio de alarme est ativa.
Cookie (Inteiro): Identifica uma Fonte de Alarme durante uma seo de execuo.
CurrentValue (Double): Valor da Fonte no momento em que a condio de alarme
ficou ativa.
Enabled (Booleano): Indica se a verificao de alarmes na Fonte de Alarme est
habilitada.
EventCategory (String): Nome da categoria do alarme (por exemplo, "Nvel", "Taxa
de Variao", "Banda Morta", "Digital" ou "Discreto").
EventTime (Data): Data e hora da ltima atualizao do evento.
EventTimeUTC (Data): Data e hora (UTC) da ltima atualizao do evento.
EventType (String): "Event" (evento) ou "Condition" (alarme).
FullAlarmSourceName (String): Nome completo do objeto Fonte de Alarme.
FormattedValue (String): Contm o valor (formatado) da Fonte no momento em
que a condio de alarme ficou ativa.
Visualizao

243

InTime (Data): Data e hora em que a condio de alarme ficou ativa.


Message (String): Mensagem do alarme.
OutTime (Data): Data e hora em que a condio saiu de alarme (ou zero se ainda
est ativa).
Quality (String): "Boa (xxx)", "Ruim (xxx)" ou "Incerta (xxx)".
Severity (Inteiro): 0: Alta, 1: Mdia ou 2: Baixa.
Source (String): Link da Fonte de Alarme.
SubConditionName (String): Nome da subcondio de alarme (por exemplo,
"LOLO", "LO", "HI", "HIHI", "DIG", etc.).
Os campos definidos pelo usurio tambm podem ser utilizados na expresso do
filtro, utilizando-se o nome definido no Servidor de Alarmes.
Ao todo, as mensagens que aparecem na listagem do E3Alarm sempre passam por
cinco filtros:
Filtro por tipo (alarme ou evento) (propriedade FilterType)
Filtro por severidade (propriedades ShowLowPriority, ShowMediumPriority e
ShowHighPriority)
Filtro por rea (propriedades AreaFilter e SimpleAreaFilter)
Filtro pela propriedade CustomFilter
Filtro do sumrio de alarmes (equivalente expresso "Enabled AND
(ConditionActive OR (AckRequired AND NOT Acked))")
Exemplos de utilizao da propriedade CustomFilter:
Para um campo de usurio chamado IsSupressed, e que se queira mostrar apenas
alarmes em que este campo tem valor diferente de zero, a expresso a ser
utilizada a seguinte:
IsSupressed <> 0

Para mostrar apenas mensagens com a subcondio "HIHI" ou "LOLO" de objetos


de alarme cujo nome inicie por "Pressure", a expresso a ser utilizada a
seguinte:
(SubConditionName = "HIHI" OR SubConditionName = "LOLO") AND
(Mid(AlarmSourceName, 1, 8) = "Pressure")

244

Visualizao

4.4.3.20 Domain
Especifica o Domnio ao qual o E3Alarm ir se conectar. O padro desta
propriedade uma String vazia, ou seja, o E3Alarm se conecta ao mesmo Domnio
do Viewer onde ele se encontra. Por exemplo, \\NomeDeOutroServidor.

4.4.3.21 Enabled
Habilita o objeto ActiveX no projeto. O valor padro desta propriedade True.

4.4.3.22 FilterType
Efetua os filtros de alarme. As opes disponveis so:
1 - OnlyAlarms: mostra apenas alarmes
2 - OnlyEvents: mostra apenas eventos
3 - AlarmsAndEvents: mostra tanto alarmes quanto eventos

4.4.3.23 Font
Determina a fonte (tipo de letra) do cabealho e das linhas do E3Alarm. Esta
propriedade somente de leitura e s pode ser modificada via Studio, no em
tempo de execuo.

4.4.3.24 FourthSortAscending
Quando esta propriedade estiver configurada para False, a ordenao de eventos
pelo campo quaternrio ser no sentido descendente. Caso contrrio, o sentido
ser ascendente. O valor padro desta propriedade False.

4.4.3.25 FourthSortField
Determina o campo quaternrio para a ordenao dos eventos no E3Alarm. O
nome do campo deve ser sempre especificado em ingls (veja os campos
disponveis no Manual do Usurio do E3). O valor padro dessa propriedade uma
String vazia. Esta propriedade no tem efeito quando as propriedades
PrimarySortField, SecondarySortField ou ThirdSortField forem configuradas como
uma String vazia.

4.4.3.26 GridBkColor
Esta propriedade determina a cor de fundo do E3Alarm. O valor padro desta
propriedade a cor configurada no Windows para o item Janela (Painel de Controle
- Vdeo - Aparncia - Avanada).
Visualizao

245

4.4.3.27 InactiveHighNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade alta.
Esta propriedade somente de leitura.

4.4.3.28 InactiveLowNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade baixa.
Esta propriedade somente de leitura.

4.4.3.29 InactiveMedNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade mdia.
Esta propriedade somente de leitura.

4.4.3.30 InactiveNACKAlarms
Determina o nmero total de alarmes inativos e no reconhecidos. Esta
propriedade somente de leitura.

4.4.3.31 PopupMenu
Habilita um menu contextual ao clicar com o boto direito do mouse sobre o
objeto E3Alarm. O valor padro desta propriedade True.

4.4.3.32 PrimarySortAscending
Quando esta propriedade estiver configurada para False, a ordenao de eventos
pelo campo primrio ser no sentido descendente. Caso contrrio, o sentido ser
ascendente. O valor padro desta propriedade False.

4.4.3.33 PrimarySortField
Determina o campo primrio para a ordenao dos eventos no E3Alarm. O nome
do campo deve ser sempre especificado em ingls (veja os campos disponveis no
Manual do Usurio do E3). O valor padro dessa propriedade "EventTime". Quando
esta propriedade uma String vazia, as propriedades SecondarySortField,
ThirdSortField e FourthSortField no tm efeito.

4.4.3.34 SecondarySortAscending
Quando esta propriedade estiver configurada para True, a ordenao de eventos
pelo campo secundrio ser no sentido ascendente. Caso contrrio, o sentido ser
descendente. O valor padro desta propriedade False.

246

Visualizao

4.4.3.35 SecondarySortField
Determina o campo secundrio para a ordenao dos eventos no E3Alarm. O
nome do campo deve ser sempre especificado em ingls (veja os campos
disponveis no Manual do Usurio do E3). O valor padro dessa propriedade uma
String vazia. Esta propriedade no tem efeito quando a propriedade
PrimarySortField for configurada como uma String vazia.

4.4.3.36 ShowHighPriority
Filtra quais alarmes so mostrados ou no, de acordo com a sua severidade.
Quando estiver em True, so mostrados os alarmes de severidade alta; do
contrrio, estes alarmes no so mostrados. O valor padro desta propriedade
True.

4.4.3.37 ShowLowPriority
Filtra quais alarmes so mostrados ou no, de acordo com a sua severidade.
Quando estiver em True, so mostrados os alarmes de severidade baixa; do
contrrio, estes alarmes no so mostrados. O valor padro desta propriedade
True.

4.4.3.38 ShowMediumPriority
Filtra quais alarmes so mostrados ou no, de acordo com a sua severidade.
Quando estiver em True, so mostrados os alarmes de severidade mdia; do
contrrio, estes alarmes no so mostrados. O valor padro desta propriedade
True.

4.4.3.39 SimpleAreaFilter
Quando esta propriedade for igual a Verdadeiro, o comportamento de filtragem
pelo nome de rea de Alarmes baseado apenas na coincidncia da parte inicial
do nome. Quando for igual a Falso, o comportamento leva em conta todo o nome da
rea, mas permite o uso de caracteres coringa e mltiplos filtros de rea, que
devem ser separados por dois pontos. Ver tambm a propriedade AreaFilter, que
especifica o filtro por nome de rea.

4.4.3.40 ThirdSortAscending
Quando esta propriedade estiver configurada para False, a ordenao de eventos
pelo campo tercirio ser no sentido descendente. Caso contrrio, o sentido ser
ascendente. O valor padro desta propriedade False.

Visualizao

247

4.4.3.41 ThirdSortField
Determina o campo tercirio para a ordenao dos eventos no E3Alarm. O nome
do campo deve ser sempre especificado em ingls (veja os campos disponveis no
Manual do Usurio do E3). O valor padro dessa propriedade uma String vazia.
Esta propriedade no tem efeito quando as propriedades PrimarySortField ou
SecondarySortField forem configuradas como uma String vazia.

4.5 E3Browser
Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
E3Browser.

4.5.1 Eventos
Esta seo contm informaes sobre os eventos do objeto E3Browser.

4.5.1.1 KeyPress
KeyPress(KeyAscii)
Ocorre quando o E3Browser tem o foco de teclado e o usurio pressiona uma tecla,
que corresponde a um caractere que pode ser mostrado em tela (uma tecla ANSI, de
cdigo indicado na varivel KeyAscii). Ou seja, o evento ocorre quando alguma das
teclas a seguir so pressionadas:
Qualquer caractere do teclado que possa ser impresso
Tecla CTRL combinada com qualquer caractere do alfabeto padro
Tecla CTRL combinada com qualquer caractere especial
Tecla BACKSPACE
Tecla ESC
Este evento no ocorre nas seguintes condies:
Pressionando-se a tecla TAB
Pressionando-se a tecla ENTER
Pressionando-se a tecla DEL (essa tecla no padro ANSI)
Pressionando-se as setas do teclado
Quando uma tecla faz com que o foco v de um objeto a outro
Enquanto um usurio pressiona uma tecla que produz um cdigo ANSI, o E3Browser
248

Visualizao

recebe os eventos KeyDown e KeyPress repetidamente. Quando o usurio libera a


tecla, o evento KeyUp ocorre. Para monitorar o estado fsico do teclado ou
manipular teclas no reconhecidas pelo evento KeyPress (como teclas de funo,
navegao, etc.), utiliza-se os eventos KeyDown e KeyUp.

4.5.1.2 MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse se move sobre o objeto E3Browser.

4.5.1.3 OnDrawRow
OnDrawRow(Selected, Line, TextColor, BackColor)
Este evento passa quatro parmetros: Selected indica se a linha est selecionada;
Line indica o nmero da linha sendo desenhada; TextColor indica a cor do texto da
linha; e BackColor indica a cor de fundo do texto. Se a cor for modificada dentro
deste evento, esta modificao ser usada pelo E3Browser no desenho da linha.
Outra modificao importante que se o mtodo GetColumnValue for chamado de
dentro do evento, os valores retornados sero os da linha sendo desenhada, e no
os da linha selecionada.

4.5.1.4 OnFormatCell
OnFormatCell(Column, FieldName, OriginalValue, FormattedValue)
Este evento permite personalizar o formato do texto das clulas do E3Browser. Os
parmetros deste evento so os seguintes:
Column: ndice da coluna visvel do E3Browser (iniciando em 0). Permite
identificar a coluna da clula que est sendo formatada
FieldName: Texto com o nome do campo da coluna sendo formatada
OriginalValue: Valor no formatado da clula, do tipo Variant
FormattedValue: Valor formatado, do tipo Variant, de acordo com a configurao
da coluna do E3Browser. Se for modificado dentro do evento, permite alterar o
texto formatado
Exemplo (formatao de campos de Alarmes):
Sub E3Browser1_OnFormatCell(Column, FieldName, OriginalValue,
FormattedValue)
If Column = 15 Then
If Not IsNull(OriginalValue) Then
FormattedValue = SourceTypeName(OriginalValue)
ElseIf Column = 9 Then
If OriginalValue = 0 Then
FormattedValue = "Alta"

Visualizao

249

ElseIf OriginalValue = 1 Then


FormattedValue = "Mdia"
Else
FormattedValue = "Baixa"
End If
End If
End Sub

4.5.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto E3Browser.

4.5.2.1 AboutBox
AboutBox()
Este mtodo exibe uma caixa de dilogo com informaes sobre verso e copyright
do objeto E3Browser.

4.5.2.2 ClearFields
ClearFields()
Limpa a formatao de colunas e linhas do E3Browser.

4.5.2.3 GetColumnValue
GetColumnValue(Index)
Retorna o valor de uma clula, na coluna informada e na linha selecionada. Este
mtodo possui o parmetro Index, que determina o ndice da coluna desejada.

4.5.2.4 Requery
Requery()
O mtodo Requery atualiza a Consulta, utilizando sua configurao atual, e retorna
os dados para o E3Browser.

4.5.2.5 RetrieveE3QueryFields
RetrieveE3QueryFields()
O mtodo RetrieveE3QueryFields l a estrutura de dados da consulta e atualiza a
formatao do E3Browser, com os campos definidos na consulta. Se for bem
sucedido, retorna True. Caso contrrio, retorna False. Este mtodo especialmente
til quando se precisa usar um nico E3Browser para exibir dados de diferentes
tabelas ou consultas.

250

Visualizao

4.5.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E3Browser.

4.5.3.1 AllowColumnResize
Habilita ou desabilita a configurao do tamanho das colunas da grade do
objeto, em tempo de execuo. Se esta propriedade estiver configurada para False,
o tamanho das colunas fixo e no poder ser modificado.

4.5.3.2 AllowRowResize
Habilita ou desabilita a configurao do tamanho das linhas da grade do objeto,
em tempo de execuo. Se esta propriedade estiver configurada para False, o
tamanho das linhas fixo e no poder ser modificado.

4.5.3.3 ColumnWidth
Determina a largura das colunas do E3Browser, em pixels.

4.5.3.4 CurSel
Indica a posio atual do cursor do E3Browser, ou seja, o ndice da linha em que
ele est posicionado.

4.5.3.5 E3Query
Retorna o objeto Consulta do E3Browser, para que se possa acessar suas
propriedades.

4.5.3.6 Fields
Retorna o objeto Campos do E3Browser, que contm a lista com todos os
campos da tabela, tornando possvel a sua referncia atravs dos itens dessa
coleo. O valor padro desta propriedade vazio. Exemplo:
Sub E3Browser1_Click()
' Troca a cor do campo Campo1
Set fields = Screen.Item("E3Browser").Fields
Set campo1 = fields.Item("Campo1")
campo1.BkColor = RGB(255, 0, 0) ' Vermelho
' Mostra quantos campos tem o E3Browser
MsgBox fields.Count
' Mostra o nome dos campos do E3Browser
For Each field In fields
MsgBox field.Name
Next
End Sub

Visualizao

251

4.5.3.7 FixedBkColor
Especifica a cor do fundo da primeira coluna do E3Browser. O valor padro
desta propriedade a cor bege (RGB(236, 233, 216)).

4.5.3.8 FixedColumnWidth
Determina a largura da primeira coluna do E3Browser, em pixels. O valor padro
desta propriedade 30 pixels.

4.5.3.9 FixedRowFont
Determina a fonte (texto) utilizada na linha de cabealho do E3Browser. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada somente via Studio. O valor padro desta propriedade a fonte Arial.

4.5.3.10 FixedRowHeight
Determina a altura (em pixels) da linha de cabealho do E3Browser. O valor
padro desta propriedade 20.

4.5.3.11 FixedTextColor
Muda a cor do cabealho do E3Browser.

4.5.3.12 GridBkColor
Determina a cor de fundo da rea de dados do E3Browser. O valor padro desta
propriedade a cor branca (RGB(255, 255, 255)).

4.5.3.13 GridFont
Determina a fonte utilizada nos textos da rea de dados do E3Browser. O valor
padro desta propriedade a fonte Arial. Esta propriedade no pode ser utilizada
em scripts ou em Associaes, sendo configurada somente via Studio.

4.5.3.14 GridLineColor
Determina a cor das linhas da grade de dados do E3Browser. O valor padro
desta propriedade cinza (RGB(192, 192, 192)).

4.5.3.15 GridLinesType
Determina o tipo de linhas a serem desenhadas na grade de dados do
E3Browser.
252

Visualizao

Opes disponveis para GridLinesType


OPO
0 - GLNone
1 - GLHorz
2 - GLVert
3 - GLBoth

DESCRIO
Sem l i nha s s epa ra dora s .
Somente a s l i nha s hori zonta i s (pa dr o).
Somente a s l i nha s verti ca i s .
Li nha s verti ca i s e hori zonta i s .

4.5.3.16 RefreshTime
Especifica o tempo de atualizao da Consulta em relao ao Banco de Dados.
Atravs desta propriedade possvel verificar as atualizaes dos dados no
Histrico relacionado, referente a um determinado tempo estipulado (em
milissegundos). Quando a propriedade RefreshTime for igual a 0, no h
atualizao dos dados, e eles permanecem inalterados.

4.5.3.17 RowHeight
Define a altura das linhas da E3Browser, em pixels. O valor padro desta
propriedade 20.

4.5.3.18 SelectRow
Estabelece a possibilidade de seleo das linhas do E3Browser. Se estiver
configurada para True, ser possvel selecionar as linhas; do contrrio, as linhas
no podem ser selecionadas.

4.5.3.19 SourceQuery
Contm a referncia para o objeto Consulta ao qual o E3Browser est associado.
NOTA: Pa ra troca r a Cons ul ta do E3Brows er por mei o de um s cri pt (ca s o a nova
Cons ul ta modi fi que os ca mpos da Cons ul ta ori gi na l ), a l m de a l tera r a
propri eda de SourceQuery, preci s o uti l i za r os mtodos RetrieveE3QueryFields e
Requery.

4.5.3.20 TextBkColor
Especifica a cor de fundo das clulas de dados do E3Browser. O valor padro
desta propriedade a cor branca (RGB(255, 255, 255)).

4.5.3.21 TextColor
Especifica a cor do texto do E3Browser. O valor padro desta propriedade a cor
preta (RGB(0,0,0)).
Visualizao

253

4.5.3.22 TitleTipBkColor
Especifica a cor do fundo do texto da dica do E3Browser. O valor padro desta
propriedade a cor preta (RGB(0, 0, 0)).

4.5.3.23 TitleTipTextColor
Especifica a cor do texto da dica do E3Browser. O valor padro desta
propriedade a cor cinza (RGB(204, 204, 204)).

4.5.3.24 ToolbarBkColor
Especifica a cor de fundo da barra de funes do E3Browser. O valor padro
desta propriedade bege (RGB(236, 233, 216)).

4.5.3.25 ToolbarFont
Determina a fonte utilizada nos textos da barra de funes do E3Browser. Esta
propriedade no pode ser utilizada em scripts ou em Associaes, sendo
configurada somente via Studio.

4.5.3.26 ToolbarForeColor
Especifica a cor de frente da barra de funes do E3Browser. O valor padro
desta propriedade preto (RGB(0, 0, 0)).

4.5.4 Campos do E3Browser


Esta seo contm informaes sobre propriedades dos campos do objeto
E3Browser. Estes campos no possuem eventos nem mtodos associados.

4.5.4.1 Propriedades
Esta seo contm informaes sobre as propriedades dos campos do objeto
E3Browser.

4.5.4.1.1 BkColor
Determina a cor de fundo do campo do E3Browser. O valor padro a cor
configurada no Windows para o item Janela do Painel de Controle (Painel de
Controle - Vdeo - Aparncia - Avanada).

4.5.4.1.2 Color
Retorna a cor do texto do campo. O valor padro dessa propriedade preto
(RGB(0, 0, 0)).
254

Visualizao

4.5.4.1.3 Format
Configura o formatador usado na coluna.

4.5.4.1.4 Name
Retorna o nome do campo.

4.5.4.1.5 Visible
Habilita ou desabilita a visibilidade do campo selecionado na Consulta do
E3Browser. Se a propriedade estiver configurada para True, o campo ser visvel no
E3Browser. Caso contrrio, o campo no mostrado no E3Browser, em tempo de
execuo. O valor padro True.

4.5.4.1.6 Width
Retorna a largura do campo, em pixels.

4.6 E3Chart
Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
E3Chart.

4.6.1 Eventos
Esta seo contm informaes sobre os eventos do objeto E3Chart.

4.6.1.1 OnCursorChange
OnCursorChange()
Ocorre quando o cursor do E3Chart muda de posio. Por exemplo, pode-se criar
um script para este evento quando for necessrio mostrar os valores de posio do
cursor na Tela. Exemplo:
Sub E3Chart1_OnCursorChange()
Set Chart = Application.GetFrame("").Screen.Item("E3Chart1")
Set Pena = Chart.Pens.Item(0)
' O objeto Text1 deve mostrar a posio atual do cursor
Set Texto = Application.GetFrame("").Screen.Item("Text1")
If Pena.GetCursorPos(aa, bb) Then
Texto.Value = "Posio X = " & aa & "; Posio Y = " & bb
End If
End Sub

Visualizao

255

4.6.1.2 OnLegendClick
OnLegendClick(Row, Col, RowData)
Ocorre quando o usurio clica em uma linha da Legenda. Os parmetros Row e Col
indicam, respectivamente, a linha e a coluna clicadas. O parmetro RowData o
ndice da Pena da Legenda onde ocorreu o clique. Exemplo:
Sub E3Chart1_OnLegendClick(Row, Col, RowData)
Set texto = Screen.Item("Texto1")
texto.Value = Legend.Item(col).Name & " " & _
Pens.Item(RowData).name
End Sub

4.6.1.3 OnQueryFinish
OnQueryFinish()
Ocorre quando uma ou mais Consultas so encerradas no objeto. Quando o evento
gerado, a chamada do mtodo FitAll ou FitPen pode causar problemas caso se
esteja utilizando a Consulta automtica, j que o mtodo ativa outras Consultas
at que todos os dados sejam lidos. Neste caso, recomendado que o valor
passado pelos parmetros destes mtodos seja 1 (um), o que enquadra
verticalmente as Penas.

4.6.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto E3Chart.

4.6.2.1 ClearPenMarks
ClearPenMarks()
Remove as marcas de pesquisa de todas as Penas do E3Chart.

4.6.2.2 CopyConfig
CopyConfig(SourceChart[, Flags])
O mtodo CopyConfig copia as configuraes de um E3Chart para outro. O
parmetro SourceChart indica o E3Chart de origem, cujas propriedades sero
copiadas para o E3Chart que chamou o mtodo.
NOTA: No ca s o dos Rel a tri os , o mtodo CopyConfig i r funci ona r s omente com
Pena s do ti po Histrica.

Por exemplo, para copiar a configurao de um E3Chart que est em uma Tela
(ScreenChart) para outro que est dentro de um Relatrio (ReportChart), o
256

Visualizao

seguinte script pode ser adicionado no objeto Report associado ao Relatrio:


Sub OnBeforePrint
Set Chart = _
Report.Sections("PageHeader").Controls("ReportChart")
Chart.CopyConfig(Application.GetFrame()._
Screen.Item("ScreenChart"))
Chart.LoadData()
Chart.FitAll()
End Sub
NOTA: Es te mtodo ta mbm pos s ui o pa r metro opci ona l e n o us a do Flags,
s omente pa ra fi ns de compa ti bi l i da de com vers es a nteri ores .

4.6.2.3 FitAll
FitAll([FitStyle])
Enquadra todas as Penas no E3Chart. O parmetro opcional FitStyle indica o modo
de enquadramento das Penas em tempo de execuo:
0: Enquadra ambos os Eixos ao mesmo tempo
1: Enquadra apenas o Eixo Vertical
2: Enquadra apenas o Eixo Horizontal

4.6.2.4 FitPen
FitPen(Pen[, FitStyle])
Enquadra uma Pena no E3Chart, especificada pelo ndice ou pelo nome. O
parmetro Pen define a Pena que ser enquadrada no E3Chart (ndice ou nome da
Pena). O parmetro opcional FitStyle indica o modo de enquadramento das Penas
em tempo de execuo:
0: Enquadra ambos os Eixos ao mesmo tempo
1: Enquadra apenas o Eixo Vertical
2: Enquadra apenas o Eixo Horizontal
Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.FitPen(1)
Chart.FitPen("Pen1", 1)
' Enquadra a Pen1 somente na vertical
End Sub

Visualizao

257

4.6.2.5 LoadData
LoadData()
Carrega os dados no E3Chart. Este mtodo especialmente usado para carregar os
dados antes de imprimir, quando usado em um objeto Relatrio.
NOTA: O mtodo LoadData s er s ncrono s omente s e a Pena n o es ti ver em modo
Automtico.

4.6.2.6 ResetConfig
ResetConfig([Flags])
Remove todas as configuraes ajustadas em um E3Chart, devolvendo-o ao estado
inicial.
NOTA: Es te mtodo ta mbm pos s ui o pa r metro opci ona l e n o us a do Flags,
s omente pa ra fi ns de compa ti bi l i da de com vers es a nteri ores .

4.6.2.7 ShowCursors
ShowCursors()
Ativa o modo Pesquisa de Intervalo. Em tempo de execuo, este recurso pode ser
acessado atravs do clique com o boto direito do mouse sobre o objeto e
selecionando a opo Pesquisar Intervalos do menu de contexto.

4.6.2.8 ZoomIn
ZoomIn()
O mtodo ZoomIn aumenta o zoom no E3Chart, isto , aproxima a visualizao das
Penas. Em tempo de execuo, este recurso pode ser acessado atravs do clique
com o boto direito do mouse sobre o objeto e selecionando a opo Mais Zoom do
menu de contexto.

4.6.2.9 ZoomOut
ZoomOut()
O mtodo ZoomOut diminui o zoom no E3Chart, isto , afasta a visualizao das
Penas no E3Chart. Em tempo de execuo, este recurso pode ser acessado atravs
do clique com o boto direito do mouse sobre o E3Chart e selecionando a opo
Menos Zoom.

258

Visualizao

4.6.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E3Chart.

4.6.3.1 Axes
Retorna a coleo de Eixos do E3Chart. A partir da, as propriedades da coleo
de Eixos podem ser modificadas.

4.6.3.2 BackColor
Determina a cor de fundo do E3Chart. Para que esta cor aparea, a propriedade
ShowBackground deve estar configurada como True. O valor padro desta
propriedade bege (RGB(236, 233, 216)).

4.6.3.3 CursorBegin
Define a posio do cursor inicial, entre 0 e 1. necessrio executar o mtodo
ShowCursors ou habilitar a opo Pesquisa de Intervalos para que os cursores
apaream.

4.6.3.4 CursorColor
Estabelece a cor do cursor de pesquisa de intervalo. O valor padro vermelho
(RGB(255, 0, 0)).

4.6.3.5 CursorEnd
Define a posio do cursor final, entre 0 e 1. necessrio executar o mtodo
ShowCursors ou habilitar a opo Pesquisa de Intervalos para que os cursores
apaream.

4.6.3.6 CursorLineStyle
Estilo de linha do cursor de pesquisa de intervalo. As opes disponveis so:
Opes disponveis para CursorLineStyle
OPO
0 - LS_Solid
1 - LS_Dash
2 - LS_Dot
3 - LS_Dashdot

Visualizao

DESCRIO
Apl i ca uma l i nha s l i da no curs or de
i nterva l o do E3Cha rt.
Apl i ca uma l i nha tra ceja da no curs or de
i nterva l o do E3Cha rt.
Apl i ca uma l i nha ponti l ha da no curs or
de i nterva l o do E3Cha rt.
Apl i ca uma l i nha tra o e ponto no curs or
de i nterva l o do E3Cha rt.

259

OPO
4 - LS_Dashdotdot
5 - LS_Null

DESCRIO
Apl i ca uma l i nha tra o ponto ponto no
curs or de i nterva l o do E3Cha rt.
Apl i ca uma l i nha i nvi s vel no curs or de
i nterva l o do E3Cha rt.

4.6.3.7 CursorLineWidth
Estabelece a largura do cursor de intervalo.

4.6.3.8 CursorSearchStyle
Permite que o cursor pesquise os pontos do grfico, de acordo com as seguintes
opes:
0 - PointNearest: Pesquisa o ponto mais prximo
1 - LinearInterpolation: Pesquisa um ponto interpolado
2 - PointPrevious: Pesquisa o ponto anterior

4.6.3.9 ForeColor
Determina a cor de frente do E3Chart. O valor padro desta propriedade preto
(RGB(0, 0, 0)).

4.6.3.10 GridBkColor
Determina a cor de fundo da grade do E3Chart. O valor padro desta propriedade
branco (RGB(255, 255, 255)). Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.GridBkColor
MsgBox "Prxima"
E3Chart1.GridBkColor = RGB(0, 255, 0)
MsgBox "Voltar"
E3Chart1.GridBkColor = Old
End Sub

4.6.3.11 HorAxisTitle
Determina o ttulo do Eixo Horizontal principal. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1= Screen.Item("E3Chart1")
Old = E3Chart1.HorAxisTitle
MsgBox "Prxima"
E3Chart1.HorAxisTitle = "!Teste"
MsgBox "Voltar"
E3Chart1.HorAxisTitle = Old

260

Visualizao

End Sub

4.6.3.12 HorGrid
Determina o tipo de linha que ser aplicada na grade horizontal do E3Chart.
Opes disponveis para HorGrid
OPO
0 - Solid
1 - Dash
2 - Dot
3 - Dashdot
4 - Dashdotdot
5 - Invisible

DESCRIO
Apl i ca uma l i nha s l i da na gra de
hori zonta l do E3Cha rt.
Apl i ca uma l i nha tra ceja da na gra de
hori zonta l do E3Cha rt.
Apl i ca uma l i nha ponti l ha da na gra de
hori zonta l do E3Cha rt (pa dr o).
Apl i ca uma l i nha tra o e ponto na gra de
hori zonta l do E3Cha rt.
Apl i ca uma l i nha tra o ponto ponto na
gra de hori zonta l do E3Cha rt.
Apl i ca uma l i nha i nvi s vel na gra de
hori zonta l do E3Cha rt.

Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.HorGrid
For i = 0 To 5
E3Chart1.HorGrid = i
MsgBox "E3Chart1.HorGrid =" & CStr(i)
Next
MsgBox "Voltar"
E3Chart1.HorGrid = Old
End Sub

4.6.3.13 HorGridColor
Determina a cor da grade horizontal do objeto E3Chart. O valor padro desta
propriedade cinza (RGB(192, 192, 192)). Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.HorGridColor = RGB(255, 0, 0)
MsgBox "Prxima"
E3Chart1.HorGridColor = RGB(255, 0, 0)
MsgBox "Prxima"
E3Chart1.HorGridColor = RGB(0, 0, 255)
MsgBox "Voltar"
E3Chart1.HorGridColor = Old
End Sub

Visualizao

261

4.6.3.14 HorMinorTicks
Determina o nmero de subdivises das escalas horizontais da grade. O valor
padro desta propriedade 1. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.HorMinorTicks
For i = 0 To 5
E3Chart1.HorMinorTicks = i
MsgBox "Prximo valor"
Next
E3Chart1.HorMinorTicks = Old
End Sub

4.6.3.15 HorScaleBegin
Determina o valor inicial aplicado na escala horizontal principal da grade. Este
valor pode ser numrico para E3Charts XY, ou Data para E3Charts com escala de
tempo fixa. Para E3Charts de tempo real, esta propriedade no aplicada, sendo
ento utilizada a propriedade TimeSpan.

4.6.3.16 HorScaleEnd
Determina o valor final aplicado na escala horizontal principal da grade. Este
valor pode ser numrico para E3Charts XY, ou Data para E3Charts com escala de
tempo fixa. Para E3Charts de tempo real, esta propriedade no aplicada, sendo
ento utilizada a propriedade TimeSpan. Exemplo:
Sub ComboBox1_Change()
' Define qual consulta deseja mostrar
current_query_index = ListIndex
Set E3Chart1 = Screen.Item("E3Chart1")
i = 0
For Each query In E3Chart1.Queries
If i = current_query_index Then
query.FieldFilter(0) = "" ' Traz tudo
Set current_query = query
Else
query.FieldFilter(0) = "<0" ' No traz nada para
' no ficar lento
End If
i = i + 1
Next
' S mostra as penas que usam a consulta atual
For Each pen In E3Chart1.Pens
pen.Visible = (pen.QueryName = current_query.Name)
Next
' Atualiza as consultas
E3Chart1.Queries.UpdateData()

262

Visualizao

Screen.Item("E3Chart1").HorScaleBegin = Now - 0.001


Screen.Item("E3Chart1").HorScaleEnd = Now
End Sub

4.6.3.17 HorScaleFormat
Contm um texto que representa uma mscara, dentro da qual os valores da
escala horizontal sero mostrados. Esta mscara pode representar vrios tipos de
valores:
Geral: No possui formatao especfica, adaptando-se automaticamente ao
valor especificado
Nmero: Apresenta nmeros com parte inteira e fracionria. O usurio pode
optar por at 15 casas decimais, por usar ou no um separador de milhares, e
por apresentar nmeros negativos com sinal ou entre parnteses. Para nmeros
muito grandes ou muito pequenos, recomenda-se utilizar o formato Cientfico
Data: Apresenta valores numricos de data e hora (quando vlidos). Para
representar apenas a hora, use o formato equivalente
Hora: Apresenta valores numricos de hora e data (quando vlidos). Para
representar apenas a data, use o formato equivalente
Porcentagem: Multiplica o nmero por 100 e adiciona o smbolo de
porcentagem. Admite at 15 casas decimais
Cientfico: Apresenta o nmero em notao de mantissa e expoente. Ideal para
nmeros de magnitude variada. Admite at 15 casas decimais
Especial: Permite formatar nmeros inteiros em bases no decimais
(hexadecimal, octal ou binria, por exemplo)
Outro: Permite editar diretamente o cdigo de formatao desejado, ou
selecionar um formato criado anteriormente
A mscara destes formatos, como exemplificadas no campo Tipo, ser exibida na
Janela de Propriedades (por exemplo, d/M/yy H:mm, 0E-00, etc.).

4.6.3.18 HorTickUnit
Determina o nmero de subdivises entre as marcas da grade. Quando esta
propriedade estiver com valor 0, o espaamento ser automtico. Exemplo:
Sub SubCommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.HorTickUnit
For i = 0 To 30 Step 10
E3Chart1.HorTickUnit = i
MsgBox "E3Chart1.HorTickUnit = " & CStr(i)
Next
MsgBox "Voltar"

Visualizao

263

E3Chart1.HorTickUnit = Old
End Sub

4.6.3.19 Legend
Retorna o objeto Legenda do E3Chart. A partir da, as propriedades da Legenda
podem ser modificadas.

4.6.3.20 MouseMode
Seleciona uma das opes de tempo de execuo do menu do E3Chart. Os
valores possveis para essa propriedade so:
0 - MouseModeZoom: Coloca o mouse em modo Zoom por rea selecionada. Esta
opo est disponvel nos grficos de escala numrica em XY e escala fixa.
Equivale a selecionar a opo Caixa de Zoom do menu em tempo de execuo do
E3Chart
1 - MouseModePan: Coloca o mouse em modo de movimentao das escalas.
Equivale a selecionar a opo Mover do menu em tempo de execuo do E3Chart
2 - MouseModePanH: Coloca o mouse em modo de movimentao das escalas
somente na direo horizontal. Equivale a selecionar a opo Mover
horizontalmente do menu em tempo de execuo do E3Chart
3 - MouseModeSearch: Coloca o mouse em modo de pesquisa de valores nos
dados das Penas. Equivale a selecionar a opo Pesquisar do menu em tempo de
execuo do E3Chart
4 - MouseModeCursors: Habilita a opo de pesquisa de intervalos de tempo.
Equivale a selecionar a opo Pesquisar Intervalos do menu em tempo de
execuo do E3Chart

4.6.3.21 Padding
Esta propriedade determina a distncia, em pixels, entre o grfico e a borda do
objeto E3Chart, conforme pode ser observado nas figuras seguintes atravs das
setas vermelhas. O valor padro desta propriedade 10. Exemplo:

264

Visualizao

Propriedade Padding igual a 10

Visualizao

265

Propriedade Padding igual a 30

4.6.3.22 Pens
Retorna o objeto Coleo de Penas do E3Chart. O objeto Coleo de Penas
utilizado para inserir, remover ou acessar as Penas disponveis no E3Chart. Esta
propriedade somente de leitura. Exemplo:
Sub CommandButton1_Click()
For Each pen In Screen.Item("E3Chart1").Pens
pen.Visible = True
Next
End Sub

4.6.3.23 Queries
Retorna o objeto Coleo de Consultas dentro do E3Chart. O objeto Coleo de
Consultas utilizado para inserir, remover ou acessar as Consultas disponveis no
E3Chart. Esta propriedade somente de leitura.

4.6.3.24 RefreshTime
Esta propriedade determina o tempo de atualizao do E3Chart.

266

Visualizao

4.6.3.25 ScaleFont
Determina a fonte do texto utilizada na grade. Exemplo:
Sub CommandButton1_Click()
Screen.Item("E3Chart1").ScaleFont = "Times New Roman"
Screen.Item("E3Chart1").ScaleFont.Size = 12
Screen.Item("E3Chart1").ScaleFont.Italic = true
End Sub

4.6.3.26 ShowBackground
Habilita ou desabilita a visualizao do fundo do grfico. Se a propriedade for
igual a True, o fundo do grfico mostrado. Caso contrrio, o grfico fica com o
fundo transparente. A cor escolhida na propriedade BackColor no aparece se esta
propriedade estiver em False (opo padro). Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
E3Chart1.ShowBackground = Not E3Chart1.ShowBackground
End Sub

4.6.3.27 ShowBottomScale
Se a propriedade estiver configurada para True, o Eixo Horizontal principal
mostrado na base da grade. Caso contrrio, no mostrado. O valor padro True.
Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
oldBottomScale = E3Chart1.ShowBottomScale
MsgBox "Mostrar eixo"
E3Chart1.ShowBottomScale = True
MsgBox "Esconder eixo"
E3Chart1.ShowBottomScale = False
MsgBox "Voltar..."
E3Chart1.ShowBottomScale = oldBottomScale
End Sub

4.6.3.28 ShowGridBackground
Habilita ou desabilita a visualizao do fundo da grade. Se a propriedade for
igual a True (padro), o fundo da grade mostrado. Caso contrrio, a grade fica
com o fundo transparente. A cor escolhida na propriedade GridBkColor no aparece
se esta propriedade estiver em False. Exemplo:
Sub CommandButton1_Click()
Set Chart1 = Screen.Item("E3Chart1")
Chart1.ShowGridBackground = Not Chart1.ShowGridBackground
End Sub

Visualizao

267

4.6.3.29 ShowLeftScale
Se a propriedade estiver configurada para True, o Eixo Vertical principal ser
mostrado esquerda da grade. Caso contrrio, fica invisvel. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.ShowLeftScale = Not Chart.ShowLeftScale
End Sub

4.6.3.30 ShowPopupMenu
Habilita ou desabilita a opo de mostrar o menu em tempo de execuo do
E3Chart. Se o valor for igual a True, o menu ser mostrado quando o usurio clicar
com o boto direito do mouse sobre o grfico do E3Chart. Se o valor for igual a
False, o menu no mostrado. O valor padro dessa propriedade True.

4.6.3.31 ShowRightScale
Se a propriedade estiver configurada para True, o Eixo Vertical principal da
escala ser mostrado direita da grade. Caso contrrio, fica invisvel. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.ShowRightScale = Not Chart.ShowRightScale
End Sub

4.6.3.32 ShowTitle
Se a propriedade estiver configurada para True, o ttulo principal do E3Chart
visvel. Caso contrrio, fica invisvel. A propriedade Title contm o ttulo que ser
mostrado no E3Chart. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
oldTitle = E3Chart1.Title
oldShowTitle = E3Chart1.ShowTitle
E3Chart1.Title = "Teste!"
MsgBox "Mostrar"
E3Chart1.ShowTitle = True
MsgBox "Esconder"
E3Chart1.ShowTitle = False
MsgBox "Voltar"
E3Chart1.Title = oldTitle
E3Chart1.ShowTitle = oldShowTitle
End Sub

268

Visualizao

4.6.3.33 ShowTopScale
Se a propriedade estiver configurada para True, o Eixo Horizontal principal
mostrado no topo da grade. Caso contrrio, no mostrado. O valor padro
False. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.ShowTopScale = Not Chart.ShowTopScale
End Sub

4.6.3.34 TimeSpan
Indica a escala de tempo que aparece no Eixo Horizontal principal do E3Chart,
quando este for configurado para mostrar a escala de tempo real. O valor desta
propriedade sempre em segundos. O valor padro desta propriedade 60.

4.6.3.35 Title
Determina o ttulo principal do E3Chart. Para que o ttulo aparea no E3Chart, a
propriedade ShowTitle deve ser configurada para True.

4.6.3.36 TitleFont
Determina a fonte do ttulo principal do E3Chart. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
E3Chart1.Title = "Teste"
E3Chart1.ShowTitle = True
MsgBox "Troca fonte"
E3Chart1.TitleFont = "Times New Roman"
MsgBox "Troca tamanho"
E3Chart1.TitleFont.Size = 20
End Sub

4.6.3.37 VerAxisTitle
Determina o ttulo do Eixo Vertical principal.

4.6.3.38 VerGrid
Determina o tipo de linha que ser aplicada na grade vertical do E3Chart.
Opes disponveis para VerGrid
OPO
0 - Solid

Visualizao

DESCRIO
Apl i ca uma l i nha s l i da na gra de verti ca l
do E3Cha rt.

269

OPO
1 - Dash
2 - Dot
3 - Dashdot
4 - Dashdotdot
5 - Invisible

DESCRIO
Apl i ca uma l i nha tra ceja da na gra de
verti ca l do E3Cha rt.
Apl i ca uma l i nha ponti l ha da na gra de
verti ca l do E3Cha rt (pa dr o).
Apl i ca uma l i nha tra o e ponto na gra de
verti ca l do E3Cha rt.
Apl i ca uma l i nha tra o ponto ponto na
gra de verti ca l do E3Cha rt.
Apl i ca uma l i nha i nvi s vel na gra de
verti ca l do E3Cha rt.

4.6.3.39 VerGridColor
Determina a cor da linha do Eixo Vertical principal da grade. O valor padro
desta propriedade cinza (RGB(192, 192, 192)).

4.6.3.40 VerMinorTicks
Determina o nmero de subdivises entre as marcas do Eixo Vertical principal da
grade. O valor padro desta propriedade 1.

4.6.3.41 VerScaleBegin
Determina o valor no topo no Eixo Vertical principal da grade do E3Chart. O valor
padro desta propriedade 100.

4.6.3.42 VerScaleEnd
Determina o valor na base do Eixo Vertical principal da grade. O valor padro
desta propriedade -100.

4.6.3.43 VerScaleFormat
Contm um texto que representa uma mscara, dentro da qual os valores da
escala vertical sero mostrados. Esta mscara pode representar vrios tipos de
valores:
Geral: No possui formatao especifica, adaptando-se automaticamente ao
valor especificado
Nmero: Apresenta nmeros com parte inteira e fracionria. O usurio pode
optar por at 15 casas decimais, por usar ou no um separador de milhares, e
por apresentar nmeros negativos com sinal ou entre parnteses. Para nmeros
muito grandes ou muito pequenos, recomenda-se utilizar o formato Cientfico
Data: Apresenta valores numricos de data e hora (quando vlidos). Para
representar apenas a hora, use o formato equivalente
270

Visualizao

Hora: Apresenta valores numricos de hora e data (quando vlidos). Para


representar apenas a data, use o formato equivalente
Porcentagem: Multiplica o nmero por 100 e adiciona o smbolo de
porcentagem. Admite at 15 casas decimais
Cientfico: Apresenta o nmero em notao de mantissa e expoente. Ideal para
nmeros de magnitude variada. Admite at 15 casas decimais
Especial: Permite formatar nmeros inteiros em bases no decimais
(hexadecimal, octal e binria, por exemplo)
Outro: Permite editar diretamente o cdigo de formatao desejado, ou
selecionar um formato criado anteriormente
A mscara destes formatos, como exemplificado no campo Tipo, ser exibida na
Janela de Propriedades (por exemplo, d/M/yy H:mm, 0E-00, etc.).

4.6.3.44 VerTickUnit
Determina o nmero de subdivises entre as marcas da grade. Quando esta
propriedade estiver com valor 0, o espaamento ser automtico. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.VerTickUnit
For i = 0 To 30 Step 10
E3Chart1.VerTickUnit = i
MsgBox "E3Chart1.VerTickUnit = " & CStr(i)
Next
MsgBox "Voltar"
E3Chart1.VerTickUnit = Old
End Sub

4.6.4 Coleo de Penas


Esta seo contm informaes sobre mtodos e propriedades do objeto Coleo
de Penas. Este objeto no possui eventos associados.

4.6.4.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Coleo de Penas.
NOTA: A Col e o de Pena s do E3Cha rt deve s er a ces s a da a tra vs da propri eda de
Pens.

Visualizao

271

4.6.4.1.1 AddPen
AddPen(Pen)
O mtodo AddPen adiciona uma nova Pena ao E3Chart, retornando a Pena criada.
Exemplo:
Sub CommandButton1_Click()
' Cria uma pena sem nome.
Set Pen = Screen.Item("E3Chart1").Pens.AddPen("")
MsgBox Pen.Name
End Sub
SubCommandButton1_DbClick()
' Cria uma pena com o nome "Pen1".
' Se o nome existir, a pena incrementada.
Set Pen = Screen.Item("E3Chart1").Pens.AddPen("Pen1")
MsgBox Pen.Name
End Sub
Sub CommandButton2_Click()
' Cria uma pena e associa a TagDemo1.
Set Chart = Screen.Item("E3Chart1")
Set Pen = Chart.Pens.AddPen("")
MsgBox Pen.Name
Pen.UsetimeStamp = True
Pen.YLink = "Dados.TagDemo1"
Pen.Connect()
End Sub

4.6.4.1.2 ChangePenPos
ChangePenPos(Source, Dest)
Modifica a ordem de desenho das Penas no E3Chart. Este mtodo possui os
seguintes parmetros:
Source: Determina o ndice da Pena a ser movida (comeando em um)
Dest: Determina o destino da Pena (comeando em um)
Uma situao em que este mtodo especialmente til quando tem-se uma Pena
com o desenho de linha e outra com o desenho de rea. Se a Pena de rea for
desenhada depois da Pena de linha, ela poder esconder a ltima. A soluo ento
seria inverter a ordem de desenho destas Penas. Exemplo:
Sub CommandButton1_Click()
' Move a pena 1 para a posio 2.
Screen.Item("E3Chart1").Pens.ChangePenPos(1, 2)
End Sub

272

Visualizao

4.6.4.1.3 Item
Item(Index)
O mtodo Item retorna um objeto Pena da Coleo de Penas, especificado pelo
ndice. Este mtodo possui o parmetro Index, que pode ser do tipo numrico (se
corresponder ao ndice da Pena) ou texto (se corresponder ao nome da Pena).
Exemplo:
Sub CommandButton1_Click()
' Obtm a primeira pena.
Set Pen1 = Screen.Item("E3Chart1").Pens.Item(0)
End Sub

4.6.4.1.4 Remove
Remove(Name)
O mtodo Remove apaga uma Pena atravs do nome especificado. Este mtodo
possui o parmetro Name, que determina o nome da Pena a ser removida. Exemplo:
Sub CommandButton1_Click()
Screen.Item("E3Chart1").Pens.Remove(1)
End Sub

4.6.4.1.5 SetCursorPos
SetCursorPos(X, Range)
Posiciona o cursor de cada Pena do E3Chart. Equivale ao comportamento de
chamar o mtodo SetCursorPos de cada Pena.

4.6.4.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Coleo de Penas.

4.6.4.2.1 Count
Contm o nmero total de Penas inseridas no E3Chart. Esta propriedade
somente de leitura.

4.6.4.3 Penas
Esta seo contm informaes sobre mtodos e propriedades do objeto Pena. Este
objeto no possui eventos associados.

4.6.4.3.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Pena.
Visualizao

273

4.6.4.3.1.1 AddPoint
AddPoint(ValueX, ValueY[, Quality])
Adiciona um ponto ao final do buffer de tempo real. O tamanho do buffer s
vlido aps a conexo da Pena. Se a Pena for criada no Studio, a conexo
automtica, mas se for criada via script necessrio chamar o mtodo Connect
aps sua criao. Este mtodo deve ser usado com Penas de tempo real, e com a
propriedade UseTimeStamp em False. O parmetro opcional Quality indica a
qualidade do ponto a ser inserido. Se este parmetro no for informado, a
qualidade do ponto ser considerada boa (192). O nmero de pontos que podem
ser adicionados a uma Pena est relacionado ao tamanho do buffer (propriedade
BufferSize da Pena).
4.6.4.3.1.2 Clear
Clear()
Apaga os dados do buffer de tempo real, sem diminuir seu tamanho. Este mtodo
no desconecta Associaes, nem tampouco remove dados histricos.
4.6.4.3.1.3 Connect
Connect()
O mtodo Connect faz a Pena conectar-se ao servidor para receber os dados de
tempo real, associando as propriedades XLink e YLink. Se a Pena j estiver
conectada, o mtodo fica inativo. Exemplo:
Sub CommandButton1_Click()
Set Pen1 = Screen.Item("E3Chart1").Pens.Item("Pen1")
Pen1.Disconnect()
Pen1.Connect()
End Sub

4.6.4.3.1.4 Disconnect
Disconnect()
O mtodo Disconnect limpa os dados atuais e faz com que a Pena no receba mais
os dados de tempo real do seu Tag associado. Se a Pena j estiver desconectada o
mtodo fica inativo. Quando o mtodo Disconnect usado em uma Pena Mista
(DataSourceType igual a 2), ele remove a parte de tempo real, permanecendo a parte
histrica. Em tempo de execuo, para que os dados de tempo real sejam
mostrados novamente preciso chamar o mtodo Connect. Exemplo:
Sub CommandButton1_Click()
Set Pen1 = Screen.Item("E3Chart1").Pens.Item("Pen1")
Pen1.Disconnect()
Pen1.Connect()
End Sub

274

Visualizao

4.6.4.3.1.5 GetCursorPos
GetCursorPos(X, Y)
Retorna a posio em que o cursor interceptou a Pena no E3Chart. Este mtodo
possui os parmetros X e Y, que correspondem s coordenadas x e y do cursor. Se o
mtodo for bem sucedido retorna True, caso contrrio, retorna False. Exemplo:
Sub CommandButton1_Click()
For Each pen In Chart.Pens
If pen.GetCursorPos(aa, bb) Then
strResult = strResult & pen.name_
& " := " & CSTr(CDate(aa)) + _
"y " + CStr(bb) + vbNewLine
End If
Next
MsgBox strResult
End Sub

4.6.4.3.1.6 GetPoint
GetPoint(ValueX, ValueY)
Retorna as coordenadas X e Y do ponto mais prximo ao valor de entrada em
ValueX. O parmetro ValueX informa o valor de referncia para a busca do ponto, e
depois recebe o valor efetivo da coordenada X do ponto mais prximo encontrado.
O parmetro ValueY retorna o valor efetivo da coordenada Y do ponto mais prximo
encontrado. O mtodo retorna True se encontrou um ponto, e False caso contrrio.
4.6.4.3.1.7 SetCursorPos
SetCursorPos(X, Range)
Posiciona o cursor da Pena do E3Chart. O parmetro X indica em qual posio o
cursor deve ser posicionado, similar ao comportamento de mover o cursor na
pesquisa com o mouse. O cursor movido para a posio mais prxima indicada
por X. O parmetro Range opcional e usado como validao. O cursor s ser
movido se o ponto vlido estiver dentro do intervalo. Qualquer valor negativo
indica que o intervalo passado no deve ser usado. Exemplo:
' Existindo um ponto vlido em (x = 1, y = 10)
' e outro em (x = 4, y = 20).
SetCursorPos(2) ' move o cursor para o ponto (1, 10)
SetCursorPos(4) ' move o cursor para o ponto (4, 20)
' Quando range usado, o cursor s movido
' se ponto estiver dentro do range.
' No vai mover o cursor, porque 2 est mais de 0.5 unidade
' distante do ponto mais prximo, que 1.
SetCursorPos (2, 0.5)
' Envia o cursor para o ponto (1, 10).

Visualizao

275

SetCursorPos (2, 4)

Este mtodo retorna True se o cursor foi movido, caso contrrio retorna False.

4.6.4.3.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Pena.
4.6.4.3.2.1 AutoQuery
Quando a propriedade AutoQuery est configurada para True, diz-se que a Pena
do tipo Consulta Automtica, ou simplesmente Pena Automtica. O objetivo da
Pena Automtica diminuir o consumo de memria e o tempo de consulta. Para
isso, ela aplica filtros no campo E3Timestamp para trazer somente os dados
necessrios para dentro da rea do E3Chart. Toda vez que o perodo visvel do
E3Chart for alterado, a Pena Automtica trar os dados que esto faltando para
completar o desenho daquele perodo. Alm disso, a Consulta Automtica tambm
completa os dados histricos que esto faltando para conectar as partes histrica
e de tempo real da Pena. Se, por acaso, os dados histricos no chegarem aps
trinta segundos, a Consulta Automtica cancelada naquele trecho. Veja tambm a
propriedade MaxGapTime para maiores detalhes.
Devido ao modo como a Consulta Automtica aplica filtros para o campo
E3Timestamp, ela no est disponvel para consultas de Storage e cdigo SQL
customizados pelo usurio. Ou seja, mesmo que a propriedade AutoQuery esteja
configurada para True, ela no tem efeito se a Consulta for do tipo Storage. Uma
das formas de reconhecer a Consulta Automtica o desenho hachurado na tela do
E3Chart. Toda vez que aparecem hachuras no desenho, significa que naquele
perodo est ocorrendo uma Consulta Automtica. Quando o contorno da parte
hachurada estiver na cor vermelha, significa que a Consulta Automtica daquele
trecho est falhando. Nesse caso, o E3Chart refaz a Consulta do trecho com
problemas.
NOTA: Di ferentemente da pa rte de tempo rea l , onde ca da Pena pos s ui s eu prpri o
buffer de da dos , a pa rte hi s tri ca da Pena a rma zena da na Cons ul ta e
compa rti l ha da entre a s Pena s . Por exempl o, qua ndo uma Cons ul ta tem trs
ca mpos , E3Timestamp, Campo1 e Campo2, es tes da dos fi ca m a rma zena dos dentro da
Cons ul ta e es t o di s pos i o pa ra a s Pena s que compa rti l ha m a quel a Cons ul ta .
Com i s s o, a pa rte comum, gera l mente o ca mpo E3Timestamp, pode s er us a da por
dua s Pena s di ferentes , s em que os da dos s eja m dupl i ca dos . No ca s o da s Pena s
Autom ti ca s , dua s Pena s di ferentes podem us a r a mes ma ta bel a e, devi do a
es ca l a s di ferentes , el a s podem ca rrega r perodos di ferentes da Cons ul ta . Nes s a
s i tua o, ca da Pena herda a utoma ti ca mente a pa rte ca rrega da pel a outra Pena .
O objeto Cons ul ta n o pode funci ona r s i mul ta nea mente em modo Automtico e No
Automtico. Is s o s i gni fi ca ta mbm que s e Pena s di ferentes , uma Autom ti ca e outra
N o Autom ti ca , qui s erem compa rti l ha r a mes ma Cons ul ta , es ta Cons ul ta va i s e
a da pta r pri mei ra Pena que uti l i z -l a . Ou s eja , a propri eda de AutoQuery n o
ga ra nte que a Cons ul ta do ti po Automtico, dependendo de outros fa tores .

276

Visualizao

4.6.4.3.2.2 AverageY
Informa a mdia da Pena no intervalo, caso a propriedade EnableCalc esteja
habilitada. Caso o E3Chart esteja no modo de Pesquisa de Intervalos, mostra a
mdia neste intervalo; do contrrio, mostra a mdia no intervalo entre o incio e o
fim no Eixo Horizontal. Valores com qualidade ruim no so considerados caso a
propriedade ShowBadPoints esteja desabilitada. Esta propriedade somente de
leitura.
4.6.4.3.2.3 BkColor
Determina a cor de fundo usada em uma Pena do tipo rea. O valor padro desta
propriedade vazio.
4.6.4.3.2.4 BufferSize
Determina o nmero de pontos mantidos na Pena de tempo real. Aps este valor,
os dados mais antigos so descartados. Nas Penas histricas, esta propriedade
no tem efeito. Esta propriedade ser considerada somente aps a conexo da
Pena. Para maiores informaes, veja o mtodo Connect. O valor padro desta
propriedade 1000, e deve ser sempre maior que 0. Exemplo:
Sub CommandButton1_Click()
Set Pen1 = Screen.Item("E3Chart1").Pens.Item("Pen1")
Pen1.Disconnect()
Pen1.BufferSize = 5000
Pen1.Connect()
End Sub

4.6.4.3.2.5 Color
Determina a cor da linha da Pena no E3Chart. O valor padro desta propriedade
vazio.
4.6.4.3.2.6 DataSourceType
Determina a origem dos dados da Pena. As opes disponveis para esta
propriedade so as seguintes:
Opes disponveis para DataSourceType
OPO
0 - Tempo Real
1 - Histrico
2 - Pena Mista

Visualizao

DESCRIO
Indi ca conex o da Pena a um Ta g
a tua l i za do em tempo rea l .
Indi ca conex o da Pena a os da dos
vi ndos de uma cons ul ta .
Indi ca conex o da Pena a Ta gs de tempo
rea l e da dos hi s tri cos
s i mul ta nea mente.

277

Quando a propriedade DataSourceType for igual a 0 (Tempo Real), as propriedades


XLink e YLink informam os links utilizados; ou ento a propriedade UseTimeStamp
informa que a propriedade XLink no ser usada, estando em seu lugar o timestamp
da propriedade YLink. Quando a propriedade DataSourceType for igual a 1
(Histrico), as propriedades XField e YField informam os campos da tabela a serem
usados. A propriedade QueryName indica o nome da tabela usada. Quando
DataSourceType for igual a 2 (Pena Mista), as opes 0 e 1 funcionaro
simultaneamente para a Pena.
NOTA: Em tempo de execu o, qua ndo a propri eda de for a l tera da e a Pena dei xa r
de mos tra r os da dos de tempo rea l , s er preci s o cha ma r o mtodo Connect pa ra que
es tes da dos s eja m mos tra dos nova mente.

Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
MsgBox "Clique OK para criar a pena."
Set Pen = E3Chart1.Pens.AddPen("Pen1")
Pen.DataSourceType = 0 ' Tempo real
Pen.YLink = "Dados.TagDemo1"
Pen.UseTimeStamp = True ' Em X usa o timestamp
Pen.Color = RGB(255, 0, 0)
Pen.Docstring = "Teste"
MsgBox "Clique OK para conectar."
Pen.Connect() ' Comea a receber os dados
MsgBox "Clique OK para enquadrar."
E3Chart1.FitPen(0)
MsgBox "Clique OK para remover a pena."
E3Chart1.Pens.Remove(Pen.Name)
End Sub

4.6.4.3.2.7 DigitalData
Determina o estilo de plotagem digital. Se a propriedade estiver configurada para
True, o estilo de plotagem digital assume que a variao do dado seja de forma
digital, ou seja, que seu valor em relao ao ltimo variou instantaneamente. Caso
contrrio, a variao considerada linear e os pontos so unidos por um segmento
de reta. O valor padro desta propriedade True.
4.6.4.3.2.8 EnableCalc
Habilita ou desabilita o clculo da mdia, mnimos e mximos dentro do
intervalo.

278

Visualizao

4.6.4.3.2.9 EnableHighLimit
Habilita ou desabilita a verificao do limite alto.
4.6.4.3.2.10 EnableLowLimit
Habilita ou desabilita a verificao do limite baixo.
4.6.4.3.2.11 EU
Esta propriedade utilizada para identificar a unidade de engenharia que o valor
representa, como por exemplo graus, metros, KW/h, etc.
4.6.4.3.2.12 HighlightMaxGapTime
Especifica se a linha que conecta visualmente a parte histrica e a parte de
tempo real de uma Pena Mista (definida em MaxGapTime) deve ter uma cor
(definida em MaxGapTimeColor) e um estilo (definido em MaxGapTimeStyle)
diferenciados. O valor padro desta propriedade Falso.
4.6.4.3.2.13 HighLimit
Determina o limite de alarme alto.
4.6.4.3.2.14 InterpolatedBeginY
Informa o valor do ponto interpolado onde o cursor inicial cruza com a Pena. Esta
propriedade somente de leitura.
4.6.4.3.2.15 InterpolatedEndY
Informa o valor do ponto interpolado onde o cursor final cruza com a Pena. Esta
propriedade somente de leitura.
4.6.4.3.2.16 LimitPenBkColor
Determina a cor de fundo da Pena quando em alarme.
4.6.4.3.2.17 LimitPenColor
Determina a cor da Pena quando em alarme.
4.6.4.3.2.18 LowLimit
Determina o limite de alarme baixo.
Visualizao

279

4.6.4.3.2.19 MaxGapTime
Permite especificar um tempo limite a ser considerado para a conexo visual
entre a parte histrica e a parte de tempo real de uma Pena Mista. O valor padro
desta propriedade 0. O valor desta propriedade pode ser modificado em tempo de
execuo.
NOTA: Es ta propri eda de es t di s ponvel a pa rti r da vers o 3.5. Pa ra a pl i ca es
cri a da s em vers es a nteri ores e a berta s na vers o 3.5, o va l or da propri eda de
s empre 0.

4.6.4.3.2.20 MaxGapTimeColor
Permite configurar a cor da conexo visual entre a parte histrica e a parte de
tempo real de uma Pena Mista, definida na propriedade MaxGapTime. O valor
padro desta propriedade vermelho (RGB(255, 0, 0)).
4.6.4.3.2.21 MaxGapTimeStyle
Especifica o estilo da linha que estabelece uma conexo visual entre a parte
histrica e a parte de tempo real de uma Pena Mista, configurada na propriedade
MaxGapTime. Os valores possveis para esta propriedade so os seguintes:
0: Slida
1: Tracejada
2: Pontilhada
3: Trao - Ponto
4: Trao - Ponto - Ponto
5: Invisvel
NOTA: A op o 5 (Invi s vel ) des ta propri eda de s pode s er s el eci ona da vi a s cri pt.

4.6.4.3.2.22 MaxY
Informa o valor mximo da Pena no intervalo, caso a propriedade EnableCalc
esteja habilitada. Caso o E3Chart esteja no modo de Pesquisa de Intervalos, mostra
a mdia nesse intervalo; do contrrio, mostra a mdia no intervalo entre o incio e
o fim no Eixo Horizontal. Valores com qualidade ruim no so considerados caso a
propriedade ShowBadPoints esteja desabilitada. Esta propriedade somente de
leitura.

280

Visualizao

4.6.4.3.2.23 MinY
Informa o valor mnimo da Pena no intervalo, caso a propriedade EnableCalc
esteja habilitada. Caso o E3Chart esteja no modo de Pesquisa de Intervalos, mostra
a mdia nesse intervalo; do contrrio, mostra a mdia no intervalo entre o incio e
o fim no Eixo Horizontal. Valores com qualidade ruim no so considerados caso a
propriedade ShowBadPoints esteja desabilitada. Esta propriedade somente de
leitura.
4.6.4.3.2.24 Name
Determina o nome da Pena.
4.6.4.3.2.25 PenStyle
Determina o estilo de linha da Pena. O valor padro desta propriedade 0
(zero). As opes disponveis so as seguintes:
Opes disponveis para PenLineStyle
OPO
0 - LsSolid
1 - LsDash
2 - LsDot
3 - LsDashDot
4 - LsDashDotDot
5 - LsNull

DESCRIO
Li nha s l i da .
Li nha tra ceja da .
Li nha ponti l ha da .
Li nha tra o-ponto.
Li nha tra o-ponto-ponto.
Sem l i nha .

NOTA: A uti l i za o de um va l or di ferente de 0 (LsSolid) nes ta propri eda de,


combi na da com a uti l i za o da propri eda de Width com va l ores ma i ores do que 1
(um), pode degra da r a performa nce de des enho da Pena .

4.6.4.3.2.26 PenType
Determina o tipo de desenho da Pena no E3Chart:
0: Linha
1: Ponto
2: Ponto e Linha
3: rea

Visualizao

281

4.6.4.3.2.27 QueryName
Determina o nome da Consulta que a Pena est utilizando. Esta propriedade
utilizada se a propriedade DataSourceType estiver configurada para 1 (Histrico).
4.6.4.3.2.28 ScaleX
A propriedade ScaleX indica a escala X do E3Chart a qual a Pena est associada. A
escala configurada para ScaleX tem orientao horizontal, ou seja, pode estar
posicionada no topo ou na base do E3Chart. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Set Pen = Chart.Pens.AddPen("PenaDoTagDemo2")
Pen.XLink = "Dados.TagDemo2"
Pen.UseTimeStamp = True
' A escala deve existir previamente.
Pen.ScaleX = "EscalaParaTagDemo2"
Pen.Connect
End Sub

4.6.4.3.2.29 ScaleY
A propriedade ScaleY indica a escala Y do E3Chart a qual a Pena est associada. A
escala configurada para ScaleY tem orientao vertical, estando posicionada
esquerda ou direita do objeto. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Set Pen = Chart.Pens.AddPen("PenaDoTagDemo2")
Pen.YLink = "Dados.TagDemo2"
Pen.UseTimeStamp = True
' A escala deve existir previamente.
Pen.ScaleY = "EscalaParaTagDemo2"
Pen.Connect
End Sub

4.6.4.3.2.30 ScanValue
Define o tempo de leitura esperado do Tag da Pena de tempo real. Este valor
levado em conta no modo de desenho analgico. Quando o valor ultrapassa o valor
determinado por ScanValue, considera-se que o valor do Tag no foi alterado no
intervalo. De outra forma, quando o ScanValue igual a zero, os dados da Pena so
sempre conectados com uma reta ligando os dois pontos, como se o valor estivesse
variando de forma linear. A unidade desta propriedade em milissegundos.

282

Visualizao

4.6.4.3.2.31 ShowAverage
Habilita a exibio da mdia da Pena no E3Chart. Esta propriedade s tem efeito
caso a propriedade EnableCalc esteja habilitada.
4.6.4.3.2.32 ShowBadPoints
Quando desabilitada, os pontos com qualidade ruim no sero plotados. Se a
Pena estiver traando linhas, as linhas que passam pelos pontos de qualidade
ruim no sero conectadas. Para que a qualidade dos pontos seja levada em
considerao na parte histrica da Pena, o campo nomecampo_quality deve estar
selecionado na Consulta do E3Chart. Quando habilitada, todos os pontos so
plotados normalmente.
4.6.4.3.2.33 ShowMinMax
Habilita a exibio dos pontos mnimo e mximo da Pena no E3Chart. Esta
propriedade s tem efeito caso a propriedade EnableCalc esteja habilitada.
4.6.4.3.2.34 UseTimeStamp
Determina que ser utilizado, para o Eixo Horizontal, o valor do timestamp
associado ao Eixo Vertical. Veja exemplo na descrio da propriedade
DataSourceType.
4.6.4.3.2.35 Visible
Determina se a Pena est visvel no E3Chart. Se a opo estiver configurada para
True, a Pena visvel em tempo de execuo. Caso contrrio, a Pena fica invisvel.
Exemplo:
Sub CommandButton1_Click()
Set Pen1 = Screen.Item("E3Chart1").Pens.Item("Pen1")
Pen1.Visible = Not Pen1.Visible
End Sub

4.6.4.3.2.36 Width
Determina a largura da linha da Pena no E3Chart. O valor padro desta
propriedade 0 (zero).
NOTA: A uti l i za o de va l ores ma i ores do que 1 (um) nes ta propri eda de, combi na da
com a uti l i za o da propri eda de PenStyle com um va l or di ferente de 0 (LsSolid), pode
degra da r a performa nce de des enho da Pena .

Visualizao

283

4.6.4.3.2.37 XField
Nome do campo da Consulta usado para plotar o dado em uma escala horizontal.
usada para Penas histricas.
4.6.4.3.2.38 XLink
Nome do link usado para plotar o dado em uma escala horizontal. Quando o
valor desta propriedade alterado, a Pena automaticamente desconectada. Aps
a configurao, preciso chamar o mtodo Connect para que a Pena comece a
receber os dados relativos a este link. usada para Penas de tempo real.
4.6.4.3.2.39 XMaxY
Informa o valor X relativo ao ponto MaxY. Esta propriedade somente de leitura.
4.6.4.3.2.40 XMinY
Informa o valor X relativo ao ponto MinY. Esta propriedade somente de leitura.
4.6.4.3.2.41 YField
Nome do campo da Consulta usado para plotar o dado em uma escala vertical.
usada para Penas histricas.
4.6.4.3.2.42 YLink
Nome do link usado para plotar o dado em uma escala vertical. Quando o valor
desta propriedade alterado, a Pena automaticamente desconectada. Aps a
configurao, preciso chamar o mtodo Connect para que a Pena comece a
receber os dados relativos a este link. usada para Penas de tempo real.

4.6.5 Coleo de Eixos


Esta seo contm informaes sobre mtodos e propriedades do objeto Coleo
de Eixos. Este objeto no possui eventos associados.

4.6.5.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Coleo de Eixos.

4.6.5.1.1 AddAxis
AddAxis(AxisName)
Adiciona um novo Eixo com o nome determinado no parmetro AxisName e retorna
284

Visualizao

o Eixo criado. Caso se tente criar um Eixo com um nome que j existe, ser
mostrada uma mensagem de erro. Querendo-se que o nome seja gerado
automaticamente, deve se passar o parmetro AxisName em branco. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Set newAxis = Chart.Axes.AddAxis("")
newAxis.Color = RGB(255, 0, 0)
End Sub

4.6.5.1.2 Remove
Remove(Index)
Remove o Eixo atravs de seu nome ou ndice, conforme especificado no parmetro
Index. Os Eixos principais 0 e 1 no podem ser removidos. Caso se tente remov-los,
aparecer uma mensagem de erro. Exemplos:
Sub CommandButton1_Click()
' Este exemplo remove todos os eixos adicionais
Set Chart = Screen.Item("E3Chart")
While (Chart.Axes.Count > 2)
Chart.Axes.Remove(2)
Wend
End Sub
Sub CommandButton1_Click()
' Remove um eixo adicional, se existir
Set Chart = Screen.Item("E3Chart1")
Chart.Axes.Remove(2)
End Sub

4.6.5.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Coleo de Eixos.

4.6.5.2.1 Count
Retorna o nmero total de Eixos do E3Chart, incluindo os dois Eixos principais
(Horizontal e Vertical).

4.6.5.2.2 HorAxis
Retorna o Eixo Horizontal principal. Este Eixo tambm participa da lista de Eixos.
Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
MsgBox Chart.axes.Item(0).Name & ", " & _
Chart.axes.Item(1).Name
MsgBox Chart.axes.HorAxis.Name & ", " & _
Chart.axes.Item("NomeDoEixo").Name

Visualizao

285

End Sub

4.6.5.2.3 Item
Retorna o Eixo atravs de seu nome ou ndice. O ndice 0 sempre o Eixo
Horizontal principal e o ndice 1 sempre o Eixo Vertical principal. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart")
MsgBox Chart.axes.Item(0).Name & ", " & _
Chart.axes.Item(1).Name
MsgBox Chart.axes.HorAxis.Name & ", " & _
Chart.axes.Item("NomeDoEixo").Name
End Sub

4.6.5.2.4 VerAxis
Retorna o Eixo Vertical principal. Este Eixo tambm participa da lista de Eixos.
Exemplos:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
MsgBox Chart.axes.Item(0).Name & ", " & _
Chart.axes.Item(1).Name
MsgBox Chart.axes.Item("NomeDoEixo").Name & ", " & _
Chart.axes.VerAxis.Name
End Sub

4.6.5.3 Eixos
Esta seo contm informaes sobre mtodos e propriedades do objeto Eixo. Este
objeto no possui eventos associados.

4.6.5.3.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Eixo.
NOTA: HorAxis e VerAxis s o propri eda des da Col e o de Ei xos que a ces s a m os Ei xos
pa dr o Hori zonta l e Verti ca l , res pecti va mente. Por exempl o, a o i nvs de uti l i za r
"Cha rt.Axes .Item('Ei xoHori zonta l ')", pode-s e uti l i za r "Cha rt.Axes .HorAxi s ". Dema i s
Ei xos cri a dos pel o us u ri o tm nomes prpri os , es col hi dos ca s o a ca s o.

4.6.5.3.1.1 GetHistoricPeriod
GetHistoricPeriod(Begin, End)
Retorna o intervalo de tempo mostrado na escala histrica. O parmetro Begin
indica a data inicial da escala histrica e End indica a data final. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart")

286

Visualizao

Chart.Axes.Item("NomeDoEixo").GetHistoricPeriod min, max


Value = CStr(dmin) & " " & CStr(dmax)
MsgBox "Data inicial = " & CStr(min) & _
vbNewLine & " Data final = " & CStr(max)
End Sub

4.6.5.3.1.2 GetMinMax
GetMinMax(Min, Max)
Retorna nos parmetros Min e Max os valores mnimo e mximo da escala
numrica, respectivamente. Exemplo:
Sub CommandButton1_DBClick()
Set Chart = Screen.Item("E3Chart")
Chart.Axes.Item("NomeDoEixo").GetMinMax dmin, dmax
MsgBox CStr(dmin) & " " & CStr(max)
End Sub

4.6.5.3.1.3 GetRealTimePeriod
GetRealTimePeriod(Period)
Retorna a unidade de tempo configurada na escala de tempo real. O parmetro
Period recebe o valor da escala de tempo. As unidades de tempo disponveis esto
descritas na tabela a seguir.
Unidades de tempo disponveis
VALOR
0 - tuSeconds
1 - tuMinutes
2 - tuHours
3 - tuDays
4 - tuWeeks
5 - tuMonths
6 - tuYears

Uni da de
Uni da de
Uni da de
Uni da de
Uni da de
Uni da de
Uni da de

de
de
de
de
de
de
de

DESCRIO
tempo em s egundos
tempo em mi nutos
tempo em hora s
tempo em di a s
tempo em s ema na s
tempo em mes es
tempo em a nos

Exemplo:
Dim Unidade, Valor
Unidade = Screen.Item("E3Chart1").Axes.Item_
("EixoHorizontal").GetRealTimePeriod(Valor)
MsgBox "Valor: " & CStr(Valor) & " Unidade: " & CStr(Unidade)

4.6.5.3.1.4 GetTickSpacing
GetTickSpacing(TickSpacing, TimeUnit)
Retorna o espaamento entre os ticks (subdivises da escala) e a unidade
configurada. O parmetro TickSpacing determina o espaamento entre os ticks e
Visualizao

287

TimeUnit determina a unidade. Quando este parmetro est em zero, significa que
automtico. A unidade no utilizada quando a escala numrica. Os valores
disponveis para o parmetro TimeUnit esto descritos no mtodo
GetRealTimePeriod. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Unitvalue_
= Chart.Axes.Item("NomeDoEixo").GetTickSpacing(TickSpacing)
MsgBox "valor" = " & CStr(TickSpacing) & _
" unidade " & CStr(unitvalue)
End Sub

4.6.5.3.1.5 SetHistoricPeriod
SetHistoricPeriod(Begin, End)
Configura o perodo de tempo para a escala histrica. O parmetro Begin determina
o perodo inicial da escala e End determina o perodo final da escala. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart2")
Chart.Axes.Item("NomeDoEixo").ScaleType = 2
' Mostra o ultimo perodo
Chart.Axes.Item("NomeDoEixo").SetHistoricPeriod now - 1, now
End Sub

4.6.5.3.1.6 SetMinMax
SetMinMax(Min, Max)
Configura os valores mnimo e mximo da escala numrica. O valor mnimo
determinado pelo parmetro Min e o mximo por Max. Exemplo:
Sub Circulo1_Click()
Set Chart = Screen.Item("E3Chart2")
Chart.Axes.Item("NomeDoEixo").SetMinMax -10, 500
End Sub

4.6.5.3.1.7 SetRealTimePeriod
SetRealTimePeriod(Times, TimeUnit)
Ajusta o intervalo de tempo na unidade definida pelo parmetro TimeUnit. As
opes disponveis neste parmetro esto descritas no mtodo GetRealTimePeriod.
O parmetro Times determina o intervalo de tempo e a unidade da escala
especificado por TimeUnit. O Eixo fica sempre sendo atualizado neste modo (tempo
real). Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart5")
' tuSeconds = 0, tuMinutes =1, tuHours = 2, tuDays = 3,
' tuWeeks = 4, tuMonths = 5, tuYears = 6
' 2 minutos

288

Visualizao

Chart.Axes.Item("NomeDoEixo").SetRealTimePeriod 2, 1
Chart.Axes.Item("NomeDoEixo").SetTickSpacing 30, 0
End Sub

4.6.5.3.1.8 SetTickSpacing
SetTickSpacing(TickSpacing, TimeUnit)
Configura o espaamento entre os ticks (subdivises da escala) usando a unidade.
O espaamento entre os ticks determinado pelo parmetro TickSpacing. O
parmetro TimeUnit determina a unidade. Caso a escala seja numrica, a unidade
no considerada. As opes disponveis no parmetro TimeUnit esto descritas no
mtodo GetRealTimePeriod. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
' 10 (caso seja a escala numrica,
' o valor da unidade no considerado)
Chart.Axes.Item("NomeDoEixo").SetTickSpacing 10, 0
Chart.Axes.Item("NomeDoEixo").SetTickSpacing 20, 0
End Sub

4.6.5.3.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Eixo.
NOTA: HorAxis e VerAxis s o propri eda des da Col e o de Ei xos que a ces s a m os Ei xos
pa dr o hori zonta l e verti ca l , res pecti va mente. Por exempl o, a o i nvs de uti l i za r
"Cha rt.Axes .Item('Ei xoHori zonta l ')", pode-s e uti l i za r "Cha rt.Axes .HorAxi s ". Dema i s
Ei xos cri a dos pel o us u ri o tm nomes prpri os , es col hi dos ca s o a ca s o.

4.6.5.3.2.1 Color
Determina a cor principal do Eixo.
4.6.5.3.2.2 EnableTextColor
Esta propriedade, quando habilitada, especifica que o texto do Eixo tem a mesma
cor da escala configurada na propriedade Color. O valor padro desta propriedade
Falso.
4.6.5.3.2.3 Format
Determina a formatao dos valores do Eixo. Os formatos permitidos nesta
propriedade esto descritos no Manual do Usurio do E3, no tpico Telas e Objetos
de Tela - Formatao de Valores, ou em branco para selecionar o modo Automtico.
Esta propriedade permite utilizar o caractere | (barra vertical) na String de
formatao como uma quebra de linha.
Visualizao

289

Se a formatao do Eixo for selecionada como Automtica (janela Propriedades do


Eixo, aba Escala, grupo Formatao) e o tipo de escala for selecionado como Mostrar
ltimo perodo (tempo real) ou Intervalo de tempo (histrico), o formato de data e
hora obedece a configurao regional do usurio do Windows. Se o tipo de escala
for selecionado como Escala numrica, utiliza-se a formatao automtica de
nmeros. Exemplo:
Sub CommandButton1_Click()
' Muda a formatao
Set Chart = Screen.Item("E3Chart1")
strOldFormat = Chart.Axes.Item("NomeDoEixo").Format
MsgBox "Clique para setar a formatao automtica."
Chart.Axes.Item("NomeDoEixo").Format = "" ' Automatico
MsgBox "Clique para usar outra formatao."
Chart.Axes.Item("NomeDoEixo").Format = "0.0"
MsgBox "Clique para usar outra formatao."
Chart.Axes.Item("NomeDoEixo").Format = "dd/MM/yy hh:mm:ss"
MsgBox "Clique novamente para voltar formatao original."
Chart.Axes.Item("NomeDoEixo").Format = strOldFormat
End Sub

4.6.5.3.2.4 GridColor
Determina a cor das linhas da grade. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.Axes.Item("NomeDoEixo").ShowGrid = False
MsgBox "Clique para trocar a cor das linhas na grade."
Chart.Axes.Item("NomeDoEixo").GridColor = RGB(0, 0, 255)
Chart.Axes.Item("NomeDoEixo").ShowGrid = True
End Sub

4.6.5.3.2.5 GridStyle
Determina o estilo da linha da grade. As opes disponveis esto descritas na
tabela a seguir.
Opes disponveis para GridStyle
OPO
0 - solid
1 - dash
2 - dot
3 - dashdot
4 - dashdotdot
5 - invisible

290

DESCRIO
O es ti l o da l i nha da gra de s l i da
O es ti l o da l i nha da gra de ponti l ha da
O es ti l o da l i nha da gra de tra ceja da
O es ti l o da l i nha da gra de ponti l ha da
e tra ceja da
O es ti l o da l i nha da gra de tra o-pontoponto
N o h l i nha s vi s vei s na gra de
(i nvi s vel )

Visualizao

Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
' Solid 0, dash 1, dot 2, dashdot 3,
' dashdotdot 4, invisible 5
For i = 0 To 5
MsgBox "Clique para mudar o estilo da linha no grid."
Chart.Axes.Item("NomeDoEixo").GridStyle = i
Next
End Sub

4.6.5.3.2.6 Inverse
Inverte a ordem dos valores mnimo e mximo na escala numrica. Normalmente,
em escalas verticais, o valor mnimo aparece abaixo e o valor mximo acima. Nas
escalas horizontais, o valor mnimo aparece na esquerda e o valor mximo na
direita. Quando a propriedade Inverse estiver configurada para Verdadeiro, no
entanto, esta ordem invertida, valores mximos abaixo ou esquerda e valores
mnimos acima ou direita. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.Axes.Item("NomeDoEixo").Inverse = Not _
Chart.Axes.Item("NomeDoEixo").Inverse
End Sub

4.6.5.3.2.7 MinorTicks
Determina o nmero total de subdivises entre as escalas. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.Axes.Item("NomeDoEixo").MinorTicks = _
Chart.Axes.Item("NomeDoEixo").MinorTicks + 1
End Sub

4.6.5.3.2.8 Mirror
Indica o espelhamento do Eixo. Se a propriedade estiver configurada para
Verdadeiro, o Eixo espelhado no lado oposto do Eixo original. Caso contrrio, o
Eixo permanece na mesma posio. Exemplo:
Sub CommandButton1_DBClick()
Set Chart = Screen.Item("E3Chart1")
Chart.Axes.Item("NomeDoEixo").Mirror = Not _
Chart.Axes.Item("NomeDoEixo").Mirror
End Sub

Visualizao

291

4.6.5.3.2.9 Name
Determina o nome do Eixo.
4.6.5.3.2.10 Position
Determina a posio do Eixo em relao grade do E3Chart. As opes
disponveis esto descritas na tabela a seguir.
Opes disponveis para Position
OPO
O Ei xo
es ca l a
O Ei xo
O Ei xo
O Ei xo

0 - axpLeft
1 - axpRight
2 - axpTop
3 - axpBottom

DESCRIO
pos i ci ona do es querda da
pos i ci ona do di rei ta da es ca l a
pos i ci ona do no topo da es ca l a
pos i ci ona do na ba s e da es ca l a

Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Set newAxis = Chart.Axes.AddAxis("")
For i = 0 To 3
MsgBox "Clique OK para mudar a posio do eixo."
newAxis.Position = i
Next
MsgBox "Remover o eixo."
Chart.Axes.Remove(newAxis.Name)
End Sub

4.6.5.3.2.11 ScaleType
Determina o tipo de escala mostrada pelo Eixo. As opes disponveis neste item
esto descritas na tabela a seguir.
Opes disponveis para ScaleType
OPO
0 - atNumberScale
1 - atLastPeriod
2 - atPeriod

DESCRIO
Es ca l a numri ca
Mos tra l ti mo perodo (Tempo Rea l )
Interva l o de tempo (Hi s tri ca )

Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Set newAxis = Chart.Axes.AddAxis("")

292

Visualizao

For i = 0 To 2
MsgBox "Clique OK para mudar o tipo de escala."
newAxis.ScaleType = i
Next
MsgBox "Remover o eixo."
Chart.Axes.Remove(newAxis.Name)
End Sub

4.6.5.3.2.12 ShowGrid
Determina a visualizao das linhas da grade. Se a propriedade estiver
configurada para Verdadeiro, as linhas da grade so mostradas. Caso contrrio, as
linhas so escondidas. Exemplo:
Sub CommandButton_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.Axes.Item("NomeDoEixo").ShowGrid = Not _
Chart.Axes.Item("NomeDoEixo").ShowGrid
End Sub

4.6.5.3.2.13 Title
Determina o ttulo do Eixo. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.Axes.Item("NomeDoEixo").Title = _
Chart.Axes.Item("NomeDoEixo").Name
MsgBox "Clique para remover o ttulo."
' Retira o ttulo
Chart.Axes.Item("NomeDoEixo").Title = ""
End Sub

4.6.5.3.2.14 Visible
Determina a visibilidade do Eixo na grade. Se a propriedade estiver configurada
para Verdadeiro, o Eixo visvel na grade. Caso contrrio, o Eixo permanece
invisvel. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item(E3Chart1)
Chart.Axes.Item("NomeDoEixo").Visible = Not _
Chart.Axes.Item("NomeDoEixo").Visible
End Sub

4.6.6 Coleo de Consultas


Esta seo contm informaes sobre mtodos e propriedades do objeto Coleo
de Consultas. Este objeto no possui eventos associados.

Visualizao

293

4.6.6.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Coleo de Consultas.

4.6.6.1.1 AddQuery
AddQuery(QueryName[, IsInternal])
Adiciona uma Consulta na Coleo de Consultas do E3Chart. Este mtodo possui os
parmetros QueryName, que determina o nome da Consulta que est sendo
adicionada, e IsInternal, que opcional, obsoleto e no deve ser informado.

4.6.6.1.2 Item
Item(Index)
O mtodo Item retorna um objeto Consulta da Coleo de Consultas, especificado
pelo ndice. Este mtodo possui o parmetro Index, que pode ser do tipo numrico
(se corresponder ao ndice da Consulta) ou texto (se corresponder ao nome da
Consulta).

4.6.6.1.3 Remove
Remove(Index)
Remove o objeto Consulta especificado pelo nome ou pelo ndice da Coleo de
Consultas. Este mtodo possui o parmetro Index, que pode ser do tipo numrico
(se corresponder ao ndice da Consulta) ou texto (se corresponder ao nome da
Consulta).

4.6.6.1.4 UpdateData
UpdateData()
Atualiza os dados de todas as Consultas. Exemplo:
Sub Texto1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
E3Chart1.Queries.UpdateData()
End Sub

4.6.6.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Coleo de
Consultas.

294

Visualizao

4.6.6.2.1 Count
Contm o nmero total de Consultas do E3Chart. Esta propriedade somente de
leitura.

4.6.7 Legenda
Esta seo contm informaes sobre mtodos e propriedades do objeto Legenda.
Este objeto no possui eventos associados.

4.6.7.1 Mtodos
Na Legenda, podem ser selecionadas vrias colunas. Cada coluna mostra um tipo
de informao e possui um nome e um valor correspondente. A seguir, tem-se a
tabela da descrio das colunas possveis na Legenda.
Opes disponveis para identificao das colunas
OPO
Cor da Pena

VALOR
6

NOME
Color

Descrio da Pena

Description

DifX

15

DiffX

DifY

16

DiffY

EscalaX

ScaleX

EscalaY

ScaleY

Estado

Status

FimX

14

XEnd

FimY

18

YEnd

IncioX

13

XBegin

Visualizao

DESCRIO
Mos tra a cor da
Pena .
Mos tra a
propri eda de
DocString da Pena .
Mos tra a di ferena
entre os curs ores
i ni ci a l e fi na l .
Mos tra a di ferena
entre os pontos
i nterpol a dos i ni ci a l
e fi na l no Ei xo Y.
Mos tra o nome da
es ca l a a s s oci a da a o
Ta g X.
Mos tra o nome da
es ca l a a s s oci a da a o
Ta g Y.
Mos tra o s ta tus da
Pena .
Mos tra a pos i o
fi na l do curs or.
Mos tra o ponto
i nterpol a do onde o
curs or fi na l cruza a
Pena .
Mos tra a pos i o
i ni ci a l do curs or.

295

OPO

VALOR
17

YBegin

MximoY

12

MaxY

MdiaY

10

AverageY

MnimoY

11

MinY

Nome da pena

Name

Nome do tag X

TagX

Nome do tag Y

TagY

Unidade

19

EU

Valor do tag X

TagXValue

Valor do tag Y

TagYValue

IncioY

NOME

DESCRIO
Mos tra o ponto
i nterpol a do onde o
curs or i ni ci a l cruza a
Pena .
Mos tra o va l or
m xi mo da Pena no
i nterva l o.
Mos tra o va l or
mdi o da Pena no
i nterva l o.
Mos tra o va l or
mni mo da Pena no
i nterva l o.
Mos tra o nome da
Pena .
Mos tra o nome do
Ta g X a s s oci a do
Pena .
Mos tra o nome do
Ta g Y a s s oci a do
Pena .
Mos tra a uni da de
a s s oci a da Pena .
Mos tra o va l or do
Ta g X a s s oci a do
Pena . Es te va l or
mos tra do qua ndo o
gr fi co es t no
modo de Pes qui s a .
Mos tra o va l or do
Ta g Y a s s oci a do
Pena . Es te va l or
mos tra do qua ndo o
gr fi co es t no
modo de Pes qui s a .

4.6.7.1.1 ChangeColumnPos
ChangeColumnPos(Source, Dest)
Troca a posio entre duas colunas. Possui os seguintes parmetros:
Source: ndice da coluna que ser movida para Dest
Dest: ndice da coluna que ser movida para Source
Exemplo:
Sub CommandButton1_Click()
Screen.Item("E3Chart1").Legend.ChangeColumnPos 1, 2

296

Visualizao

End Sub

4.6.7.1.2 Count
Count()
Retorna o nmero de colunas da Legenda.

4.6.7.1.3 InsertColumn
InsertColumn(Col, Index)
Insere uma nova coluna na Legenda. Este mtodo possui os seguintes parmetros:
Col: Identifica a coluna a ser inserida (ver Tabela de Identificao das Colunas, no
incio do tpico Mtodos da Legenda).
Index: Determina a posio em que a coluna ser inserida.
Exemplo:
Sub CommandButton1_Click()
'Mostra o nome da Pena
Screen.Item("E3Chart1").Legend.InsertColumn 0, 0
End Sub
Sub CommandButton1_Click()
'Mostra a cor da Pena
Screen.Item("E3Chart1").Legend.InsertColumn "Color", 0
End Sub

4.6.7.1.4 Item
Item(Col)
Retorna uma coluna da Legenda pelo nome ou pelo ndice. O parmetro Col
determina o ndice ou o nome da coluna (ver Tabela de Identificao das Colunas, no
incio do tpico Mtodos da Legenda).

4.6.7.1.5 RemoveColumn
RemoveColumn(Col)
Remove uma coluna. Este mtodo possui o parmetro Col, que determina a coluna
que ser removida (ver Tabela de Identificao das Colunas, no incio do tpico
Mtodos da Legenda).

4.6.7.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Legenda.
Visualizao

297

4.6.7.2.1 BackColor
Configura ou retorna a cor de fundo da Legenda. O valor padro desta
propriedade branco (RGB(255, 255, 255)).

4.6.7.2.2 EnableTextColor
Esta propriedade, quando habilitada, especifica que o texto da Legenda ter a
mesma cor da Pena, configurada na propriedade Color. O valor padro desta
propriedade Falso.

4.6.7.2.3 LegendPos
Indica a posio da Legenda no E3Chart.
Opes disponveis para LegendPos
OPO
0 - lgTop
1 - lgLeft
2 - lgBottom
3 - lgRight

Mos tra
Mos tra
Mos tra
Mos tra

a
a
a
a

DESCRIO
Legenda no topo.
Legenda es querda .
Legenda na ba s e.
Legenda di rei ta .

4.6.7.2.4 ShowAllPens
Quando a propriedade for True, todas as Penas do E3Chart so mostradas na
Legenda. A propriedade Visible da Pena ignorada. Quando em False, somente as
Penas com a propriedade Visible igual a True sero mostradas. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
E3Chart1.Legend.ShowAllPens = Not _
E3Chart1.Legend.ShowAllPens
End Sub

4.6.7.2.5 ShowHeader
Determina a visibilidade do ttulo da Legenda (cabealho). Se a opo for
configurada para True, o ttulo da Legenda mostrado. Caso contrrio, o ttulo fica
invisvel.

4.6.7.2.6 Size
Determina o tamanho da Legenda. Este tamanho pode significar a altura ou
largura, dependendo da posio da Legenda.

298

Visualizao

4.6.7.2.7 Visible
Determina a visibilidade da Legenda. Se a opo estiver configurada como True, a
Legenda visvel no E3Chart. Caso contrrio, fica invisvel.

4.6.7.3 Colunas da Legenda


Esta seo contm informaes sobre propriedades do objeto Colunas da Legenda.
Este objeto no possui eventos nem mtodos associados.

4.6.7.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Colunas da
Legenda.
4.6.7.3.1.1 Caption
Permite definir um ttulo para a Coluna.
4.6.7.3.1.2 Column
Retorna o identificador da Coluna. Veja a Tabela de Identificao das Colunas.
4.6.7.3.1.3 Format
Configura o formatador usado na Coluna.
4.6.7.3.1.4 Index
Retorna a posio da Coluna na Legenda.
4.6.7.3.1.5 Name
Determina o nome da Coluna. O nome das Colunas pode ser visto na Tabela de
Identificao das Colunas.
4.6.7.3.1.6 TextAlign
Retorna o alinhamento do texto da Coluna. As opes disponveis para esta
propriedade so as seguintes:
Opes disponveis para TextAlign
OPO
0 - taLeft
1 - taRight

Visualizao

DESCRIO
Al i nha mento es querdo.
Al i nha mento di rei to.

299

OPO
2 - taCenter

DESCRIO
Al i nha mento centra l i za do.

4.6.7.3.1.7 Width
Retorna a largura da Coluna.

4.7 E3Playback
Esta seo contm informaes sobre mtodos e propriedades do objeto
E3Playback. Este objeto no possui eventos associados.

4.7.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto E3Playback.

4.7.1.1 Pause
Pause()
Congela o relgio de playback no tempo atual.

4.7.1.2 Play
Play()
Inicia a reproduo dos dados no horrio atual de playback, avanando o relgio
de acordo com a velocidade de reproduo atual.

4.7.1.3 Stop
Stop()
Interrompe o playback, dados de Tags e alarmes so removidos das Telas e
nenhuma nova consulta feita ao Banco de Dados.

4.7.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto E3Playback.

4.7.2.1 CurrentTime
Mostra a data e a hora atual do objeto E3Playback. Esta propriedade est
disponvel somente em tempo de execuo.

300

Visualizao

4.7.2.2 DBServer
Indica o nome do objeto Banco de Dados que contm os dados histricos do
aplicativo.

4.7.2.3 InitialScreen
Indica a Tela que mostrada inicialmente no E3Playback. Se esta propriedade for
deixada em branco, utilizada a Tela ou Quadro configurado na propriedade
InitialScreen do objeto Viewer.

4.7.2.4 PlaybackState
Informa o estado atual do objeto E3Playback. Esta propriedade est disponvel
somente em tempo de execuo e suas opes esto descritas na tabela a seguir.
Opes da propriedade PlaybackState
OPO
0 - Parado
1 - Reproduzindo
2 - Pausado

DESCRIO
O rel gi o de playback es t pa ra do.
O rel gi o de playback es t s e movendo.
O rel gi o de playback es t pa us a do.

4.8 Relatrios
Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Relatrio.

4.8.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Relatrio.

4.8.1.1 OnAfterPrint
OnAfterPrint()
Iniciado aps uma Seo ter sido montada no Relatrio. Pode-se utilizar este
evento para atualizar qualquer contador cuja utilizao seja necessria depois do
Relatrio ser completado.

4.8.1.2 OnBeforePrint
OnBeforePrint()
Iniciado antes da Seo ter sido montada no Relatrio. Pode-se utilizar este evento
para modificar o valor de um objeto no Relatrio antes que este seja impresso.
Recomenda-se que os campos da Consulta do Relatrio no sejam acessados
Visualizao

301

quando este evento estiver sendo utilizado.

4.8.1.3 OnDataInitialize
OnDataInitialize()
Ocorre antes do evento OnReportStart. Este evento permite acrescentar e configurar
campos coleo Fields de um Relatrio, antes de sua gerao. Exemplo:
Sub OnDataInitialize()
Fields.Add "Nome"
Fields.Add "Setor"
Fields.Add "Cdigo"
End Sub

4.8.1.4 OnError
OnError(Number, Description, SCode, Source, HelpFile, HelpContext, CancelDisplay)
Gerado por um erro interno no Relatrio. Se este evento no for tratado, o E3 ir
mostrar uma mensagem de erro genrica.
Variveis do evento OnError
NOME
Number
Description
SCode
Source
HelpFile
HelpContext
CancelDisplay

DESCRIO
Nmero i ntei ro i denti fi ca dor do erro.
String com a des cri o do erro.
Intei ro com o cdi go de erro do
s ubs i s tema OLE (n o uti l i za do).
String com o objeto ori gem do erro.
String com o nome e ca mi nho do a rqui vo
de a juda .
Nmero de contexto do tpi co de a juda
referente a o erro (i ntei ro).
Bool ea no que i ndi ca s e o erro deve s er
mos tra do em uma MessageBox.

4.8.1.5 OnFetchData
OnFetchData(eof)
Disparado toda vez que um novo registro processado. Este evento utilizado para
executar um script que modifica os valores dos campos que foram adicionados ao
Relatrio em um script associado ao evento OnDataInitialize. A varivel eof tem o
valor padro True e indica que aps o script o processamento do registro atual do
Relatrio foi encerrado.

302

Visualizao

4.8.1.6 OnFormat
OnFormat()
Iniciado depois que os dados so lidos e carregados no Relatrio, mas antes da
Seo ser preparada para a impresso. Este evento pode ser utilizado para
modificar o layout da Seo do Relatrio ou de qualquer outro objeto.

4.8.1.7 OnHyperlink
OnHyperlink(Button, Link)
Ocorre quando um link clicado no Relatrio. Pode-se utilizar este evento para
executar um script que redirecione um link ou para configurar um link no Relatrio.
A varivel Button indica qual boto foi clicado (normalmente, 1) e a varivel Link
determina qual o endereo que ser seguido.

4.8.1.8 OnNoData
OnNoData()
Ocorre quando no h dados a serem impressos no Relatrio. Pode-se utilizar este
evento para executar um script que mostre uma mensagem de erro na tela,
acusando a falta de dados para imprimir e cancele o Relatrio.

4.8.1.9 OnPageEnd
OnPageEnd()
Ocorre ao final da impresso de cada pgina do Relatrio.

4.8.1.10 OnPageStart
OnPageStart()
Ocorre no incio da impresso de cada pgina do Relatrio.

4.8.1.11 OnPrintProgress
OnPrintProgress(PageNumber)
Ocorre enquanto uma pgina do Relatrio est sendo impressa. A varivel
PageNumber indica o nmero da pgina atual.

4.8.1.12 OnReportEnd
OnReportEnd()
Disparado no final da gerao do Relatrio, aps finalizar a sua impresso.
Visualizao

303

4.8.1.13 OnReportStart
OnReportStart()
Disparado no incio da gerao do Relatrio, antes de comear a sua impresso.

4.8.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Relatrio.

4.8.2.1 Export
Export([ExportFilter[, ExportFileName]])
Imprime um Relatrio de acordo com o formato especificado no arquivo. Este
mtodo possui o parmetro ExportFilter, que determina o filtro para o Relatrio,
indicando o formato para a exportao. Pode assumir as seguintes opes:
PDF: Exporta os dados para o formato Adobe PDF
Excel: Exporta os dados para o formato de uma planilha do Excel
HTML: Exporta os dados para o formato HTML
TEXT: Exporta os dados para um arquivo texto
RTF: Exporta os dados para o formato Rich Text Format
TIFF: Exporta os dados para o formato Tag Image File Format
Ao simplesmente informar o nome de um filtro, como exposto acima, os dados
sero exportados utilizando-se as propriedades em comum de cada filtro. Pode-se
modificar as propriedades comuns de um filtro de exportao atravs do mtodo
GetExportFilter, antes de exportar os dados. O nome do arquivo deve ser informado
no parmetro ExportFileName. Exemplo:
Sub Button1_Click()
Set report = Application.LoadReport("[Relatrio3]")
Select case Application._
SelectMenu("PDF|Excel|HTML|RTF|Texto|TIFF|Texto(CSV)")
Case 1
Report.Export "PDF", "C:\correio\reports\report.pdf"
MsgBox "Exportado para PDF!"
Case 2
Report.Export "EXCEL", "C:\correio\reports\report.XLS"
MsgBox "Exportado para XLS!"
Case 3
Report.Export "HTML", "C:\correio\reports\report.html"
MsgBox "Exportado para HTML!"
Case 4
Report.Export "RTF", "C:\correio\reports\report.rtf"

304

Visualizao

MsgBox "Exportado para RTF!"


Report.Export "TEXT", "C:\correio\reports\report.txt"
MsgBox "Exportado para TXT!"
Case 6
Report.Export "TIFF", "C:\correio\reports\report.tiff"
MsgBox "Exportado para TIFF!"
Case 7
Set reportFilter = report.GetExportFilter("TEXT")
reportFilter.FileName = "C:\correio\reports\report2.txt"
reportFilter.TextDelimiter = ","
report.Export reportFilter
MsgBox "Exportado para TXT usando filtro!"
End Select
End Sub

4.8.2.2 GetExportFilter
GetExportFilter(FilterName)
Retorna um objeto que especifica a customizao dos parmetros de exportao.
Este mtodo possui o parmetro FilterName, que determina o filtro para o Relatrio,
indicando o tipo de formato para a exportao. Pode assumir as seguintes opes:
PDF: Exporta os dados para o formato Adobe PDF
Excel: Exporta os dados para o formato de uma planilha do Excel
HTML: Exporta os dados para o formato HTML
TEXT: Exporta os dados para um arquivo texto
RTF: Exporta os dados para o formato Rich Text Format
TIFF: Exporta os dados para o formato Tag Image File Format
Depois de obtido o filtro, as seguintes propriedades podem ser modificadas:
Propriedades passveis de modificao
PROPRIEDADE
AutoRowHeight

Excel

BorderSpace

Excel

Visualizao

FILTRO

DESCRIO
Em True (pa dr o), confi gura
a a l tura da l i nha
a utoma ti ca mente. Em
Fa l s e, confi gura a a l tura
pa ra o ma i or el emento na
l i nha .
Es pa a mento mni mo entre
a s cl ul a s . O va l or pa dr o
de 59 twi ps .

305

PROPRIEDADE
CreateCSSFile

HTML

DoubleBoundaries

Excel

ExportRange

HTML

FaxExport

TIFF

FileName

Todos

GenPageBreaks

HTML

HTMLOutputPath

HTML

JPGQuality

PDF

MinColumnWidth

Excel

MinRowHeight
MultiSheet

Excel
Excel

PageDelimiter

TEXT

SuppressEmptyLines

TEXT

TextDelimiter

HTML

306

FILTRO

DESCRIO
Se verda dei ro, gera um
a rqui vo CSS no di retri o
i ndi ca do por
HTMLOutputPath.
Em True, i ndi ca que os
el ementos a l i nha dos
di rei ta devem repor os
a l i nha dos es querda na
mes ma col una . Ca s o
contr ri o, dei xe em Fa l s e
pa ra l i bera r ma i s es pa o.
Indi ca uma fa i xa de
p gi na s pa ra s erem
exporta da s . Por exempl o,
"1, 2, 3-9, 14".
Objeto que permi te
exporta r os da dos no
forma to RFC 1314 TIFF.
Informa o nome do a rqui vo
pa ra o qua l os da dos s er o
exporta dos .
Em True, col oca r quebra s
de p gi na a ba i xo do
el emento ma i s i nferi or em
ca da p gi na do Rel a tri o.
Ca mi nho pa dr o pa ra os
a rqui vos HTML.
Indi ca o nvel de qua l i da de
da s i ma gens exporta da s
(de 0 a 100).
Ta ma nho mni mo da
col una . O va l or pa dr o
1011 twi ps .
Ta ma nho mni mo da l i nha .
Em True, ca da p gi na no
Rel a tri o va i pa ra uma
pl a ni l ha s epa ra da .
Confi gura ou retorna o
ca ra ctere del i mi ta dor entre
p gi na s .
Reti ra ou i ns ere l i nha s
va zi a s , pa ra efei to de
layout.
Confi gura ou retorna o
ca ra ctere del i mi ta dor entre
os textos .

Visualizao

PROPRIEDADE
TrimEmptySpace

Excel

FILTRO

Unicode

TEXT

WebCacheOutput

HTML

DESCRIO
Em True, o es pa o verti ca l
entre os el ementos s er
el i mi na do. O pa dr o
Fa l s e.
Determi na s e o texto va i
s er s a l vo em forma to
Uni code (16 bi ts ).
Em True, o Rel a tri o s er
exporta do pa ra o s ervi o
de WebCa che. Ca s o
contr ri o (pa dr o), n o
s er exporta do.

4.8.2.3 Print
Print()
Imprime um Relatrio.

4.8.2.4 PrintPreview
PrintPreview()
Faz uma prvia de impresso de Relatrio na Tela. Se o Relatrio for mostrado
corretamente na Tela, retorna True. Caso o usurio aperte o boto Cancel ou
acontea algum erro, retorna False. Exemplo:
Sub CommandButton1_Click()
Set report = Application.LoadReport("[Relatrio1]")
Inicio = Application.GetObject("Dados.Grafico.datai").Value
Final = Application.GetObject("Dados.Grafico.dataf").Value
report.Item("Consulta1").SetVariableValue "Ini", Inicio
report.Item("Consulta1").SetVariableValue "Fim", Final
report.PrintPreview()
End Sub
NOTA: Es te mtodo n o es t di s ponvel pa ra Rel a tri os ca rrega dos us a ndo o
mtodo LoadReport do Servi dor.

4.8.2.5 Query
Query()
Retorna o objeto Consulta atualmente selecionado no Relatrio. Para maiores
informaes a respeito deste objeto, veja o captulo Consultas. Exemplo:
Sub Rect_Click()
Set Query = Application.LoadReport("[Relatrio3]").Query()
Query.SetVariableValue("Chave1", "XYZ")
End Sub

Visualizao

307

4.8.3 Propriedades
Para criar um script no Relatrio, utiliza-se o Editor de Scripts do Relatrio,
acessado atravs do boto Editor de Scripts e para visualizar o Relatrio, utiliza-se
o boto Gerar Relatrio, ambos localizados na Barra de Ferramentas do Relatrio.
Os scripts do Relatrio utilizam alguns procedimentos, dependendo do objeto ou
da Seo onde se deseja incluir o cdigo. Por exemplo:
Report.Sections("PageHeader").Controls("E3Chart1")._
GridBkColor= RGB(255, 0, 255).

Onde:
PageHeader: o nome da Seo onde o objeto est incluso no Relatrio
E3Chart1: o nome do objeto que est dentro da Seo especificada, neste caso
PageHeader
GridBkColor: o nome da propriedade do objeto, neste caso E3Chart
RGB(255, 0, 255): o parmetro ou ao da propriedade. Neste caso, mudar a cor
de fundo do grfico para rosa
Sendo assim, para fazer-se um script no Relatrio, usa-se o seguinte conceito:
Report.Sections("NomeDaSeo").Controls("NomeDoObjeto")._
NomeDaPropriedade=parmetros_da_propriedade
NOTA: O objeto Rel a tri o enca ps ul a um objeto Acti veReports (ou AR), que o
Rel a tri o propri a mente di to.

4.8.3.1 Caption
Contm o ttulo do Relatrio que aparece na barra de ttulo da janela de
visualizao (preview). O valor padro desta propriedade uma String vazia.

4.8.4 Layout
Esta seo contm informaes sobre propriedades do objeto Layout do Relatrio.
Este objeto no possui eventos nem mtodos associados.

4.8.4.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Layout do
Relatrio.

308

Visualizao

NOTA: As propri eda des a qui des cri ta s s o pa rte do objeto Acti veReport (ou AR) que
enca ps ul a do no objeto Rel a tri o. Es ta s propri eda des s o v l i da s a pena s dentro
do es copo do AR e n o podem s er a ces s a da s fora des s e objeto.

4.8.4.1.1 _PageBottomMargin
Determina a margem inferior do Relatrio, em twips (1 twip = 1/1440 polegada). O
valor padro desta propriedade 1440 (1 pol ou 2,54 cm).

4.8.4.1.2 _PageLeftMargin
Determina a margem esquerda do Relatrio, em twips (1 twip = 1/1440 polegada).
O valor padro desta propriedade 1440 (1 pol ou 2,54 cm).

4.8.4.1.3 _PageRightMargin
Determina a margem direita do Relatrio, em twips (1 twip = 1/1440 polegada). O
valor padro desta propriedade 1440 (1 pol ou 2,54 cm).

4.8.4.1.4 _PageTopMargin
Determina a margem superior do Relatrio, em twips (1 twip = 1/1440 polegada).
O valor padro desta propriedade 1440 (1 pol ou 2,54 cm).

4.8.4.1.5 AllowSplitters
Permite que a tela de visualizao do Relatrio seja dividida em duas partes.
Essa propriedade s est disponvel em tempo de execuo. Se a propriedade
estiver configurada para False (valor padro), a barra para diviso no aparece na
tela.

4.8.4.1.6 documentName
Determina o nome do documento para o Relatrio. Este nome aparece no
gerenciador de impresso e pode ser usado para identificar mais facilmente o
Relatrio. O valor padro desta propriedade "ActiveReports Document".

4.8.4.1.7 MaxPages
Estabelece o nmero mximo de pginas para o Relatrio. Quando este nmero
alcanado, o E3 para de processar o documento. O valor padro desta propriedade
10.

4.8.4.1.8 ParentReport
Esta propriedade uma varivel de uso interno do sistema e contm uma
referncia para o objeto Relatrio. A propriedade somente de leitura, e vlida
Visualizao
309

apenas para os eventos OnDataInitialize e OnReportEnd.

4.8.4.1.9 PrintWidth
Determina a largura da rea de impresso do Relatrio, em twips. Se o tamanho
do Relatrio for mudado em tempo de execuo, a largura de impresso tambm
dever ser ajustada, para garantir que o Relatrio ir ocupar toda a rea de
impresso. O tamanho da rea de impresso deve tambm incluir a largura das
margens, para que o Relatrio no fique maior que o tamanho do papel. Se isto
acontecer, o erro ser assinalado por uma linha pontilhada vermelha impressa em
cada pgina do Relatrio.

4.8.4.1.10 RulerVisible
Quando configurado como True, indica que sero mostradas uma rgua vertical e
outra horizontal na janela de visualizao do Relatrio. Do contrrio, as rguas
ficaro invisveis.

4.8.4.1.11 ScriptDebuggerEnabled
Habilita ou desabilita o depurador do ActiveReports (JIT), para depurar os scripts
associados aos Relatrios. Este depurador no est disponvel em todo o E3,
apenas nos Relatrios.

4.8.4.1.12 ScriptLanguage
Indica a linguagem usada para interpretar os scripts associados a um Relatrio.
A linguagem padro o VBScript, mas JScript tambm pode ser utilizada.

4.8.4.1.13 ShowParameterUI
Habilita ou desabilita os parmetros da caixa de dilogo da Consulta, que
aparece quando o Relatrio est sendo executado. Se a propriedade estiver
configurada para True, os parmetros da caixa de dilogo da Consulta sero
mostrados. Caso contrrio, estes parmetros no so mostrados.

4.8.4.1.14 Status
Retorna o status do Relatrio. As opes disponveis para esta propriedades so
as seguintes:
Opes disponveis para Status
OPO
0 - DDStatIdle
1 - DDStartRunning

310

DESCRIO
Indi ca que o Rel a tri o es t fecha do.
Indi ca que o Rel a tri o es t s endo
executa do.

Visualizao

OPO
2 - DDStartCompleted
3 - DDStartCanceled

DESCRIO
Indi ca que o Rel a tri o es t compl eto.
Indi ca que o Rel a tri o foi ca ncel a do.

4.8.4.1.15 TOCEnabled
Habilita ou desabilita o ndice do Relatrio. Se a propriedade estiver configurada
para True, o ndice do Relatrio habilitado; do contrrio, o Relatrio no ter
ndice. O valor padro desta propriedade True.

4.8.4.1.16 TOCVisible
Determina a visibilidade do ndice do Relatrio. Se a propriedade estiver
configurada para True, o ndice do Relatrio mostrado; do contrrio, o ndice fica
invisvel. O valor padro desta propriedade True.

4.8.4.1.17 ToolbarVisible
Habilita ou desabilita a Barra de Ferramentas da janela de prvia de impresso
do Relatrio. Se a propriedade estiver configurada para True, a barra habilitada;
do contrrio, no haver barra de ferramentas nesta janela.

4.8.4.1.18 UserData
Configura ou retorna as informaes especficas do usurio. Esta propriedade
similar propriedade Tag do Visual Basic, mas ser exportada e salva em um
arquivo .rpx. Pode ser usada para salvar e carregar qualquer informao
personalizada necessria ao desenho do Relatrio.

4.8.4.1.19 Version
Retorna o nmero da verso do produto.

4.8.4.1.20 WaterMark
Adiciona uma imagem de fundo ao Relatrio (marca d'gua). As marcas d'gua
so textos ou figuras que aparecem sob o texto do documento. Normalmente, elas
tornam o documento visualmente mais interessante.

Visualizao

311

Exemplo de marca d'gua

O valor padro desta propriedade vazio (sem imagem).

4.8.4.1.21 WaterMarkAlignment
Determina o alinhamento da marca d'gua no Relatrio. As opes disponveis
para esta propriedade so as seguintes:
Opes disponveis para WaterMarkAlignment
OPO
0 - ddPATopLeft
1 - ddPATopRight
2 - ddPACenter
3 - ddPABottomLeft
4 - ddPABottonRight

Al i nha
Al i nha
Al i nha
Al i nha
Al i nha

a
a
a
a
a

DESCRIO
i ma gem a o topo e es querda .
i ma gem a o topo e di rei ta .
i ma gem a o centro (pa dr o).
i ma gem ba s e e es querda .
i ma gem ba s e e di rei ta .

4.8.4.1.22 WaterMarkPrintOnPages
Indica o nmero das pginas do Relatrio que recebero a marca d'gua. A
sintaxe utilizada pode incluir uma nica pgina, uma extenso de pginas, ou
mesmo uma combinao de ambos. Exemplo: 1, 5-8, 9, 10-15.
312

Visualizao

4.8.4.1.23 WaterMarkSizeMode
Configura o efeito do tamanho da marca d'gua na pgina do Relatrio. As opes
disponveis so as seguintes:
Opes disponveis para WaterMarkSizeMode
OPO
0 - ddSMClicp
1 - ddSMStretch
2 - ddSMZoom

DESCRIO
A ma rca d' gua mos tra da no Rel a tri o
no s eu ta ma nho ori gi na l .
A ma rca d' gua i r preencher toda a
p gi na do Rel a tri o.
A ma rca d' gua s er a umenta da a t fi ca r
do ta ma nho da p gi na do Rel a tri o.

4.8.5 Seo
Esta seo contm informaes sobre propriedades comuns do objeto Seo do
Relatrio. Este objeto no possui eventos nem mtodos associados.

4.8.5.1 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns do objeto Seo do
Relatrio.

4.8.5.1.1 BackColor
Especifica a cor de fundo da Seo do Relatrio. O efeito desta propriedade s
ser visvel se a propriedade BackStyle estiver habilitada para a opo 1 ddBKNormal. O valor padro branco (RGB(255, 255, 255)).

4.8.5.1.2 BackStyle
Especifica o estilo de fundo da Seo do Relatrio. As opes disponveis para
esta propriedade so as seguintes:
0 - ddBKTransparent: fundo transparente
1 - ddBKNormal: fundo normal

4.8.5.1.3 CanGrow
Determina a aplicao de stretch ao texto da pgina do Relatrio. Caso a largura
ou a altura da pgina sejam aumentadas, o texto acompanha esta variao. Se a
propriedade estiver configurada para True, o texto acompanha as variaes de
altura e de largura do objeto. Caso contrrio, este permanece com as configuraes
iniciais. O valor padro desta propriedade True.
Visualizao

313

4.8.5.1.4 CanShrink
Determina a aplicao do efeito de encolhimento ao texto da pgina do Relatrio.
Caso a largura ou a altura da pgina sejam diminudas, o texto acompanha esta
variao. Se a propriedade estiver configurada para True, o texto acompanha as
variaes de altura e largura do objeto. Caso contrrio, este permanece com as
configuraes iniciais. O valor padro desta propriedade True.

4.8.5.1.5 height
Determina a altura da Seo da pgina do Relatrio. O valor padro desta
propriedade 360.

4.8.5.1.6 IsRepeating
Determina a repetio da Seo na ltima pgina do Relatrio. Se a propriedade
estiver configurada para True, a Seo ser repetida na ltima pgina. Caso
contrrio, no haver esta repetio.

4.8.5.1.7 Name
Indica o nome da Seo do Relatrio.

4.8.5.1.8 Type
Retorna o tipo da Seo. As opes disponveis so:
Opes disponveis para Type
OPO
0 - ReportHeader
1 - ReportFooter
2 - PageHeader
3 - PageFooter
4 - GroupHeader
5 - GroupFooter
6 - Detail

314

DESCRIO
Se o ti po ReportHea der (Ca bea l ho de
Rel a tri o).
Se o ti po ReportFooter (Roda p de
Rel a tri o).
Se o ti po Pa geHea der (Ca bea l ho de
p gi na ).
Se o ti po Pa geFooter (Roda p de
p gi na ).
Se o ti po GroupHea der (Ca bea l ho de
grupo).
Se o ti po GroupFooter (Roda p de
grupo).
Se o ti po Deta i l ( rea pa ra contedo do
Rel a tri o).

Visualizao

4.8.5.1.9 Visible
Habilita ou desabilita a visibilidade da Seo no Relatrio. Se a propriedade
estiver configurada para True, a Seo visvel no Relatrio. Caso contrrio, no
visvel. O valor padro desta propriedade True.

4.8.5.2 Group Header


Esta seo contm informaes sobre propriedades do objeto Group Header do
Relatrio. Este objeto no possui eventos nem mtodos associados.

4.8.5.2.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Group Header do
Relatrio.
4.8.5.2.1.1 ColumnLayout
Determina se o GroupHeader ir utilizar o mesmo layout das colunas
configuradas na Seo Detail. Se a propriedade estiver configurada para True, o
nmero de colunas na Seo Detail ser o mesmo do GroupHeader ou GroupFooter
associados. Caso contrrio, ele permanece com as configuraes padro.
4.8.5.2.1.2 DataField
Retorna os dados dos campos do Relatrio. Define um campo obrigatrio para
um grupo dentro do contedo da Seo Detail. Este valor ajustado ao nome de
todos os campos na fonte de dados do Relatrio ou ao nome de um campo
customizado que est inserido na coleo de campos. Quando esta propriedade
ajustada, o Relatrio cria um grupo novo cada vez que o valor do campo muda nos
registros de dados do detalhe.
4.8.5.2.1.3 GrpKeepTogether
Determina se a Seo GroupHeader ser impressa como um bloco nico na
mesma pgina do Relatrio. As opes disponveis so as seguintes:
Opes disponveis para GrpKeepTogether
OPO
0 - GrpNone

1 - GrpFirstDetails

Visualizao

DESCRIO
A p gi na pode s er quebra da
i medi a ta mente depoi s de um
GroupHeader.
O GroupHeader s er i mpres s o com a
pri mei ra Se o Detail da mes ma p gi na
ou col una do Rel a tri o.

315

OPO

DESCRIO
O GroupHeader, Detail e Footer de grupo
s er o i mpres s os juntos na mes ma
p gi na do Rel a tri o.

2 - GrpAll

O valor padro desta propriedade 0 - GrpNone.


4.8.5.2.1.4 KeepTogether
Determina se as Sees do Relatrio sero impressas como um nico bloco, na
mesma pgina. As opes disponveis para esta propriedade so as seguintes:
Opes disponveis para KeepTogether
OPO
0 - ddGrpNone
1 - ddGrpFirstDetail

DESCRIO
H uma quebra de p gi na depoi s do
Rel a tri o.
O Rel a tri o i mpri mi r a Se o Detail na
mes ma p gi na ou col una .

4.8.5.2.1.5 NewColumn
Insere uma nova quebra de coluna antes ou depois da impresso da Seo no
Relatrio. As opes disponveis para esta propriedade so as seguintes:
Opes disponveis para NewColumn
OPO
0 - ddNPNone
1 - ddNBefore
2 - ddNPAfter
3 - ddNPBeforeAfter

DESCRIO
N o h quebra de p gi na na Se o.
Ini ci a a i mpres s o da Se o em uma
nova p gi na .
Ini ci a uma nova p gi na depoi s de
i mpri mi r a Se o.
Ini ci a a i mpres s o em uma nova p gi na
e uma nova p gi na depoi s de i mpri mi r a
Se o.

4.8.5.2.1.6 NewPage
Insere uma quebra de pgina no Relatrio. As opes disponveis para esta
propriedade so as seguintes:
Opes disponveis para NewPage
OPO
0 - ddNPNone
1 - ddNBefore

316

DESCRIO
N o h quebra de p gi na na Se o
(pa dr o).
Ini ci a a i mpres s o em uma nova p gi na .

Visualizao

OPO
2 - ddNPAfter
3 - ddNPBeforeAfter

DESCRIO
Ini ci a uma nova p gi na depoi s da
i mpres s o da Se o.
Ini ci a a i mpres s o em uma nova p gi na
e i ni ci a uma nova p gi na depoi s de
i mpri mi r a Se o.

4.8.5.2.1.7 Repeat
Determina se o GroupHeader ser impresso novamente depois de ser associado
Seo Detail quando h mltiplas pginas, colunas ou quebras de pginas no
Relatrio. As opes disponveis so as seguintes:
Opes disponveis para Repeat
OPO
0 - ddRepeatNone
1 - ddRepeatOnPage
2 - ddRepeatOnColumn

3 - ddRepeatAll

DESCRIO
N o h rei mpres s o do grupo de
ca bea l ho (pa dr o).
Impri me o grupo de ca bea l hos no topo
da p gi na conforme a s es peci fi ca es da
Se o Detail.
Impri me o grupo de ca bea l hos no topo
da col una da p gi na do Rel a tri o
conforme a s es peci fi ca es da Se o
Detail.
Impri me o grupo de ca bea l hos e os
dema i s objetos no topo da p gi na do
Rel a tri o conforme a s es peci fi ca es da
Se o Detail.

4.8.5.2.1.8 UnderlayNext
Determina se a Seo deve imprimir uma Seo depois da outra,
consecutivamente. Se a propriedade estiver configurada para True, a Seo seguinte
comear a impresso a partir da coordenada superior da Seo na pgina do
Relatrio. Caso contrrio, este recurso no utilizado. O valor padro desta
propriedade False.

4.8.5.3 Detail
Esta seo contm informaes sobre propriedades do objeto Detail do Relatrio.
Este objeto no possui eventos nem mtodos associados.

4.8.5.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Detail do
Relatrio.
Visualizao

317

4.8.5.3.1.1 ColumnCount
Determina o nmero de colunas na Seo Detail do Relatrio. A largura de cada
coluna deve ser igual a rea imprimvel do Relatrio, dividida pelo nmero de
colunas. O valor padro desta propriedade 1.
4.8.5.3.1.2 ColumnDirection
A propriedade ColumnDirection determina a direo da impresso das colunas
da Seo Detail. As opes disponveis so as seguintes:
Opes disponveis para ColumnDirection
OPO
0 - ddCDDownAcross

1 - ddCDAcrossDown

DESCRIO
Impri me ca da col una da Se o Detail de
ci ma pa ra ba i xo e depoi s pa s s a pa ra a
prxi ma col una di rei ta .
Impri me ca da col una da Se o Detail da
di rei ta pa ra a es querda e a s s i m por
di a nte.

O layout determinado conforme a opo configurada:

Opo ddCDDownAccross

318

Visualizao

Opo ddCDAccrossDown

4.8.5.3.1.3 ColumnSpacing
Determina o espaamento da coluna na Seo Detail. O valor padro desta
propriedade 0.
4.8.5.3.1.4 KeepTogether
Determina se as Sees do Relatrio sero impressas como um nico bloco, na
mesma pgina. As opes disponveis para esta propriedade so as seguintes:
Opes disponveis para KeepTogether
OPO
0 - ddGrpNone
1 - ddGrpFirstDetail

DESCRIO
H uma quebra de p gi na depoi s do
Rel a tri o.
O Rel a tri o i mpri mi r a Se o Detail na
mes ma p gi na ou col una .

4.8.5.3.1.5 NewColumn
Insere uma nova quebra de coluna antes ou depois da impresso da Seo no
Relatrio. As opes disponveis para esta propriedade so as seguintes:

Visualizao

319

Opes disponveis para NewColumn


OPO
0 - ddNPNone
1 - ddNBefore
2 - ddNPAfter
3 - ddNPBeforeAfter

DESCRIO
N o h quebra de p gi na na Se o.
Ini ci a a i mpres s o da Se o em uma
nova p gi na .
Ini ci a uma nova p gi na depoi s de
i mpri mi r a Se o.
Ini ci a a i mpres s o em uma nova p gi na
e uma nova p gi na depoi s de i mpri mi r a
Se o.

4.8.5.3.1.6 NewPage
Insere uma quebra de pgina no Relatrio. As opes disponveis para esta
propriedade so as seguintes:
Opes disponveis para NewPage
OPO
0 - ddNPNone
1 - ddNBefore
2 - ddNPAfter
3 - ddNPBeforeAfter

DESCRIO
N o h quebra de p gi na na Se o.
Ini ci a a i mpres s o em uma nova p gi na .
Ini ci a uma nova p gi na depoi s da
i mpres s o da Se o.
Ini ci a a i mpres s o em uma nova p gi na
e i ni ci a uma nova p gi na depoi s de
i mpri mi r a Se o.

4.8.5.4 Group Footer


Esta seo contm informaes sobre propriedades do objeto Group Footer do
Relatrio. Este objeto no possui eventos nem mtodos associados.

4.8.5.4.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Group Footer do
Relatrio.
4.8.5.4.1.1 ColumnLayout
Determina se o GroupFooter ir utilizar o mesmo layout das colunas
configuradas na Seo Detail. Se a propriedade estiver configurada para True, o
nmero de colunas na Seo Detail ir refletir no GroupHeader ou no GroupFooter
associados. Caso contrrio, permanece com as configuraes padro. O valor
padro desta propriedade True.

320

Visualizao

4.8.5.4.1.2 KeepTogether
Determina se as Sees do Relatrio sero impressas como um nico bloco, na
mesma pgina. As opes disponveis para esta propriedade so as seguintes:
Opes disponveis para KeepTogether
OPO
0 - ddGrpNone
1 - ddGrpFirstDetail

DESCRIO
H uma quebra de p gi na depoi s do
Rel a tri o.
O Rel a tri o i mpri mi r a s e o Detail na
mes ma p gi na ou col una .

4.8.5.4.1.3 NewColumn
Insere uma nova quebra de coluna antes ou depois da impresso da Seo no
Relatrio. As opes disponveis para esta propriedade so as seguintes:
Opes disponveis para NewColumn
OPO
0 - ddNPNone
1 - ddNBefore
2 - ddNPAfter
3 - ddNPBeforeAfter

DESCRIO
N o h quebra de p gi na na Se o.
Ini ci a a i mpres s o da Se o em uma
nova p gi na .
Ini ci a uma nova p gi na depoi s de
i mpri mi r a Se o.
Ini ci a a i mpres s o em uma nova p gi na
e uma nova p gi na depoi s de i mpri mi r a
Se o.

4.8.5.4.1.4 NewPage
Insere uma quebra de pgina no Relatrio. As opes disponveis para esta
propriedade so as seguintes:
Opes disponveis para NewPage
OPO
0 - ddNPNone
1 - ddNBefore
2 - ddNPAfter
3 - ddNPBeforeAfter

Visualizao

DESCRIO
N o h quebra de p gi na na Se o
(pa dr o).
Ini ci a a i mpres s o em uma nova p gi na .
Ini ci a uma nova p gi na depoi s da
i mpres s o da Se o.
Ini ci a a i mpres s o em uma nova p gi na
e i ni ci a uma nova p gi na depoi s de
i mpri mi r a Se o.

321

4.8.5.4.1.5 PrintAtBottom
Determina se o GroupFooter ou o rodap do Relatrio sero impressos no p da
pgina. Se a propriedade estiver configurada para True e o Relatrio contiver um
rodap de pgina, o GroupFooter e o rodap do Relatrio sero impressos acima
da Seo Rodap de Pgina. Configurando mais de uma Seo para imprimir o p
da pgina do Relatrio, far com que as Sees seguintes do rodap sejam
impressas em pginas separadas.

4.8.6 Objetos
Esta seo contm informaes sobre propriedades dos Objetos do Relatrio. Estes
objetos no possuem eventos nem mtodos associados.

4.8.6.1 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns aos objetos do
Relatrio.

4.8.6.1.1 BackColor
Especifica a cor de fundo do objeto no Relatrio. O efeito desta propriedade s
ser visvel se a propriedade BackStyle estiver habilitada para a opo 1 ddBKNormal. O valor padro desta propriedade branco (RGB(255, 255, 255)).
NOTA: es ta propri eda de n o v l i da pa ra os objetos Li nha e Quebra de P gi na .

4.8.6.1.2 BackStyle
Especifica o estilo do fundo dos objetos do Relatrio. As opes disponveis
para esta propriedade so as seguintes:
0 - ddBKTransparent: transparente (mostra a cor definida pela propriedade
BackColor da Seo)
1 - ddBKNormal: normal (mostra a cor definida pela propriedade BackColor do
objeto)
O valor padro 0 - ddBKTransparent.
NOTA: es ta propri eda de n o v l i da pa ra os objetos Li nha , Cdi go de Ba rra s ,
Quebra de P gi na e Ta bel a .

322

Visualizao

4.8.6.1.3 height
Esta propriedade determina a altura do objeto no Relatrio.
NOTA: es ta propri eda de n o v l i da pa ra os objetos Li nha e Quebra de P gi na .

4.8.6.1.4 left
Retorna o valor do posicionamento esquerdo do objeto no Relatrio.
NOTA: es ta propri eda de n o v l i da pa ra os objetos Li nha e Quebra de P gi na .

4.8.6.1.5 Name
Determina o nome do objeto. O valor padro desta propriedade uma String
vazia.

4.8.6.1.6 Tag
Retorna o tipo do Tag associado ao objeto, isto , Boolean, String, Integer, etc.

4.8.6.1.7 Top
Retorna o valor do topo do objeto.
NOTA: es ta propri eda de n o v l i da pa ra o objeto Li nha .

4.8.6.1.8 Visible
Determina a visibilidade do objeto no Relatrio. Se a opo estiver configurada
para True, o objeto visvel no Relatrio. Caso contrrio, o objeto est oculto. O
valor padro desta propriedade True.
NOTA: es ta propri eda de n o v l i da pa ra o objeto Quebra de P gi na .

4.8.6.1.9 Width
Esta propriedade determina a largura do objeto no Relatrio.
NOTA: es ta propri eda de n o v l i da pa ra os objetos Li nha e Quebra de P gi na .

Visualizao

323

4.8.6.2 Cdigo de Barras


Esta seo contm informaes sobre propriedades do objeto Cdigo de Barras do
Relatrio. Este objeto no possui eventos nem mtodos associados.

4.8.6.2.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Cdigo de Barras
do Relatrio.
4.8.6.2.1.1 Alignment
Determina o alinhamento do texto do objeto no Relatrio. As opes disponveis
so as seguintes:
0 - ddtxLeft: alinha o texto esquerda do objeto
1 - ddtxRight: alinha o texto direita do objeto
2 - ddtxCenter: alinha o texto ao centro do objeto
4.8.6.2.1.2 BarWidth
Determina a largura das barras do Cdigo de Barras. Configurando a largura para
1, a barra do objeto expandida em at 15 pontos, e assim por diante. Quanto
maior o nmero configurado na propriedade, maior a largura da barra do cdigo
de barras. O valor padro desta propriedade 1.
4.8.6.2.1.3 Caption
Contm o texto do objeto propriamente dito. O valor padro desta propriedade
uma String vazia.
4.8.6.2.1.4 CaptionPosition
Especifica a posio do texto da propriedade Caption no objeto. As opes
disponveis para esta propriedade so as seguintes:
0 - ddbcCaptionNone: o texto da propriedade Caption no aparece no Cdigo de
Barras
1 - ddbcCaptionAbove: o texto da propriedade Caption aparece acima do Cdigo
de Barras
2 - ddbcCaptionBelow: o texto da propriedade Caption aparece abaixo do Cdigo
de Barras
O valor padro desta propriedade 0 - ddbcCaptionNone.
324

Visualizao

4.8.6.2.1.5 DataField
Configura ou retorna o dado associado ao objeto. Este dado associado pode ser
um campo da tabela no Banco de Dados fornecido pelo objeto Consulta; uma
expresso matemtica com campos da Consulta e funes do VBScript (neste caso,
o campo deve ser precedido do smbolo de igual); ou um Tag ou propriedade do E3.
Neste caso o valor atual da varivel ser mostrado ao realizar a impresso. O
valor padro desta propriedade uma String vazia.
NOTA: O s ervi dor deve es ta r s endo executa do pa ra que o va l or da va ri vel pos s a s er
ca ptura do.

4.8.6.2.1.6 Direction
Determina a orientao espacial dos Cdigos de Barra. As opes disponveis
nesta propriedade so as seguintes:
Opes disponveis para Direction
OPO
0 - ddbcLeftToRight
1 - ddbcRightToLeft
2 - ddbcTopToBottom
3 - ddbcBottomToTop

DESCRIO
O Cdi go de Ba rra s di reci ona do
es querda pa ra a di rei ta .
O Cdi go de Ba rra s di reci ona do
di rei ta pa ra a es querda .
O Cdi go de Ba rra s di reci ona do
ba i xo pa ra ci ma .
O Cdi go de Ba rra s di reci ona do
ci ma pa ra ba i xo.

da
da
de
de

O valor padro desta propriedade 0 - ddbcLeftToRight.


4.8.6.2.1.7 EnableCheckSum
Habilita ou desabilita a leitura do valor de checksum (caractere de objeto do
Cdigo de Barras). Se a propriedade estiver habilitada para False, somente cdigos
com checksum sero afetados.
4.8.6.2.1.8 Font
Determina a fonte do objeto no texto estabelecido pela propriedade Caption. O
valor padro desta propriedade "Arial".
NOTA: Es ta propri eda de n o us a da em s cri pts ou em As s oci a es , s endo edi ta da
s omente vi a E3 Studi o.

Visualizao

325

4.8.6.2.1.9 Forecolor
Especifica a cor de preenchimento de frente do objeto. Nos scripts, utilize a
funo do VBScript RGB para montar a cor a ser associada a esta propriedade. O
valor padro desta propriedade preto (RGB(0, 0, 0)).
4.8.6.2.1.10 Style
Determina o estilo do Cdigo de Barras. As opes disponveis so as seguintes:
Opes disponveis para Style
OPO
0 - ddbcNone
1 - ddbcAnsi39
2 - ddbcAnsi39x

3 - ddbcCode_2_of_5
4 - ddbcCode25intlv
5 - ddbcCode25mat
6 - ddbcCode39
7 - ddbcCode39x
8 - ddbcCode_128_a
9 - ddbcCode_128_b
10 - ddbcCode_128_c
11 - ddbcCode_128auto

12 - ddbcCode_93
13 - ddbcCode_93x

14 - ddbcMSI

326

DESCRIO
Es ti l o de cdi go de ba rra s pa dr o.
Es ti l o de cdi go de ba rra s ANSI 3 de 9
(Cdi go 39). Uti l i ze l etra s , nmeros , -,*, $,
/, +, %, etc.
Es ti l o de cdi go de ba rra s ANSI
es tendi do 3 de 9 (Cdi go es tendi do 39).
Uti l i ze ca ra cteres compl etos ASCII.
Es ti l o de cdi go de ba rra s 2 de 5. Uti l i ze
s omente nmeros .
Es ti l o de cdi go de ba rra s i nterca l a do 2
de 5. Uti l i ze s omente nmeros .
Es ti l o de cdi go de ba rra s Ma tri z 25.
Es ti l o de cdi go de ba rra s Cdi go 39,
uti l i ze l etra s , nmeros , -,*, $, /, +, %, etc.
Es ti l o de cdi go de ba rra s Cdi go 39
es tendi do. Uti l i ze ca ra cteres compl etos
ASCII.
Es ti l o de cdi go de ba rra s 128 A. Uti l i ze
nmeros , pontua es , ou l etra s .
Es ti l o de cdi go de ba rra s 128 B. Uti l i ze
s tri ngs , nmeros , pontua es , ou l etra s .
Es ti l o de cdi go de ba rra s 128 C. Uti l i ze
s omente nmeros .
Es ti l o de cdi go de ba rra s 128
Autom ti co. Uti l i ze ca ra cteres compl etos
ASCII. Sel eci ona a utoma ti ca mente
cdi gos entre 128 A, B e C pa ra s eta r no
cdi go de ba rra s o va l or menor.
Es ti l o de cdi go de ba rra s Cdi go 93.
Uti l i ze l etra s , nmeros , -,*,$, /,+,%, etc.
Es ti l o de cdi go de ba rra s Cdi go 93
es tendi do. Uti l i ze ca ra cteres compl etos
ASCII.
Es ti l o de cdi go de ba rra s Cdi go MSI.
Uti l i ze s omente nmeros .

Visualizao

OPO
15 - ddbcPostNet

16 - ddbcCodabar
17 - ddbcEAN_8

18 - ddbcEAN_13
19 - ddbcUPC_A
20 - ddbcUPC_EO

21 - ddbcUPC_E1

22 - ddbcRM4SCC

23 - ddbcUCCEAN128

DESCRIO
Es ti l o de cdi go de ba rra s Pos tNet.
Uti l i ze s omente nmeros com uma
veri fi ca o di gi ta l .
Es ti l o de cdi go de ba rra s . Uti l i ze A, B, C,
D, +, -, :, /, ou nmeros .
Es ti l o de cdi go de ba rra s EAN-8. Uti l i ze
s omente nmeros (7 nmeros e
veri fi ca o di gi ta l ).
Es ti l o de cdi go de ba rra s EAN-13. Uti l i ze
s omente nmeros (12 nmeros e
veri fi ca o di gi ta l ).
Es ti l o de cdi go de ba rra s UPC-A. Uti l i ze
s omente nmeros (11 nmeros e
veri fi ca o di gi ta l ).
Es ti l o de cdi go de ba rra s UPC-E1. Uti l i ze
s omente nmeros . Us a do pa ra s mbol os
de compres s o-zero UPC. Na
propri eda de Caption, pode-s e entra r com
6 dgi tos do cdi go UPC-E ou com 11
dgi tos . Se um cdi go com 11 dgi tos
i ns eri do, o cdi go de ba rra s converte
pa ra 6 dgi tos UPC-E, s e pos s vel . Sen o,
converte-s e de 11 pa ra 6 dgi tos UPC-E e
na da mos tra do.
Es ti l o de cdi go de ba rra s UPC-E1. Uti l i ze
s omente nmeros . A l a rgura da entra da
de da dos do UPC E1 de 6 ca ra cteres
numri cos .
Es ti l o de cdi go de ba rra s Roya l Ma i l
RM4SCC. Uti l i ze s omente l etra s e
nmeros (com veri fi ca o di gi ta l ). Es te
cdi go de ba rra s uti l i za do no Rei no
Uni do.
Es ti l o de cdi go de ba rra s UCC/EAN_128.
Uti l i ze ca ra cteres compl etos ASCII. A
vers o es peci a l do cdi go 128 us a do
na a pl i ca o HIBC.

4.8.6.3 Elipse, Retngulo e Retngulo Arredondado


Esta seo contm informaes sobre propriedades dos objetos Elipse, Retngulo e
Retngulo Arredondado do Relatrio. Estes objetos no possuem eventos nem
mtodos associados.

4.8.6.3.1 Propriedades
Esta seo contm informaes sobre as propriedades dos objetos Elipse,
Retngulo e Retngulo Arredondado do Relatrio.
Visualizao

327

4.8.6.3.1.1 LineColor
Especifica a cor da linha do objeto. O valor padro desta propriedade preto
(RGB(0, 0, 0)).
4.8.6.3.1.2 LineStyle
Determina o estilo da linha do objeto. As opes disponveis desta propriedade
so as seguintes:
Opes disponveis para LineStyle
OPO
0 - ddLSTransparent
1 - ddLSSolid
2 - ddLSDash
3 - ddLSDot
4 - ddLSDashDot
5 - ddLSDashDotDot

DESCRIO
A l i nha do objeto fi ca tra ns pa rente.
A l i nha do objeto a pa rece s l i da .
A l i nha do objeto fi ca tra ceja da .
A l i nha do objeto fi ca ponti l ha da .
A l i nha do objeto fi ca tra ceja da .
A l i nha do objeto fi ca ponti l ha da ,
tra ceja da e ponti l ha da .

O valor padro desta propriedade 1 - ddLSSolid.


4.8.6.3.1.3 LineWeight
Especifica a largura da linha do objeto. Configurando a largura para 1, a linha do
objeto expandida em at 15 pontos, se for 2, a linha expandida em at 30 pontos
e assim por diante. Quanto maior o nmero configurado na propriedade, maior a
largura do objeto. O valor padro desta propriedade 1.
4.8.6.3.1.4 Shape
Permite alterar a forma do objeto. As opes disponveis so as seguintes:
Opes disponveis para Shape
OPO
0 - ddSHRectangle
1 - ddSHEllipse
2 - ddSHRoundRect

DESCRIO
Forma to reta ngul a r.
Forma to el pti co ou ci rcul a r.
Forma to de ret ngul o a rredonda do.

4.8.6.4 Figura
Esta seo contm informaes sobre propriedades do objeto Figura do Relatrio.
Este objeto no possui eventos nem mtodos associados.
328

Visualizao

4.8.6.4.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Figura do
Relatrio.
4.8.6.4.1.1 DataField
Configura ou retorna o dado associado ao objeto. Este dado associado pode ser
um campo da tabela no Banco de Dados fornecido pelo objeto Consulta; uma
expresso matemtica com campos da Consulta e funes do VBScript (neste caso,
o campo deve ser precedido do smbolo de igual); ou um Tag ou propriedade do E3.
Neste caso o valor atual da varivel ser mostrado ao realizar a impresso. O
valor padro desta propriedade uma String vazia.
NOTA: O s ervi dor deve es ta r s endo executa do pa ra que o va l or da va ri vel pos s a s er
ca ptura do.

4.8.6.4.1.2 Forecolor
Especifica a cor do preenchimento do fundo do objeto. Nos scripts, utilize a
funo do VBScript RGB para formar a cor a ser associada a esta propriedade. O
valor padro desta propriedade preto (RGB(0, 0, 0)).
4.8.6.4.1.3 hyperLink
Especifica o link atribudo ao texto. Para utilizar este recurso, use o evento
OnHyperLink. O valor padro desta propriedade uma String vazia.
4.8.6.4.1.4 LineColor
Especifica a cor da linha do objeto. O valor padro desta propriedade preto
(RGB(0, 0, 0)).
4.8.6.4.1.5 LineStyle
Determina o estilo da linha do objeto. As opes disponveis desta propriedade
so as seguintes:
Opes disponveis para LineStyle
OPO
0 - ddLSTransparent
1 - ddLSSolid
2 - ddLSDash
3 - ddLSDot

Visualizao

A l i nha
A l i nha
A l i nha
A l i nha

DESCRIO
fi ca tra ns pa rente no objeto.
a pa rece s l i da no objeto.
fi ca tra ceja da no objeto.
fi ca ponti l ha da no objeto.

329

OPO

DESCRIO
A l i nha fi ca tra ceja da e ponti l ha da no
objeto.
A l i nha fi ca ponti l ha da , tra ceja da e
ponti l ha da no objeto.

4 - ddLSDashDot
5 - ddLSDashDotDot

O valor padro desta propriedade 1 - ddLSSolid.


4.8.6.4.1.6 LineWeight
Especifica a largura da linha do objeto. Configurando a lagura para 1, a linha do
objeto expandida em at 15 pontos, e assim por diante. Quanto maior o nmero
configurado na propriedade, maior a largura do objeto. O valor padro desta
propriedade 1.
4.8.6.4.1.7 Picture
Especifica o arquivo de figura para o objeto. As extenses permitidas so
.bmp, .gif, .jpg, .cur, .ico, .emf e .wmf. O valor padro desta propriedade uma String
vazia.
4.8.6.4.1.8 PictureAlignment
Determina o alinhamento da figura no objeto. As opes disponveis so as
seguintes:
Opes disponveis para PictureAlignment
OPO
0 - ddPATopLeft
1 - ddPATopRight
2 - ddPACenter
3 - ddPABottomLeft
4 - ddPABottomRight

Al i nha a
objeto.
Al i nha a
Al i nha a
Al i nha a
Al i nha a

DESCRIO
fi gura no topo es querdo do
fi gura
fi gura
fi gura
fi gura

no topo di rei to do objeto.


no centro do objeto.
es querda do objeto.
di rei ta do objeto.

O valor padro desta propriedade 2 - ddPACenter.


4.8.6.4.1.9 SizeMode
Especifica o tamanho do objeto. As opes disponveis so as seguintes:
Opes disponveis para SizeMode
OPO
0 - ddsMClip

330

DESCRIO
Mos tra o objeto no s eu ta ma nho a tua l .

Visualizao

OPO
1 - ddsMStretch
2 - ddsMZoom

DESCRIO
Ajus ta o objeto de a cordo com a s ua
rea .
Ajus ta a a l tura ou a l a rgura da i ma gem
do objeto dentro da rea es peci fi ca da ,
s em di s torc-l a .

4.8.6.5 SetPoint
Esta seo contm informaes sobre propriedades do objeto SetPoint do Relatrio.
Este objeto no possui eventos nem mtodos associados.

4.8.6.5.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto SetPoint do
Relatrio.
4.8.6.5.1.1 Alignment
Determina o alinhamento do texto no objeto. As opes disponveis para esta
propriedade so:
0 - Left: alinhamento esquerda (padro)
1 - Right: alinhamento direita
2 - Center: alinhamento centralizado
4.8.6.5.1.2 CanGrow
Determina a aplicao do efeito de stretch ao texto do objeto. Caso a largura ou
altura do objeto sejam aumentadas, o texto acompanha esta variao. Se a
propriedade estiver configurada para True, o texto acompanha as variaes de
altura e largura do objeto. Caso contrrio, este permanece com as configuraes
iniciais. O valor padro desta propriedade True.
4.8.6.5.1.3 CanShrink
Determina a aplicao do efeito de encolhimento ao texto do objeto. Caso a
largura ou altura do objeto sejam diminudas, o texto acompanha esta variao. Se
a propriedade estiver configurada para True, o texto acompanha as variaes de
altura e largura do objeto. Caso contrrio, este permanece com as configuraes
iniciais. O valor padro desta propriedade True.
4.8.6.5.1.4 ClassName
Retorna a classe do objeto. Esta propriedade somente de leitura.
Visualizao

331

4.8.6.5.1.5 DataField
Configura ou retorna o dado associado ao objeto. Este dado associado pode ser
um campo da tabela no Banco de Dados fornecido pelo objeto Consulta; uma
expresso matemtica com campos da Consulta e funes do VBScript (neste caso,
o campo deve ser precedido do smbolo de igual); ou um Tag ou propriedade do E3.
Neste caso o valor atual da varivel ser mostrado ao realizar a impresso. O
valor padro desta propriedade vazio.
NOTA: O s ervi dor deve es ta r s endo executa do pa ra que o va l or da va ri vel pos s a s er
ca ptura do.

4.8.6.5.1.6 Font
Esta propriedade determina a fonte do texto no objeto. O valor padro desta
propriedade uma String vazia. Esta propriedade no pode ser utilizada em scripts
ou em Associaes e configurada somente via Studio.
4.8.6.5.1.7 ForeColor
A propriedade ForeColor especifica a cor de fundo do objeto. Nos scripts, utilize
a funo do VBScript RGB para montar a cor a ser associada a esta propriedade. O
valor padro desta propriedade preto (RGB(0, 0, 0)).
4.8.6.5.1.8 hyperLink
A propriedade hyperLink determina o link que ser atribudo ao texto. Para
utilizar este recurso, use o evento OnHyperLink.
4.8.6.5.1.9 Multiline
A propriedade Multiline indica se o texto ter mltiplas linhas (True) ou se ser
uma caixa de texto simples (False). Isto pode ser visualizado quando o objeto
Viewer est em execuo. O valor padro desta propriedade False.
4.8.6.5.1.10 OutputFormat
Configura ou retorna a formatao do texto da propriedade Text, utilizado nas
configuraes das funes de formatao (FormatCurrency, FormatDateTime,
FormatNumber e FormatPercent) do Visual Basic.
4.8.6.5.1.11 Style
Retorna o estilo do texto configurado no objeto. Esta propriedade somente de
leitura.
332

Visualizao

4.8.6.5.1.12 SummaryDistinctField
Determina o nome do campo que ser usado pela funo selecionada na
propriedade SummaryFunc. Esta propriedade s vlida se a funo definida em
SummaryFunc for do grupo de funes Distinct Summary, o qual abrange as funes
de nmeros 9 at 15, e quando a propriedade SummaryType tem valor diferente de
0.
4.8.6.5.1.13 SummaryFunc
Determina o tipo de funo que ser usada para processar os valores do campo
especificado na propriedade DataField, como listado na tabela a seguir. Esta
propriedade s vlida quando a propriedade SummaryType tem valor diferente de
0.
Opes disponveis para SummaryFunc
OPO
0 - Sum

1 - Avg

2 - Count
3 - Min

4 - Max

5 - Var
6 - VarP

7 - Dev

Visualizao

DESCRIO
Ca l cul a a s oma de todos os va l ores
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a a mdi a de todos os va l ores
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Conta o nmero de va l ores dentro do
i nterva l o de tota i s es peci fi ca do (grupo,
p gi na ou Rel a tri o).
Mos tra o menor va l or (va l or mni mo)
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Mos tra o ma i or va l or (va l or m xi mo)
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a a va ri nci a dos va l ores dentro do
i nterva l o de tota i s es peci fi ca do (grupo,
p gi na ou Rel a tri o).
Ca l cul a a va ri nci a popul a ci ona l dos
va l ores dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a o des vi o pa dr o dos va l ores
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).

333

OPO
8 - DevP

9 - DSum

10 - DAvg

11 - DCount

12 - DVar

13 - DVarP

14 - DDev

15 - DDevP

DESCRIO
Ca l cul a o des vi o pa dr o popul a ci ona l
dos va l ores dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a a s oma de todos os va l ores
di s ti ntos dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a a mdi a ba s ea da nos va l ores
di s ti ntos dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
rel a tri o).
Conta o nmero dos va l ores di s ti ntos
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a a va ri nci a dos va l ores di s ti ntos
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a a va ri nci a popul a ci ona l dos
va l ores di s ti ntos dentro do i nterva l o de
tota i s es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a o des vi o pa dr o dos va l ores
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, p gi na ou
Rel a tri o).
Ca l cul a o des vi o pa dr o popul a ci ona l
dos va l ores di s ti ntos dentro do i nterva l o
de tota i s es peci fi ca do (grupo, p gi na ou
Rel a tri o).

4.8.6.5.1.14 SummaryGroup
Esta propriedade s vlida quando a propriedade SummaryType for igual a 3 SubTotal. SummaryGroup indica qual o nome da seo GroupHeader que ser
usada para controlar os subtotais, ou seja, a cada mudana de valor no
GroupHeader, o somatrio reiniciado.
NOTA: Qua ndo es ta propri eda de uti l i za da , a s propri eda des CanShrink e CanGrow
fi ca m des a bi l i ta da s .

4.8.6.5.1.15 SummaryRunning
Determina se ser feito o total de somatrios acumulados, de acordo com as
opes:
334

Visualizao

0 - None: no faz o total


1 - Group: calcula os totais acumulados para cada intervalo de totais
especificado
2 - All: calcula o total acumulado para todos os valores do relatrio,
independente do agrupamento.
Esta propriedade s vlida quando a propriedade SummaryType tem valor
diferente de 0.
4.8.6.5.1.16 SummaryType
Determina o tipo ou nvel de totalizao a ser gerada. As opes disponveis so
as seguintes:
Opes disponveis para SummaryType
OPO
0 - None
1 - GrandTotal
2 - PageTotal
3 - SubTotal
4 - PageCount

DESCRIO
Sem gera o de s oma tri o.
Es peci fi ca que s er tota l i za do todo o
contedo do Rel a tri o.
Es peci fi ca que s er gera do um s ubtota l
por p gi na .
Es peci fi ca que s er gera do um s ubtota l
pa ra ca da grupo, defi ni do na
propri eda de SummaryGroup.
Es peci fi ca o conta dor de p gi na .

4.8.6.5.1.17 Text
Determina o texto que ser atribudo ao objeto.
4.8.6.5.1.18 VerticalAlignment
Determina o alinhamento vertical do objeto, a saber:
0 - Top: alinhamento pelo topo
1 - Middle: alinhamento ao centro
2 - Bottom: alinhamento pela base
4.8.6.5.1.19 WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a True. Se for
False, a configurao white-space:nowrap ir aparecer na propriedade Style.
Visualizao

335

4.8.6.6 Texto
Esta seo contm informaes sobre propriedades do objeto Texto do Relatrio.
Este objeto no possui eventos nem mtodos associados.

4.8.6.6.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Texto do Relatrio.
4.8.6.6.1.1 Alignment
A propriedade Alignment determina o alinhamento do texto, a saber:
0 - ddtxLeft: alinhamento esquerda
1 - ddtxRight: alinhamento direita
2 - ddtxCenter: alinhamento centralizado (valor padro)
4.8.6.6.1.2 Angle
A propriedade Angle indica o ngulo do texto. O valor da propriedade deve ser
especificado em dcimos de graus, ou seja, para que o texto seja mostrado em um
ngulo de 45 graus, o valor deve ser igual 450. O valor padro desta propriedade
0 (posicionamento horizontal).
4.8.6.6.1.3 Caption
A propriedade Caption contm o texto do objeto propriamente dito. O valor
padro desta propriedade uma String vazia.
4.8.6.6.1.4 ClassName
A propriedade ClassName permite especificar uma classe CSS global (indicada em
uma folha de estilos CSS externa) a ser aplicada ao texto. Uma classe CSS
(Cascading Style Sheet) um padro de formatao que determina tipo e tamanho
de letra ou alinhamento e espaamento do pargrafo, entre outras caractersticas.
Atravs de CSS, pode-se aplicar um padro de formatao pr-definido a um texto,
agilizando e unificando a apresentao dos textos. Para aplicar um estilo
especfico, pode-se utilizar a propriedade Style. O valor padro dessa propriedade
o estilo Normal.
4.8.6.6.1.5 Font
Esta propriedade indica o nome da fonte (tipo das letras) do texto. O valor
padro desta propriedade uma String vazia (o E3 ir usar o padro do sistema).
336

Visualizao

NOTA: Es ta propri eda de n o pode s er uti l i za da em s cri pts ou As s oci a es ,


confi gura da s omente vi a Studi o e s pode s er modi fi ca da em tempo de
confi gura o.

4.8.6.6.1.6 ForeColor
A propriedade Forecolor especifica a cor de preenchimento do fundo do objeto.
Nos scripts, utilize a funo RGB do VBScript para montar a cor a ser associada a
esta propriedade. O valor padro desta propriedade preto (RGB(0, 0, 0)).
4.8.6.6.1.7 hyperLink
A propriedade hyperLink determina um link que ser atribudo ao objeto. Para
utilizar este recurso, use o evento OnHyperLink. O valor padro desta propriedade
uma String vazia.
4.8.6.6.1.8 Multiline
A propriedade Multiline indica se o texto ter mltiplas linhas (True) ou se ser
uma caixa de texto simples (False). Isto pode ser visualizado quando o objeto
Viewer est em execuo. O valor padro desta propriedade False.
4.8.6.6.1.9 Style
A propriedade Style permite especificar um estilo CSS (Cascading Style Sheet) para
o texto, em substituio ao estilo global. O valor da propriedade deve ser uma
String CSS vlida, caso contrrio a propriedade ser ignorada. O valor padro
desta propriedade uma String vazia (o E3 ir usar o padro do sistema). Exemplo:
Sub Report1_OnBeforePrint
Label1.Style = "font-family: Times; font-weight: bold;_
text-align: center; color: RGB(255, 255, 0)"
End Sub

4.8.6.6.1.10 VerticalAlignment
A propriedade VerticalAlignment determina o alinhamento vertical do texto, a
saber:
0 - ddTxTop: alinhamento pelo topo (padro)
1 - ddTxMiddle: alinhamento centralizado
2 - ddTxBottom: alinhamento pela base
4.8.6.6.1.11 WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a rea disponvel para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
Visualizao

337

funcione, a propriedade Multiline deve ser obrigatoriamente igual a True.

4.8.6.7 Linha
Esta seo contm informaes sobre propriedades do objeto Linha do Relatrio.
Este objeto no possui eventos nem mtodos associados.

4.8.6.7.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Linha do
Relatrio.
4.8.6.7.1.1 LineColor
A propriedade LineColor especifica a cor da linha do objeto O valor padro desta
propriedade preto (RGB(0, 0, 0)).
4.8.6.7.1.2 LineStyle
Esta propriedade determina o estilo da linha do objeto. O valor padro desta
propriedade 1 - ddLSSolid. As outras opes disponveis desta propriedade so as
seguintes:
Opes disponveis para LineStyle
OPO
0 - ddLSTransparent
1 - ddLSSolid
2 - ddLSDash
3 - ddLSDot
4 - ddLSDashDot
5 - ddLSDashDotDot

DESCRIO
A l i nha fi ca tra ns pa rente no objeto.
A l i nha a pa rece s l i da no objeto.
A l i nha fi ca tra ceja da no objeto.
A l i nha fi ca ponti l ha da no objeto.
A l i nha fi ca tra ceja da e ponti l ha da no
objeto.
A l i nha fi ca ponti l ha da , tra ceja da e
ponti l ha da no objeto.

4.8.6.7.1.3 LineWeight
A propriedade LineWeight especifica a largura da linha do objeto. Configurando a
largura para 1, a linha do objeto expandida em at 15 pontos, se a largura for 2, a
linha do objeto expandida em at 30 pontos, e assim por diante. Quanto maior o
nmero configurado na propriedade, maior a largura do objeto. O valor padro
desta propriedade 1.
4.8.6.7.1.4 X1
A propriedade X1 habilita ou desabilita a posio do ponto inicial da linha no
eixo X.
338

Visualizao

4.8.6.7.1.5 X2
A propriedade X2 determina a posio do ponto final da linha no eixo X. O valor
padro desta propriedade vazio.
4.8.6.7.1.6 Y1
A propriedade Y1 determina a posio do ponto inicial da linha no eixo Y. O valor
padro desta propriedade vazio.
4.8.6.7.1.7 Y2
A propriedade Y2 determina a posio do ponto final da linha no eixo Y. O valor
padro desta propriedade vazio.

4.8.6.8 Quebra de Pgina


Esta seo contm informaes sobre propriedades do objeto Quebra de Pgina do
Relatrio. Este objeto no possui eventos nem mtodos associados.

4.8.6.8.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Quebra de Pgina
do Relatrio.
4.8.6.8.1.1 Enabled
A propriedade Enabled habilita ou desabilita o objeto no Relatrio. Se a opo
estiver configurada para True, o objeto habilitado no Relatrio. Caso contrrio, o
objeto fica desabilitado. O valor padro desta propriedade True.

4.8.6.9 Tabela
Esta seo contm informaes sobre propriedades do objeto Tabela do Relatrio.
Este objeto no possui eventos nem mtodos associados.

4.8.6.9.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Tabela do
Relatrio.
4.8.6.9.1.1 CanGrow
Determina a aplicao do efeito de stretch ao texto do objeto. Caso a largura ou
altura do objeto sejam aumentadas, o texto acompanha esta variao. Se a
propriedade estiver configurada para True, o texto acompanha as variaes de
Visualizao

339

altura e largura do objeto. Caso contrrio, este permanece com as configuraes


iniciais. O valor padro desta propriedade True.
4.8.6.9.1.2 CanShrink
Determina a aplicao do efeito de encolhimento ao texto do objeto. Caso a
largura ou altura do objeto sejam diminudas, o texto acompanha esta variao. Se
a propriedade estiver configurada para True, o texto acompanha as variaes de
altura e largura do objeto. Caso contrrio, este permanece com as configuraes
iniciais. O valor padro desta propriedade True.
4.8.6.9.1.3 CloseBorder
Esta propriedade habilita ou desabilita a visualizao da linha da borda da base
da tabela, caso a mesma ultrapasse mais de uma pgina no Relatrio.
4.8.6.9.1.4 left
A propriedade left retorna o valor do posicionamento esquerdo do objeto no
Relatrio. O valor padro desta propriedade vazio.

4.8.6.10 E3Chart
Esta seo contm informaes sobre propriedades do objeto E3Chart do Relatrio.

4.8.6.10.1 Propriedades
Exemplo de utilizao das propriedades do E3Chart em um Relatrio
Os scripts abaixo devem ser criados na seo PageHeader do Relatrio, utilizando
o evento OnBeforePrint. Exemplos:
Sub OnBeforePrint
' Usando um E3Chart em um relatrio
Set chart = _
Report.Sections("PageHeader").Controls("E3Chart1")
chart.LoadData()
chart.FitAll
End Sub
Sub OnBeforePrint
' Este script faz a cpia das configuraes do objeto
' E3Chart chartfrom para o E3Chart chart
' que ser utilizado no relatrio.
Set chartfrom = _
Application.GetFrame().Screen.Item("E3Chart1")
Set chart = _
Report.Sections("PageHeader").Controls("E3Chart2")
chart.CopyConfig(chartfrom)

340

Visualizao

chart.LoadData()
chart.FitAll
End Sub
NOTA: A des cri o da s propri eda des do E3Cha rt no Rel a tri o s o a s mes ma s
expl i ca da s no tpi co Propriedades do E3Cha rt.

Visualizao

341

CAPTULO

Objetos de Servidor

Esta seo contm informaes sobre as propriedades comuns aos objetos de


Servidor. Estes objetos no possuem eventos nem mtodos comuns. Os objetos que
compartilham propriedades de Servidor so os seguintes:
Objetos em Tempo de Execuo do Servidor
Objetos em Tempo de Configurao
Drivers
Servidor de Dados
Banco de Dados
Histricos
Storage
Frmulas
Alarmes

5.1 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns a todos os objetos
de Servidor.

5.1.1 IsAlarmArea
Habilita ou desabilita a funcionalidade de rea de Alarme para os objetos de
Servidor. Esta propriedade no est disponvel nos objetos rea de Alarme, Fonte de
Alarme e Servidor de Alarmes. O valor padro desta propriedade Falso. Ao
habilitar esta propriedade, o objeto passar a contar com as mesmas propriedades
de uma rea de Alarme.

5.1.2 Propriedades Comuns a Objetos de Servidor como


reas de Alarme
Esta seo contm informaes sobre propriedades comuns a objetos de servidor
que se comportam como reas de Alarme.

342

Objetos de Servidor

5.1.2.1 ActiveAlarms
Determina o nmero de alarmes ativos dentro do objeto. Esta propriedade
somente de leitura e seu valor padro 0 (zero).

5.1.2.2 ActiveHighAlarms
Indica o nmero de alarmes ativos com severidade alta. Esta propriedade
somente de leitura.

5.1.2.3 ActiveHighNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade alta. Esta
propriedade somente de leitura.

5.1.2.4 ActiveLowAlarms
Indica o nmero de alarmes ativos com severidade baixa. Esta propriedade
somente de leitura.

5.1.2.5 ActiveLowNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade baixa. Esta
propriedade somente de leitura.

5.1.2.6 ActiveMedAlarms
Indica o nmero de alarmes ativos com severidade mdia. Esta propriedade
somente de leitura.

5.1.2.7 ActiveMedNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade mdia. Esta
propriedade somente de leitura.

5.1.2.8 ActiveNACKAlarms
Indica o nmero de alarmes que esto sem reconhecimento dentro da rea. Esta
propriedade somente de leitura.

5.1.2.9 Alarm
Estabelece a existncia de alarmes ativos dentro do objeto. Se a opo estiver em
True, existe pelo menos um alarme ativo dentro do objeto, e a propriedade
ActiveAlarms far a leitura no servidor, indicando a quantidade de alarme ativos.
Caso contrrio, a propriedade ActiveNACKAlarms far a leitura dos alarmes sem
Objetos de Servidor

343

reconhecimento. Esta propriedade somente de leitura.

5.1.2.10 AlarmVerify
Habilita a verificao de todos os alarmes dentro do objeto. Depois de habilitada
esta verificao (True), se a propriedade ActiveAlarms possuir valor maior que 0
(zero), o servidor verifica tanto os alarmes ativos quanto os sem reconhecimento,
listando estes ltimos pela propriedade ActiveNACKAlarms. Esta propriedade til
para evitar-se o efeito de avalanche de alguns sistemas, onde o acontecimento de
um evento gera uma grande quantidade de alarmes correlacionados.

5.1.2.11 InactiveHighNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade alta.
Esta propriedade somente de leitura.

5.1.2.12 InactiveLowNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade baixa.
Esta propriedade somente de leitura.

5.1.2.13 InactiveMedNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade mdia.
Esta propriedade somente de leitura.

5.1.2.14 InactiveNACKAlarms
Determina o nmero total de alarmes inativos e no reconhecidos. Esta
propriedade somente de leitura.

5.1.2.15 UserFields
Retorna um objeto que uma coleo de Campos de Usurio de Alarmes de um
objeto de Servidor. Veja o item Coleo de Campos de Usurio de Alarmes para
maiores informaes sobre a coleo de objetos retornados por esta propriedade.

5.2 Coleo de Campos de Usurio de Alarmes


Esta seo contm informaes sobre mtodos e propriedades comuns coleo
de Campos de Usurio de Alarmes de objetos de Servidor do E3, retornada pela
propriedade UserFields de reas de Alarme e Fontes de Alarme.

344

Objetos de Servidor

5.2.1 Mtodos Comuns


Esta seo contm informaes sobre os mtodos comuns coleo de Campos de
Usurio de Alarmes de objetos de Servidor do E3.

5.2.1.1 Item
Item(Index)
Retorna um objeto Campo de Usurio de Alarmes indicado pelo parmetro Index,
que pode ser o valor da propriedade Index (inteiro) ou o valor da propriedade
Name (texto) do objeto.

5.2.2 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns coleo de
Campos de Usurio de Alarmes de objetos de Servidor do E3.

5.2.2.1 Count
Retorna o nmero de objetos filhos (itens) de uma coleo de Campos de Usurio
de Alarmes. Se a Coleo no contm objetos filhos, esta propriedade retorna o
valor 0 (zero).

5.2.3 Campo de Usurio de Alarmes


Esta seo contm informaes sobre as propriedades dos objetos do tipo Campo
de Usurio de Alarmes contidos na Coleo de Campos de Usurio de Alarmes
retornada pela propriedade UserFields de reas de Alarme, Fontes de Alarme e de
Objetos de Servidor com comportamento de rea de Alarme. Este objeto no possui
eventos nem mtodos associados.

5.2.3.1 Propriedades
Esta seo contm informaes sobre as propriedades dos objetos do tipo Campo
de Usurio de Alarmes contidos na coleo de Campos de Usurio de Alarmes.

5.2.3.1.1 Index
Retorna o ndice deste objeto na Coleo de Campos de Usurio de Alarmes. Este
valor pode ser utilizado como parmetro para o mtodo Item da Coleo.

5.2.3.1.2 Link
Retorna ou modifica a Associao configurada para este Campo de Usurio de
Alarmes. Para alterar em tempo de execuo a Associao configurada nesta
Objetos de Servidor

345

propriedade, deve-se desativar o objeto. Por exemplo:


Dim sAlarm
Set sAlarm = _
Application.GetObject("ConfigAlarms.Area.DigitalAlarm1")
sAlarm.Deactivate()
sAlarm.UserFields.Item("BatchName").Link = _
"Driver.TagBatchName.Value"
sAlarm.Activate()

5.2.3.1.3 Name
Retorna o nome deste objeto na Coleo de Campos de Usurio de Alarmes. Este
valor pode ser utilizado como parmetro para o mtodo Item da Coleo.

5.2.3.1.4 Value
Retorna ou configura o valor atual do Campo de Usurio de Alarmes. Esta
propriedade tem um comportamento diferenciado dependendo se o objeto est
ativo ou inativo. Com o objeto ativo, o valor retornado na leitura desta propriedade
obedece seguinte lista de prioridades:
1. Se h um valor forado (propriedade ValueSource igual a evsForcedValue),
retorna este valor
2. Se h uma Associao configurada (propriedade ValueSource igual a evsLink),
retorna o valor atual da Associao
3. Busca o valor deste Campo de Usurio na rea hierarquicamente superior
(percorre a hierarquia de reas em sentido ascendente)
4. Se no h nenhuma rea hierarquicamente superior que tenha um valor
forado ou uma Associao configurada para este Campo de Usurio, recupera
o valor padro do Campo de Usurio configurado no Servidor de Alarmes
Se o objeto estiver inativo, a leitura desta propriedade retorna o valor forado,
caso exista (propriedade ValueSource igual a evsForcedValue). Se no h um valor
forado, a leitura da propriedade falha.
O comportamento das escritas nesta propriedade o mesmo, tanto com o objeto
ativo como inativo. A escrita falha caso haja uma Associao configurada
(propriedade ValueSource igual a evsLink). Caso contrrio, o novo valor aceito e a
propriedade ValueSource automaticamente configurada para evsForcedValue.

5.2.3.1.5 ValueSource
Especifica a fonte da propriedade Value deste Campo de Usurio de Alarmes. Os
valores possveis para esta propriedade so os seguintes:
0 - evsInherited: A propriedade Value herdada do Servidor de Alarmes ou da
346

Objetos de Servidor

rea superior (valor padro)


1 - evsLink: A propriedade Value fornecida pela propriedade Link
2 - evsForcedValue: A propriedade Value fornecida pelo usurio
Esta propriedade aceita escritas tanto com o objeto ativo como inativo. Em ambos
os casos, no possvel escrever o valor evsLink. Para trocar a propriedade
ValueSource para o valor evsLink, deve-se escrever diretamente na propriedade Link
(desativando o objeto se estiver em tempo de execuo).
NOTA: Ao exporta r um objeto Ca mpo de Us u ri o de Al a rmes , a propri eda de
ValueSource deve s er col oca da a ps a s propri eda des Link e Value na ordem da s
col una s .

5.3 Objetos em Tempo de Execuo do Servidor


Esta seo contm informaes sobre objetos que s podem ser utilizados em
tempo de execuo, o Servidor (Application) e as Pastas de Aplicativo.

5.3.1 Servidor
Esta seo contm informaes sobre mtodos especficos do objeto Server
(Application). Este objeto possui os mtodos gerais Item e Save, alm das
propriedades Name e Count, descritos na seo Eventos, Mtodos e Propriedades
Gerais dos Objetos. O objeto no possui eventos associados.

5.3.1.1 Mtodos
Esta seo contm informaes sobre os mtodos especficos do objeto Servidor.
NOTA: Os mtodos a qui des cri tos s podem s er uti l i za dos em tempo de execu o,
n o es ta ndo di s ponvei s no Studi o.

5.3.1.1.1 ClearFailure
ClearFailure(FailureName)
Este mtodo deve ser chamado para indicar que uma falha reportada por
ReportFailure no est mais ativa. O parmetro FailureName contm o nome da
falha (definido pelo usurio) e deve ser passado para o mtodo ReportFailure,
quando de sua chamada.

Objetos de Servidor

347

5.3.1.1.2 E3GetActor
E3GetActor()
Este mtodo retorna o nome de logon do usurio que iniciou a requisio atual no
E3Run. Se o E3Run no estiver atualmente tratando uma operao gerada por outro
processo, retorna a String "System". Se no houver nenhum usurio logado no
processo que gerou a requisio atual, retorna a String "Anonymous".

5.3.1.1.3 LoadReport
LoadReport(ReportName)
Carrega um modelo de Relatrio. Veja o mtodo LoadReport do objeto Viewer para
um exemplo de uso.
NOTA: O mtodo PrintPreview do objeto Rel a tri o n o es t di s ponvel em Rel a tri os
ca rrega dos uti l i za ndo es te mtodo.

5.3.1.1.4 ReportFailure
ReportFailure(FailureName, FailureDescription, FailureWeight)
Este mtodo permite que o aplicativo reporte falhas para o Servidor, que podem ser
visualizadas clicando com o boto direito sobre o cone do E3 na rea de
Notificao. Quando o mtodo usado, o cone do E3 na rea de Notificao
comea a piscar em vermelho, indicando a ocorrncia da falha. As falhas
reportadas so normalmente condies que impedem que o aplicativo funcione
parcialmente (problema de comunicao em uma porta serial, link de rede inativo,
banco de dados sem conexo, etc.), e que normalmente no podem ser detectadas
pelo Servidor. Este mtodo tem duas finalidades:
Avisar o operador do sistema a respeito de problemas em um servidor
Auxiliar o gerenciador automtico de hot-standby a decidir qual servidor est
mais apto para executar o aplicativo
NOTA: O mtodo ReportFailure s es t di s ponvel no Servi dor.

O mtodo ReportFailure possui os seguintes parmetros:

348

Objetos de Servidor

Parmetros do mtodo ReportFailure


NOME
FailureName

FailureDescription

FailureWeight

DESCRIO
Contm o nome da fa l ha (defi ni do pel o
us u ri o). Es te mes mo pa r metro deve
s er pa s s a do pa ra o mtodo ClearFailure
qua ndo o a pl i ca ti vo detecta r que a fa l ha
n o es t ma i s a ti va . Por exempl o, "Fa l ha
COM1".
Des cri o textua l da fa l ha (defi ni da pel o
us u ri o). Por exempl o, "Fa l ha de
comuni ca o na porta COM1".
Defi ne a s everi da de (ou pes o) da fa l ha .
O va l or 0 i ndi ca um a vi s o (s em
gra vi da de). Va l ores ma i ores que zero
i ndi ca m fa l ha s . Qua nto ma i or o va l or,
ma i s gra ve a fa l ha .

Exemplo:
Sub TagEstadoSerial_OnValueChanged()
If Value then
' O valor do tag TRUE, indica que est em falha
Application.ReportFailure "FALHA_COM1", "Falha de "_
& "comunicao na COM1", 100
Else
' O valor do tag FALSE, limpa a falha
' (indica que est OK)
Application.ClearFailure "FALHA_COM1"
End If
End Sub

5.3.1.1.5 Trace
Trace(MessageText[, LogTimeStamp[, BreakLine]])
Este mtodo permite registrar mensagens em um arquivo texto. As mensagens so
gravadas em um arquivo com o mesmo nome e caminho do arquivo de Domnio,
com a extenso .txt. Por exemplo, se a aplicao de Domnio for c:\teste.dom, as
mensagens sero registradas no arquivo c:\teste.txt. Cada nova mensagem
adicionada sempre no final do arquivo. Caso haja falha no registro no arquivo
(como por exemplo, direito de acesso negado, falta de espao em disco, etc.),
ocorrer um erro de script.
Este mtodo pode ser usado, por exemplo, para registrar mensagens de depurao
de scripts que no sejam executados no Viewer (haja vista que neste caso no
possvel utilizar o mtodo MsgBox).

Objetos de Servidor

349

Parmetros do mtodo Trace


NOME
MessageText
LogTimeStamp
BreakLine

DESCRIO
Mens a gem de texto defi ni da pel o
us u ri o.
(Opci ona l ) Bool ea no que i ndi ca s e ca da
regi s tro deve ter a da ta e a hora
(timestamp). Se omi ti do, a s s ume True.
(Opci ona l ) Bool ea no que i ndi ca a
pres ena ou n o de uma quebra de l i nha
a o fi na l de ca da mens a gem. Em Fa l s e,
fa z com que o a rqui vo tenha todos os
regi s tros em uma s l i nha . Se omi ti do,
a s s ume True.

5.3.1.1.6 TrackEvent
TrackEvent(EventMessage, Comment, TimeStamp)
O mtodo TrackEvent permite gerar eventos via script manualmente. Veja o mtodo
TrackEvent do objeto Viewer para mais informaes.

5.3.2 Pastas de Aplicativo


O objeto Pasta de Aplicativo semelhante ao objeto Pasta de Dados, do objeto
Servidor de Dados, permitindo agrupar objetos do Servidor dentro de pastas.
Contudo, existem diferenas importantes:
O objeto Pasta de Aplicativo s est disponvel em tempo de execuo
O objeto possui as propriedades gerais Application, Count, Name, Parent e
PathName, alm dos mtodos gerais Item e Save
O objeto permite utilizar o comando For Each do VBScript para enumerar seus
objetos filhos, mas este acesso leva em conta apenas os objetos do Servidor, no
listando, por exemplo, Telas e Recursos que estejam dentro das pastas
A pasta raiz a partir da qual possvel enumerar os objetos sempre o objeto
Servidor

5.4 Objetos em Tempo de Configurao


Esta seo contm informaes sobre objetos que s podem ser utilizados em
tempo de configurao.

5.4.1 E3StudioApplication
Esta seo contm informaes sobre mtodos especficos do objeto
E3StudioApplication. Este objeto no possui eventos nem propriedades especficos.
350

Objetos de Servidor

5.4.1.1 Mtodos
Esta seo contm informaes sobre os mtodos especficos do objeto
E3StudioApplication.
NOTA: Os mtodos a qui des cri tos s podem s er uti l i za dos no Studi o, n o es ta ndo
di s ponvei s em tempo de execu o.

5.4.1.1.1 CreateFile
CreateFile(ProjectName, ClassName[, FileName, FolderName, RunWizard,
OpenView])
Cria um novo objeto em um arquivo de projeto (.prj). Os parmetros deste mtodo
so os seguintes:
ProjectName: o nome do arquivo de projeto onde o objeto ser inserido. Este
parmetro no pode ser vazio, e o arquivo de projeto deve estar carregado no
Studio. Pode ser o caminho completo do arquivo de projeto ou o caminho
relativo ao arquivo de Domnio. No h necessidade de adicionar a extenso .prj
ClassName: o nome da classe do objeto que ser criado. Veja a tabela a seguir
para os valores permitidos neste parmetro
FileName: o nome do objeto inserido. Se este parmetro for omitido, ser
utilizado o nome padro para a criao do objeto de tipo indicado em
ClassName. O tamanho mximo permitido para este parmetro de 32 caracteres
e se j existir, ser automaticamente incrementado
FolderName: o nome da Pasta onde o objeto ser criado. Se este parmetro for
omitido, o objeto criado na raiz do arquivo de projeto. O nome da Pasta deve
obedecer s mesmas regras da seo de Notas do mtodo RenameFolder
RunWizard: Booleano que indica se o assistente de configurao da classe
indicada por ClassName ser aberto aps a execuo do mtodo. O valor padro
deste parmetro Verdadeiro
OpenView: Booleano que indica se o editor do objeto inserido ser aberto aps a
execuo do mtodo. O valor padro deste parmetro Verdadeiro
Valores possveis para o parmetro ClassName
OBJETO A SER CRIADO
Banco de Dados
Configurao de Alarmes
Driver de Comunicao
Driver de Comunicao OPC
Frmula
Histrico

Objetos de Servidor

VALOR DO PARMETRO
DB.DBServer
DB.Al a rmConfi g
IODrv.IODri ver
IODrv.OPCDri ver
DB.Formul a
DB.Hi s t

351

OBJETO A SER CRIADO


Quadro
Relatrio
Servidor de Alarmes
Servidor de Dados
Storage
Tela
Viewer

VALOR DO PARMETRO
Pa nel .Fra meSet
Pa nel .Report
DB.Al a rmServer
Pa nel .Da ta Server
DB.Hi s tori a n
Pa nel .Screen
Pa nel .Vi ewer

5.4.1.1.2 CreateFolder
CreateFolder(ProjectName, FolderName[, ParentFolder])
Cria uma nova Pasta com o nome definido em FolderName, dentro do arquivo de
projeto (.prj) ProjectName, e cujo objeto pai indicado por ParentFolder. As
seguintes restries se aplicam a este mtodo:
O arquivo de projeto indicado no parmetro ProjectName deve existir, e estar
aberto no Studio
Se o parmetro FolderName for vazio, ser utilizado o nome padro para criao
de Pastas. Por exemplo, Pasta1
O tamanho mximo permitido para o parmetro FolderName de 32 caracteres
Se o nome indicado no parmetro FolderName j existir, o nome ser
automaticamente incrementado
O nome da Pasta em FolderNome deve obedecer s mesmas regras da seo de
Notas do mtodo RenameFolder
A Pasta indicada no parmetro ParentFolder deve existir. Se o parmetro for
omitido, a nova Pasta criada na raiz do arquivo de projeto

5.4.1.1.3 CreatePRJ
CreatePRJ(Filename)
Cria um novo arquivo de projeto (.prj) com o nome Filename, e o adiciona ao
Domnio corrente, se existir. Se o parmetro Filename no for um caminho absoluto,
ser utilizado um caminho relativo ao Domnio, ou o caminho padro para
arquivos de projeto (salvo no Registro do Windows). A extenso .prj adicionada
automaticamente, se necessrio.

5.4.1.1.4 RenameFolder
RenameFolder(OldName, NewName)
Permite renomear uma Pasta em um arquivo de projeto aberto no Studio,
352

Objetos de Servidor

pertencente ou no ao Domnio. O parmetro OldName o caminho completo da


Pasta que se deseja renomear, e o parmetro NewName o novo nome, sem o
caminho.
NOTAS:
Se o ca mi nho compl eto da Pa s ta no pa r metro OldName ou o novo nome no
pa r metro NewName comea com um ca ra ctere que n o s eja uma l etra (s em
a centos nem ""), ou s e pos s ui um ca ra ctere qua l quer que n o s eja uma l etra
(s em a centos nem ""), um a l ga ri s mo (0-9) ou s ubl i nha do, obri ga tri o o us o de
col chetes no nome
Se o pa r metro NewName i nv l i do, s e o pa r metro OldName contm um erro de
s i nta xe, ou a i nda s e o ca mi nho i ndi ca do em OldName n o foi encontra do em
nenhum a rqui vo de projeto a berto, ocorrer um erro de s cri pt
Arqui vos de projeto protegi dos por s enha dever o s er des bl oquea dos a ntes da
uti l i za o des te mtodo

5.5 Drivers
Esta seo contm informaes sobre eventos, mtodos e propriedades dos
seguintes objetos: Driver de Comunicao, Tag de Comunicao, Bloco de
Comunicao, Elemento de Bloco de Comunicao, Driver de Comunicao OPC, Tag
de Comunicao OPC, Bloco de Comunicao OPC, Elemento de Bloco de
Comunicao OPC e Driver de Comunicao OPC UA.

5.5.1 Driver de Comunicao


Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Driver de Comunicao.

5.5.1.1 Eventos
Es ta s e o contm i nforma es s obre os eventos do objeto Dri ver de Comuni ca o.

5.5.1.1.1 AfterStart
AfterStart()
Ocorre depois que o Driver de Comunicao iniciou a comunicao. comum fazerse um script para este evento utilizando o mtodo Write para fazer configuraes
em equipamentos. Exemplo:
Sub Driver1_AfterStart()
' Aps iniciada a comunicao manda escrever valores
' para o equipamento/dispositivo
Write 0, 2, 55, 2, 33.4
Write 0, 3, 55, 20, "Metal"
End Sub

Objetos de Servidor

353

5.5.1.1.2 AfterStop
AfterStop()
Ocorre depois que o Driver finalizou a comunicao. Utilize o evento AfterStop
para fazer alguma ao que seja necessria aps terminada a comunicao do
Driver.

5.5.1.1.3 BeforeStart
BeforeStart()
Ocorre quando o Driver est prestes a iniciar a comunicao. Utilize o evento
BeforeStart para fazer alguma ao que seja necessria antes de iniciar a
comunicao, como por exemplo a configurao de parmetros do Driver. Exemplo:
Sub Driver1_BeforeStart()
' Faz a inicializao dos parmetros do driver antes
' de iniciar a comunicao
P1 = 0
P2 = 20
P3 = 80
P4 = 0
End Sub

5.5.1.1.4 BeforeStop
BeforeStop()
Ocorre quando o Driver est prestes a finalizar a comunicao. Utilize o evento
BeforeStop para fazer alguma ao que seja necessria antes que a comunicao
seja terminada, como por exemplo, escrever ou ler valores do equipamento ou
dispositivo, antes que a comunicao no esteja mais disponvel.

5.5.1.1.5 OnCommError
OnCommError(EvtType, Size, Element, N1, N2, N3, N4)
Ocorre quando algum erro de escrita ou leitura detectado pelo Driver de
Comunicao. Utilize o evento OnCommError para saber quando ocorreu uma falha
de escrita ou leitura no Driver. As variveis de evento recebem informaes sobre o
erro ocorrido. Com estes valores, possvel rastrear quais Tags esto apresentando
problemas de comunicao.

354

Objetos de Servidor

Variveis do evento OnCommError


NOME
EvtType

Size
Element
N1
N2
N3
N4

DESCRIO
Informa qua l o ti po de opera o o Dri ver
es ta va efetua ndo qua ndo ocorreu o erro,
conforme a s opes a s egui r:
0: Erro de l ei tura de um s El emento (Size
= 1). Param1 N1, Param2 N2, Param3
N3 e Param4 N4
1: Erro de es cri ta de um s El emento (Size
= 1). Param1 N1, Param2 N2, Param3
N3 e Param4 N4
2: Erro de l ei tura de um Bl oco (Bl oco de
Comuni ca o). Size determi na do pel o
nmero de el ementos do Bl oco. Param1
N1, Param2 N2, Param3 N3 e Param4
N4
3: Erro de es cri ta de um Bl oco (Bl oco de
Comuni ca o). Size determi na do pel o
nmero de el ementos do Bl oco. Param1
N1, Param2 N2, Param3 N3 e Param4
N4
Qua nti da de de va l ores s endo es cri tos ou
l i dos .
ndi ce do el emento que es ta va s endo l i do
ou es cri to, dentro do Bl oco.
Pa r metro 1 da opera o de l ei tura ou
es cri ta que gerou o erro.
Pa r metro 2 da opera o de l ei tura ou
es cri ta que gerou o erro.
Pa r metro 3 da opera o de l ei tura ou
es cri ta que gerou o erro.
Pa r metro 4 da opera o de l ei tura ou
es cri ta que gerou o erro.

Exemplo:
Sub Driver1_OnCommError(Type, Size, Element, N1, N2, N3, N4)
Application.GetObject("Dados.TagInterno1").Value = _
Application.GetObject("Dados.TagInterno1").Value + 1
Application.GetObject("Dados.EvtType").Value = EvtType
Application.GetObject("Dados.Size").Value = Size
Application.GetObject("Dados.Element").Value = Element
Application.GetObject("Dados.N1").Value = N1
Application.GetObject("Dados.N2").Value = N2
Application.GetObject("Dados.N3").Value = N3
Application.GetObject("Dados.N4").Value = N4
End Sub

Objetos de Servidor

355

5.5.1.1.6 OnCommErrorEx
OnCommErrorEx(ErrorInfo)
Ocorre logo aps a execuo do mtodo OnCommError.
Informaes do parmetro ErrorInfo
NOME
ErrorInfo.EvtType

ErrorInfo.Size
ErrorInfo.Element
ErrorInfo.Nx
ErrorInfo.ParamDevice
ErrorInfo.ParamItem

DESCRIO
Indi ca o ti po de opera o que ca us ou o
erro:
0: l ei tura de Ta g
1: es cri ta em Ta g
2: l ei tura de Bl oco
3: es cri ta em Bl oco
Ta ma nho do Bl oco que oca s i onou o erro
(s e for um Ta g, o Size 1).
ndi ce do El emento de Bl oco que ca us ou o
erro.
Pa r metros Nx ou Bx (x = 1, 2, 3 ou 4) da
opera o que ca us ou o erro.
Pa r metro ParamDevice (String) da opera o
que ca us ou o erro.
Pa r metro ParamItem (String) da opera o
que ca us ou o erro.

5.5.1.1.7 OnTagRead
OnTagRead(Tag)
Ocorre na leitura de um Tag, sempre que um novo valor ou um erro for retornado
pelo Driver de Comunicao. Ou seja, se o valor ou a qualidade do Tag no
mudarem, o evento no ser disparado. Para que o evento funcione, a propriedade
EnableDriverEvent deve obrigatoriamente estar habilitada. Alm disso, a
propriedade PercentDeadband tambm pode exercer influncia sobre a ocorrncia
do evento, caso a propriedade EnableDeadband esteja habilitada. Exemplo:
Sub Tags_OnTagRead(Tag)
Set Obj = Application.GetObject("Dados1.TagName")
Obj.Value = Tag.Name
Set Obj = Application.GetObject("Dados1.TagRead")
Obj.Value = True
Set Obj = Application.GetObject("Dados1.TagType")
Obj.Value = TypeName(Tag)
End Sub

356

Objetos de Servidor

5.5.1.1.8 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escrita for disparada em qualquer Tag do Driver.
Variveis do evento OnTagWrite
NOME
Tag

Succeeded
User

DESCRIO
Uma refernci a pa ra o objeto do Ta g que
es t s ofrendo a es cri ta . Por exempl o,
pode-s e a ces s a r a propri eda de do Ta g
com a s i nta xe Tag.DocString.
Um va l or Bool ea no que i ndi ca o s uces s o
da es cri ta (True = s uces s o, Fa l s e = fa l ha ).
Pa r metro que recebe o us u ri o que fez
a es cri ta . O va l or pa dr o des te
pa r metro "Sys tem". Se n o houver
nenhum us u ri o l oga do no Vi ewer que
gerou o evento, es te pa r metro contm o
va l or "Anonymous ".

5.5.1.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Driver de
Comunicao.

5.5.1.2.1 Write
Write(N1, N2, N3, N4, Value[, WriteSyncMode])
Executa a escrita de um dado no equipamento. Este mtodo retorna um Booleano
que indica o sucesso ou no da operao.
Os parmetros N1 a N4 correspondem aos parmetros N do Driver. O parmetro
Value define o valor a ser escrito no Driver. O parmetro WriteSyncMode permite
utilizar um modo de escrita diferente do utilizado pelo Driver. As opes
disponveis para este parmetro so:
0: Usa o modo de escrita configurado no Driver (padro)
1: Executa uma escrita sncrona
2: Executa uma escrita assncrona (sem confirmao)
Se o parmetro WriteSyncMode for omitido, ser tambm utilizado o modo de
escrita configurado no Driver. Para maiores detalhes sobre estes parmetros,
consulte a documentao do Driver.

Objetos de Servidor

357

5.5.1.2.2 WriteEx
WriteEx(N1, N2, N3, N4, Value[, Timestamp[, Quality[, WriteStatus[,
WriteSyncMode]]]])
Faz a escrita de um dado no equipamento. Este mtodo retorna um Booleano que
indica o sucesso ou no da operao.
Os parmetros N1 a N4 correspondem aos parmetros N do Driver. O parmetro
Value define o valor a ser escrito no Driver. Para maiores detalhes sobre estes
parmetros, consulte a documentao do Driver.
Os parmetros Timestamp, Quality e WriteStatus so opcionais. Se omitidos, o
comportamento do mtodo o mesmo do mtodo Write. Timestamp especifica a
data e hora a ser escrita no Tag (se suportada pelo equipamento). Se omitido,
assumida a data e hora do momento da operao de escrita. Quality indica a
qualidade (de 0 a 255). Se omitido, assumida a qualidade Boa (192). WriteStatus
recebe um valor retornado pelo Driver, que indica o status da escrita (se suportado
pelo Driver, de acordo com sua documentao prpria). O parmetro
WriteSyncMode permite utilizar o modo de escrita diferente do utilizado no Driver.
As opes disponveis para este parmetro so:
0: usa o modo de escrita configurado no Driver
1: executa uma escrita sncrona
2: executa uma escrita assncrona (sem confirmao)
Se o parmetro for omitido, ser tambm utilizado o modo de escrita configurado
no Driver. Exemplo:
Dim status
If Driver1.WriteEx(0, 0, 0, 0, 100, , , status) Then
MsgBox "Escrita feita com sucesso, status = " & status
Else
MsgBox "Escrita falhou, status = " & status
End If

5.5.1.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Driver de
Comunicao.

5.5.1.3.1 DisableIOServerPool
Fora o Driver a no participar do Pool de processos do IOServer, ou seja, o
Driver ir rodar em um IOServer exclusivo. O valor padro desta propriedade
Falso.

358

Objetos de Servidor

NOTA: Pa ra ma i s i nforma es , cons ul te o tpi co Pool de Processos IOServer, no Manual


do Usurio.

5.5.1.3.2 DriverLocation
Define qual ser o driver utilizado pelo objeto Driver de Comunicao para
efetuar a comunicao com o equipamento ou dispositivo. Esta propriedade aceita
uma String com o caminho completo do driver, caso ele no esteja no mesmo
diretrio do Domnio, ou o caminho relativo se ele estiver no mesmo diretrio do
Domnio. Caso no haja um Domnio aberto no Studio, o caminho relativo ser
considerado a partir da pasta onde se encontra o projeto ou biblioteca contendo o
objeto Driver de Comunicao. Aps isso, a propriedade DriverName mudar para
a descrio do driver. Esta propriedade no pode ser modificada aps iniciada a
comunicao. O valor padro desta propriedade uma String vazia.
NOTA: Acons el ha -s e uti l i za r s empre a op o Procurar DLL, no menu contextua l do
objeto Dri ver de Comuni ca o, pa ra confi gura r correta mente es ta propri eda de.

5.5.1.3.3 DriverName
A propriedade DriverName contm uma String que descreve o driver associado
ao objeto Driver de Comunicao. Para isso, deve-se antes configurar a
propriedade DriverLocation. Esta propriedade somente de leitura e no est
disponvel em tempo de execuo.

5.5.1.3.4 EnableReadGrouping
Permite otimizaes de leitura (agrupamento automtico de Tags). Esta
propriedade no pode ser alterada em tempo de execuo. Seu valor padro True.
A otimizao de leitura s acontecer se o Driver suportar este recurso.

5.5.1.3.5 P1
Utilize a propriedade P1 para configurar o driver. Consulte a documentao do
driver para sua correta parametrizao. Esta propriedade no pode ser modificada
aps iniciada a comunicao. Exemplo:
Sub Driver1_BeforeStart()
' Driver1 um objeto do tipo Driver de Comunicao
DriverLocation = "c:\driver\plc.dll"
P1 = 2
P2 = 1
P3 = 9600
End Sub

Objetos de Servidor

359

5.5.1.3.6 P2
Utilize a propriedade P2 para configurar o driver. Consulte a documentao do
driver para sua correta parametrizao. Esta propriedade no pode ser modificada
aps iniciada a comunicao. O valor padro desta propriedade 0. Exemplo:
Sub Driver1_BeforeStart()
' Driver1 um objeto do tipo Driver de Comunicao
DriverLocation = "c:\driver\plc.dll"
P1 = 2
P2 = 1
P3 = 9600
End Sub

5.5.1.3.7 P3
Utilize a propriedade P3 para configurar o driver. Consulte a documentao do
driver para sua correta parametrizao. Esta propriedade no pode ser modificada
aps iniciada a comunicao. Exemplo:
Sub Driver1_BeforeStart()
' Driver1 um objeto do tipo Driver de Comunicao
DriverLocation = "c:\driver\plc.dll"
P1 = 2
P2 = 1
P3 = 9600
End Sub

5.5.1.3.8 P4
Utilize a propriedade P4 para configurar o driver. Consulte a documentao do
driver para sua correta parametrizao. Esta propriedade no pode ser modificada
aps iniciada a comunicao. Exemplo:
Sub Driver1_BeforeStart()
' Driver1 um objeto do tipo Driver de Comunicao
DriverLocation = "c:\driver\plc.dll"
P1 = 2
P2 = 1
P3 = 9600
P4 = 500
End Sub

5.5.1.3.9 ParamDevice
Define o endereo do equipamento acessado pelo driver. Esta propriedade
herdada pelos Tags filhos do driver, que podem sobrescrever este valor, se
necessrio.

360

Objetos de Servidor

5.5.1.3.10 ReadRetries
Indica o nmero de re-tentativas de leitura do driver em caso de erro. Se for
configurada para 2, por exemplo, indica que o driver vai tentar duas vezes mais
uma comunicao falhada, sem contar a tentativa original.

5.5.1.3.11 ShareMaximum
A propriedade ShareMaximum define o nmero mximo de Drivers de
Comunicao que sero agrupados em um I/O Server compartilhado. Esta
propriedade s utilizada se a propriedade ShareServer estiver habilitada.
Exemplo:
' Este driver no ser compartilhado
ShareServer = False
ShareMaximum = <qualquer valor>
' Todos os drivers sero agrupados no mesmo IOServer
' No define um limite
ShareServer = True
ShareMaximum = 0
' Agrupa cada 5 drivers em um IOServer
ShareServer = True
ShareMaximum = 5

5.5.1.3.12 ShareServer
Se a propriedade ShareServer estiver configurada para True, isto significa que
este driver ir compartilhar sua execuo entre os demais objetos Driver de
Comunicao que possuam a mesma String em DriverLocation. Isto implica que
somente o primeiro Driver de Comunicao configurado executar a inicializao
da comunicao. Todos os demais objetos Driver de Comunicao compartilhados
ignoraro todos os parmetros de configurao P1 at P4, e tambm outras
configuraes. Do contrrio, se a propriedade estiver configurada para False, o
driver no compartilhar qualquer tipo de comunicao com outros objetos Driver
de Comunicao. Esta propriedade no pode ser modificada aps iniciada a
comunicao. O valor padro desta propriedade False.

5.5.1.3.13 WriteFeedbackMode
Esta propriedade permite controlar a confirmao (ou feedback) das escritas em
Tags. aplicvel somente a Tags que possam ser lidos, ou seja, possuam a
propriedade AllowRead em True. Atravs desta propriedade, possvel tornar mais
imediata a leitura de Tags que recebem escritas. Esta propriedade possui as
seguintes opes de configurao:

Objetos de Servidor

361

Opes disponveis para WriteFeedbackMode


OPO
0 - wfWaitNextRead
1 - wfImmediateReadAfterWrite

2 - wfTrustWriteSuccess

DESCRIO
A l ei tura do Ta g s er fei ta norma l mente
no prxi mo scan.
Aps ca da es cri ta , uma l ei tura de
confi rma o s er fei ta o ma i s cedo
pos s vel .
Se o dri ver i ndi ca r s uces s o na es cri ta , o
va l or es cri to a s s umi do di reta mente
pel o Ta g, s em l -l o do PLC.

O valor padro desta propriedade 1 - wfImmediateReadAfterWrite. Aplicaes


anteriores existncia desta propriedade assumem o valor 0 - wfWaitNextRead
quando carregadas. Exemplo:
Sub CommandButton1_Click()
Dim modo
modo = Application.GetObject("Driver1").WriteFeedbackMode
MsgBox modo
Select case modo
Case 0
MsgBox "A leitura do tag ser feita no prximo scan."
Case 1
MsgBox "Aps cada escrita, uma leitura de confirmao _
ser feita o mais cedo possvel."
Case 2
MsgBox "Se o driver indicar sucesso na escrita, _
o valor escrito assumido diretamente pelo tag, _
sem l-lo do PLC."
End Select
End Sub
NOTA: Qua ndo for us a do o modo 2 - wfTrustWriteSuccess, o timestamp e a qua l i da de
podem fi ca r erra dos , j que em uma es cri ta bem s ucedi da , o va l or a s s umi do pel o
Ta g s em bus ca r o timestamp e a qua l i da de no PLC. Al m di s s o, o prpri o va l or
a s s umi do pode ter um pequeno des vi o devi do a qua l quer ti po de a rredonda mento
que pos s a ocorrer no dri ver ou no PLC. Deve s er l eva do em conta a i nda que a l guns
dri vers ou protocol os podem i ndi ca r s uces s o, mes mo qua ndo a es cri ta fa l hou. Por
tudo i s s o, os outros modos (1 - wfImmediateReadAfterWrite ou 0 - wfWaitNextRead)
devem s er preferi dos s empre que pos s vel .

5.5.1.3.14 WriteRetries
Indica o nmero de re-tentativas de escrita do driver em caso de erro. Se for igual
a 2, indica que o driver vai tentar duas vezes mais uma comunicao falhada, sem
contar a tentativa original.

362

Objetos de Servidor

5.5.1.3.15 WriteSyncMode
Determina como as escritas sero enviadas para o I/O Server (modo sncrono ou
assncrono). Esta propriedade possui as seguintes opes de configurao:
Opes disponveis para WriteSyncMode
OPO
0 - wsmDefault
1 - wsmSync

2 - wsmAsyncUnconfirmed

DESCRIO
Modo s ncrono (pa dr o).
Modo s ncrono. Sempre que um va l or
es cri to em a l gum Ta g, o E3Run envi a a
es cri ta pa ra o I/O Server e a gua rda o
retorno da es cri ta .
Modo a s s ncrono s em confi rma o.
Toda s a s es cri ta s s o envi a da s pa ra o I/
O Server s em a gua rda r o retorno, e
a s s ume-s e s empre que a es cri ta
funci onou. Qua ndo em modo a s s ncrono,
os mtodos de es cri ta dos Ta gs (Write,
WriteEx) s empre retorna m True
i medi a ta mente, e o s ta tus da es cri ta
(nos mtodos que retorna m es te s ta tus )
fi ca s empre va zi o (Empty). O evento
OnTagWrite do dri ver executa do a s s i m
que a es cri ta envi a da pa ra o I/O Server,
e o pa r metro Succeeded fi ca s empre em
True.

As escritas assncronas sero executadas pelo I/O Server assim que o driver ficar
disponvel (quando a leitura atual terminar). Se vrias escritas assncronas forem
enviadas para o I/O Server, o driver s retomar as leituras depois que todas as
escritas assncronas forem executadas.

5.5.1.4 Bloco de Comunicao


Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Bloco de Comunicao.

5.5.1.4.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Bloco de Comunicao.
5.5.1.4.1.1 OnRead
OnRead()
Ocorre quando uma leitura do Bloco de Comunicao efetuada pelo driver. Utilize
Objetos de Servidor

363

o evento OnRead quando for necessrio efetuar alguma operao logo aps algum
dado ter sido modificado no objeto Bloco de Comunicao, como por exemplo as
propriedades Quality, TimeStamp ou ainda a propriedade Value de algum Elemento
do Bloco. Exemplo:
Sub IOBloco1_OnRead()
' Ao ler o bloco, atribui ao tag InternalTag1
' o valor do elemento de bloco elm1
Set obj = Application.GetObject("DataServer1.InternalTag1")
Set elm = Application.GetObject("Driver1.IOBloco1.elm1")
obj.Value = elm.Value
End Sub

5.5.1.4.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Bloco de Comunicao.
5.5.1.4.2.1 Write
Write([WriteSyncMode])
Executa a escrita do valor corrente do Bloco de Comunicao no equipamento.
Normalmente, este comando de script s usado quando a propriedade AllowWrite
deste objeto for False.
O parmetro WriteSyncMode permite utilizar o modo de escrita diferente do
utilizado no driver. As opes disponveis para este parmetro so:
0: usa o modo de escrita configurado no driver
1: executa uma escrita sncrona
2: executa uma escrita assncrona (sem confirmao)
Se o parmetro for omitido, ser tambm utilizado o modo de escrita configurado
no driver. Para maiores detalhes, consulte a documentao do driver. Este mtodo
retorna um Booleano que indica o sucesso ou no da operao.
5.5.1.4.2.2 WriteEx
WriteEx([Value[, Timestamp[, Quality[, WriteStatus[, WriteSyncMode]]]]])
Executa a escrita de um valor no equipamento. Todos os seus parmetros so
opcionais; se omitidos, o comportamento do mtodo igual ao do mtodo Write.
Este mtodo retorna um Booleano que indica o sucesso ou no da operao.
O parmetro Value define o valor a ser escrito no driver. O tipo de dado depende do
driver; se omitido, assumido o valor corrente do Tag. Timestamp especifica a data
e hora a ser escrita no Tag (se suportada pelo equipamento). Se omitido,
assumida a data e hora do momento da operao de escrita. Quality indica a
qualidade (de 0 a 255). Se omitido, assumida a qualidade Boa (192). WriteStatus
364

Objetos de Servidor

recebe um valor retornado pelo driver, que indica o status da escrita (se suportado
pelo driver, de acordo com sua documentao prpria).
O parmetro WriteSyncMode permite utilizar o modo de escrita diferente do
utilizado no driver. As opes disponveis para este parmetro so:
0: usa o modo de escrita configurado no driver
1: faz uma escrita sncrona
2: faz uma escrita assncrona (sem confirmao)
Se o parmetro for omitido, ser tambm utilizado o modo de escrita configurado
no driver. Exemplo:
Sub Tag1_OnRead()
' O mtodo WriteEx pode ser usado para transferir
' valores de variveis de um driver para outro.
Application.GetObject("Driver2.Tag")._
WriteEx Value, TimeStamp, Quality
End Sub

5.5.1.4.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Bloco de
Comunicao.
5.5.1.4.3.1 AdviseType
Controla o modo Advise. As opes disponveis so:
Opes disponveis para AdviseType
OPO
0 - AlwaysInAdvise
1 - AdviseWhenLinked

DESCRIO
O Ta g ma nti do a tua l i za do s e a
propri eda de AllowRead for True.
O Ta g s a tua l i za do s e AllowRead for
True e o Ta g es ti ver a s s oci a do a a l gum
objeto a ti vo, por exempl o, um Di s pl a y de
uma Tel a a berta , um Al a rme ha bi l i ta do,
entre outros . A a s s oci a o do Ta g pa ra
es s e props i to pode s er fei ta na s
s egui ntes propri eda des : Value, RawValue,
Quality e de Bit00 a Bit31 de El ementos de
Bl oco, e Quality e TimeStamp de Bl ocos de
Comuni ca o.

5.5.1.4.3.2 AllowRead
Define se este Bloco dever ou no ser lido pelo Driver de Comunicao. Caso a
propriedade AllowRead esteja habilitada, ento o Driver automaticamente
Objetos de Servidor

365

atualizar os Elementos de comunicao inseridos neste Bloco, em intervalos de


tempo definidos pela propriedade Scan. Caso contrrio, este Bloco de Comunicao
no ser lido ou atualizado. Esta propriedade pode ser modificada em tempo de
execuo. O valor padro desta propriedade True. Exemplo:
Sub Botao1_Click()
' Faz com que seja parada a leitura do bloco
Set obj = Application.GetObject("Driver1.bloco1")
obj.AllowRead = False
End Sub

5.5.1.4.3.3 AllowWrite
Define se este Bloco dever ou no ser escrito quando for modificada a
propriedade Value de seus Elementos do Bloco de Comunicao. Se esta
propriedade estiver configurada para True, as modificaes sero enviadas para o
equipamento ou dispositivo associado ao Driver de Comunicao. Caso contrrio
as modificaes sero ignoradas. Os Elementos de comunicao no aceitaro
valores, caso esta propriedade esteja configurada para False, a no ser que a
propriedade AllowRead tambm esteja configurada para False. Exemplo:
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do bloco
Set obj = Application.GetObject("Driver1.bloco1")
obj.AllowWrite = False
End Sub

5.5.1.4.3.4 B1
Especifica a qual conjunto de dados no equipamento ou no dispositivo este Tag
estar associado. Consulte a documentao do driver para sua correta
parametrizao. Esta propriedade pode ser modificada aps iniciada a
comunicao. Exemplo:
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
End Sub

5.5.1.4.3.5 B2
Especifica a qual conjunto de dados no equipamento ou no dispositivo este Tag
estar associado. Consulte a documentao do driver para sua correta
parametrizao. Esta propriedade pode ser modificada aps iniciada a
comunicao. Exemplo:
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
End Sub

366

Objetos de Servidor

5.5.1.4.3.6 B3
Especifica a qual conjunto de dados no equipamento ou no dispositivo este Tag
estar associado. Consulte a documentao do driver para sua correta
parametrizao. Esta propriedade pode ser modificada aps iniciada a
comunicao. Exemplo:
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
End Sub

5.5.1.4.3.7 B4
Especifica a qual conjunto de dados no equipamento ou no dispositivo este Tag
estar associado. Consulte a documentao do driver para sua correta
parametrizao. Esta propriedade pode ser modificada aps iniciada a
comunicao. Exemplo:
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
B4 = 524
End Sub

5.5.1.4.3.8 EnableDeadBand
A propriedade EnableDeadBand habilita ou desabilita a propriedade
PercentDeadBand dos Elementos do Bloco. Se esta propriedade estiver configurada
para True, o valor do Bloco atualizado somente se este mudar e o novo valor
exceder o limite definido pela propriedade PercentDeadBand de qualquer um dos
Elementos do Bloco. Caso contrrio, o Bloco sempre atualizado e o limite de
banda morta no verificado. Sempre que possvel, recomendado manter a banda
morta habilitada, pois ela melhora a performance da aquisio e do
processamento de dados. Normalmente, a banda morta ser desabilitada apenas
para os Tags que retornem valores representando eventos que precisam ser
tratados no evento OnRead do Tag. O valor padro desta propriedade True.

Objetos de Servidor

367

NOTAS:
Ca s o ha ja ma i s de um El emento de Bl oco ma pea do pa ra o mes mo ndi ce, a
confi gura o de ba nda morta uti l i za da s er a quel a que res ul te no menor va l or
a bs ol uto de ba nda morta .
Se a l gum ndi ce do Bl oco pos s ui r um El emento n o ma pea do, a ba nda morta
nes te ndi ce s er i gua l a 0, ou s eja , qua l quer va ri a o no va l or do El emento vi ol a
a ba nda morta .
Se a propri eda de EnableDeadBand es ti ver ha bi l i ta da , o l ti mo va l or envi a do a o
Bl oco compa ra do com o va l or l i do no momento, El emento por El emento. Se
qua l quer um dos El ementos do Bl oco vi ol a r s ua ba nda morta , o Bl oco i ntei ro
s er a tua l i za do.

5.5.1.4.3.9 EnableDriverEvent
Esta propriedade utilizada para controlar a gerao do evento OnTagRead, que
ocorre no Driver de Comunicao que contm o Bloco. Se a propriedade
EnableDriverEvent do Tag estiver configurada para True, ser habilitada a gerao
do evento OnTagRead por este Tag. Caso contrrio, no ocorre. Os trs tipos de
Elementos de Comunicao (Tag de Comunicao, Bloco de Comunicao e
Elemento de Bloco) podem gerar este evento. O evento ocorre no driver e no no
Bloco.
5.5.1.4.3.10 ParamDevice
Define o endereo do equipamento acessado pelo Bloco. Esta propriedade
herdada do Driver, mas seu valor pode ser sobrescrito, se necessrio.
5.5.1.4.3.11 ParamItem
Identifica o dado que o Bloco acessa dentro de um equipamento.
5.5.1.4.3.12 Quality
A propriedade Quality informa qual a qualidade do valor contido na propriedade
Value. Cada vez que o Driver atribui um novo valor para o Bloco, ele tambm
configura a qualidade daquele dado. Esta propriedade somente para leitura. O
valor padro desta propriedade 0 (Qualidade Ruim).
NOTA: Pa ra ma i ores i nforma es s obre qua l i da de, cons ul te o tpi co Qualidade no
Manual do Usurio do E3.

5.5.1.4.3.13 Scan
Especifica qual tempo de varredura ser utilizado pelo servidor para atualizar o
Bloco. Esta propriedade representada em milissegundos e pode ser modificada
aps iniciada a comunicao, sendo utilizada apenas quando a propriedade
AllowRead estiver habilitada. Ao configurar esta propriedade nos diversos Blocos
368

Objetos de Servidor

presentes na aplicao, recomenda-se aumentar o valor da propriedade Scan para


aqueles Blocos que no variam muito no equipamento ou no dispositivo,
possibilitando assim que outros Blocos de maior prioridade sejam lidos com
maior frequncia, aumentando assim a performance geral do sistema. O valor
padro desta propriedade 1000 (1 segundo). O valor do scan deve ser maior que
zero. Exemplo:
Sub Bloco de comunicacao1_BeforeStart()
Scan = 152
End Sub

5.5.1.4.3.14 Size
Define o tamanho do conjunto de valores deste Bloco. Consulte a documentao
do driver utilizado para conhecer qual o limite para esta propriedade, de acordo
com os parmetros B1 at B4. Criando os Elementos de Bloco, possibilita-se o
acesso aos valores lidos e tambm permite a escrita de valores para o
equipamento ou dispositivo. Esta propriedade no pode ser modificada aps a
comunicao ser iniciada. O valor padro desta propriedade 0. Exemplo:
Sub Bloco de comunicacao1_BeforeStart()
Size = 10
End Sub

5.5.1.4.3.15 TimeStamp
A propriedade TimeStamp atualizada sempre que ocorrer alguma mudana de
valor ou de estado nas propriedades Value ou Quality. Ele informa qual a data e
hora associada tanto ao valor quanto qualidade do Bloco de Comunicao. Esta
uma propriedade somente para leitura. O valor padro desta propriedade
00:00:00.

5.5.1.4.4 Elemento de Bloco de Comunicao


Esta seo contm informaes sobre mtodos e propriedades do objeto Elemento
de Bloco de Comunicao. Este objeto no possui eventos associados.
5.5.1.4.4.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Elemento de Bloco de
Comunicao.

Write
Write([WriteSyncMode])
Executa a escrita do valor corrente do Elemento de Bloco no equipamento.
Normalmente, este comando de script s usado quando a propriedade AllowWrite
deste objeto for False.
O parmetro WriteSyncMode permite utilizar o modo de escrita diferente do
Objetos de Servidor

369

utilizado no driver. As opes disponveis para este parmetro so:


0: usa o modo de escrita configurado no driver
1: executa uma escrita sncrona
2: executa uma escrita assncrona (sem confirmao)
Se o parmetro for omitido, ser tambm utilizado o modo de escrita configurado
no driver. Para maiores detalhes, consulte a documentao do driver. Este mtodo
retorna um Booleano que indica o sucesso ou no da operao.

WriteEx
WriteEx([Value[, Timestamp[, Quality[, WriteStatus[, WriteSyncMode]]]]])
Executa a escrita de um valor no equipamento. Todos os seus parmetros so
opcionais; se omitidos, o comportamento do mtodo igual ao do mtodo Write.
Este mtodo retorna um Booleano que indica o sucesso ou no da operao.
O parmetro Value define o valor a ser escrito no driver. O tipo de dado depende do
driver; se omitido, assumido o valor corrente do Tag. Timestamp especifica a data
e hora a ser escrita no Tag (se suportada pelo equipamento). Se omitido,
assumida a data e hora do momento da operao de escrita. Quality indica a
qualidade (de 0 a 255). Se omitido, assumida a qualidade Boa (192). WriteStatus
recebe um valor retornado pelo driver, que indica o status da escrita (se suportado
pelo driver, de acordo com sua documentao prpria). O parmetro
WriteSyncMode permite utilizar o modo de escrita diferente do utilizado no driver.
As opes disponveis para este parmetro so:
0: usa o modo de escrita configurado no driver
1: executa uma escrita sncrona
2: executa uma escrita assncrona (sem confirmao)
Se o parmetro for omitido, ser tambm utilizado o modo de escrita configurado
no driver. Exemplo:
Sub Tag1_OnRead()
' O mtodo WriteEx pode ser usado para transferir
' valores de variveis de um driver para outro.
Application.GetObject("Driver2.Tag")._
WriteEx Value, TimeStamp, Quality
End Sub

5.5.1.4.4.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Elemento de Bloco
de Comunicao.
370

Objetos de Servidor

Bit00 at Bit31
As propriedades de bit Bit00 at Bit31 representam juntas os 32 bits do valor
presente na propriedade Value do Elemento de Bloco, sendo Bit00 o bit menos
significativo e Bit31 o bit mais significativo. Modificar cada um destes bits implica
na igual modificao da propriedade Value do Elemento, e vice-versa, mas isto
somente ocorre quando a propriedade UseBitFields estiver configurada para True. O
valor padro destas propriedades False.

DeviceHigh
A propriedade DeviceHigh define o valor mximo atingido pelo Elemento de Bloco
no equipamento ou no dispositivo. Esta propriedade utilizada no clculo do valor
da propriedade PercentDeadBand, e tambm para fazer o ajuste de escala do valor
proveniente do equipamento ou do dispositivo antes de ser atribudo
propriedade Value. Da mesma forma, no momento da escrita feita a operao
inversa antes de enviar o valor para o Driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para True. O valor padro desta
propriedade 1000.
NOTA: Os va l ores dos bi ts (a s propri eda des Bit00 at Bit31) n o s o a feta dos pel o
a jus te na es ca l a , ou s eja , repres enta m os bi ts dos va l ores l i dos pel o equi pa mento
a ntes da convers o.

DeviceLow
A propriedade DeviceLow define qual o valor mnimo atingido por este Elemento
no equipamento ou no dispositivo. Esta propriedade utilizada no clculo do valor
da propriedade PercentDeadBand, e tambm para fazer o ajuste de escala do valor
proveniente do equipamento ou do dispositivo antes de ser atribudo
propriedade Value. Da mesma forma, no momento da escrita, feita a operao
inversa antes de enviar o valor para o Driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para True. O valor padro desta
propriedade 0.
NOTA: Os va l ores dos bi ts (a s propri eda des Bit00 at Bit31) n o s o a feta dos pel o
a jus te na es ca l a , ou s eja , repres enta m os bi ts dos va l ores l i dos pel o equi pa mento
a ntes da convers o.

EnableDriverEvent
Esta propriedade utilizada para controlar a gerao do evento OnTagRead, que
ocorre no Driver de Comunicao que contm o Bloco. Se a propriedade
EnableDriverEvent do Tag estiver configurada para True, ser habilitada a gerao
do evento OnTagRead por este Tag. Caso contrrio, no ocorre. Os trs tipos de
Elementos de Comunicao (Tag de Comunicao, Bloco de Comunicao e
Elemento de Bloco) podem gerar este evento. O evento ocorre no driver e no no
Bloco.
Objetos de Servidor

371

EnableScaling
A propriedade EnableScaling habilita ou desabilita a escala de valor para o valor
enviado e recebido do equipamento ou do dispositivo. Se esta propriedade estiver
configurada para True, todo valor proveniente do equipamento ou do dispositivo
sofrer ajuste de escala conforme as propriedades DeviceHigh, DeviceLow, EUHigh e
EULow antes de ser atribudo propriedade Value. Caso contrrio, nenhum ajuste
de escala ser efetuado em nenhum dos dois sentidos (escrita e leitura). O valor
padro desta propriedade False. Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala de um elemento temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

EU
Esta propriedade utilizada para identificar qual unidade de engenharia seu
valor representa, como por exemplo: graus, metros, KW/h, etc. Exemplo:
Sub ElementodeBloco1_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

EUHigh
Define qual o valor mximo que dever ser atribudo propriedade Value,
ajustando a escala ao valor do equipamento ou do dispositivo antes desta
atribuio. Da mesma forma, no momento da escrita feita a operao inversa
antes de enviar o valor para o driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para True. O valor padro desta
propriedade 1000. Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala de um elemento temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"

372

Objetos de Servidor

EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

EULow
Define qual o valor mnimo que dever ser atribudo propriedade Value,
ajustando a escala ao valor do equipamento ou do dispositivo antes desta
atribuio. Da mesma forma, no momento da escrita, feita a operao inversa
antes de enviar o valor para o driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para True. O valor padro desta
propriedade 0. Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala de um elemento temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EULow = 100
EULow = 0
End Sub

Index
Especifica a posio que o Elemento de Bloco ocupa entre os elementos
configurados pela propriedade Size do Bloco de Comunicao no qual ele est
inserido. Esta propriedade aceita valores de 0 at um nmero menor do que a valor
definido em Size. Por exemplo: configurando um Bloco de Comunicao para ter
Size igual a 20, o nmero mximo vlido para a propriedade Index ser 19 e o
mnimo ser 0. Esta propriedade pode ser alterada aps iniciada a comunicao. O
valor padro desta propriedade 0, porm ao mapear os Elementos de um Bloco o
Studio automaticamente ajusta o parmetro Index para um valor de acordo com o
especificado. Exemplo:
Sub Elemento_OnStartRunning()
Index = 15
End Sub

PercentDeadBand
A propriedade PercentDeadBand determina a variao mnima do valor (banda
morta) de um Elemento de Bloco, para que seu valor no E3 seja atualizado. Este
valor especificado como um percentual da diferena entre as propriedades
DeviceHigh e DeviceLow. Esta propriedade s ser utilizada caso a propriedade
EnableDeadBand do Bloco esteja configurada para True. Se a propriedade
PercentDeadBand for igual a 0, o Elemento de Bloco no ter banda morta, e
qualquer variao no seu valor ser repassada para o E3. Caso contrrio, s ser
Objetos de Servidor

373

enviado para o E3 um novo valor cuja diferena, em relao ao valor atual no E3,
seja maior que a banda morta. O valor padro desta propriedade 0 (zero).

Quality
A propriedade Quality informa qual a qualidade do valor contido na propriedade
Value. Cada vez que o Driver atribui um novo valor para o Elemento, ele tambm
configura a qualidade daquele dado. Esta propriedade somente para leitura. O
valor padro desta propriedade 0 (Qualidade Ruim).
NOTA: Pa ra ma i ores i nforma es s obre qua l i da de, cons ul te o tpi co Qualidade no
Manual do Usurio do E3.

RawValue
Acessa o valor original do Elemento anterior escala, ou seja, independente da
configurao da propriedade EnableScaling. Ento, se esta propriedade for False, as
propriedades Value e RawValue apresentam o mesmo comportamento.

UseBitFields
Se esta propriedade estiver configurada para True, toda vez que o valor da
propriedade Value for modificada, ele atualizar os bits referentes s
propriedades Bit00 at Bit31. Da mesma forma, atualizar o valor de Value toda vez
que alguma das propriedades Bit00 at Bit31 mudar de valor e posteriormente
enviar para o equipamento ou para o dispositivo se a propriedade AllowWrite do
Bloco de Comunicao estiver configurada para True. Caso contrrio, os bits no
sofrero nem acarretaro qualquer mudana. Esta propriedade pode ser atualizada
aps ter sido iniciada a comunicao. O valor padro desta propriedade False.

Value
Atualizada sempre que uma nova leitura vlida de um valor do equipamento ou
do dispositivo for feita, utilizando-se a parametrizao B1 at B4 do Bloco de
Comunicao onde este Elemento estiver inserido, e considerando-se sua posio
na tabela lida atravs da propriedade Index. O tipo desta varivel (nmero inteiro,
ponto flutuante, texto) depende do driver ao qual o Elemento est associado e da
sua parametrizao.
Esta propriedade somente ser atualizada desta forma se a propriedade AllowRead
do objeto Bloco de Comunicao ao qual o Elemento pertence estiver configurada
para True, e quando no houver erros de comunicao (neste caso somente as
propriedades Quality e TimeStamp sero atualizadas), de acordo com o tempo de
varredura definido em Scan. Outra forma de utilizar esta propriedade para
escrever valores no equipamento ou no dispositivo, bastando para isto atribuir um
novo valor propriedade Value ou a algum dos bits Bit00 a Bit31. Neste caso, a
propriedade AllowWrite do objeto Bloco de Comunicao deve estar configurada
para True.
Esta tambm a propriedade padro do objeto Elemento de Bloco. Sendo assim,
374

Objetos de Servidor

uma referncia por valor a um Elemento de Bloco no necessita obrigatoriamente


explicitar a propriedade Value para acessar o valor. Caso esta propriedade no
esteja sendo atualizada, verifique se a propriedade Index est corretamente
configurada. O valor padro desta propriedade vazio (sem valor). Exemplo:
Sub Botao1_Click()
' Acessa um elemento e mostra o valor atual
' elm1 um objeto tipo Bloco de comunicao
Set obj = Application.GetObject("Driverde_
Comunicacao1.Block1.elm1")
MsgBox "Valor atual de elm1: " & obj.Value
' Isto tambm pode ser feito de outra forma,
' sem mostrar a propriedade Value, que padro
MsgBox "Valor atual de elm1: " & obj
End Sub

5.5.1.5 Pasta
Esta seo contm informaes sobre as propriedades do objeto Pasta do Driver de
Comunicao. Este objeto no possui eventos nem mtodos associados.

5.5.1.5.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Pasta do Driver de
Comunicao.
5.5.1.5.1.1 ParamDevice
Define o endereo do equipamento acessado pela Pasta. Esta propriedade
herdada do Driver, e seu valor pode ser sobrescrito, se necessrio.

5.5.1.6 Tag de Comunicao


Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Tag de Comunicao.

5.5.1.6.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Tag de Comunicao.
5.5.1.6.1.1 OnRead
OnRead()
Ocorre quando efetuada uma leitura do Tag pelo driver. Utilize o evento OnRead
quando for necessrio efetuar alguma operao logo aps algum dado ser
modificado no Tag, como por exemplo, as propriedades Value, Quality ou
TimeStamp. Este evento gerado por uma leitura em background. Exemplo:
Sub CommTag1_OnRead()

Objetos de Servidor

375

' Ao ler o tag, atribui o seu valor ao tag InternalTag1


Set obj = Application.GetObject("DataServer1.InternalTag1")
obj = Value ' Valor de CommTag1
End Sub

5.5.1.6.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Tag de Comunicao.
5.5.1.6.2.1 Write
Write([WriteSyncMode])
Executa a escrita do valor corrente do Tag de Comunicao no equipamento.
Normalmente, este comando de script s usado quando a propriedade AllowWrite
deste objeto for False.
O parmetro WriteSyncMode permite utilizar o modo de escrita diferente do
utilizado no driver. As opes disponveis para este parmetro so:
0: usa o modo de escrita configurado no driver
1: executa uma escrita sncrona
2: executa uma escrita assncrona (sem confirmao)
Se o parmetro for omitido, ser tambm utilizado o modo de escrita configurado
no driver. Para maiores detalhes, consulte a documentao do driver. Este mtodo
retorna um Booleano que indica o sucesso ou no da operao.
5.5.1.6.2.2 WriteEx
WriteEx([Value[, Timestamp[, Quality[, WriteStatus[, WriteSyncMode]]]]])
Executa a escrita de um valor no equipamento. Todos os seus parmetros so
opcionais; se omitidos, o comportamento do mtodo igual ao do mtodo Write.
Este mtodo retorna um Booleano que indica o sucesso ou no da operao.
O parmetro Value define o valor a ser escrito no driver. O tipo de dado depende do
driver; se omitido, assumido o valor corrente do Tag. Timestamp especifica a data
e hora a ser escrita no Tag (se suportada pelo equipamento). Se omitido,
assumida a data e hora do momento da operao de escrita. Quality indica a
qualidade (de 0 a 255). Se omitido, assumida a qualidade Boa (192). WriteStatus
recebe um valor retornado pelo driver, que indica o status da escrita (se suportado
pelo driver, de acordo com sua documentao prpria). O parmetro
WriteSyncMode permite utilizar o modo de escrita diferente do utilizado no driver.
As opes disponveis para este parmetro so:
0: usa o modo de escrita configurado no driver
1: executa uma escrita sncrona
376

Objetos de Servidor

2: executa uma escrita assncrona (sem confirmao)


Se o parmetro for omitido, ser tambm utilizado o modo de escrita configurado
no driver. Exemplo:
Sub Tag1_OnRead()
' O mtodo WriteEx pode ser usado para transferir
' valores de variveis de um driver para outro.
Application.GetObject("Driver2.Tag")._
WriteEx Value, TimeStamp, Quality
End Sub

5.5.1.6.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Tag de
Comunicao.
5.5.1.6.3.1 AdviseType
Controla o modo Advise. As opes disponveis so:
Opes disponveis para a propriedade AdviseType
OPO
0 - AlwaysInAdvise
1 - AdviseWhenLinked

DESCRIO
O Ta g ma nti do a tua l i za do s e a
propri eda de AllowRead for True.
O Ta g s a tua l i za do s e AllowRead for
True e o Ta g es ti ver a s s oci a do a a l gum
objeto a ti vo, por exempl o, um Di s pl a y de
uma Tel a a berta , um Al a rme ha bi l i ta do,
entre outros . A a s s oci a o do Ta g pa ra
es s e props i to pode s er fei ta na s
s egui ntes propri eda des : Value, RawValue,
TimeStamp, Quality e Bit00 a t Bit31 do
Ta g de Comuni ca o.

Exemplo:
Sub CommandButton3_Click()
MsgBox Application._
Application.GetObject("Driver1.Tag1").AdviseType
End Sub

5.5.1.6.3.2 AllowRead
Configure esta propriedade para definir se este Tag dever ou no ser lido pelo
Driver de Comunicao. Se esta propriedade estiver configurada para True, o driver
automaticamente atualizar as propriedades Value e Bits (de Bit00 at Bit31) deste
objeto em intervalos de tempo definidos pela propriedade Scan. Caso contrrio,
Objetos de Servidor

377

este Tag de Comunicao no ser lido. Esta propriedade pode ser modificada em
tempo de execuo. O valor padro desta propriedade True. Exemplo:
Sub Botao1_Click()
' Faz com que seja parada a leitura do tag
Set obj = Application.GetObject("Driver1.tag")
obj.AllowRead = False
End Sub

5.5.1.6.3.3 AllowWrite
Configure esta propriedade para definir se este Tag dever ou no ser escrito
automaticamente quando for modificada a propriedade Value ou qualquer
propriedade Bit (de Bit00 at Bit31). Se esta propriedade estiver configurada para
True, as modificaes sero enviadas para o equipamento ou dispositivo
associado ao Driver de Comunicao. Caso contrrio, as modificaes sero
ignoradas. O valor padro desta propriedade True. Exemplo:
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do tag
Set obj = Application.GetObject("Driver1.tag")
obj.AllowWrite = False
End Sub

5.5.1.6.3.4 Bit00 at Bit31


As propriedades de bit Bit00 at Bit31 representam juntas os 32 bits do valor
presente na propriedade Value do objeto Tag de Comunicao, sendo Bit00 o bit
menos significativo e Bit31 o bit mais significativo. Modificar cada um destes bits
implica na igual modificao da propriedade Value do Tag, e vice-versa, mas isto
somente ocorre quando a propriedade UseBitFields estiver configurada para True. O
valor padro destas propriedades False.
5.5.1.6.3.5 DeviceHigh
A propriedade DeviceHigh define qual o valor mximo atingido pelo Tag no
equipamento ou dispositivo. Esta propriedade ser utilizada para fazer o ajuste de
escala do valor proveniente do equipamento ou dispositivo antes de ser atribudo
propriedade Value. Da mesma forma, no momento da escrita feita a operao
inversa antes de enviar o valor para o driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para True. O valor padro desta
propriedade 1000. Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0

378

Objetos de Servidor

EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a t Bit31) n o s o a feta dos pel o
a jus te de es ca l a . Is to , repres enta m os bi ts do va l or l i do do equi pa mento, a ntes
da convers o.

5.5.1.6.3.6 DeviceLow
A propriedade DeviceLow define o valor mnimo atingido por este Tag no
equipamento ou no dispositivo. Esta propriedade ser utilizada para fazer o ajuste
de escala do valor proveniente do equipamento ou do dispositivo antes de ser
atribudo propriedade Value. Da mesma forma, no momento da escrita feita a
operao inversa antes de enviar o valor para o driver. Esta converso s ocorre
quando a propriedade EnableScaling est configurada para True. Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a t Bit31) n o s o a feta dos pel o
a jus te de es ca l a , i s to , repres enta m os bi ts do va l or l i do do equi pa mento, a ntes
da convers o.

5.5.1.6.3.7 EnableDeadBand
A propriedade EnableDeadBand habilita ou desabilita a propriedade
PercentDeadBand. Se esta propriedade estiver configurada para True, o valor do
Tag atualizado somente se este mudar e o novo valor exceder o limite definido
pela propriedade PercentDeadBand. Caso contrrio, o Tag sempre atualizado e o
limite de deadband (banda morta) no verificado. Sempre mantenha a banda
morta (deadband) habilitada, pois ela melhora a performance da aquisio de
dados e processamento. Voc deve desabilitar o deadband somente em casos onde
o Driver de Comunicao estiver retornando eventos de Tags Digitais ou
Analgicos, e seja necessrio processar estes eventos via script no evento OnRead
do Tag. O valor padro desta propriedade True.

Objetos de Servidor

379

5.5.1.6.3.8 EnableDriverEvent
Esta propriedade utilizada para controlar a gerao do evento OnTagRead, que
ocorre no Driver de Comunicao que contm o Bloco. Se a propriedade
EnableDriverEvent do Tag estiver configurada para True, ser habilitada a gerao
do evento OnTagRead por este Tag. Caso contrrio, no ocorre. Os trs tipos de
Elementos de Comunicao (Tag de Comunicao, Bloco de Comunicao e
Elemento de Bloco) podem gerar este evento. O evento ocorre no driver e no no
Bloco.
5.5.1.6.3.9 EnableScaling
A propriedade EnableScaling habilita ou desabilita a escala de valor para o valor
enviado e recebido do equipamento ou do dispositivo. Se esta propriedade estiver
configurada para True, todo valor proveniente do equipamento ou do dispositivo
sofrer ajuste de escala nas propriedades DeviceHigh, DeviceLow, EUHigh e EULow,
antes de ser atribudo propriedade Value. Caso contrrio, nenhum ajuste de
escala ser efetuado em nenhum dos dois sentidos (escrita e leitura). Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

5.5.1.6.3.10 EU
Esta propriedade utilizada para identificar a unidade de engenharia que o valor
representa, como por exemplo, graus, metros, KW/h, etc. Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

380

Objetos de Servidor

5.5.1.6.3.11 EUHigh
Define qual o valor mximo que dever ser atribudo propriedade Value,
ajustando a escala ao valor do equipamento ou do dispositivo antes desta
atribuio. Da mesma forma, no momento da escrita feita a operao inversa
antes de enviar o valor para o driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para True. O valor padro desta
propriedade 1000. Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a t Bit31) n o s o a feta dos pel o
a jus te de es ca l a . Is to , repres enta m os bi ts do va l or l i do do equi pa mento, a ntes
da convers o.

5.5.1.6.3.12 EULow
Define qual o valor mnimo que dever ser atribudo propriedade Value,
ajustando a escala ao valor do equipamento ou do dispositivo antes desta
atribuio. Da mesma forma, no momento da escrita, feita a operao inversa
antes de enviar o valor para o driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para True. O valor padro desta
propriedade 0. Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EULow = 100
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 a t Bit31) n o s o a feta dos pel o
a jus te de es ca l a . Is to , repres enta m os bi ts do va l or l i do do equi pa mento, a ntes
da convers o.

Objetos de Servidor

381

5.5.1.6.3.13 N1
Especifica a varivel do equipamento ou do dispositivo a que este Tag estar
associado. Consulte a documentao do driver para sua correta parametrizao.
Esta propriedade pode ser modificada aps iniciada a comunicao. O valor
padro desta propriedade 0. Exemplo:
Sub Tag_OnStartRunning()
N1 = 10
End Sub

5.5.1.6.3.14 N2
Especifica a varivel do equipamento ou do dispositivo a que este Tag estar
associado. Consulte a documentao do driver para sua correta parametrizao.
Esta propriedade pode ser modificada aps iniciada a comunicao. O valor
padro desta propriedade 0. Exemplo:
Sub Tag_OnStartRunning()
N2 = 3
End Sub

5.5.1.6.3.15 N3
Especifica a varivel do equipamento ou do dispositivo a que este Tag estar
associado. Consulte a documentao do driver para sua correta parametrizao.
Esta propriedade pode ser modificada aps iniciada a comunicao. O valor
padro desta propriedade 0. Exemplo:
Sub Tag_OnStartRunning()
N1 = 10
N3 = 5
N4 = 20
End Sub

5.5.1.6.3.16 N4
Especifica a varivel do equipamento ou do dispositivo a que este Tag estar
associado. Consulte a documentao do driver para sua correta parametrizao.
Esta propriedade pode ser modificada aps iniciada a comunicao. O valor
padro desta propriedade 0. Exemplo:
Sub Tag_OnStartRunning()
N1 = 10
N4 = 20
End Sub

5.5.1.6.3.17 ParamDevice
Define o endereo do equipamento acessado pelo Tag. Esta propriedade
herdada do driver, mas seu valor pode ser sobrescrito, se necessrio.
382

Objetos de Servidor

5.5.1.6.3.18 ParamItem
Identifica o dado que o Tag acessa dentro de um equipamento.
5.5.1.6.3.19 PercentDeadBand
A propriedade PercentDeadBand determina a variao mnima do valor (banda
morta) de um Tag, para que seu valor no E3 seja atualizado. Este valor
especificado como um percentual da diferena entre as propriedades DeviceHigh e
DeviceLow. Esta propriedade s ser utilizada caso a propriedade EnableDeadBand
do mesmo Tag esteja configurada para True. Se a propriedade PercentDeadband for
igual a 0, o Tag no ter banda morta, e qualquer variao no seu valor ser
repassada para o E3. Caso contrrio, s ser enviado para o E3 um novo valor cuja
diferena, em relao ao valor atual no E3, seja maior que a banda morta. O valor
padro desta propriedade 0 (zero).
5.5.1.6.3.20 Quality
A propriedade Quality informa qual a qualidade do valor contido na propriedade
Value. Cada vez que o Driver atribui um novo valor para o Tag, ele tambm
configura a qualidade daquele dado. Esta propriedade somente para leitura. O
valor padro desta propriedade 0 (Qualidade Ruim).
NOTA: Pa ra ma i ores i nforma es s obre qua l i da de, cons ul te o tpi co Qualidade no
Manual do Usurio do E3.

5.5.1.6.3.21 RawValue
Acessa o valor original do Tag anterior escala, ou seja, independentemente da
configurao da propriedade EnableScaling. Ento, se esta propriedade for False, as
propriedades Value e RawValue apresentam o mesmo comportamento.
5.5.1.6.3.22 Scan
Utilize a propriedade Scan para especificar o tempo de varredura que ser
utilizado pelo servidor para atualizar a propriedade Value. Esta propriedade
representada em milissegundos e pode ser modificada aps iniciada a
comunicao, sendo utilizada apenas quando a propriedade AllowRead estiver
configurada para True. Ao configurar esta propriedade nos diversos Tags presentes
na aplicao, recomenda-se aumentar o valor da propriedade Scan para aqueles
Tags que no variam muito no equipamento ou no dispositivo, possibilitando
assim que outros Tags de maior prioridade sejam lidos com maior frequncia,
aumentando assim a performance geral do sistema. O valor padro desta
propriedade 1000 (1 segundo). O valor do scan deve ser maior que 0. Exemplo:
Sub Tag_OnStartRunning()
Scan = 1500

Objetos de Servidor

383

End Sub

5.5.1.6.3.23 TimeStamp
A propriedade TimeStamp atualizada sempre que ocorrer alguma mudana de
valor ou estado nas propriedades Value ou Quality. Ele informa qual a data e hora
associada tanto ao valor quanto qualidade do Tag de Comunicao. Esta uma
propriedade somente para leitura. O valor padro desta propriedade 00:00:00.
5.5.1.6.3.24 UseBitFields
Caso a propriedade UseBitFields esteja configurada para True, toda vez que o
valor da propriedade Value for modificado, ele atualizar os bits referentes s
propriedades Bit00 at Bit31. Da mesma forma, atualizar o valor de Value toda vez
que alguma das propriedades Bit00 at Bit31 mudar de valor e posteriormente
enviar para o equipamento ou para o dispositivo, se a propriedade AllowWrite
estiver configurada para True. Caso contrrio, os bits no sofrero nem
acarretaro qualquer mudana. Esta propriedade pode ser atualizada aps ter sido
iniciada a comunicao.
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a t Bit31) n o s o a feta dos pel o
a jus te de es ca l a , i s to , repres enta m os bi ts do va l or l i do do equi pa mento, a ntes
da convers o.

5.5.1.6.3.25 Value
Atualizada sempre que uma nova leitura vlida de um valor do equipamento ou
do dispositivo for feita, utilizando-se a parametrizao N1 at N4. O tipo desta
varivel (nmero inteiro, ponto flutuante, texto) depende do driver ao qual o Tag
est associado e da sua parametrizao.
Esta propriedade somente ser atualizada desta forma se a propriedade AllowRead
estiver configurada para True, e quando no houver erros de comunicao (neste
caso somente as propriedades Quality e TimeStamp sero atualizadas), de acordo
com o tempo de varredura definido em Scan. Outra forma de utilizar esta
propriedade para escrever valores no equipamento ou no dispositivo, bastando
para isto atribuir um novo valor propriedade Value ou a algum dos bits Bit00 at
Bit31. Neste caso, a propriedade AllowWrite deve estar configurada para True.
Esta tambm a propriedade padro do objeto Tag de Comunicao. Sendo assim,
uma referncia por valor a um Tag de Comunicao no necessita obrigatoriamente
explicitar a propriedade Value para acessar o valor. O valor padro desta
propriedade vazio (sem valor). Exemplo:
Sub Botao1_Click()
' Acessa um tag e mostra o valor atual
' tag1 um objeto tipo Tag de Comunicao
Set obj = Application.GetObject("Driver de Comunicao1._
tag1")

384

Objetos de Servidor

MsgBox "Valor
' Isto tambm
' sem mostrar
MsgBox "Valor
End Sub

atual de tag1: " & obj.Value


pode ser feito de outra forma,
a propriedade Value, que o padro
atual de tag1: " & obj

NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a t Bit31) n o s o a feta dos pel o
a jus te de es ca l a . Is to , repres enta m os bi ts do va l or l i do do equi pa mento, a ntes
da convers o.

5.5.2 Driver de Comunicao OPC


Esta seo contm informaes sobre os eventos e propriedades do objeto Driver
de Comunicao OPC. Este objeto no possui mtodos associados.

5.5.2.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Driver de Comunicao
OPC.

5.5.2.1.1 OnTagRead
OnTagRead(Tag)
Ocorre na leitura de um Tag, sempre que um novo valor ou erro for retornado pelo
Servidor OPC. Ou seja, se o valor ou a qualidade do Tag no mudarem, o evento no
disparado. Para que este evento ocorra, a propriedade EnableDriverEvent do Tag
deve obrigatoriamente estar habilitada.

5.5.2.1.2 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escrita for disparada em qualquer Tag do Driver de
Comunicao OPC. Para que o evento ocorra, a propriedade EnableDriverEvent do
Tag deve obrigatoriamente estar habilitada. Se a escrita for assncrona, o evento
OnTagWrite gerado apenas quando o servidor enviar a resposta indicando o
efetivo sucesso ou no da escrita.
Parmetros do evento OnTagWrite
NOME
Tag

Succeeded

Objetos de Servidor

DESCRIO
Uma refernci a pa ra o objeto Ta g que
es t s ofrendo a es cri ta . Por exempl o,
pode-s e a ces s a r a propri eda de do Ta g
us a ndo a s i nta xe Tag.DocString.
Um va l or Bool ea no que i ndi ca s uces s o
ou fa l ha na es cri ta .

385

NOME
User

DESCRIO
Pa r metro que recebe o us u ri o que fez
a es cri ta . O va l or pa dr o des te
pa r metro "Sys tem". Se n o houver
nenhum us u ri o l oga do no Vi ewer que
gerou o evento, es te pa r metro contm o
va l or "Anonymous ". Se a es cri ta for
a s s ncrona , ou s e ocorreu uma fa l ha
reporta da de forma a s s ncrona , es te
pa r metro s empre contm o va l or
"Sys tem".

5.5.2.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Driver de
Comunicao OPC.

5.5.2.2.1 CallTimeout
Especifica o tempo limite para a resposta de qualquer chamada ou acesso a um
servidor OPC, como por exemplo escritas, criao de Grupos OPC, criao, remoo
e browsing de Tags, mudana no modo Advise dos Tags, etc. Caso este tempo seja
excedido, o E3 considera o servidor como travado (indisponvel) e inicia o processo
de reconexo. O valor desta propriedade no pode ser negativo. Configurar esta
propriedade com o valor 0 (zero) desabilita este tempo limite, fazendo com que
acessos ao servidor OPC possam demorar um tempo indefinido, eventualmente
travando todo o aplicativo caso este acesso seja sncrono. O valor padro desta
propriedade 10000 (10 segundos). Aplicaes criadas em verses anteriores, ao
serem carregadas na verso atual, assumem o valor 0 (zero) por questes de
compatibilidade. Este valor deve ser ajustado com cuidado, para que no tranque a
aplicao e nem force uma desconexo sem necessidade, caso o servidor OPC
realmente demore para responder determinadas requisies.

5.5.2.2.2 Compatibility
Permite controlar o uso das interfaces padro OPC pelo Cliente OPC do E3. As
opes disponveis so as seguintes:
0 - AnyVersion: Funcionamento normal (recomendado), o Driver de
Comunicao OPC comunica com servidores DA 2.0x e 1.0a (dando
preferncia ao uso de interfaces 2.0x)
1 - Version10A: Permite forar a comunicao no padro DA 1.0a para
servidores que suportam DA 2.0x e 1.0a
2 - Version20: Permite forar a comunicao apenas no padro OPC DA 2.0
Esta propriedade no pode ser modificada quando a comunicao do cliente OPC
386

Objetos de Servidor

estiver habilitada (tanto no Studio quanto em tempo de execuo).


NOTA: Apena s em l ti mo ca s o o Dri ver de Comuni ca o OPC deve s er confi gura do
com um va l or di ferente de 0 - AnyVersion (va l or pa dr o). Es ta propri eda de de us o
a va na do, e s e a pl i ca res tri ta mente pa ra contorna r a l guma s i tua o de pos s vel
i ncompa ti bi l i da de com a l gum s ervi dor OPC es pecfi co.

5.5.2.2.3 ConnectionTimeout
Especifica o tempo mximo para estabelecer uma conexo com um servidor OPC,
incluindo todos os passos da conexo, mesmo os passos antes do acesso ao
servidor em si, como acesso ao servio OPCENUM ou ao Registro do Windows. O
valor desta propriedade no pode ser negativo. Configurar esta propriedade com o
valor 0 (zero) desabilita este tempo, fazendo com que o limite seja o efetivo tempo
de retorno de erro pelos servios necessrios para acessar o servidor OPC. O valor
padro 10000 (10 segundos). Aplicaes criadas em verses anteriores, ao serem
carregadas na verso atual, assumem o valor 0 (zero) por questes de
compatibilidade.

5.5.2.2.4 ReconnectPeriod
Controla o perodo da conexo com o Servidor OPC. Se a conexo for perdida, o
Driver de Comunicao OPC para e reinicia at que esta ao retorne sucesso. O
perodo configurado em milissegundos e quando o valor configurado para 0
(zero), a reconexo desabilitada. Pelo fato do Driver de Comunicao OPC ser
parado e iniciado, os eventos BeforeStart e AfterStop so gerados. Quando a
conexo for perdida, todos os Tags relacionados so desconectados do seu estado
atual (bad/quality/null value). Exemplo:
Sub DriverOPC1_AfterStart()
Application.GetObject("DriverOPC1.GrupoOPC1")._
ReconnectPeriod = 0
End Sub

5.5.2.2.5 ServerId
Determina o servidor ao qual o Driver de Comunicao OPC deve se conectar.
Apesar de o valor padro da propriedade ser vazio, se este valor estiver vazio o
Driver de Comunicao OPC no vai se conectar. Esta propriedade s pode ser
modificada quando o Driver de Comunicao OPC no est conectado. Exemplo:
Sub CommandButton1_Click()
Set Opc = Application.GetObject("DriverOPC1")
Opc.Deactivate
Opc.ServerId = "ElipseSCADA.OPCSvr.1"
Opc.ServerMachine = "\\server2"
Opc.Activate
End Sub

Objetos de Servidor

387

5.5.2.2.6 ServerMachine
Esta propriedade determina o endereo da estao onde est rodando o servidor
OPC. Para aplicaes que esto rodando localmente, esta propriedade pode ficar
em branco (padro). Caso contrrio, necessrio especificar o caminho (por
exemplo, "\\NomeServidor"). Esta propriedade s pode ser modificada quando o
Driver de Comunicao OPC estiver desconectado. Exemplo:
Sub CommandButton1_Click()
Set Opc = Application.GetObject("DriverOPC1")
Opc.Deactivate
Opc.ServerId = "ElipseSCADA.OPCSvr.1"
Opc.ServerMachine = "\\server2"
Opc.Activate
End Sub

5.5.2.2.7 ServerName
Esta propriedade retorna o nome ou a descrio do servidor OPC. Esta
propriedade diferente da propriedade ServerID, que um cdigo. Exemplo:
Sub Driver OPC1_AfterStart()
MsgBox _
Application.GetObject("DriverOPC1.GrupoOPC1").ServerName
End Sub

5.5.2.2.8 ServerStatus
Determina o estado da conexo com o servidor OPC. As opes disponveis
esto descritas na tabela a seguir.
Opes disponveis para ServerStatus
OPO
-1 - ServerStatus_Unknown

0 - ServerStatus_NotConnected

DESCRIO
O Dri ver de Comuni ca o OPC es t
conecta do a o s ervi dor OPC ma s o es ta do
n o i nforma do ou o cl i ente OPC pos s ui
a propri eda de ReconnectPeriod em 0
(zero).
O Dri ver de Comuni ca o OPC n o es t
conecta do a o s ervi dor OPC. Is to a contece
qua ndo, por exempl o, o Dri ver de
Comuni ca o OPC n o es t a ti vo, ou a
conex o n o foi es ta bel eci da por a l gum
probl ema qua l quer.

Os valores a seguir so informados apenas quando a propriedade ReconnectPeriod


diferente de 0 (zero). Esta passagem de perodo especificando o estado buscada
no servidor. Caso o estado no seja informado corretamente, a propriedade pode
388

Objetos de Servidor

manter o valor igual a -1, ou a desconexo pode ser detectada neste caso, levando
a propriedade ServerStatus para 0 (zero). Os valores so baseados nos cinco
estados padro definidos para servidores OPC.
Opes disponveis para ReconnectPeriod diferente de zero
OPO
1 - ServerStatus_Running
2 - ServerStatus_Failed
3 - ServerStatus_NoConfig
4 - ServerStatus_Suspended
5 - ServerStatus_Test

DESCRIO
O s ervi dor es t roda ndo norma l mente.
O s ervi dor n o es t roda ndo. Um erro
n o es peci fi ca do ocorreu no s ervi dor.
O s ervi dor es t roda ndo, porm s em
i nforma es de confi gura o.
O s ervi dor foi s us pens o
tempora ri a mente.
O s ervi dor es t em modo de tes te.

Exemplo:
Sub CommandButton1_Click()
Dim status
status = Application.GetObject("DriverOPC1").ServerStatus
MsgBox "O status do driver " & status
Select Case status
Case -1
MsgBox "O DriverOPC est conectado ao servidor OPC_
mas seu estado no foi informado."
Case 0
MsgBox "O DriverOPC no est conectado ao servidor OPC"
Case 1
MsgBox "O servidor est rodando normalmente"
Case 2
MsgBox "O servidor no est rodando"
Case 3
MsgBox "O servidor est rodando mas sem_
informaes de configurao"
Case 4
MsgBox "O servidor foi suspenso temporariamente"
Case 5
MsgBox "O servidor est em Modo de Testes"
End Select
End Sub
NOTA: Pa ra obter o comporta mento equi va l ente a uma propri eda de Bool ea na , o
recomenda do us a r ServerStatus di ferente de 0 (zero). Is to ba s i ca mente di ferenci a
a pena s entre ha ver a conex o ou n o, des cons i dera ndo es ta dos ma i s es pecfi cos
do s ervi dor. Al m di s to, a expres s o i ndepende do us o da propri eda de
ReconnectPeriod di ferente de 0 (zero).

Objetos de Servidor

389

5.5.2.2.9 WriteFeedbackMode
Esta propriedade permite controlar a confirmao (ou feedback) das escritas em
Tags. As opes de configuraco desta propriedade esto descritas na tabela a
seguir.
Opes disponveis para a propriedade WriteFeedbackMode
OPO
0 - wfWaitNextRead
1 - wfImmediateReadAfterWrite
2 - wfTrustWriteSuccess

DESCRIO
Aps a es cri ta , a gua rda norma l mente a
prxi ma l ei tura .
Fora uma l ei tura a s s ncrona de
di s pos i ti vo l ogo a ps ca da es cri ta .
O va l or es cri to a s s umi do pel o Ta g
i medi a ta mente, ca s o a es cri ta tenha
funci ona do.

O valor padro desta propriedade 0 - wfWaitNextRead para aplicativos criados


antes da implementao desta propriedade, e 1 - wfImmediateReadAfterWrite
para aplicativos criados a partir de sua implementao.
NOTAS:
A propri eda de WriteFeedbackMode do Dri ver de Comuni ca o OPC n o pode s er
a l tera da com o objeto a ti vo.
Na op o 2 - wfTrustWriteSuccess, no ca s o de es cri ta s a s s ncrona s , o va l or
a s s umi do no Ta g a ps o a genda mento da es cri ta , s e a opera o foi bem
s ucedi da . Porm, s e a es cri ta fa l ha r pos teri ormente, o va l or no Ta g pode fi ca r
erra do. No ca s o da es cri ta s ncrona , o va l or a s s umi do l ogo a ps o trmi no da
es cri ta , s e houver s uces s o.
Veja ta mbm a propri eda de WriteFeedbackMode do objeto Dri ver de Comuni ca o,
cujo comporta mento s emel ha nte.

5.5.2.3 Grupo OPC


Esta seo contm informaes sobre os mtodos e propriedades do objeto Grupo
OPC. Este objeto no possui eventos associados.

5.5.2.3.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Grupo OPC.
5.5.2.3.1.1 Refresh
Refresh(Source)
Fora o servidor a reenviar os valores de todos os Tags do Grupo OPC que estejam
com a leitura habilitada, tenham eles mudado de valor ou no. O parmetro Source
390
Objetos de Servidor

determina o argumento da fonte de dados do Driver de Comunicao OPC. Se o


valor informado for 1 (RefreshFromCache), os valores enviados so os valores do
cache do servidor. Do contrrio, se o valor informado for 2 (RefreshFromDevice), os
valores enviados so atualizados no cache do servidor antes de serem enviados.
Para que este mtodo funcione, a propriedade Enable do Grupo OPC, bem como a
leitura de pelo menos um Tag do Grupo OPC, deve estar habilitada. Para maiores
informaes sobre o mecanismo de habilitao de leitura (modo Advise), veja as
propriedades AllowRead e AdviseType do Tag.

5.5.2.3.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Grupo OPC.
5.5.2.3.2.1 BlockMode
Esta propriedade determina o comportamento de ativao ou desativao do
Grupo OPC. Quando esta propriedade estiver configurada para Verdadeiro, a
comunicao dos Tags do Grupo OPC iniciada em conjunto. Isto em geral
ocasiona uma melhor performance (menor tempo de ativao), por minimizar o
nmero de chamadas ao servidor OPC. Quando a propriedade estiver configurada
para Falso, o comportamento de ativar a comunicao de cada Tag do Grupo OPC
individualmente (de acordo com a sequncia normal de ativao dos objetos). Com
isto, por exemplo, o primeiro Tag do Grupo OPC (na ordem vista no Organizer)
comunica antes do ltimo Tag. Apesar de mais lento, pode ser uma vantagem usar
este modo de ativao do Bloco de Comunicao OPC quando se deseja executar
alguma operao (uma escrita no Tag, por exemplo) em um script do evento
OnStartRunning do Tag. Na desativao ocorre tudo de maneira anloga. Quando o
valor da propriedade Verdadeiro, a desativao da comunicao dos Tags do
Grupo OPC ocorre em conjunto, ao trmino da desativao de todo o Grupo OPC.
Caso a propriedade esteja configurada para Falso, a desativao da comunicao
ocorre individualmente para cada Tag (de acordo com a sequncia normal de
desativao de objetos).
5.5.2.3.2.2 DeadBand
Esta propriedade permite ajustar o nvel mnimo de variao de um Tag OPC, para
que este seja atualizado. Essa propriedade s se aplica para os Tags do Grupo OPC
que forem considerados do tipo analgico pelo servidor OPC ao qual o Driver de
Comunicao OPC est conectado. O intervalo vlido para esta propriedade entre
0 e 100%. Um valor de 0 (zero) para esta propriedade significa que qualquer
variao do valor de um Tag do Grupo OPC implica na atualizao do Grupo OPC.
Este valor percentual aplicado para cada Tag em relao aos seus limites de
engenharia (que esto definidos no servidor OPC). Para que um Tag seja atualizado,
a seguinte expresso deve ser verdadeira (isto avaliado no servidor OPC):
Abs(Valor_guardado_anteriormente Valor_corrente) >
(DeadBand / 100) * Abs(Limite_Superior Limite_Inferior)

Objetos de Servidor

391

O valor padro desta propriedade 0 (zero).


5.5.2.3.2.3 Enable
Esta propriedade habilita a atualizao dos Tags dentro de um Grupo OPC. Se
esta propriedade estiver em Falso, nenhum Tag dentro do Grupo OPC atualizado.
Caso contrrio, os Tags que tenham a propriedade AllowRead configurada para
Verdadeiro e que estejam em modo Advise (para maiores informaes, ver a
propriedade AdviseType) so mantidos atualizados de acordo com o tempo de
atualizao (propriedade Scan) e a banda morta (propriedade DeadBand) do Grupo
OPC. Estando esta propriedade em Falso, no possvel utilizar o mtodo Refresh
do Grupo OPC.
5.5.2.3.2.4 RealScan
Tempo de varredura efetivamente utilizado pelo servidor OPC.
5.5.2.3.2.5 Scan
Especifica o tempo de varredura de atualizao dos Tags do Grupo OPC que
utilizado pelo servidor. Esta propriedade representada em milissegundos e pode
ser modificada aps iniciada a comunicao, sendo utilizada apenas quando a
propriedade Enable estiver configurada para Verdadeiro.
Ao configurar esta propriedade nos diversos Tags presentes na aplicao,
recomenda-se aumentar o valor desta propriedade para aqueles Grupos OPC de
Tags que no variam muito no equipamento ou dispositivo, possibilitando assim
que outros Grupos OPC de Tags de maior prioridade sejam lidos com maior
frequncia, aumentando assim a performance e a resposta da aplicao. O valor
padro desta propriedade 1000.

5.5.2.3.3 Bloco de Comunicao OPC


Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Bloco de Comunicao OPC.
5.5.2.3.3.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Bloco de Comunicao
OPC.

OnRead
OnRead()
Ocorre quando um valor do Bloco de Comunicao OPC recebido do Servidor OPC.
Utilize o evento OnRead quando for necessrio efetuar alguma operao logo aps
algum dado ter sido modificado no objeto Bloco de Comunicao OPC
392

Objetos de Servidor

(propriedades Bit00 at Bit31, Quality, RawValue, TimeStamp e Value de algum


Elemento do Bloco de Comunicao OPC).
5.5.2.3.3.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Bloco de Comunicao
OPC.

Write
Write()
Executa a escrita do valor corrente do Bloco de Comunicao OPC no equipamento.
Para maiores detalhes, consulte a documentao do Driver. Este mtodo retorna
um Booleano que indica o sucesso ou no da operao.

WriteEx
WriteEx([Value[, SyncWrite]])
Executa a escrita de um valor no equipamento. Todos os seus parmetros so
opcionais. Se omitidos, o comportamento do mtodo igual ao do mtodo Write.
Este mtodo retorna um Booleano que indica o sucesso ou no da operao. O
parmetro Value define o valor a ser escrito no Driver de Comunicao OPC. O tipo
de dado depende do Driver. Se omitido, assumido o valor corrente do Bloco de
Comunicao OPC. O parmetro SyncWrite um Booleano que especifica se a
operao descrita deve ser sncrona (Verdadeiro) ou assncrona (Falso). Se for
omitido, usado o valor especificado na propriedade SyncWrite do Bloco de
Comunicao OPC.
NOTA: As s i m como no mtodo Write, a es cri ta fei ta i ndependente de o va l or s er
di ferente do va l or a tua l do Bl oco de Comuni ca o OPC, bem como i ndependente da
propri eda de AllowWrite do Bl oco de Comuni ca o OPC s er Verda dei ra ou Fa l s a .
Al m di s to, s e a es cri ta funci ona ma s o Bl oco de Comuni ca o OPC n o es t em scan
(s eja porque a propri eda de AllowRead Fa l s a , ou porque us a a op o
AdviseWhenLinked qua ndo n o es t s endo a s s oci a do), o va l or es cri to a s s umi do
i medi a ta mente com qua l i da de boa e timestamp do momento da es cri ta .

5.5.2.3.3.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Bloco de
Comunicao OPC.

AdviseType
Controla o modo Advise. As opes disponveis esto descritas na tabela a
seguir.

Objetos de Servidor

393

Opes disponveis para a propriedade AdviseType


OPO
0 - AlwaysInAdvise

1 - AdviseWhenLinked

DESCRIO
O Ta g ma nti do a tua l i za do s e a
propri eda de AllowRead do Bl oco de
Comuni ca o OPC for Verda dei ra e a
propri eda de Enabled do Grupo OPC
ta mbm for Verda dei ra .
O Ta g s a tua l i za do s e a propri eda de
AllowRead do Bl oco de Comuni ca o OPC
e a propri eda de Enabled do Grupo OPC
forem Verda dei ra s , e o Ta g es ti ver
a s s oci a do a a l gum objeto a ti vo, como
por exempl o um Di s pl a y de uma Tel a
a berta ou um Al a rme ha bi l i ta do, entre
outros . A a s s oci a o do Ta g pa ra es te
props i to pode s er fei ta na s s egui ntes
propri eda des : Value, RawValue, Quality e
Bit00 at Bit31 de El ementos de Bl oco de
Comuni ca o OPC, e Quality e TimeStamp
de Bl ocos de Comuni ca o OPC.

Exemplo:
Sub CommandButton3_Click()
MsgBox Application._
GetObject("DriverOPC.GrupoOPC.SCRIPT1").AdviseType
End Sub

AllowRead
Configure esta propriedade para definir se este Bloco de Comunicao OPC deve
ou no ser lido pelo Driver de Comunicao OPC. Se esta propriedade estiver
configurada para Verdadeiro, ento o Driver automaticamente atualiza as
propriedades Value e Bits (de Bit00 at Bit31) dos Elementos do Bloco de
Comunicao OPC em intervalos de tempo. Caso contrrio, este Bloco de
Comunicao OPC no lido se esta propriedade estiver configurada para Falso.
Esta propriedade pode ser modificada em tempo de execuo. O valor padro desta
propriedade Verdadeiro. Exemplo:
Sub Botao1_Click()
' Faz com que seja parada a leitura do Tag
Set obj = Application.GetObject("Driver1.tag")
obj.AllowRead = False
End Sub

AllowWrite
Configure esta propriedade para definir se este Tag deve ou no ser escrito
automaticamente quando a propriedade Value ou qualquer propriedade Bit (de
Bit00 at Bit31) for modificada. Se a propriedade estiver em Verdadeiro, as
394

Objetos de Servidor

modificaes so enviadas para o equipamento ou dispositivo associado ao Driver


de Comunicao OPC, seno as modificaes so ignoradas. Estando esta
propriedade configurada para Verdadeiro, ento o Driver automaticamente
atualiza as propriedades Value e Bits (de Bit00 at Bit31) deste objeto, em
intervalos de tempo. Caso contrrio, este Bloco de Comunicao OPC no lido. O
valor padro desta propriedade Verdadeiro. Exemplo:
Sub Botao1_Click()
Set obj = Application.GetObject("Driver1.tag")
obj.AllowWrite = False
End Sub

DataType
Propriedade somente de leitura. Determina o tipo de dado associado ao Bloco
de Comunicao OPC, conforme a tabela a seguir.
Opes disponveis para a propriedade DataType
OPO
0 - _Undefined
1 - _Null
2 - _Integer
3 - _Long
4 - _Single
5 - _Double
6 - _Currency
7 - _Date
8 - _String
9 - _Object
10 - _Error
11 - _Boolean
12 - _Variant
13 - _UnkObject
14 - _Decimal
36 - _Record
16 - _Char

Objetos de Servidor

DESCRIO
Va l or uni di mens i ona l n o defi ni do
(va zi o).
Va l or nul o.
Va l or uni di mens i ona l i ntei ro de 16 bi ts
s i na l i za do.
Va l or uni di mens i ona l i ntei ro de 32 bi ts
s i na l i za do.
Va l or uni di mens i ona l de ponto fl utua nte
de 32 bi ts .
Va l or uni di mens i ona l de ponto fl utua nte
de 64 bi ts .
Va l or uni di mens i ona l monet ri o com
qua tro ca s a s deci ma i s .
Va l or de da ta e hora .
Va l or l i tera l (texto).
Va l or uni di mens i ona l de refernci a a um
objeto.
Va l or uni di mens i ona l de cdi go de erro.
Va l or uni di mens i ona l Bool ea no
(verda dei ro ou fa l s o).
Da dos de qua l quer ti po us a dos pa ra
objetos e outros va l ores pa ra os qua i s o
ti po de da dos des conheci do.
Va l or uni di mens i ona l de refernci a a um
objeto.
Va l or uni di mens i ona l de ponto fl utua nte
de 96 bi ts .
Va l or uni di mens i ona l de gra va o.
Va l or uni di mens i ona l i ntei ro de oi to
bi ts .

395

OPO
17 - _Byte
18 - _Word
19 - _Dword
20 - _LongLong
21 - _DDWord
22 - _Integer_
23 - _Uinteger
8194 - _ArrInteger
8195 - _ArrLong
8196 - _ArrSingle
8197 - _ArrDouble
8198 - _ArrCurrency
8199 - _ArrDate
8200 - _ArrString
8201 - _ArrObject
8202 - _ArrError
8203 - _ArrBoolean
8204 - _ArrVariant
8205 - _ArrUnkObject
8206 - _ArrDecimal
8228 - _ArrRecord
8208 - _ArrChar
8209 - _ArrByte

8210 - _ArrWord

396

DESCRIO
Uti l i za do pa ra cri a o de DLLs e pa ra
OLE, ocupa um byte de memri a .
Va l or uni di mens i ona l i ntei ro de 16 bi ts .
Va l or uni di mens i ona l i ntei ro de 32 bi ts .
Va l or uni di mens i ona l i ntei ro de 64 bi ts
s i na l i za do.
Va l or uni di mens i ona l i ntei ro de 64 bi ts .
Nmeros s em deci ma i s , cujo i nterva l o de
ocorrnci a deve es ta r entre -32.768 e
32.767, ocupa doi s bytes .
Nmero i ntei ro s em s i na l (equi va l ente a
um DWord), que va i de 0 (zero) a
4294967295 (232 - 1).
Arra y uni di mens i ona l de va l ores
i ntei ros .
Arra y uni di mens i ona l de va l ores i ntei ros
de 32 bi ts s i na l i za dos .
Arra y uni di mens i ona l de va l ores de
ponto fl utua nte de 32 bi ts .
Arra y uni di mens i ona l de va l ores de
ponto fl utua nte de 64 bi ts .
Arra y uni di mens i ona l de va l ores
monet ri os com qua tro ca s a s deci ma i s .
Arra y uni di mens i ona l de va l ores de da ta
e hora .
Arra y uni di mens i ona l de va l ores l i tera i s
(texto).
Arra y uni di mens i ona l de va l ores de
refernci a a um objeto.
Arra y uni di mens i ona l de va l ores de
cdi go de erro.
Arra y uni di mens i ona l de va l ores
Bool ea nos (verda dei ro ou fa l s o).
Arra y de da dos de qua l quer ti po us a dos
pa ra objetos e outros va l ores pa ra os
qua i s o ti po de da dos des conheci do.
Arra y uni di mens i ona l de va l ores de
refernci a a um objeto.
Arra y uni di mens i ona l de va l ores de
ponto fl utua nte de 96 bi ts .
Arra y uni di mens i ona l de va l ores record.
Arra y uni di mens i ona l de va l ores char.
Arra y uni di mens i ona l de bytes , que s o
va l ores uti l i za dos pa ra cri a o de DLLs e
pa ra OLE, ocupa um byte de memri a .
Arra y uni di mens i ona l de va l ores i ntei ros
de 32 bi ts .

Objetos de Servidor

OPO
8211 - _ArrDWord
8212 - _ArrLongLong
8213 - _ArrDDWord
8214 - _ArrInteger_
8215 - _ArrUInteger

DESCRIO
Arra y uni di mens i ona l de va l ores i ntei ros
de 32 bi ts .
Arra y uni di mens i ona l de va l ores i ntei ros
de 16 bi ts .
Arra y uni di mens i ona l de va l ores i ntei ros
de 32 bi ts s i na l i za dos .
Arra y uni di mens i ona l de va l ores i ntei ros
de 16 bi ts s i na l i za dos .
Arra y uni di mens i ona l de nmeros
i ntei ros s em s i na l (equi va l ente a um
DWord), que va i de 0 (zero) a 4294967295
(232 -1).

EnableDriverEvent
Esta propriedade utilizada para controlar a gerao do evento OnTagRead, que
ocorre no Driver de Comunicao OPC que contm o Bloco de Comunicao OPC. Se
a propriedade EnableDriverEvent do Bloco de Comunicao OPC estiver
configurada para Verdadeiro, a cada leitura vinda do servidor OPC, seja com erro
ou no, gerado o evento OnTagRead no objeto Driver de Comunicao OPC que
contm este Bloco de Comunicao OPC. Caso contrrio, o evento no ocorre.
Tambm quando a propriedade EnableDriverEvent tiver o valor Verdadeiro, a cada
escrita que seja enviada para o servidor OPC gerado o evento OnTagWrite no
objeto Driver de Comunicao OPC que contm o Bloco de Comunicao OPC. Se a
escrita for assncrona, o evento OnTagWrite gerado apenas quando o servidor
enviar a resposta indicando o efetivo sucesso ou no da escrita. Neste caso, o
evento gerado apenas se a propriedade EnableDriverEvent for Verdadeira neste
momento, e no no momento do envio da escrita. O valor padro desta propriedade
Falso.

ItemID
Esta propriedade determina o caminho que identifica o Bloco de Comunicao
OPC no servidor ao qual o Driver de Comunicao OPC se conecta. A definio
deste caminho flexvel e depende do servidor especfico. Normalmente, os
servidores especificam um espao de ID com itens hierrquicos, do tipo
ItemPai.ItemFilho.Tag1. A propriedade ItemID funciona como uma chave nica para
os dados, considerando o onde ou o qu permite ao servidor OPC se conectar
fonte dos dados. Apesar de o valor padro ser vazio, necessrio especificar algum
valor para que o Bloco de Comunicao OPC seja vlido.

Quality
Esta propriedade informa qual a qualidade do valor contido na propriedade
Value. Cada vez que o Driver de Comunicao OPC atribui um novo valor para o
Bloco de Comunicao OPC, ele tambm configura a qualidade daquele dado. Esta
propriedade somente para leitura. O valor padro desta propriedade 0 (zero,
qualidade ruim).
Objetos de Servidor

397

NOTA: Pa ra ma i ores i nforma es s obre qua l i da de, cons ul te o tpi co Qualidade no


Manual do Usurio do E3.

Size
Define o tamanho do conjunto de valores do Bloco de Comunicao OPC. Consulte
a documentao do Driver utilizado, para conhecer qual o limite para esta
propriedade, de acordo com os parmetros B1 at B4. Criando os Elementos para o
Bloco de Comunicao OPC, possibilita-se acessar os valores lidos e tambm
permite a escrita de valores para o equipamento ou dispositivo. Esta propriedade
no pode ser modificada aps iniciada a comunicao. O valor padro desta
propriedade 0 (zero). Exemplo:
Sub BlocoOPC1_OnStartRunning()
Size = 12
End Sub

SyncWrite
Esta propriedade determina o tipo de escrita usada por um Bloco de
Comunicao OPC. Se a propriedade estiver configurada para Verdadeiro, a escrita
sncrona, isto , o Driver de Comunicao OPC espera o resultado da escrita do
servidor. Caso contrrio, a escrita assncrona, isto , o valor do Tag de
Comunicao OPC enviado e o processamento do Driver de Comunicao OPC
continua imediatamente. O valor padro desta propriedade Falso.
NOTA: No modo a s s ncrono (propri eda de des a bi l i ta da ), a performa nce da
comuni ca o tende a s er mel hor, porm no modo s ncrono (propri eda de
ha bi l i ta da ), o s uces s o da opera o de es cri ta veri fi ca do e i nforma do.

TimeStamp
Esta propriedade atualizada sempre que ocorrer alguma mudana de valor ou
de estado nas propriedades Value ou Quality. Esta propriedade informa qual a data
e hora associada tanto ao valor quanto qualidade do Bloco de Comunicao OPC.
Esta uma propriedade somente para leitura. O valor padro desta propriedade
"00:00:00".
5.5.2.3.3.4 Elemento de Bloco de Comunicao OPC
Esta seo contm informaes sobre eventos e propriedades do objeto Elemento
de Bloco de Comunicao OPC. Este objeto no possui mtodos associados.

Eventos
Esta seo contm informaes sobre os eventos do objeto Elemento de Bloco de
Comunicao OPC.

398

Objetos de Servidor

OnRead
OnRead()
Ocorre quando um valor do Elemento de Bloco de Comunicao OPC recebido
pelo Servidor OPC. Utilize o evento OnRead quando for necessrio efetuar alguma
operao logo aps algum dado ter sido modificado no objeto Elemento de Bloco
de Comunicao OPC (propriedades Bit00 at Bit31, Quality, RawValue ou Value).

Propriedades
Esta seo contm as propriedades do objeto Elemento de Bloco de Comunicao
OPC.

Bit00 at Bit31
Estas propriedades representam juntas os 32 bits do valor presente na
propriedade Value do objeto Elemento de Bloco de Comunicao OPC, sendo Bit00 o
bit menos significativo e Bit31 o bit mais significativo. Modificar cada um destes
bits implica na igual modificao da propriedade Value do Elemento de Bloco de
Comunicao OPC e vice-versa, mas isto somente ocorre quando a propriedade
UseBitFields estiver configurada para Verdadeiro. O valor padro destas
propriedades Falso.

DeviceHigh
Esta propriedade define o valor mximo atingido por um Elemento de Bloco de
Comunicao OPC no equipamento ou no dispositivo. Esta propriedade utilizada
para fazer o ajuste de escala do valor proveniente do equipamento ou dispositivo
antes de ser atribudo propriedade Value. Da mesma forma, no momento da
escrita feita a operao inversa antes de enviar o valor para o Driver. Esta
converso s ocorre quando a propriedade EnableScaling est configurada para
Verdadeiro. O valor padro desta propriedade 1000. Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prtica
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

DeviceLow
Esta propriedade define o valor mnimo atingido por um Elemento de Bloco de
Comunicao OPC no equipamento ou no dispositivo. Esta propriedade utilizada
Objetos de Servidor

399

para executar o ajuste de escala do valor proveniente do equipamento ou


dispositivo antes de ser atribudo propriedade Value. Da mesma forma, no
momento da escrita feita a operao inversa antes de enviar o valor para o
Driver. Esta converso s ocorre quando a propriedade EnableScaling est
configurada para Verdadeiro. O valor padro desta propriedade 0 (zero).
Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prtica
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

EnableScaling
Esta propriedade habilita ou desabilita a escala de valor para o valor enviado e
recebido do equipamento ou dispositivo. Se esta propriedade estiver configurada
para Verdadeiro, todo valor proveniente do equipamento ou dispositivo sofre
ajuste de escala conforme as propriedades DeviceHigh, DeviceLow, EUHigh e EULow
antes de ser atribudo propriedade Value. O mesmo ocorre quando uma escrita
for necessria, quando o valor presente em Value sofre ajuste de escala (sem com
isso alterar a propriedade Value) e posteriormente enviado para o equipamento
ou dispositivo. Caso a propriedade EnableScaling tenha o valor Falso, nenhum
ajuste de escala efetuado em nenhum dos dois sentidos (escrita e leitura). O valor
padro desta propriedade Falso. Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prtica
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

EU
Identifica a unidade de engenharia representada por este valor, como por
exemplo, graus, metros, KW/h, etc. Exemplo:
400

Objetos de Servidor

Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prtica
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

EUHigh
Define qual o valor mximo que deve ser atribudo propriedade Value,
ajustando a escala ao valor do equipamento ou do dispositivo antes desta
atribuio. Da mesma forma, no momento da escrita feita a operao inversa
antes de enviar o valor para o Driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para Verdadeiro. O valor padro desta
propriedade 1000. Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prtica
' de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EULow = 100
EULow = 0
End Sub

EULow
Define qual o valor mnimo que deve ser atribudo propriedade Value, ajustando
a escala ao valor do equipamento ou do dispositivo antes desta atribuio. Da
mesma forma, no momento da escrita feita a operao inversa antes de enviar o
valor para o Driver. Esta converso s ocorre quando a propriedade EnableScaling
est configurada para Verdadeiro. O valor padro desta propriedade 0 (zero).
Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala da
' temperatura de um Elemento
' que varia de 0 a 255 no servidor OPC,
' mas que significa na prtica
' de 0 a 100 graus Celsius
EU = "Graus Celsius"

Objetos de Servidor

401

EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

Index
Utilize esta propriedade para especificar a posio que um Elemento de Bloco de
Comunicao OPC ocupa entre os Elementos configurados pela propriedade Size do
objeto Bloco de Comunicao OPC no qual ele est inserido. Esta propriedade
aceita valores de 0 (zero) at um nmero menor do que o valor definido em Size. Por
exemplo, configurando um Bloco de Comunicao OPC para ter a propriedade Size
igual a 20, o nmero mximo vlido para a propriedade Index 19 e o mnimo 0
(zero). Esta propriedade pode ser alterada aps iniciada a comunicao. O valor
padro da propriedade 0 (zero), porm ao mapear os Elementos de um Bloco de
Comunicao OPC o Studio automaticamente configura a propriedade Index para
um valor de acordo com o especificado. Exemplo:
Sub Elemento1_OnRead()
MsgBox Index
End Sub

Quality
Esta propriedade representa o estado de qualidade do valor contido na
propriedade Value.
NOTA: Pa ra ma i ores i nforma es s obre qua l i da de, cons ul te o tpi co Qualidade no
Manual do Usurio do E3.

RawValue
Acessa o valor original do Elemento de Bloco de Comunicao OPC anterior
escala, ou seja, independente da configurao da propriedade EnableScaling. Ento,
se esta propriedade for Falsa, as propriedades Value e RawValue apresentam o
mesmo comportamento.

UseBitFields
Caso esta propriedade tenha o valor Verdadeiro, toda vez que o valor da
propriedade Value for modificada, ela atualiza os bits referentes s propriedades
Bit00 at Bit31. Da mesma forma, atualiza o valor de Value toda vez que alguma
das propriedades Bit00 at Bit31 mudar de valor e posteriormente envia para o
equipamento ou dispositivo se a propriedade AllowWrite do Bloco de Comunicao
OPC estiver configurada para Verdadeiro. Caso contrrio, se esta propriedade
estiver configurada para Falso, os bits no sofrem nem acarretam qualquer
mudana. Esta propriedade pode ser atualizada aps ter sido iniciada a
comunicao. O valor padro desta propriedade Falso.

402

Objetos de Servidor

Value
Atualizada sempre que um novo valor lido no servidor OPC, de acordo com a
especificao da propriedade ItemID do Bloco de Comunicao OPC onde este
objeto est inserido, e considerando a propriedade Index, que especifica a posio
do Elemento no vetor do Bloco de Comunicao OPC. O tipo desta propriedade
(nmero inteiro, ponto flutuante, texto, etc.) depende do Driver ao qual ele est
associado e da sua configurao.
Esta propriedade somente atualizada desta forma se a propriedade AllowRead do
objeto Bloco de Comunicao OPC ao qual o Elemento de Bloco de Comunicao
OPC pertence estiver configurada para Verdadeiro, e de acordo com o tempo de
varredura definido na propriedade Scan do Grupo OPC que contm o Bloco de
Comunicao OPC. Se a propriedade AllowWrite do objeto Bloco de Comunicao
OPC estiver configurada em Verdadeiro, pode-se escrever valores no equipamento
ou no dispositivo simplesmente atribuindo um novo valor para a propriedade
Value.
Esta tambm a propriedade padro do objeto Elemento de Bloco OPC. Sendo
assim, uma referncia por valor a um objeto Elemento de Bloco OPC no necessita
obrigatoriamente explicitar a propriedade Value para acessar o valor. Caso esta
propriedade no esteja sendo atualizada, verifique se a propriedade Index est
corretamente configurada (seu valor deve ser entre zero e o tamanho do Bloco de
Comunicao OPC menos um). Exemplo:
Sub Botao1_Click()
' Acessa um elemento e mostra o valor atual
' elm1 um objeto do tipo Elemento de Bloco OPC
Set obj = Application.GetObject_
("OPCDriver1.Grupo1.BlocoOPC1.elm1")
MsgBox "Valor atual de elm1: " & obj.Value
' Isto tambm pode ser feito de outra forma,
' sem mostrar a propriedade Value, que padro
MsgBox "Valor atual de elm1: " & obj
End Sub

5.5.2.3.4 Tag de Comunicao OPC


Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Tag de Comunicao OPC.
5.5.2.3.4.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Tag de Comunicao
OPC.

OnRead
OnRead()
Ocorre quando um valor do Tag de Comunicao OPC recebido do Servidor OPC.
Objetos de Servidor

403

Utilize o evento OnRead quando for necessrio efetuar alguma operao logo aps
algum dado ter sido modificado no objeto Tag de Comunicao OPC (propriedades
Bit00 at Bit31, Quality, RawValue, TimeStamp ou Value).
5.5.2.3.4.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Tag de Comunicao
OPC.

Write
Write()
Executa a escrita do valor corrente do Tag de Comunicao OPC no equipamento.
Para maiores detalhes, consulte a documentao do Driver. Este mtodo retorna
um Booleano que indica o sucesso ou no da operao.

WriteEx
WriteEx([Value[, SyncWrite]])
Executa a escrita de um valor no equipamento. Todos os seus parmetros so
opcionais. Se omitidos, o comportamento do mtodo igual ao do mtodo Write.
Este mtodo retorna um Booleano que indica o sucesso ou no da operao. O
parmetro Value define o valor a ser escrito no Driver. O tipo de dado depende do
Driver. Se omitido, assumido o valor corrente do Tag de Comunicao OPC. O
parmetro SyncWrite um Booleano que especifica se a operao descrita deve ser
sncrona (Verdadeiro) ou assncrona (Falso). Se for omitido, usado o valor
especificado na propriedade SyncWrite do Tag de Comunicao OPC.
NOTA: As s i m como no mtodo Write, a es cri ta fei ta i ndependente de o va l or s er
di ferente do va l or a tua l do Ta g de Comuni ca o OPC, bem como i ndependente da
propri eda de AllowWrite do Ta g s er Verda dei ra ou Fa l s a . Al m di s to, s e a es cri ta
funci ona ma s o Ta g n o es t em scan (s eja porque a propri eda de AllowRead Fa l s a ,
ou porque us a a op o AdviseWhenLinked qua ndo n o es t s endo a s s oci a do), o
va l or es cri to a s s umi do i medi a ta mente com qua l i da de boa e timestamp do
momento da es cri ta .

5.5.2.3.4.3 Propriedades
Esta seo contm as propriedades do objeto Tag de Comunicao OPC.

AdviseType
Controla o modo Advise. As opes disponveis esto descritas na tabela a
seguir.

404

Objetos de Servidor

Opes disponveis para a propriedade AdviseType


OPO
0 - AlwaysInAdvise

1 - AdviseWhenLinked

DESCRIO
O Ta g de Comuni ca o OPC ma nti do
a tua l i za do s e a propri eda de AllowRead
for Verda dei ra e a propri eda de Enable do
Grupo OPC ta mbm for Verda dei ra .
O Ta g de Comuni ca o OPC s
a tua l i za do s e a propri eda de AllowRead e
a propri eda de Enable do Grupo OPC forem
Verda dei ra s , e o Ta g es ti ver a s s oci a do a
a l gum objeto a ti vo, como por exempl o
um Di s pl a y de uma Tel a a berta ou um
Al a rme ha bi l i ta do, entre outros . A
a s s oci a o do Ta g pa ra es te props i to
pode s er fei ta na s s egui ntes
propri eda des : Value, RawValue,
TimeStamp, Quality e Bit00 at Bit31 de
Ta gs de Comuni ca o OPC.

Exemplo:
Sub CommandButton3_Click()
MsgBox Application._
GetObject("DriverOPC.GrupoOPC.TagOPC1").AdviseType
End Sub

AllowRead
Define se este Tag de Comunicao OPC deve ou no ser lido pelo Driver de
Comunicao OPC. Caso a propriedade esteja configurada para Verdadeiro, o
Driver automaticamente atualiza as propriedades Value e Bits (de Bit00 at Bit31)
deste objeto em intervalos de tempo. Caso contrrio, este Tag de Comunicao OPC
no lido. Esta propriedade pode ser modificada em tempo de execuo. O valor
padro desta propriedade Verdadeiro. Exemplo:
Sub Botao1_Click()
' Faz com que seja parada a leitura do tag
Set obj = Application.GetObject("Driver1.tag")
obj.AllowRead = False
End Sub

AllowWrite
Define se este Tag de Comunicao OPC deve ou no ser escrito automaticamente
quando a propriedade Value ou qualquer propriedade Bit (de Bit00 at Bit31) for
modificada. Se a propriedade estiver em Verdadeiro, as modificaes so enviadas
para o equipamento ou dispositivo associado ao Driver de Comunicao OPC. Do
contrrio, as modificaes so ignoradas. O valor padro desta propriedade
Verdadeiro. Exemplo:
Sub Botao1_Click()

Objetos de Servidor

405

' Faz com que seja desabilitada a escrita do tag


Set obj = Application.GetObject("Driver1.tag")
obj.AllowWrite = False
End Sub

Bit00 at Bit31
Estas propriedades representam juntas os 32 bits do valor presente na
propriedade Value do objeto Tag de Comunicao OPC, sendo Bit00 o bit menos
significativo e Bit31 o bit mais significativo. Modificar cada um destes bits implica
na igual modificao da propriedade Value do Tag e vice-versa, mas isto somente
ocorre quando a propriedade UseBitFields estiver configurada para Verdadeiro. O
valor padro destas propriedades Falso.
NOTA: Os va l ores dos bi ts (propri eda des Bit00 a t Bit31) n o s o a feta dos pel o
a jus te de es ca l a , i s to , repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers o.

DataType
Propriedade somente de leitura. Determina o tipo de dado associado ao Tag de
Comunicao OPC. Veja a tabela Opes disponveis para a propriedade DataType
na propriedade DataType do objeto Bloco de Comunicao OPC para os valores
possveis desta propriedade.

DeviceHigh
Esta propriedade define o valor mximo atingido por um Tag de Comunicao
OPC no equipamento ou no dispositivo. Esta propriedade utilizada para executar
o ajuste de escala do valor proveniente do equipamento ou do dispositivo antes de
ser atribudo propriedade Value. Da mesma forma, no momento da escrita feita
a operao inversa antes de enviar o valor para o Driver. Esta converso s ocorre
quando a propriedade EnableScaling estiver configurada para Verdadeiro, seno os
valores permanecem os mesmos. O valor padro desta propriedade 1000.
Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 at Bit31) n o s o a feta dos pel o
a jus te de es ca l a , i s to , repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers o.

406

Objetos de Servidor

DeviceLow
Esta propriedade define o valor mnimo atingido por um Tag de Comunicao
OPC no equipamento ou no dispositivo. Esta propriedade utilizada para executar
o ajuste de escala do valor proveniente do equipamento ou do dispositivo antes de
ser atribudo propriedade Value. Da mesma forma, no momento da escrita feita
a operao inversa antes de enviar o valor para o Driver. Esta converso s ocorre
quando a propriedade EnableScaling est configurada para Verdadeiro, seno as
configuraes permanecem as mesmas. O valor padro desta propriedade 0
(zero). Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 at Bit31) n o s o a feta dos pel o
a jus te de es ca l a , i s to , repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers o.

EnableDriverEvent
Esta propriedade utilizada para controlar a gerao do evento OnTagRead, que
ocorre no Driver de Comunicao OPC que contm o Tag de Comunicao OPC. Se a
propriedade EnableDriverEvent do Tag estiver configurada para Verdadeiro, a cada
leitura vinda do servidor OPC, seja com erro ou no, gerado o evento OnTagRead
no objeto Driver de Comunicao OPC que contm este Tag. Caso contrrio, o
evento no ocorre. Tambm quando a propriedade EnableDriverEvent tiver o valor
Verdadeiro, a cada escrita que seja enviada para o servidor OPC gerado o evento
OnTagWrite no objeto Driver de Comunicao OPC que contm o Tag. Se a escrita
for assncrona, o evento OnTagWrite gerado apenas quando o servidor enviar a
resposta indicando o efetivo sucesso ou no da escrita. Neste caso, o evento
gerado apenas se a propriedade EnableDriverEvent for Verdadeira neste momento,
e no no momento do envio da escrita. O valor padro desta propriedade Falso.

EnableScaling
Se esta propriedade estiver configurada para Verdadeiro, todo valor proveniente
do equipamento ou do dispositivo sofre ajuste de escala conforme as
propriedades EUHigh e EULow antes de ser atribudo propriedade Value. Caso a
propriedade EnableScaling tenha o valor configurado para Falso, nenhum ajuste de
escala efetuado em nenhum dos dois sentidos (tanto para escrita como para
leitura). O valor padro desta propriedade Falso. Exemplo:
Objetos de Servidor

407

Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

EU
Identifica a unidade de engenharia representada pelo valor, como por exemplo,
graus, metros, KW/h, etc. O valor padro desta propriedade vazio. Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub

EUHigh
Define qual o valor mximo que deve ser atribudo propriedade Value,
ajustando a escala ao valor do equipamento ou do dispositivo antes desta
atribuio. Da mesma forma, no momento da escrita feita a operao inversa
antes de enviar o valor para o Driver. Esta converso s ocorre quando a
propriedade EnableScaling est configurada para Verdadeiro. O valor padro desta
propriedade 1000. Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 at Bit31) n o s o a feta dos pel o
a jus te de es ca l a , i s to , repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers o.

408

Objetos de Servidor

EULow
Define qual o valor mnimo que deve ser atribudo propriedade Value, ajustando
a escala ao valor do equipamento ou do dispositivo antes desta atribuio. Da
mesma forma, no momento da escrita, feita a operao inversa antes de enviar o
valor para o Driver. Esta converso s ocorre quando a propriedade EnableScaling
est configurada para Verdadeiro. O valor padro desta propriedade 0 (zero).
Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prtica de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 at Bit31) n o s o a feta dos pel o
a jus te de es ca l a , i s to , repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers o.

ItemID
Esta propriedade determina o caminho que identifica o Tag de Comunicao OPC
no servidor OPC ao qual o Driver de Comunicao OPC se conecta. A definio
deste caminho flexvel e depende do servidor especfico. Normalmente os
servidores especificam um espao de ID com itens hierrquicos, do tipo
ItemPai.ItemFilho.Tag1. Esta propriedade funciona como uma chave nica para os
dados, considerando o onde ou o qu permite o servidor OPC se conectar fonte
dos dados. Apesar de o valor padro ser vazio, necessrio especificar algum
valor para que o Tag de Comunicao OPC seja vlido.

Quality
Esta propriedade informa qual a qualidade do valor contido na propriedade
Value. Cada vez que o Driver de Comunicao OPC atribui um novo valor para o Tag
de Comunicao OPC, ele tambm configura a qualidade daquele dado. Esta
propriedade somente para leitura. O valor padro desta propriedade 0 (zero,
qualidade ruim).
NOTA: Pa ra ma i ores i nforma es s obre qua l i da de, cons ul te o tpi co Qualidade no
Manual do Usurio do E3.

RawValue
Acessa o valor original do Tag de Comunicao OPC anterior escala, ou seja,
Objetos de Servidor

409

independente da configurao da propriedade EnableScaling. Ento, se esta


propriedade for Falsa, as propriedades Value e RawValue apresentam o mesmo
comportamento.

SyncWrite
Esta propriedade determina o tipo de escrita usada por um Tag de Comunicao
OPC. Se a propriedade estiver configurada para Verdadeiro, a escrita sncrona,
isto , o Driver de Comunicao OPC espera o resultado da escrita do servidor.
Caso contrrio, a escrita assncrona, isto , o valor do Tag de Comunicao OPC
enviado e o processamento do Driver de Comunicao OPC continua
imediatamente. O valor padro desta propriedade Falso.
NOTA: No modo a s s ncrono (propri eda de confi gura da pa ra Fa l s o), a performa nce da
comuni ca o tende a s er mel hor, porm no modo s ncrono (propri eda de
confi gura da pa ra Verda dei ro), o s uces s o da opera o de es cri ta veri fi ca do e
i nforma do.

TimeStamp
Esta propriedade atualizada sempre que ocorrer alguma mudana de valor ou
de estado nas propriedades Value ou Quality. Esta propriedade informa qual a data
e hora associada tanto ao valor quanto qualidade do Tag de Comunicao OPC.
Esta uma propriedade somente para leitura. O valor padro desta propriedade
"00:00:00".

UseBitFields
Caso esta propriedade tenha o valor Verdadeiro, toda vez que o valor da
propriedade Value for modificada ele atualiza os bits referentes s propriedades
Bit00 at Bit31. Da mesma forma, atualiza o valor de Value toda vez que alguma
das propriedades Bit00 at Bit31 mudar de valor e posteriormente envia para o
equipamento ou dispositivo se a propriedade AllowWrite estiver configurada para
Verdadeiro. Caso contrrio, se esta propriedade estiver configurada para Falso, os
bits no sofrem qualquer mudana. Esta propriedade pode sofrer atualizao aps
ter sido iniciada a comunicao. O valor padro desta propriedade Falso.
Exemplo:
Sub TagOPC1_Click()
UseBitFields = True
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 at Bit31) n o s o a feta dos pel o
a jus te de es ca l a , i s to , repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers o.

Value
Esta propriedade atualizada quando executada uma nova leitura vlida de um
valor do equipamento ou do dispositivo utilizando sua configurao, porm o tipo
410

Objetos de Servidor

desta varivel (nmero inteiro, ponto flutuante ou texto) depende do Driver de


Comunicao OPC ao qual ele est associado e da sua configurao. Esta
propriedade somente atualizada desta forma se a propriedade AllowRead estiver
configurada para Verdadeiro e quando no houver erros de comunicao (neste
caso somente as propriedades Quality e TimeStamp so atualizadas), mas de
acordo com o tempo de varredura definido no Grupo OPC ao qual o Tag de
Comunicao OPC pertence. Outra forma de utilizar esta propriedade escrever
valores no equipamento ou dispositivo. Basta que se atribua um novo valor para a
propriedade Value ou algum dos bits Bit00 at Bit31, desde que a propriedade
AllowWrite esteja configurado para Verdadeiro. Esta propriedade tambm a
propriedade padro do objeto Tag de Comunicao OPC. Sendo assim, uma
referncia por valor a um objeto Tag de Comunicao OPC no necessita
obrigatoriamente explicitar a propriedade Value para acessar o valor. O valor
padro desta propriedade vazio. Exemplo:
Sub Botao1_Click()
' Acessa um tag e mostra o valor atual
' tag1 um objeto tipo OPCTag
Set obj = Application._
GetObject("Driverde_ Comunicacao1.tag1")
MsgBox "Valor atual de tag1: " & obj.Value
' Sem mostrar a propriedade Value, que padro
MsgBox "Valor atual de tag1: " & obj
End Sub

5.5.3 Driver de Comunicao OPC UA


Esta seo contm informaes sobre as propriedades do objeto Driver de
Comunicao OPC UA. Este objeto no possui eventos nem mtodos associados.

5.5.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Driver de
Comunicao OPC UA.

5.5.3.1.1 EndPointURL
Propriedade de leitura e escrita que especifica o caminho (ponto de conexo) do
servidor OPC UA ao qual o cliente ir se conectar. Esta propriedade no pode ser
alterada com a comunicao ativa.

5.5.3.1.2 Password
Propriedade de leitura e escrita que especifica a senha do usurio que ser
usado na conexo com o servidor OPC UA. Essa propriedade usada em conjunto
com a propriedade UserName, e seu valor padro uma String vazia.

Objetos de Servidor

411

NOTA: Es ta propri eda de pode s er a l tera da com a comuni ca o a ti va , ma s es ta


a l tera o s ter efei to qua ndo o Cl i ente OPC UA for rei ni ci a do.

5.5.3.1.3 SecurityMode
Propriedade de leitura e escrita que especifica o modo de segurana que ser
usado na conexo com o servidor OPC UA. Esta propriedade no pode ser alterada
com a comunicao ativa. Os valores possveis para esta propriedade so os
seguintes:
1: usmNone (no utiliza nenhum modo de segurana na conexo)
2: usmSign (utiliza autenticao na conexo)
3: usmSignAndEncrypt (utiliza autenticao e criptografia na conexo)
Esta propriedade usada em conjunto com a propriedade SecurityPolicy para
determinar o tipo de segurana da conexo. O valor padro desta propriedade 1
(usmNone), ou seja, nenhuma segurana.
NOTA: Se a propri eda de SecurityMode for di ferente de usmNone, neces s ri o que o
s ervi dor OPC UA a cei te o certi fi ca do da i ns t nci a do cl i ente E3. A forma como um
certi fi ca do a cei to ou reconheci do por um s ervi dor OPC UA depende do s ervi dor.

5.5.3.1.4 SecurityPolicy
Propriedade de leitura e escrita que especifica a poltica de segurana
(criptografia) usada na conexo com o servidor OPC UA. Esta propriedade no pode
ser alterada com a comunicao ativa. Os valores possveis para esta propriedade
so os seguintes:
1: uspNone (no utiliza criptografia na conexo)
2: uspBasic128Rsa15 (utiliza o algoritmo RSA com chave de 128 bits na conexo)
3: uspBasic256 (utiliza o algoritmo AES com chave de 256 bits na conexo)
Esta propriedade usada em conjunto com a propriedade SecurityMode para
determinar o tipo de segurana da conexo. O valor padro desta propriedade 1
(uspNone), ou seja, nenhuma poltica de segurana.

5.5.3.1.5 TimeoutCall
Propriedade de leitura e escrita que especifica o tempo limite de uma chamada ao
servidor OPC UA, em milissegundos. Esta propriedade no pode ser alterada com a
comunicao ativa, seu valor deve ser maior que 0 (zero) e seu valor padro
10000 (10 segundos).
412

Objetos de Servidor

NOTA: No pa dr o OPC UA, v ri a s cha ma da s permi tem conti nua r a comuni ca o, com
ml ti pl a s res pos ta s do s ervi dor. Des ta forma , es te tempo a ca ba por s er o tempo
l i mi te de res pos ta do s ervi dor OPC UA.

5.5.3.1.6 TimeoutConnection
Propriedade de leitura e escrita que especifica o tempo limite da conexo, em
milissegundos. O valor padro desta propriedade 10000 (10 segundos) e seu
valor deve ser maior que 0 (zero). Esta propriedade no pode ser alterada com a
comunicao ativa.

5.5.3.1.7 TimeoutSession
Propriedade de leitura e escrita que especifica o tempo limite para a renovao
da sesso de comunicao do cliente E3 com o servidor OPC UA, em milissegundos.
O valor padro desta propriedade 600000 (10 minutos) e este valor deve ser
maior que 0 (zero). Esta propriedade no pode ser alterada com a comunicao
ativa.

5.5.3.1.8 UserName
Propriedade de leitura e escrita que especifica o nome do usurio que ser usado
na conexo com o servidor OPC UA. Essa propriedade usada em conjunto com a
propriedade Password. O valor padro desta propriedade uma String vazia.
NOTA: Es ta propri eda de pode s er a l tera da com a comuni ca o a ti va , ma s es ta
a l tera o s ter efei to qua ndo o Cl i ente OPC UA for rei ni ci a do.

5.6 Servidor de Dados


Esta seo contm informaes sobre eventos, mtodos e propriedades dos
seguintes objetos: Consulta, Pasta de Dados, Tag Contador, Tag Demo, Tag Interno e
Tag Timer.

5.6.1 Consulta
Esta seo contm informaes sobre eventos, mtodos e propriedades do objeto
Consulta.

5.6.1.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Consulta.

Objetos de Servidor

413

5.6.1.1.1 OnAsyncQueryFinish
OnAsyncQueryFinish(Recordset, Error)
Ocorre no retorno do mtodo GetAsyncADORecordset. O parmetro Recordset o
ADO Recordset gerado pela Consulta, e o parmetro Error um Booleano que,
quando verdadeiro, mostra que o objeto no conseguiu ser gerado. Exemplo:
Sub Consulta1_OnAsyncQueryFinish(Recordset, Error)
MsgBox "Retornou " + CStr(Recordset.RecordCount) + "
registros"
End Sub

5.6.1.2 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Consulta.

5.6.1.2.1 AddField
AddField(Name[, Table])
O mtodo AddField adiciona um novo campo da tabela na Consulta. O parmetro
Name determina o nome do novo campo que ser adicionado Consulta. O
parmetro Table determina o nome da tabela a que o campo pertence. Este mtodo
foi desenvolvido apenas para manter a compatibilidade com o antigo objeto
Consulta do E3Chart. Exemplo:
Sub Botao1_Click()
Screen.Item("E3Browser").Item("Consulta").AddField "Campo1"
End Sub
NOTA: Es te mtodo i r fa l ha r s e a propri eda de QueryType es ti ver confi gura da pa ra o
va l or 1 - qtStorage.

5.6.1.2.2 AddStorageTag
AddStorageTag(Name, FieldType)
Adiciona um Tag pertencente ao Storage Consulta. O parmetro Name recebe o
nome do Tag a ser adicionado. O parmetro FieldType indica o tipo deste Tag (0:
Double, 1: Bit, 2: String, 3: Integer). Retorna um Booleano indicando o sucesso (ou
no) da operao.
NOTA: Es te mtodo i r fa l ha r s e a propri eda de QueryType es ti ver confi gura da pa ra o
va l or 0 - qtDBServer.

414

Objetos de Servidor

5.6.1.2.3 AddTable
AddTable(Name)
Adiciona uma tabela do banco de dados na Consulta. O parmetro Table determina
o nome da tabela a ser adicionada.
NOTA: Es te mtodo i r fa l ha r s e a propri eda de QueryType es ti ver confi gura da pa ra o
va l or 1 - qtStorage.

5.6.1.2.4 AddUaField
AddUaField(Name[, Alias[, Function]])
Este mtodo adiciona, em tempo de execuo, um campo a uma consulta
configurada para o tipo OPC UA. O mtodo retorna Verdadeiro se for bem sucedido
e Falso se houver falha. Os parmetros deste mtodo so os seguintes:
Name: Uma String com o caminho (Coluna) do campo
Alias: Uma String com o ttulo do campo. Se este parmetro for omitido assume
uma String vazia
Function: Uma String com o tipo de funo de agregao do campo, caso seja
usada uma consulta do tipo Dados Processados. Se este parmetro for omitido,
assume o valor Interpolative
Em uma consulta de tipo Dados Brutos (propriedade UaQueryType com valor igual a
zero), este mtodo falha se j houver um campo definido. Este mtodo s tem efeito
se a propriedade QueryType estiver configurada para OPC UA (valor igual a 2:
qtOpcUa). Do contrrio, retorna Falso.

5.6.1.2.5 Execute
Execute(ImmediateExecute)
O mtodo Execute executa um comando SQL que no tenha retorno (como DELETE,
UPDATE ou INSERT), configurado na propriedade SQL da Consulta. O parmetro
ImmediateExecute indica se a operao passar pelas filas de operaes (arquivos
.e3i e .e3o) antes de chegar ao Banco de Dados (caso esteja configurada como
Falso), ou se ser enviada diretamente para o Banco de Dados (caso esteja
configurada como Verdadeiro). A vantagem de se utilizar a Consulta para executar
comandos a utilizao de variveis, como em uma consulta simples. Exemplo de
comandos SQL:
DELETE FROM teste WHERE cod > 10
UPDATE teste SET cod = 10 WHERE cod > 10
INSERT INTO teste(cod) VALUES(10)

Objetos de Servidor

415

Exemplo:
Sub CommandButton1_Click()
Screen.Item("Consulta1").Execute
End Sub

5.6.1.2.6 GetADORecordSet
GetADORecordSet()
O mtodo GetADORecordSet retorna um Recordset do tipo ADO (ActiveX Data
Object), resultante da execuo da Consulta configurada. Exemplo:
Sub Botao1_Click()
Set rec = Screen.Item("Consulta1").GetADORecordset()
strDatas = " "
i = 0
' Mostra uma mensagem com os 10 primeiros
' registros da coluna E3TimeStamp
While (NOT rec.EOF AND i < 10)
strDatas = strDatas &
CStr(rec.Fields.Item("E3TimeStamp").Value) & _
Chr(10) & Chr(13)
i = i + 1
rec.MoveNext()
Wend
MsgBox strDatas
End Sub
NOTA: Pa ra ma i ores i nforma es s obre o objeto ADORecords et retorna do por es te
mtodo, cons ul te a documenta o da Mi cros oft no l i nk http://msdn.microsoft.com/enus/library/ms675841(VS.85).aspx (s omente em i ngl s ).

5.6.1.2.7 GetAsyncADORecordSet
GetAsyncADORecordSet()
Cria uma Consulta e, quando ela estiver finalizada, gera o evento
OnAsyncQueryFinish do prprio objeto, passando para este evento o resultado
(Recordset) gerado pela Consulta.

5.6.1.2.8 GetE3QueryFields
GetE3QueryFields()
O mtodo GetE3QueryFields retorna a Coleo de Campos (colunas) de uma
Consulta. Cada item desta Coleo possui propriedades que podem ser
modificadas, conforme descrito no tpico Campo da Consulta. Exemplo:
Sub Botao1_Click()
' Percorre a coleo de Campos,

416

Objetos de Servidor

' mostrando-os em uma caixa de mensagem


' e ajustando-os como visveis
' na configurao da Consulta.
Set Browser = Screen.Item("E3Browser")
Set Consulta = Browser.Item("Consulta")
Set Campos = Consulta.GetE3QueryFields()
For Each campo In Campos
MsgBox CStr(campo.TableName) & "-" & CStr(campo.ColumnName)
campo.Visible = True
Next
' Refaz a Consulta do E3Browser, que acabou de ser
' modificada, para que todos os campos apaream.
Browser.RetrieveE3QueryFields()
Browser.Requery()
End Sub
NOTA: Pa ra us a r es te mtodo, a Cons ul ta dever s er previ a mente cri a da em tempo
de confi gura o.

5.6.1.2.9 RemoveField
RemoveField(FieldName[, Table])
O mtodo RemoveField remove um campo previamente includo em uma Consulta.
O parmetro FieldName determina o nome do campo que ser removido. O
parmetro Table determina o nome da tabela a qual o campo pertence. Este mtodo,
a exemplo do mtodo AddField, foi includo para manter a compatibilidade com as
verses antigas da Consulta do E3Chart. Exemplo:
Sub CommandButton1_Click()
Screen.Item("E3Browser").Item("Consulta")._
RemoveField "Campo1"
End Sub

5.6.1.2.10 RemoveStorageTag
RemoveStorageTag(Name)
Remove um Tag previamente configurado na Consulta. O parmetro Name indica o
nome do Tag. Retorna um Booleano indicando o sucesso (ou no) da operao.
NOTA: Es te mtodo i r fa l ha r s e a propri eda de QueryType es ti ver confi gura da pa ra o
va l or 0 - qtDBServer.

5.6.1.2.11 RemoveTable
RemoveTable(TableName)
Remove uma tabela da Consulta. O parmetro TableName determina o nome da
Objetos de Servidor

417

tabela a ser removida.


NOTA: Es te mtodo i r fa l ha r s e a propri eda de QueryType es ti ver confi gura da pa ra o
va l or 1 - qtStorage.

5.6.1.2.12 RemoveUaField
RemoveUaField(Name)
Este mtodo remove o campo com o nome especificado, se existir. O parmetro
Name uma String com o nome (Coluna) do campo. O mtodo retorna Verdadeiro se
for bem sucedido e Falso se houver falha. Este mtodo s tem efeito se a
propriedade QueryType estiver configurada para OPC UA (valor igual a 2:
qtOpcUa). Do contrrio, retorna Falso.

5.6.1.2.13 SetVariableValue
SetVariableValue(VarName, Value)
O mtodo SetVariableValue ajusta o valor de uma varivel configurada na
Consulta, de forma que este valor possa ser informado como um filtro ou
parmetro antes de a Consulta ser realizada. Deve ser definido o nome da varivel
(VarName) e seu valor (Value), que pode ser um nmero, texto ou data e hora.
Exemplo:
Sub CommandButton_Click()
Set cons = Screen.Item("E3Browser1").Item("Consulta1")
DataInicial = now - 1
DataFinal = now
cons.SetVariableValue "DataIni", DataInicial
cons.SetVariableValue "DataFim", DataFinal
End Sub

5.6.1.3 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Consulta.
NOTA: N o recomend vel o a ces s o di reto des ta s propri eda des vi a s cri pts . O i dea l
a ces s a r o objeto Cons ul ta , pa s s a ndo pa r metros a tra vs do mtodo
SetVariableValue e modi fi ca ndo fi l tros ou ca mpos a tra vs da col e o retorna da com
o mtodo GetE3QueryFields.

5.6.1.3.1 CursorLocation
Define o local onde a Consulta ser gerada e manipulada, sob o ponto de vista
do SGBD (Sistema Gerenciador do Banco de Dados). As opes disponveis so:
0 - clServer: a Consulta ser gerada no SGBD (servidor)
418

Objetos de Servidor

1 - clClient: a Consulta ser gerada no Servidor (cliente)


O valor padro desta propriedade 1 - clClient. Ver tambm a propriedade
CursorType.
NOTA: Es ta propri eda de n o tem efei to pa ra Ba ncos de Da dos em que a
propri eda de SourceType s eja i gua l a 0 - stAccess, poi s nes te ca s o s empre o Servi dor
que gera e ma ni pul a a Cons ul ta . Entreta nto, pa ra SourceType i gua l a 1 - stOracle ou 2
- stSqlServer, a cons el ha -s e uti l i za r a op o 1 - clClient. Pa ra ma i ores i nforma es ,
cons ul te a documenta o da propri eda de CursorLocation e da enumera o
CursorLocationEnum do objeto ADO (ActiveX Data Object).

5.6.1.3.2 CursorType
Define o tipo de Consulta de acordo com a visualizao dos dados. O valor
padro desta propriedade 0 - ctKeyset. Todas as opes disponveis esto na
tabela a seguir.
Opes disponveis para CursorType
OPO
0 - ctKeyset
1 - ctStatic
2 - ctDynamic

DESCRIO
Qua l quer muda na nos regi s tros
i ni ci a l mente retorna dos pel a Cons ul ta
s er vi s vel (Pa dr o).
Nenhuma muda na nos regi s tros
i ni ci a l mente retorna dos pel a Cons ul ta
s er vi s vel .
Todos os novos regi s tros a di ci ona dos na
Cons ul ta s er o vi s vei s , a l m da s
muda na s nos regi s tros i ni ci a l mente
retorna dos pel a Cons ul ta .

5.6.1.3.3 DataSource
Indica o objeto Banco de Dados, Storage ou Driver de Comunicao OPC UA que
ser usado na Consulta. Esta propriedade somente de leitura, mas pode ser
modificada em tempo de execuo.

5.6.1.3.4 Fields
Texto com os campos a serem visualizados na Consulta, separados por vrgula.
Corresponde ao argumento da clusula SELECT do cdigo SQL da Consulta. Em
branco (vazio), determina que a Consulta deve mostrar todos os campos da tabela.
Esta propriedade somente de leitura, mas pode ser modificada em tempo de
execuo.

Objetos de Servidor

419

5.6.1.3.5 FunctionSubType
Especifica o subtipo da funo indicada por FunctionType. Apenas as opes 1 ftArchivedValue, 2 - ftTagAttribute e 6 - ftCalculatedData possuem subtipos. Para as
outras funes, FunctionSubType assume o valor -1 - fsNoSubType. A tabela a seguir
mostra os possveis valores da propriedade, de acordo com a funo escolhida na
propriedade FunctionType:
Subtipos para funo ArchivedValue (FunctionType = 1)
SUBTIPO
0 - fsPreviousArchivedValue
1 - fsInterpolatedArchivedValue
2 - fsNextArchivedValue
3 - fsExactArchivedValue

DESCRIO
Va l or a rma zena do i medi a ta mente
a nteri or a o timestamp forneci do.
Va l or ca l cul a do a pa rti r do va l or a nteri or
e pos teri or.
Va l or a rma zena do i medi a ta mente
pos teri or a o timestamp.
Se for encontra do um va l or a rma zena do
no exa to i ns ta nte que foi forneci do pel o
timestamp.

Subtipos para funo TagAttribute (FunctionType = 2)


SUBTIPO
0 - fsTagAttributeDescription
1 - fsTagAttributeSource
2 - fsTagAttributeType
3 - fsTagAttributeEU
4 - fsTagAttributeLowEng
5 - fsTagAttributeHighEng
6 - fsTagAttributeDeadBand
7 - fsTagAttributeDeadBandUnit
8 - fsTagAttributeMinRecTime

9 - fsTagAttributeMaxRecTime

DESCRIO
Si gni fi ca do ou des cri o do Ta g.
Ca mi nho do Ta g que es t s endo
a rma zena do.
Ti po de da do: Double, Boolean ou String.
Uni da de de engenha ri a .
Li mi te i nferi or.
Li mi te s uperi or.
Ba nda morta pa ra gra va o.
Uni da de da ba nda morta (va l or a bs ol uto
ou porcenta gem).
Tempo mni mo pa ra gra va o (va ri a es
menores que es s e i nterva l o s o
des preza da s ).
Tempo m xi mo pa ra gra va o (a
a us nci a de va ri a o nes s es i nterva l os
fora uma gra va o).

Subtipos para funo CalculatedData (FunctionType = 6)


SUBTIPO
0 - fsTotalCalculatedData
1 - fsMinimumCalculatedData

420

DESCRIO
Tota l dos va l ores .
Va l or mni mo.

Objetos de Servidor

SUBTIPO
2 - fsMaximumCalculatedData
3 - fsStandardCalculatedData
4 - fsRangeCalculatedData
5 - fsMeanCalculatedData
6 - fsMedianCalculatedData

DESCRIO
Va l or m xi mo.
Des vi o pa dr o.
Ampl i tude dos va l ores .
Mdi a dos va l ores .
Medi a na dos va l ores .

5.6.1.3.6 FunctionType
Esta propriedade vlida quando um objeto Storage fonte da Consulta (isto
indicado pela propriedade DataSource). Ela especifica a funo que ir definir os
dados gerados pela Consulta. Algumas funes possuem subfunes, que podem
ser indicadas na propriedade FunctionSubType. A propriedade FunctionType pode
assumir os seguintes valores:
Opes disponveis para FunctionType
OPO
-1 - ftNoFunction

0 - ftLastValue
1 - ftArchivedValue

2 - ftTagAttribute
3 - ftCompressedDataNValues

4 - ftCompressedDataStartEndTime

5 - ftSampledData

Objetos de Servidor

DESCRIO
N o h nenhuma fun o defi ni da . Es te
va l or n o es t di s ponvel qua ndo a
propri eda de QueryType es t confi gura da
pa ra o va l or 1 - qtStorage.
Retorna o l ti mo va l or a rma zena do na
Ba s e de Da dos .
Retorna um va l or a rma zena do em
rel a o a um determi na do i ns ta nte de
tempo defi ni do na va ri vel TimeStamp.
O ti po de rel a o defi ni do na
propri eda de FunctionSubType.
Devol ve um a tri buto do Ta g, defi ni do na
propri eda de FunctionSubType.
Retorna , pa ra um ni co Ta g, N va l ores
defi ni dos na va ri vel NumVals,
a rma zena dos a pa rti r de um i ns ta nte
i ni ci a l , defi ni do na va ri vel StartTime.
Retorna , pa ra um ni co Ta g, os va l ores
a rma zena dos que es t o entre o i nterva l o
defi ni do pel a s va ri vei s StartTime e
EndTime.
Retorna , pa ra um ou ma i s Ta gs , os
va l ores i nterpol a dos (ou s eja ,
es ti ma dos ) entre os i ns ta ntes defi ni dos
pel a s va ri vei s StartTime e EndTime, a
i nterva l os fi xos defi ni dos pel a va ri vel
TimeInterval.

421

OPO
6 - ftCalculatedData

DESCRIO
Retorna , pa ra um ou ma i s Ta gs , o
res ul ta do de opera es ma tem ti ca s
a pl i ca da s a os da dos entre os i ns ta ntes
defi ni dos pel a s va ri vei s StartTime e
EndTime, a i nterva l os fi xos defi ni dos
pel a va ri vel TimeInterval.

NOTA: As va ri vei s ta mbm podem s er defi ni da s em tempo de execu o a pa rti r da


cha ma da do mtodo SetVariableValue da Cons ul ta .

5.6.1.3.7 GroupBy
Texto correspondente ao argumento da clusula GROUP BY do cdigo SQL da
Consulta. Esta propriedade somente de leitura, mas pode ser modificada em
tempo de execuo.

5.6.1.3.8 Having
Texto correspondente ao argumento da clusula HAVING do cdigo SQL da
Consulta. Esta propriedade normalmente utilizada com a propriedade GroupBy.
Esta propriedade somente de leitura, mas pode ser modificada em tempo de
execuo.

5.6.1.3.9 IgnoreQuality
Permite indicar se os dados com qualidade ruim sero includos ou no no
resultado da Consulta. Esta propriedade s tem efeito se o objeto Consulta estiver
utilizando um Storage como fonte de dados. Esta propriedade pode ser modificada
por script em tempo de execuo.

5.6.1.3.10 OrderBy
Texto correspondente ao argumento da clusula ORDER BY do cdigo SQL da
Consulta. Esta propriedade somente de leitura, mas pode ser modificada em
tempo de execuo.

5.6.1.3.11 QueryType
Indica o tipo de consulta a ser realizada. Os valores possveis para esta
propriedade so os seguintes:
-1 - qtUndefined: O objeto Consulta inicialmente tentar executar a consulta em
um objeto Banco de Dados. Se falhar, tentar execut-la em um objeto Storage.
Este o valor padro para Consultas criadas no Studio ou em tempo de execuo
0 - qtDBServer: O objeto Consulta tentar executar a consulta somente em um
422

Objetos de Servidor

objeto Banco de Dados


1 - qtStorage: O objeto Consulta tentar executar a consulta somente em um
objeto Storage
2 - qtOpcUa: O objeto Consulta tentar executar a consulta somente em um
objeto Driver de Comunicao OPC UA
NOTAS:
No ca s o de ma ni pul a o de Cons ul ta s em tempo de execu o, recomenda -s e
confi gura r es ta propri eda de pa ra o ti po des eja do a ntes de efetua r a s dema i s
confi gura es do objeto, es peci a l mente no ca s o de reuti l i za o de um objeto
Cons ul ta pa ra di ferentes fontes de da dos .
Pa ra a pl i ca es cri a da s em vers es a nteri ores , a o a bri r a a pl i ca o no Studi o
es s a propri eda de s er a utoma ti ca mente confi gura da pa ra -1 - qtUndefined.
Os mtodos AddStorageTag e RemoveStorageTag fa l ha r o s e es ta propri eda de
es ti ver confi gura da pa ra 0 - qtDBServer.
A propri eda de FunctionType n o a cei ta r o va l or -1 - ftNoFunction s e es ta
propri eda de es ti ver confi gura da pa ra o va l or 1 - qtStorage.
Os mtodos AddField, AddTable e RemoveTable fa l ha r o s e es ta propri eda de
es ti ver confi gura da pa ra o va l or 1 - qtStorage.
Se es ta propri eda de es ti ver confi gura da pa ra -1 - qtUndefined, a tenta ti va de
executa r a Cons ul ta em um objeto Stora ge (a o fa l ha r a Cons ul ta em um objeto
Ba nco de Da dos ) fa l ha r s e a propri eda de FunctionType es ti ver confi gura da pa ra 1 - ftNoFunction ou s e a propri eda de FunctionSubType es ti ver confi gura da pa ra um
va l or i nv l i do.

5.6.1.3.12 SQL
Contm o cdigo SQL especificado para a Consulta. Esta propriedade somente
para leitura, mas pode ser modificada em tempo de execuo.

5.6.1.3.13 Table
A propriedade Table contm as tabelas que sero consultadas (por exemplo,
Alarms a tabela de alarmes ou eventos). Corresponde ao argumento da clusula
FROM do cdigo SQL da Consulta. Esta propriedade somente de leitura, mas pode
ser modificada em tempo de execuo.

5.6.1.3.14 UaNamespaceArray
Esta propriedade retorna um objeto que uma Coleo de Namespaces OPC UA,
usada pelos campos configurados na Consulta. Esta propriedade somente de
leitura.

Objetos de Servidor

423

5.6.1.3.15 UaQueryType
Esta uma propriedade de leitura e escrita que permite determinar se a
Consulta do tipo Dados Brutos (0: uqtRaw) ou do tipo Dados Processados (1:
uqtProcessed, valor padro). No Studio esta propriedade somente de leitura. Em
tempo de execuo ela permite configurar o tipo da consulta OPC UA, mas s aceita
escritas se a propriedade QueryType estiver configurada para OPC UA (valor igual
a 2: qtOpcUa).

5.6.1.3.16 Where
Determina a condio da Consulta que filtra os registros da tabela a serem
visualizados, ou seja, s sero visualizados os registros que satisfizerem a
condio. Corresponde ao argumento WHERE do cdigo SQL da Consulta. Esta
propriedade somente de leitura, mas pode ser modificada em tempo de execuo.

5.6.1.4 Coleo de Campos


Esta seo contm informaes sobre os mtodos e as propriedades do objeto
Coleo de Campos da Consulta. Este objeto no possui eventos especficos.

5.6.1.4.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Coleo de Campos da
Consulta.
5.6.1.4.1.1 Add
Add(NewItem)
Adiciona um novo objeto Campo da Consulta na Coleo de Campos de uma
Consulta, indicado pelo parmetro NewItem.
5.6.1.4.1.2 Item
Item(Index)
Retorna um objeto Campo da Consulta da Coleo de Campos. O parmetro Index
pode ser o ndice nmerico deste Campo ou seu nome.
5.6.1.4.1.3 RefreshUaNodeIds

RefreshUaNodeIds()
Atualiza todos os Campos da Consulta, buscando os Identificadores de Ns OPC UA
(NodeIds) no servidor e atualizando a propriedade UaNodeId dos Campos da
Consulta. Para que este mtodo funcione, as seguintes condies devem ser
424

Objetos de Servidor

atendidas:
A propriedade QueryType da Consulta deve estar configurada para 2: qtOpcUa
A Consulta deve apontar para um Driver de Comunicao OPC UA vlido
O Driver de Comunicao OPC UA configurado na Consulta deve estar ativo e
conectado
5.6.1.4.1.4 Remove
Remove(Index)
Remove um objeto Campo da Consulta da Coleo de Campos de uma Consulta. O
parmetro Index pode ser tanto uma String com o nome do Campo da Consulta
quanto o ndice deste objeto na Coleo de Campos.

5.6.1.4.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Coleo de
Campos da Consulta.
5.6.1.4.2.1 Count
Retorna o nmero de objetos Campo da Consulta nesta Coleo. Esta propriedade
somente de leitura.

5.6.1.4.3 Campo da Consulta


Esta seo contm informaes sobre as propriedades do objeto Campo da
Consulta. Este objeto no possui eventos nem mtodos especficos.
5.6.1.4.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Campo da
Consulta.

Alias
Apelido do Campo na Consulta.

ColumnName
Nome da coluna. Este nome deve existir nas tabelas adicionadas nesta Consulta.

Criteria
Filtro que ser aplicado sobre o Campo.

Objetos de Servidor

425

Function
Funo para a qual o Campo pode ser passado como parmetro.

GroupBy
Em Verdadeiro, indica que o Campo faz parte de um agrupamento.

OrderBy
Ordenao dos dados do Campo. Os valores vlidos so "ASC" (ordenao
ascendente), "DESC" (ordenao descendente) ou uma String vazia (sem ordenao).
Qualquer valor diferente significa que o Campo no possui ordenao.

OrderNumber
Nmero de ordem do Campo em relao aos outros Campos que compem a
ordenao da Consulta. Este valor s ser aceito como maior que 0 (zero) se o
Campo tiver um tipo de ordenao (definido na propriedade OrderBy). Este valor
ter que ser menor ou igual ao nmero de Campos que compem a ordenao da
Consulta.

TableName
Nome da tabela a que pertence o Campo. Esta tabela deve ter sido adicionada na
configurao da Consulta.

UaNodeId
Retorna um objeto do tipo Identificador de N OPC UA, com a configurao do
N que identifica um campo de uma consulta OPC UA em um determinado servidor
OPC UA. No Studio esta propriedade apenas representada por um cone, na
coluna Id da configurao de campos da Consulta.

Visible
Em Verdadeiro, indica que o Campo est visvel.

5.6.1.5 Coleo de Namespaces OPC UA


Esta seo contm informaes sobre mtodos e propriedades do objeto Coleo
de Namespaces OPC UA (UaNamespaceArray). Este objeto no possui eventos
especficos.

5.6.1.5.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Coleo de
Namespaces OPC UA.

426

Objetos de Servidor

5.6.1.5.1.1 Add
Add(Item)
Adiciona um identificador de Namespace, sempre ao final da Coleo. O parmetro
Item uma String que define o Namespace. Este parmetro no pode ser vazio.
5.6.1.5.1.2 Item
Item(Index)
Retorna o identificador de Namespace do ndice especificado. O parmetro Index
deve ser um LONG variando entre 0 (zero) e Count menos 1 (um).
5.6.1.5.1.3 Remove
Remove(Index)
Remove o Namespace do ndice especificado. Note que isto implica em mudar os
ndices dos Namespaces de ndice superior ao removido. No possvel remover os
ndices 0 (zero) e 1 (um). O parmetro Index um valor (LONG) que identifica o
Namespace que se deseja remover da Coleo, variando entre 2 (dois) e Count
menos 1 (um).

5.6.1.5.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Coleo de
Namespaces OPC UA.
5.6.1.5.2.1 Count
Retorna o total de Namespaces da coleo. O valor mnimo desta propriedade
sempre 2 (dois), j que os ndices 0 e 1 esto sempre presentes.

5.6.1.5.3 Identificador de N OPC UA


Esta seo contm informaes sobre propriedades do objeto Identificador de N
OPC UA (E3UaNodeId). Este objeto no possui eventos nem mtodos especficos.
5.6.1.5.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Identificador de
N OPC UA.

GUID
Propriedade de leitura e escrita que identifica este objeto, caso a propriedade
Type seja igual a 2: nitGUID. Se a propriedade Type for diferente de 2 (dois), a
Objetos de Servidor

427

leitura desta propriedade retorna erro. J a escrita nesta propriedade fora sempre
com que a propriedade Type seja modificada para 2 (dois). O valor desta
propriedade uma String do tipo GUID (Globally Unique Identifier, ou Identificador
nico Global), um valor de 128 bits. Caso esta propriedade seja configurada com o
valor "{00000000-0000-0000-0000-000000000000}", este objeto ser identificado
como Null.

NamespaceIndex
Propriedade de leitura e escrita que identifica a qual Namespace se refere este
Identificador. Este ndice deve estar entre 0 (zero) e o nmero de Namespaces menos
1 (um) que o servidor possuir. No caso da definio do campo na Consulta, o ndice
se refere Coleo de Namespaces OPC UA definida no objeto Consulta (que em um
dado momento pode ser diferente da Coleo de Namespaces do servidor). Seu
valor nunca pode ser maior que 65535, pois o padro OPC UA define que este um
valor de 16 bits.

Numeric
Propriedade de leitura e escrita que identifica este objeto, caso a propriedade
Type seja igual a 0: nitNumeric. Se a propriedade Type for diferente de 0 (zero), a
leitura desta propriedade retorna erro. J a escrita nesta propriedade fora sempre
com que a propriedade Type seja modificada para 0 (zero). Um valor 0 (zero) nesta
propriedade identifica este objeto como Null.

Opaque
Propriedade de leitura e escrita que identifica este objeto, caso a propriedade
Type seja igual a 3: nitOpaque. O valor desta propriedade um vetor de bytes, ou
seja, uma String de caracteres no necessariamente vlidos ou imprimveis. Se a
propriedade Type for diferente de 3 (trs), a leitura desta propriedade retorna erro.
J a escrita nesta propriedade fora sempre com que a propriedade Type seja
modificada para 3 (trs). Uma String vazia nesta propriedade identifica este objeto
como Null.

String
Propriedade de leitura e escrita que identifica este objeto, caso a propriedade
Type seja igual a 1: nitString. Se a propriedade Type for diferente de 1 (um), a
leitura desta propriedade retorna erro. J a escrita na propriedade fora sempre
com que a propriedade Type seja modificada para 1 (um). Uma String vazia nesta
propriedade identifica este objeto como Null.

Type
Propriedade de leitura e escrita que determina qual o tipo de identificador este
objeto utiliza. Os valores possveis para esta propriedade so os seguintes:
0 - nitNumeric: O identificador um nmero (LONG)
1 - nitString: O identificador uma String
428

Objetos de Servidor

2 - nitGUID: O identificador uma String do tipo GUID (Globally Unique Identifier)


3 - nitOpaque: O identificador um vetor de bytes
Sempre que esta propriedade modificada, o valor do identificador forado para
Null.

5.6.2 Pasta de Dados


O objeto Pasta de Dados no contm eventos, mtodos ou propriedades especficos,
somente gerais. Estes podem ser visualizados na seo Eventos, Mtodos e
Propriedades Gerais dos Objetos.

5.6.3 Tag Contador


Esta seo contm informaes sobre eventos e propriedades do objeto Tag
Contador. Este objeto no possui mtodos associados.

5.6.3.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Tag Contador.

5.6.3.1.1 OnPreset
OnPreset()
Ocorre toda vez que o valor da propriedade Preset alcanado.

5.6.3.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Tag Contador.

5.6.3.2.1 AutoRestart
Indica que a contagem deve ser recomeada do zero aps ter sido atingido o
valor estabelecido na propriedade Preset. Esta propriedade somente vlida
quando a propriedade CounterType est configurada com o valor 0 - Preset.

5.6.3.2.2 CounterType
Define o comportamento do contador. Os valores disponveis para esta
propriedade so:
0 - Preset: a contagem interrompida quando o valor estabelecido na
propriedade Preset atingido
1 - Infinite: a contagem prossegue indefinidamente
Objetos de Servidor

429

5.6.3.2.3 Enabled
Inicia ou para o contador. Em True, a contagem iniciada; em False, ela
interrompida.

5.6.3.2.4 Increment
Define o intervalo de atualizao da propriedade Value. Caso esta propriedade
tenha seu valor modificado enquanto a contagem estiver em curso, esta
modificao s ter efeito quando o contador for parado e reiniciado.

5.6.3.2.5 Preset
Limite a ser atingido pelo contador, em segundos. Caso o valor de Preset no seja
um mltiplo de Increment, o Tag ir atingir este valor antes do prximo incremento.

5.6.3.2.6 ResetCounterWhenEnabled
Habilita o reincio da contagem (do zero) cada vez que o valor da propriedade
Enabled retorna a True. Quando desabilitada, o contador reinicia a contagem de
onde ela foi interrompida anteriormente.

5.6.3.2.7 Value
Mostra a contagem do contador, em segundos. Propriedade somente de leitura.
Essa propriedade recebe valores mltiplos de Increment, exceto quando a
propriedade Enabled ajustada para False. Nesse caso, o valor ser o do momento
em que o Tag foi desabilitado. Ao reiniciar a contagem, o valor da propriedade ser
o prximo mltiplo de Increment. O valor mximo dessa propriedade
2147483647 (0x7FFFFFFF).

5.6.4 Tag Demo


Esta seo contm informaes sobre mtodos e propriedades do objeto Tag Demo.
Este objeto no possui eventos associados.

5.6.4.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Tag Demo.

5.6.4.1.1 Reset
Reset()
Zera a fase (deslocamento em tempo) da forma de onda do Tag. A fase da onda
somente ser zerada quando o Tag estiver habilitado. Este mtodo, quando o Tag
430

Objetos de Servidor

estiver habilitado, no tem efeito nos Tags do tipo CurrentTime e Random, que no
so peridicos. Quando o Tag estiver desabilitado, seu valor simplesmente
zerado, independentemente do tipo de Tag.

5.6.4.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Tag Demo.

5.6.4.2.1 Enabled
A propriedade Enabled habilita ou desabilita a variao do Tag Demo. Se Enabled
estiver configurado para False, a variao estar desabilitada. Caso contrrio, o
Tag atualizar a propriedade Value conforme a configurao das propriedades
Period e Scan. O valor padro desta propriedade True.

5.6.4.2.2 Maximum
A propriedade Maximum determina o valor mximo do Tag. O valor padro desta
propriedade 100. Exemplo:
Sub CommandButton2_Click()
' Ao clicar no boto, abre uma caixa de mensagens,
' indicando o valor da propriedade Maximum do TagDemo6
MsgBox Application.GetObject("Dados.TagDemo6").Maximum
End Sub

5.6.4.2.3 Minimum
A propriedade Minimum determina o valor mnimo do Tag. O valor padro desta
propriedade 0. Exemplo:
Sub CommandButton2_Click()
' Ao clicar no boto, abre um messagebox indicando o valor
' da propriedade Minimum do TagDemo6
MsgBox Application.GetObject("Dados.TagDemo6").Minimum
End Sub

5.6.4.2.4 Period
Define o comprimento da forma de onda, em milissegundos. No se aplica quando
a propriedade Type estiver configurada para 0 - Random ou 3 - CurrentTime. O
valor padro desta propriedade 10000 ms. Exemplo:
Sub TagDemo1_OnStartRunning()
Period = 1000
End Sub

Objetos de Servidor

431

5.6.4.2.5 Scan
A propriedade Scan define o intervalo de tempo, em milissegundos, entre duas
variaes da propriedade Value. Utilize esta propriedade se voc desejar maior ou
menor quantidade de dados gerados pelo Tag Demo. O valor padro desta
propriedade 1000. O valor do scan deve ser maior que 0. Exemplo:
Sub Linha1_Click()
Application.GetObject("Dados.TagDemo2").Scan = 200
End Sub

5.6.4.2.6 TimeStamp
A propriedade TimeStamp atualizada sempre que ocorrer alguma mudana de
valor ou estado nas propriedades Value ou Quality. Ela informa qual a data e hora
associada tanto ao valor quanto qualidade do Tag Demo. Esta uma propriedade
somente para leitura. O valor padro desta propriedade 00:00:00.

5.6.4.2.7 Type
Determina o tipo de onda do Tag. Modifique a propriedade conforme a tabela a
seguir. Quando a propriedade Type estiver configurado para 3 (CurrentTime), a
propriedade Value ir conter a data e hora atual do servidor.
Opes disponveis para Type
VALOR
0
1
2
3
4
5
6

FORMA DE ONDA
Ra ndom (a l ea tri a )
Si ne (onda s eni de)
Squa re (onda qua dra da )
CurrentTi me (da ta e hora )
Ra mpUp (borda de s ubi da )
Ra mpDown (borda de des ci da )
Ra mpUpDown (borda de s ubi da e
des ci da )

Exemplo:
Sub Linha1_Click()
Application.GetObject("Dados.TagDemo2").Type = 2
End Sub

5.6.4.2.8 Value
A propriedade Value varia de acordo com o tipo da forma de onda, estabelecida
na propriedade Type. Esta uma propriedade apenas de leitura. O valor padro
desta propriedade 0. Exemplo:
Sub Figura1_Click()

432

Objetos de Servidor

MsgBox Application.GetObject("Dados.TagDemo2").Value = 10
End Sub

5.6.5 Tag Interno


Esta seo contm informaes sobre mtodos e propriedades do objeto Tag
Interno. Este objeto no possui eventos associados.

5.6.5.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Tag Interno.

5.6.5.1.1 WriteEx
WriteEx([NewValue[, NewTimestamp[, NewQuality]]])
Permite modificar o valor, a data e hora e a qualidade de um Tag Interno em uma
nica operao. Este mtodo retorna um Booleano que indica o sucesso ou no da
operao.
O parmetro NewValue especifica o novo valor do Tag; se omitido, o valor do Tag
no modificado. O parmetro NewTimestamp especifica a nova data e hora do
Tag; se omitido, utiliza-se a data e hora do momento da chamada do mtodo. O
parmetro NewQuality especifica a nova qualidade do Tag; se omitida, ser
assumida a qualidade Boa (192). Todos estes parmetros podem ser omitidos.
Exemplo:
Sub CommandButton12_Click()
Dim Ret
Ret = Application.GetObject("Dados.TagInterno1")._
WriteEx(123.456, "1/1/2001", 193)
If Ret Then
MsgBox "Funcionou!"
Else
MsgBox "Falhou!"
End If
End Sub

5.6.5.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Tag Interno.

5.6.5.2.1 Quality
Informa a qualidade do valor contido na propriedade Value. Esta propriedade
de leitura e escrita, mas sempre que o valor do Tag Interno for modificado, seja por
script ou por uma Associao, ela ser atualizada de acordo. Exemplo:
Sub CommandButton1_Click()
MsgBox Application.GetObject("Dados.TagInterno1").Quality
End Sub

Objetos de Servidor

433

NOTA: Pa ra ma i ores i nforma es s obre qua l i da de, cons ul te o tpi co Qualidade no


Manual do Usurio do E3.

5.6.5.2.2 Retentive
A propriedade Retentive determina se o valor do Tag Interno deve ser
armazenado automaticamente, caso o Domnio seja parado. Se esta propriedade
estiver configurada para True, o valor do Tag Interno ser armazenado
automaticamente, no caso de troca de servidor do Domnio ativo. Isso garante que
o valor do Tag ser sincronizado com um servidor standby. Assim, quando o
servidor for executado, o valor do Tag ser o mesmo do servidor que parou. Caso
contrrio, o valor do Tag ser ajustado para o valor inicial sempre que o Domnio
for executado ou ocorrer troca do servidor ativo. Esta propriedade no tem efeito se
for alterada em tempo de execuo. Exemplo:
Sub CommandButton1_Click()
Dim status
status = Application.GetObject("Dados.TagInterno1").Retentive
MsgBox status
Select Case status
Case True
MsgBox "O valor do tag interno ser _
armazenado automaticamente."
Case False
MsgBox "O valor do tag ser ajustado para o valor _
inicial sempre que o domnio for executado ou _
ocorrer troca do servidor ativo."
End Select
End Sub
NOTA: Es ta propri eda de s v l i da pa ra Ta gs Internos conti dos no Servi dor. Ta gs
Internos conti dos no Vi ewer n o podem s er retenti vos .

5.6.5.2.3 TimeStamp
A propriedade TimeStamp informa a data e hora associada ao valor contido na
propriedade Value. Esta propriedade de leitura e escrita, mas sempre que o valor
do Tag Interno for modificado, seja por script ou por uma Associao, ela ser
atualizada de acordo.

5.6.5.2.4 Value
A propriedade Value do tipo Variant, o que permite armazenar valores de todo e
qualquer tipo, desde um inteiro at referncias para objetos (veja o exemplo a
seguir). Utilize-o para guardar valores dentro do Viewer ou Servidor e para trocar
dados entre os diversos pontos da aplicao. O valor padro desta propriedade
vazio. Esta propriedade de leitura e escrita. Exemplo:
434

Objetos de Servidor

Sub Meses_OnStartRunning()
' Meses um tag do tipo InternalTag.
' Utiliza-se o evento para inicializar o vetor.
Value = Array("Janeiro", "Fevereiro", "Maro", _
"Abril", "Maio", "Junho", "Julho", "Agosto", _
"Setembro", "Outubro", "Novembro", "Dezembro")
End Sub

5.6.6 Tag Timer


Esta seo contm informaes sobre eventos e propriedades do objeto Tag Timer.
Este objeto no possui eventos associados.

5.6.6.1 Eventos
Esta seo contm informaes sobre os eventos do objeto Tag Timer.

5.6.6.1.1 OnPreset
OnPreset()
Ocorre toda vez que o valor da propriedade NextExecTime alcanado.

5.6.6.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Tag Timer.

5.6.6.2.1 Enabled
Habilita ou desabilita o Timer. O valor padro desta propriedade True.

5.6.6.2.2 NextExecTime
Exibe o prximo horrio de disparo. uma propriedade somente de leitura.

5.6.6.2.3 RepeatInterval
utilizada sempre que o Tag for do tipo Contnuo. O valor padro desta
propriedade 00:00:01.

5.6.6.2.4 StartTime
Data e hora inicial do Timer. Para o tipo Single, a prpria data e hora de
disparo. Para os demais, o momento a partir do qual o Timer comea a disparar.
O valor padro o dia e a hora locais.

Objetos de Servidor

435

5.6.6.2.5 TriggerType
Tipo de disparo do Timer. As opes disponveis so:
Opes disponveis para TriggerType
OPO
0 - ttSingle
1 - ttContinuous
2 - ttDaily
3 - ttMonthly

Di s pa ro
Di s pa ro
Di s pa ro
Di s pa ro

DESCRIO
ni co.
contnuo.
di ri o.
mens a l .

5.7 Banco de Dados


Esta seo contm informaes sobre mtodos e propriedades do objeto Banco de
Dados. Este objeto no possui eventos associados.

5.7.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Banco de Dados.

5.7.1.1 SetDBParameters
SetDBParameters(ServerName, UserName, Password, DBName)
String de conexo com o banco de dados nas propriedades do objeto Banco de
Dados. O parmetro ServerName determina o nome do servidor. O parmetro
UserName determina o nome do usurio. O parmetro Password determina a senha
do login para se conectar ao banco de dados. O parmetro DBName o nome do
banco de dados utilizado no SQL Server. Para os demais bancos de dados, este
parmetro no utilizado.

5.7.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Banco de Dados.

5.7.2.1 ConnectionActive
Indica se o E3 possui uma conexo ativa com o banco de dados. O E3
normalmente utiliza duas conexes com este banco de dados, uma para escritas e
outra para leituras. A propriedade ConnectionActive est em Verdadeiro se pelo
menos uma destas duas conexes estiver conectada e funcionando. Esta
propriedade no deve ser utilizada para detectar falhas de conexo, j que ela
pode estar em Falso em diversas situaes, como por exemplo:
Quando o banco de dados no est em uso (nenhuma operao de escrita ou
leitura foi executada)
436

Objetos de Servidor

Quando o banco de dados recm foi reconfigurado (quando uma


propriedade de conexo do banco de dados alterada em tempo de
execuo as conexes so fechadas, e s so reconectadas na prxima
operao de escrita ou leitura)
Quando a conexo com o banco de dados caiu (por exemplo, a rede no est
disponvel ou o banco de dados foi fechado)
Quando o objeto DBServer est desativado (apesar de que, mesmo com o
objeto DBServer desativado, a conexo pode ser reconectada se o aplicativo
solicitar alguma leitura ou escrita imediata no banco de dados)
NOTA: Se o a pl i ca ti vo gera opera es de ba nco de da dos de forma cons i s tente, i s to
, s e es t s empre gera ndo nova s es cri ta s ou l ei tura s , a propri eda de
ConnectionActive reporta correta mente o es ta do da conex o com o ba nco de da dos ,
j que fi ca m el i mi na da s a s dema i s s i tua es em que es ta propri eda de poderi a
es ta r em Fa l s o.

5.7.2.2 EnableSynchronization
Indica ao E3, se habilitada (Verdadeiro), que ele tambm deve executar a
gravao dos dados em uma segunda base de dados simultaneamente, para
permitir uma maior segurana. Se a propriedade estiver habilitada e houver um
servidor Standby, o E3 executa a sincronizao entre os bancos de dados dos dois
servidores. O valor padro desta propriedade Falso, ou seja, a sincronia est
desabilitada.

5.7.2.3 NetLibrary
Configura o tipo de biblioteca de rede do Banco de Dados. As opes disponveis
esto descritas na tabela a seguir.
Opes disponveis para a propriedade NetLibrary
OPO
0 - Default
1 - NamedPipes
2 - TcpIp
3 - SpxIpx
4 - BanyanVines
5 - MultiProtocol

Bi bl i oteca
Bi bl i oteca
Bi bl i oteca
Bi bl i oteca
Bi bl i oteca
Bi bl i oteca

do
do
do
do
do
do

DESCRIO
ti po pa dr o
ti po Named Pipes
ti po Winsock TCP/IP
ti po SPX/IPX
ti po Banyan Vines
ti po Multi-protocolo (RPC)

NOTA: A propri eda de NetLibrary s omente es t di s ponvel em Ba ncos de Da dos do


ti po SQL Server.

Objetos de Servidor

437

5.7.2.4 nRetries
Esta propriedade especifica o nmero de vezes que o E3 tenta executar uma
operao de banco de dados, alm da primeira tentativa. O valor padro desta
propriedade 5 (cinco). Se o valor desta propriedade for igual a 0 (zero),
executada apenas uma tentativa por operao. Caso haja uma perda de conexo
com o banco de dados durante qualquer uma das tentativas, a operao abortada
e as tentativas restantes so desconsideradas.

5.7.2.5 ReconnectDelay
A propriedade ReconnectDelay determina o tempo de espera (em milissegundos)
para que a aplicao execute uma tentativa de restabelecer uma conexo perdida
com o banco de dados. O valor padro desta propriedade 2000 (dois segundos).

5.7.2.6 SourceDatabase
Caso o Banco de Dados seja do tipo Access, este o nome do arquivo .mdb. Caso
o Banco de Dados seja do tipo SQL Server, este o nome do servidor SQL
concatenado com o banco de dados escolhido, no formato Servidor/Banco de
Dados. Caso o Banco de Dados seja do tipo Oracle, este o nome da conexo
criada. Esta propriedade somente para leitura.

5.7.2.7 SourceType
Indica o banco de dados utilizado pelo objeto. As opes disponveis so as
seguintes:
0 - stAccess: Banco de dados Access
1 - stOracle: Banco de dados Oracle
2 - stSqlServer: Banco de dados SQL Server

5.7.2.8 TimeOutCommand
Contm o tempo de espera para qualquer operao do banco de dados, antes que
a aplicao gere um erro por timeout. O valor padro 180 (trs minutos).

5.7.2.9 TimeOutConnection
Contm o tempo de espera para realizar a conexo com o banco de dados, antes
que a aplicao gere um erro por timeout. O valor padro 15 segundos.

438

Objetos de Servidor

5.7.2.10 TotalFailedWrites
Indica a quantidade de operaes dos arquivos .e3o que falharam e foram
descartadas desde que a conexo com o banco de dados foi ativada. Pode ser
zerada automaticamente em diversas situaes, como por exemplo:
Ao desativar o objeto DBServer
Se o processo E3DBEngine for fechado por algum motivo
Se os parmetros de configurao da conexo do objeto DBServer forem
alterados

5.7.2.11 UserName
Login utilizado para se conectar ao banco de dados. Esta propriedade somente
para leitura.

5.7.2.12 UseTransaction
Define se o Servidor de Banco de Dados utiliza as transaes do banco de dados
ou no. Se a propriedade estiver em Verdadeiro, cada bloco de operaes (200
operaes) de banco de dados (operaes do Histrico, Storage, Formulas e
Alarmes) so executadas de uma vez s, ou seja, em uma nica transao.

5.8 Histricos
Esta seo contm informaes sobre mtodos e propriedades do objeto Histrico.
Este objeto no possui eventos associados.

5.8.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Histrico.

5.8.1.1 StartAcquisition
StartAcquisition()
Habilita o Histrico a gravar os valores do seus campos periodicamente, a partir
da taxa especificada na propriedade ScanTime. Este mtodo pode ser chamado a
qualquer momento aps a chamada do mtodo StopAcquisition. O comportamento
padro deste mtodo iniciar a aplicao habilitado, ou seja, este mtodo
sempre executado internamente ao se iniciar o Histrico. Exemplo:
Sub Botao1_Click()
' Quando clica no boto, habilita o histrico.
Application.GetObject("Hist1").StartAcquisition()
End Sub

Objetos de Servidor

439

5.8.1.2 StopAcquisition
StopAcquisition()
Desabilita a gravao dos registros por perodo no Histrico, independente do
valor especificado na propriedade ScanTime. A gravao por perodo fica
desabilitada at o mtodo StartAcquisition ser chamado. O comportamento padro
do objeto Histrico iniciar a aplicao com a gravao habilitada. Exemplo:
Sub Hist1_OnStartRunning()
' Desabilita o Histrico assim que iniciar.
StopAcquisition()
End Sub

5.8.1.3 WriteRecord
WriteRecord()
Insere uma nova linha de informao no banco de dados. Os valores so obtidos a
partir dos valores atuais de cada uma das variveis especificadas como fontes de
dados dos campos do Histrico. Utiliza-se este mtodo em duas situaes:
Para gravar uma nova linha de dados antes do tempo previsto para a prxima
gravao quando o Histrico est habilitado por tempo
Para gravar um novo conjunto de dados quando o Histrico est desabilitado
Exemplo:
Sub Tag1_OnValueChange()
' Grava uma nova linha em um histrico
' quando um tag muda de valor.
Application.GetObject("Hist1").WriteRecord()
End Sub

5.8.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Histrico.

5.8.2.1 BackupDiscardInterval
Indica a quantidade de unidades de tempo durante a qual os dados de backup
sero mantidos na tabela principal e na tabela de backup, at serem descartados
(por exemplo, para manter os dados por 24 meses na tabela principal, e mais seis
meses na tabela de backup, o valor da propriedade deve ser de 30 meses). Esta
propriedade trabalha em conjunto com a propriedade BackupDiscardTimeUnit. O
valor padro desta propriedade 12 (doze unidades de tempo indicadas em
BackupDiscardTimeUnit).

440

Objetos de Servidor

NOTA: O tempo tota l i ndi ca do pel a combi na o da s propri eda des


BackupDiscardInterval e BackupDiscardTimeUnit deve s er ma i or que o tempo i ndi ca do
pel a s propri eda des DiscardInterval e DiscardTimeUnit.

5.8.2.2 BackupDiscardTimeUnit
A propriedade BackupDiscardTimeUnit indica a unidade de tempo em que os
dados de backup ficaro armazenados at serem descartados. As opes
disponveis so:
0 - dtHour: horas
1 - dtDay: dias
2 - dtMonth: meses (padro)
3 - dtMinute: minutos
Esta propriedade trabalha em conjunto com a propriedade BackupDiscardInterval.

5.8.2.3 CacheSize
Define o tamanho do bloco de registros que deve ser lido pelo Histrico antes de
ser enviado para o banco de dados. Por exemplo, se CacheSize igual a 4, sero
enviados blocos contendo quatro registros cada um para o objeto Banco de Dados
associado. Os valores vlidos para esta propriedade devem estar no intervalo
entre 1 e 4. O valor padro desta propriedade 1.
NOTA: O bl oco de regi s tros envi a do a ca da 1 s egundo, mes mo que n o tenha
a ti ngi do o ta ma nho confi gura do na propri eda de CacheSize.

5.8.2.4 CompressedTable
Habilita o uso de banda morta para a gravao de dados. O valor padro desta
propriedade False.

5.8.2.5 DBServer
Indica o objeto Banco de Dados utilizado no Histrico para criao de tabelas e
registros de dados. O valor padro desta propriedade uma String vazia.

5.8.2.6 DeadBand
Esta propriedade trabalha em conjunto com a propriedade CompressedTable.
Indica o valor calculado sobre o ltimo valor gravado (em percentagem) que define
se este novo valor ser gravado. Se o valor gravado no for numrico, sua
modificao faz com que todos os valores sejam gravados.
Objetos de Servidor

441

5.8.2.7 DiscardInterval
Esta propriedade trabalha em conjunto com a propriedade DiscardTimeUnit. A
propriedade DiscardInterval indica o intervalo de tempo durante o qual os dados do
Histrico ficaro armazenados na tabela do banco de dados, at serem
descartados. O valor padro desta propriedade 1 (uma unidade de tempo
indicada em DiscardTimeUnit). Se esta propriedade for configurada com um valor
menor ou igual ao valor da propriedade BackupDiscardInterval, o E3
automaticamente ajusta o valor de BackupDiscardInterval como o dobro do valor de
DiscardInterval. Esta propriedade pode ser modificada em tempo de execuo.

5.8.2.8 DiscardTimeUnit
Esta propriedade trabalha em conjunto com a propriedade DiscardInterval. A
propriedade DiscardTimeUnit indica a unidade de tempo em que os dados da tabela
ficaro armazenados at serem descartados. As opes disponveis so:
0 - dtHour: horas
1 - dtDay: dias
2 - dtMonth: meses (padro)
3 - dtMinute: minutos

5.8.2.9 EnableBackupTable
Cria uma tabela de backup onde os dados descartados permanecero por
segurana. Se configurada para True, a tabela ser criada; do contrrio, no haver
tabela de backup. O valor padro desta propriedade False.

5.8.2.10 EnableDiscard
Indica descarte dos dados do Histrico aps um certo tempo. Se configurada
para False, os dados sero armazenados indefinidamente na tabela; do contrrio,
sero descartados aps determinado tempo. O valor padro dessa propriedade
False.

5.8.2.11 EnableQualityLogs
Quando em True, ao iniciar o Histrico o E3 gera um registro igual ao primeiro
registro coletado mas com qualidade ruim (0) e timestamp de um segundo antes.

5.8.2.12 ScanTime
Define a variao de intervalo do tempo, em milissegundos, que o Histrico ir
esperar para executar a aquisio e gravao de um novo registro na tabela. Utilize
esta propriedade se houver necessidade de maior ou menor quantidade de dados
442

Objetos de Servidor

gerados por segundo. O valor padro desta propriedade 1000.

5.8.2.13 TableName
Define o nome da tabela que ser utilizada no Histrico.

5.8.2.14 UserTable
Quando esta propriedade est configurada para True, identifica que o Histrico
do usurio, ou seja, os dados da tabela foram importados do banco de dados. Caso
contrrio, um Histrico normal do E3. Esta propriedade apenas de leitura.

5.8.2.15 UseTagQuality
Se for True, o Histrico vai usar o valor de qualidade da fonte do Tag; caso
contrrio, ser utilizado o mtodo antigo de avaliao (0: valor duvidoso; 1: valor
bom).

5.8.2.16 VerificationInterval
Esta propriedade trabalha em conjunto com a propriedade VerificationUnit para
controlar o intervalo de tempo que o E3 verifica a antiguidade dos dados, para
depois descart-los. O valor padro desta propriedade 1 (uma unidade de tempo
indicada em VerificationUnit).

5.8.2.17 VerificationUnit
Esta propriedade trabalha em conjunto com a propriedade VerificationInterval.
A propriedade VerificationUnit indica a unidade de tempo em que ser feita a
verificao para descarte dos dados. As opes disponveis so:
0 - dtHour: horas
1 - dtDay: dias
2 - dtMonth: meses (padro)
3 - dtMinute: minutos

5.9 Storage
Esta seo contm informaes sobre mtodos e propriedades do objeto Storage.
Este objeto no possui eventos associados.

5.9.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Storage.
Objetos de Servidor

443

5.9.1.1 CreateNewSession
CreateNewSession([DefaultType[, DefaultMinRecTime[, DefaultMaxRecTime[,
DefaultDeadBand[, DefaultDeadBandUnit[, DefaultScanTime]]]]]])
Cria uma Sesso com a capacidade de incluir dados em um Storage, de forma
independente da aquisio normal. Os parmetros opcionais so utilizados nas
configuraes dos Tags da Sesso, caso no informados em sua criao. So eles,
respectivamente:
DefaultType: Tipo de dado (0: Double, 1: Bit, 2: String, ou 3: Integer). Se nenhum
valor for informado, ser utilizado o valor 0 (Double).
DefaultMinRecTime: Intervalo mnimo de tempo entre gravaes. Se nenhum valor
for informado, ser utilizado o valor 0 (zero)
DefaultMaxRecTime: Intervalo mximo de tempo sem gravaes. Se nenhum valor
for informado, ser utilizado o valor 3600
DefaultDeadBand: Banda morta. Se nenhum valor for informado, ser utilizado o
valor 1 (um)
DefaultDeadBandUnit: Unidade da banda morta do Tag (0: Porcentagem ou 1:
Absoluta). Se nenhum valor for informado, ser utilizado o valor 1 (Absoluta)
DefaultScanTime: Tempo de varredura. Se nenhum valor for informado, ser
utilizado o valor 0 (zero)
Este mtodo ir funcionar mesmo que o objeto Storage no tenha nenhum campo
configurado.

5.9.1.2 StartAcquisition
StartAcquisition()
Inicia ou retoma a gerao de dados que vo para o Banco de Dados. O Storage
recebe notificaes sobre quais Tags cadastrados sofreram modificao, e quando
isto acontece ele verifica se os registros sero gravados ou no. Quando este
mtodo chamado, a notificao de mudana e a gerao de gravaes sero
iniciadas ou retomadas. Exemplo:
Sub Botao1_Click()
' Quando clica no boto, habilita o Storage
Application.GetObject("Storage1").StartAcquisition()
End Sub

5.9.1.3 StopAcquisition
StopAcquisition()
Para a gerao de dados que vo para o Banco de Dados. O Storage recebe
444

Objetos de Servidor

notificaes sobre quais Tags cadastrados sofreram modificao, e quando isto


acontece ele verifica se os registros sero gravados ou no. Quando este mtodo
chamado, a notificao de mudana e a gerao de gravaes so paralisadas.
Exemplo:
Sub Storage1_OnStartRunning()
' Desabilita o Storage assim que iniciar
StopAcquisition()
End Sub

5.9.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Storage.

5.9.2.1 BackupDiscardInterval
Indica a quantidade de unidades de tempo durante as quais os dados de backup
sero mantidos na tabela principal e na tabela de backup, at serem descartados
(por exemplo, para manter os dados por 24 meses na tabela principal, e mais seis
meses na tabela de backup, o valor da propriedade deve ser de 30 meses). Esta
propriedade trabalha em conjunto com a propriedade BackupDiscardTimeUnit. O
valor padro desta propriedade 12 (doze unidades de tempo indicadas em
BackupDiscardTimeUnit).
NOTA: O tempo tota l i ndi ca do pel a combi na o da s propri eda des
BackupDiscardInterval e BackupDiscardTimeUnit deve s er ma i or que o tempo i ndi ca do
pel a s propri eda des DiscardInterval e DiscardTimeUnit.

5.9.2.2 BackupDiscardTimeUnit
A propriedade BackupDiscardTimeUnit indica a unidade de tempo em que os
dados de backup ficaro armazenados, at serem descartados. As opes
disponveis so:
0 - dtHour: horas
1 - dtDay: dias
2 - dtMonth: meses (padro)
3 - dtMinute: minutos
Esta propriedade trabalha em conjunto com a propriedade BackupDiscardInterval.

5.9.2.3 CacheSize
Define o tamanho do bloco de registros que deve ser lido pelo Storage antes de ser
enviado para o banco de dados. Por exemplo, se CacheSize igual a 4, sero
Objetos de Servidor

445

enviados blocos contendo quatro registros cada um para o objeto Banco de Dados
associado. O valor padro desta propriedade 10.
NOTA: O bl oco de regi s tros envi a do a ca da 1 s egundo, mes mo que n o tenha
a ti ngi do o ta ma nho confi gura do na propri eda de CacheSize.

5.9.2.4 CompressionRate
Mostra a taxa de compresso de dados obtida at o momento.

5.9.2.5 DBServer
Indica o objeto Banco de Dados utilizado no Storage para criao de tabelas e
registros de dados. O valor padro desta propriedade uma String vazia.

5.9.2.6 DiscardInterval
Esta propriedade trabalha em conjunto com a propriedade DiscardTimeUnit. A
propriedade DiscardInterval indica o intervalo de tempo durante o qual os dados do
Histrico ficaro armazenados na tabela do banco de dados, at serem
descartados. O valor padro desta propriedade 1 (uma unidade de tempo
indicada em DiscardTimeUnit). Se esta propriedade for configurada com um valor
menor ou igual ao valor da propriedade BackupDiscardInterval, o E3
automaticamente ajusta o valor de BackupDiscardInterval com o dobro do valor de
DiscardInterval. Esta propriedade pode ser modificada em tempo de execuo.

5.9.2.7 DiscardTimeUnit
Esta propriedade trabalha em conjunto com a propriedade DiscardInterval. A
propriedade DiscardTimeUnit indica a unidade de tempo em que os dados ficaro
armazenados at serem descartados. As opes disponveis so:
0 - dtHour: horas
1 - dtDay: dias
2 - dtMonth: meses (padro)
3 - dtMinute: minutos

5.9.2.8 EnableBackupTable
Cria uma tabela de backup onde os dados descartados permanecero por
segurana. Se configurada para True, a tabela ser criada; do contrrio, no haver
tabela de backup. O valor padro desta propriedade False.

446

Objetos de Servidor

5.9.2.9 EnableDiscard
Habilita o descarte dos dados aps um determinado tempo. Se configurada para
False, os dados sero armazenados indefinidamente na tabela; do contrrio, sero
descartados aps determinado tempo. O valor padro dessa propriedade False.

5.9.2.10 Fields
Coleo que aponta para os Campos criados no Storage. Para cada Campo
possvel visualizar as propriedades Name e Link, e modificar as propriedades Type,
MinRecTime, MaxRecTime, DeadBand, ScanTime e DeadBandUnit.

5.9.2.11 StringFieldSize
Esta propriedade especifica o tamanho mximo que os campos do tipo String do
objeto Storage podero ter (ser o tamanho utilizado na criao do campo Value da
tabela de Strings).

5.9.2.12 TableName
Define o nome da tabela que ser utilizada no Storage.

5.9.2.13 VerificationInterval
Esta propriedade trabalha em conjunto com a propriedade VerificationUnit para
controlar o intervalo de tempo que o E3 verifica a antiguidade dos dados, para
depois descart-los. O valor padro desta propriedade 1 (uma unidade de tempo
indicada em VerificationUnit).

5.9.2.14 VerificationUnit
Esta propriedade trabalha em conjunto com a propriedade VerificationInterval.
A propriedade VerificationUnit indica a unidade de tempo em que ser feita a
verificao para descarte dos dados. As opes disponveis so:
0 - dtHour: horas
1 - dtDay: dias
2 - dtMonth: meses (padro)
3 - dtMinute: minutos

5.9.3 Campo do Storage


Esta seo contm informaes sobre propriedades do objeto Campo do Storage.
Este objeto no possui eventos nem mtodos associados.
Objetos de Servidor

447

5.9.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Campo do Storage.

5.9.3.1.1 DeadBand
Banda morta utilizada para clculo do algoritmo do Storage. Indica a preciso
que o usurio est disposto a perder em cada Campo a ser armazenado. Quanto
maior o valor da propriedade DeadBand, mais compacto ser o banco de dados
(menos dados sero gravados). Este valor pode ser especificado em unidades
absolutas ou como um percentual do valor atual do Tag, conforme configurado na
propriedade DeadBandUnit.

5.9.3.1.2 DeadBandUnit
Unidade da propriedade DeadBand. Pode ser especificado em unidades absolutas
ou como um percentual do valor atual do Tag.

5.9.3.1.3 Link
Determina a fonte de dados que ser associada ao Campo. Propriedade apenas
de leitura.

5.9.3.1.4 MaxRecTime
Diferena mxima, em segundos, entre os timestamps de dois registros
consecutivos armazenados no banco de dados, isto , o tempo mximo sem que
nenhum dado seja gravado. Por exemplo, se um Tag no estiver variando de valor,
mesmo assim o valor atual deve ser escrito no banco de dados sempre que o
nmero de segundos configurado em MaxRecTime for atingido. Este comportamento
pode ser desabilitado colocando-se o valor 0 (zero).

5.9.3.1.5 MinRecTime
Diferena mnima, em milissegundos, entre os timestamps de dois registros
quaisquer de mesma qualidade armazenados no banco de dados, isto , o tempo
mnimo para que um novo dado seja gravado. Este parmetro serve para limitar o
nmero de registros escritos em um banco de dados, no caso de um Tag sofrer
variaes bruscas de valor. Este comportamento pode ser desabilitado colocandose o valor 0 (zero).

5.9.3.1.6 Name
Propriedade que retorna o nome configurado para este Campo no objeto Storage.
Atravs dele, possvel buscar itens na coleo.
448

Objetos de Servidor

5.9.3.1.7 ScanTime
Retorna ou configura o tempo de varredura (em milissegundos) do Campo, ou
seja, de quanto em quanto tempo o valor do Tag ser realimentado no algoritmo de
compactao de dados, caso no esteja variando. Se o valor desta propriedade for
igual a 0 (zero), o valor da propriedade MaxRecTime ser utilizado para este
mesmo propsito.

5.9.3.1.8 Type
Retorna o tipo do objeto no formato do Storage (0: Double, 1: Bit, 2: String, 3:
Integer). Esta propriedade de leitura e escrita, mas s aceita mudanas enquanto
a coleta de dados para este Campo ainda no comeou.
NOTA: Os ti pos de da dos Bit, String e Integer n o s o s ubmeti dos a o a l gori tmo de
compa cta o do Stora ge. Porta nto, s empre que h uma va ri a o no va l or ou na
qua l i da de do Ca mpo, o va l or gra va do no ba nco de da dos . As propri eda des
DeadBand, DeadBandUnit, MaxRecTime e MinRecTime n o tm efei to nes tes ti pos de
da dos , poi s s o excl us i va s do a l gori tmo de compa cta o.

5.9.4 Sesso do Storage


Esta seo contm informaes sobre os mtodos do objeto Sesso do Storage. Este
objeto no possui eventos nem propriedades associados.

5.9.4.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Sesso do Storage.

5.9.4.1.1 AddField
AddField(FieldName[, Type, MinRecTime, MaxRecTime, DeadBand, DeadBandUnit,
ScanTime])
Este mtodo responsvel pela insero de Tags temporrios na estrutura da
Sesso. Se os parmetros opcionais no forem preenchidos, sero utilizado os
valores definidos na criao da Sesso pelo mtodo CreateNewSession do Storage.
Os parmetros deste mtodo so descritos na tabela a seguir.
Parmetros do mtodo AddField
PARMETRO
FieldName

Objetos de Servidor

DESCRIO
Nome do Ta g tempor ri o (obri ga tri o).

449

PARMETRO
Type

MinRecTime
MaxRecTime
DeadBand
DeadBandUnit

ScanTime

DESCRIO
Ti po do Ta g (opci ona l ). Os va l ores
pos s vei s s o 0: Double, 1: Bit, 2: String ou
3: Integer. O va l or pa dr o des te
pa r metro 0 (Double).
Interva l o mni mo de tempo entre a s
gra va es (opci ona l ). O va l or pa dr o
des te pa r metro 0 (zero).
Interva l o m xi mo de tempo s em
gra va es (opci ona l ). O va l or pa dr o
des te pa r metro 3600.
Ba nda morta do Ta g tempor ri o
(opci ona l ). O va l or pa dr o des te
pa r metro 1 (um).
Uni da de de ba nda morta do Ta g
tempor ri o (opci ona l ). Os va l ores
pos s vei s s o 0: Porcentagem ou 1:
Absoluta. O va l or pa dr o des te pa r metro
1 (Absoluta).
Tempo de va rredura do Ta g tempor ri o
(opci ona l ). O va l or pa dr o des te
pa r metro 0 (zero).

Este mtodo retorna Verdadeiro se o Tag foi corretamente adicionado na Sesso, e


Falso caso contrrio.

5.9.4.1.2 AddValue
AddValue(FieldName, Timestamp, Quality, Value)
Adiciona um valor a um Tag temporrio na Sesso. Os parmetros deste mtodo
so descritos na tabela a seguir.
Parmetros do mtodo AddValue
PARMETRO
FieldName

Timestamp
Quality
Value

DESCRIO
Nome do ca mpo a o qua l o va l or s er
a di ci ona do. Es te nome deve exi s ti r na
confi gura o ori gi na l do Stora ge, ou
ent o deve ter s i do a di ci ona do
previ a mente pel o mtodo AddField.
Es ta mpa de tempo do va l or a s er
a di ci ona do.
Qua l i da de do va l or a s er a di ci ona do.
Va l or a s er a di ci ona do.

Este mtodo retorna Verdadeiro se o valor foi adicionado corretamente, e Falso


450

Objetos de Servidor

caso contrrio.

5.9.4.1.3 Commit
Commit()
Grava todos os dados mantidos em memria pela Sesso no banco de dados do
Storage. Este mtodo retorna Verdadeiro se os dados foram gravados corretamente,
e Falso caso contrrio.

5.10 Frmulas
Esta seo contm informaes sobre mtodos e propriedades do objeto Frmula.
Este objeto no possui eventos associados.

5.10.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Frmula.

5.10.1.1 CreateUnit
CreateUnit(UnitName)
Cria uma unidade na tabela de frmulas. Este mtodo possui o parmetro UnitName
que determina o nome da unidade a ser criada. Retorna True se conseguir realizar a
operao; caso contrrio, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no boto, cria uma nova Unit
Application.GetObject("Formula1").CreateUnit("Unit2")
End Sub

5.10.1.2 CreateValue
CreateValue(ValueName)
Cria um conjunto de valores na tabela de frmulas. Este mtodo possui o
parmetro ValueName, que determina o nome do conjunto a ser criado. Retorna
True se conseguir realizar a operao; caso contrrio, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no boto, cria um novo Valor
Application.GetObject("Formula1").CreateValue("Modelo5")
End Sub

Objetos de Servidor

451

5.10.1.3 DeleteUnit
DeleteUnit(UnitName)
Apaga uma unidade na tabela de frmulas. Este mtodo possui o parmetro
UnitName, que informa o nome da unidade a ser apagada. Retorna True se
conseguir realizar a operao; caso contrrio, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no boto, apaga a unit
Application.GetObject("Formula1").DeleteUnit("Unit2")
End Sub

5.10.1.4 DeleteValue
DeleteValue(ValueName)
Apaga um conjunto de valores na tabela de frmulas. Este mtodo possui o
parmetro ValueName, que informa o conjunto de valores a ser apagado. Retorna
True se conseguir realizar a operao; caso contrrio, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no boto, apaga um conjunto de valores
Application.GetObject("Formula1").DeleteValue("Modelo5")
End Sub

5.10.1.5 FindUnit
FindUnit(UnitName)
Verifica se uma determinada unidade existe no banco de dados das frmulas. Este
mtodo possui o parmetro UnitName, que determina o nome da unidade a ser
encontrada. O mtodo retorna True se conseguir realizar a operao; caso
contrrio, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no boto, aparece uma caixa de mensagem
' (MessageBox) com o resultado
MsgBox(Application.GetObject("Formula1")._
FindUnit("Unit2"))
End Sub

5.10.1.6 FindValue
FindValue(ValueName)
Verifica se um determinado conjunto de valores existe no banco de dados de
frmulas. Este mtodo possui o parmetro ValueName, que informa o nome do
conjunto a ser verificado. Retorna True se conseguir realizar a operao; caso
452

Objetos de Servidor

contrrio, retorna False. Exemplo:


Sub Botao1_Click()
Dim val
' Quando clica no boto aparece uma caixa de mensagem
' (MessageBox) com o resultado
MsgBox CStr(Application.GetObject("Formula1")._
FindValue("Modelo5"))
End Sub

5.10.1.7 GetUnitData
GetUnitData(UnitName, TemplateName, Val)
Coloca na varivel indicada em Val o Tag associado unidade UnitName do
template TemplateName. Retorna True se a operao foi bem-sucedida, ou False,
caso contrrio. Exemplo:
Sub Botao1_Click()
Dim qualTag, qualFormula
Application.GetObject("Formula1").GetUnitData _
"Unidade1", "Template2", var1
End Sub

5.10.1.8 GetValueData
GetValueData(ValueName, TemplateName, Val)
Coloca na varivel Val o valor do conjunto de valores ValueName que est
associado ao template TemplateName. Retorna True se a operao foi bemsucedida, ou False, caso contrrio. Exemplo:
Sub Botao1_Click()
Dim Valor, qualFormula
Application.GetObject("Formula1").GetValueData _
"Valores4", "Template2", var1
End Sub

5.10.1.9 LoadFormulaValuesQuiet
LoadFormulaValuesQuiet(UnitName, ValueName)
Carrega um conjunto de valores para uma unidade de destino, sem apresentar
nenhuma mensagem. Este mtodo possui os parmetros UnitName, que determina o
nome da unidade e ValueName, que determina o nome do conjunto de valores.
Retorna True quando executado com sucesso, e False quando falha (o que no
significa um erro de script, necessariamente). Exemplo:
Sub Botao1_Click()
Application.GetObject("Formula1").LoadFormulaValuesQuiet _
"Unidade3", "Valor1"
End Sub

Objetos de Servidor

453

NOTA: Es te mtodo ta mbm a ces s a do a tra vs do objeto Viewer.

5.10.1.10 RenameUnit
RenameUnit(UnitName, NewUnitName)
Renomeia uma determinada unidade existente na tabela de frmulas. Retorna True
se conseguir realizar a operao, ou False, caso contrrio. Este mtodo possui os
parmetros UnitName, que determina o nome da unidade a ser encontrada; e
NewUnitName, que informa o novo nome da unidade. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no boto, renomeia uma unit
Application._
GetObject("Formula1").RenameUnit "Unit2", "Unit3"
End Sub

5.10.1.11 RenameValue
RenameValue(ValueName, NewValueName)
Renomeia um determinado conjunto de valores existente na tabela de frmulas.
Retorna True se conseguir realizar a operao ou False, caso contrrio. Este mtodo
possui os parmetros ValueName, que informa o nome do conjunto de valores e
NewValueName, que informa o novo nome do conjunto de valores. Exemplo:
Sub Botao1_Click()
Application.GetObject("Formula1").RenameValue "Modelo5",
"ModeloABC"
End Sub

5.10.1.12 SaveFormulaValues
SaveFormulaValues(UnitName, ValueName[, IgnoreErrors])
Este mtodo salva os valores atuais dos Tags de uma unidade de origem em um
conjunto de valores na tabela de frmulas. Este mtodo no faz a verificao dos
limites, caso o template tenha uma restrio do tipo absoluta. O parmetro
UnitName o nome da unidade de origem e o parmetro ValueName o conjunto de
valores que ser salvo. Retorna True se conseguir realizar a operao. Do
contrrio, retorna False. O parmetro IgnoreErrors, quando em True, faz com que
todos os valores sejam gravados, independente de haver erros de associaes na
Frmula. Seu valor padro False, no entanto. Exemplo:
Sub Botao1_Click()
Application.GetObject("Formula1") SaveFormulaValues
"Unidade1", "Valor1"
End Sub

454

Objetos de Servidor

5.10.1.13 SetUnitData
SetUnitData(UnitName, TemplateName, Data)
Carrega para a tabela de frmulas o Tag identificado para um certo modelo
(template), em uma determinada unidade. Retorna True se conseguir realizar a
operao ou False, caso contrrio. Este mtodo possui os parmetros UnitName,
que informa o nome da unidade, TemplateName, que informa o nome do template do
Tag e Data, que informa o nome da varivel que contm o nome do Tag. Exemplo:
Sub Botao1_Click()
Application.GetObject("Formula1").SetUnitData _
"Unidade2", "Template5", 50
End Sub

5.10.1.14 SetValueData
SetValueData(ValueName, TemplateName, Data)
Altera o valor referente a um template definido para um determinado conjunto de
valores. Este mtodo faz a verificao dos limites, retornando Verdadeiro se
conseguir realizar a operao ou Falso, caso contrrio. Este mtodo possui os
parmetros ValueName, que determina o nome do conjunto de valores,
TemplateName, que determina o nome do template e Data, que determina o nome da
varivel que possui o valor. Exemplo:
Sub Botao1_Click()
Application.GetObject("Formula1").SetValueData _
"Unidade2", "Template1", 100
End Sub
NOTA: Pa ra ma i ores i nforma es s obre o mtodo SetValueData, cons ul te os a rti gos
KB 35, KB 280 e KB 119, do Elipse Knowledgebase.

5.10.2 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Frmula.

5.10.2.1 DBServer
Indica o nome do banco de dados onde sero gravadas as informaes da
Frmula, ou seja, as unidades e os conjuntos de valores. O valor padro desta
propriedade uma String vazia.

5.10.2.2 ImmediateExecute
Quando habilitada, faz com que a Frmula escreva seus registros diretamente no
Banco de Dados, sem precisar passar por suas filas de operaes (arquivos .e3i e
.e3o). Isso faz com que as operaes feitas no Banco de Dados sejam vistas de
Objetos de Servidor

455

forma mais rpida.

5.10.2.3 TableName
Indica o nome das tabelas onde ficaro as informaes das Frmulas. O valor
padro desta propriedade uma String vazia.

5.11 Alarmes
Esta seo contm informaes sobre eventos, mtodos e propriedades dos objetos
Configurao de Alarmes, reas de Alarme, Fontes de Alarme e Servidor de Alarmes.

5.11.1 Configurao de Alarmes


O objeto Configurao de Alarmes no contm eventos, mtodos ou propriedades
especficos, somente gerais. Estes podem ser visualizados na seo Eventos,
Mtodos e Propriedades Gerais dos Objetos.

5.11.2 reas de Alarme


Esta seo contm informaes sobre propriedades do objeto rea de Alarme. Este
objeto no possui eventos nem mtodos associados.

5.11.2.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto rea de Alarme.

5.11.2.1.1 ActiveAlarms
Determina o nmero de alarmes ativos dentro da rea do sistema. Esta
propriedade somente de leitura e seu valor padro 0 (zero).

5.11.2.1.2 ActiveHighAlarms
Indica o nmero de alarmes ativos com severidade alta. Esta propriedade
somente de leitura.

5.11.2.1.3 ActiveHighNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade alta. Esta
propriedade somente de leitura.

5.11.2.1.4 ActiveLowAlarms
Indica o nmero de alarmes ativos com severidade baixa. Esta propriedade
somente de leitura.
456

Objetos de Servidor

5.11.2.1.5 ActiveLowNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade baixa. Esta
propriedade somente de leitura.

5.11.2.1.6 ActiveMedAlarms
Indica o nmero de alarmes ativos com severidade mdia. Esta propriedade
somente de leitura.

5.11.2.1.7 ActiveMedNACKAlarms
Indica o nmero de alarmes no reconhecidos com severidade mdia. Esta
propriedade somente de leitura.

5.11.2.1.8 ActiveNACKAlarms
Indica o nmero de alarmes que esto sem reconhecimento dentro da rea. Esta
propriedade somente de leitura.

5.11.2.1.9 Alarm
Estabelece a existncia de alarmes ativos dentro da rea. Se a opo estiver em
True, o sistema tem pelo menos um alarme ativo dentro da rea, e a propriedade
ActiveAlarms far a leitura no sistema, indicando a quantidade de alarme ativos.
Caso contrrio, a propriedade ActiveNACKAlarms far a leitura dos alarmes sem
reconhecimento. Esta propriedade somente de leitura.

5.11.2.1.10 AlarmVerify
Habilita a verificao de todos os alarmes dentro da rea. Depois de habilitada
esta verificao (True), se a propriedade ActiveAlarms possuir valor maior que 0
(zero), o sistema verifica tanto os alarmes ativos quanto os sem reconhecimento,
listando estes ltimos pela propriedade ActiveNACKAlarms. Esta propriedade til
para evitar-se o efeito de avalanche de alguns sistemas, onde o acontecimento de
um evento gera uma grande quantidade de alarmes correlacionados.

5.11.2.1.11 InactiveHighNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade alta.
Esta propriedade somente de leitura.

5.11.2.1.12 InactiveLowNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade baixa.
Esta propriedade somente de leitura.
Objetos de Servidor

457

5.11.2.1.13 InactiveMedNACKAlarms
Indica o nmero de alarmes inativos e no reconhecidos com severidade mdia.
Esta propriedade somente de leitura.

5.11.2.1.14 InactiveNACKAlarms
Determina o nmero total de alarmes inativos e no reconhecidos. Esta
propriedade somente de leitura.

5.11.2.1.15 UserFields
Retorna um objeto que uma coleo de Campos de Usurio de Alarmes de uma
rea de Alarme. Veja o item Coleo de Campos de Usurio de Alarmes para maiores
informaes sobre a coleo de objetos retornados por esta propriedade.

5.11.3 Fontes de Alarme


Esta seo contm informaes sobre mtodos e propriedades comuns ao objeto
Fonte de Alarme. Este objeto no possui eventos comuns associados.
NOTA: Qua ndo um objeto Fonte de Al a rme des a bi l i ta do ou des a ti va do, a s
propri eda des ActiveNACKAlarm, Alarm, CurrentSeverity, CurrentSubConditionName,
FormattedValue, RawAlarm e Value a s s umem s eus va l ores pa dr o, i ndi ca ndo que a
Fonte de Al a rme n o es t vi ncul a da a uma mens a gem de a l a rme a ti va . Nes te ca s o,
os va l ores da s propri eda des Alarm e ActiveNACKAlarm s o propa ga dos pa ra os
conta dores da s rea s s uperi ores .
Pa ra que a s propri eda des ci ta da s receba m um va l or di ferente do pa dr o,
neces s ri o que a s s egui ntes condi es es teja m pres entes :
A Fonte de Al a rme deve es ta r ha bi l i ta da e a ti va da
As reas de Alarme (e todos os objetos hi era rqui ca mente s uperi ores ) devem es ta r
ha bi l i ta da s e a ti va da s
O Servidor de Alarmes deve es ta r a ti va do

5.11.3.1 Mtodos Comuns


Esta seo contm informaes sobre os mtodos comuns aos objetos Fontes de
Alarme.

5.11.3.1.1 Ack
Ack([ActorID])
Executa o reconhecimento de um alarme configurado no objeto Fonte de Alarmes. O
mtodo retorna um Booleano que indica o sucesso ou no da operao. O
parmetro ActorID informa o nome do usurio responsvel pelo reconhecimento
458

Objetos de Servidor

dos alarmes. Este parmetro opcional e, se for omitido, assume o logon do


usurio do Viewer, "Anonymous" se no h usurio logado, ou "System" se a
chamada do mtodo foi originada no servidor.

5.11.3.1.2 GetAlarm
GetAlarm()
Retorna um objeto que permite o acesso s configuraes especficas de cada tipo
de alarme. Isto permite verificar ou modificar em tempo de execuo as
propriedade de um determinado alarme. Dependendo do tipo de alarme, o mtodo
retornar as seguintes propriedades:
Alarme Digital: Responsvel pelas configuraes de alarme digital
Propriedades do Alarme Digital
ITEM
DigitalReturnMessageText
Digital
DigitalLimit
DigitalMessageText
DigitalSeverity

DigitalAckRequired

DESCRIO
Mens a gem de retorno do a l a rme di gi ta l .
Ha bi l i ta ou des a bi l i ta a veri fi ca o de
a l a rme di gi ta l .
Li mi te pa ra o a l a rme di gi ta l .
Texto da mens a gem de a l a rme di gi ta l .
Severi da de do a l a rme di gi ta l . Conjunto de
va l ores :
0: Al ta
1: Mdi a
2: Ba i xa
Neces s i da de de reconheci mento pa ra es te
ti po de a l a rme (di gi ta l ).

Alarme Analgico: Responsvel pelas configuraes do alarme analgico.


Propriedades deste objeto (tem quatro nveis de alarme):

Propriedades do Alarme Analgico


ITEM
LevelDeadBand
LevelReturnMessageText

DESCRIO
Ba nda morta pa ra o a l a rme de nvei s .
Mens a gem de retorno de a l a rme.

Alarme LoLo (Muito Baixo)


ITEM
LoLo
LoLoLimit

Objetos de Servidor

DESCRIO
Ha bi l i ta ou des a bi l i ta a veri fi ca o de
a l a rme Mui to Ba i xo.
Li mi te pa ra o nvel de a l a rme Mui to Ba i xo.

459

ITEM
LoLoMessageText
LoLoSeverity

LoLoAckRequired

DESCRIO
Texto da mens a gem de a l a rme Mui to
Ba i xo.
Import nci a do nvel de a l a rme Mui to
Ba i xo. Conjunto de va l ores :
0: Al ta
1: Mdi a
2: Ba i xa
Neces s i da de de reconheci mento pa ra es te
nvel de a l a rme (Mui to Ba i xo).

Alarme Lo (Baixo)
ITEM
Lo
LoLimit
LoMessageText
LoSeverity

LoAckRequired

DESCRIO
Ha bi l i ta ou des a bi l i ta a veri fi ca o de
a l a rme Ba i xo.
Li mi te pa ra o nvel de a l a rme Ba i xo.
Texto da mens a gem de a l a rme Ba i xo.
Import nci a do nvel de a l a rme Ba i xo.
Conjunto de va l ores :
0: Al ta
1: Mdi a
2: Ba i xa
Neces s i da de de reconheci mento pa ra es te
nvel de a l a rme (Ba i xo).

Alarme Hi (Alto)
ITEM
Hi
HiLimit
HiMessageText
HiSeverity

HiAckRequired

460

DESCRIO
Ha bi l i ta ou des a bi l i ta a veri fi ca o de
a l a rme Al to.
Li mi te pa ra o nvel de a l a rme Al to.
Texto da mens a gem de a l a rme Al to.
Import nci a do nvel de a l a rme Al to.
Conjunto de va l ores :
0: Al ta
1: Mdi a
2: Ba i xa
Neces s i da de de reconheci mento pa ra es te
nvel de a l a rme (Al to).

Objetos de Servidor

Alarme HiHi (Muito Alto)


ITEM

DESCRIO
Ha bi l i ta ou des a bi l i ta a veri fi ca o de
a l a rme Mui to Al to.
Li mi te pa ra o nvel de a l a rme Mui to Al to.
Texto da mens a gem de a l a rme Mui to Al to.
Import nci a do nvel de a l a rme Mui to Al to.
Conjunto de va l ores :
0: Al ta
1: Mdi a
2: Ba i xa
Neces s i da de de reconheci mento pa ra es te
nvel de a l a rme (Mui to Al to).

HiHi
HiHiLimit
HiHiMessageText
HiHiSeverity

HiHiAckRequired

Alarme Taxa de Variao: Responsvel por configuraes de alarme de taxa de


variao
Propriedades do Alarme Taxa de Variao
ITEM
ROCReturnMessageText
ROC
ROCLimit

ROCMessageText
ROCSeverity

ROCAckRequired

DESCRIO
Mens a gem de retorno da ta xa de muda na .
Ha bi l i ta ou des a bi l i ta a veri fi ca o de
a l a rme de ta xa de va ri a o.
Li mi te pa ra o a l a rme de ta xa de muda na .
Pa ra o a l a rme ocorrer, ba s ta que o va l or do
Ta g a s s oci a do ul tra pa s s e es s e va l or em
um s egundo.
Texto da mens a gem de a l a rme de ta xa de
muda na .
Import nci a do a l a rme de ta xa de
muda na . Conjunto de va l ores :
0: Al ta
1: Mdi a
2: Ba i xa
Neces s i da de de reconheci mento pa ra es te
ti po de a l a rme (ta xa de muda na ).

Alarme Banda Morta: Responsvel por configuraes de alarme de banda morta

Objetos de Servidor

461

Propriedades do Alarme Banda Morta


ITEM
DeadBandSetPoint

DeadBandReturnMessageText
DeadBand
DeadBandLimit
DeadBandMessageText
DeadBandSeverity

DeadBandAckRequired

DESCRIO
Li mi te de ba nda morta do a l a rme. Ca da vez
que o va l or do Ta g a s s oci a do ul tra pa s s a r o
va l or des ta propri eda de pa ra ma i s ou pa ra
menos do va l or de DeadBandLimit, o a l a rme
ocorrer .
Mens a gem de retorno de a l a rme de ba nda
morta .
Ha bi l i ta ou des a bi l i ta a veri fi ca o de
a l a rme de ba nda morta .
Li mi te pa ra o a l a rme de ba nda morta .
Texto da mens a gem de a l a rme de ba nda
morta .
Import nci a do a l a rme de ba nda morta .
Conjunto de va l ores :
0: Al ta
1: Mdi a
2: Ba i xa
Neces s i da de de reconheci mento pa ra es te
ti po de a l a rme (ba nda morta ).

Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botao muda o nivel de alarme Lo do
' AlarmSource BatteryLevel
Application.GetObject("ConfigAlarmes1.Area1.BatteryLevel")_
.GetAlarm().LoLimit = 10.2
End Sub
NOTA: a s propri eda des rel a ti va s a ca da ti po de a l a rme podem s er a ces s a da s
di reta mente por s cri pts e As s oci a es , bem como vi s ua l i za da s na Li s ta de
Propri eda des do objeto, n o ma i s s endo obri ga tri a s ua edi o vi a mtodo
GetAlarm.

5.11.3.2 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns aos objetos Fonte
de Alarme.

5.11.3.2.1 ActiveNACKAlarm
Se ajustada para True, indica que a Fonte no foi reconhecida desde a ltima
ativao. Esta propriedade somente de leitura. O valor padro desta propriedade
False.
462

Objetos de Servidor

5.11.3.2.2 Alarm
Se ajustada para True, indica a condio ativa do alarme. O valor padro desta
propriedade False.

5.11.3.2.3 AlarmVerify
Se ajustada para True, habilita a verificao da Fonte de Alarme (ou seja, a
gerao do alarme).

5.11.3.2.4 AreaNameOverride
Determina um nome alternativo para a rea que contm a Fonte de Alarme. O
valor padro desta propriedade uma String vazia.
NOTAS:
Qua ndo es ta propri eda de es t va zi a , o nome da Fonte de Al a rme compos to dos
nomes dos objetos rea hi era rqui ca mente s uperi ores .
Es ta propri eda de, mes mo qua ndo preenchi da , n o i nfl uenci a nos conta dores da
rea s de Al a rme hi era rqui ca mente s uperi ores , que conti nua r o conta ndo os
a l a rmes des ta Fonte de Al a rme.
Se es ta propri eda de for a l tera da em tempo de execu o, o novo va l or s entra r
em vi gor qua ndo ocorrer o prxi mo a l a rme nes ta Fonte de Al a rme.

5.11.3.2.5 CurrentSeverity
Indica a ltima severidade do alarme ativo, a saber:
0: Alta
1: Mdia
2: Baixa
O valor padro desta propriedade -1, indicando que a Fonte de Alarme no est
ativa.

5.11.3.2.6 CurrentSubConditionName
Determina o nome da ltima condio de alarme ativa. As opes disponveis
para esta propriedade so:
Opes disponveis para CurrentSubConditionName
OPO
LOLO
LO

Objetos de Servidor

DESCRIO
Al a rme Ana l gi co na fa i xa LOLO.
Al a rme Ana l gi co na fa i xa LO.

463

OPO
HI
HIHI
BM
TV
DIG

Al a rme
Al a rme
Al a rme
Al a rme
Al a rme

DESCRIO
Ana l gi co na fa i xa HI.
Ana l gi co na fa i xa HIHI.
de Ba nda Morta .
Ta xa de Va ri a o.
Di gi ta l .

O valor padro desta propriedade uma String vazia.

5.11.3.2.7 Delay
Especifica um tempo de atraso para o alarme (em ms), tanto na entrada quanto na
sada da condio. Quando essa propriedade estiver em 0 (que ser sempre o valor
padro), no aplicado nenhum atraso. Quando for diferente de 0, o alarme s
ser ativado ou desativado se permanecer na mesma condio por um tempo maior
ou igual ao especificado.

5.11.3.2.8 DoubleAckRequired
Quando configurada como True, indica que o alarme pode ser reconhecido tanto
quando est ativo como quando passa a inativo, ou seja, pode ser reconhecido
duplamente. Quando configurada como False, indica que o alarme s pode ser
reconhecido uma vez, e ao ser reconhecido sai da lista de alarmes. Alarmes que
no necessitem reconhecimento (propriedade AckRequired) no possibilitam esta
personalizao. Aplicaes anteriores verso 2.5 vm com esta propriedade
configurada como False.

5.11.3.2.9 Event
Quando configurada como Verdadeiro, indica que o alarme do tipo Evento. Um
alarme do tipo Evento, ao ser ativado, reconhecido pelo usurio "System".
Portanto, ao ser reconhecido nada acontece (no tem efeito algum), assim como
no incrementa o nmero de alarmes ativos nem o nmero de alarmes no
reconhecidos. No pode ser modificada em tempo de execuo.

5.11.3.2.10 Format
A propriedade Format especifica que tipo de formato ser atribudo ao objeto.
Permite mudar a forma como os dados so apresentados sem mudar o valor que
existe por trs deles. Esta propriedade pode ser editada manualmente ou
configurada atravs da janela de formatao. Seu uso semelhante aos
formatadores usados nas planilhas de dados, seguindo a mesma sintaxe bsica.
So suportados os seguintes tipos de dados:

464

Objetos de Servidor

Tipos de dados suportados por Format


DADOS
Numrico
Texto
Booleano
Data e Hora

DESCRIO
Sa da deci ma l , ci entfi ca , hexa deci ma l ,
bi n ri a e octa l .
Textos em gera l .
Va l ores bol ea nos .
Ca l end ri o Gregori a no.

5.11.3.2.11 FormattedValue
Contm o valor do alarme conforme a propriedade Value, formatado de acordo
com a propriedade Format. Esta propriedade somente de leitura. O valor padro
desta propriedade Null.

5.11.3.2.12 RawAlarm
Indica se o alarme deve estar ativo, independentemente da espera. Quando a
espera for igual a 0 (zero), o valor de RawAlarm ser o mesmo da propriedade
Alarm. Esta propriedade somente de leitura. O valor padro desta propriedade
False.

5.11.3.2.13 Source
Contm a expresso que dever ser avaliada para determinar se o alarme deve
ocorrer ou no.

5.11.3.2.14 UserFields
Retorna um objeto que uma coleo de Campos de Usurio de Alarmes de uma
Fonte de Alarme. Veja o item Coleo de Campos de Usurio de Alarmes para
maiores informaes sobre a coleo de objetos retornados por esta propriedade.

5.11.3.2.15 Value
Contm o valor do que foi avaliado para determinar se o alarme ocorre ou no. O
valor padro desta propriedade Null.

5.11.3.3 Fonte de Alarme Analgico


Esta seo contm informaes sobre propriedades do objeto Fonte de Alarme
Analgico. Este objeto no possui eventos nem mtodos associados.

Objetos de Servidor

465

Qua ndo o va l or da propri eda de Event (comum a toda s a s Fontes de Al a rme) es t


confi gura do pa ra Verda dei ro, a s propri eda des HiEvent, HiHiEvent, LoEvent e LoLoEvent
n o podem s er modi fi ca da s (toda s a s s ubcondi es do a l a rme s e comporta m como
eventos ).

5.11.3.3.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Fonte de Alarme
Analgico.
5.11.3.3.1.1 Hi
Habilita ou desabilita a verificao de alarmes do tipo Hi.
5.11.3.3.1.2 HiAckRequired
Indica que o alarme do tipo Hi requer reconhecimento.
5.11.3.3.1.3 HiEvent
Define se a subcondio Hi do Alarme deve ser tratada como um evento. Se a
propriedade Event, comum s Fontes de Alarme, estiver configurada para
Verdadeiro, esta propriedade no pode ser modificada e seu valor fica sempre em
Verdadeiro. Alm disso, esta propriedade no pode ser modificada em tempo de
execuo.
5.11.3.3.1.4 HiHi
Habilita ou desabilita a verificao de alarmes do tipo HiHi.
5.11.3.3.1.5 HiHiAckRequired
Indica que o alarme do tipo HiHi requer reconhecimento.
5.11.3.3.1.6 HiHiEvent
Define se a subcondio HiHi do Alarme deve ser tratada como um evento. Se a
propriedade Event, comum s Fontes de Alarme, estiver configurada para
Verdadeiro, esta propriedade no pode ser modificada e seu valor fica sempre em
Verdadeiro. Alm disso, esta propriedade no pode ser modificada em tempo de
execuo.
5.11.3.3.1.7 HiHiLimit
Indica o nvel em que o alarme HiHi ser ativado.

466

Objetos de Servidor

5.11.3.3.1.8 HiHiMessageText
Ajusta a mensagem de texto do limite do alarme de tipo HiHi.
5.11.3.3.1.9 HiHiSeverity
Indica o nvel de importncia do alarme de tipo HiHi. As opes so:
0: Alta
1: Mdia
2: Baixa
5.11.3.3.1.10 HiLimit
Indica o nvel em que o alarme Hi ser ativado.
5.11.3.3.1.11 HiMessageText
Ajusta a mensagem de texto do limite do alarme de tipo Hi.
5.11.3.3.1.12 HiSeverity
Indica o nvel de importncia do alarme de tipo Hi. As opes so:
0: Alta
1: Mdia
2: Baixa
5.11.3.3.1.13 LevelDeadBand
Banda morta para os limites do nvel do alarme.
5.11.3.3.1.14 LevelReturnMessageText
Ajusta a mensagem de retorno do nvel do alarme.
5.11.3.3.1.15 Lo
Habilita ou desabilita a verificao de alarmes do tipo Lo.
5.11.3.3.1.16 LoAckRequired
Indica que o alarme do tipo Lo requer reconhecimento.
Objetos de Servidor

467

5.11.3.3.1.17 LoEvent
Define se a subcondio Lo do Alarme deve ser tratada como um evento. Se a
propriedade Event, comum s Fontes de Alarme, estiver configurada para
Verdadeiro, esta propriedade no pode ser modificada e seu valor fica sempre em
Verdadeiro. Alm disso, esta propriedade no pode ser modificada em tempo de
execuo.
5.11.3.3.1.18 LoLimit
Indica o nvel em que o alarme Lo ser ativado.
5.11.3.3.1.19 LoLo
Habilita ou desabilita a verificao de alarmes do tipo LoLo.
5.11.3.3.1.20 LoLoAckRequired
Indica que o alarme do tipo LoLo requer reconhecimento.
5.11.3.3.1.21 LoLoEvent
Define se a subcondio LoLo do Alarme deve ser tratada como um evento. Se a
propriedade Event, comum s Fontes de Alarme, estiver configurada para
Verdadeiro, esta propriedade no pode ser modificada e seu valor fica sempre em
Verdadeiro. Alm disso, esta propriedade no pode ser modificada em tempo de
execuo.
5.11.3.3.1.22 LoLoLimit
Indica o nvel em que o alarme LoLo ser ativado.
5.11.3.3.1.23 LoLoMessageText
Ajusta a mensagem de texto do limite do alarme de tipo LoLo.
5.11.3.3.1.24 LoLoSeverity
Indica o nvel de importncia do alarme de tipo LoLo. As opes so:
0: Alta
1: Mdia
2: Baixa

468

Objetos de Servidor

5.11.3.3.1.25 LoMessageText
Ajusta a mensagem de texto do limite do alarme de tipo Lo.
5.11.3.3.1.26 LoSeverity
Indica o nvel de importncia do alarme de tipo Lo. As opes so:
0: Alta
1: Mdia
2: Baixa

5.11.3.4 Fonte de Alarme Digital


Esta seo contm informaes sobre propriedades do objeto Fonte de Alarme
Digital. Este objeto no possui eventos nem mtodos associados.

5.11.3.4.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Fonte de Alarme
Digital.
5.11.3.4.1.1 Digital
Habilita ou desabilita a verificao de alarme digital.
5.11.3.4.1.2 DigitalAckRequired
Necessidade de reconhecimento para o alarme digital.
5.11.3.4.1.3 DigitalLimit
Limite para o alarme digital.
5.11.3.4.1.4 DigitalMessageText
Texto da mensagem de alarme digital.
5.11.3.4.1.5 DigitalReturnMessageText
Mensagem de retorno do alarme digital.

Objetos de Servidor

469

5.11.3.4.1.6 DigitalSeverity
Severidade do alarme digital. Conjunto de valores:
0: Alta
1: Mdia
2: Baixa

5.11.3.5 Fonte de Alarme Banda Morta


Esta seo contm informaes sobre propriedades do objeto Fonte de Alarme
Banda Morta. Este objeto no possui eventos nem mtodos associados.

5.11.3.5.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Fonte de Alarme
Banda Morta.
5.11.3.5.1.1 DeadBand
Habilita ou desabilita a verificao de alarme de banda morta.
5.11.3.5.1.2 DeadBandAckRequired
Necessidade de reconhecimento para o alarme de banda morta.
5.11.3.5.1.3 DeadBandLimit
Limite para o alarme de banda morta.
5.11.3.5.1.4 DeadBandMessageText
Texto da mensagem de alarme de banda morta.
5.11.3.5.1.5 DeadBandReturnMessageText
Mensagem de retorno de alarme de banda morta.
5.11.3.5.1.6 DeadBandSetpoint
Limite de banda morta do alarme. Cada vez que o valor do Tag associado
ultrapassar o valor desta propriedade para mais ou para menos do valor de
DeadBandLimit, o alarme ocorrer.

470

Objetos de Servidor

5.11.3.5.1.7 DeadBandSeverity
Importncia do alarme de banda morta. Conjunto de valores:
0: Alta
1: Mdia
2: Baixa

5.11.3.6 Fonte de Alarme Taxa de Variao


Esta seo contm informaes sobre propriedades do objeto Fonte de Alarme Taxa
de Variao. Este objeto no possui eventos nem mtodos associados.

5.11.3.6.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Fonte de Alarme
Taxa de Variao.
5.11.3.6.1.1 ROC
Habilita ou desabilita a verificao de alarme de taxa de variao.
5.11.3.6.1.2 ROCAckRequired
Necessidade de reconhecimento para o alarme de taxa de variao.
5.11.3.6.1.3 ROCLimit
Limite para o alarme de taxa de variao. Para o alarme ocorrer, basta que o
valor do Tag associado ultrapasse esse valor em um segundo.
5.11.3.6.1.4 ROCMessageText
Texto da mensagem do alarme de taxa de variao.
5.11.3.6.1.5 ROCReturnMessageText
Mensagem de retorno do alarme de taxa de variao.
5.11.3.6.1.6 ROCSeverity
Importncia do alarme de taxa de variao. Conjunto de valores:
0: Alta
1: Mdia
Objetos de Servidor

471

2: Baixa

5.11.3.7 Fonte de Alarme Discreto


Esta seo contm informaes sobre propriedades do objeto Fonte de Alarme
Discreto. Este objeto no possui eventos nem mtodos associados.
Qua ndo o va l or da propri eda de Event (comum a toda s a s Fontes de Al a rme) es t
confi gura do pa ra Verda dei ro, a propri eda de Kind dos objetos da col e o de
Subcondi es da Fonte de Al a rme Di s creto n o pode s er modi fi ca da (toda s a s
s ubcondi es do a l a rme s e comporta m como eventos ).

5.11.3.7.1 Propriedades
Esta seo contm informaes sobre as propriedades do objeto Fonte de Alarme
Discreto.
5.11.3.7.1.1 DiscreteReturnMessageText
Retorna ou modifica a mensagem de retorno da Fonte de Alarme Discreto. Se
algum dos objetos da coleo de Subcondies tiver sua propriedade Kind
configurada para 2 (Retorno), a propriedade Message deste objeto ser utilizada,
ao invs do valor definido em DiscreteReturnMessageText.
5.11.3.7.1.2 SubConditions
Retorna um objeto que uma coleo das Subcondies da Fonte de Alarme
Discreto. Veja o item Coleo de Subcondies para maiores informaes sobre a
coleo de objetos retornados por esta propriedade.

5.11.3.7.2 Coleo de Subcondies


Esta seo contm informaes sobre mtodos e propriedades comuns coleo
de Subcondies retornada pela propriedade SubConditions de uma Fonte de
Alarme Discreto.
5.11.3.7.2.1 Mtodos Comuns
Esta seo contm informaes sobre os mtodos comuns coleo de
Subcondies de uma Fonte de Alarme Discreto.

AddSubCondition
AddSubCondition([Name, Caption, Message, Kind, AckRequired, Severity, Value])
Adiciona um objeto Subcondio coleo de Subcondies. Este mtodo possui os
seguintes parmetros opcionais:
472

Objetos de Servidor

Parmetros do mtodo AddSubCondition


PARMETRO
Name

Caption
Message
Kind

AckRequired

Severity

Value

DESCRIO
O nome do objeto. Corres ponde
propri eda de Name do objeto
Subcondi o. Se for omi ti do, a
Subcondi o s er cri a da com o nome
"Subcondi ca o". Se o va l or pa s s a do nes te
pa r metro j exi s ti r na col e o, s er
a utoma ti ca mente i ncrementa do.
A des cri o do objeto. Corres ponde
propri eda de Caption do objeto
Subcondi o.
O texto da mens a gem da Subcondi o.
Corres ponde propri eda de Message do
objeto Subcondi o.
O ti po de comporta mento des ta
Subcondi o. Os va l ores pos s vei s pa ra
es te pa r metro s o: 0 - Al a rme (pa dr o);
1 - Evento; 2 - Retorno. Corres ponde
propri eda de Kind do objeto Subcondi o.
Indi ca s e es ta Subcondi o exi ge
reconheci mento. Corres ponde
propri eda de AckRequired do objeto
Subcondi o. O va l or pa dr o des ta
propri eda de Verda dei ro.
O ti po de s everi da de des ta Subcondi o.
Os va l ores pos s vei s pa ra es te pa r metro
s o: 0 - Al ta ; 1 - Mdi a (pa dr o); 2 - Ba i xa .
Corres ponde propri eda de Severity do
objeto Subcondi o.
Pa r metro que contm um va l or que s er
a va l i a do pa ra determi na ndo s e o a l a rme
ocorre ou n o. Corres ponde
propri eda de Value, comum s Fontes de
Al a rme.

Item
Item(Index)
Retorna uma referncia para um objeto Subcondio, indicado por Index. Este
parmetro pode ser o ndice na coleo (iniciando em 1) ou o nome do objeto
(propriedade Name).

RemoveSubCondition
RemoveSubCondition(Index)
Remove o objeto Subcondio, indicado pelo parmetro Index. Este parmetro pode
ser o ndice na coleo (iniciando em 1) ou o nome do objeto (propriedade Name).
Objetos de Servidor

473

5.11.3.7.2.2 Propriedades Comuns


Esta seo contm informaes sobre as propriedades comuns coleo de
Subcondies de uma Fonte de Alarme Discreto.

Count
Retorna o nmero de objetos filhos (itens) de uma coleo de Subcondies. Esta
propriedade trabalha em conjunto com o mtodo Item. Se a coleo no possui
objetos filhos, o valor retornado 0 (zero).
5.11.3.7.2.3 Subcondies
Esta seo contm informaes sobre propriedades de objetos do tipo Subcondio
contidos na coleo retornada pela propriedade SubConditions da Fonte de Alarme
Discreto. Este objeto no possui eventos nem mtodos associados.

Propriedades
Esta seo contm informaes sobre propriedades do objeto Subcondio.

AckRequired
Indica se este objeto Subcondio requer reconhecimento.

Caption
Descrio da Subcondio.

Enabled
Habilita ou desabilita a Subcondio.

Kind
Indica o comportamento da Subcondio. Os valores possveis para esta
propriedade so os seguintes:
0: Alarme
1: Evento
2: Retorno
Se a propriedade Event, comum s Fontes de Alarme, estiver configurada para
Verdadeiro, esta propriedade no pode ser modificada e seu valor fica sempre em 1
(Evento). Alm disso, esta propriedade no pode ser modificada em tempo de
execuo.

Limit
Define o valor da Fonte de Alarme para gerar a Subcondio.
474

Objetos de Servidor

Message
A mensagem do evento quando a Subcondio est ativa. Se a propriedade Kind
estiver configurada como 2 (Retorno), esta propriedade ser considerada como a
mensagem de retorno do alarme.

Name
Nome do objeto Subcondio. Este valor no diferencia maisculas e minsculas.

Severity
O tipo de severidade desta Subcondio. Os valores possveis para esta
propriedade so:
0: Alta
1: Mdia
2: Baixa

5.11.4 Servidor de Alarmes


Esta seo contm informaes sobre mtodos e propriedades do objeto Servidor
de Alarme. Este objeto no possui eventos associados.

5.11.4.1 Mtodos
Esta seo contm informaes sobre os mtodos do objeto Servidor de Alarme.

5.11.4.1.1 AckAllAlarms
AckAllAlarms([ActorID])
Executa o reconhecimento de todos os alarmes do servidor, independente da rea.
O mtodo retorna um Booleano que indica o sucesso ou no da operao. O
parmetro ActorID informa o nome do usurio responsvel pelo reconhecimento
dos alarmes. Este parmetro opcional e, se for omitido, assume o logon do
usurio do Viewer, "Anonymous" se no h usurio logado, ou "System" se a
chamada do mtodo foi originada no servidor. Exemplo:
Sub Botao1_Click()
' Quando clica no botao reconhece todos os alarmes
Application.GetObject("ServidorAlarmes1")._
AckAllAlarms(Application.User)
End Sub

5.11.4.1.2 AckArea
AckArea(Area[, ActorID])
Executa o reconhecimento dos alarmes em uma determinada rea. O mtodo
Objetos de Servidor

475

retorna um Booleano que indica o sucesso ou no da operao. O parmetro Area


especifica o nome da(s) rea(s) cujos alarmes sero reconhecidos, atravs da
comparao entre os trechos iniciais dos nomes. Por exemplo, AckArea("ANA")
reconheceria alarmes das reas "ANALOGICOS", "ANA.AREA2", etc. Se o valor deste
parmetro for vazio, o mtodo ter o mesmo comportamento de AckAllAlarms. O
parmetro ActorID informa o nome do usurio responsvel pelo reconhecimento
dos alarmes. Este parmetro opcional e, se for omitido, assume o logon do
usurio do Viewer, "Anonymous" se no h usurio logado, ou "System" se a
chamada do mtodo foi originada no servidor. Exemplo:
Sub Botao1_Click()
'Quando clica no boto reconhece os alarmes da Area1
Application.GetObject("ServidorAlarmes1").AckArea "Area1", _
Application.User
End Sub

5.11.4.1.3 LogTrackingEvent
LogTrackingEvent(Message[, ActorID], Area, Severity, EventTime, Source,
EventCategory, EventType, UserFields, AlarmSourceName, FullAlarmSourceName)
Simula um evento ou alarme e o envia direto para o banco de dados do servidor de
alarmes, sem passar pelo E3Alarm. Por isto, este evento no pode ser visto no
E3Alarm, nem tampouco o alarme pode ser reconhecido.
Cada parmetro do mtodo permite especificar o valor do campo de mesmo nome
no evento. Os campos do evento so preenchidos de acordo com os parmetros do
mtodo:
Parmetros do mtodo LogTrackingEvent
NOME
Message
ActorID

Area

Severity

476

DESCRIO
Pa r metro texto que es peci fi ca o
contedo do ca mpo Mensagem do evento.
Se omi ti do, a s s ume uma String va zi a .
Pa r metro texto opci ona l que es peci fi ca
o contedo do ca mpo Operador do evento.
Se omi ti do, a s s ume o l ogon do us u ri o
do Vi ewer, "Anonymous " s e n o h
us u ri o l oga do, ou "Sys tem" s e a
cha ma da do mtodo foi ori gi na da no
s ervi dor.
Pa r metro texto que es peci fi ca o
contedo do ca mpo rea do evento. Se
omi ti do, a s s ume uma String va zi a .
Pa r metro numri co que determi na a
s everi da de do evento. Se omi ti do,
a s s ume o va l or 0, ou s eja , s everi da de
a l ta .

Objetos de Servidor

NOME
EventTime

Source
EventCategory

EventType
UserFields
AlarmSourceName
FullAlarmSourceName

DESCRIO
Es peci fi ca o timestamp do evento. Se
omi ti d