E3scripts PTB

Copyright 2014 Elipse Software Ltda. Todos os direitos reservados. Verso 4.
5 (23/01/2014)
Manual de Referncia de Scripts
Sumrio
................................................................................................................................................. 5 1 Introduo
.......................................................................................................................................... 5 1.1 Objetos
.......................................................................................................................................... 6 1.2 Scripts
.......................................................................................................................................... 11 1.3 Picks
.......................................................................................................................................... 18 1.4 Eventos Definidos pelo Usurio
................................................................................................................................................. 21 2 Programando no E3
.......................................................................................................................................... 21 2.1 Ambiente de Programao
.......................................................................................................................................... 22 2.2 Declarando Variveis
.......................................................................................................................................... 22 2.3 Obtendo Referncias aos Objetos
.......................................................................................................................................... 41 2.4 Acessando Objetos
.......................................................................................................................................... 42 2.5 Trabalhando com Colees
.......................................................................................................................................... 43 2.6 Comando Set
.......................................................................................................................................... 44 2.7 E3Globals
.......................................................................................................................................... 52 2.8 Eventos, Mtodos e Propriedades Gerais dos Objetos
................................................................................................................................................. 75 3 Bibliotecas do Usurio
.......................................................................................................................................... 75 3.1 XControls e XObjects
.......................................................................................................................................... 77 3.2 Propriedades de um ElipseX
................................................................................................................................................. 80 4 Visualizao
.......................................................................................................................................... 80 4.1 Viewer
.......................................................................................................................................... 108 4.2 Quadros e Divisores
.......................................................................................................................................... 115 4.3 Telas e Objetos de Tela
.......................................................................................................................................... 236 4.4 E3Alarm
.......................................................................................................................................... 252 4.5 E3Browser
.......................................................................................................................................... 259 4.6 E3Chart
.......................................................................................................................................... 303 4.7 E3Playback
.......................................................................................................................................... 305 4.8 Relatrios
................................................................................................................................................. 346 5 Objetos de Servidor
.......................................................................................................................................... 346 5.1 Propriedades Comuns
.......................................................................................................................................... 348 5.2 Coleo de Campos de Usurio de Alarmes
.......................................................................................................................................... 351 5.3 Objetos em Tempo de Execuo do Servidor
.......................................................................................................................................... 354 5.4 Objetos em Tempo de Configurao
.......................................................................................................................................... 357 5.5 Drivers
.......................................................................................................................................... 417 5.6 Servidor de Dados
.......................................................................................................................................... 440 5.7 Banco de Dados
.......................................................................................................................................... 443 5.8 Histricos
.......................................................................................................................................... 447 5.9 Storage
.......................................................................................................................................... 455 5.10 Frmulas
.......................................................................................................................................... 460 5.11 Alarmes
................................................................................................................................................. 486 6 Dvidas Mais Frequentes
Introduo 5
1
Introduo
CAPTULO
Os Scripts so mdul os de l i nguagem de programao nos quai s se pode cri ar
procedi mentos associ ados a eventos especfi cos, permi ti ndo uma mai or
fl exi bi l i dade no desenvol vi mento de apl i caes. Cada objeto (i tem de um
apl i cati vo) do E3 possui uma l i sta de eventos previ amente defi ni dos, mas tambm
possvel defi ni r novos eventos prpri os do usuri o.
1.1 Objetos
Os Objetos so componentes de software reuti l i zvei s que permi tem maxi mi zar o
uso e aumentar a qual i dade e produti vi dade em seus apl i cati vos.
Um objeto no E3 encapsul a ou contm trs di ferentes partes (propri edades,
mtodos e eventos) que podem ser mani pul adas para a uti l i zao das vantagens de
sua funci onal i dade na apl i cao.
Propriedades defi nem atri butos de um objeto, como a aparnci a de um objeto de
Tel a ou o val or i ni ci al de um objeto quando o apl i cati vo i ni ci ado.
Mtodos so funes que real i zam uma ao especfi ca dentro ou com um objeto.
Eventos so noti fi caes geradas por um objeto em resposta a al guma ocorrnci a
em parti cul ar, como um cl i que de mouse ou uma mudana no val or de um Tag,
entre outros.
Uma das pri nci pai s caractersti cas dos objetos e das l i nguagens ori entadas a
objeto a capaci dade de herana entre el es, ou seja, estes podem herdar as
caractersti cas de um ou mai s objetos, tendo as mesmas funci onal i dades
especfi cas. Assi m, pode se ter vri os objetos trabal hando em conjunto para prover
caractersti cas de um outro objeto deri vado.
Tome como exempl o o objeto E3Chart. El e composto i nternamente de vri os
objetos, como ttul os, l egendas, escal as, di vi ses, consul tas e penas. Note que cada
objeto contri bui para a funci onal i dade do todo: as escal as ajudam a l ocal i zar os
val ores dos pontos no E3Chart; as l egendas, a i denti fi car a pena e seus val ores; e a
pena real i za o desenho dos val ores no E3Chart.
Atravs da mani pul ao de objetos dentro do E3Chart, pode-se cri ar duas
i nstnci as deste objeto bastante di ferentes entre si . Para se mani pul ar um objeto
especfi co, deve-se acess-l o atravs de uma hi erarqui a. Se os doi s objetos E3Chart
esti verem na mesma Tel a, deve-se acessar pri mei ro a Tel a, depoi s o E3Chart
desejado, depoi s uma de suas propri edades ou objetos fi l hos. Quando h vri os
objetos de um mesmo ti po, geral mente el es podem ser acessados atravs de uma
col eo (collection). Uma col eo um objeto especi al que gerenci a um conjunto de
objetos semel hantes. Um exempl o no objeto E3Chart a col eo Pens, que permi te
6 Introduo
o acesso a todas as penas do E3Chart.
1.2 Scripts
A l i nguagem que o E3 Studi o usa em seus scri pts o VBScript, um subconjunto da
l i nguagem Vi sual Basi c desenvol vi da pel a Mi crosoft. O VBScri pt possui um
i nterpretador rpi do, l eve e portvel , desenvol vi do para uso em navegadores para
a Internet e outras apl i caes que usam ActiveX Controls, Automation Servers e Java
Applets.
Conforme vi sto anteri ormente, os scri pts so associ ados a eventos de um objeto.
Entretanto, para faci l i tar e aumentar a vel oci dade de desenvol vi mento, o E3 j
i ncorpora al gumas aes mai s comuns que poderi am ser real i zadas com scri pts,
atravs de assi stentes chamados Picks. Pode-se portanto defi ni r que um
determi nado evento executar um scri pt, um Pick ou uma combi nao del es, em
uma sequnci a tambm pr-defi ni da.
Cada view do E3 Studi o apresenta pel o menos duas abas na parte i nferi or: Design e
Scripts, com exceo dos objetos Banco de Dados e Servi dor de Al armes, que no
possuem a aba Design. Os objetos e seus fi l hos podem ser mani pul ados na aba
Design; para mani pul ar seus scri pts, uti l i ze a aba Scripts. As opes di sponvei s
nesta l ti ma so:
Opes disponveis na aba Scripts
CONE OPO DESCRIO
Lista de Objetos
Sel eci ona o objeto
cujo scri pt ser
mani pul ado.
Lista de Eventos
Sel eci ona o
evento a ser
apl i cado ao
objeto.
Script
Adi ci ona um scri pt
associ ado ao
evento.
Pick Abrir Tela
Adi ci ona um Pi ck
Abrir Tela.
Pick Abrir Tela
Modal
Adi ci ona um Pi ck
Abrir Tela Modal.
Pick Executar
Aplicao
Adi ci ona um Pi ck
Executar Aplicao.
Pick Carregar Valor
Adi ci ona um Pi ck
Carregar Valor.
Pick Inverter Valor
Adi ci ona um Pi ck
Inverter Valor.
Pick Imprimir
Relatrio
Adi ci ona um Pi ck
Imprimir Relatrio.
Introduo 7
CONE OPO DESCRIO
Remover script ou
Pick selecionado
Remove o scri pt
ou o Pi ck
sel eci onado na
Li sta de Aes.
Mover script ou Pick
selecionado para
cima
Move a ao
sel eci onada para
ci ma, na ordem da
Li sta de Aes
para o evento.
Mover script ou Pick
selecionado para
baixo
Move a ao
sel eci onada para
bai xo, na ordem
da Li sta de Aes
para o evento.
AppBrowser
Abre a janel a do
AppBrowser.
Procurar
Busca por
ocorrnci as de um
determi nado
texto.
Procurar anterior
Sel eci ona na l i sta
de resul tados a
ocorrnci a
anteri or.
Procurar prxima
Sel eci ona na l i sta
de resul tados a
ocorrnci a
segui nte.
Substituir
Substi tui as
ocorrnci as
encontradas por
outro texto
especi fi cado.
Criar evento do
usurio
Cri a um evento de
usuri o.
Remover evento do
usurio
Remove o evento
de usuri o
sel eci onado.
Editar evento do
usurio
Edi ta o evento de
usuri o
sel eci onado.
Compila o script
selecionado
Compi l a o scri pt
sel eci onado,
mostrando os
erros no pai nel
Mensagens.
Compilar todos os
scripts deste evento
Compi l a todos os
scri pts associ ados
ao evento.
8 Introduo
CONE OPO DESCRIO
Compila todos os
eventos deste
objeto
Compi l a todos os
eventos
associ ados ao
objeto.
A ordem de execuo das aes de ci ma para bai xo. Para al terar a ordem, pode-
se uti l i zar as opes e . Uti l i ze a opo para veri fi car se no h erros no
scri pt especi fi cado para o evento. As mensagens de erro do compi l ador so
apresentadas no pai nel Mensagens, que pode estar em uma janel a fl utuante ou
ancorado na parte i nferi or ou superi or da aba Scripts. Cl i que duas vezes no erro
caso deseje que el e seja sel eci onado no scri pt.
Mensagem do compilador
1.2.1 Adicionando um Script
Para adi ci onar um scri pt a um objeto, si ga estes passos:
1. Sel eci one o objeto para o qual se deseja cri ar o scri pt e cl i que na aba Scripts.
Introduo 9
Aba Scripts
2. Cl i que sobre o cone . O Edi tor de Scri pts aberto, conforme a fi gura a
segui r.
10 Introduo
Adicionando um script ao objeto
3. Di gi te os comandos VBScri pt desejados na cai xa de edi o de texto.
NOTA: Uti l i ze o caractere de subl i nhado quando desejar acrescentar uma quebra de
l i nha, para dei xar o cdi go mai s l egvel . O caractere de subl i nhado i ndi ca que o
cdi go conti nua na l i nha subsequente.
Por exempl o:
If intTemperaturaCaldeira3 > 120 and _
intTemperaturaCaldeira4 > 120 Then
bEnviarAlarme = True
bAlarmeLigado = True
End If
Cada evento pode ter vri os scri pts e vri os Picks associ ados, chamados Aes do
Evento. A l i sta das aes pode ser vi sta na parte superi or da janel a de edi o de
scri pts. Cada objeto pode ter qual quer quanti dade de eventos com scri pts ou Picks
associ ados.
Introduo 11
NOTA: Ao cl i car com o boto di rei to do mouse sobre qual quer destas aes
descri tas anteri ormente, abre-se um menu contextual que possi bi l i ta recortar,
copi ar e col ar scri pts e Picks entre eventos.
1.3 Picks
Os Picks i mpl ementam uma forma mai s ami gvel de real i zar procedi mentos mai s
comuns, poupando tempo de confi gurao. Entre el es, esto aes como troca de
Tel a ou atri bui o de val ores, bastante comuns na cri ao de um projeto. A segui r
so descri tos os Picks di sponvei s na aba Scripts.
1.3.1 Abrir Tela
Abre uma determi nada Tel a ou Quadro.
Configuraes do Pick Abrir Tela
Opes disponveis no Pick Abrir Tela
OPO DESCRIO
Abrir a tela
I ndi ca qual Tel a deve ser aberta.
12 Introduo
OPO DESCRIO
No quadro
I ndi ca o Quadro onde a Tel a ser
vi sual i zada. Se esti ver em branco, ser o
Quadro pri nci pal (_top).
Zoom inicial
Defi ne o zoom da Tel a, quando
mostrada.
Parmetro
I ndi ca um parmetro a ser passado na
chamada da Tel a.
Habilitar scroll da tela
Habi l i ta o uso das barras de rol agem na
Tel a.
Especificar posio da tela
I ndi ca a posi o da Tel a, em pi xel s.
Especificar tamanho da tela
I ndi ca o tamanho da Tel a, em pi xel s ou
Hi metri c.
Estilo da janela
Abre a cai xa de di l ogo Estilo de janela.
1.3.1.1 Caixa de Dilogo Estilo de Janela
Permi te confi gurar o esti l o da janel a a ser mostrada, defi ni ndo ttul o e a
di sponi bi l i dade das bordas e botes de fechar, maxi mi zar e mi ni mi zar, entre
outras opes. Se a opo Usar configurao padro das janelas for marcada, o
si stema desabi l i ta as opes desta janel a e assume a confi gurao padro do
Vi ewer, conforme o que pode ser vi sto na aba Visualizador das propri edades do
objeto Vi ewer.
Introduo 13
Caixa de dilogo Estilo de Janela
1.3.2 Abrir Tela Modal
Abre uma Tel a Modal , i sto , uma Tel a que no permi te a i nterao do usuri o com
outras Tel as enquanto esta esti ver ati va.
14 Introduo
Configuraes do Pick Abrir Tela Modal
Opes disponveis no Pick Abrir Tela Modal
OPO DESCRIO
Abrir a tela
Sel eci ona a Tel a a ser aberta.
Ttulo
Defi ne o ttul o da janel a. Esse texto ser
concatenado com o nome da Tel a.
Zoom inicial
Defi ne o zoom da Tel a, quando
mostrada.
Parmetro
I ndi ca um parmetro a ser passado na
chamada da Tel a.
Habilitar scroll da tela
Habi l i ta o uso das barras de rol agem na
Tel a.
Especificar a posio da tela
Determi na a posi o, em pi xel s, do
quadro na Tel a, a parti r do canto
superi or esquerdo da Tel a.
Especificar o tamanho da tela
Determi na a l argura e a al tura, em pi xel s
ou Hi metri c, da Tel a.
Estilo da janela
Permi te confi gurar o esti l o da janel a a
ser mostrada, defi ni ndo ttul o e a
di sponi bi l i dade das bordas e botes de
fechar, entre outras opes (ver o tpi co
Caixa de Dilogo Estilo de Janela).
Introduo 15
1.3.3 Executar Aplicao
Executa uma apl i cao especfi ca.
Configuraes do Pick Executar Aplicao
Opes disponveis no Pick Executar Aplicao
OPO DESCRIO
Aplicao
Cl i cando-se em pode-se navegar no
di sco para i ndi car o arqui vo da apl i cao
a ser executada.
Argumentos
Permi te especi fi car argumentos para a
chamada da apl i cao.
Executar no diretrio
Determi na o di retri o de trabal ho da
apl i cao que ser executada.
Modo de exibio
Determi na o ti po de janel a de execuo
da apl i cao: Normal, Minimizado ou
Maximizado.
16 Introduo
1.3.4 Carregar Valor
Carrega um val or em um Tag.
Configuraes do Pick Carregar Valor
Opes disponveis no Pick Carregar Valor
OPO DESCRIO
Nome do Tag
Especi fi ca o nome do Tag no qual ser
carregado o val or. Pode-se escol her o Tag
no AppBrowser cl i cando em .
Valor
Determi na o val or que ser carregado no
Tag. Pode-se escol her o ti po de dados
cl i cando na cai xa de sel eo.
1.3.5 Inverter Valor
Permi te i nverter o val or de um Tag. Se o val or do Tag for i gual a Valor1, ento o Tag
recebe Valor2. Se o val or do Tag for i gual a Valor2, ento o Tag recebe Valor1. Se o
val or do Tag no for i gual a Valor1 nem Valor2, o Tag recebe Valor1.
possvel col ocar tantos Pi cks Inverter Valor quantos se desejar. Isso permi te a
Introduo 17
veri fi cao de ml ti pl os val ores para um mesmo Tag ou at mesmo para di versos
Tags em um mesmo evento.
Configuraes do Pick Inverter Valor
Opes disponveis no Pick Inverter Valor
OPO DESCRIO
Nome do Tag
Cl i cando em , abre-se o AppBrowser
para a escol ha do Tag desejado.
Valor 1
Determi na o pri mei ro val or a ser
comparado. Se o val or do Tag for i gual a
Valor1, ento o Tag recebe Valor2.
Valor 2
Determi na o segundo val or a ser
comparado. Se o val or do Tag for i gual a
Valor2, ento o Tag recebe Valor1.
18 Introduo
1.3.6 Imprimir Relatrio
Permi te i mpri mi r um Rel atri o na tel a ou na i mpressora.
Configuraes do Pick Imprimir Relatrio
Opes disponveis no Pick Imprimir Relatrio
OPO DESCRIO
Imprimir relatrio
Permi te escol her o rel atri o a ser
i mpresso.
Sada
Determi na o ti po de sada do rel atri o:
Impressora: Envi a o rel atri o para a
i mpressora. Corresponde ao mtodo Print
Tela: Executa uma prvi a de i mpresso
do rel atri o na tel a. Corresponde ao
mtodo PrintPreview
1.4 Eventos Definidos pelo Usurio
Apesar do E3 vi r com uma extensa gama de eventos, mui tas vezes o usuri o pode
desejar cri ar um evento especfi co para sua apl i cao.
Introduo 19
Um exempl o para a uti l i zao de eventos defi ni dos pel o usuri o seri a a real i zao
de um cl cul o ou tarefa mai s compl exa em um objeto, quando o evento gerador
vem de um outro Tag ou propri edade.
Apesar de se poder cri ar e executar este mesmo ti po de trabal ho a parti r do prpri o
Tag ou da propri edade geradora do evento, exi stem vantagens em manter-se o
scri pt junto ao objeto que sofrer a ao. Dentre el as, pode-se ci tar o trabal ho
adi ci onal necessri o para fazer um objeto apontar para outro, al m de faci l i dades
de manuteno, poi s se por al gum moti vo for necessri o modi fi car ou apagar o Tag
ou a propri edade que seja o evento gerador, no necessri o modi fi car um
segundo objeto.
Outra vantagem o fato de que se o Tag gerador do evento for apagado, o objeto
no perder o scri pt, basta que se i ndi que uma outra fonte geradora de evento.
A gerao de eventos i nternos faci l i ta ai nda a cri ao de bi bl i otecas, poi s cada vez
que um componente de bi bl i oteca i nseri do em uma apl i cao, el e traz consi go os
scri pts e cl cul os que podem ser necessri os, di mi nui ndo o trabal ho de
confi gurao.
Para gerar um novo evento i nterno em um objeto, si ga estes procedi mentos:
1. Cl i que em Criar evento do usurio , ou ento em Criar novo evento na
Li sta de Eventos. O E3 abri r uma janel a para a defi ni o das propri edades do
evento.
Janela para a adio de eventos definidos pelo usurio
20 Introduo
Opes disponveis na janela Eventos
OPO DESCRIO
Nome do Evento
Nome que i denti fi ca o evento.
Propriedade ou expresso
Expresso geradora do evento. Pode ser
copi ada atravs do AppBrowser, ao cl i car
em .
Sempre que a propriedade for uma condio
verdadeira
I ndi ca que o evento ser do ti po
etOnEvent (o evento ocorre no momento
que a expresso for verdadei ra) ou
etWhileEvent (o evento ocorre
ci cl i camente, em i nterval os pr-
defi ni dos).
Repetir o evento
Quando preenchi do, i ndi ca que o evento
ser do ti po etWhileEvent. I ndi ca o ci cl o de
repeti o do evento em mi l i ssegundos,
i sto , de quanto em quanto tempo el e
i r ocorrer, enquanto a expresso
geradora for verdadei ra.
Sempre que a propriedade alterar o seu
valor
I ndi ca que o evento ser do ti po
etOnValueChanged, i sto , o evento i r
ocorrer sempre que a expresso geradora
mudar de val or.
Tratar a desconexo como mudana de
valor
I ndi ca se a conexo ou desconexo da
expresso geradora do evento dever ser
tratada como mudana.
2. Cl i que em OK para compl etar o processo e i nseri r o evento. El e i r aparecer na
l i sta de eventos.
3. Para al terar este evento, sel eci one-o e cl i que em Editar evento do usurio . A
janel a anteri or ser aberta novamente para a edi o de dados do evento.
4. Para apagar este evento, sel eci one-o e cl i que em Remover evento do usurio
.
IMPORTANTE: Quando se cl i ca em Remover evento do usurio, os scri pts deste evento
sero perdi dos.
Programando no E3 21
2
Programando no E3
CAPTULO
Apesar de a mai ori a dos aspectos do VBScri pt se apl i carem programao de
scri pts no E3, al gumas parti cul ari dades devem ser destacadas no que di z respei to
s i mpl ementaes do concei to de ori entao a objetos no si stema.
O VBScript uma l i nguagem baseada no Vi sual Basi c que traz a capaci dade de
scripting (rotei ri zao) para apl i caes que rodam no si stema operaci onal
Wi ndows.
O VBScri pt troca i nformaes com as apl i caes uti l i zando a tecnol ogi a ActiveX
Scripting. Com o ActiveX Scripting, navegadores e outras apl i caes cl i ente, como o
Vi ewer, podem compi l ar scri pts e chamar funes, dentre outros procedi mentos.
Isso possi bi l i ta que scri pts desenvol vi dos para uma apl i cao ou bi bl i oteca, que
devam ser executados na i nterface grfi ca, possam ser executados tanto no Vi ewer
quanto em um navegador de Internet, sem a necessi dade de qual quer adaptao do
apl i cati vo.
Mai s i nformaes sobre o VBScri pt podem ser obti das no manual Guia de
Referncia do VBScript, no Grupo de Programas Elipse E3.
2.1 Ambiente de Programao
O ambi ente de programao de scri pts no E3 Studi o pode ser acessado atravs do
cl i que com o boto di rei to do mouse sobre qual quer objeto, escol hendo-se a
opo Propriedades. Na aba Scripts da view do objeto, pode-se ver a cai xa de
sel eo onde se defi ne qual evento ser o gerador do scri pt. Como vi sto no captul o
anteri or, exi stem doi s ti pos de eventos em um objeto do E3, os Pr-Definidos e os
Definidos pelo Usurio.
Os eventos pr-defi ni dos vari am de objeto para objeto, dependendo da sua
uti l i zao e funci onal i dade. Um objeto de Tel a, por exempl o, possui eventos
rel aci onados i nterface grfi ca, como Click (chamado ao cl i car sobre o objeto) ou
DbClick (chamado com um dupl o cl i que do mouse); j um objeto como um Dri ver de
Comuni cao possui eventos rel aci onados comuni cao, como OnCommError
(chamado quando h um erro de comuni cao). Pode-se tambm defi ni r outros
eventos para o objeto, como vi sto anteri ormente.
Quando um scri pt associ ado a um evento em um objeto, o campo de di gi tao
apresenta uma decl arao de procedi mento (procedure), cuja defi ni o
automti ca e composta do segui nte texto:
Sub NomeDoObjeto_NomeDoEvento()
End Sub
Onde NomeDoObjeto o nome do objeto associ ado e NomeDoEvento o nome do
22 Programando no E3
evento em questo. Os comandos do scri pt devero estar entre essas duas l i nhas.
Para ajudar na di gi tao do scri pt, pode-se uti l i zar o AppBrowser. Ao se escol her o
mtodo ou propri edade desejada, pode-se uti l i zar a opo Copiar. O Tag,
propri edade ou mtodo escol hi dos sero i nseri dos na posi o do cursor na rea
de edi o do scri pt. O l ocal do cursor mostrado atravs de uma ani mao com
seta pi scante.
2.2 Declarando Variveis
possvel decl arar vari vei s de duas manei ras: implicitamente ou explicitamente.
Para decl arar uma vari vel i mpl i ci tamente, basta usar seu nome no scri pt.
Automati camente, a vari vel ser cri ada e i ni ci al i zada com o val or da atri bui o,
ou permanecer com o val or EMPTY (vazi a, sem nenhum val or), caso no receba
nenhum val or antes de ser uti l i zada.
Esta uma prti ca rpi da, porm se o scri pt for mui to extenso, i sto pode causar
confuso e a cri ao de mai s de uma vari vel com o mesmo nome, gerando bugs no
scri pt.
Para decl arar vari vei s expl i ci tamente, uti l i za se o comando Dim, como no
exempl o:
Dim Temperatura
Pode-se decl arar ml ti pl as vari vei s separando cada nome de vari vel com uma
vrgul a. Por exempl o:
Dim Esquerda, Direita, Topo, Base
Em vi rtude dos scri pts no E3 serem todos associ ados a um objeto em parti cul ar, as
vari vei s so sempre l ocai s, vl i das apenas para o escopo do scri pt. Para ter-se
vari vei s pbl i cas ou gl obai s, deve-se cri ar um Tag Interno e uti l i z-l o para
armazenar o val or desejado.
2.3 Obtendo Referncias aos Objetos
Uma das caractersti cas mai s i mportantes ao se trabal har com scri pts dentro do E3
consi derar a separao exi stente entre os processos que so executados no
servi dor e aquel es executados na i nterface do cl i ente (Vi ewer). Para se trabal har
com scri pts, pode-se mani pul ar:
Objetos do servi dor atravs do servi dor
Objetos do servi dor atravs do(s) Vi ewer(s)
Objetos do Vi ewer atravs do mesmo Vi ewer
No entanto, no se pode mani pul ar di retamente:
Objetos do Vi ewer atravs do servi dor (s possvel atravs da cri ao de
eventos no Vi ewer, l i gados a vari vei s que esto no servi dor)
Objetos de um Vi ewer a parti r de outro Vi ewer (s possvel atravs da cri ao
de eventos l i gados a vari vei s que esto no servi dor)
Tai s l i mi taes so decorrentes do fato de que, por defi ni o, exi ste uma
i ndependnci a entre o que cada uma das estaes Vi ewer est executando ou
vi sual i zando e o servi dor, e vi ce-versa. Por i sso, todas as ati vi dades, tanto do
servi dor como do Vi ewer, necessi tam ser coordenadas de forma assncrona ou
atravs de eventos para operarem de forma harmoni osa.
Logo, devi do a esta i ndependnci a ao se cri ar um scri pt, pri mei ro deve-se obter
uma refernci a correta dos objetos que se deseja mani pul ar, ou seja, necessri o
que o objeto seja pri mei ramente encontrado nos vri os mdul os do E3.
Val e repeti r que, ao se edi tar um scri pt, o usuri o poder uti l i zar o AppBrowser,
que permi te copi ar para o scri pt o cami nho de um mtodo ou propri edade de forma
compl eta, auxi l i ando-o na cri ao de scri pts.
Portanto, para acessar os objetos externos que esto sendo mani pul ados em um
scri pt, so uti l i zadas al gumas di reti vas bsi cas. Por exempl o, para se mani pul ar o
val or de um Tag de Comuni cao, o cami nho Servidor - Driver - Pasta (se houver) -
Tag. J se o objeti vo mani pul ar um boto na Tel a, o cami nho Viewer - Quadro
(se houver) - Tela - Boto.
Exi stem basi camente trs l ocal i zaes de ori gem de scri pts, do ponto de vi sta da
metodol ogi a para acesso dos objetos:
Servi dor
Tel as e Quadros (Vi ewer)
El i pseX (bi bl i otecas): podem ser XObjects (rodam no servi dor) e XControl s
(rodam no Vi ewer)
2.3.1 Acessando Propriedades do Servidor
Para se acessar um objeto que est sendo executado no servi dor a parti r de um
objeto de Tel a ou um El i pseX, deve-se usar o mtodo Application.GetObject.
A pal avra Application retorna o objeto de apl i cao rel aci onado ao contexto atual
do objeto, e o mtodo GetObject procura no servi dor por um objeto dentro de
Application com o nome forneci do. Exempl o:
Sub Button1_Click()
Application.GetObject("Driver1")._
Item("tag001").AllowRead = False
End Sub
Ou ai nda:
Sub Button1_Click()
Application.GetObject("Driver1.tag001").AllowRead = False
End Sub
O mtodo Item foi uti l i zado para, a parti r da refernci a de Driver1, l ocal i zar o
tag001, poi s o Dri ver uma col eo de Tags. Depoi s de l ocal i zado o objeto, suas
propri edades e funes podem ser acessadas l i vremente.
Caso al guma outra operao ti vesse que ser real i zada com Driver1 ou tag001,
outra al ternati va para o scri pt anteri or seri a:
Sub Retangulo1_Click()
Set obj = Application.GetObject("Driver1")
obj.Item("tag001").AllowRead = False
obj.Item("tag002").AllowRead = False
End Sub
Neste caso, a vari vel obj est apontando para o objeto Driver1 e na prxi ma vez
que se qui ser acessar al gum objeto que descende de Driver1 dentro do scri pt,
pode-se uti l i zar a vari vel obj di retamente. Isto traz um ganho de performance, j
que cada chamada do mtodo GetObject faz um acesso ao servi dor. Atravs desta
tcni ca, chamadas desnecessri as ao servi dor so evi tadas. Este exempl o usa o
comando Set, que ser expl i cado mai s adi ante. Note que a uti l i zao de vari vei s
tambm torna o cdi go mai s cl aro e de modi fi cao mai s fci l . Caso seja
necessri o al terar o objeto no qual queremos executar comandos, basta mudar a
l i nha de atri bui o dessa vari vel .
A pal avra Application nos scri pts pode i ndi car tanto funes que so executadas no
Vi ewer quanto no servi dor. Neste caso, o objeto Appl i cati on sabe de antemo quai s
funes devem ser executadas tanto para um quanto para o outro caso. No
possvel , entretanto, executar funes de Vi ewer dentro do servi dor, assi m como
tambm no possvel executar funes de servi dor dentro do Vi ewer.
2.3.2 Acessando Propriedades do Studio
Para acessar um objeto de servi dor qual quer em um scri pt que roda no Studi o
pode-se usar a di reti va Application.GetObject. A pal avra Application retorna o
objeto de apl i cao rel aci onado ao contexto atual do objeto, e o mtodo GetObject
procura no Domni o carregado no Studi o por um objeto de servi dor com o cami nho
forneci do. Exempl o (o evento CustomConfig di sparado no Studi o):
Sub XControl1_CustomConfig
Application.GetObject("Dados.TagDemo1").DocString =
"Documentao"
End Sub
2.3.3 Acessando Propriedades do Servidor de dentro do
Servidor
Caso seja necessri o acessar as propri edades de um Tag a parti r de outro, ori gem e
desti no esto no servi dor l i gados vi a um mdul o pai , que Driver1.
Nesta si tuao, deve ser usada a propri edade Parent. Isto faz com que seja
acessado pri mei ro o objeto pai onde est o scri pt, para depoi s descer-se na
hi erarqui a em busca de outro el emento.
Driver1 o objeto pai de Tag1 e de Tag2
Exempl o:
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
ani nhar vri os comandos Parent.
Pasta1 o objeto pai de Tag1
Exempl o:
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 fi l hos da Tel a. Exempl o:
Sub Tela1_OnPreShow(vArg)
Item("Retangulo1").Visible = True
End Sub
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 propri edade Parent ou o mtodo Screen.
TelaInicial o objeto pai de Retangulo1 e
Retangulo2
Exempl o:
Parent.Item("Retangulo2").Visible = True
End Sub
2.3.6 Modificando a Tela ou Objetos de Tela a partir do
Servidor
A modi fi cao de um comportamento qual quer em uma Tel a s pode ser fei ta a
parti r de Associ aes (o servi dor reporta automati camente para os Vi ewers todas
as mudanas das vari vei s escol hi das), ou atravs de uma busca expl ci ta do
Vi ewer por i nformaes no servi dor. Toda a operao de associ ao da i nterface
grfi ca fei ta do cl i ente para o servi dor, e no do servi dor para o cl i ente. Assi m,
no possvel modi fi car Tel as ou objetos a parti r do servi dor vi a scri pts, poi s cada
cl i ente de dados uma cpi a di ferente das Tel as.
Um exempl o prti co mudar a cor de um texto na Tel a para verde quando um Tag
for l i gado (val or um) e para vermel ho quando for desl i gado (val or zero). Neste
caso, deve-se si mpl esmente cri ar uma Associ ao Di gi tal entre a propri edade
TextColor de Texto1 com o Tag1. Associ aes so prefervei s devi do rapi dez de
execuo e si mpl i ci dade de manuteno e construo da apl i cao.
Associando a cor do texto ao valor de Tag1
Uma outra forma de executar o procedi mento anteri or cri ar um scri pt no Vi ewer
que veri fi que constantemente se o Tag1 mudou ou no de val or, para ento mudar
a cor do texto. Este ti po de scri pt possvel de ser real i zado, mas degrada mui to a
performance da apl i cao. Por i sto, esta prti ca no aconsel hvel .
2.3.7 Acessando Objetos de um ElipseX a partir do prprio
ElipseX
Na cri ao de um El i pseX, pode-se decl arar propri edades (XProperti es) e i nseri r
objetos, que podem ser objetos de Tel a (XControl ) ou objetos do servi dor (XObject).
Para se acessar as XProperti es atravs de scri pts, basta acessar o nome da
propri edade di retamente.
Aba Design
Aba Propriedades
Por exempl o, na fi gura anteri or temos o XControl1 com a propri edade
Propriedade1, e os objetos Texto1 e Retangulo1.
A propri edade Propriedade1, do ti po Booleano, pode ser acessada com o scri pt a
segui r:
Sub XControl1_OnStartRunning()
XControl1.Propriedade1 = True
End Sub
Ou ai nda:
Propriedade1 = True
End Sub
Se o El i pseX possui objetos i nternos, ento possvel uti l i zar o mtodo Item para
obter uma refernci a destes objetos. Por exempl o:
Item("Texto1").Value = "motor"
Item("Retangulo1").ForegroundColor = RGB(212, 208, 20)
End Sub
2.3.8 Acessando Objetos de um ElipseX Externamente
O acesso externo a um objeto El i pseX s pode ser fei to atravs de suas
propri edades, uti l i zando suas i nstnci as cri adas. No possvel acessar objetos
i nternos di retamente.
Se o El i pseX em questo for um XControl , el e se comporta como um objeto de Tel a.
Por exempl o, na segui nte apl i cao:
XControl (exemplo)
Para al terar a propri edade Propriedade1 do XControl pode-se fazer o segui nte
scri pt no evento Click de um boto:
Sub CommandButton1_Click()
Screen.Item("XControl11").Propriedade1 = True
End Sub
Ou ai nda:
Parent.Item("XControl11").Propriedade1 = True
End Sub
No caso de um XObject, deve-se i nseri -l o em um Servi dor de Dados:
XObject (exemplo)
Um scri pt para al terar a propri edade Valor do XObject seri a:
Application.GetObject("Dados.XObject11").Valor = 123
End Sub
Ou ai nda:
Application.GetObject("Dados").Item("XObject11").Valor = 123
End Sub
Pode-se ai nda ter um XControl acessando um XObject, atravs de uma XProperty.
Por exempl o, a fi gura mostra um XControl chamado XControl1 que possui uma
propri edade XValor do ti po XObject1, que o nome do XObject cri ado.
XObject
XControl
Faz-se, por exempl o, uma Associ ao do val or do objeto Texto1 com a
propri edade Valor do XObject1. Isso fei to atravs da propri edade XValor, cri ada
no XControl1. Assi m, o val or da propri edade Valor do XObject1 ser mostrada
no objeto Texto1 do XControl1.
Propriedade Valor
No projeto, o vncul o da i nstnci a XObject11 i nstnci a XControl11 pode ser
fei to atravs de uma Associ ao na propri edade XValor.
XValor (Associao)
2.3.8.1 Exemplo de Criao de um ElipseX
Suponha que determi nada apl i cao necessi te supervi si onar e comandar 10
motores. Cada motor preci sa ser representado por um desenho na Tel a, que exi be a
cor verde quando esti ver operando, e vermel ho quando esti ver desl i gado. Tambm
deve ser permi ti do o comando do motor na Tel a, envi ando i nstrues para l i gar e
desl i gar, e sua vel oci dade tambm deve ser exi bi da.
Uma possi bi l i dade a cri ao de um XControl chamado MotorA, com as
propri edades Estado i gual a Boolean e Velocidade i gual a Double, conforme a fi gura
a segui r:
Aba Design
Aba Propriedades
1. Para a i ndi cao da cor, a propri edade OverrideFillColor do motor deve estar
associ ada propri edade Estado do XControl , atravs de uma Associ ao
Di gi tal . Confi gure a propri edade OverrideFillMode para 2 - SolidFill.
2. Para exi bi r a vel oci dade, a propri edade Value do Di spl ay deve ser associ ada
propri edade Velocidade do XControl .
3. O Boto Li ga-Desl i ga troca o val or da propri edade Estado atravs de uma
Associ ao Si mpl es.
Note que:
As Associ aes dentro da bi bl i oteca so i nternas, e seu formato
Nome_do_Controle.Nome_da_Propriedade
O objeto, depoi s de i nseri do na Tel a, dever ter essas propri edades associ adas
aos Tags verdadei ros, para cada um dos motores
Uma Associ ao de um Tag para a propri edade Estado ter que ser fei ta para
cada MotorA
Viewer
Outra possi bi l i dade, mai s abrangente, uti l i za um XObject para o motor. Desta
forma, todas as i nformaes rel ati vas aos motores resi dem em objetos que fi cam
no servi dor. Assi m, pode-se construi r vri os ti pos de i nterface para o motor
(XControl s) que trazem do servi dor, atravs do XObject, somente as i nformaes
necessri as.
Desta manei ra, o objeto MotorA teri a que ser modi fi cado para apontar para um
XObject, ao i nvs de decl arar em si mesmo todas as propri edades.
1. Cri e um XObject chamado MotorADados, e decl are nel e as propri edades Estado
e Velocidade.
2. Cri e um XControl MotorA que possua apenas uma propri edade, chamada
MeusDados, do ti po MotorADados.
3. MotorADados dever ser i nseri do em uma Pasta de Dados no servi dor, e
corresponder a cada um dos motores. MotorA por sua vez i r apontar para o
MotorADados desejado, no sendo necessri a a cri ao de novos Tags.
Configurao na view do XObject
Configurao na view do XControl
4. A propri edade Estado, associ ada propri edade OverrideFillColor do motor,
fi ca MotorA.MeusDados.Estado.
5. A propri edade Velocidade, associ ada ao Di spl ay, fi ca
MotorA.MeusDados.Velocidade.
2.4 Acessando Objetos
Segui ndo o concei to de encapsul amento de programao ori entada a objetos, os
mtodos e propri edades fi cam associ ados a seus objetos de ori gem. Isto si gni fi ca
que sempre se deve i ndi car o objeto do qual se est acessando o mtodo ou
propri edade.
2.4.1 Propriedades
Para referenci ar as propri edades de um objeto, deve-se usar o mtodo GetObject. A
si ntaxe a segui nte:
Application.GetObject("<objeto>").<propriedade>
Onde <objeto> o nome do objeto e <propriedade>, a propri edade desejada.
Exempl o:
Application.GetObject("Dados.TempTanque2").Type
Para faci l i tar a di gi tao, aconsel hvel sempre uti l i zar o AppBrowser, que j traz
a si ntaxe correta.
2.4.1.1 Propriedade Value
No E3, mui tos objetos possuem uma propri edade em comum chamada Value. Neste
caso especfi co, pode-se acessar esta propri edade uti l i zando se o prpri o nome do
objeto:
Button1 = False
Que equi val ente a:
Button1.Value = False
2.4.2 Mtodos
A si ntaxe a segui r exempl i fi ca a chamada de um mtodo que no preci sa de
parmetros:
Application.GetObject("<objeto>").<metodo>
Onde <objeto> o objeto em questo e <metodo>, o mtodo desejado.
Se o mtodo acei ta parmetros, use a si ntaxe a segui r:
Application.GetObject("<objeto>").<metodo>(<parametro>)
Onde <parametro> o parmetro a ser passado para o mtodo. Quando houver
mai s de um parmetro, uti l i ze vrgul as para separ-l os.
Se o mtodo retorna um resul tado, e for desejvel guard-l o, ento os parmetros
devem ser col ocados obri gatori amente entre parnteses:
<V> =Application.GetObject("<objeto>").<metodo>(<parametro>)
Onde <V> a vari vel que i r receber o resul tado do mtodo.
2.5 Trabalhando com Colees
Uma col eo (ou collection) um objeto que gerenci a um conjunto de objetos
si mi l ares. Os objetos conti dos em uma col eo so referenci ados por ndi ces,
semel hante refernci a de arrays. Pode-se adi ci onar ou remover objetos
i ndi vi duai s de uma col eo, conforme o exempl o a segui r.
' Adiciona uma pena no objeto E3Chart1
Screen.Item("E3Chart1").Pens.AddPen "Pena"
End Sub
' Remove a primeira pena
Screen.Item("E3Chart1").Pens.Remove 0
End Sub
NOTA: o pri mei ro objeto em uma col eo possui ndi ce 1 (um).
Todas as col ees possuem uma propri edade em comum chamada Count, que o
nmero de objetos (ou fi l hos) exi stentes. Exempl o:
' 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 col eo possui um mtodo Item, que pode ser usado para acessar qual quer
objeto dentro da col eo. O mtodo Item acei ta um parmetro Item, que pode ser
um nmero (i ntei ro posi ti vo) ou o nome do objeto dentro da col eo que se deseja
acessar. Os exempl os a segui r so de ajustes da cor da segunda Pena do objeto
E3Chart:
' Modifica a cor da terceira pena
Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(212, 208,
20)
End Sub
Ou ai nda:
' Modifica a cor da pena com nome "Pena2"
Screen.Item("E3Chart1").Pens.Item("Pena2").Color = RGB(212,
208, 20)
End Sub
Os comandos anteri ores so equi val entes, o pri mei ro i ndi cando o ndi ce da Pena
na col eo, e o segundo i ndi cando o nome da Pena.
2.6 Comando Set
O VBScri pt i mpl ementa o concei to de pol i morfi smo das l i nguagens ori entadas a
objeto, permi ti ndo que uma vari vel do ti po Variant assuma a forma de um objeto
qual quer, atravs do comando Set. Deste modo, a vari vel funci ona como um
pontei ro para o objeto desejado, permi ti ndo acessar seus mtodos e propri edades.
Exempl o:
Set E3Chart = Screen.Item("E3Chart1")
E3Chart.Pens.Item(2).Color = RGB(212, 208, 20)
End Sub
Neste exempl o foi fei ta a mesma tarefa que na seo anteri or, porm a parte
referente a como chegar at o objeto especfi co havi a si do omi ti da. Sem o comando
Set, a mesma chamada teri a que ser escri ta da segui nte forma:
Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(212, 208, 20)
Aparentemente, no exi ste vantagem neste caso, poi s pode-se fazer tudo em uma
ni ca l i nha de cdi go. Porm, se l ogo abai xo no mesmo scri pt outras operaes
forem necessri as, o processo se torna mai s si mpl es e rpi do se a chamada ao
mtodo Item no ti ver si do col ocada em todas as l i nhas.
' Exemplo ruim
20)
20)
20)
End Sub
' Exemplo melhor
Set Penas = Screen.Item("E3Chart1").Pens
Penas.Item(0).Color = RGB(212, 208, 20)
End Sub
2.7 E3Globals
O E3Globals um mdul o do E3 que contm mtodos de uso gl obal . Os mtodos
GetCurrentWindowsUserName, GetLocalTime e GetLocalTimeUTC no podem ser
uti l i zados em Associ aes, somente em scri pts. O restante dos mtodos pode ser
uti l i zado tanto em scri pts quanto em Associ aes.
A forma de uti l i zao destes mtodos admi te duas si ntaxes, E3Globals.<mtodo>
ou si mpl esmente <mtodo>, exceto no caso do objeto Rel atri o, onde a si ntaxe
E3Globals.<mtodo> obri gatri a.
2.7.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do mdul o E3Gl obal s.
2.7.1.1 BShl
BShl(Value, Bits)
Retorna o val or passado no parmetro Value desl ocado esquerda o nmero de
bi ts especi fi cado no parmetro Bits. Este mtodo retorna um erro caso o parmetro
Bits esteja fora da fai xa permi ti da (entre 0 e 31). Este mtodo est di sponvel tanto
em Associ aes quanto em scri pts.
2.7.1.2 BShr
BShr(Value, Bits[, PreserveSign])
Retorna o val or passado no parmetro Value desl ocado di rei ta o nmero de bi ts
especi fi cado no parmetro Bits. Este mtodo retorna um erro caso o parmetro Bits
esteja fora da fai xa permi ti da (entre 0 e 31). O parmetro PreserveSign um
Booleano opci onal que, se verdadei ro, preenche os bi ts esquerda com uma cpi a
do bi t de si nal . O val or padro deste parmetro (Fal so) preenche os bi ts esquerda
com zeros. Este mtodo est di sponvel tanto em Associ aes quanto em scri pts.
2.7.1.3 Choose
Choose(Index, Values)
Retorna um dos i tens especi fi cados em Values, baseado no parmetro Index
(i ni ci ando em zero). Este mtodo retorna Null caso o val or de Index seja menor que
0 ou mai or ou i gual ao nmero de val ores em Values. Este mtodo est di sponvel
tanto em Associ aes quanto em scri pts.
NOTA: O mtodo Choose no propaga a qual i dade nem o timestamp dos val ores. Se
uma Associ ao conti ver a expresso Choose(TagIndex, Tag1.Value,
Tag2.Value, Tag3.Value), o resul tado ser o val or escol hi do, porm com
qual i dade Boa (192) e timestamp atual . Para que essas i nformaes sejam
preservadas, necessri o especi fi car somente o objeto, como por exempl o Choose
(TagIndex, Tag1, Tag2, Tag3).
2.7.1.4 E3Format
E3Format(Value, Format)
Formata a expresso em Value uti l i zando o formato especi fi cado em Format. Este
formato uti l i za as mesmas defi ni es da propri edade Format de objetos Texto,
Di spl ay e SetPoi nt. Este mtodo est di sponvel tanto em Associ aes quanto em
scri pts.
2.7.1.5 GetBit
GetBit(Value, BitIndex)
Retorna o val or (verdadei ro ou fal so) do bi t de Value especi fi cado em BitIndex. Este
mtodo retorna um erro caso o parmetro BitIndex esteja fora da fai xa permi ti da
(entre 0 e 31). Este mtodo est di sponvel tanto em Associ aes quanto em scri pts.
2.7.1.6 GetComputerName
GetComputerName()
Retorna uma String contendo o nome do computador atual . Este mtodo est
di sponvel tanto em Associ aes quanto em scri pts.
2.7.1.7 GetCurrentWindowsUserName
GetCurrentWindowsUserName()
Retorna uma String contendo o nome do usuri o l ogado no processo corrente. Este
mtodo no est di sponvel em Associ aes, somente em scri pts.
2.7.1.8 GetLocalTime
GetLocalTime()
Retorna a data e hora do computador l ocal , com preci so de mi l i ssegundos e no
fuso horri o l ocal . Este mtodo no est di sponvel em Associ aes, somente em
scri pts.
2.7.1.9 GetLocalTimeUTC
GetLocalTimeUTC()
Retorna a data e hora do computador l ocal , com preci so de mi l i ssegundos e no
fuso horri o UTC (Tempo Universal Coordenado). Este mtodo no est di sponvel
em Associ aes, somente em scri pts.
2.7.1.10 IIf
IIf(Condition, ExprTrue, ExprFalse)
Retorna a expresso conti da em ExprTrue se a condi o aval i ada em Condition for
verdadei ra, e a expresso conti da em ExprFalse se a condi o aval i ada for fal sa.
Este mtodo est di sponvel tanto em Associ aes quanto em scri pts.
NOTA: O mtodo IIf no propaga a qual i dade nem o timestamp dos val ores. Se uma
Associ ao conti ver a expresso IIf(Tag1.Value == 0, Tag2.Value,
Tag3.Value), o resul tado ser o val or de Tag2 ou Tag3, porm com qual i dade
Boa (192) e timestamp atual . Para que essas i nformaes sejam preservadas,
necessri o especi fi car somente o objeto, como por exempl o IIf(Tag1.Value ==
0, Tag2, Tag3).
2.7.1.11 OPCGetLimit
OPCGetLimit(Quality)
Retorna a i nformao de Limite de uma Qual i dade OPC especi fi cada no parmetro
Quality. Este mtodo est di sponvel tanto em Associ aes quanto em scri pts. Os
val ores possvei s de retorno deste mtodo so:
0: Li vre
1: Bai xo
2: Al to
3: Constante
2.7.1.12 OPCGetQuality
OPCGetQuality(Quality)
Retorna a i nformao de Qualidade de uma Qual i dade OPC especi fi cada no
parmetro Quality. Este mtodo est di sponvel tanto em Associ aes quanto em
scri pts. Os val ores possvei s de retorno deste mtodo so:
0: Rui m
1: Incerta
2: No uti l i zada
3: Boa
2.7.1.13 OPCGetSubStatus
OPCGetSubStatus(Quality)
Retorna a i nformao de Substatus (de 0 a 15) de uma Qual i dade OPC especi fi cada
no parmetro Quality. Este mtodo est di sponvel tanto em Associ aes quanto em
scri pts. O Padro OPC especi fi ca os segui ntes val ores:
Qualidade Boa:
0: no especi fi cado
1: sobrescri ta l ocal
Qualidade Ruim:
1: erro de confi gurao
2: no conectado
3: fal ha no di sposi ti vo
4: l ti mo val or conheci do
5: fal ha de comuni cao
6: fora de servi o
Qualidade Incerta:
1: l ti mo val or uti l i zvel
4: sensor no confi vel
5: uni dade de engenhari a excedi da
6: sub-normal
2.7.1.14 OPCGetVendor
OPCGetVendor(Quality)
Retorna a i nformao de Reservado para o Fabricante (de 0 a 255) de uma
Qual i dade OPC especi fi cada em Quality. Este mtodo est di sponvel tanto em
Associ aes quanto em scri pts.
2.7.1.15 OPCIsBad
OPCIsBad(Quality)
Retorna verdadei ro se a Qual i dade OPC Rui m, ou fal so caso contrri o. Este
mtodo est di sponvel tanto em Associ aes quanto em scri pts.
2.7.1.16 OPCIsGood
OPCIsGood(Quality)
Retorna verdadei ro se a Qual i dade OPC Boa, ou fal so caso contrri o. Este mtodo
est di sponvel tanto em Associ aes quanto em scri pts.
2.7.1.17 OPCIsUncertain
OPCIsUncertain(Quality)
Retorna verdadei ro se a Qual i dade OPC Incerta, ou fal so caso contrri o. Este
mtodo est di sponvel tanto em Associ aes quanto em scri pts.
2.7.1.18 OPCMakeQuality
OPCMakeQuality(QualityFlag, SubStatus, Limit, Vendor)
Retorna um novo val or de Qual i dade OPC uti l i zando os val ores passados nos
parmetros QualityFlag, SubStatus, Limit e Vendor. Este mtodo est di sponvel tanto
em Associ aes quanto em scri pts. Os val ores possvei s para cada um dos
parmetros so os segui ntes:
QualityFlag: Especi fi ca a qual i dade do val or
0: Rui m
1: Incerta
3: Boa
SubStatus: Especi fi ca o substatus do val or (entre 0 e 15, veja o mtodo
OPCGetSubStatus para os val ores possvei s). Se este parmetro for omi ti do,
assume o val or 0
Limit: Especi fi ca o l i mi te do val or. Se este parmetro for omi ti do, assume o val or
0
0: Li vre
1: Bai xo
2: Al to
3: Constante
Vendor: Val or especfi co do fabri cante (entre 0 e 255). Se este parmetro for
omi ti do, assume o val or 0
2.7.1.19 OPCSetLimit
OPCSetLimit(Quality, Limit)
Modi fi ca a i nformao de Limite de uma Qual i dade OPC e retorna o val or
modi fi cado. Este mtodo est di sponvel tanto em Associ aes quanto em scri pts.
Os val ores possvei s para o parmetro Limit so:
0: Li vre
1: Bai xo
2: Al to
3: Constante
2.7.1.20 OPCSetQuality
OPCSetQuality(Quality, QualityFlag)
Modi fi ca a i nformao de Qualidade de uma Qual i dade OPC e retorna o val or
modi fi cado. Este mtodo est di sponvel tanto em Associ aes quanto em scri pts.
Os val ores possvei s para o parmetro QualityFlag so:
0: Rui m
1: Incerta
2: No uti l i zada
3: Boa
2.7.1.21 OPCSetSubStatus
OPCSetSubStatus(Quality, SubStatus)
Modi fi ca a i nformao de Substatus de uma Qual i dade OPC (de 0 a 15) e retorna o
val or modi fi cado. Este mtodo est di sponvel tanto em Associ aes quanto em
scri pts. O Padro OPC especi fi ca os segui ntes val ores:
Qualidade Boa:
1: sobrescri ta l ocal
Qualidade Ruim:
1: erro de confi gurao
2: no conectado
3: fal ha no di sposi ti vo
4: l ti mo val or conheci do
5: fal ha de comuni cao
6: fora de servi o
Qualidade Incerta:
1: l ti mo val or uti l i zvel
4: sensor no confi vel
5: uni dade de engenhari a excedi da
6: sub-normal
2.7.1.22 OPCSetVendor
OPCSetVendor(Quality, Vendor)
Modi fi ca a i nformao de Reservado para o Fabricante (de 0 a 255) de uma
Qual i dade OPC e retorna o val or modi fi cado. Este mtodo est di sponvel tanto em
Associ aes quanto em scri pts.
2.7.1.23 SetBit
SetBit(Value, BitIndex, BitValue)
Ajusta o val or de Value (verdadei ro ou fal so) do bi t especi fi cado em BitIndex para
BitValue. Este mtodo retorna um erro caso o parmetro BitIndex esteja fora da
fai xa permi ti da (entre 0 e 31). Este mtodo est di sponvel tanto em Associ aes
quanto em scri pts.
2.7.1.24 SourceTypeName
SourceTypeName(SourceType)
Retorna uma String com a descri o da Fonte de Medi da ati va (propri edade
ActiveSource dos objetos Medi da Anal gi ca e Medi da Di screta do El i pse Power).
Este mtodo est di sponvel tanto em Associ aes quanto em scri pts. Os val ores
possvei s para o parmetro SourceType so os segui ntes:
-1: String vazi a
0: Fonte Ati va
1: SCADA
2: Operador
3: Centro de Comando
4: Faturamento
5: Cal cul ada
6: Banco de Dados
100: Processador Topol gi co
101: Fl uxo de Potnci a
102: Esti mador de Estados
103: Descarte de Cargas
NOTA: Caso o val or passado no parmetro SourceType no esteja entre os val ores
possvei s, este mtodo retorna "???".
2.8 Eventos, Mtodos e Propriedades Gerais dos
Objetos
Esta seo contm i nformaes sobre eventos, mtodos e propriedades gerai s dos
objetos.
2.8.1 Eventos
Eventos so ocorrnci as rel aci onadas a um objeto, que permi tem di sparar aes
programadas. Exi stem basi camente, doi s ti pos de eventos: Fsicos (ou Externos) e
Internos. Os Eventos Fsicos so, por exempl o, aes do usuri o. No caso do
usuri o di gi tar al go no tecl ado, a i nformao rel evante pode ser a tecl a
pressi onada, ou se o usuri o apontar e cl i car com o mouse, a i nformao rel evante
a posi o do cursor e o status dos botes. Os Eventos Internos so, por exempl o,
mudanas de val or de uma vari vel (Tag) na apl i cao. Como o Tag pode ser
associ ado a um di sposi ti vo externo, di z-se que os eventos i nternos podem ter
associ aes fsi cas, como a mudana da temperatura de uma cmara, por exempl o.
2.8.1.1 Variveis de Evento
Variveis de Evento so cri adas quando o evento i ni ci a. Para serem uti l i zadas,
devem ser associ adas a parmetros na chamada do scri pt do evento. O exempl o a
segui r a chamada de um procedi mento associ ado ao evento KeyDown de
AlgumObjeto.
Sub AlgumObjeto_KeyDown(KeyCode, Shift)
Note que na chamada tem-se duas vari vei s, KeyCode e Shift. O E3 i r atri bui r
val ores a essas vari vei s automati camente no momento da ocorrnci a do evento.
Neste caso, KeyCode i r receber o cdi go da tecl a pressi onada e Shift receber
Verdadei ro ou Fal so, conforme a tecl a SHIFT esteja pressi onada ou no.
2.8.1.2 OnStartRunning
OnStartRunning()
Ocorre to l ogo um objeto seja i ni ci ado. Exempl o (Meses um Tag Interno e uti l i za
o evento OnStartRunning para i ni ci al i zar o vetor):
Sub Meses_OnStartRunning()
Value = Array ("Janeiro", "Fevereiro", "Maro", "Abril",_
"Maio", "Junho", "Julho", "Agosto", "Setembro", "Outubro",_
"Novembro", "Dezembro")
End Sub
NOTA: Para acessar este array, necessri o copi ar a propri edade Value para uma
vari vel l ocal .
2.8.1.3 OnStopRunning
OnStopRunning()
Ocorre quando termi na a execuo de uma i nstnci a deste objeto. Uti l i ze o evento
OnStopRunning para real i zar operaes de fi nal i zao para o objeto. Exempl o:
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 captul o so l i stados os mtodos comuns aos objetos do E3. Cada entrada
mostra o nome do mtodo com seus respecti vos parmetros, na si ntaxe correta, e
um exempl o de uti l i zao do mtodo.
2.8.2.1 Chamadas de Mtodos
Mui tos mtodos pr-defi ni dos possuem parmetros, que podem (ou devem) ser
passados na chamada do mtodo. Para i sso, o VBScri pt possui uma regra que deve
ser segui da: se o mtodo for uti l i zado em uma atri bui o, seus parmetros devem
estar entre parnteses. Por exempl o, veja esta chamada do mtodo GetObject:
obj = Application.GetObject("dados.tag001")
J se o mtodo for chamado sozi nho, deve-se reti rar os parnteses. Por exempl o,
veja esta chamada do mtodo SetVariableValue:
Screen.Item("Consulta").SetVariableValue Valor, 12
Os parnteses usados nas ci taes de mtodos neste manual servem apenas como
i ndi cati vo para di ferenci -l os das propri edades. Nos scri pts, deve-se segui r esta
mesma regra.
2.8.2.2 Activate
Activate()
Ati va um objeto que est i nati vo no momento. Exempl o:
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 adi ci ona um novo objeto apl i cao. Este mtodo possui o
parmetro ClassName, que i ndi ca o ti po de objeto que ser cri ado. Por exempl o,
para se cri ar um retngul o na Tel a, o parmetro ClassName deve ser "DrawRect". O
objeto cri ado fi ca conti do no objeto que chamou o mtodo AddObject e pode ser
acessado atravs do mtodo Item.
O parmetro Activate opci onal e i ndi ca se o objeto ser ati vado aps a cri ao.
Se o objeto for ati vado, as Associ aes e scri pts fi cam habi l i tados. Se o objeto for
cri ado com Activate em Fal se, mai s tarde el e pode ser ati vado pel o mtodo Activate.
O parmetro ObjectName tambm opci onal e i ndi ca um nome para o objeto
cri ado. Caso o nome j exi sta, o novo nome ser automati camente i ncrementado.
Se o parmetro no for i nformado, o novo objeto ser nomeado a parti r do nome
da cl asse defi ni da no parmetro ClassName.
O objeto s ser cri ado se el e for de um ti po compatvel com o objeto que o contm.
Para se ter certeza que o objeto foi cri ado, pode-se uti l i zar o mtodo IsObject.
NOTA: Apenas os objetos que possuem a opo Inserir no menu de contexto podem
acessar este mtodo.
2.8.2.4 Context
Context(ContextName)
Retorna o objeto que i mpl ementa o contexto i ndi cado pel o parmetro ContextName,
que deve ser uma String entre aspas dupl as. Este mtodo i r fal har se nenhum
objeto na hi erarqui a superi or do objeto que est chamando este mtodo
i mpl ementar o contexto i ndi cado. Os segui ntes contextos esto di sponvei s:
Container: Objetos de servi dor e do Vi ewer (objetos i nseri dos em arqui vos de
projeto ou em pastas dentro de projetos)
Area: reas de Al arme, ou qual quer objeto de servi dor cuja propri edade
IsAlarmArea esteja confi gurada para Verdadei ro
NOTA: Os nomes dos contextos esto sempre em i ngl s, e no di ferenci am
mai scul as de mi nscul as. Para veri fi car o contexto a que um objeto pertence,
basta abri r sua janel a de Propri edades, sel eci onar a aba Item, e veri fi car os
contextos vl i dos no quadro Contextos. Caso um objeto defi na mai s de um contexto,
os nomes sero apresentados em ordem al fabti ca, separados por vrgul as.
2.8.2.5 Deactivate
Deactivate()
Este mtodo desati va um objeto cri ado ou previ amente ati vado pel o mtodo
Activate. Pode-se desati var um objeto quando for necessri o real i zar uma
confi gurao prvi a (i ni ci al i zao de propri edades, por exempl o), ou quando se
desejar real i zar testes nos quai s o objeto no pode estar presente e ati vo. Exempl o:
Dim obj, novo
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 especi fi cado. O parmetro ChildName uma String
(i gnora mai scul as e mi nscul as) que i ndi ca o objeto fi l ho que se deseja apagar. O
mtodo retorna True caso tenha consegui do apagar o objeto, ou Fal se caso o objeto
fi l ho no exi sta.
Para se apagar um objeto a parti r de uma refernci a a um el emento, uti l i za-se o
mtodo DeleteObject do objeto pai . Exempl o:
If obj.DeleteObject("Tag001") Then
MsgBox("Tag apagado com sucesso!")
Else
MsgBox("Falha em apagar: o tag no existe.")
End If
End Sub
NOTA: Apenas os objetos que possuem a opo Inserir no menu de contexto podem
acessar este mtodo.
2.8.2.7 GetChildObject
GetChildObject(ObjectPath)
O mtodo GetChildObject retorna uma refernci a para o objeto fi l ho apontado pel o
parmetro ObjectPath. Com i sso possvel acessar todas as propri edades e
mtodos deste objeto, semel hante ao funci onamento do mtodo GetObject. O
mtodo fal har se o cami nho apontado por ObjectPath conti ver uma propri edade
ou mtodo ao fi nal . O cami nho apontado pel o objeto fi l ho no um cami nho desde
a rai z (o arqui vo .prj) e si m um cami nho sempre a parti r do objeto onde o mtodo
chamado.
NOTA: Este mtodo NO exi ste no objeto Appl i cati on do servi dor e nem nas Pastas
de Apl i cati vo, porm exi ste no objeto Appl i cati on do Vi ewer, sendo acessvel
mesmo em um Vi ewer em modo Somente Leitura.
2.8.2.8 GetObject
GetObject(ObjectPath)
O mtodo GetObject retorna a refernci a do objeto especi fi cado em ObjectPath.
Isto permi te acessar todas as propri edades ou mtodos do objeto. Esta uma
prti ca bastante comum na programao de scri pts no E3. El a faci l i ta a
mani pul ao de objetos e dei xa o cdi go mai s i ntel i gvel . Exempl o:
' 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 refernci a para o objeto fi l ho ItemId do objeto que chamou o mtodo. O
mtodo Item pode buscar um objeto tanto pel o nome quanto pel o ndi ce (i ntei ro, de
1 at o especi fi cado na propri edade Count). Se o ndi ce ou o nome especi fi cado for
vl i do, o mtodo Item retorna a refernci a do objeto. Caso contrri o, o mtodo
retorna um erro de "Parmetro Invl i do". Exempl o:
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
2.8.2.10 Save
Save()
Este mtodo sal va o objeto especi fi cado, que foi modi fi cado em tempo de execuo
(runtime). Os objetos fi l hos tambm sero sal vos, conforme as especi fi caes do
objeto pai . Este mtodo no vl i do para os objetos Tel a e Vi ewer. Exempl o:
Set area = Application.GetObject("ConfigAlarms")._
AddObject("Area", True)
Application.GetObject("ConfigAlarms").Save()
End Sub
NOTA: As modi fi caes fei tas em tempo de execuo e sal vas no objeto s sero
vi svei s no Studi o aps a atual i zao do projeto, que pode ser fei ta cl i cando-se
com o boto di rei to do mouse sobre o nome do projeto e sel eci onando a opo
Atualizar.
2.8.3 Propriedades
Todo objeto possui Propriedades, que servem para guardar i nformaes a respei to
de suas caractersti cas. Por exempl o, um objeto do ti po Retngulo possui a
propri edade Name, que contm seu nome, e as propri edades Width e Height, que
guardam a sua l argura e a sua al tura, respecti vamente, entre outras propri edades.
Neste captul o so l i stadas todas as propri edades gerai s dos objetos do E3. Cada
entrada traz o nome da propri edade, descri o e, quando apl i cvel , um exempl o de
seu uso.
As propri edades so i denti fi cadas por um cone que i ndi ca o ti po de dado
suportado em seu contedo. Os ti pos de dados di sponvei s so os segui ntes:
Tipos de dados disponveis
CONE TIPO DE DADO DESCRIO
Booleano
Retorna Verdadei ro (True)
ou Fal so (Fal se).
Numrico
Retorna um i ntei ro ou
double (posi ti vo ou
negati vo), a ser defi ni do
pel a propri edade.
Data
Retorna uma data no
cal endri o Gregori ano
(i ni ci ando em 1899).
Texto
Retorna um texto.
Variant
Retorna um ti po vari vel ,
que pode assumi r vri os
formatos.
CONE TIPO DE DADO DESCRIO
Cor
Retorna uma cor no
formato RGB.
Link
Retorna uma Associ ao
entre objetos.
Enumerao
Retorna um conjunto
determi nado de val ores.
Al gumas propri edades podem propagar seus val ores mesma propri edade em seus
objetos fi l hos. Neste caso, so chamadas de propri edades propagvei s. Pode-se, no
entanto, forar a propri edade do objeto fi l ho a se comportar de modo di ferente.
NOTA: O E3 uti l i za para defi ni o de coordenadas e espessura o si stema Hi metri c.
Neste si stema, cada uni dade l gi ca equi val e a um mi l si mo de centmetro; ou
seja, cada 1000 uni dades equi val em a um centmetro. Assi m, este o padro
adotado na descri o das propri edades do E3, quando apl i cvel .
2.8.3.1 Application
A propri edade Application retorna o objeto de apl i cao rel aci onado ao
contexto atual do objeto. Com o objeto Apl i cao possvel , por exempl o, buscar
outros objetos presentes no apl i cati vo. Exempl o:
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 fi l hos (i tens) que o objeto possui . Esta propri edade
funci ona em conjunto com o mtodo Item. Se o objeto no possui r fi l hos, o val or
retornado ser 0 (zero). Exempl o:
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
2.8.3.3 DocString
Texto l i vre que tem por objeti vo possi bi l i tar a documentao das
funci onal i dades ou caractersti cas do objeto pel os programadores do projeto.
Exempl o:
Docstring = "Este boto ativa o condensador do sistema."
MsgBox Docstring
End Sub
2.8.3.4 Links
Retorna um objeto que uma col eo das conexes (ou Associ aes) de um
objeto qual quer do E3. Esta propri edade acessvel apenas em tempo de execuo.
Veja o i tem Coleo de Associaes para mai ores i nformaes sobre a col eo de
objetos retornados por esta propri edade.
2.8.3.5 Name
Identi fi ca cada um dos objetos presentes no si stema. Al terar esta propri edade
i mpl i ca em modi fi car todas as outras propri edades ou scri pts que uti l i zam este
objeto. No aconsel hvel a al terao desta propri edade em tempo de execuo.
Exempl o:
MsgBox "O nome da Tela " & (Screen.Name)
End Sub
2.8.3.6 Parent
Retorna o objeto pai deste objeto. Sendo assi m, se um objeto est i nseri do na
Tel a, a propri edade Parent retorna "Tel a". Da mesma forma, se um Tag Interno est
i nseri do di retamente abai xo de um Servi dor de Dados, a propri edade Parent do Tag
Interno apontar para o Servi dor de Dados. Exempl o:
' 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 cami nho do objeto que contm o objeto atual ,
i ncl ui ndo as Pastas. Este val or determi nado apenas no momento em que for
requi si tado, por i sso no recomendado cri ar Associ aes para esta propri edade.
2.8.3.8 PathName
Identi fi ca o cami nho do objeto na apl i cao. Esta propri edade acessvel
apenas em tempo de execuo. Exempl o:
MsgBox "O caminho da Tela " & (Screen.PathName)
End Sub
2.8.3.9 PathVolume
Retorna uma String contendo o nome do arqui vo .prj ou .l i b que contm o objeto.
No Studi o, a propri edade retorna o cami nho compl eto do projeto ou bi bl i oteca
(c:\fol der\fol der\vol ume.prj). Em tempo de execuo, os objetos que rodam no
Vi ewer retornam sempre uma String vazi a. J os que rodam no servi dor retornam o
cami nho rel ati vo do projeto ou bi bl i oteca, conforme el e esteja armazenado no
Domni o (vol ume.prj). Este val or determi nado apenas no momento em que for
requi si tado, por i sso no recomendado cri ar Associ aes para esta propri edade.
2.8.4 Coleo de Associaes
Esta seo contm i nformaes sobre mtodos e propriedades comuns col eo
das conexes (ou Associ aes) de um objeto qual quer do E3, retornada pel a
propri edade Links.
2.8.4.1 Mtodos Comuns
Esta seo contm i nformaes sobre os mtodos comuns col eo de
Associ aes retornada pel a propri edade Links.
2.8.4.1.1 CreateLink
CreateLink(Property, Source[, Type])
Este mtodo permi te cri ar uma Associ ao com uma propri edade do objeto. Em
caso de sucesso, o mtodo retorna o objeto cri ado. Caso contrri o, ocorrer um
erro de scri pt e o mtodo retornar Nothing. O mtodo possui os segui ntes
parmetros:
Property: especi fi ca o nome da propri edade para qual ser cri ada a Associ ao
Source: especi fi ca o nome do objeto de ori gem da Associ ao
Type (opci onal ): especi fi ca o ti po de Associ ao a ser cri ada. Quando este
parmetro for omi ti do, ser cri ada uma Associ ao Si mpl es
NOTA: Nem todas as propri edades exi stentes em um objeto permi tem a cri ao de
Associ aes. Para veri fi car quai s as propri edades permi tem este recurso, acesse a
aba Associaes. Se a propri edade for i nvl i da para a Associ ao, no exi sti r ou j
possui r uma Associ ao, ocorrer um erro de scri pt.
Opes disponveis para o parmetro Type
OPO DESCRIO
0 - Associao Simples
Na Associ ao Si mpl es, o val or da
ori gem copi ado para a propri edade
toda vez que el e for modi fi cado.
1 - Associao Bidirecional
Na Associ ao Bi di reci onal ocorre o
mesmo que na Si mpl es; porm, caso
haja uma vari ao na propri edade, seu
val or ser copi ado para a ori gem,
gerando assi m uma Associ ao de duas
di rees.
2 - Associao Analgica
A Associ ao Anal gi ca estabel ece uma
escal a de converses entre a vari vel de
ori gem e a propri edade.
3 - Associao Digital
Na Associ ao Di gi tal , so especi fi cados
val ores fi xos ou al ternantes para a
propri edade, que so atri budos de
acordo com a fonte ser verdadei ra ou
fal sa.
4 - Associao por Tabela
Na Associ ao por Tabel a, pode-se
estabel ecer condi es entre a vari vel ,
os val ores e o desti no. Na tabel a so
especi fi cados os val ores mni mos e
mxi mos e demai s confi guraes.
5 - Associao Reversa
A Associ ao Reversa uma Associ ao
uni di reci onal da propri edade para a
fonte.
6 - Associao Mltipla
A Associ ao Ml ti pl a semel hante a
uma Associ ao por Tabel a, exceto que
cada l i nha da Associ ao permi te buscar
seu val or de uma fonte di ferente.
Exempl o:
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 & "'."
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 Associ ao de uma determi nada propri edade de um
objeto. Se for um texto, Property especi fi ca o nome da propri edade cuja Associ ao
deseja-se acessar. A Associ ao tambm pode ser acessada numeri camente pel o
ndi ce Index. Este ndi ce deve ser de 1 at Count. Caso no exi sta Associ ao com a
propri edade, ou o ndi ce seja i nvl i do, ocorrer um erro de scri pt. Como as demai s
col ees, Links permi te o uso do comando For Each do VBScri pt. Exempl o:
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 Associ ao com a propri edade especi fi cada por Property,
caso el a exi sta. Caso no exi sta Associ ao com a propri edade especi fi cada, o
mtodo no tem efei to. Exempl o:
Dim Bind
Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")
' 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
2.8.4.2 Propriedades Comuns
Esta seo contm i nformaes sobre as propri edades comuns col eo de
Associ aes retornada pel a propri edade Links.
2.8.4.2.1 Count
Retorna o nmero de objetos fi l hos (i tens) de uma col eo de Associ aes. Esta
propri edade trabal ha em conjunto com o mtodo Item. Se a col eo no possui
objetos fi l hos, o val or retornado 0 (zero).
2.8.4.3 Associaes
Esta seo contm i nformaes sobre os objetos do ti po Associ ao conti dos na
col eo de Associ aes retornada pel a propri edade Links. Os ti pos de Associ aes
di sponvei s so os segui ntes:
Simples
Bidirecional
Analgica
Digital
Tabela
Reversa
Mltipla
2.8.4.3.1 Propriedades Comuns
Esta seo contm i nformaes sobre as propri edades comuns aos objetos
conti dos na col eo de Associ aes retornada pel a propri edade Links.
2.8.4.3.1.1 Property
Especi fi ca o nome da propri edade que est conectada. Ao ser modi fi cada,
permi te desl ocar a Associ ao para outra propri edade do mesmo objeto. Exempl o:
Dim bind
Set bind = Screen.Item("TableBind").Links.Item(1)
bind.Property = "Caption"
End Sub
2.8.4.3.1.2 Source
Especi fi ca a fonte da Associ ao, que pode ser o nome de outro objeto da
apl i cao ou uma expresso mai s compl exa, acessando vri os objetos. Exempl o:
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 propri edade apenas para l ei tura e i nforma o ti po de Associ ao. Os
val ores di sponvei s so os segui ntes:
Opes disponveis para Type
OPO DESCRIO
0 - bsSimple
Associao Simples.
1 - bsSimpleBiDir
Associao Bidirecional.
2 - bsAnalog
Associao Analgica.
3 - bsAnimation
Associao Digital.
4 - bsTable
Associao por Tabela.
5 - bsReverse
Associao Reversa.
6 - bsMultiSource
Associao Mltipla.
2.8.4.3.2 Associao Simples
O objeto Associ ao Si mpl es no tem eventos, mtodos ou propri edades
associ adas.
2.8.4.3.3 Associao Bidirecional
Esta seo contm i nformaes sobre propriedades do objeto Associ ao
Bi di reci onal . Este objeto no possui eventos nem mtodos associ ados.
2.8.4.3.3.1 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Associ ao
Bi di reci onal .
BiDirectional
True se a Associ ao for Bi di reci onal . Fal se se a Associ ao for Reversa ou
Si mpl es.
2.8.4.3.4 Associao Analgica
Esta seo contm i nformaes sobre propriedades do objeto Associ ao
Anal gi ca. Este objeto no possui eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades da Associ ao Anal gi ca.
DstHiValue
Especi fi ca o val or mxi mo ati ngi do na propri edade. Exempl o:
Sub DstHiValue_ValueChange()
Dim Bind
Screen.Item("ScrollBar1").Max = Value
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
Especi fi ca o val or mni mo ati ngi do na propri edade. Exempl o:
Sub DstLoValue_ValueChange()
Dim Bind
Screen.Item("ScrollBar1").Min = Value
MsgBox "ScrollBar1 no tem associao."
Else
MsgBox "Mudando DstLoValue de " &_
Bind.DstLoValue & " para " & Value
Bind.DstLoValue = Value
End If
End Sub
SrcHiValue
Especi fi ca o val or mxi mo ati ngi do na fonte. Exempl o:
Sub SrcHiValue_ValueChange()
Dim Bind
Screen.Item("ScrollBar2").Max = Value
MsgBox "ScrollBar1 no tem associado."
Else
MsgBox "Mudando SrcHiValue de " &_
Bind.SrcHiValue & " para " & Value
Bind.SrcHiValue = Value
End If
End Sub
SrcLoValue
Especi fi ca o val or mni mo ati ngi do na fonte. Exempl o:
Sub SrcLoValue_ValueChange()
Dim Bind
Screen.Item("ScrollBar2").Min = Value
MsgBox "ScrollBar1 no tem associado."
Else
MsgBox "Mudando SrcLoValue de " &_
Bind.SrcLoValue & " para " & Value
Bind.SrcLoValue = Value
End If
End Sub
NOTA: Caso os val ores especi fi cados para as propri edades SrcHiValue e SrcLoValue
sejam i guai s, no possvel fazer a escal a, e a Associ ao funci onar como se
fosse uma Associ ao Si mpl es.
2.8.4.3.5 Associao Digital
Esta seo contm i nformaes sobre propriedades do objeto Associ ao Di gi tal .
Este objeto no possui eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades da Associ ao Di gi tal .
BlinkOff
Quando esta propri edade esti ver confi gurada para True, a propri edade
conectada i r al ternar peri odi camente entre os val ores das propri edades OffValue
e BlinkOffValue, caso a fonte retorne Fal se. Exempl o:
Sub BlinkOff_Change()
Dim Bind
Set Bind = Screen.Item("Retangulo1")._
Links.Item("ForegroundColor")
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
Especi fi ca o val or al ternati vo a ser assumi do peri odi camente pel a propri edade
quando a expresso da fonte resul tar em Fal se, e a propri edade BlinkOff esti ver
confi gurada em True. Exempl o:
Sub BlinkOffValue_Click()
Dim Value
If Application.ShowPickColor_
(Value, ForegroundColor, 400, 300) Then
Dim Bind
Set Bind = Screen.Item("Retangulo1").Links._
Item("ForegroundColor")
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 propri edade esti ver confi gurada para True, a propri edade
conectada i r al ternar peri odi camente entre os val ores das propri edades OnValue
e BlinkOnValue, caso a fonte retorne True. Exempl o:
Sub BlinkOn_Change()
Dim Bind
Set Bind =_
Screen.Item("Retangulo1").Links.Item("ForegroundColor")
Else
MsgBox "Retangulo1 est associado a '" & Bind.Source & "'"
MsgBox "Mudando BlinkOn de " & Bind._
BlinkOn & " para " & Value
Bind.BlinkOn = Value
End If
End Sub
BlinkOnValue
Especi fi ca o val or al ternati vo a ser assumi do peri odi camente pel a propri edade
quando a expresso da fonte resul tar em True e a propri edade BlinkOn esti ver
confi gurada para True. Exempl o:
Sub BlinkOnValue_Click()
Dim Value
Dim Bind
Else
MsgBox "Mudando BlinkOnValue de " &_
Bind.BlinkOnValue & " para " & Value
Bind.BlinkOnValue = Value
End If
End If
End Sub
OffValue
Especi fi ca o val or assumi do pel a propri edade quando a expresso da fonte
resul tar em Fal se. Exempl o:
Sub OffValue_Click()
Dim Value
Dim Bind
Else
MsgBox "Mudando OffValue de " &_
Bind.OffValue & " para " & Value
Bind.OffValue = Value
End If
End If
End Sub
OnValue
Especi fi ca o val or assumi do pel a propri edade quando a expresso da fonte for
True. Exempl o:
Sub OnValue_Click()
Dim Value
Dim Bind
Else
MsgBox "Mudando OnValue de " &_
Bind.OnValue & " para " & Value
Bind.OnValue = Value
End If
End If
End Sub
2.8.4.3.6 Associao por Tabela
Esta seo contm i nformaes sobre mtodos e propriedades do objeto
Associ ao por Tabel a. Este objeto no possui eventos associ ados.
2.8.4.3.6.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Associ ao por Tabel a.
InsertRow
InsertRow([Row])
Insere uma nova l i nha na tabel a. O parmetro Row opci onal e especi fi ca em que
posi o da tabel a deve ser i nseri da a l i nha. Quando omi ti do, assume o
comportamento padro de i nseri r a l i nha no fi m da tabel a, o que equi val e a usar
Row i gual a -1. Quando i nformado e no for -1, deve ser um val or entre 1 e Count, e
a nova l i nha cri ada desl oca as l i nhas de ndi ce mai or ou i gual para a di reo
ascendente dos ndi ces. Uma l i nha nova sempre assume os segui ntes val ores
padro para as propri edades:
Min: 0.0
Max: 1.0
Blink: Fal se
BlinkValue: 0.0
Value: 0.0
Exempl o:
Dim Bind
Set Bind = _
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 refernci a para o objeto Li nha da Conexo por Tabel a, i ndi cado por
ItemId.
RemoveRow
RemoveRow(Row)
Remove a l i nha no ndi ce especi fi cado. O parmetro Row determi na a l i nha da
tabel a a ser removi da (deve ser de 1 at Count). Exempl o:
Sub RemoveRow_Click()
Dim Bind
Set Bind =_
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
Esta seo contm i nformaes sobre as propri edades do objeto Associ ao por
Tabel a.
Count
A propri edade Count i nforma o nmero de l i nhas da tabel a. Esta propri edade
somente de l ei tura.
2.8.4.3.6.3 Linha da Associao por Tabela
Esta seo contm i nformaes sobre propriedades do objeto Li nha da Associ ao
por Tabel a. Este objeto no possui eventos nem mtodos associ ados.
Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Li nha da
Associ ao por Tabel a.
Blink
Determi na que quando a fonte esti ver no i nterval o desta Li nha, a propri edade i r
al ternar peri odi camente entre os val ores especi fi cados nas propri edades Value e
BlinkValue. Exempl o:
Sub CheckBox1_Click()
Screen.Item("Retangulo1").Links.Item("ForegroundColor")._
Item(1).Blink = Value
Item(2).Blink = Value
End Sub
BlinkValue
Especi fi ca o val or al ternati vo (para pi scar) da propri edade a ser assumi do
quando a fonte esti ver no i nterval o especi fi cado na Li nha, e a propri edade Blink
esti ver confi gurada para True. Exempl o:
Dim Cor
' Escolhe uma cor
Application.ShowPickColor Cor, 0, 100, 100
Item(1).BlinkValue = Cor
End Sub
Max
Especi fi ca o val or mxi mo da fonte para uma Li nha da Tabel a.
Min
Especi fi ca o val or mni mo da fonte para uma Li nha da Tabel a. Exempl o (para Max
e Min):
Set Bind = _
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
Especi fi ca o val or da propri edade a ser assumi do quando a fonte esti ver no
i nterval o especi fi cado na Li nha. Exempl o:
Dim Cor
' Escolhe uma cor
Application.ShowPickColor Cor, 0, 100, 100
Item(1).Value = Cor
End Sub
2.8.4.3.7 Associao Reversa
Esta seo contm i nformaes sobre propriedades do objeto Associ ao Reversa.
Reversa.
Reverse
True se a Associ ao for Reversa. Fal se se a Associ ao for Bi di reci onal ou
Si mpl es.
2.8.4.3.8 Associao Mltipla
Associ ao Ml ti pl a. Este objeto no possui eventos associ ados.
2.8.4.3.8.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Associ ao Ml ti pl a.
InsertRow
InsertRow(InsertAtRow)
Insere uma nova Li nha na tabel a de Associ aes Ml ti pl as.
Item
Item(ItemId)
Retorna uma refernci a para o objeto Li nha da Conexo Ml ti pl a, i ndi cado por
ItemId.
RemoveRow
RemoveRow(Row)
Remove a Li nha no ndi ce i ndi cado pel o parmetro Row.
Ml ti pl a.
Count
Esta propri edade retorna o nmero de Li nhas da tabel a de Associ aes Ml ti pl as.
2.8.4.3.8.3 Linha da Associao Mltipla
Esta seo contm i nformaes sobre propriedades do objeto Li nha da Associ ao
Ml ti pl a. Este objeto no possui eventos nem mtodos associ ados.
Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Li nha da
Associ ao Ml ti pl a.
Max
Interval o mxi mo para o val or da Associ ao i ndi cada na propri edade Source.
Min
Interval o mni mo para o val or da Associ ao i ndi cada na propri edade Source.
Source
Especi fi ca a fonte da Associ ao da Li nha da Conexo Ml ti pl a, que pode ser o
nome de outro objeto da apl i cao ou uma expresso mai s compl exa, acessando
vri os objetos.
Bibliotecas do Usurio 75
3
Bibliotecas do Usurio
CAPTULO
Esta seo contm i nformaes sobre os objetos XControl s, XObjects e as
Propri edades de um El i pseX.
3.1 XControls e XObjects
Esta seo contm i nformaes sobre eventos e propriedades dos objetos
XControl s e XObjects. Estes objetos no possuem mtodos associ ados.
3.1.1 Eventos
Esta seo contm i nformaes sobre os eventos dos objetos XControl s e XObjects.
3.1.1.1 Constructor
Constructor()
Di sparado quando o El i pseX i ni ci ado. Pode-se uti l i zar este evento para rodar um
scri pt que i ni ci e val ores i nternos de um El i pseX, por exempl o.
3.1.1.2 CustomConfig
CustomConfig()
Permi te confi guraes automati zadas nas i nstnci as de El i pseX. Uma opo de
confi gurao i r aparecer no menu de contexto das i nstnci as de El i pseX sempre
que exi sti r um scri pt associ ado ao evento CustomConfig da defi ni o do El i pseX.
Quando a opo sel eci onada no menu, o evento di sparado. O texto que aparece
na opo do menu pode ser i nformado na propri edade CustomConfigText da
defi ni o do El i pseX. Se esta propri edade esti ver em branco, aparecer o texto
"Confi gurar".
76 Bibliotecas do Usurio
Menu de contexto da instncia do ElipseX
NOTA: O scri pt associ ado ao evento CustomConfig roda no E3 Studi o, onde os objetos
no esto ati vos. Portanto, o comportamento ser di ferente do usual .
3.1.2 Propriedades
Esta seo contm i nformaes sobre as propri edades dos objetos XControl s e
XObjects.
3.1.2.1 CustomConfigText
Indi ca o texto que dever aparecer no menu para a opo de confi gurao da
i nstnci a do El i pseX. A opo s i r aparecer se exi sti r um scri pt associ ado ao
evento CustomConfig da defi ni o do El i pseX. Se o val or da propri edade esti ver em
branco, aparecer o texto "Confi gurar" na opo do menu. O val or padro desta
propri edade uma String vazi a.
3.2 Propriedades de um ElipseX
Esta seo contm i nformaes sobre eventos e propriedades do objeto
Propri edade de um El i pseX. Este objeto no possui mtodos associ ados.
3.2.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Propri edade de um
El i pseX.
3.2.1.1 OnPropertyChanged
OnPropertyChanged()
Ocorre quando uma propri edade de um El i pseX modi fi cada. Pode-se uti l i zar este
evento para di sparar scri pts que executem aes de acordo com determi nado
status de um El i pseX.
3.2.2 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Propri edade de
um El i pseX.
3.2.2.1 DefaultValue
Defi ne o val or i ni ci al para a Propri edade quando uma nova i nstnci a do objeto
cri ada. Se a Propri edade est confi gurada como retentiva, el a ser i ni ci al i zada
com este val or cada vez que o objeto for carregado. O val or padro desta
propri edade vazi o (Empty).
3.2.2.2 HelpString
Texto contendo a descri o da Propri edade. Este texto ser mostrado na parte
i nferi or da Li sta de Propri edades no Studi o quando a Propri edade for sel eci onada.
O val or padro desta propri edade uma String vazi a.
78 Bibliotecas do Usurio
3.2.2.3 Persistable
Indi ca se a Propri edade sal va no arqui vo de projeto (Verdadei ro) ou se est
di sponvel apenas em tempo de execuo (Fal so). O val or padro desta
propri edade Verdadei ro. Se esta propri edade for confi gurada com o val or Fal so, a
Propri edade no pode ser edi tada no Studi o, nem sal va ou l i da do arqui vo de
projeto. Entretanto, a Propri edade ai nda vi svel no AppBrowser. Esta propri edade
representada pel o cone .
Quando esta propri edade est confi gurada para Verdadei ro, a Propri edade recebe
seu val or padro (propri edade DefaultValue) apenas na cri ao de uma i nstnci a.
Se a propri edade DefaultValue for al terada, as i nstnci as do objeto j cri adas no
so afetadas.
Quando esta propri edade est confi gurada para Fal so, a Propri edade recebe seu
val or padro sempre que uma i nstnci a carregada, ou seja, sempre que a
propri edade DefaultValue for al terada, todas as i nstnci as j cri adas so
i ni ci al i zadas com o novo val or padro.
3.2.2.4 Public
Quando uma Propri edade de um El i pseX pbl i ca (True), el a ser vi svel fora da
Bi bl i oteca. Caso contrri o, a Propri edade ser i nterna e somente vi svel para o
objeto. O val or padro desta propri edade True. A Propri edade pbl i ca
representada pel o cone .
3.2.2.5 Retentive
Indi ca se o val or atual da Propri edade em tempo de execuo ser persi sti do no
arqui vo de Domni o (Verdadei ro), enquanto o Domni o esti ver carregado.
Propri edades retenti vas tm o segui nte comportamento:
Propagam o seu val or para o servi dor em Standby
Mantm o seu val or se a apl i cao atual i zada em tempo de execuo
Mantm o seu val or se a apl i cao parada (desde que o Domni o no seja
fechado)
NOTAS:
Esta propri edade somente est di sponvel para Propri edades cujo ti po de dados
no seja um objeto (Variant, Double, Integer, etc.)
O uso dessa propri edade em Verdadei ro i mpl i ca em um aumento no uso de
memri a e CPU por parte do E3Run, por i sso deve ser uti l i zada com cautel a
3.2.2.6 Type
Determi na o ti po de val ores que a Propri edade i r acei tar (por exempl o, Boolean,
Double, Integer, Variant, etc.). Quando for especi fi cado um objeto como ti po (por
exempl o DemoTag, IOTag, XObject, etc.), esta propri edade ter o segui nte
comportamento:
Caso o ElipseX esteja inativo: A propri edade funci ona como uma String, que
especi fi ca o cami nho da i nstnci a de um objeto do ti po confi gurado
Caso o ElipseX esteja ativo: Na escri ta, a propri edade funci ona da mesma
manei ra de quando o objeto est desati vado. Porm, na l ei tura a propri edade
retorna o objeto especi fi cado, caso el e exi sta. Se o cami nho no aponta para um
objeto exi stente no momento, a propri edade retorna Nothing
80 Visualizao
4
Visualizao
CAPTULO
Esta seo contm i nformaes sobre eventos, mtodos e propri edades dos objetos
de vi sual i zao do E3:
Viewer
Quadros e Divisores
Telas e Objetos de Tela
E3Alarm
E3Browser
E3Chart
E3Playback
Relatrios
4.1 Viewer
Esta seo contm i nformaes sobre eventos, mtodos e propriedades do objeto
Vi ewer.
4.1.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Vi ewer.
4.1.1.1 OnInactive
OnInactive()
Este evento ocorre enquanto o Vi ewer esti ver i nati vo, se a propri edade
EnableInactivity esti ver em True. El e i ni ci a quando constatado que o usuri o est
sem uti l i zar o Vi ewer por um perodo de tempo i gual ou superi or ao val or da
propri edade InactivityTime.
Em um scri pt para esse evento, o usuri o pode programar o que deseja fazer
quando o Vi ewer esti ver i nati vo por um determi nado perodo de tempo. Por
exempl o, possvel determi nar que aps 20 mi nutos sem uso, ser fei to logout do
Vi ewer. Exempl o:
Sub Viewer_OnInactive()
Logout(false)
If MsgBox("Essa sesso do Viewer foi fechada devido
inatividade.") = 0 Then
Visualizao 81
Application.GetFrame("").OpenScreen "TelaInicial", 0
End Sub
4.1.1.2 Eventos de Usurio
Esta seo contm i nformaes sobre eventos de usuri o do objeto Vi ewer. Os
eventos di sponvei s nesta seo so os segui ntes:
OnLogin
OnLogout
4.1.1.2.1 OnLogin
OnLogin()
Ocorre quando um usuri o executa um login de si stema (autenti cao de usuri o)
com sucesso. O login de si stema pode ser fei to atravs da execuo do mtodo
Login ou quando um objeto que s pode ser acessado por usuri os com um
determi nado nvel de autori zao exi ge autenti cao.
4.1.1.2.2 OnLogout
OnLogout()
Ocorre quando executado um logout, ou seja, a sada do usuri o do si stema. O
logout fei to atravs da chamada ao mtodo Logout.
4.1.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Vi ewer.
4.1.2.1 CaptureScreen
CaptureScreen(Filename)
O mtodo CaptureScreen captura a Tel a atual e a sal va em um arqui vo. Este mtodo
semel hante ao efei to real i zado pel a tecl a PRINT SCREEN no Wi ndows. O
parmetro Filename determi na o nome do arqui vo no qual a Tel a ser sal va.
NOTA: O formato fi nal do arqui vo Bi tmap (.bmp), mesmo que no parmetro
Filename seja i nformada outra extenso (.gi f, .jpg, etc.).
Exempl o:
Screen.Frame.CaptureScreen "c:\temp\tela.bmp"
End Sub
82 Visualizao
4.1.2.2 ChangePassword
ChangePassword()
Este mtodo abre uma cai xa de di l ogo para permi ti r a troca de senha do usuri o
atual . O mtodo retorna Verdadei ro se o usuri o atual tem permi sso para trocar a
senha. Caso contrri o, retorna Fal so, i ndi cando que houve fal ha na operao, ou
que no possvel trocar a senha, porque o usuri o no tem autori zao.
NOTA: Este mtodo s estar di sponvel se o usuri o l ogado for um usuri o do
Domni o do E3.
4.1.2.3 DoModal
DoModal(Screen, Title, Left, Top, Width, Height, Arg, Flags)
Abre uma Tel a modal . Uma Tel a modal uma janel a que no permi te cl i car em
outras Tel as ou janel as enquanto el a no for fechada. O parmetro Title passado
neste mtodo s ser uti l i zado se a propri edade Caption esti ver vazi a; do contrri o,
este parmetro ser i gnorado.
Este mtodo possui os segui ntes parmetros:
Screen: determi na o nome da Tel a
Title: determi na o ttul o da janel a modal
Left, Top: posi o XY da janel a modal em pi xel s
Width: l argura da janel a modal em pi xel s ou Hi metri c
Height: al tura da janel a modal em pi xel s ou Hi metri c
Arg: determi na a vari vel a ser usada no evento OnPreShow da Tel a
Flags: determi na a combi nao uti l i zada na janel a modal . Tal combi nao fei ta
somando-se os val ores da tabel a correspondentes s opes que o usuri o
deseja. Quando o val or especi fi cado for -1, sero adotadas as confi guraes do
Vi ewer para a janel a modal . Quando este val or for di ferente de -1, pode-se fazer
as combi naes descri tas na tabel a a segui r.
Combinaes possveis para o parmetro Flags
VALOR DESCRIO
1
Habi l i ta a barra de ttul o na janel a
2
Habi l i ta o boto Fechar na janel a.
4
Habi l i ta o boto Minimizar na janel a.
8
Habi l i ta o boto Maximizar na janel a.
16
Habi l i ta a borda na janel a.
32
Especi fi ca que a janel a pode ser
di mensi onada.
Visualizao 83
VALOR DESCRIO
64
Especi fi ca que a janel a pode ser movi da.
256
Especi fi ca que a janel a fi car no topo da
Tel a.
512
Especi fi ca que a janel a ser confi gurada
no esti l o Barra de Ferramentas.
1024
Desabi l i ta os botes de objeto.
2048
Central i za a Tel a modal no Quadro tanto
hori zontal quanto verti cal mente.
Exempl o:
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 val ores de tamanho neste mtodo podem ser i nformados como nmeros
ou Strings. No caso de nmeros, so consi derados em pi xel s. No caso de Strings, se
vi erem acompanhados da uni dade "hm", sero i nterpretados como Hi metri c.
Qual quer outro caso consi derado em pi xel s.
4.1.2.4 ESign
ESign(ObjName[, Description[, Action[, From[, To[, User[, Comment]]]]]])
O mtodo ESign uti l i zado para executar uma val i dao da al terao de um
campo, atravs de assi natura el etrni ca. Quando este mtodo uti l i zado, a
segui nte cai xa de di l ogo mostrada:
84 Visualizao
Caixa de Dilogo de Assinatura Eletrnica
Parmetros do mtodo ESign
PARMETRO DESCRIO
ObjName
Texto que contm o nome de um Tag ou
outro objeto da apl i cao.
Description
Texto que contm a descri o de
ObjName. Este parmetro opci onal e, se
for omi ti do, a cai xa de di l ogo tentar
buscar os dados da propri edade
DocString de ObjName.
Action
Texto que contm a ao a ser executada
(por exempl o, "Al terao do val or"). Este
parmetro opci onal e o seu val or
padro uma String vazi a.
From
Variant que contm o val or ori gi nal , ou o
estado que ser al terado. Este
parmetro opci onal .
To
Variant que contm o novo val or do Tag,
ou o val or a ser apl i cado em Action. Este
Visualizao 85
PARMETRO DESCRIO
User
Texto de retorno. Recebe o nome de login
sel eci onado na cai xa de di l ogo. Este
Comment
Texto de retorno. Recebe o comentri o
di gi tado na cai xa de di l ogo. Este
Ao cl i car em , abre-se uma janel a que permi te autenti car o usuri o. Se a opo
Windows for sel eci onada, os campos Nome do usurio e Senha sero
automati camente desabi l i tados. Cl i que em Outro usurio para sel eci onar um
usuri o pertencente ao domni o de rede. Caso a opo E3 seja sel eci onada, di gi te
as i nformaes de um usuri o pertencente ao Domni o do E3 nos campos Nome do
usurio e Senha.
Login integrado
Este mtodo retorna Verdadei ro se o usuri o cl i car em OK, e se os campos Usurio e
Senha forem vl i dos. Caso contrri o, se a cai xa de di l ogo for cancel ada ou se o
login ou a senha esti verem errados, aps trs tentati vas o mtodo retorna Fal so. Em
caso de fal ha, User e Comment so confi gurados para uma String vazi a.
Os comentri os pr-defi ni dos so guardados no Regi stro do Wi ndows. Apenas os
l ti mos 26 comentri os so sal vos. Cada vez que a janel a cri ada, os l ti mos
comentri os so buscados no Regi stro e usados para preencher a l i sta de sel eo.
Se um novo comentri o for i nformado pel o usuri o, el e ser sal vo e o mai s anti go
ser descartado, caso no haja posi o l i vre. Se for uti l i zado um comentri o j
exi stente, este passa a ser o pri mei ro da l i sta de mai s recentes. Exempl o:
Sub Button1_Click()
Dim Tag, User, Comment
86 Visualizao
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 apl i cati vo externo de nome e cami nho AppPath, com os
argumentos Arguments, i ni ci ando no di retri o de trabal ho InitialDir. Quando
especi fi cado um documento em AppPath, o apl i cati vo associ ado a este documento
executado, e o documento passado como um dos parmetros do apl i cati vo.
ProcessID recebe o nmero que i denti fi ca o processo (esse nmero uti l i zado no
mtodo IsAppRunning e o mesmo val or que aparece no Gerenci ador de Tarefas do
Wi ndows, na col una PID). O parmetro CmdShow especi fi ca o modo de abertura da
janel a do apl i cati vo, como na tabel a a segui r:
Opes disponveis para o parmetro CmdShow
OPO DESCRIO
0
Esconde a janel a e ati va outra janel a.
1
Ati va e mostra a janel a. Se a janel a
esti ver maxi mi zada ou mi ni mi zada, el a
ser restaurada para o tamanho e
posi o ori gi nai s. Uma apl i cao deve
especi fi car esse val or quando esti ver
mostrando uma janel a pel a pri mei ra vez.
2
Ati va a janel a e mostra-a mi ni mi zada.
3
Ati va a janel a e mostra-a maxi mi zada.
4
Mostra a janel a com seu tamanho e
posi o mai s recentes. A janel a ati va
permanece ati va.
5
Ati va a janel a e mostra-a com seu
tamanho e posi o atuai s.
6
Mi ni mi za a janel a e ati va a prxi ma
janel a de nvel superi or.
7
Mostra a janel a mi ni mi zada. A janel a
ati va permanece ati va.
8
Mostra a janel a em seu estado atual . A
janel a ati va permanece ati va.
Visualizao 87
OPO DESCRIO
9
Ati va e mostra a janel a. Se a janel a
esti ver maxi mi zada ou mi ni mi zada, el a
ser restaurada para o tamanho e
posi o ori gi nai s. Uma apl i cao deve
especi fi car esse val or quando esti ver
restaurando uma janel a que estava
mi ni mi zada.
Exempl o:
Dim ret
Application.ExecuteExternalApp "calc.exe", "", "", 1, ret
Application.GetObject("Dados.TagInterno1").Value = ret
End Sub
NOTA: O parmetro retornado em ProcessID pode ser 0, caso nenhum processo tenha
si do i ni ci ado. Por exempl o, se um documento aberto for uma URL e uma i nstnci a
do I nternet Expl orer j esti ver rodando, el a mostrar o documento. Nenhum
processo novo i ni ci ado, portanto ProcessID ser 0.
4.1.2.6 Exit
Exit()
Este mtodo fecha a janel a no Vi ewer. Exempl o:
Sub_Botao1.Click()
Application.Exit()
EndSub
4.1.2.7 GetFormulaUnitDataObj
GetFormulaUnitDataObj(FormulaName)
Este mtodo obtm a confi gurao das Uni dades exi stentes em uma determi nada
Frmul a. As Uni dades so o desti no dos dados sal vos na Frmul a (val ores). Este
mtodo possui o parmetro FormulaName, que o nome da Frmul a.
Uti l i ze o mtodo GetFormulaUnitDataObj para obter uma col eo das uni dades de
uma Frmul a. Este mtodo retorna True se consegui r real i zar a operao, ou Fal se,
caso no consi ga. Exempl o:
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)
88 Visualizao
MsgBox CStr(obj.Name(1))
End Sub
4.1.2.8 GetFormulaValueDataObj
GetFormulaValueDataObj(FormulaName)
Este mtodo obtm a confi gurao dos val ores exi stentes em uma determi nada
Frmul a. Os val ores so o conjunto de dados sal vos na Frmul a. Este mtodo
possui o parmetro FormulaName, que o nome da Frmul a.
Uti l i ze o mtodo GetFormulaValueDataObj para obter uma col eo de val ores na
Frmul a. Este mtodo retorna True se consegui r real i zar a operao, ou Fal se, caso
no consi ga. Exempl o:
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 Di vi sor que j esteja aberto no Vi ewer
atual . Este mtodo possui o parmetro FrameName, que opci onal e determi na o
nome do Quadro a ser buscado. Caso o val or especi fi cado em FrameName seja
vazi o, el e retornar um Quadro que contm todos os Di vi sores ou a Tel a ati va no
momento. Com o retorno deste mtodo, uti l i ze os mtodos do Di vi sor, como por
exempl o, o mtodo OpenScreen para abri r uma outra Tel a. Exempl o:
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 compl eto do usuri o l ogado no E3.
Caso no haja nenhum usuri o l ogado, retornada uma String vazi a.
Visualizao 89
4.1.2.11 GetKeyPad
GetKeyPad()
Retorna uma refernci a para o objeto El i pse KeyPad, permi ti ndo mani pul ar um
tecl ado vi rtual fl utuante em apl i caes desenvol vi das com o E3. Veja o Manual do
Usurio do E3 para mai ores i nformaes sobre este objeto. Os mtodos e
propri edades do El i pse KeyPad esto descri tos no captul o ActiveX - Elipse KeyPad.
4.1.2.12 GetMouseX
GetMouseX()
Retorna a coordenada X do mouse, em pi xel s, referente rea total da tel a do
computador.
NOTA: Este mtodo i r fal har em um scri pt se a posi o atual do mouse no puder
ser determi nada. Uma das si tuaes onde essa fal ha pode ser veri fi cada o caso
de estar aberta a janel a de Logon do Wi ndows (ao pressi onar a combi nao de
tecl as CTRL + ALT + DEL). Este comportamento de i mpedi r o acesso posi o atual
do mouse padro do Wi ndows em al gumas si tuaes e no pode ser contornado.
Sugere-se uti l i zar o comando On Error Resume Next antes da uti l i zao deste
mtodo para evi tar erros de scri pt.
4.1.2.13 GetMouseY
GetMouseY()
Retorna a coordenada Y do mouse, em pi xel s, referente rea total da tel a do
computador.
NOTA: Este mtodo i r fal har em um scri pt se a posi o atual do mouse no puder
ser determi nada. Uma das si tuaes onde essa fal ha pode ser veri fi cada o caso
de estar aberta a janel a de Logon do Wi ndows (ao pressi onar a combi nao de
tecl as CTRL + ALT + DEL). Este comportamento de i mpedi r o acesso posi o atual
do mouse padro do Wi ndows em al gumas si tuaes e no pode ser contornado.
Sugere-se uti l i zar o comando On Error Resume Next antes da uti l i zao deste
mtodo para evi tar erros de scri pt.
4.1.2.14 GetValue
GetValue(TagName)
O mtodo GetValue busca pel o val or de um objeto especi fi cado no parmetro
TagName. Se TagName apontar para uma propri edade, este mtodo retornar o
val or da propri edade. Se por outro l ado o parmetro TagName especi fi car um
objeto, o mtodo retornar o val or da propri edade Value do objeto. Exempl o:
Sub Botao1_Click()
90 Visualizao
' Ao clicar no Boto pega o valor de um tag
' sendo executado em um DataServer
X = Application.GetValue("DataServer1.InternalTag1")
End Sub
4.1.2.15 IsAppRunning
IsAppRunning(ProcessId)
Indi ca se uma apl i cao i ni ci ada pel o mtodo ExecuteExternalApp est sendo
executada. Retorna True se o apl i cati vo i denti fi cado no si stema operaci onal por
ProcessId esti ver rodando. Caso contrri o, retorna Fal se. Exempl o:
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 parmetro ProcessId o mesmo val or que aparece no Gerenci ador de
Tarefas do Wi ndows, na col una PID.
4.1.2.16 IsUserMemberOfGroup
IsUserMemberOfGroup(GroupName[, UserName])
Este mtodo veri fi ca se um usuri o pertence a um determi nado grupo. Possui os
segui ntes parmetros:
GroupName: Nome do grupo de usuri os que se quer veri fi car
UserName: Nome do usuri o que se quer veri fi car. Se este parmetro for omi ti do,
ou for i gual a uma String vazi a, o mtodo consi dera o usuri o atual mente l ogado
no Vi ewer
O mtodo retorna Verdadei ro se o usuri o pertencer ao grupo i ndi cado por
GroupName, ou Fal so caso contrri o.
4.1.2.17 IsWebViewer
IsWebViewer()
Veri fi ca se o apl i cati vo est sendo vi sual i zado pel o WebVi ewer. O mtodo retorna
True se a apl i cao esti ver sendo executada no WebVi ewer. Caso contrri o, retorna
Fal se.
Visualizao 91
4.1.2.18 LoadFormulaDlg
LoadFormulaDlg(FormulaName[, UnitName[, ValueName]])
Este mtodo apresenta uma cai xa de di l ogo que permi te ao usuri o escol her o
conjunto de val ores e a uni dade de desti no, carregando uma Frmul a. Este mtodo
possui o parmetro FormulaName, que determi na o nome do objeto Frmul a que
ser operado.
Uti l i ze o mtodo LoadFormulaDlg para chamar uma cai xa de di l ogo para
carregamento dos dados do objeto Frmul a especi fi cado por FormulaName. Nesta
cai xa possvel especi fi car qual conjunto de val ores (UnitName) ser envi ado para
qual conjunto de Tags (ValueName). Nesta cai xa de mensagem o usuri o conta com
todos os conjuntos de val ores e uni dades di sponvei s no objeto Frmul a, podendo
atri bui r um a outro l i vremente. Quando o usuri o cl i car em OK, o conjunto de
val ores ser carregado na uni dade especi fi cada. Exempl o:
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 automati camente um conjunto de val ores para uma uni dade
de desti no, apresentando uma cai xa de di l ogo que permi te ao usuri o i nformar
val ores di ferentes daquel es defi ni dos na Frmul a. Este mtodo possui os segui ntes
parmetros: FormulaName determi na o nome da Frmul a e UnitName determi na o
nome da uni dade. O nome do conjunto de val ores confi gurado no parmetro
ValueName.
Uma cai xa de mensagem aparecer permi ti ndo ao usuri o i nformar val ores
di ferentes daquel es defi ni dos para cada um dos val ores da Frmul a.
NOTA: O mtodo retorna um val or l gi co, ou seja, retorna True quando executada
com sucesso, e Fal se quando fal ha, o que no si gni fi ca que houve um erro no
scri pt.
Exempl o:
Sub Botao1_Click()
Application.LoadFormulaValues "Formula1", "Unit1", "Value1"
End Sub
92 Visualizao
4.1.2.20 LoadFormulaValuesQuiet
LoadFormulaValuesQuiet(FormulaName, UnitName, ValueName)
Carrega um conjunto de val ores para uma uni dade de desti no, sem apresentar
nenhuma mensagem. Este mtodo possui os segui ntes parmetros: FormulaName
determi na o nome da Frmul a e UnitName determi na o nome da uni dade. O nome
do conjunto de val ores confi gurado no parmetro ValueName. Exempl o:
Sub Botao1_Click()
Application.LoadFormulaValuesQuiet "Formula1", "Unidade3",
"Valor1"
End Sub
NOTA: Este mtodo tambm acessado atravs do objeto Frmula.
4.1.2.21 LoadReport
LoadReport(ReportName)
Carrega um model o de Rel atri o. O parmetro ReportName o nome do Rel atri o a
ser carregado. Exempl o:
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 cai xa de di l ogo para o login (autenti cao de usuri o) na apl i cao. O
usuri o l ogado permanece na memri a at que seja fei to outro login ou logout
(sada do usuri o da apl i cao). Este mtodo possui o parmetro Mode, que um
Bool eano que determi na se uma mensagem de confi rmao ou fal ha da operao
dever ser mostrada (o padro Fal so). Quando uma Tel a esti ver para ser aberta
(atravs do mtodo OpenScreen), veri fi cado se exi ste al guma confi gurao de
segurana. Caso exi sta, a Tel a s ser aberta se o usuri o l ogado ti ver permi sso.
Caso no tenha permi sso, aberto um di l ogo para o login.
4.1.2.23 LoginUser
LoginUser(Username, UserPassword)
Executa o login de um usuri o especfi co sem mostrar nenhuma mensagem. O
parmetro Username o nome do usuri o e o parmetro UserPassword a senha
desse usuri o. O mtodo retorna Verdadei ro se o login do usuri o foi bem-
sucedi do, e Fal so caso contrri o. Se o usuri o passado no parmetro Username
Visualizao 93
esti ver confi gurado para trocar de senha no prxi mo login, o mtodo retorna Fal so.
Domni o do E3.
4.1.2.24 Logout
Logout([Mode])
Executa o logout (sada do usuri o atual da apl i cao) do Vi ewer. Caso no haja
um usuri o l ogado, este mtodo no tem efei to. A parti r deste momento, ser
consi derado que um usuri o "anni mo" est uti l i zando a apl i cao. (Pode-se
uti l i zar o evento OnLogout para executar um scri pt para i r para a Tel a i ni ci al ou
fi nal i zar a apl i cao). Este mtodo possui o parmetro opci onal Mode, que um
Bool eano que determi na se uma mensagem de confi rmao ou fal ha da operao
dever ser mostrada (o padro Fal so).
4.1.2.25 PasswordConfirm
PasswordConfirm(Mode)
Este mtodo abre uma cai xa de di l ogo sol i ci tando a reconfi rmao da senha do
usuri o atual mente l ogado. Retorna Verdadei ro se a senha for confi rmada, ou
Fal so caso contrri o. O parmetro Bool eano Mode determi na se deve ser executado
um logout em caso de fal ha na confi rmao (Verdadei ro) ou no (Fal so).
Confirmao de senha
Se a cai xa de di l ogo for fechada atravs do boto Cancelar, o mtodo retorna
Fal so. Caso no haja usuri o l ogado, o mtodo retorna Fal so, mas sem abri r a
cai xa de di l ogo. Caso a senha di gi tada no esteja correta, a sol i ci tao repeti da
at no mxi mo trs vezes. Se o usuri o di gi tar a senha i ncorreta nestas trs vezes, a
cai xa de di l ogo fechada e o mtodo retorna Fal so.
94 Visualizao
Domni o do E3.
4.1.2.26 Playsound
Playsound(Filename)
Toca um arqui vo de som cujo cami nho e nome esto i ndi cados no parmetro
Filename. O arqui vo deve segui r as segui ntes especi fi caes:
Dever estar no formato de som do Wi ndows (extenso .wav)
Se o arqui vo esti ver no projeto (adi ci onado atravs do comando Inserir recurso),
o nome do arqui vo dever estar entre col chetes
Se foi cri ada uma pasta no projeto e o arqui vo foi adi ci onado atravs do
comando Inserir recurso, o cami nho dever ser especi fi cado entre aspas (por
exempl o, "c:\som\di ng.wav"). Se o arqui vo esti ver no di retri o l ocal , o nome no
preci sa de aspas, basta col ocar o cami nho (por exempl o: c:\som\di ng.wav).
Exempl o:
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 especi fi cado pel o parmetro
Menu. Este parmetro um texto que consi ste em vri as opes del i mi tadas pel a
barra verti cal (|), sendo que cada uma destas Strings ser uma opo do menu.
Caso haja um conjunto de doi s del i mi tadores sucessi vos (||), um separador ser
i nseri do. Use os caracteres de abre e fecha chaves para cri ar um submenu. Um
asteri sco na frente de uma String i ndi ca que a opo estar marcada. J um si nal
de excl amao far com que a opo esteja desabi l i tada.
A posi o da cai xa de di l ogo pode ser confi gurada atravs dos parmetros Left e
Top, que i ndi cam a di stnci a da margem esquerda e do topo da Tel a em pi xel s,
respecti vamente. Caso estes parmetros no sejam i nformados, o menu
posi ci onado de acordo com o l ocal onde o cl i que do mouse foi aci onado.
Este mtodo retornar 0 se nenhuma opo foi sel eci onada, ou o nmero da opo,
sendo que 1 seri a para a pri mei ra opo conti da no texto, 2 para a segunda e
Visualizao 95
assi m por di ante. Exempl o:
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
ElseIf op = 3 Then
ElseIf op = 4 Then
ElseIf op = 0 Then
MsgBox "Nenhuma opo foi escolhida"
End If
End Sub
4.1.2.28 SetValue
SetValue(TagName, NewVal)
Este mtodo confi gura o val or de um objeto dentro do servi dor. O mtodo SetValue
procura por um objeto ou propri edade sendo executado no servi dor e atri bui o
val or especi fi cado no parmetro defi ni do em TagName. O ti po e o val or do
parmetro NewVal devero ser suportados pel o objeto especi fi cado em TagName.
Exempl o:
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 cai xa de di l ogo para a al terao de data e hora. Este mtodo retorna
True se o usuri o confi rmar a data, ou Fal se se o usuri o cancel ar a edi o. A nova
data retornada no parmetro DateValue. A posi o da cai xa de di l ogo pode ser
confi gurada atravs dos parmetros Left e Top, que i ndi cam a di stnci a da margem
esquerda e do topo da tel a em pi xel s, respecti vamente. Caso estes parmetros no
sejam i nformados, a cai xa de di l ogo central i zada. O val or do parmetro
DefaultDate a data e a hora i ni ci ai s quando a cai xa de di l ogo for aberta. Se no
for i nformada a data, o si stema assume a data atual ; se no for i nformada a hora,
i ni ci ar como 00:00:00. Se nem a data nem a hora forem i nformadas, i ni ci ar com
data e hora atuai s. Exempl os:
Sub Texto2_Click()
Dim novaHora
96 Visualizao
Application.ShowDatePicker novaHora, 300, 300
MsgBox "A hora : " & novaHora
End Sub
4.1.2.30 ShowFilePicker
ShowFilePicker(Open, FileName[, Extension, Flags, Filter])
Exi be as cai xas de di l ogo Sal var e Abri r Arqui vo, do Wi ndows. O parmetro Open
i ndi ca o di l ogo a ser aberto; se True, abre a janel a Abri r Arqui vo; se Fal se, abre a
janel a Sal var. O parmetro FileName i ndi ca a vari vel onde ser armazenado o
nome do arqui vo a ser sal vo ou carregado, caso o mtodo retorne True. Este
parmetro deve ser obri gatori amente uma vari vel . O parmetro Extension
opci onal e i nforma a extenso do arqui vo padro a ser anexada ao nome do
arqui vo na cai xa de entrada, quando a extenso no for i nformada. Caso esteja
vazi o, nenhuma extenso ser concatenada ao fi nal do nome do arqui vo. Extenses
ml ti pl as podem ser especi fi cadas usando-se o caractere de ponto e vrgul a como
del i mi tador. A String deve termi nar com os caracteres ||.
O parmetro Flags opci onal e defi ne o comportamento da cai xa de di l ogo. um
nmero i ntei ro, a soma dos val ores da tabel a a segui r. O parmetro Filter
opci onal e defi ne um conjunto de pares de Strings que especi fi cam fi l tros que
podem ser apl i cados aos arqui vos. A pri mei ra String descreve o fi l tro, e a segunda
i ndi ca o ti po de extenso a ser uti l i zada.
VALOR DESCRIO
1
CREATEPROMPT: Se o usuri o especi fi car
um arqui vo que no exi ste, este flag faz
com que el e seja questi onado sobre a
cri ao do arqui vo. Se el e escol her cri ar
o arqui vo, a cai xa de di l ogo fechada e
o nome do arqui vo retornado no
parmetro Filename. Caso contrri o, a
cai xa de di l ogo permanece aberta.
2
FILEMUSTEXIST: Especi fi ca que o usuri o
s pode di gi tar nomes de arqui vos
exi stentes. Caso contrri o, a cai xa de
di l ogo mostra um avi so na cai xa de
mensagens.
4
NOCHANGEDIR: Recupera o di retri o
atual para o val or ori gi nal caso o usuri o
tenha mudado de di retri o enquanto
buscava o arqui vo. No tem efei to para a
janel a Abri r Arqui vo no Wi ndows XP.
Visualizao 97
VALOR DESCRIO
8
NODEREFERENCELINKS: Confi gura a cai xa
de di l ogo para retornar o arqui vo de
atal ho (.l nk) sel eci onado. Se este flag
no for especi fi cado, a cai xa de di l ogo
retorna o cami nho e nome de arqui vo
referenci ados pel o arqui vo de atal ho.
16
NOREADONLYRETURN: Determi na que o
arqui vo retornado no seja somente
para l ei tura, e o di retri o no
protegi do contra gravao.
32
PATHMUSTEXIST: Especi fi ca que o usuri o
pode i nformar apenas arqui vos e
di retri os vl i dos, caso contrri o uma
cai xa de mensagem mostrada para
avi sar o usuri o.
64
READONLY: Faz o boto de opo Somente
Leitura ser sel eci onado i ni ci al mente
quando o di l ogo cri ado.
128
OVERWRITEPROMPT: Faz a cai xa de
di l ogo de Sal var Como gerar uma
mensagem i nformando da exi stnci a do
arqui vo, e pede confi rmao para
sobrescrever o arqui vo.
Exempl o de fi l tro:
"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 cai xa de di l ogo Cores do Wi ndows para a escol ha de uma cor. O val or
deci mal da cor escol hi da retornado no parmetro ColorValue. O parmetro Color
i ndi ca uma cor previ amente sel eci onada na pal eta de cores. Se este parmetro no
for i nformado, assume o val or 0 (preto). A posi o da cai xa de di l ogo pode ser
confi gurada atravs dos parmetros Left e Top, que i ndi cam respecti vamente, a
di stnci a da margem esquerda e do topo da tel a, em pi xel s. Caso estes parmetros
no sejam i nformados, a cai xa de di l ogo central i zada. Exempl o:
Sub CommandButton_Click()
Dim novaCor
Dim corPadrao
corPadrao = 65280 ' Verde Claro
If Application.ShowPickColor(novaCor, corPadrao, 90, 90) Then
Screen.Item("Retangulo1").ForegroundColor = novaCor
98 Visualizao
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 val or do objeto ou propri edade sendo executado no
servi dor e compara com os parmetros ValA e ValB. Se o val or buscado for i gual a
ValB, o objeto ou propri edade especi fi cado em TagName receber o val or de ValA.
Caso contrri o, receber o val or de ValB. Caso o val or de TagName no seja nem
ValA nem ValB, o mtodo ToggleValue atri bui r o val or especi fi cado em ValA.
Exempl o:
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 permi te gerar eventos vi a scri pt manual mente. Estes eventos
podem ser gerados tanto no Vi ewer como no Servi dor, e so regi strados em uma
tabel a no banco de dados do apl i cati vo.
Parmetros do mtodo TrackEvent
NOME DESCRIO
EventMessage
Contm a mensagem do evento (mxi mo
de 200 caracteres).
Comment
(Opci onal ) Contm comentri os
adi ci onai s sobre o evento (mxi mo de
200 caracteres).
TimeStamp
(Opci onal ) I ndi ca a data e hora em que o
evento ocorreu. Se no for especi fi cado,
o E3 assume a data e hora atuai s.
Visualizao 99
O mtodo TrackEvent s vai regi strar os eventos caso a opo de Registro de
Eventos nas Opes do Domni o esteja habi l i tada. Os eventos so regi strados em
uma tabel a de um banco de dados, que defi ni da tambm nas confi guraes de
Regi stro de Eventos.
Para mai ores i nformaes sobre o Regi stro de Eventos do Domni o, consul te o
Manual do Usurio do E3. Exempl o:
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 cai xa de di l ogo que permi te edi tar a l i sta de usuri os do
Servi dor. As funes di sponvei s so:
Mostrar a l i sta de todos os usuri os
Excl ui r usuri os (no possvel excl ui r o usuri o atual )
Adi ci onar e edi tar usuri os
Edi tar as confi guraes de um usuri o
Al terar a senha do usuri o
Al terar os demai s dados do usuri o (login, nome, etc.)
IMPORTANTE: Apenas o Admi ni strador pode ter acesso ao mtodo
UserAdministration. A cai xa de di l ogo de confi gurao dos usuri os acessvel
somente ao usuri o habi l i tado como Admi ni strador.
4.1.3 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Vi ewer.
100 Visualizao
4.1.3.1 BlinkTime
Defi ne o tempo, em mi l i ssegundos, entre cada mudana de estado quando um
objeto tem que pi scar (ou seja, toda vez que al gum objeto de Tel a tem uma
associ ao e marcada a opo Piscar). O val or padro desta propri edade
200ms.
NOTA: O tempo mni mo de atual i zao da Tel a 55ms; portanto, se esta
propri edade for confi gurada com tempo i nferi or a 55ms, a confi gurao no ter
efei to al gum.
4.1.3.2 CacheEnable
Mantm em memri a as Tel as j abertas i nstanci adas no Vi ewer, permi ti ndo
uma troca mai s rpi da entre el as. Se a propri edade for habi l i tada, ento o cache de
Tel as tambm habi l i tado.
4.1.3.3 Caption
Determi na o nome da apl i cao que est uti l i zando o Vi ewer. O val or padro
desta propri edade vazi o.
4.1.3.4 CenterWindow
Quando habi l i tada, determi na que a janel a de vi sual i zao do Vi ewer dever
i ni ci ar central i zada. Caso contrri o, ser uti l i zada a confi gurao padro. O val or
padro desta propri edade True.
4.1.3.5 CloseButton
Se a opo esti ver habi l i tada, o boto Fechar habi l i tado no Vi ewer, e possvel
uti l i zar este boto. Caso contrri o, este boto no aparece na janel a. O val or
4.1.3.6 CommErrorBkColor
Propri edade uti l i zada para defi ni r a cor de fundo do Setpoi nt quando uma
Associ ao ou Conexo fal hou. O val or padro desta propri edade vermel ho (RGB
(255, 0, 0)). Veri fi car tambm a propri edade EnableCommError.
4.1.3.7 CommErrorText
Propri edade uti l i zada para defi ni r o texto de al erta quando uma Associ ao ou
Conexo fal hou. O val or padro desta propri edade "???". Veri fi car tambm a
propri edade EnableCommError.
Visualizao 101
4.1.3.8 CommErrorTextColor
Propri edade uti l i zada para defi ni r a cor do texto do Setpoi nt quando uma
Associ ao ou Conexo fal hou. O val or padro desta propri edade amarel o (RGB
(255, 255, 0)). Veri fi car tambm a propri edade EnableCommError.
4.1.3.9 DisableTaskSwitching
Se esti ver confi gurada para True, desabi l i ta a troca de janel as no Vi ewer. Caso
contrri o, a troca de janel as habi l i tada. O val or padro desta propri edade
Fal se. Essa propri edade pode ser modi fi cada em tempo de execuo uti l i zando o
mtodo SetDisableTaskSwitching.
4.1.3.10 EnableCommError
Habi l i ta ou desabi l i ta a vi sual i zao dos erros de comuni cao. Por exempl o,
caso haja na Tel a um Setpoi nt associ ado a um Tag de Comuni cao, e a
comuni cao do E3 com este Tag fal he, ser mostrado no Setpoi nt o texto
confi gurado na propri edade CommErrorText, com a cor i nformada na propri edade
CommErrorTextColor e a cor de fundo do Setpoi nt defi ni da na propri edade
CommErrorBkColor. O val or padro desta propri edade True.
4.1.3.11 EnableHeartbeat
Habi l i ta ou desabi l i ta o envi o de heartbeat (mensagem envi ada em i nterval os
fi xos, que i ndi ca que o Servi dor est ati vo) entre o Vi ewer e o servi dor. Caso o
Vi ewer pare de receber as mensagens de heartbeat, si nal de que al gum probl ema
ocorreu, portanto a conexo deve ser abortada. O val or padro desta propri edade
Fal se.
4.1.3.12 EnableInactivity
Habi l i ta ou desabi l i ta a veri fi cao do perodo de i nati vi dade do usuri o. Para
mai ores i nformaes, veja o evento OnInactive, do objeto Vi ewer. O val or padro
desta propri edade Fal se.
4.1.3.13 EnableZoomMenu
Se esti ver confi gurada como True, habi l i ta a exi bi o do menu de confi gurao
do zoom da Tel a atravs do boto di rei to do mouse em tempo de execuo, exceto
quando al gum scri pt esti ver confi gurado com i nformao di vergente nos eventos
MouseDown ou MouseUp. Caso contrri o, o menu no ser mostrado. O val or
102 Visualizao
4.1.3.14 HeartbeatPeriodMs
Indi ca o i nterval o (em mi l i ssegundos) entre as mensagens de heartbeat envi adas
pel o Servi dor. A mensagem de heartbeat sempre envi ada quando o servi dor fi ca o
perodo i ndi cado por esta propri edade sem envi ar nenhuma mensagem para o
Vi ewer. O val or padro desta propri edade 2000 (doi s segundos).
4.1.3.15 HeartbeatTimeoutMs
Indi ca o tempo, em mi l i ssegundos, que o Vi ewer tol era sem receber nenhuma
mensagem do Servi dor. Se este tempo passar, e nenhuma mensagem for recebi da, o
Vi ewer assume que a conexo foi perdi da, e i ni ci a o processo de reconexo. Este
tempo deve ser mai or que o tempo determi nado na propri edade
HeartbeatPeriodMs, de prefernci a mai or que o dobro. O val or padro desta
propri edade 5000 (ci nco segundos).
4.1.3.16 InactivityTime
Defi ne o tempo mxi mo de espera por um evento de mouse ou de tecl ado antes do
perodo de i nati vi dade, em mi nutos. Para mai ores i nformaes, veja o evento
OnInactive do objeto Vi ewer. O val or padro desta propri edade 5 (ci nco) mi nutos.
Exempl o:
MsgBox "A aplicao ficar inativa em " & _
Application.InactivityTime & " minuto(s)."
End Sub
4.1.3.17 InitialScreen
Indi ca a Tel a ou Quadro i ni ci al que dever ser mostrado quando o Vi ewer
chamado. Atravs da propri edade WindowStyle, possvel determi nar se a janel a
dever i ni ci ar maxi mi zada, janel ada ou mi ni mi zada. O val or padro desta
propri edade "Tel aIni ci al ".
4.1.3.18 IsPlaybackMode
Se True, i ndi ca que o Vi ewer est rodando dentro de um E3Pl ayback, em modo
playback. Esta propri edade somente de l ei tura e s est di sponvel em tempo de
execuo.
4.1.3.19 IsReadOnly
Se ajustada para True, i ndi ca que o Vi ewer est no modo Somente Leitura
(acesso restri to).
Visualizao 103
4.1.3.20 LoginRetries
Especi fi ca o nmero de retentati vas de login do Vi ewer, i sto , quantas vezes a
cai xa de di l ogo de login ser exi bi da al m da pri mei ra vez. O val or padro desta
propri edade 2.
4.1.3.21 MaximizeButton
Se a opo esti ver habi l i tada (True), o boto Maximizar habi l i tado no Vi ewer, e
possvel uti l i zar esse boto. Caso contrri o, esse boto no aparece na janel a. O
val or padro desta propri edade True.
4.1.3.22 MinimizeButton
Se a opo esti ver habi l i tada (True), o boto Minimizar habi l i tado no Vi ewer, e
possvel uti l i zar esse boto. Caso contrri o, esse boto no aparece na janel a. O
4.1.3.23 Params
Esta propri edade um vetor de pares chave-val or, que retorna os parmetros
passados para o Vi ewer atravs da opo de l i nha de comando -params. Todos os
val ores so retornados como Strings. Por exempl o, se a l i nha de comando do
Vi ewer conti ver os segui ntes parmetros:
Viewer -params Idioma=PTB
Pode-se uti l i zar o segui nte cdi go para veri fi car qual o i di oma de i ni ci al i zao do
Vi ewer.
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 chave no faz di ferena entre mai scul as e mi nscul as (pode ser
tanto "i di oma" quanto "I di oma"), mas os val ores retornados, pri nci pal mente se
uti l i zados com um comado Select, fazem a di ferenci ao entre mai scul as e
mi nscul as.
4.1.3.24 ReconnectDialogDelaySec
Indi ca o nmero de segundos que o Vi ewer i r esperar durante uma possvel
reconexo ao servi dor antes de mostrar uma mensagem avi sando o usuri o desta
104 Visualizao
ao (esta propri edade no afeta a pri mei ra conexo). Se for i gual a 0, a mensagem
de reconexo sempre ser mostrada. Para evi tar que a mensagem seja mostrada,
recomendvel col ocar um nmero mui to grande (1 bi l ho, por exempl o).
NOTA: Quando a reconexo ocorre em si l nci o, todas as janel as do Vi ewer ati vo
fi cam desabi l i tadas e uma ampul heta mostrada, i ndi cando que o apl i cati vo est
i ndi sponvel . Durante o tempo da reconexo, no permi ti do ao usuri o cancel ar o
processo.
4.1.3.25 RenderQuality
Control a a qual i dade de desenho de todas as Tel as, somente se o val or da
propri edade RenderQuality das Tel as seja i gual a 0 - rqDefault. Os val ores
possvei s para esta propri edade so os segui ntes:
0 - rqDefault: Uti l i za o modo de qual i dade normal , GDI (Graphics Device Interface).
Corresponde ao i tem Utilizar Padro do menu contextual Qualidade (todas as
telas) do Vi ewer, em tempo de execuo. Este o val or padro para apl i caes
cri adas em verses anteri ores 4.0
1 - rqNormal: Fora o modo de qual i dade normal (GDI) para o desenho de todas
as Tel as. Corresponde ao i tem Forar Qualidade Normal do menu contextual
Qualidade (todas as telas) do Vi ewer, em tempo de execuo
2 - rqHighQuality: Fora o modo de al ta qual i dade (GDI+) para o desenho de
todas as Tel as. Corresponde ao i tem Forar Alta Qualidade do menu contextual
Qualidade (todas as telas) do Vi ewer, em tempo de execuo. Este o val or padro
para apl i caes cri adas a parti r da verso 4.0
A fi gura a segui r mostra o menu contextual do Vi ewer em tempo de execuo, com
as respecti vas opes de confi gurao desta propri edade:
Visualizao 105
Menu contextual do Viewer em tempo de execuo
4.1.3.26 ShowKeyPadOnEdit
Esta propri edade automati camente habi l i ta a exi bi o do El i pse KeyPad, sempre
que um objeto de Tel a que permi ta edi o receba o foco.
4.1.3.27 TargetDPIX
Defi ne o val or de pontos por pol egada, na hori zontal , do moni tor do computador
de desti no. O val or padro desta propri edade -1, que faz com que seja assumi do
o val or do computador atual .
106 Visualizao
4.1.3.28 TargetDPIY
Defi ne o val or de pontos por pol egada, na verti cal , do moni tor do computador de
desti no. O val or padro desta propri edade -1, que faz com que seja assumi do o
val or do computador atual .
4.1.3.29 TargetMarginX
Defi ne o nmero de pi xel s que devem ser descontados da resol uo hori zontal da
Tel a (a rea ti l do Vi ewer). O val or padro da propri edade -1, que faz com que
seja assumi da a confi gurao da janel a do Vi ewer (com ou sem a barra de ttul o,
com ou sem borda) em conjunto com a confi gurao do computador atual (l argura
de borda e barra de ttul o defi ni das pel o Wi ndows).
4.1.3.30 TargetMarginY
Defi ne o nmero de pi xel s que devem ser descontados da resol uo verti cal da
Tel a (a rea ti l do Vi ewer). O val or padro da propri edade -1, que faz com que
seja assumi da a confi gurao da janel a do Vi ewer (com ou sem a barra de ttul o,
com ou sem borda) em conjunto com a confi gurao do computador atual (l argura
de borda e barra de ttul o defi ni das pel o Wi ndows).
4.1.3.31 TargetResolutionX
Defi ne a resol uo hori zontal da Tel a para a qual esta apl i cao est desti nada
(em pi xel s). O val or padro da propri edade -1, que faz com que seja assumi da a
resol uo do computador atual .
4.1.3.32 TargetResolutionY
Defi ne a resol uo verti cal da Tel a para a qual esta apl i cao est desti nada (em
pi xel s). O val or padro da propri edade -1, que faz com que seja assumi da a
resol uo do computador atual .
4.1.3.33 TitleBar
Se a opo esti ver habi l i tada (True), a barra de ttul o do Vi ewer mostrada,
conforme as especi fi caes da propri edade Caption. Do contrri o, el a escondi da.
O val or padro desta propri edade True.
4.1.3.34 User
Contm o nome do usuri o que est uti l i zando o Vi ewer. Esta propri edade
somente para l ei tura.
Visualizao 107
4.1.3.35 ViewerLanguageId
Retorna o cdi go do i di oma do Vi ewer em execuo. Os val ores possvei s para
esta propri edade esto descri tos na tabel a a segui r. Esta propri edade somente de
l ei tura e s est di sponvel em tempo de execuo.
Valores disponveis para ViewerLanguageId
DECIMAL HEXADECIMAL IDIOMA
4 0x0004 Chi ns Si mpl i fi cado
1031 0x0407 Al emo
1033 0x0409 I ngl s Ameri cano
1034 0x040A Espanhol
1046 0x0416 Portugus do Brasi l
NOTA: Esta propri edade NO corresponde ao i di oma de i nstal ao do Wi ndows e
nem ao i di oma confi gurado no pai 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
Habi l i ta ou desabi l i ta uma borda na janel a do Vi ewer. O val or padro dessa
propri edade verdadei ro. Essa propri edade de l ei tura e escri ta, mas al terar seu
val or em tempo de execuo no al tera a confi gurao do Vi ewer j aberto, apenas
das janel as que forem abertas uti l i zando a confi gurao do Vi ewer.
4.1.3.37 WindowHeight
Determi na a al tura da janel a do Vi ewer, em pi xel s. O val or padro dessa
propri edade 300.
4.1.3.38 WindowMovable
Indi ca se a janel a pode ser movi da. O val or padro dessa propri edade
verdadei ro. Essa propri edade de l ei tura e escri ta, mas al terar seu val or em tempo
de execuo no al tera a confi gurao do Vi ewer j aberto, apenas das janel as que
forem abertas uti l i zando a confi gurao do Vi ewer.
4.1.3.39 WindowResizable
Indi ca se a janel a pode ser redi mensi onada. Esta propri edade s tem efei to se a
propri edade WindowBorder for verdadei ra. O val or padro dessa propri edade
verdadei ro. Essa propri edade de l ei tura e escri ta, mas al terar seu val or em tempo
de execuo no al tera a confi gurao do Vi ewer j aberto, apenas das janel as que
forem abertas uti l i zando a confi gurao do Vi ewer.
108 Visualizao
4.1.3.40 WindowSmallTitle
Indi ca se a janel a do Vi ewer deve ter a barra de ttul o pequena. Esta propri edade
s tem efei to se a propri edade TitleBar for verdadei ra. O val or padro dessa
propri edade Fal so. Essa propri edade de l ei tura e escri ta, mas al terar seu val or
em tempo de execuo no al tera a confi gurao do Vi ewer j aberto, apenas das
janel as que forem abertas uti l i zando a confi gurao do Vi ewer.
4.1.3.41 WindowStayOnTop
Indi ca se a janel a do Vi ewer deve sempre se sobrepor s outras janel as. O val or
padro dessa propri edade Fal so. Essa propri edade de l ei tura e escri ta, mas
al terar seu val or em tempo de execuo no al tera a confi gurao do Vi ewer j
aberto, apenas das janel as que forem abertas uti l i zando a confi gurao do Vi ewer.
4.1.3.42 WindowStyle
Defi ne o esti l o i ni ci al de janel a do Vi ewer. As opes di sponvei s so:
0 - Maximized: i ni ci a o Vi ewer maxi mi zado
1 - Windowed: i ni ci a o Vi ewer janel ado
2 - Minimized: i ni ci a o Vi ewer mi ni mi zado
4.1.3.43 WindowWidth
Determi na a l argura da janel a do Vi ewer, em pi xel s. O val or padro dessa
propri edade 400.
4.2 Quadros e Divisores
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Di vi sor e
sobre as propriedades do objeto Quadro. O objeto Di vi sor no possui eventos
associ ados e o objeto Quadro no possui eventos nem mtodos associ ados.
4.2.1 Mtodos do Divisor
Esta seo contm i nformaes sobre os mtodos do objeto Di vi sor.
4.2.1.1 BringToFront
BringToFront()
Traz para a frente um Di vi sor que esteja escondi do ou abai xo de outro.
Visualizao 109
4.2.1.2 CaptureScreen
CaptureScreen(Filename)
Captura o contedo de um Di vi sor, gravando-o no arqui vo de nome e cami nho
Filename, no formato BMP. Exempl o:
' 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)
Uti l i ze o mtodo Close para fechar a janel a do Quadro. O parmetro Code ter o
val or de retorno para o mtodo DoModal, se a janel a em questo ti ver si do
chamada por este mtodo. Exempl o:
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 Vi ewer comece a pi scar na barra de tarefas do
Wi ndows. O parmetro Number determi na o nmero de vezes que a Barra de
Tarefas deve pi scar e Time determi na o tempo (em mi l i ssegundos) entre um pi scar e
outro. Exempl o:
Sub Texto1_Click()
Set quadro = Application.GetFrame("_top")
quadro.FlashWindow 50, 500
End Sub
4.2.1.5 MaximizeFrame
MaximizeFrame()
Maxi mi za um Quadro ou Tel a modal .
4.2.1.6 MinimizeFrame
MinimizeFrame()
Mi ni mi za um Quadro ou Tel a modal .
110 Visualizao
4.2.1.7 MoveFrame
MoveFrame([PosX, ][PosY, ][SizeX, ][SizeY])
Move e redi mensi ona um Di vi sor (Frame) para uma coordenada e um tamanho
especfi cos. Os parmetros PosX e PosY i nformam a nova posi o, em pi xel s, com
rel ao esquerda e ao topo, respecti vamente. Os parmetros SizeX e SizeY
i nformam o novo compri mento e a nova al tura, respecti vamente, em pi xel s ou em
Hi metri c. Todos os parmetros so opci onai s. Exempl o:
' 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 val ores de tamanho neste mtodo podem ser i nformados como nmeros
ou Strings. No caso de nmeros, so consi derados em pi xel s. No caso de Strings, se
vi erem acompanhados da uni dade "hm", sero i nterpretados como Hi metri c.
Qual quer outro caso consi derado em pi xel s.
4.2.1.8 OpenScreen
OpenScreen(ScreenName, Arg)
O mtodo OpenScreen abre uma Tel a dentro de um Di vi sor. O parmetro
ScreenName determi na o nome da Tel a a ser aberta. possvel tambm especi fi car o
percentual de zoom da Tel a e a habi l i tar a barra de rol agem atravs da chave "?"
como no model o a segui r.
<nome-da-tela>?<zoom>?<habilitar-rolagem>
Onde nome-da-tela o nome da Tel a a ser aberta, zoom o percentual de zoom e
habilitar-rolagem habi l i ta ou desabi l i ta a rol agem de Tel a. O percentual de zoom da
Tel a pode assumi r os segui ntes val ores:
1: toda a pgi na
2: a l argura da Tel a ocupa 100% da l argura do Di vi sor, com al tura proporci onal
3: a al tura da Tel a ocupa 100% da al tura do Di vi sor, com l argura proporci onal
4: a Tel a preenche total mente o Di vi sor
5 a 100: equi val e ao percentual de zoom da Tel a propri amente di to
A habi l i tao de rol agem pode assumi r os segui ntes val ores:
0: desabi l i ta a rol agem
1: habi l i ta a rol agem
Visualizao 111
O parmetro Arg permi te repassar o val or especi fi cado Tel a atravs do evento
OnPreShow. Exempl o:
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
' 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 permi te forar o redesenho do contedo de uma Tel a ou Di vi sor.
El e deve ser usado em scri pts de Vi ewer com processamento massi vo (por exempl o,
l aos), ou em chamadas de mtodos que demandem mui to tempo e exi jam
i ndi caes vi suai s ao usuri o do progresso do processo.
Devi do ao redesenho em geral ser uma operao pesada, a verso padro do
mtodo Refresh (sem parmetros) oti mi zada de forma a i gnorar pedi dos de
redesenho mui to prxi mos, i ncl ui ndo redesenho do prpri o E3. Este
comportamento padro i deal para i ndi caes de progresso em l aos, onde
mui tos redesenhos so fei tos em sequnci a. O parmetro Force desabi l i ta esta
oti mi zao, garanti ndo que para cada chamada do mtodo Refresh seja fei to um
redesenho. Porm, ao uti l i zar-se esta opo, o mtodo Refresh no pode ser
chamado repeti damente, como dentro de um l ao. Exempl o:
' 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()
Permi te restaurar a janel a do Quadro para o seu tamanho ori gi nal .
112 Visualizao
4.2.1.11 SetDisableTaskSwitching
SetDisableTaskSwitching(Disable)
Habi l i ta ou desabi l i ta a troca de janel as. O parmetro Disable um val or Bool eano
que i ndi ca se a troca de janel as ser habi l i tada ou no. Este mtodo atual i za a
propri edade DisableTaskSwitching do objeto Vi ewer.
NOTAS:
Se mai s de uma i nstnci a do Vi ewer esti ver rodando em uma mesma mqui na, e
pel o menos uma destas i nstnci as uti l i zar o mtodo SetDisableTaskSwitching, a
al terao afetar todos os Vi ewers desta mqui na
Caso seja necessri o modi fi car o ttul o ou o esti l o da janel a, o mtodo
SetFrameOptions deve ser uti l i zado aps a chamada ao mtodo
SetDisableTaskSwitching
4.2.1.12 SetForegroundWnd
SetForegroundWnd()
O mtodo SetForegroundWnd ati va e move o foco para a janel a do Vi ewer. Este
mtodo ti l quando se deseja chamar a ateno do operador para al gum evento
ocorri do, quando a janel a do Vi ewer encontra-se escondi da ou mi ni mi zada.
4.2.1.13 SetFrameOptions
SetFrameOptions(Title, Flags)
Uti l i zado para confi gurar o ttul o do Frame na janel a e o esti l o da janel a. O
parmetro Title uma String que contm o ttul o da janel a. Este texto ser mostrado
se a propri edade Caption da Tel a esti ver vazi a.
O parmetro Flags especi fi ca o esti l o da janel a. Se este parmetro for omi ti do, o
val or padro ser -1. Este val or usado para manter a confi gurao anteri or da
janel a. Quando o val or especi fi cado no for -1, pode-se modi fi car o esti l o da
janel a especi fi cando a soma dos val ores das combi naes descri tas na tabel a a
segui r.
VALOR DESCRIO
1
Habi l i ta a barra de ttul o na janel a.
2
Habi l i ta o boto Fechar na janel a.
4
Habi l i ta o boto Minimizar na janel a.
8
Habi l i ta o boto Maximizar na janel a.
16
Habi l i ta a borda na janel a.
32
Especi fi ca que a janel a pode ser
di mensi onada. Para i sso, necessri o
que a janel a tenha uma borda.
Visualizao 113
VALOR DESCRIO
64
Especi fi ca que a janel a pode ser movi da.
256
Especi fi ca que a janel a fi car no topo da
Tel a.
512
Especi fi ca que a janel a ser confi gurada
no esti l o Barra de Ferramentas.
1024
Desabi l i ta os botes de objeto.
2048
Central i za a janel a.
Exempl o:
Sub Tela_OnPreShow()
Frame.SetFrameOptions("Tela de Alarmes", 114)
End Sub
No exempl o anteri or, o val or 114 (2 + 16 + 32 + 64) i ndi ca que a janel a ter o boto
Fechar habi l i tado (2), ter uma borda (16), poder ser di mensi onada (32) e poder
ser movi da (64). O ttul o da janel a ser "Tel a de Al armes".
Nos Pi cks Abrir Tela e Abrir Tela Modal tambm possvel confi gurar o esti l o da
janel a durante a edi o, atravs da cai xa de di l ogo Esti l o da Janel a. Para mai s
i nformaes veja o tpi co Picks.
NOTA: o mtodo SetFrameOptions deve ser usado aps a chamada ao mtodo
SetDisableTaskSwitching, caso seja necessri o modi fi car o ttul o ou o esti l o da
janel a.
4.2.2 Propriedades do Divisor
Esta seo contm i nformaes sobre as propri edades do objeto Di vi sor.
4.2.2.1 IsHTML
A propri edade IsHTML retorna True se o di vi sor contm cdi gos HTML i nseri dos
no Quadro. Caso contrri o, retorna Fal se.
4.2.2.2 SplitBorder
Habi l i ta ou desabi l i ta a borda do Di vi sor, e determi na se a borda entre o Di vi sor
mandante e o Di vi sor restante deve ser exi bi da em tempo de execuo. Esta
propri edade no tem efei to no Di vi sor restante. O val or padro desta propri edade
True.
114 Visualizao
4.2.2.3 SplitDockPosition
Indi ca a posi o do Di vi sor desejado na Tel a. As opes di sponvei s so:
Opes disponveis para SplitDockPosition
OPO DESCRIO
0 - dockRemaining
Posi ci ona o Di vi sor como restante, ou
seja, el e ocupar o espao que sobra na
di vi so hori zontal ou verti cal .
1 - dockTop
Posi ci ona o Di vi sor como mandante,
aci ma do restante.
2 - dockBottom
abai xo do restante.
3 - dockLeft
esquerda do restante.
4 - dockRight
di rei ta do restante.
4.2.2.4 SplitLink
A propri edade SplitLink contm um link que deve ser mostrado no Di vi sor.
possvel especi fi car uma Tel a do projeto, um executvel ou um link na Internet. No
caso de Tel as, possvel especi fi car um percentual de zoom e a habi l i tao das
barras de rol agem usando a chave "?", como no model o <nome-da-tela>?
<zoom>?<barra-de-rolagem>, onde nome-da-tela o nome da Tel a a ser aberta;
zoom o percentual de zoom e barra-de-rolagem 1 para habi l i tar ou 0 para
desabi l i tar. Os parmetros zoom e barra-de-rolagem so vl i dos apenas se o link
i ndi cado se tratar de uma Tel a. Caso contrri o, sero i gnorados. Se o parmetro
zoom no for i nformado, assumi do 100%. Se o parmetro barra-de-rolagem no
for i nformado, assumi do 1, ou seja, habi l i tado. Exempl o:
Application.GetFrame("Divisor1").SplitLink = "Tela1?10?1"
End Sub
4.2.2.5 SplitResizable
Determi na se o Di vi sor mandante pode ser redi mensi onado em tempo de
execuo. Esta propri edade no tem efei to no Di vi sor restante. O val or padro
desta propri edade True.
4.2.2.6 SplitValue
A propri edade SplitValue determi na o val or que ser atri budo ao Di vi sor do
Quadro, que tanto pode ser % (percentagem), hm (HIMETRIC) ou px (pi xel s). Se a
uni dade for omi ti da, o val or ser consi derado em Hi metri c.
Visualizao 115
4.2.3 Propriedades do Quadro
Esta seo contm i nformaes sobre as propri edades do objeto Quadro.
4.2.3.1 Caption
A propri edade Caption defi ne o ttul o da Quadro a ser mostrado na barra de
ttul o no Vi ewer.
4.3 Telas e Objetos de Tela
Esta seo contm i nformaes sobre eventos, mtodos e propri edades de Tel as e
Objetos de Tel a.
4.3.1 Tela
Tel a.
4.3.1.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Tel a.
4.3.1.1.1 Click
Click()
Ocorre quando o boto esquerdo do mouse pressi onado sobre a Tel a. Este evento
no ocorrer se a Tel a no esti ver vi svel ou sua propri edade Enabled esti ver
confi gurada para Fal se. A vi si bi l i dade da Tel a depende de trs fatores:
propri edade Visible i gual a True; objeto pai vi svel ; e propri edade Layer do objeto
presente na camada da Tel a.
4.3.1.1.2 DbClick
DbClick()
Ocorre quando h um dupl o-cl i que, ou seja, o boto esquerdo do mouse
pressi onado rapi damente duas vezes sobre a Tel a. Este evento no ocorrer se o
objeto no esti ver vi svel ou sua propri edade Enabled esti ver confi gurada para
Fal se. A vi si bi l i dade do objeto depende de trs fatores: propri edade Visible i gual a
True; objeto pai vi svel ; e propri edade Layer do objeto presente na camada da Tel a.
116 Visualizao
4.3.1.1.3 KeyDown
KeyDown(KeyCode, Shift)
Ocorre no momento em que uma tecl a pressi onada, i ndependentemente do foco
na Tel a.
Variveis do evento KeyDown
NOME DESCRIO
KeyCode
Nmero i ntei ro que i denti fi ca o caractere
ASCI I da tecl a que foi pressi onada.
Shift
Mostra a tecl a pressi onada juntamente
com o mouse:
4: Tecl a SHI FT
8: Tecl a CTRL
12: Tecl as CTRL + SHI FT
Exempl o:
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 tecl a sol ta, i ndependentemente do foco na Tel a.
Variveis do evento KeyUp
NOME DESCRIO
KeyCode
Shift
com o mouse:
4: Tecl a SHI FT
8: Tecl a CTRL
Exempl o:
Sub Tela1_KeyUp(KeyCode, Shift)
' Mostra uma caixa de mensagem quando o usurio
' soltar uma tecla
MsgBox "Cdigo da tecla: " & KeyCode
End Sub
Visualizao 117
4.3.1.1.5 MouseDown
MouseDown(Button, ShiftState, MouseX, MouseY)
Ocorre quando se pressi ona qual quer boto do mouse sobre a Tel a. Uti l i ze o
evento MouseDown para determi nar aes especfi cas quando a Tel a for cl i cada
pel o usuri o.
Variveis do evento MouseDown
NOME DESCRIO
Button
Mostra o boto do mouse pressi onado:
1: O boto do mouse pressi onado o
esquerdo
di rei to
ShiftState
com o mouse:
4: Tecl a SHI FT
8: Tecl a CTRL
MouseX
Mostra a coordenada X onde o mouse foi
cl i cado na Tel a.
MouseY
Mostra a coordenada Y onde o mouse foi
cl i cado na Tel a.
Exempl o:
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 sol ta qual quer boto do mouse previ amente cl i cado. Uti l i ze o
evento MouseUp para especi fi car aes que sero di sparadas somente quando o
boto do mouse for sol to.
118 Visualizao
Variveis do evento MouseUp
NOME DESCRIO
Button
esquerdo
di rei to
ShiftState
com o mouse:
4: Tecl a SHI FT
8: Tecl a CTRL
MouseX
cl i cado na Tel a.
MouseY
cl i cado na Tel a.
Exempl o:
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 Tel a est prestes a ser fechada. Uti l i ze o evento OnHide
quando for necessri o efetuar al guma operao antes do objeto Tel a ser fechado.
Este evento pode ocorrer de di versas manei ras:
Quando a Tel a for substi tuda por outra atravs do mtodo OpenScreen
Quando o usuri o fechar a janel a onde est a Tel a
Quando for chamado o mtodo Close do objeto Tel a
Quando o Vi ewer for fechado ou encerrado
4.3.1.1.8 OnPreShow
OnPreShow(Arg)
Ocorre antes da Tel a ser mostrada. A vari vel de evento Arg recebe o contedo do
parmetro Arg do mtodo OpenScreen, que gera esse evento. Logo aps, gerado o
evento OnShow. Exempl o:
Sub Screen1_OnPreShow(Arg)
' O ttulo da Tela Screen1 a ser mostrada
Visualizao 119
' foi passado como parmetro na chamada do mtodo
' OpenScreen que gerou o evento.
Caption = Arg
End Sub
4.3.1.1.9 OnShow
OnShow()
Ocorre no momento exato que uma Tel a mostrada. Uti l i ze o evento OnPreShow
para efetuar al guma operao antes que a Tel a seja exi bi da. Exempl o:
Sub TelaPrincipal_OnShow()
MsgBox "Seja bem-vindo ao sistema!"
End Sub
4.3.1.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Tel a.
4.3.1.2.1 Close
Close(Code)
Uti l i ze o mtodo Close para fechar a Tel a. Este mtodo gera o evento OnHide antes
de ser efeti vamente executado. O parmetro Code ter o val or de retorno para o
mtodo DoModal, se a Tel a em questo ti ver si do chamada por este mtodo.
Exempl o:
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 Tel a, i ndi cada pel o parmetro XPixel, de pi xel s para
Hi metri c. Este mtodo compl ementar ao mtodo ToPixelX.
4.3.1.2.3 FromPixelY
FromPixelY(YPixel)
Converte a coordenada Y da Tel a, i ndi cada pel o parmetro YPixel, de pi xel s para
Hi metri c. Este mtodo compl ementar ao mtodo ToPixelY.
120 Visualizao
4.3.1.2.4 ToPixelX
ToPixelX(XHimetric)
Converte a coordenada X da Tel a, i ndi cada pel o parmetro XHimetric, de Hi metri c
para pi xel s. Este mtodo compl ementar ao mtodo FromPixelX.
4.3.1.2.5 ToPixelY
ToPixelY(YHimetric)
Converte a coordenada Y da Tel a, i ndi cada pel o parmetro YHimetric, de Hi metri c
para pi xel s. Este mtodo compl ementar ao mtodo FromPixelY.
4.3.1.3 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Tel a.
seja, cada 1000 uni dades equi val em a 1 centmetro. Assi m, este o padro adotado
na descri o das propri edades do E3, quando apl i cvel .
4.3.1.3.1 BackgroundColor
Especi fi ca a cor de preenchi mento do fundo da Tel a. Nos scri pts, uti l i ze a funo
do VBScri pt RGB para montar a cor a ser associ ada a esta propri edade. O val or
padro desta propri edade ci nza (RGB(192, 192, 192)).
4.3.1.3.2 Caption
A propri edade Caption defi ne o ttul o da Tel a a ser mostrado na barra de ttul o no
Vi ewer.
4.3.1.3.3 FillStyle
Esta propri edade especi fi ca o esti l o do preenchi mento da Tel a e dos objetos de
Tel a. A tabel a a segui r contm os val ores vl i dos para a propri edade FillStyle.
Opes disponveis para a propriedade FillStyle
OPO DESCRIO
0 - Solid
O preenchi mento ser sl i do (padro).
1 - Hollow
No h preenchi mento. Este val or no
est di sponvel para o objeto Tel a.
2 - Horizontal
O preenchi mento ser com l i stras
hori zontai s.
Visualizao 121
OPO DESCRIO
3 - Vertical
verti cai s.
4 - Downward
descendo da esquerda para a di rei ta em
ngul o de 45 graus.
5 - Upward
subi ndo da esquerda para a di rei ta em
ngul o de 45 graus.
6 - Cross
hori zontai s e verti cai s.
7 - DiagonalCross
descendo e subi ndo da esquerda para a
di rei ta em ngul o de 45 graus.
8 - Gradient
O preenchi mento ser em degrad
uti l i zando tanto ForegroundColor quanto
BackgroundColor. O efei to ser defi ni do
pel a propri edade GradientStyle.
9 - SemiTransparent
Dei xa o objeto transl ci do. Este val or
no est di sponvel para o objeto Tel a.
10 - MouseArea
O preenchi mento ser vazi o, mas o
objeto conti nua sensvel aos eventos
(padro). Este val or no est di sponvel
para o objeto Tel a.
11 - Background
Preenche o objeto com a cor de fundo.
12 - Picture
Preenche o objeto com a fi gura
sel eci onada na propri edade PictureFile.
Este val or s est di sponvel para o
objeto Tel a.
NOTA: A propri edade FillStyle no est di sponvel para o objeto Figura.
4.3.1.3.4 ForegroundColor
Especi fi ca a cor do preenchi mento da frente da Tel a. Nos scri pts, uti l i ze a funo
RGB do VBScri pt para montar a cor a ser associ ada a esta propri edade. O val or
padro para esta propri edade preto (RGB(0, 0, 0)). Apl i caes anteri ores
i ntroduo desta propri edade tero ambas as propri edades ForegroundColor e
BackgroundColor confi guradas com a cor antes armazenada na propri edade
BackgroundColor, e o esti l o de preenchi mento confi gurado como 11 - Background,
que pi nta toda a Tel a com a cor de fundo (comportamento anti go, anteri or
cri ao dos esti l os). Exempl o:
Sub Tela1_Click()
' Troca a cor de fundo da Tela para azul
ForegroundColor = RGB(0, 0, 255)
End Sub
122 Visualizao
4.3.1.3.5 GradientStyle
Esta propri edade especi fi ca o esti l o de preenchi mento degrad da Tel a. Esta
propri edade s ser uti l i zada quando o val or da propri edade FillStyle esti ver
confi gurada para 8 (Gradient). Os degrads consi deram a mudana da cor parti ndo
de ForegroundColor e i ndo para BackgroundColor.
Opes disponveis para GradientStyle
OPO DESCRIO
0 - LeftToRight
Degrad verti cal da esquerda para a
di rei ta.
1 - RightToLeft
Degrad verti cal da di rei ta para a
esquerda.
2 - VerFromCenter
Degrad verti cal do centro para as
bordas.
3 - VerToCenter
Degrad verti cal das bordas para o
centro.
4 - BottonUp
Degrad hori zontal de bai xo para ci ma.
5 - TopDown
Degrad hori zontal de ci ma para bai xo.
6 - HorzFromCenter
Degrad do centro para as bordas.
7 - HorzToCenter
Degrad das bordas para o centro.
8 - DiagUpRight
Degrad di agonal para ci ma com a cor de
frente na di rei ta (padro).
9 - DiagUpLeft
frente na esquerda.
10 - DiagUpFromCenter
Degrad di agonal para ci ma do centro
para as bordas.
11 - DiagUpToCenter
Degrad di agonal para ci ma das bordas
para o centro.
12 - DiagDownLeft
Degrad di agonal para bai xo com cor de
frente na esquerda.
13 - DiagDownRight
frente na di rei ta.
14 - DiagDownFromCenter
Degrad di agonal para bai xo do centro
para as bordas.
15 - DiagDownToCenter
Degrad di agonal para bai xo das bordas
para o centro.
16 - SpotSouthEast
Degrad com cor de frente parti ndo do
canto i nferi or di rei to.
17 - SpotSouthWest
canto i nferi or esquerdo.
18 - SpotNorthWest
canto superi or esquerdo.
19 - SpotNorthEast
canto superi or di rei to.
20 - SpotFromCenter
Degrad com cor de fundo do centro para
as bordas.
Visualizao 123
OPO DESCRIO
21 - SpotToCenter
Degrad com cor de fundo das bordas
para o centro.
4.3.1.3.6 Layer
Esta propri edade defi ne em quai s camadas o objeto deve aparecer. O val or
representa uma mscara de 32 bi ts, um bi t para cada camada. Portanto, podem ser
defi ni das at 32 camadas i ndi vi duai s. Assi m, objetos podem ser agrupados
l ogi camente e mostrados ou escondi dos apenas com a modi fi cao da mscara da
propri edade Layer.
Opes disponveis na Lista de Propriedades
NOTA: A vi si bi l i dade do objeto depende de trs fatores: a propri edade Visible tem
que estar confi gurada para True; o objeto que pai deste objeto tem que estar
vi svel ; a propri edade Layer deste objeto tem que estar habi l i tada para a Tel a.
4.3.1.3.7 PictureFile
Contm o nome do arqui vo da fi gura que ser uti l i zada como fundo na Tel a.
Pode ser qual quer formato j suportado no E3 pel o objeto DrawPi cture (*.bmp,
*.gi f, *.jpg, *.cur, *.i co, *.emf, *.wmf). O val or padro desta propri edade uma
String em branco. Esta propri edade s ser vl i da se a propri edade FillStyle esti ver
sel eci onada como 12 - Picture.
124 Visualizao
4.3.1.3.8 PicturePosition
Indi ca a posi o da fi gura sel eci onada na propri edade PictureFile na Tel a. Esta
propri edade s ser vl i da se a propri edade FillStyle esti ver sel eci onada como 12 -
Picture. As opes vl i das so:
Opes disponveis para PicturePosition
OPO DESCRIO
0 - Center
Fi gura no tamanho ori gi nal , central i zada
na Tel a.
1 - Tile
Fi gura no tamanho ori gi nal , repeti da
tantas vezes quantas forem necessri as
para preencher a Tel a.
2 - Stretch
Fi gura redi mensi onada para preencher a
Tel a.
3 - TopLeft
Fi gura no tamanho ori gi nal , no canto
esquerdo superi or da Tel a.
4 - BottomLeft
esquerdo i nferi or da Tel a.
5 - BottomRight
di rei to i nferi or da Tel a.
6 - TopRight
di rei to superi or da Tel a.
4.3.1.3.9 RenderQuality
Control a a qual i dade de desenho de uma Tel a. Os val ores possvei s para esta
propri edade so os segui ntes:
0 - rqDefault: A qual i dade de desenho da Tel a uti l i za o val or defi ni do na
propri edade RenderQuality do Vi ewer. Este o val or padro desta propri edade,
mesmo em apl i caes cri adas em verses anteri ores 4.0
1 - rqNormal: Fora o modo de qual i dade normal (GDI) para o desenho da Tel a
2 - rqHighQuality: Fora o modo de al ta qual i dade (GDI+) para o desenho da Tel a
A fi gura a segui r mostra o menu contextual de uma Tel a em tempo de execuo, com
as respecti vas opes de confi gurao desta propri edade:
Visualizao 125
Menu contextual da Tela em tempo de execuo
4.3.2 Objetos de Tela
Esta seo contm i nformaes sobre eventos, mtodos e propri edades dos Objetos
de Tel a.
4.3.2.1 Eventos Comuns
Esta seo contm i nformaes sobre os eventos comuns a todos os Objetos de
Tel a.
126 Visualizao
4.3.2.1.1 Click
Click()
Ocorre quando o boto esquerdo do mouse pressi onado sobre o objeto. Este
evento no ocorrer se o objeto no esti ver vi svel ou se sua propri edade Enabled
esti ver confi gurada para Fal se. A vi si bi l i dade do objeto depende de trs fatores:
propri edade Visible i gual a True; objeto pai vi svel ; e propri edade Layer do objeto
presente na camada da Tel a.
4.3.2.1.2 DbClick
DbClick()
Ocorre quando h um dupl o-cl i que, ou seja, o boto esquerdo do mouse
pressi onado rapi damente duas vezes sobre o objeto. Este evento no ocorrer se o
objeto no esti ver vi svel ou se sua propri edade Enabled esti ver confi gurada para
Fal se. A vi si bi l i dade do objeto depende de trs fatores: propri edade Visible i gual a
True; objeto pai vi svel ; e propri edade Layer do objeto presente na camada da Tel a.
4.3.2.1.3 KeyDown
KeyDown(KeyCode, Shift)
Ocorre no momento em que uma tecl a pressi onada e o objeto est com o foco do
tecl ado. Note que este evento no ser gerado se o objeto no esti ver habi l i tado
(propri edade Enabled i gual a Fal se) ou este objeto no possui r o foco do tecl ado.
Variveis do evento KeyDown
NOME DESCRIO
KeyCode
Shift
com o mouse:
4: Tecl a SHI FT
8: Tecl a CTRL
4.3.2.1.4 KeyUp
KeyUp(KeyCode, Shift)
Ocorre no momento em que uma tecl a sol ta e o objeto est com o foco do tecl ado.
Note que este evento no ser gerado se o objeto no esti ver habi l i tado
(propri edade Enabled i gual a Fal se) ou este objeto no possui r o foco do tecl ado.
Visualizao 127
Variveis do evento KeyUp
NOME DESCRIO
KeyCode
Shift
com o mouse:
4: Tecl a SHI FT
8: Tecl a CTRL
4.3.2.1.5 MouseDown
MouseDown(Button, ShiftState, MouseX, MouseY)
Ocorre quando se pressi ona qual quer boto do mouse sobre o objeto.
Variveis de evento MouseDown
NOME DESCRIO
Button
esquerdo
di rei to
ShiftState
com o mouse:
4: Tecl a SHI FT
8: Tecl a CTRL
MouseX
cl i cado na Tel a.
MouseY
cl i cado na Tel a.
4.3.2.1.6 MouseUp
MouseUp(Button, ShiftState, MouseX, MouseY)
Ocorre quando se sol ta qual quer boto do mouse previ amente cl i cado sobre o
objeto. Uti l i ze o evento MouseUp para especi fi car aes que sero di sparadas
somente quando o boto do mouse for sol to.
128 Visualizao
Variveis do evento MouseUp
NOME DESCRIO
Button
esquerdo
di rei to
ShiftState
com o mouse:
4: Tecl a SHI FT
8: Tecl a CTRL
MouseX
cl i cado na Tel a.
MouseY
cl i cado na Tel a.
Esta seo contm i nformaes sobre os mtodos comuns a todos os Objetos de
Tel a.
4.3.2.2.1 BringToFront
BringToFront()
Faz com que o objeto se posi ci one frente de todos os outros objetos da Tel a.
4.3.2.2.2 SendToBack
SendToBack()
Faz com que o objeto se posi ci one atrs de todos os outros objetos da Tel a.
4.3.2.2.3 SetFocus
SetFocus()
Uti l i ze o mtodo SetFocus para mover o foco do mouse ou do tecl ado para um
objeto determi nado.
Neste tpi cos so l i stadas as propri edades comuns a todos os objetos de Tel a. As
propri edades expl i cadas a segui r no se apl i cam nos segui ntes objetos: MSForms,
E3Chart, E3Browser e E3Alarm. Estes so ci tados posteri ormente, em captul os
especfi cos para estes objetos.
Visualizao 129
NOTA 1: O E3 uti l i za para defi ni o de coordenadas e espessura o si stema Hi metri c.
NOTA 2: As propri edades l i stadas a segui r so comuns a todos os objetos ci tados
aci ma, i ncl usi ve o Grupo de objetos e movi mentos de Rotao e Transl ao.
4.3.2.3.1 Angle
A propri edade Angle defi ne o ngul o de rotao em graus, no senti do anti -
horri o, que o objeto deve ser rotaci onado. Isto tambm se apl i ca aos fi l hos que
este objeto ti ver, respei tando as l i mi taes de rotao de cada objeto fi l ho. O
objeto rotaci onar de acordo com o seu centro, que pode ser edi tado durante a
operao de rotao. O val or padro desta propri edade 0 (sem rotao).
4.3.2.3.2 BackgroundColor
Esta propri edade especi fi ca a cor de preenchi mento do fundo do objeto. Esta cor
uti l i zada quando a propri edade BackgroundStyle est confi gurada para 1 (opaco)
e umas das propri edades VerticalPercentFill ou HorizontalPercentFill est com
val ores di ferentes de 100. Outro uso desta cor quando a propri edade FillStyle est
confi gurada entre os val ores 2 e 8. Isto faz com que a rea restante uti l i ze a cor de
fundo para preenchi mento. Nos scri pts, uti l i ze a funo RGB do VBScri pt para
montar a cor a ser associ ada a esta propri edade. O val or padro desta
propri edade ci nza (RGB(192, 192, 192)).
4.3.2.3.3 BackgroundStyle
Esta propri edade especi fi ca o modo do preenchi mento do fundo do objeto. Esta
propri edade habi l i ta a uti l i zao das propri edades VerticalPercentFill e
HorizontalPercentFill com val ores di ferentes de 100 e tambm da propri edade
FillStyle confi gurada entre os val ores 2 e 8. Isto faz com que a rea restante uti l i ze a
cor de fundo confi gurada em BackgroundColor para preenchi mento. A tabel a a
segui r contm os val ores vl i dos para a propri edade BackgroundStyle.
Opes disponveis para BackgroundStyle
OPO DESCRIO
0 - Transparente
Nenhum fundo deste objeto ser
desenhado.
1 - Opaco
Caso vi svel , o fundo ser desenhado.
130 Visualizao
4.3.2.3.4 BorderColor
Especi fi ca a cor da borda ou a cor da l i nha deste objeto. Esta propri edade s
uti l i zada quando a propri edade BorderStyle no est confi gurada para o val or 5
(nul l ), onde o objeto fi ca sem borda. Nos scri pts, uti l i ze a funo RGB do VBScri pt
para montar a cor a ser associ ada a esta propri edade. O val or padro desta
propri edade branco (RGB(255, 255, 255)), exceto para os objetos Di spl ay e
SetPoi nt, cujo val or padro da propri edade ci nza escuro (RGB(128,128,128)).
4.3.2.3.5 BorderStyle
A propri edade BorderStyle determi na o esti l o de borda que ser apl i cada ao
objeto.
Opes disponveis para BorderStyle
OPO DESCRIO
0 - Normal
Apl i ca uma borda sl i da no objeto
(padro).
1 - Dash
Apl i ca uma borda com l i nha tracejada no
objeto.
2 - Dot
Apl i ca uma borda ponti l hada no objeto.
3 - Dashdot
Apl i ca uma borda com trao-ponto no
objeto.
4 - Dashdotdot
Apl i ca uma borda com trao-ponto-ponto
no objeto.
5 - Null
O objeto no ter borda.
4.3.2.3.6 BorderWidth
Defi ne a espessura, em uni dades Hi metri c, da l i nha ou da borda do objeto. S
uti l i zada se a propri edade BorderStyle no esti ver confi gurada para o val or 5
(nul l ). O val or padro desta propri edade 0 (zero). Esta uma exceo no si stema
de medi das do E3, poi s quando seu val or zero, a espessura da l i nha ou da borda
no defi ni da em uni dades Hi metri c, mas si m em pi xel s. A propri edade
BorderWidth com val or i gual a zero i ndi ca a espessura de um pi xel .
4.3.2.3.7 Effect3D
Determi na a apl i cao de um efei to 3D no objeto sel eci onado. As opes
di sponvei s para esta propri edade so descri tas na tabel a a segui r.
Opes disponveis para Effect3D
OPO DESCRIO
0 - No3D
Transparente (padro).
1 - Raised
Apl i ca um efei to 3D em al to rel evo.
2 - Sunken
Apl i ca um efei to 3D em bai xo rel evo.
Visualizao 131
4.3.2.3.8 Effect3D_X
Especi fi ca a di menso do efei to 3D no ei xo hori zontal do objeto (ei xo X). O val or
padro desta propri edade 30.
4.3.2.3.9 Effect3D_Y
Especi fi ca a di menso do efei to 3D no ei xo verti cal do objeto (ei xo Y). O val or
4.3.2.3.10 Effect3DColorBase
Determi na a cor da base do efei to 3D no objeto. O val or padro desta
propri edade preto (RGB(0, 0, 0)).
4.3.2.3.11 Effect3DColorTop
Determi na a cor do topo do efei to 3D no objeto. O val or padro desta
propri edade branco (RGB(255, 255, 255)).
4.3.2.3.12 Enabled
Habi l i ta ou desabi l i ta o objeto, i sto , o foco e a resposta aos eventos gerados
pel o usuri o. Se a propri edade esti ver confi gurada para True, o objeto pode receber
o foco, responder a eventos gerados pel o usuri o e estar acessvel atravs de
scri pts (padro). Caso contrri o, o usuri o no poder i nteragi r com o objeto
usando o mouse, pressi onando tecl as ou tecl as de atal ho e o objeto aparece
esmaeci do. Al m di sso, se o objeto exi bi r um bi tmap, o bi tmap fi ca esmaeci do
sempre que este objeto esti ver desabi l i tado.
As propri edades 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 i nterl i gadas. Quando as propri edades Enabled e Locked esti verem
ambas confi guradas em True, o objeto pode receber foco e aparecer normal mente
na Tel a, e os dados podem ser copi ados, mas no edi tados. Quando Enabled for
True, mas Locked for Fal se, os dados podem ser no s copi ados, mas tambm
edi tados. No entanto, quando Enabled for Fal se, o objeto no recebe foco e fi ca
esmaeci do na Tel a, i ndependentemente do status de Locked. Al m di sso, os dados
no podem ser copi ados nem tampouco edi tados.
possvel combi nar as confi guraes das propri edades Enabled e TabStop para
i mpedi r que o usuri o sel eci one um boto de comando com a tecl a TAB, embora
ai nda seja permi ti do ao usuri o cl i car no boto. Defi ni r a propri edade TabStop
como Fal se si gni fi ca que o Boto de Comando no aparecer na ordem de
tabul ao. Entretanto, se Enabled for True, o usuri o ai nda poder cl i car no Boto
de Comando, desde que a propri edade TakeFocusOnClick esteja defi ni da como True.
132 Visualizao
4.3.2.3.13 FillStyle
Esta propri edade especi fi ca o esti l o do preenchi mento do objeto. A tabel a a
segui r contm os val ores vl i dos para a propri edade FillStyle.
Opes disponveis para FillStyle
OPO DESCRIO
0 - Solid
O preenchi mento ser sl i do (padro).
1 - Hollow
No haver preenchi mento.
2 - Horizontal
hori zontai s.
3 - Vertical
verti cai s.
4 - Downward
descendo da esquerda para a di rei ta em
ngul o de 45 graus.
5 - Upward
subi ndo da esquerda para a di rei ta em
ngul o de 45 graus.
6 - Cross
hori zontai s e verti cai s.
7 - DiagonalCross
descendo e subi ndo da esquerda para a
di rei ta em ngul o de 45 graus.
8 - Gradient
O preenchi mento ser em degrad
uti l i zando tanto o val or da propri edade
ForegroundColor quanto o val or da
propri edade BackgroundColor. O efei to
ser defi ni do pel a propri edade
GradientStyle.
9 - SemiTransparent
Dei xa o objeto transl ci do.
10 - MouseArea
No haver preenchi mento, mas o objeto
conti nua sensvel aos eventos.
4.3.2.3.14 ForegroundColor
Esta propri edade especi fi ca a cor do preenchi mento da frente do objeto. Esta cor
uti l i zada quando a propri edade FillStyle est confi gurada para 0 (sl i do) ou entre
2 e 9. Nos scri pts, uti l i ze a funo RGB do VBScri pt para montar a cor a ser
associ ada a esta propri edade. O val or padro para esta propri edade azul (RGB(0,
0, 255)), exceto para os objetos Di spl ay e SetPoi nt, cujo val or padro para esta
4.3.2.3.15 Frame
Retorna o Quadro pai do objeto. Esta propri edade acessvel apenas em tempo
de execuo.
Visualizao 133
4.3.2.3.16 GradientStyle
Esta propri edade especi fi ca o esti l o de preenchi mento degrad do objeto. Esta
propri edade s ser uti l i zada quando a val or da propri edade FillStyle esti ver
confi gurada para 8 (Gradient). Os degrads consi deram a mudana parti ndo da cor
confi gurada na propri edade ForegroundColor e i ndo para a cor confi gurada na
propri edade BackgroundColor.
OPO DESCRIO
0 - LeftToRight
di rei ta.
1 - RightToLeft
esquerda.
2 - VerFromCenter
bordas.
3 - VerToCenter
centro.
4 - BottomUp
5 - TopDown
6 - HorzFromCenter
7 - HorzToCenter
8 - DiagUpRight
9 - DiagUpLeft
frente na esquerda.
para as bordas.
11 - DiagUpToCenter
para o centro.
12 - DiagDownLeft
Degrad di agonal para bai xo com a cor
de frente na esquerda.
13 - DiagDownRight
Degrad di agonal para bai xo com a cor
de frente na di rei ta.
para as bordas.
para o centro.
16 - SpotSouthEast
Degrad com a cor de frente parti ndo do
17 - SpotSouthWest
18 - SpotNorthWest
19 - SpotNorthEast
20 - SpotFromCenter
Degrad com a cor de fundo do centro
para as bordas.
134 Visualizao
OPO DESCRIO
21 - SpotToCenter
Degrad com a cor de fundo das bordas
para o centro.
IMPORTANTE: Um grande nmero de objetos sendo mostrados com degrad,
si mul taneamente, acarretam uma perda de performance na atual i zao da Tel a. O
uso de fi guras no l ugar pode resol ver o probl ema.
4.3.2.3.17 HasFocus
Esta propri edade determi na que o objeto sel eci onado est com o foco. Esta
propri edade acessvel apenas em tempo de execuo.
4.3.2.3.18 Height
Determi na a al tura do objeto.
4.3.2.3.19 HorizontalFillStyle
Defi ne como ser o preenchi mento hori zontal do objeto. Esta propri edade
trabal ha em conjunto com a propri edade HorizontalPercentFill, que i nforma qual
porcentagem do objeto dever ser preenchi da. Estas duas propri edades permi tem
uma si mul ao de um preenchi mento de nvel em um objeto, como ocorre em um
nvel de um tanque, por exempl o.
Opes disponveis para HorizontalFillStyle
OPO DESCRIO
0 - FillLeftToRight
A porcentagem de preenchi mento ser
da esquerda para a di rei ta (padro).
1 - FillRightToLeft
da di rei ta para a esquerda.
2 - FillCenterToEdgesH
do centro para as bordas.
4.3.2.3.20 HorizontalPercentFill
Uti l i ze a propri edade HorizontalPercentFill para especi fi car qual a porcentagem
da rea hori zontal do objeto dever ser preenchi da. Os val ores acei tos por esta
propri edade vari am de 0 a 100. Esta propri edade trabal ha em conjunto com a
propri edade HorizontalFillStyle, que i nforma como este preenchi mento ocorrer. O
val or padro desta propri edade 100.
4.3.2.3.21 Layer
Esta propri edade defi ne em quai s camadas o objeto deve aparecer. O val or
representa uma mscara de 32 bi ts, um bi t para cada camada. Portanto, podem ser
Visualizao 135
defi ni das at 32 camadas i ndi vi duai s. Assi m, objetos podem ser agrupados
l ogi camente e mostrados ou escondi dos apenas com a modi fi cao da mscara da
propri edade Layer.
4.3.2.3.22 MouseOver
A propri edade MouseOver i nforma se o pontei ro do mouse encontra-se em ci ma
da Tel a. Caso afi rmati vo, a propri edade MouseOver habi l i tada; do contrri o, ser
Fal se. Esta propri edade apenas de l ei tura, e acessvel apenas em tempo de
execuo. O val or padro desta propri edade Fal se.
4.3.2.3.23 MouseOverChild
A propri edade MouseOverChild i nforma se o pontei ro do mouse encontra-se em
ci ma de um dos objetos i nseri dos na Tel a. Caso afi rmati vo, a propri edade
MouseOverChild habi l i tada; do contrri o, ser Fal se. Esta propri edade apenas
de l ei tura, e acessvel apenas em tempo de execuo. O val or padro desta
propri edade Fal se.
4.3.2.3.24 Screen
Retorna a Tel a pai do objeto. Esta propri edade acessvel apenas em tempo de
execuo.
4.3.2.3.25 Shadow
Indi ca a presena do efei to de sombra no objeto. Se True, o objeto possui uma
sombra, cujas coordenadas so estabel eci das pel as propri edades ShadowX e
ShadowY. Do contrri o, o objeto no possui o efei to de sombra. O val or padro
4.3.2.3.26 ShadowColor
Especi fi ca a cor do preenchi mento da sombra do objeto. Esta cor uti l i zada
quando a propri edade Shadow est confi gurada para True. Nos scri pts, uti l i ze a
funo RGB do VBScri pt para montar a cor a ser associ ada a esta propri edade. O
val or padro desta propri edade ci nza escuro (RGB(128, 128, 128)).
4.3.2.3.27 ShadowX
Defi ne a coordenada verti cal esquerda da sombra do objeto, em uni dades
Hi metri c. Este sombra sempre rel ati va propri edade X do objeto. Val ores
posi ti vos i ndi cam que a sombra est di rei ta do objeto, e negati vos, esquerda. O
136 Visualizao
4.3.2.3.28 ShadowY
Defi ne a coordenada hori zontal superi or da sombra do objeto, em uni dades
Hi metri c. Este sombra sempre rel ati va propri edade Y do objeto. Val ores
posi ti vos i ndi cam que a sombra est abai xo do objeto, e negati vos, aci ma. O val or
4.3.2.3.29 TabStop
Esta propri edade determi na a uti l i zao da tecl a TAB no si stema. Se o campo
esti ver em True, possvel uti l i zar a tecl a; caso contrri o, a tecl a no pode ser
uti l i zada.
4.3.2.3.30 Tip
A propri edade Tip mostra um texto popup quando o mouse esti ver por um breve
momento sobre o objeto em execuo.
4.3.2.3.31 VerticalFillStyle
Defi ne como ser o preenchi mento verti cal do objeto. Esta propri edade trabal ha
em conjunto com a propri edade VerticalPercentFill, que i nforma qual porcentagem
do objeto dever ser preenchi da. Estas duas propri edades permi tem uma
si mul ao de um preenchi mento de nvel em um objeto.
Opes disponveis para VerticalFillStyle
OPO DESCRIO
0 - FillBottomToTop
de bai xo para ci ma.
1 - FillTopToBottom
de ci ma para bai xo.
2 - FillCenterToEdgesV
4.3.2.3.32 VerticalPercentFill
Uti l i ze a propri edade VerticalPercentFill para especi fi car qual a porcentagem da
rea verti cal do objeto dever ser preenchi da. Os val ores acei tos por esta
propri edade VerticalFillStyle, que i nforma como este preenchi mento ocorre. O val or
4.3.2.3.33 Visible
Esta propri edade defi ne a vi si bi l i dade do objeto. Se confi gurada como True, o
objeto fi ca vi svel , desde que tambm sejam obedeci dos os segui ntes fatores: o
Visualizao 137
objeto pai deste objeto tambm deve estar vi svel , e a propri edade Layer deste
objeto tambm deve estar presente na camada da Tel a.
4.3.2.3.34 Width
Determi na a l argura do objeto, em uni dades Hi metri c.
4.3.2.3.35 X
A propri edade X defi ne a coordenada hori zontal esquerda, em uni dades Hi metri c,
do objeto.
4.3.2.3.36 Y
Esta propri edade defi ne a coordenada verti cal superi or, em uni dades Hi metri c, do
objeto.
4.3.2.4 Grupo
Esta seo contm i nformaes sobre propriedades do Grupo de objetos. Este
objeto no possui eventos nem mtodos associ ados.
4.3.2.4.1 Propriedades
Esta seo contm i nformaes sobre propri edades do Grupo de objetos.
4.3.2.4.1.1 EnableOverrideLineColor
Esta propri edade habi l i ta ou desabi l i ta o objeto Grupo a sobrescrever as cores
ori gi nai s das l i nhas dos objetos conti dos no Grupo. Se a propri edade
EnableOverrideLineColor esti ver habi l i tada, faz com que sejam modi fi cadas as
cores ori gi nai s das l i nhas dos objetos do Grupo pel a cor defi ni da na propri edade
OverrideLineColor. Caso contrri o, cada objeto conti do no Grupo apresentar sua
cor de l i nha ori gi nal . O val or padro desta propri edade Fal se.
4.3.2.4.1.2 OverrideFillColor
Quando a propri edade OverrideFillMode esti ver confi gurada para 2 ou 3, a
propri edade OverrideFillColor ser usada para defi ni r a cor a ser usada no
preenchi mento dos objetos contguos no Grupo, ao i nvs da cor ori gi nal . Nos
scri pts, uti l i ze a funo RGB do VBScri pt para montar a cor a ser associ ada a esta
propri edade. O val or padro desta propri edade vermel ho (RGB(255, 0, 0)).
138 Visualizao
4.3.2.4.1.3 OverrideFillMode
A propri edade OverrideFillMode especi fi ca o modo do preenchi mento dos
objetos que esto dentro do Grupo. El a al tera o modo ori gi nal de preenchi mento da
i magem sem al terar a confi gurao ori gi nal de preenchi mento dos objetos.
Opes disponveis para OverrideFillMode
OPO DESCRIO
0 - NoOverride
Preenchi mento ori gi nal do objeto.
1 - WireFrame
Os objetos no sero preenchi dos,
desenharo somente suas bordas.
2 - SolidFill
O preenchi mento dos objetos conti dos
no Grupo ser sl i do com a cor
especi fi cada na propri edade
OverrideFillColor.
3 - ByBrightness
no Grupo ser sl i do com a cor
especi fi cada pel a propri edade
OverrideFillColor, porm l evar em conta
qual era a i ntensi dade da cor ori gi nal de
preenchi mento de cada objeto.
4.3.2.4.1.4 OverrideLineColor
Quando a propri edade EnableOverrideLineColor esti ver confi gurada para True, a
propri edade OverrideLineColor ser usada para defi ni r a cor a ser usada na cor da
l i nha dos objetos do Grupo, ao i nvs da cor ori gi nal . Nos scri pts, uti l i ze a funo
RGB do VBScri pt para montar a cor a ser associ ada a esta propri edade. O val or
padro desta propri edade vermel ho (RGB(255, 0, 0)).
4.3.2.5 Retngulo Arredondado
Esta seo contm i nformaes sobre propriedades do objeto Retngul o
Arredondado. Este objeto no possui eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades do objeto Retngul o
Arredondado.
4.3.2.5.1.1 RoundAspectX
A propri edade RoundAspectX defi ne o tamanho da di menso das l aterai s do
Retngul o no ei xo X. Sendo assi m, de acordo com o val or defi ni do na propri edade,
os cantos do Retngul o i ro mudar a sua forma, desde um retngul o at uma
el i pse. Esta propri edade pode vari ar seu val or de 0.1 at 1.0. Exempl o:
Visualizao 139
Sub RetanguloArred_Click()
RoundAspectX = 0.5
End Sub
4.3.2.5.1.2 RoundAspectY
A propri edade RoundAspectY defi ne o tamanho da di menso da al tura do
Retngul o no ei xo Y. Sendo assi m, de acordo com o val or defi ni do na propri edade,
os cantos do Retngul o i ro mudar a sua forma, desde um retngul o at uma
el i pse. Esta propri edade pode vari ar seu val or de 0.1 at 1.0. Exempl o:
Sub RetanguloArred_Click()
RoundAspectY = 0.5
End Sub
4.3.2.6 Arco de Elipse
Esta seo contm i nformaes sobre propriedades do objeto Arco de El i pse. Este
Esta seo contm i nformaes sobre as propri edades do objeto Arco de El i pse.
4.3.2.6.1.1 ArcBeginAngle
Esta propri edade confi gura o ngul o i ni ci al do arco do objeto, em graus. O
i nterval o acei to por essa propri edade vai de 0 at 359. O esti l o e forma do arco
dependero tambm das confi guraes das propri edades ArcEndAngle e ArcStyle. O
val or padro desta propri edade 0. Exempl o:
Screen.Item("Arco1").ArcBeginAngle = 12
End Sub
4.3.2.6.1.2 ArcEndAngle
Esta propri edade confi gura o ngul o fi nal do arco do objeto, em graus. O
i nterval o acei to por essa propri edade vai de 0 at 359. O esti l o e forma do arco
dependero tambm das confi guraes das propri edades ArcBeginAngle e ArcStyle.
O val or padro desta propri edade 270. Exempl o:
Screen.Item("Arco1").ArcEndAngle = 12
End Sub
4.3.2.6.1.3 ArcStyle
Esta propri edade especi fi ca o esti l o da borda ou l i nha do objeto. A borda do
objeto ser desenhada conforme o esti l o defi ni do, uti l i zando a cor especi fi cada
em BorderColor com a espessura BorderWidth. A segui nte tabel a contm os val ores
140 Visualizao
vl i dos para a propri edade ArcStyle:
Opes disponveis para ArcStyle
OPO DESCRIO
0 - arc
O esti l o do desenho ser um arco.
1 - chord
O esti l o do desenho ser uma corda,
uni ndo o ponto i ni ci al e fi nal .
2 - pie
O esti l o do desenho ser uma pi zza
(padro).
Exempl o:
Screen.Item("Arco1").ArcStyle = 1
End Sub
4.3.2.7 Figura
Esta seo contm i nformaes sobre propriedades do objeto Fi gura. Este objeto
no possui eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades do objeto Fi gura.
4.3.2.7.1.1 BackgroundColor
fundo para preenchi mento. Nos scri pts, uti l i ze a funo do VBScri pt RGB para
4.3.2.7.1.2 BackgroundStyle
Esta propri edade especi fi ca o modo do preenchi mento do fundo do objeto. Esta
propri edade habi l i ta a uti l i zao das propri edades VerticalPercentFill e
HorizontalPercentFill com val ores di ferentes de 100 e tambm da propri edade
FillStyle confi gurada entre os val ores 2 e 8. Isto faz com que a rea restante uti l i ze a
cor de fundo BackgroundColor para preenchi mento. A segui nte tabel a contm os
val ores vl i dos para a propri edade BackgroundStyle.
Visualizao 141
Opes disponveis para BackgroundStyle
OPO DESCRIO
0 - Transparente
Nenhum fundo deste objeto ser
desenhado.
1 - Opaco
Caso vi svel , o fundo ser desenhado.
4.3.2.7.1.3 Convert
Esta propri edade permi te a converso da fi gura. Se a opo do campo esti ver em
0 possvel vi sual i zar a converso. Caso contrri o, no ser possvel vi sual i zar a
converso. O campo s acei ta os val ores 0 e 1. O val or padro desta propri edade
0.
Esta propri edade habi l i ta ou desabi l i ta o objeto a sobrescrever a cor ori gi nal da
l i nha da i magem pel a cor defi ni da na propri edade OverrideLineColor. Se a
propri edade EnableOverrideLineColor esti ver habi l i tada, faz com que sejam
modi fi cadas a cor ori gi nal da l i nha do objeto pel a cor de OverrideLineColor. Caso
contrri o, o objeto Fi gura exi bi r a cor ori gi nal .
4.3.2.7.1.5 Filename
Defi ne o nome do arqui vo de i magem associ ado a esse objeto. O cami nho do
arqui vo pode ser tanto o cami nho compl eto do arqui vo no di sco quanto o cami nho
rel ati vo apl i cao (quando i nseri do o arqui vo de i magem como um Recurso da
apl i cao). O val or padro desta propri edade vazi o. Os segui ntes ti pos de
arqui vos de i magem so suportados:
PROPRIEDADE FILTRO DESCRIO FILTRO
Bitmap file
BMP No Si m
Graphics Interchange
Format
GI F No Si m
Joint Picture Expert
Group
JPG No Si m
Icon File
I CO No Si m
4.3.2.7.1.6 HorizontalFillStyle
Defi ne como ser o preenchi mento hori zontal do objeto. Esta propri edade
trabal ha em conjunto com a propri edade HorizontalPercentFill, que i nforma qual
porcentagem do objeto dever ser preenchi da. Estas duas propri edades permi tem
uma si mul ao de um preenchi mento de nvel em um objeto, como ocorre em um
nvel de um tanque, por exempl o.
142 Visualizao
Opes disponveis para HorizontalFillStyle
OPO DESCRIO
0 - FillLeftToRight
da esquerda para a di rei ta (padro).
1 - FillRightToLeft
da di rei ta para a esquerda.
2 - FillCenterToEdgesH
4.3.2.7.1.7 HorizontalPercentFill
Uti l i ze a propri edade HorizontalPercentFill para especi fi car qual a porcentagem
da rea hori zontal do objeto dever ser preenchi da. Os val ores acei tos por esta
propri edade HorizontalFillStyle, que i nforma como este preenchi mento ocorrer. O
Sub Circulo1_OnStartRunning()
HorizontalPercentFill = 200
End Sub
Quando a propri edade OverrideFillMode esti ver especi fi cada para os val ores 2
ou 3, a propri edade OverrideFillColor ser usada para defi ni r a cor a ser usada no
preenchi mento da i magem, ao i nvs da cor ori gi nal . Nos scri pts, uti l i ze a funo do
VBScri pt RGB para montar a cor a ser associ ada a esta propri edade. O val or
padro desta propri edade vermel ho (RGB(255, 0, 0)). Exempl o:
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: Esta propri edade s funci ona quando o objeto Fi gura est trabal hando com
arqui vos metafi l e (WMF ou EMF).
A propri edade OverrideFillMode especi fi ca o modo do preenchi mento da
i magem do objeto, quando este est mostrando um arqui vo Wi ndows Metafi l e. El a
al tera o modo ori gi nal de preenchi mento da i magem sem al terar o arqui vo defi ni do
pel a propri edade Filename. A segui nte tabel a contm os val ores vl i dos para a
propri edade OverrideFillMode.
Visualizao 143
OPO DESCRIO
0 - NoOverride
A i magem manter seu preenchi mento
ori gi nal (padro).
1 - WideFrame
A i magem no ser preenchi da.
2 - SolidFill
A i magem ser preenchi da com a cor
OverrideFillColor.
3 - ByBrightness
A i magem ser preenchi da com a cor
qual era a i ntensi dade da cor ori gi nal da
i magem.
Exempl o:
End Sub
l i nha da fi gura, ao i nvs da cor ori gi nal . Nos scri pts, uti l i ze a funo do VBScri pt
RGB para montar a cor a ser associ ada a esta propri edade. O val or padro desta
propri edade vermel ho (RGB(255, 0, 0)). Exempl o:
OverrideLineColor = RGB(0, 0, 255)
End Sub
4.3.2.7.1.11 Shadow
Indi ca a presena do efei to de sombra no objeto. Se True, o objeto possui uma
sombra, cujas coordenadas so estabel eci das pel as propri edades ShadowX e
ShadowY. Do contrri o, o objeto no possui o efei to de sombra. O val or padro
144 Visualizao
4.3.2.7.1.12 ShadowColor
Especi fi ca a cor do preenchi mento da sombra do objeto. Esta cor uti l i zada
quando a propri edade Shadow est confi gurada para True. Nos scri pts, uti l i ze a
funo do VBScri pt RGB para montar a cor a ser associ ada a esta propri edade. O
val or padro desta propri edade ci nza escuro (RGB(128, 128, 128)). Exempl o:
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
4.3.2.7.1.13 ShadowX
Defi ne a coordenada verti cal esquerda da sombra deste objeto, em uni dades
Hi metri c. Esta sombra sempre rel ati va propri edade X do objeto. Val ores
posi ti vos i ndi cam que a sombra estar di rei ta do objeto, e negati vos esquerda.
O val or padro desta propri edade 200.
4.3.2.7.1.14 ShadowY
Defi ne a coordenada hori zontal superi or da sombra deste objeto, em uni dades
Hi metri c. Esta sombra sempre rel ati va a propri edade Y do objeto. Val ores
posi ti vos i ndi cam que a sombra estar abai xo do objeto, e negati vos aci ma. O
Sub Botao1_Click()
ShadowY = 250
End Sub
4.3.2.7.1.15 TransparentColor
Quando a propri edade TransparentMode esti ver confi gurada para 1, esta
propri edade defi ni r qual cor da i magem no ser desenhada, e a i magem fi car
transparente nestes pontos. Nos scri pts, uti l i ze a funo do VBScri pt RGB para
propri edade branco (RGB(255, 255, 255)). Exempl o:
' Deixa a cor da imagem azul transparente
Visualizao 145
' quando se clica no objeto Figura
TransparentMode = 1 ' ByColor
TransparentColor = RGB(0, 0, 255)
End Sub
4.3.2.7.1.16 TransparentMode
A propri edade TransparentMode especi fi ca o modo como a i magem ter o efei to
de transparnci a.
Opes disponveis para TransparentMode
OPO DESCRIO
0 - Disabled
Nenhuma transparnci a ser efetuada.
1 - ByColor
A transparnci a ser de acordo com a cor
defi ni da na propri edade TransparentColor.
2 - ByPercent
A i magem fi car transl ci da com
porcentagem de transparnci a
TransparentPercent.
Exempl o:
' Deixa a cor da imagem azul transparente
' quando se clica no objeto Figura
TransparentMode = 1 ' ByColor
TransparentColor = RGB(0, 0, 255)
End Sub
4.3.2.7.1.17 TransparentPercent
Quando a propri edade TransparentMode esti ver confi gurada para 2, esta
propri edade defi ne quo transl ci da a i magem ser exi bi da, vari ando de 0
(total mente transl ci do) a 100 (opaco ou sl i do). Exempl o:
' Deixa a imagem translcida quando se clica no objeto
TransparentMode = 1 ' ByPercent
TransparentPercent = 50 ' 50% translcido
End Sub
146 Visualizao
4.3.2.7.1.18 VerticalFillStyle
Defi ne como ser o preenchi mento verti cal do objeto. Esta propri edade trabal ha
em conjunto com a propri edade VerticalPercentFill, que i nforma qual porcentagem
do objeto dever ser preenchi da. Estas duas propri edades permi tem uma
si mul ao de um preenchi mento de nvel em um objeto.
Opes disponveis para VerticalFillStyle
OPO DESCRIO
0 - FillBottomToTop
de bai xo para ci ma.
1 - FillTopToBottom
de ci ma para bai xo.
2 - FillCenterToEdgesV
4.3.2.7.1.19 VerticalPercentFill
Uti l i ze a propri edade VerticalPercentFill para especi fi car qual a porcentagem da
rea verti cal do objeto dever ser preenchi da. Os val ores acei tos por esta
propri edade VerticalFillStyle, que i nforma como este preenchi mento ocorrer. O
4.3.2.8 Texto, Display e SetPoint
Esta seo contm i nformaes sobre eventos e propriedades dos objetos Texto,
Di spl ay e SetPoi nt. Estes objetos no possuem mtodos associ ados.
4.3.2.8.1 Eventos
Esta seo contm i nformaes sobre os eventos dos objetos Texto, Di spl ay e
SetPoi nt.
4.3.2.8.1.1 Validate
Validate(Cancel, NewValue)
Ocorre aps os testes de l i mi tes do SetPoi nt (ver propri edades MinLimit, MaxLimit,
EnableLimits) e antes do val or do SetPoi nt ser envi ado para o Tag. A fi nal i dade
deste evento permi ti r que o usuri o cancel e o envi o do val or do SetPoi nt para o
Tag.
O parmetro Cancel bool eano e i ndi ca se a operao de atri bui o do val or do
SetPoi nt ao Tag deve ser cancel ada (Cancel i gual a True). O padro Fal se, ou seja,
Visualizao 147
o val or do SetPoi nt ser envi ado ao Tag. NewValue o val or que est sendo
aval i ado. O val or anti go pode ser acessado pel a propri edade Value do SetPoi nt.
Exempl o:
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
Esta seo contm i nformaes sobre as propri edades dos objetos Texto, Di spl ay e
SetPoi nt.
4.3.2.8.2.1 EnableLimits
Indi ca se ser fei ta a veri fi cao de l i mi tes no texto. Quando EnableLimits for
True, e o usuri o i nseri r um val or no-numri co ou col ocar um val or fora dos
l i mi tes defi ni dos em MinLimit e MaxLimit, uma mensagem de erro mostrada (a
propri edade IsSetPoint deve ser True). Exempl o:
Screen.Item("Texto1").EnableLimits = _
Not(Screen.Item("Texto1").EnableLimits)
End Sub
4.3.2.8.2.2 Format
A propri edade Format especi fi ca que ti po de formato ser atri budo ao objeto.
Permi te mudar a forma como os dados so apresentados sem mudar o val or que
exi ste por trs del es. Esta propri edade pode ser edi tada manual mente ou
confi gurada atravs da janel a de formatao. Seu uso semel hante aos
formatadores usados nas pl ani l has de dados, segui ndo a mesma si ntaxe. So
suportados os segui ntes ti pos de dados:
Tipos de dados suportados por Format
DADOS DESCRIO
Numrico
Sada deci mal , ci entfi ca, hexadeci mal ,
bi nri a e octal .
Texto
Textos em geral .
Booleano
Val ores bol eanos.
Data/Hora
Cal endri o Gregori ano.
148 Visualizao
4.3.2.8.2.3 IsSetPoint
A propri edade IsSetPoint uti l i zada para determi nar se o objeto tem
comportamento de SetPoi nt, ou seja, permi te edi o da propri edade Value. A
propri edade Value consi ste em um Variant, que pode assumi r val ores de todo e
qual quer ti po. A propri edade IsSetPoint bool eana e assume o segui nte
comportamento: se a opo for True, ser permi ti da a edi o; j se a opo esti ver
Fal se, a edi o no ser permi ti da. Isto pode ser vi sual i zado quando o objeto
Vi ewer est em execuo. O val or padro desta propri edade Fal se.
4.3.2.8.2.4 KeepFormatWhenEditing
Permi te que o val or do objeto seja edi tado com ou sem formatao. As opes
di sponvei s so:
0 - kfNever: neste caso o val or sempre edi tado sem formatao (padro)
1 - kfAutomatic: permi te que o val or seja edi tado no val or formatado, caso o E3
detecte que o texto formatado passvel de ser i nterpretado como um val or
Caso o formato seja consi derado i ncompatvel , o val or edi tado sem formatao.
4.3.2.8.2.5 MaxLimit
Contm o val or mxi mo permi ti do no objeto (a propri edade EnableLimits deve ser
True). Exempl o:
Screen.Item("Texto1").MaxLimit = Screen.Item("Texto6").Value
End Sub
4.3.2.8.2.6 MinLimit
Contm o val or mni mo permi ti do no objeto (a propri edade EnableLimits deve ser
True). Exempl o:
Screen.Item("Texto1").MinLimit = Screen.Item("Texto5").Value
End Sub
4.3.2.8.2.7 Multiline
A propri edade Multiline i ndi ca se o texto ter ml ti pl as l i nhas (True) ou se ser
uma cai xa de texto si mpl es (Fal se). Isto pode ser vi sual i zado quando o objeto
Visualizao 149
4.3.2.8.2.8 SetPointDataType
Determi na o ti po de val or que envi ado do SetPoi nt para o Tag.
Opes disponveis para SetPointDataType
OPO DESCRIO
0 - stCurrentType
Mantm o ti po do val or atual no SetPoi nt
(ver a segui r).
1 - stChar
Val or i ntei ro de 8 bi ts com si nal .
2 - stByte
Val or i ntei ro de 8 bi ts sem si nal .
3 - stWord
4 - stInteger
5 - stLong
6 - stDWord
7 - stSingle
Val or de ponto fl utuante de 32 bi ts.
8 - stDouble
Val or de ponto fl utuante de 64 bi ts.
9 - stDateTime
Val or de data e hora.
10 - stString
Texto.
Quando o texto di gi tado envi ado pel o SetPoi nt, este pri mei ro tentar converter o
val or para o ti po confi gurado (Word, String, Double, etc.). Se a converso no for
possvel - ou seja, o val or di gi tado i nvl i do para o ti po escol hi do - nenhum val or
envi ado (por exempl o, se o usuri o di gi tar -1 e o ti po for Byte). J quando o val or
da propri edade for 0 - stCurrentType, o ti po de dado envi ado pel o SetPoi nt ser
extrado do val or anteri or presente no objeto. Caso o val or anteri or seja Empty ou
Null, nenhuma converso ser fei ta e o val or di gi tado ser envi ado como texto.
Exempl o:
Sub Combobox1_Change()
Screen.Item("Texto1").SetPointDataType = CInt(Left(Value, 2))
End Sub
4.3.2.8.2.9 StretchText
Redi mensi ona o tamanho do objeto. A parti r do momento em que a propri edade
StretchText for habi l i tada, o objeto automati camente redi mensi ona o tamanho da
fonte do texto para que a rea ocupada por el e conti nue sempre a mesma. De outra
forma, se a propri edade StretchText esti ver confi gurada para Fal se, nenhum
redi mensi onamento ser efetuado.
4.3.2.8.2.10 TextAlignment
Esta propri edade especi fi ca o al i nhamento hori zontal do texto mostrado no
objeto.
150 Visualizao
Opes disponveis para TextAlignment
OPO DESCRIO
0 - LeftAlignment
O al i nhamento hori zontal do texto ser
esquerda.
1 - CenterAlignment
central i zado.
2 - RightAlignment
di rei ta.
4.3.2.8.2.11 TextColor
Esta propri edade especi fi ca a cor da fonte do texto a ser exi bi do. Nos scri pts,
uti l i ze a funo do VBScri pt RGB para montar a cor a ser associ ada a esta
propri edade. O val or padro desta propri edade preto (RGB(0, 0, 0)).
4.3.2.8.2.12 TextFont
Defi ne as i nformaes da fonte a ser uti l i zado pel o objeto. Esta propri edade no
pode ser uti l i zada em Associ aes e possui as segui ntes subpropri edades,
modi fi cvei s vi a scri pt:
Subpropriedades de TextFont
NOME TIPO DESCRIO
Name
Stri ng O nome da fonte.
Size
Ponto Fl utuante O tamanho, em pontos, da
fonte.
Bold
Bool eano I ndi ca se o texto est em
negri to.
Italic
Bool eano I ndi ca se o texto est em
i tl i co.
Underline
Bool eano I ndi ca se o texto est
subl i nhado.
Strikethrough
Bool eano I ndi ca se o texto est
tachado.
Weight
I ntei ro I ndi ca a vari ao do efei to
de negri to (a
subpropri edade Bold) na
fonte. Os val ores para esta
subpropri edade podem
vari ar entre 0 (no
i nterfere no efei to de
negri to) e 1000.
Visualizao 151
NOME TIPO DESCRIO
Charset
I ntei ro O conjunto de caracteres
da fonte. Veja a tabel a de
conjuntos de caracteres a
segui r, com os val ores
di sponvei s para esta
subpropri edade.
Valores disponveis para a subpropriedade Charset
VALOR DESCRIO
0
ANSI (American National Standards Institute)
1
Padro (mostra o conjunto de caracteres
di sponvel na fonte)
2
Smbol os
128
Japons (Shi ft-JI S)
129
Coreano
134
Chi ns Si mpl i fi cado (GBK)
136
Chi ns Tradi ci onal (Bi g5)
161
Grego
162
Turco
177
Hebrai co
178
rabe
186
Bl ti co
204
Ci rl i co
222
Tai l ands
238
Centro-Europeu
255
OEM (Original Equipment Manufacturer)
4.3.2.8.2.13 Value
A propri edade Value consi ste em um Variant, que pode assumi r val ores de todo e
qual quer ti po, e que ser exi bi do pel o objeto. Geral mente esta propri edade conter
um texto, poi s automati camente preenchi da quando ocorre a cri ao de um novo
objeto Texto. A propri edade IsSetPoint uti l i zada para determi nar se o objeto Texto
ter o mesmo comportamento de um SetPoi nt, ou seja, permi ti r a edi o da
propri edade Value. Exempl o:
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
152 Visualizao
4.3.2.8.2.14 VertTextAlignment
Determi na o al i nhamento verti cal do texto do objeto.
Opes disponveis para VertTextAlignment
OPO DESCRIO
0 - TopAlignment
Al i nhamento verti cal do texto no topo do
objeto.
1 - MidAlignment
Al i nhamento verti cal do texto no centro
do objeto.
2 - BottomAlignment
Al i nhamento verti cal do texto na base do
objeto.
4.3.2.8.2.15 WordWrap
Habi l i ta ou desabi l i ta uma quebra de l i nha no texto, caso a rea di sponvel para
o texto ul trapasse os l i mi tes determi nados no objeto. Para que esta propri edade
funci one, a propri edade Multiline deve ser obri gatori amente i gual a True.
4.3.2.9 Escala
Esta seo contm i nformaes sobre propriedades do objeto Escal a. Este objeto
Esta seo contm i nformaes sobre propri edades do objeto Escal a.
4.3.2.9.1.1 BackgroundColor
fundo para preenchi mento. Nos scri pts, uti l i ze a funo do VBScri pt RGB para
4.3.2.9.1.2 BorderColor
Esta propri edade determi na a cor da borda que ser apl i cada no objeto Escal a.
Com esta propri edade, possvel apl i car a cor padro ou personal i z-l a atravs da
sua edi o. O val or padro desta propri edade branco (RGB(255, 255, 255)).
Exempl o:
Sub Escala1_Click()
Visualizao 153
BorderColor = RGB (255, 0, 0)
End Sub
4.3.2.9.1.3 BorderStyle
objeto Escal a.
Opes disponveis para BorderStyle
OPO DESCRIO
0 - Normal
Apl i ca uma borda sl i da na grade
verti cal da escal a (padro).
1 - Dash
Apl i ca uma borda l i nha tracejada na
escal a.
2 - Dot
Apl i ca uma borda ponti l hada na escal a.
3 - Dashdot
Apl i ca uma borda trao e ponto na
escal a.
4 - Dashdotdot
Apl i ca uma borda trao ponto ponto na
escal a.
5 - Null
O objeto no ter borda.
4.3.2.9.1.4 BorderWidth
Esta propri edade determi na a l argura (em pi xel s) da borda do objeto Escal a.
Atravs desta propri edade, possvel confi gurar a l argura da borda, sem preci sar
modi fi car sua estrutura. O val or padro desta propri edade 0.
4.3.2.9.1.5 ForegroundColor
Esta propri edade especi fi ca a cor do preenchi mento do frente do objeto. Esta cor
uti l i zada quando a propri edade FillStyle est confi gurada para 0 (sl i do) ou entre
2 e 9. Nos scri pts, uti l i ze a funo do VBScri pt RGB para montar a cor a ser
associ ada a esta propri edade. O val or padro para esta propri edade azul (RGB(0,
0, 255)). Exempl o:
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
formatadores usados nas pl ani l has de dados, segui ndo a mesma si ntaxe. So
154 Visualizao
suportados os segui ntes ti pos de dados:
DADOS DESCRIO
Numrico
bi nri a e octal .
Texto
Textos em geral .
Booleano
Val ores Bol eanos.
Data/Hora
4.3.2.9.1.7 GradientStyle
Esta propri edade especi fi ca o esti l o de preenchi mento degrad do objeto. Esta
propri edade s ser uti l i zada quando a val or da propri edade FillStyle esti ver
confi gurada para 8 (Gradi ent). Os degrads consi deram a mudana da cor parti ndo
de ForegroundColor e i ndo para BackgroundColor.
OPO DESCRIO
0 - LeftToRight
di rei ta.
1 - RightToLeft
esquerda.
2 - VerFromCenter
bordas.
3 - VerToCenter
centro.
4 - BottomUp
5 - TopDown
6 - HorzFromCenter
7 - HorzToCenter
8 - DiagUpRight
9 - DiagUpLeft
frente na esquerda.
para as bordas.
11 - DiagUpToCenter
para o centro.
12 - DiagDownLeft
frente na esquerda.
13 - DiagDownRight
frente na di rei ta.
para as bordas.
para o centro.
Visualizao 155
OPO DESCRIO
16 - SpotSouthEast
17 - SpotSouthWest
18 - SpotNorthWest
19 - SpotNorthEast
20 - SpotFromCenter
Degrad com cor de fundo do centro para
as bordas.
21 - SpotToCenter
Degrad com cor de fundo das bordas
para o centro.
IMPORTANTE: Um grande nmero de objetos sendo mostrados com degrad
si mul taneamente acarreta uma perda de performance na atual i zao da Tel a. O
uso de fi guras no l ugar pode resol ver o probl ema.
Exempl o:
Sub Botao1_Click()
' Objeto fica com degrade
FillStyle = 8 ' GradientFill
GradientStyle = 0 ' leftToRight
End Sub
4.3.2.9.1.8 LineColor
Determi na a cor da l i nha com as marcas di vi sri as e subdi vi sri as da Escal a.
Para determi nar a cor da l egenda com nmeros do objeto, use a propri edade
TextColor. O val or padro desta propri edade preto (RGB(0, 0, 0)).
4.3.2.9.1.9 MaximumValue
Esta propri edade determi na o val or mxi mo ati ngi do pel a Escal a. O val or padro
desta propri edade 100. Exempl o:
' 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 propri edade determi na o val or mni mo requeri do pel a Escal a. O val or
padro desta propri edade 0. Exempl o:
' Ao clicar no boto, abre um MessageBox indicando
156 Visualizao
' o valor da propriedade Minimum do Escala1
MsgBox _
CSTr(Application.GetObject("Dados.Escala1").MinimumValue)
End Sub
4.3.2.9.1.11 MinorTicks
Esta propri edade determi na a quanti dade de marcas da Escal a. O val or padro
' Mostra o total de marcas da escala
MsgBox CStr(Screen.Item("Escala1").MinorTicks)
End Sub
4.3.2.9.1.12 MinorTicksPercentSize
Esta propri edade determi na o tamanho das marcas que subdi vi dem cada medi da
do objeto Escal a. O val or padro desta propri edade 10.
4.3.2.9.1.13 ScaleAlignment
Esta propri edade determi na o ti po de al i nhamento que ser atri budo Escal a:
0 - RightSide: di rei ta (val or padro)
1 - LeftSide: esquerda
4.3.2.9.1.14 ShowText
Esta propri edade determi na a vi si bi l i dade do texto na l egenda do objeto Escal a.
Se a opo esti ver habi l i tada, o texto mostrado. Caso contrri o, o objeto mostra
somente as l i nhas e subdi vi ses da Escal a. O val or padro desta propri edade
True.
4.3.2.9.1.15 StretchText
Esta propri edade determi na a apl i cao de extenso (stretch) ao texto do objeto
Escal a (caso a l argura ou al tura da Escal a sejam al teradas, o texto acompanha
esta vari ao). Se a propri edade esti ver habi l i tada, o objeto acompanha as
vari aes de al tura e l argura do objeto conforme for transformado. Caso contrri o,
o texto permanece com as confi guraes i ni ci ai s. O val or padro desta
Visualizao 157
4.3.2.9.1.16 TextAlignment
A propri edade TextAlignment determi na o al i nhamento do texto no objeto.
Opes disponveis para TextAlignment
OPO DESCRIO
0 - leftAlignment
O al i nhamento do texto ser esquerda
(padro).
1 - centerAlignment
O al i nhamento do texto ser
central i zado.
2 - rightAlignment
O al i nhamento do texto ser di rei ta.
4.3.2.9.1.17 TextColor
Determi na a cor da fonte apl i cada na l egenda com nmeros do objeto Escal a.
Para determi nar a cor da l i nha com as marcas di vi sri as e subdi vi sri as da
Escal a, uti l i ze a propri edade LineColor. O val or padro desta propri edade preto
(RGB(0, 0, 0)).
4.3.2.9.1.18 TextFont
A propri edade TextFont determi na a fonte que ser apl i cada na Escal a. A fonte
escol hi da ser apl i cada em todo o objeto Escal a. Esta propri edade no pode ser
uti l i zada em Associ aes. Veja a propri edade TextFont dos objetos Texto, Di spl ay e
SetPoi nt para mai ores i nformaes sobre as subpropri edades que podem ser
modi fi cadas vi a scri pt.
4.3.2.9.1.19 Ticks
Determi na a quanti dade de di vi sri as que a Escal a ter. O val or padro desta
propri edade 5.
4.3.2.9.1.20 TicksPercentSize
Determi na o tamanho das l i nhas que di vi dem o objeto Escal a. Conforme for o
val or especi fi cado nesta propri edade, mai or ou menor fi car o tamanho da l i nha
da di vi sri a padro da Escal a. O val or padro desta propri edade 20.
4.3.2.10 Animao com Translao
Esta seo contm i nformaes sobre propriedades do objeto Ani mao com
Transl ao. Este objeto no possui eventos nem mtodos associ ados.
158 Visualizao
Esta seo contm i nformaes sobre as propri edades do objeto Ani mar com
Transl ao.
4.3.2.10.1.1 Detents
Atravs da propri edade Detents determi nado o nmero de passos do
movi mento no objeto. Exempl o:
MsgBox Screen.Item("DynamicRotate1").Detents
End Sub
propri edade EnableOverrideLineColor esti ver habi l i tada, faz com que seja
modi fi cada a cor ori gi nal da l i nha do objeto pel a cor de OverrideLineColor. Caso
contrri o, o objeto Fi gura exi bi r a cor ori gi nal . O val or padro desta propri edade
Fal se.
4.3.2.10.1.3 EnableSlider
A propri edade EnableSlider habi l i ta o slider no movi mento do objeto. Se a
propri edade esti ver habi l i tada, o slider do movi mento habi l i tado. Caso contrri o,
i sto no ocorre.
preenchi mento dos objetos no movi mento, ao i nvs da cor ori gi nal . Nos scri pts,
Exempl o:
Sub DrawGroup1_Click()
End Sub
Visualizao 159
objetos que esto em movi mento. El a al tera o modo ori gi nal de preenchi mento da
OPO DESCRIO
0 - NoOverride
1 - WireFrame
2 - SolidFill
no grupo ser sl i do com a cor
OverrideFillColor.
3 - ByBrightness
Exempl o:
Sub DrawGroup1_Click()
End Sub
l i nha do objeto em movi mento, ao i nvs da cor ori gi nal . Nos scri pts, uti l i ze a
val or padro desta propri edade vermel ho (RGB(255, 0, 0)). Exempl o:
Sub Grupo1_Click()
OverrideLineColor = RGB(255, 0, 0)
End Sub
4.3.2.10.1.7 RangeMax
Atravs da propri edade RangeMax determi nado o al cance mxi mo do
movi mento l i near no objeto.
160 Visualizao
4.3.2.10.1.8 RangeMin
Atravs da propri edade RangeMin determi nado o al cance mni mo do movi mento
l i near no objeto.
4.3.2.10.1.9 Value
o val or i ni ci al do movi mento. Deve ser um val or entre os val ores nas
propri edades RangeMax e RangeMin.
4.3.2.11 Animao com Rotao
Esta seo contm i nformaes sobre propriedades do objeto Ani mao com
Rotao. Este objeto no possui eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades do objeto Ani mao com
Rotao.
4.3.2.11.1.1 Detents
Atravs da propri edade Detents determi nado o nmero de passos do
movi mento no objeto.
propri edade EnableOverrideLineColor esti ver habi l i tada, faz com que seja
modi fi cada a cor ori gi nal da l i nha do objeto pel a cor da propri edade
OverrideLineColor. Caso contrri o, o objeto exi bi r a cor ori gi nal . O val or padro
4.3.2.11.1.3 EnableSlider
A propri edade EnableSlider habi l i ta o slider no movi mento do objeto.
preenchi mento dos objetos no movi mento, ao i nvs da cor ori gi nal . Nos scri pts,
Visualizao 161
objetos que esto em movi mento. El a al tera o modo ori gi nal de preenchi mento da
OPO DESCRIO
0 - NoOverride
1 - WireFrame
2 - SolidFill
OverrideFillColor.
3 - ByBrightness
l i nha do objeto em movi mento, ao i nvs da cor ori gi nal . Nos scri pts, uti l i ze a
val or padro desta propri edade vermel ho (RGB(255, 0, 0)).
4.3.2.11.1.7 RangeMax
Atravs da propri edade RangeMax determi nado o al cance mxi mo do
movi mento rotaci onal no objeto.
4.3.2.11.1.8 RangeMin
Atravs da propri edade RangeMin determi nado o al cance mni mo do movi mento
rotaci onal no objeto.
4.3.2.11.1.9 RotationAngle
Esta propri edade determi na o ngul o de rotao do movi mento no objeto.
162 Visualizao
4.3.2.11.1.10 RotationDirection
Atravs da propri edade RotationDirection determi nada a di reo do ngul o de
rotao do movi mento no objeto.
Opes disponveis para RotationDirection
OPO DESCRIO
0 - Clockwise
Di reci ona o ngul o de rotao a di rei ta
do objeto.
1 - CounterClockWise
Di reci ona o ngul o de rotao a
esquerda do objeto.
4.3.2.11.1.11 Value
o val or i ni ci al do movi mento. Deve ser um val or entre os val ores nas
propri edades RangeMax e RangeMin.
4.3.2.12 Microsoft Forms
Esta seo contm i nformaes sobre eventos e propriedades comuns de objetos
Mi crosoft Forms. Estes objetos no possuem mtodos comuns associ ados.
4.3.2.12.1 Eventos Comuns
Esta seo contm i nformaes sobre os eventos comuns aos objetos Mi crosoft
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 sol tar (drag-and-drop) sobre o objeto.
Uti l i za-se este evento para moni torar se o mouse entrou, dei xou ou fi cou sobre um
objeto al vo. O evento di sparado quando o usuri o move o mouse ou pressi ona ou
sol ta al gum boto do mouse. A posi o do pontei ro do mouse vai i ndi car qual o
objeto que i r gerar o evento. Pode-se determi nar o status do pontei ro do mouse
exami nando a vari vel DragState.
Mui tos objetos no suportam operaes de arrastar e sol tar enquanto a vari vel
Cancel Fal se, que o padro. Isso si gni fi ca que o objeto rejei ta qual quer tentati va
de arrastar ou sol tar al gum outro objeto sobre si e consequentemente, no di spara
o evento BeforeDropOrPaste. O objeto Text Box (cai xa de texto) e o objeto Combo
(cai xa de sel eo) so excees; el as acei tam operaes de arrastar e sol tar
mesmo quando Cancel Fal se.
Visualizao 163
Variveis do evento BeforeDragOver
NOME DESCRIO
Index
I ndi ca o ndi ce da pgi na, em um objeto
mul ti -pgi nas, que ser afetada pel a
operao que gerou o evento. Para outros
objetos i gnorada.
Cancel
Status do evento. O padro Fal se e i ndi ca
que ser o objeto al vo que tratar o evento,
e no a apl i cao pri nci pal .
Data
Dados sendo arrastados para o objeto al vo,
propri amente di tos.
X, Y
Posi o do mouse dentro do objeto al vo,
em pontos. X medi do a parti r do l ado
esquerdo do objeto; Y medi do a parti r do
topo.
DragState
I ndi ca a condi o do mouse quando
gerado o evento:
0 - fmDragStateEnter: o mouse est dentro
do al cance do objeto
1 - fmDragStateLeave: o mouse est fora
2 - fmDragStateOver: o mouse est em
uma nova posi o, mas ai nda est
dentro do al cance do objeto
Effect
I ndi ca as aes que o objeto al vo suporta,
ou seja, o efei to de arrastar sobre o objeto
em questo:
0 - fmDropEffectNone: objeto al vo no
acei ta copi ar ou mover de al guma ori gem
1 - fmDropEffectCopy: objeto al vo permi te
copi ar de al guma ori gem para si
2 - fmDropEffectMove: objeto al vo permi te
mover de al guma ori gem para si
3 - fmDropEffectCopyOrMove: objeto al vo
permi te copi ar ou mover de al guma
ori gem para si
Shift
I ntei ro cuja soma dos fatores i ndi ca o
status das tecl as SHI FT, CTRL e ALT:
1: tecl a SHI FT pressi onada
2: tecl a CTRL pressi onada
4: tecl a ALT pressi onada
Por exempl o, um val or i gual a 5 i ndi ca que
as tecl as SHI FT e ALT estavam
pressi onadas (1 + 4 = 5).
164 Visualizao
4.3.2.12.1.2 BeforeDropOrPaste
BeforeDropOrPaste(Index, Cancel, Ctrl, Action, Data, X, Y, Effect, Shift)
Di sparado no momento i medi atamente anteri or a uma operao de arrastar e
sol tar. Normal mente, i sto ocorre l ogo aps o evento BeforeDragOver.
Variveis do evento BeforeDropOrPaste
NOME DESCRIO
Index
I ndi ca o ndi ce da pgi na, em um objeto
mul ti -pgi nas, que ser afetada pel a
operao que gerou o evento. Para outros
objetos i gnorada.
Cancel
Status do evento. O padro Fal se e i ndi ca
que ser o objeto al vo que tratar o evento,
e no a apl i cao pri nci pal .
Ctrl
Objeto al vo.
Data
Dados sendo arrastados para o objeto al vo,
propri amente di tos.
Action
I ndi ca o resul tado, baseado nas
confi guraes do tecl ado, de uma operao
arrastar e sol tar pendente:
2 - fmActionPaste: col a o objeto
sel eci onado no objeto al vo
3 - fmActionDragDrop: i ndi ca que o
usuri o arrastou o objeto sel eci onado
de sua ori gem e sol tou-o sobre o objeto
al vo
X, Y
Posi o do mouse dentro do objeto al vo,
em pontos. X medi do a parti r do l ado
esquerdo do objeto; Y medi do a parti r do
topo.
DragState
I ndi ca a condi o do mouse quando
gerado o evento:
0 - fmDragStateEnter: o mouse est dentro
1 - fmDragStateLeave: o mouse est fora
2 - fmDragStateOver: o mouse est em
uma nova posi o, mas ai nda est
dentro do al cance do objeto
Visualizao 165
NOME DESCRIO
Effect
I ndi ca as aes que o objeto al vo suporta,
ou seja, o efei to de arrastar sobre o objeto
em questo:
0 - fmDropEffectNone: objeto al vo no
acei ta copi ar ou mover de al guma ori gem
1 - fmDropEffectCopy: objeto al vo permi te
copi ar de al guma ori gem para si
2 - fmDropEffectMove: objeto al vo permi te
mover de al guma ori gem para si
3 - fmDropEffectCopyOrMove: objeto al vo
permi te copi ar ou mover de al guma
ori gem para si
Shift
I ntei ro cuja a soma dos fatores i ndi ca o
status das tecl as SHI FT, CTRL e ALT:
1: tecl a SHI FT pressi onada
2: tecl a CTRL pressi onada
4: tecl a ALT pressi onada
Por exempl o, um val or i gual a 5 i ndi ca que
as tecl as SHI FT e ALT estavam
pressi onadas (1 + 4 = 5).
4.3.2.12.1.3 Change
Change()
Ocorre quando o val or da propri edade Value do objeto modi fi cada. A segui r esto
al guns exempl os de aes que di sparam o evento Change:
Cl i car em uma Cai xa de Sel eo, em um Boto de Opes ou Boto Incremento-
Decremento
Cl i car ou sel eci onar pal avras em uma Li sta de Sel eo ou Edi tor de Texto
Sel eci onar di ferentes abas em uma cai xa de di l ogo
Mover a barra de rol agem em um objeto Barra de Rol agem
Cl i car nas setas de um Boto Incremento-Decremento
Sel eci onar di ferentes pgi nas em um objeto mul ti -pgi nas
4.3.2.12.1.4 KeyPress
KeyPress(KeyAscii)
Ocorre quando o objeto tem o foco de tecl ado e o usuri o pressi ona uma tecl a que
corresponde a um caractere que pode ser mostrado em tel a (uma tecl a ANSI, de
cdi go i ndi cado na vari vel KeyAscii). Ou seja, o evento ocorre quando al guma das
tecl as a segui r so pressi onadas:
166 Visualizao
Qual quer caractere do tecl ado que possa ser i mpresso
Tecl a CTRL combi nada com qual quer caractere do al fabeto padro
Tecl a CTRL combi nada com qual quer caractere especi al
Tecl a BACKSPACE
Tecl a ESC
Este evento no ocorre nas segui ntes condi es:
Pressi onando a tecl a TAB
Pressi onando a tecl a ENTER
Pressi onando a tecl a DEL (essa tecl a no padro ANSI)
Pressi onando as setas do tecl ado
Quando uma tecl a faz com que o foco v de um objeto a outro
Enquanto um usuri o pressi ona uma tecl a que produz um cdi go ANSI, o objeto
recebe os eventos KeyDown e KeyPress repeti damente. Quando o usuri o l i bera a
tecl a, o evento KeyUp ocorre. Para moni torar o estado fsi co do tecl ado ou
mani pul ar tecl as no reconheci das pel o evento KeyPress (como tecl as de funo,
navegao, etc.), uti l i za-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 i nterno no objeto. Se este evento no for tratado, o E3 i r
mostrar uma mensagem de erro genri ca.
Variveis do evento OnError
NOME DESCRIO
Number
Nmero i ntei ro i denti fi cador do erro.
Description
String com a descri o do erro.
SCode
I ntei ro com o cdi go de erro do
subsi stema OLE (no uti l i zado).
Source
String com o objeto que ori gi nou o erro.
HelpFile
String com o nome e o cami nho do
arqui vo de ajuda.
HelpContext
Nmero de contexto do tpi co de ajuda
referente ao erro (i ntei ro).
CancelDisplay
Bool eano. I ndi ca se o erro deve ser
mostrado em uma cai xa de mensagem.
Visualizao 167
Esta seo contm i nformaes sobre as propri edades comuns aos objetos
Mi crosoft Forms.
4.3.2.12.2.1 BackColor
Determi na a cor de fundo do objeto. Nos scri pts, uti l i ze a funo do VBScri pt RGB
para montar a cor a ser associ ada a esta propri edade. O val or padro desta
propri edade para os objetos Li sta de Sel eo, Li sta e Edi tor de Texto a cor branca
(RGB(255, 255, 255)), e para os demai s objetos a cor bege (RGB(236, 233, 216)).
4.3.2.12.2.2 ForeColor
Especi fi ca a cor do preenchi mento do fundo do objeto. Nos scri pts, uti l i ze a
funo do VBScri pt RGB para formar a cor a ser associ ada a esta propri edade. O
val or padro desta propri edade para todos os objetos MSForms a cor preta (RGB
(0, 0, 0)).
4.3.2.12.2.3 MouseIcon
A propri edade MouseIcon atri bui uma i magem ao pontei ro do mouse, quando
este movi do sobre o objeto. Esta propri edade vl i da somente quando a
propri edade MousePointer defi ni da como 99 - fmMousePointerCustom.
Um arqui vo com i magem pode ser sel eci onado para o pontei ro do mouse de duas
formas: atravs da Li sta de Propri edades (extenses .cur ou .i co); ou vi a scri pts,
uti l i zando-se a funo LoadPicture para especi fi car o cami nho e o nome do arqui vo
que contm o cone personal i zado (somente extenso .cur). Exempl o:
' 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 propri edade MousePointer especi fi ca o ti po de pontei ro do mouse que
mostrado quando o usuri o posi ci ona o mesmo sobre um objeto. As opes
di sponvei s para esta propri edade so as segui ntes:
168 Visualizao
Opes disponveis para MousePointer
OPO DESCRIO
0 - fmMousePointerDefault
Pontei ro padro. A i magem
determi nada pel o objeto.
1 - fmMousePointerArrow
Seta.
2 - fmMousePointerCross
Pontei ro em forma de cruz.
3 - fmMousePointerBeam
Em forma de I .
6 - fmMousePointerSizeNesw
Seta dupl a apontando para nordeste e
sudoeste.
7 - fmMousePointerSizeNS
Seta dupl a apontando para norte e sul .
8 - fmMousePointerNWse
Seta dupl a apontando para noroeste e
sudeste.
9 - fmMousePointerWE
Seta dupl a apontando para oeste e
l este.
10 - fmMousePointerUpArrow
Seta para ci ma.
11 - MousePointerStarHourGlassring
Ampul heta.
12 - fmMousePointerHelpNoDrop
Smbol o de Not (crcul o com uma l i nha
di agonal ) na parte superi or do objeto
sendo arrastado. I ndi ca um desti no de
sol tar i nvl i do.
13 - fmMousePointerAppStarting
Seta com uma ampul heta.
14 - fmMousePointerHelp
Seta com um ponto de i nterrogao.
15 - fmMousePointerSizeAll
Di mensi ona todo o cursor (setas
apontando para norte, sul , l este e
oeste).
99 - fmMousePointerCustom
Usa o cone especi fi cado pel a
propri edade MouseIcon.
Use a propri edade MousePointer para i ndi car al teraes de funci onal i dade
conforme o pontei ro do mouse passar sobre os objetos em uma Tel a. Por exempl o,
a confi gurao de ampul heta (opo 11) ti l para i ndi car que o usuri o preci sa
esperar al gum tempo um processo ou operao ser fi nal i zado. Al guns cones
podem vari ar, dependendo das confi guraes do si stema, como os cones
associ ados aos temas da rea de trabal ho. O val or padro desta propri edade 0 -
fmMousePointerDefault.
4.3.2.12.3 Caixa de Seleo
Esta seo contm i nformaes sobre propriedades do objeto Cai xa de Sel eo.
Esta seo contm i nformaes sobre as propri edades do objeto Cai xa de Sel eo.
Visualizao 169
Accelerator
Defi ne ou recupera a tecl a acel eradora do objeto. Esta tecl a acel eradora uma
tecl a de atal ho que, usada em conjunto com a tecl a ALT, d o foco ao objeto. O
val or padro desta propri edade vazi o.
Alignment
A propri edade Alignment especi fi ca a posi o do objeto rel ati va a sua l egenda.
As opes di sponvei s para esta propri edade so as segui ntes:
0 - fmAlignmentLeft: col oca a l egenda esquerda do objeto
1 - fmAligmentRight: col oca a l egenda di rei ta do objeto
AutoSize
A propri edade AutoSize ajusta a l argura do texto, caso a rea di sponvel para o
mesmo ul trapasse o tamanho do objeto. Quando a propri edade esti ver confi gurada
para True, o texto ser redi mensi onado para coi nci di r com o tamanho atual do
objeto.
BackStyle
A propri edade BackStyle defi ne o esti l o do pl ano de fundo para os objetos. As
opes di sponvei s para esta propri edade so as segui ntes:
0 - fmBackStyleTransparent: defi ne o objeto como transparente, i sto , nenhum
fundo deste objeto ser desenhado
1 - fmBackStyleOpaque: defi ne o objeto como opaco, i sto , o fundo ser
desenhado (val or padro)
NOTA: Esta propri edade no afeta a transparnci a de bi tmaps. Deve-se usar um
edi tor de i magens como o Pai ntbrush, por exempl o, para tornar um bi tmap
transparente. Nem todos os objetos Acti veX suportam bi tmaps transparentes.
Caption
Defi ne o texto que ser mostrado no objeto.
Font
A propri edade Font uti l i zada para determi nar a fonte do objeto. Esta
propri edade no pode ser uti l i zada em scri pts ou em Associ aes, sendo
confi gurada uni camente vi a Studi o.
GroupName
A propri edade GroupName uti l i zado para cri ar um grupo de objetos
mutuamente excl usi vos.
170 Visualizao
NOTA: Esta propri edade no uti l i zada no E3 e foi manti da por moti vos de
compati bi l i dade com a especi fi cao padro dos objetos Mi crosoft Forms.
Locked
A propri edade Locked habi l i ta ou desabi l i ta a edi o do objeto. Se esta
propri edade esti ver confi gurada para True, a edi o no permi ti da. Caso
contrri o, possvel edi tar o objeto. Os val ores confi gurados na propri edade
Enabled i nfl uenci am o comportamento de Locked. Para mai ores detal hes, consul te
a propri edade Enabled. O val or padro desta propri edade Fal se.
Picture
A propri edade Picture especi fi ca a fi gura (bi tmap) atri buda ao objeto. Um
arqui vo com i magem pode ser sel eci onado de duas manei ras: atravs da Li sta de
Propri edades ou vi a scri pts, uti l i zando-se a funo LoadPicture para especi fi car o
cami nho e o nome do arqui vo que contm a fi gura. Para remover a fi gura, cl i que no
val or da propri edade Picture e pressi one a tecl a DEL. A tecl a BACKSPACE (tecl a de
espao do tecl ado) no remove a fi gura. Exempl o:
Screen.Item("CheckBox1").Picture = LoadPicture("C:\aba.gif")
End Sub
PicturePosition
A propri edade PicturePosition especi fi ca a posi o da fi gura atri buda ao objeto
em rel ao a sua l egenda. As opes di sponvei s para esta propri edades so as
segui ntes:
OPO DESCRIO
0 - fmPicturePositionLeftTop
A fi gura aparece esquerda de sua
l egenda. A l egenda al i nhada com a
parte superi or da fi gura.
1 - fmPicturePositionLeftCenter
A fi gura aparece esquerda da
l egenda. A l egenda central i zada
rel ati vamente i magem.
2 - fmPicturePositionLeftBotton
parte i nferi or da fi gura.
3 - fmPicturePositionRightTop
A fi gura aparece di rei ta da l egenda. A
l egenda al i nhada com a parte
superi or da fi gura.
4 - fmPicturePositionRightCenter
l egenda central i zada rel ati vamente
fi gura.
5 - fmPicturePositionRightBotton
l egenda al i nhada com a parte i nferi or
da fi gura.
Visualizao 171
OPO DESCRIO
6 - fmPicturePositionAboveLeft
A fi gura aparece aci ma da l egenda. A
l egenda al i nhada com a extremi dade
esquerda da fi gura.
7 - fmPicturePositionAboveCenter
l egenda central i zada abai xo da fi gura
(padro).
8 - fmPicturePositionAboveRight
di rei ta da fi gura.
9 - fmPicturePositionBelowLeft
A fi gura aparece abai xo da l egenda. A
10 - fmPicturePositionBelowCenter
l egenda central i zada aci ma da fi gura.
11 - fmPicturePositionBelowRight
SpecialEffect
A propri edade SpecialEffect especi fi ca a aparnci a de um objeto. As opes
Opes disponveis para SpecialEffect
OPO DESCRIO
0 - fmButtonEffectFlat
O objeto aparece pl ano e possui um
destaque na borda, uma al terao de cor
ou ambos.
2 - fmButtonlEffectSunken
O objeto possui uma sombra na parte
superi or esquerda e um destaque na
parte i nferi or di rei ta, como se esti vesse
afundado na Tel a.
TextAlign
Especi fi ca como o texto al i nhado no objeto. As opes di sponvei s so as
segui ntes:
1 - fmTextAlignLeft: al i nha o texto com a extremi dade esquerda do objeto
2 - fmTextAlignCenter: central i za o texto com a extremi dade di rei ta do objeto
3 - fmTextAlignRight: al i nha o texto com a extremi dade di rei ta do objeto
TripleState
A propri edade TripleState determi na at trs estados de val ores para o objeto. Se
a propri edade esti ver confi gurada para True, o usuri o poder escol her entre trs
opes de estados: Fal so, verdadei ro ou Nul o. O val or Nul o exi bi do como um
boto sombreado. Caso contrri o, o usuri o pode escol her entre os val ores Fal se
172 Visualizao
ou True. O val or padro desta propri edade Fal se.
Value
Indi ca o val or i ni ci al do objeto. Tem comportamento Bool eano; se True, o objeto
i ni ci a marcado, do contrri o, seu estado i ni ci al no marcado. O val or padro
WordWrap
o texto ul trapasse os l i mi tes determi nados no objeto.
4.3.2.12.4 Boto de Opo
Esta seo contm i nformaes sobre propriedades do objeto Boto de Opo. Este
Esta seo contm i nformaes sobre as propri edades do objeto Boto de Opo.
Accelerator
Alignment
A propri edade Alignment especi fi ca a posi o do objeto rel ati va a sua l egenda.
AutoSize
A propri edade AutoSize ajusta a l argura do texto, caso a rea di sponvel para o
mesmo ul trapasse o tamanho do objeto. Quando a propri edade esti ver confi gurada
para True, o texto ser redi mensi onado para coi nci di r com o tamanho atual do
objeto.
BackStyle
Visualizao 173
Caption
Font
GroupName
mutuamente excl usi vos.
Locked
Picture
espao do tecl ado) no remove a fi gura. Exempl o:
Screen.Item("OptionButton1").Picture = LoadPicture
("C:\aba.gif")
End Sub
PicturePosition
segui ntes:
174 Visualizao
OPO DESCRIO
2 - fmPicturePositionLeftBotton
fi gura.
5 - fmPicturePositionRightBotton
da fi gura.
(padro).
SpecialEffect
OPO DESCRIO
0 - fmButtonEffectFlat
ou ambos.
Visualizao 175
OPO DESCRIO
2 - fmButtonlEffectSunken
afundado na Tel a.
TextAlign
segui ntes:
TripleState
opes de estados: Fal so, Verdadei ro ou Nul o. O val or Nul o exi bi do como um
Value
Indi ca o val or i ni ci al do objeto. Tem comportamento Bool eano; se True, o objeto
WordWrap
4.3.2.12.5 Lista de Seleo
Li sta de Sel eo.
4.3.2.12.5.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Li sta de Sel eo.
DropButtonClick
DropButtonClick()
Ocorre quando a Li sta de Opes aparece ou desaparece ao se cl i car no objeto.
176 Visualizao
4.3.2.12.5.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Li sta de Sel eo.
AddItem
AddItem([pvargItem[, pvargIndex]])
O mtodo AddItem uti l i zado para se adi ci onar i tens a uma Li sta de Sel eo.
pvargItem uma String que contm o texto que ser adi ci onado na l i sta; se for
omi ti do, ser acrescentada uma String em branco. pvargIndex o ndi ce do texto na
l i sta; se for omi ti do, pvargItem adi ci onado como l ti mo i tem da l i sta. Exempl o:
EntryCount = EntryCount + 1
ComboBox1.AddItem(EntryCount & " - Selection")
End Sub
Clear
Clear()
Li mpa o texto do objeto.
Copy
Copy()
Copi a o texto previ amente sel eci onado para a rea de Transfernci a. Uti l i ze o
mtodo Paste para col ar o texto no l ocal i ndi cado. Exempl o:
Screen.Item("ComboBox1").Copy()
End Sub
Cut
Cut()
Recorta o texto previ amente sel eci onado para a rea de Transfernci a. Uti l i ze o
mtodo Paste para col ar o texto no l ocal i ndi cado. Exempl o:
Screen.Item("ComboBox1").Cut()
End Sub
DropDown
DropDown()
O mtodo DropDown abre a l i sta de i tens de uma Li sta de Sel eo. A chamada deste
mtodo tem o mesmo efei to que cl i car, em tempo de execuo, no boto com a seta
ao l ado di rei to do objeto. Exempl o:
Dim ComboBox1
ComboBox1.AddItem "Abacaxi"
Visualizao 177
ComboBox1.AddItem "Morango"
ComboBox1.AddItem "Uva"
ComboBox1.AddItem "Laranja"
ComboBox1.DropDown()
End Sub
Paste
Paste()
Insere no objeto o contedo da rea de Transfernci a. Exempl o:
Screen.Item("ComboBox1").Paste()
End Sub
RemoveItem
RemoveItem(pvargIndex)
Remove i tens de uma Li sta ou de uma Li sta de Sel eo. Este mtodo possui o
parmetro pvargIndex, que especi fi ca a l i nha que ser excl uda, i ni ci ando em zero.
Ou seja, o pri mei ro el emento 0, o segundo 1, e assi m por di ante. Exempl o:
ComboBox1.SetFocus
' 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
Esta seo contm i nformaes sobre as propri edades do objeto Li sta de Sel eo.
AutoSize
A propri edade AutoSize ajusta a l argura do texto, caso a rea di sponvel
ul trapasse o tamanho do objeto. Para o objeto Li sta de Sel eo (Combo Box),
quando a propri edade esti ver confi gurada para True, a l argura do texto
reajustada para a mesma do objeto.
AutoTab
A propri edade AutoTab habi l i ta ou desabi l i ta a tabul ao automti ca no objeto.
Se a propri edade esti ver confi gurada para True, a tabul ao automti ca ocorre.
Caso contrri o, no uti l i zada.
Aps o usuri o di gi tar o nmero mxi mo de caracteres em um objeto (uti l i zando a
178 Visualizao
propri edade MaxLength), o foco se move automati camente para o prxi mo objeto
da ordem de tabul ao, quando estes caracteres forem ati ngi dos. Por exempl o,
para que uma Li sta de Sel eo exi ba dados de estoque que possuam sempre ci nco
caracteres, pode-se usar a propri edade MaxLength para especi fi car o nmero
mxi mo de caracteres a serem i ntroduzi dos no objeto e a propri edade AutoTab
para tabul ar automati camente para o prxi mo objeto depoi s que o usuri o di gi tar
ci nco caracteres.
AutoWordSelect
Habi l i ta ou desabi l i ta a sel eo automti ca de pal avras no objeto. Se esta
propri edade esti ver confi gurada para True, a pal avra i ndi cada sel eci onada no
texto mai s o espao segui nte, caso se tenha sel eci onado parte del a. Caso contrri o,
somente o caractere i ndi cado na pal avra sel eci onado.
BackStyle
BorderColor
Esta propri edade determi na a cor da borda que ser apl i cada no objeto. Com
esta propri edade, possvel apl i car a cor padro ou personal i z-l a atravs da sua
edi o. Para que esta propri edade seja apl i cvel , necessri o que a propri edade
BorderStyle esteja confi gurada para 1 - fmBorderStyleSingle. O val or padro desta
BorderStyle
objeto. As opes di sponvei s so:
0 - fmBorderStyleNone: sem borda
1 - fmBorderStyleSingle: com borda si mpl es
BoundColumn
Determi na a col una da l i sta onde os dados sero armazenados. Por exempl o, se
cada l i nha contm oi to i tens e a propri edade BoundColumn 3, o si stema
armazena as i nformaes na tercei ra col una da l i nha atual mente sel eci onada. Se o
Visualizao 179
val or for i gual a 0, este val or passado para a propri edade ListIndex do objeto. Se
o val or for 1 ou superi or, o dado i ndi cado atri budo col una referente ao val or
especi fi cado na propri edade. As col unas so numeradas a parti r de 1.
NOTA: Esta propri edade no tem efei to no E3 e foi manti da por moti vos de
CanPaste
A propri edade CanPaste especi fi ca se a rea de Transfernci a contm os dados
aos quai s o objeto d suporte. Se a opo esti ver confi gurada para True, o objeto
pode receber i nformaes col adas da rea de Transfernci a. Se os dados da rea
de Transfernci a esti verem em um formato ao qual o objeto no d suporte, a
propri edade CanPaste ser Fal se. Por exempl o, ao tentar col ar um bi tmap em um
objeto que s d suporte a texto, CanPaste ser Fal se. Esta propri edade acessvel
apenas em tempo de execuo.
Column
Especi fi ca a l i nha e a col una no objeto. Se for especi fi cado somente o val or de
col una, a propri edade Column l ou escreve a col una especi fi cada na l i nha atual
do objeto. Por exempl o, MinhaListadeSelecao.Column(3) l ou escreve a
tercei ra col una do objeto. Esta propri edade acessvel apenas em tempo de
execuo.
ColumnCount
A propri edade ColumnCount especi fi ca o nmero de col unas do objeto. A
confi gurao de ColumnCount como 0 no exi be nenhuma col una, e a confi gurao
desta propri edade como -1 exi be todas as col unas di sponvei s. O val or padro
desta propri edade 1.
ColumnHeads
A propri edade ColumnHeads habi l i ta ou desabi l i ta a exi bi o do ttul o das
col unas no objeto. Se a propri edade esti ver confi gurada para True, o ttul o
mostrado. Caso contrri o, o ttul o das col unas no mostrado. O val or padro
Fal se.
ColumnWidths
A propri edade ColumnWidths uti l i zada para especi fi car a l argura da col una
do objeto, em pontos. Um val or i gual a 1 ou em branco faz com que a l argura seja
cal cul ada na col una (a l argura mni ma de uma col una cal cul ada 72 pontos, ou 1
pol egada). Um val or i gual a 0 ocul ta a col una. Para produzi r col unas mai s
estrei tas, deve-se especi fi car a l argura na propri edade ou uti l i zar al guma dos
val ores a segui r:
180 Visualizao
Opes disponveis para ColumnWidths
OPO DESCRIO
90;72;90
A pri mei ra col una possui 90 pontos (1,25
pol egada); a segunda col una possui 72
pontos (1 pol egada); a tercei ra col una
possui 90 pontos.
6 cm;0;6 cm
A pri mei ra col una possui 6 centmetros; a
segunda col una est ocul ta; a tercei ra
col una possui 6 centmetros. Como parte
da tercei ra col una vi svel , uma barra de
rol agem hori zontal aparece.
1,5 pol;0;2,5 pol
A pri mei ra col una possui 1,5 pol egadas,
a segunda col una est ocul ta, e a
tercei ra col una possui 2,5 pol egadas.
2 pol;;2 pol
A pri mei ra col una possui 2 pol egadas, a
segunda col una possui 1 pol egada
(padro) e a tercei ra col una possui 2
pol egadas. Como somente metade da
tercei ra col una vi svel , uma barra de
(Vazio)
Todas as trs col unas possuem a mesma
l argura (1,33 pol egadas). O val or padro
desta propri edade vazi o (o E3 i r
uti l i zar o val or padro do si stema).
CurTargetX
Retorna a posi o hori zontal de i nsero de um texto no objeto. Esta posi o
medi da em uni dades hi mtri cas (um hi metro i gual a 0,0001 de um metro). Pode-
se usar CurTargetX e CurX para mover o ponto de i nsero de um texto conforme o
usuri o percorre o contedo do objeto. Quando o usuri o move o ponto de
i nsero para outra l i nha do texto, a propri edade CurTargetX especi fi ca a posi o
mai s i ndi cada para o ponto de i nsero do texto desejado. A propri edade CurX
defi ni da neste val or, se a l i nha do texto for mai or que o val or de CurTargetX. Caso
contrri o, a propri edade CurX defi ni da como o fi nal da l i nha do texto. Esta
CurX
A propri edade CurX especi fi ca a posi o atual hori zontal do ponto de i nsero no
objeto. Esta propri edades apl i cada em um objeto que possua vri as l i nhas, i sto ,
a propri edade Multiline est habi l i tada. O val or de retorno vl i do quando o
objeto possui o foco. Pode-se usar a propri edade Multiline e a propri edade CurX
para posi ci onar o ponto de i nsero do texto conforme o usuri o usa a barra de
rol agem pel o contedo do objeto. Quando o usuri o move o ponto de i nsero para
Visualizao 181
uma outra l i nha de texto rol ando o contedo do objeto, a propri edade CurTargetX
especi fi ca a posi o desejada para o ponto de i nsero. A propri edade CurX
defi ni da com este val or se a l i nha de texto for mai or do que o val or de CurTargetX.
Caso contrri o, CurX defi ni do no fi m da l i nha de texto. Esta propri edade
acessvel apenas em tempo de execuo.
DragBehavior
Habi l i ta ou desabi l i ta o recurso de arrastar e sol tar um texto no contedo do
objeto. As opes di sponvei s para esta propri edade so as segui ntes:
0 - fmDragBehaviorDisabled: no permi te a ao de arrastar e sol tar o texto no
contedo do objeto
1 - fmDragBehaviorEnabled: permi te a ao de arrastar e sol tar o texto no
contedo do objeto
O val or padro desta propri edade 0 - fmDragBehaviorDisabled.
NOTA: A propri edade DragBehavior no tem efei to se a propri edade Style esti ver
confi gurada para 2 - fmStyleDropDownList.
DropButtonStyle
Esta propri edade especi fi ca o smbol o exi bi do no boto da Li sta de Sel eo. As
Opes disponveis para DropButtonStyle
OPO DESCRIO
0 - fmDropButtonStylePlain
Exi be um boto pl ano, sem smbol o.
1 - fmDropButtonStyleArrow
Exi be um seta para bai xo (padro).
2 - fmDropButtonStyleEllipsis
Exi be reti cnci as.
3 - fmDropButtonStyleReduce
Exi be uma reta hori zontal como um
caractere subl i nhado.
O val or padro desta propri edade 1 - fmDropButtonStyleArrow.
EnterFieldBehavior
Esta propri edade control a a forma como o contedo do texto sel eci onado na
rea de edi o quando se pressi ona a tecl a TAB no objeto, e no quando o objeto
recebe o foco como um resul tado do mtodo SetFocus. As opes di sponvei s para
esta propri edade so as segui ntes:
0 - fmEnterFieldBehaviorSelectAll: sel eci ona todo o contedo do texto quando a
tecl a TAB pressi onada no objeto
1 - fmEnterFieldBehaviorRecallSelection: dei xa a sel eo i nal terada
182 Visualizao
O val or padro desta propri edade 0 - fmEnterFieldBehaviorSelectAll.
Font
HideSelection
A propri edade HideSelection especi fi ca se o texto sel eci onado conti nua em
destaque quando um objeto no ti ver mai s o foco. Se a propri edade esti ver
confi gurada para True, o texto sel eci onado somente se mantm em destaque caso o
objeto tenha o foco. Caso contrri o, o texto sel eci onado sempre aparece em
destaque, i ndependente do foco no objeto. O val or padro desta propri edade
True.
IMEMode
A propri edade IMEMode especi fi ca o modo IME (Input Method Editor) de um
objeto.
NOTA: Essa propri edade apl i ca-se apenas em apl i cati vos escri tos em i di omas
asi ti cos (chi ns si mpl i fi cado, chi ns tradi ci onal , coreano e japons) e i gnorada
em outros apl i cati vos. Foi manti da por moti vos de compati bi l i dade com a
especi fi cao padro dos objetos Mi crosoft Forms.
As opes di sponvei s so as segui ntes:
Opes disponveis para IMEMode
OPO DESCRIO
0 - fmIMEModeNoControl
No control a I ME (padro).
1 - fmIMEModeOn
I ME ati vado.
2 - fmIMEModeOff
I ME desati vado. Modo i ngl s.
3 - fmIMEModeDisable
I ME desati vado. O usuri o no pode
ati var I ME pel o tecl ado.
4 - fmIMEModeHiragana
I ME ati vado com modo Hi ragana de
l argura total .
5 - fmIMEModeKatakanaFull
I ME ati vado com modo Katakana de
l argura total .
6 - fmIMEModeKatakana
I ME ati vado com modo Katakana de mei a
l argura.
7 - fmIMEModeAlphaFull
I ME ati vado com modo Al fanumri co de
l argura total .
8 - fmIMEModeAlpha
mei a l argura.
9 - fmIMEModeHangulFull
I ME ati vado com modo Hangul de l argura
total .
Visualizao 183
OPO DESCRIO
10 - fmIMEModeHangul
I ME ati vado com modo Hangul de mei a
l argura.
11 - fmIMEModeHanziFull
I ME ati vado com modo Hanzi de l argura
total .
12 - fmIMEModeHanzi
I ME ati vado com modo Hanzi de mei a
l argura.
LineCount
A propri edade LineCount retorna o nmero de l i nhas do objeto. Esta propri edade
List
Retorna ou defi ne as entradas da l i nha e da col una na l i sta do objeto. A
numerao de l i nha e de col una comea com zero. Isto , o nmero de l i nha da
pri mei ra l i nha na l i sta zero; o nmero de col una da pri mei ra col una zero. O
nmero da segunda l i nha ou col una 1 e assi m por di ante. Esta propri edade
ListCount
Retorna o nmero de i tens conti dos na l i sta do objeto. Esta propri edade
ListIndex
Identi fi ca o i tem atual mente sel eci onado na l i sta, chamado de ndi ce. Os val ores
de ListIndex vo de 1 ao nmero total de l i nhas em uma l i sta menos um (i sto ,
ListCount 1). Quando nenhuma l i nha sel eci onada, ListIndex retorna 1. Quando
o usuri o sel eci ona uma l i nha em uma Li sta de Sel eo, o si stema defi ne o val or da
propri edade ListIndex. O val or da propri edade ListIndex da pri mei ra l i nha de uma
l i sta 0, o val or da segunda l i nha 1 e assi m por di ante. Esta propri edade
ListRows
A propri edade ListRows determi na o nmero mxi mo de l i nhas na l i sta do objeto.
ListStyle
A propri edade ListStyle determi na o esti l o da l i sta do objeto. As opes
0 - fmListStylePlain: l i stagem com os i tens do pl ano de fundo em destaque
1 - fmListStyleOption: exi be botes de opo ou cai xas de sel eo para uma l i sta
de vri as opes. Quando o usuri o sel eci ona um i tem do grupo, o boto de
opo associ ado ao i tem sel eci onado e os botes de opo para outros i tens
no grupo so desmarcados
184 Visualizao
O val or padro desta propri edade 0 - fmListStylePlain.
ListWidth
A propri edade ListWidth determi na a l argura da l i sta do objeto. O val or padro
Locked
MatchEntry
Procura, atravs do texto di gi tado pel o usuri o, por uma entrada de texto que
coi nci da com os dados exi stentes no objeto. Ao encontrar uma i nci dnci a do texto,
a l i nha contendo a mesma sel eci onada e o contedo da col una exi bi do.
As opes di sponvei s so as segui ntes:
0 - fmMatchEntryFirstLetter: procura pel a entrada de texto que coi nci da com o
pri mei ro caractere di gi tado no objeto. Se for di gi tada repeti damente a mesma
l etra, passada para a prxi ma entrada de texto que comece com esta l etra e
assi m por di ante
1 - fmMatchEntryComplete: conforme cada caractere di gi tado, o objeto
procura por uma entrada de texto que coi nci da com os caracteres di gi tados
2 - fmMatchEntryNone: no faz a procura no objeto
O val or padro desta propri edade 1 - fmMatchEntryComplete.
MatchFound
Indi ca se o texto que o usuri o di gi tou no objeto coi nci de com qual quer entrada
na l i sta. Se a propri edade esti ver confi gurada para True, o contedo da
propri edade Value coi nci de com um dos regi stros na l i sta. Caso contrri o, o
contedo da propri edade Value no coi nci de com nenhum dos regi stros na l i sta
(padro).
Esta propri edade acessvel apenas em tempo de execuo, no sendo apl i cvel
quando a propri edade MatchEntry defi ni da como 2. O val or padro desta
MatchRequired
Especi fi ca se o texto di gi tado deve ou no coi nci di r com os i tens exi stente na
Li sta de Sel eo. Se a propri edade esti ver confi gurada para True, o usuri o no
Visualizao 185
pode sai r da Li sta de Sel eo at que o texto i nseri do coi nci da com um i tem
exi stente do objeto. Caso contrri o, o texto i nseri do na Li sta de Sel eo pode ser
di ferente de todos os dados exi stente na Li sta.
MaxLength
A propri edade MaxLength determi na o nmero mxi mo de caracteres no objeto.
Confi gurando esta propri edade como 0, no h l i mi te de caracteres no objeto.
SelectionMargin
Habi l i ta ou desabi l i ta a margem de sel eo do objeto. Se esta propri edade
esti ver confi gurada para True, o texto ser sel eci onado ao se cl i car na margem do
objeto. Caso contrri o, o texto no ser sel eci onado ao se cl i car na margem.
NOTA: Se a propri edade SelectionMargin esti ver confi gurada para True quando o
objeto for i mpresso, a margem de sel eo tambm ser i mpressa.
SelLength
Retorna o nmero de caracteres sel eci onados no objeto. Esta propri edade
SelStart
Indi ca o ponto i ni ci al do texto sel eci onado ou o ponto de i nsero se nenhum
texto for sel eci onado. Esta propri edade acessvel apenas em tempo de execuo.
SelText
Retorna o texto sel eci onado no objeto. Esta propri edade acessvel apenas em
tempo de execuo.
ShowDropButtonWhen
A propri edade ShowDropButtonWhen especi fi ca quando mostrar o boto
suspenso (tecl a de navegao do objeto). As opes di sponvei s para esta
propri edade so as segui ntes:
0 - fmShowDropButtonWhenNever: no mostra o boto suspenso em nenhuma
ci rcunstnci a
1 - fmShowDropButtonWhenFocus: mostra o boto suspenso quando o objeto
possui o foco
2 - fmShowDropButtonWhenAlways: sempre mostra o boto suspenso
SpecialEffect
186 Visualizao
OPO DESCRIO
0 - fmSpecialEffectFlat
ou ambos.
1 - fmSpecialEffectRaised
O objeto possui um destaque na parte
superi or esquerda e uma sombra na
em rel evo.
2 - fmSpecialEffectSunken
parte i nferi or di rei ta. O objeto e a sua
borda aparecem afundados na Tel a.
3 - fmSpecialEffectEtched
A borda parece estar escul pi da ao redor
da extremi dade do objeto.
6 - fmSpecialEffectBump
O objeto possui um ressal to na parte
i nferi or di rei ta e parece pl ano na parte
superi or esquerda.
Style
Determi na o esti l o do objeto. As opes di sponvei s so as segui ntes:
0 - fmStyleDropDownCombo: a l i sta de sel eo se comporta como uma cai xa de
combi nao suspensa. O usuri o pode di gi tar um val or na regi o de edi o ou
sel eci onar um val or da l i sta suspensa (padro)
2 - fmStyleDropDownList: a Li sta de sel eo se comporta como uma cai xa de
l i stagem. O usuri o deve escol her um val or da l i sta
Text
Retorna o texto da opo sel eci onada. Esta propri edade acessvel apenas em
tempo de execuo.
TextAlign
segui ntes:
2 - fmTextAlignCenter: central i za o texto com o centro do objeto
TextColumn
A propri edade TextColumn i denti fi ca a col una no objeto. Os val ores para a
propri edade TextColumn vo de -1 ao nmero de col unas na l i sta. O val or
TextColumn para a pri mei ra col una 1, o val or da segunda col una 2, e assi m por
di ante. A confi gurao de TextColumn como 0 exi be os val ores para a propri edade
Visualizao 187
ListIndex. A confi gurao de TextColumn como -1 exi be a pri mei ra col una que
possui o val or da propri edade ColumnWidths mai or do que 0.
TextLength
Retorna o nmero de caracteres di gi tados no objeto. Esta propri edade acessvel
TopIndex
A propri edade TopIndex defi ne ou retorna o i tem da l i sta que aparece na posi o
mai s prxi ma do topo na l i sta. Esta propri edade retorna o val or -1 se a l i sta est
vazi a ou no exi bi da.
Value
o val or da propri edade BoundColumn das l i nhas atual mente sel eci onadas. Uma
mudana de val or na propri edade Value no i mpl i ca em mudana de val or na
propri edade BoundColumn. Para adi ci onar ou apagar entradas em uma l i sta de
sel eo, pode-se usar os mtodos AddItem ou RemoveItem.
4.3.2.12.6 Boto de Comando
Esta seo contm i nformaes sobre eventos e propriedades do objeto Boto de
Comando. Este objeto no possui mtodos associ ados.
4.3.2.12.6.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Boto de Comando.
MouseMove
MouseMove()
Ocorre quando o pontei ro do mouse movi mentado sobre o boto de comando.
Esta seo contm i nformaes sobre as propri edades do objeto Boto de
Comando.
Accelerator
tecl a de atal ho que usada em conjunto com a tecl a ALT, d o foco ao objeto. O val or
padro desta propri edade uma String vazi a.
AutoSize
ul trapasse o tamanho do objeto. Para o objeto Boto de Comando (Command
188 Visualizao
Button), quando a propri edade esti ver confi gurada para True, a l argura do texto
reajustada para a mesma do objeto. O contedo do texto cortado quando el e
excede a rea do objeto.
BackStyle
Caption
Font
Locked
Picture
espao do tecl ado) no remove a fi gura.
PicturePosition
segui ntes:
Visualizao 189
OPO DESCRIO
2 - fmPicturePositionLeftBottom
fi gura.
5 - fmPicturePositionRightBottom
da fi gura.
(padro).
TakeFocusOnClick
Especi fi ca se o objeto recebe o foco quando cl i cado. Se a propri edade esti ver
confi gurada para True, o objeto recebe o foco quando cl i cado. Caso contrri o, o
objeto no recebe o foco.
WordWrap
190 Visualizao
4.3.2.12.7 Texto
Esta seo contm i nformaes sobre propriedades do objeto Texto. Este objeto no
possui eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades do objeto Texto.
Accelerator
tecl a de atal ho que usada em conjunto com a tecl a ALT, d o foco ao objeto. O val or
AutoSize
ul trapasse o tamanho do objeto. Para o objeto Texto (Label ), quando a propri edade
esti ver confi gurada para True, o texto redi mensi onado para coi nci di r com o
tamanho atual do objeto, permi ti ndo assi m a sua exi bi o compl eta.
BackStyle
1 - fmBackStyleOpaque (valor padro): defi ne o objeto como opaco, i sto , o fundo
ser desenhado
BorderColor
BorderStyle
Visualizao 191
Caption
Font
Picture
cami nho e o nome do arqui vo que contm a fi gura. Para remover a fi gura, cl i que o
PicturePosition
segui ntes:
OPO DESCRIO
fi gura.
da fi gura.
192 Visualizao
OPO DESCRIO
(padro).
SpecialEffect
OPO DESCRIO
ou ambos.
parte i nferi or di rei ta. O objeto parece
estar em rel evo.
2 - fmSpecialEffectSunked
borda parecem estar afundados na Tel a.
superi or esquerda.
TextAlign
segui ntes:
Visualizao 193
WordWrap
4.3.2.12.8 Lista
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Li sta. Este
objeto no possui eventos associ ados.
4.3.2.12.8.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Li sta.
AddItem
AddItem([pvargItem[, pvargIndex]])
O mtodo AddItem uti l i zado para se adi ci onar i tens a uma Li sta. O parmetro
pvargItem uma String que contm o texto que ser adi ci onado l i sta; se for
omi ti do, ser acrescentado uma String em branco. O parmetro pvargIndex o
ndi ce do texto na l i sta; se for omi ti do, pvargItem adi ci onado como l ti mo i tem da
l i sta. Exempl o:
EntryCount = EntryCount + 1
ListBox1.AddItem(EntryCount & " - Selection")
End Sub
Clear
Clear()
Li mpa o texto do objeto.
RemoveItem
RemoveItem(pvargIndex)
Remove i tens da Li sta. Este mtodo possui o parmetro pvargIndex, que especi fi ca a
l i nha que ser excl uda, i ni ci ando em zero. Ou seja, o pri mei ro el emento 0, o
segundo 1, e assi m por di ante. Exempl o:
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
194 Visualizao
List1.RemoveItem(List1.ListIndex)
End If
End Sub
Esta seo contm i nformaes sobre as propri edades do objeto Li sta.
BorderColor
BorderStyle
BoundColumn
Determi na a col una da l i sta onde os dados sero armazenados. Por exempl o, se
cada l i nha contm oi to i tens e a propri edade BoundColumn 3, o si stema
armazena as i nformaes na tercei ra col una da l i nha atual mente sel eci onada. Se o
val or for i gual a 0, este val or passado para a propri edade ListIndex do objeto. Se
o val or for 1 ou superi or, o dado i ndi cado atri budo col una referente ao val or
especi fi cado na propri edade. As col unas so numeradas a parti r de 1.
Column
Especi fi ca a l i nha e col una no objeto. Se for especi fi cado somente o val or de
col una, a propri edade Column l ou escreve a col una especi fi cada na l i nha atual
do objeto. Por exempl o, MinhaListadeSelecao.Column(3) l ou escreve a
tercei ra col una do objeto. Esta propri edade acessvel apenas em tempo de
execuo.
ColumnCount
A propri edade ColumnCount especi fi ca o nmero de col unas do objeto. A
confi gurao de ColumnCount como 0 no exi be nenhuma col una, e a confi gurao
desta propri edade como -1 exi be todas as col unas di sponvei s. O val or padro
Visualizao 195
ColumnHeads
A propri edade ColumnHeads habi l i ta ou desabi l i ta a exi bi o do ttul o das
col unas no objeto. Se a propri edade esti ver confi gurada para True, o ttul o
mostrado. Caso contrri o, o ttul o das col unas no mostrado. O val or padro
Fal se.
ColumnWidths
A propri edade ColumnWidths uti l i zada para especi fi car a l argura da col una do
objeto, em pontos. Um val or i gual a -1 ou em branco faz com que a l argura seja
cal cul ada na col una (a l argura mni ma de uma col una cal cul ada 72 pontos, ou 1
pol egada). Um val or i gual a 0 (zero) ocul ta a col una. Para produzi r col unas mai s
estrei tas, deve-se especi fi car a l argura na propri edade ou uti l i zar al guma dos
val ores a segui r:
Opes disponveis para ColumnWidths
OPO DESCRIO
90;72;90
A pri mei ra col una possui 90 pontos (1,25
pol egada); a segunda col una possui 72
pontos (1 pol egada); a tercei ra col una
possui 90 pontos.
6 cm;0;6 cm
A pri mei ra col una possui 6 centmetros; a
segunda col una est ocul ta; a tercei ra
col una possui 6 centmetros. Como parte
da tercei ra col una vi svel , uma barra de
1,5 pol;0;2,5 pol
A pri mei ra col una possui 1,5 pol egadas,
a segunda col una est ocul ta, e a
tercei ra col una possui 2,5 pol egadas.
2 pol;;2 pol
A pri mei ra col una possui 2 pol egadas, a
segunda col una possui 1 pol egada
(padro) e a tercei ra col una possui 2
pol egadas. Como somente metade da
tercei ra col una vi svel , uma barra de
(Vazio)
Todas as trs col unas possuem a mesma
l argura (1,33 pol egadas). O val or padro
desta propri edade vazi o (o E3 i r
uti l i zar o val or padro do si stema).
Font
IMEMode
196 Visualizao
objeto. Essa propri edade apl i ca-se apenas em apl i cati vos escri tos em i di omas
em outros apl i cati vos. El a no tem efei to no E3 e foi manti da por moti vos de
compati bi l i dade com a especi fi cao padro dos objetos Mi crosoft Forms. As
opes di sponvei s so as segui ntes:
OPO DESCRIO
1 - fmIMEModeOn
I ME ati vado.
2 - fmIMEModeOff
l argura total .
l argura total .
l argura.
l argura total .
8 - fmIMEModeAlpha
mei a l argura.
total .
l argura.
total .
12 - fmIMEModeHanzi
l argura.
IntegralHeight
A propri edade IntegralHeight ajusta a al tura da rea de edi o do texto, caso a
rea di sponvel ul trapasse o tamanho do objeto. Se esta propri edade esti ver
confi gurada para True, a al tura da rea de edi o do texto reajustada para
coi nci di r com o tamanho atual do objeto, permi ti ndo assi m a exi bi o compl eta do
contedo do texto. Caso contrri o, a rea de edi o do texto conti nua com seu
tamanho ori gi nal . Se os textos so mai ores que o espao di sponvel , este no
exi bi do no objeto.
List
Retorna ou defi ne as entradas da l i nha e da col una na l i sta do objeto. A
numerao de l i nha e de col una comea com zero. Isto , o nmero de l i nha da
pri mei ra l i nha na l i sta zero; o nmero de col una da pri mei ra col una zero. O
nmero da segunda l i nha ou col una 1, e assi m por di ante. Esta propri edade
Visualizao 197
ListCount
Retorna o nmero de i tens conti dos na l i sta do objeto. Esta propri edade
ListIndex
Identi fi ca o i tem atual mente sel eci onado na l i sta, chamado de ndi ce. Os val ores
de ListIndex vo de -1 ao nmero total de l i nhas em uma l i sta menos um (i sto ,
ListCount - 1). Quando nenhuma l i nha sel eci onada, ListIndex retorna -1. Quando
o usuri o sel eci ona uma l i nha em uma Li sta de Sel eo, o si stema defi ne o val or da
propri edade ListIndex. O val or da propri edade ListIndex da pri mei ra l i nha de uma
l i sta 0, o val or da segunda l i nha 1, e assi m por di ante. Esta propri edade
ListStyle
A propri edade ListStyle determi na o esti l o da l i sta do objeto. As opes
0 - fmListStylePlain: l i stagem com os i tens do pl ano de fundo em destaque
1 - fmListStyleOption: exi be botes de opo ou cai xas de sel eo para uma l i sta
de vri as opes. Quando o usuri o sel eci ona um i tem do grupo, o boto de
opo associ ado ao i tem sel eci onado e os botes de opo para outros i tens
no grupo so desmarcados
O val or padro desta propri edade 0 - fmListStylePlain.
NOTA: A opo 1 - fmListStyleOption s pode ser habi l i tada se a propri edade
MultiSelect esti ver confi gurada como 1 - fmMultiselectMulti.
Locked
MatchEntry
Procura, atravs do texto di gi tado pel o usuri o, por uma entrada de texto que
coi nci da com os dados exi stentes no objeto. Ao encontrar uma coi nci dnci a no
texto, a l i nha sel eci onada e o contedo da col una exi bi do. As opes
di sponvei s so as segui ntes:
0 - fmMatchEntryFirstLetter: procura pel a entrada de texto que coi nci da com o
pri mei ro caractere di gi tado no objeto. Se for di gi tada repeti damente a mesma
l etra, passada para a prxi ma entrada de texto que comece com esta l etra, e
198 Visualizao
assi m por di ante
1 - fmMatchEntryComplete: conforme cada caractere di gi tado, o objeto
procura por uma entrada de texto que coi nci da com os caracteres di gi tados
2 - fmMatchEntryNone: no faz a procura no objeto
O val or padro desta propri edade 1 - fmMatchEntryComplete.
MultiSelect
A propri edade MultiSelect i ndi ca se o objeto permi te ml ti pl as sel ees. As
0 - fmMultiSelectSingle: somente um i tem pode ser sel eci onado
1 - fmMultiSelectMulti: permi te sel eci onar um i tem atravs da barra de espao
ou cl i que com o mouse, fazendo com que marque ou desmarque um i tem na l i sta
2 - fmMultiSelectExtended: permi te sel eci onar um i tem atravs da tecl a SHIFT,
cl i cando com o mouse ou pressi onando SHIFT e uma das tecl as de seta,
estendendo a sel eo para o i tem atual . Pressi onando a tecl a CTRL e cl i cando
com o mouse, marca ou desmarca um i tem
O val or padro desta propri edade 0 - fmMultiSelectSingle.
Selected
Sel eci ona ou desfaz a sel eo de um i tem, e veri fi ca se um i tem est sel eci onado,
quando a propri edade Multiline est confi gurada como True. Para saber se um
determi nado i tem est sel eci onado, o ndi ce do i tem a ser consul tado deve ser
passado, e a propri edade retorna se o i tem est sel eci onado ou no. Dessa forma,
possvel ver quai s i tens esto sel eci onados quando o usuri o sel eci onar mai s de
um. Esta propri edade acessvel apenas em tempo de execuo. Quando o usuri o
no esti ver uti l i zando ml ti pl as sel ees, recomenda-se que sejam usadas as
propri edades Value ou ListIndex.
SpecialEffect
OPO DESCRIO
ou ambos.
Visualizao 199
OPO DESCRIO
estar em rel evo.
superi or esquerda.
Text
Retorna o texto da opo sel eci onada. Esta propri edade acessvel apenas em
tempo de execuo.
TextAlign
segui ntes:
2 - fmTextAlignCenter: al i nha o texto com o centro do objeto
TextColumn
A propri edade TextColumn i denti fi ca a col una no objeto. Os val ores para a
propri edade TextColumn vo de -1 ao nmero de col unas na l i sta. O val or
TextColumn para a pri mei ra col una 1, o val or da segunda col una 2, e assi m por
di ante. A confi gurao de TextColumn como 0 exi be os val ores para a propri edade
ListIndex. A confi gurao de TextColumn como -1 exi be a pri mei ra col una que
possui o val or da propri edade ColumnWidths mai or do que zero.
TopIndex
A propri edade TopIndex defi ne ou retorna o i tem da l i sta que aparece na posi o
mai s prxi ma do topo na l i sta. Esta propri edade retorna o val or -1 se a l i sta est
vazi a ou no exi bi da.
Value
o val or da propri edade BoundColumn das l i nhas atual mente sel eci onadas. Esta
propri edade no tem efei to no E3 e foi manti da por moti vos de compati bi l i dade
com a especi fi cao padro dos objetos Mi crosoft Forms.
200 Visualizao
4.3.2.12.9 Boto Liga-Desliga
Esta seo contm i nformaes sobre eventos e propriedades do objeto Boto Li ga-
Desl i ga. Este objeto no possui mtodos associ ados.
4.3.2.12.9.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Boto Li ga-Desl i ga.
MouseMove
MouseMove()
Ocorre quando o pontei ro do mouse movi mentado sobre o boto Li ga-Desl i ga.
Esta seo contm i nformaes sobre as propri edades do objeto Boto Li ga-
Desl i ga.
Accelerator
val or padro desta propri edade uma String vazi a.
Alignment
A propri edade Alignment especi fi ca a posi o do objeto, rel ati va a sua l egenda.
Esta propri edade acessvel apenas em tempo de execuo.
AutoSize
ul trapasse o tamanho do objeto. Para o objeto Boto Li ga-Desl i ga (Toggl e Button),
quando a propri edade esti ver confi gurada para True, o texto redi mensi onado
para coi nci di r com o tamanho atual o objeto, permi ti ndo assi m a sua exi bi o
compl eta.
BackStyle
A propri edade BackStyle defi ne o esti l o do pl ano de fundo para o objeto. As
Visualizao 201
Caption
Font
GroupName
mutuamente excl usi vos. Esta propri edade acessvel apenas em tempo de
execuo.
Locked
Picture
PicturePosition
segui ntes:
202 Visualizao
OPO DESCRIO
A fi gura aparece esquerda da l egenda.
A l egenda central i zada rel ati vamente
i magem.
A fi gura aparece esquerda da l egenda.
A l egenda al i nhada com a parte
i nferi or da fi gura.
l egenda al i nhada com a parte superi or
da fi gura.
fi gura.
da fi gura.
(padro).
SpecialEffect
A propri edade SpecialEffect especi fi ca a aparnci a de um objeto. Esta
propri edade acessvel apenas em tempo de execuo. As opes di sponvei s para
Visualizao 203
OPO DESCRIO
ou ambos.
estar em rel evo.
superi or esquerda.
TextAlign
segui ntes:
2 - fmTextAlignCenter: al i nha o texto ao centro do objeto
TripleState
opes de estados: Fal so, Verdadei ro ou Nul o. O val or Nul o exi bi do como um
Value
Indi ca o val or i ni ci al do objeto. Tem comportamento bool eano; se True, o objeto
WordWrap
204 Visualizao
4.3.2.12.10 Editor de Texto
Edi tor de Texto.
4.3.2.12.10.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Edi tor de Texto.
DropButtonClick
DropButtonClick()
Ocorre quando a l i sta de opes aparece ou desaparece ao se cl i car no objeto.
4.3.2.12.10.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Edi tor de Texto.
Copy
Copy()
Copi a para a rea de Transfernci a um texto previ amente sel eci onado. Uti l i ze o
mtodo Paste para col ar o texto em outro l ocal .
Cut
Cut()
Recorta para a rea de Transfernci a um texto previ amente sel eci onado. Uti l i ze o
mtodo Paste para col ar o texto em outro l ocal .
Paste
Paste()
Insere em um objeto de texto o contedo da rea de Transfernci a.
Esta seo contm i nformaes sobre as propri edades do objeto Edi tor de Texto.
AutoSize
ul trapasse o tamanho do objeto. Para o objeto Edi tor de Texto (Text Box), quando a
propri edade esti ver confi gurada para True, a l argura do texto reajustada para a
mesma do objeto. O val or padro desta propri edade Fal se.
Visualizao 205
NOTA: Recomenda-se evi tar o uso da propri edade AutoSize com um Edi tor de Texto
vazi o, que tambm uti l i ze as propri edades Multiline e WordWrap. Quando o usuri o
di gi ta em um Edi tor de Texto com essas propri edades ajustadas para True, el e
automati camente se redi mensi onar como uma cai xa l onga e estrei ta, como um
caractere de l argura e uma l i nha de texto de compri mento.
AutoTab
A propri edade AutoTab habi l i ta ou desabi l i ta a tabul ao automti ca no objeto.
Se a propri edade esti ver confi gurada para True, a tabul ao automti ca ocorre.
Caso contrri o, no uti l i zada.
Aps o usuri o di gi tar o nmero mxi mo de caracteres em um objeto (confi gurado
na propri edade MaxLength), o foco se move automati camente para o prxi mo
objeto da ordem de tabul ao, quando estes caracteres forem ati ngi dos. Por
exempl o, quando se quer que um Edi tor de Texto exi ba dados de estoque que
possuam sempre ci nco caracteres, pode-se usar a propri edade MaxLength para
especi fi car o nmero mxi mo de caracteres a serem i ntroduzi dos no objeto e a
propri edade AutoTab para tabul ar automati camente para o prxi mo objeto depoi s
que o usuri o di gi tar ci nco caracteres.
AutoWordSelect
Habi l i ta ou desabi l i ta a sel eo automti ca de pal avras no objeto. Se esta
propri edade esti ver confi gurada para True, a pal avra i ndi cada sel eci onada no
texto mai s o espao segui nte, caso se tenha sel eci onado parte del a. Caso contrri o,
somente o caractere i ndi cado na pal avra sel eci onado.
BackStyle
BorderColor
206 Visualizao
BorderStyle
CanPaste
A propri edade CanPaste especi fi ca se a rea de Transfernci a contm os dados
aos quai s o objeto d suporte. Se a opo esti ver confi gurada para True, o objeto
pode receber i nformaes col adas da rea de Transfernci a. Se os dados da rea
de Transfernci a esti verem em um formato ao qual o objeto no d suporte, a
propri edade CanPaste ser Fal se. Por exempl o, ao se tentar col ar um bi tmap em um
objeto que s d suporte a texto, CanPaste ser Fal se. Esta propri edade acessvel
CurLine
Especi fi ca a l i nha corrente do objeto, ou seja, a l i nha que contm o ponto de
i nsero de texto. O nmero da pri mei ra l i nha 0 (zero). O val or padro desta
propri edade zero.
CurTargetX
Retorna a posi o hori zontal de i nsero de um texto no objeto. Esta posi o
medi da em uni dades hi mtri cas (um hi metro corresponde a 0,0001 de um metro).
Pode-se usar CurTargetX e CurX para mover o ponto de i nsero de um texto
conforme o usuri o percorre o contedo do objeto. Quando o usuri o move o ponto
de i nsero para outra l i nha do texto, a propri edade CurTargetX especi fi ca a
posi o mai s i ndi cada para o ponto de i nsero do texto desejado. A propri edade
CurX defi ni da neste val or, se a l i nha do texto for mai or que o val or de CurTargetX.
Caso contrri o, a propri edade CurX defi ni da como o fi nal da l i nha do texto. Esta
CurX
A propri edade CurX especi fi ca a posi o atual hori zontal do ponto de i nsero no
objeto. Esta propri edades apl i cada em um objeto que possua vri as l i nhas, i sto ,
a propri edade Multiline est habi l i tada. O val or de retorno vl i do quando o
objeto possui o foco. Pode-se usar a propri edade Multiline e a propri edade CurX
para posi ci onar o ponto de i nsero do texto, conforme o usuri o usa a barra de
rol agem pel o contedo no objeto. Quando o usuri o move o ponto de i nsero para
uma outra l i nha de texto rol ando o contedo do objeto, a propri edade CurTargetX
especi fi ca a posi o desejada para o ponto de i nsero. A propri edade CurX
defi ni da com este val or se a l i nha de texto for mai or do que o val or de CurTargetX.
Caso contrri o, CurX defi ni do no fi m da l i nha de texto. Esta propri edade
Visualizao 207
DragBehavior
Habi l i ta ou desabi l i ta o recurso de arrastar e sol tar um texto no contedo do
objeto. As opes di sponvei s para esta propri edade so as segui ntes:
0 - fmDragBehaviorDisabled: no permi te a ao de arrastar e sol tar o texto no
contedo do objeto
1 - fmDragBehaviorEnabled: permi te a ao de arrastar e sol tar o texto no
contedo do objeto
O val or padro desta propri edade 0 - fmDragBehaviorDisabled.
NOTA: A propri edade DragBehavior no tem efei to se a propri edade Style esti ver
confi gurada para 2.
EnterFieldBehavior
Esta propri edade control a a forma como o contedo do texto sel eci onado na
rea de edi o, quando se pressi ona a tecl a TAB no objeto e no quando o objeto
recebe o foco como um resul tado do mtodo SetFocus. As opes di sponvei s para
0 - fmEnterFieldBehaviorSelectAll (valor padro): sel eci ona todo o contedo do
texto quando a tecl a TAB pressi onada no objeto
1 - fmEnterFieldBehaviorRecallSelection: dei xa a sel eo i nal terada
EnterKeyBehavior
Defi ne o efei to da tecl a ENTER no objeto. Se esta propri edade esti ver confi gurada
para True, ao pressi onar a tecl a ENTER uma nova l i nha cri ada na rea de edi o
do texto no objeto. Caso contrri o, ao pressi onar a tecl a ENTER o foco passado
para o prxi mo objeto da ordem de tabul ao. Isto tambm ocorre se a
propri edade Multiline esti ver confi gurada para Fal se, i ndependente do val or da
propri edade EnterKeyBehavior.
A combi nao das tecl as CTRL + ENTER tambm depende do val or da propri edade
Multiline. Se esta propri edade esti ver confi gurada para True, ao pressi onar estas
tecl as uma nova l i nha cri ada na rea de edi o do texto do objeto, i ndependente
do val or da propri edade EnterKeyBehavior. Se a propri edade for Fal se, as tecl as
no tero efei to sobre o texto.
Font
208 Visualizao
HideSelection
A propri edade HideSelection especi fi ca se o texto sel eci onado conti nua em
destaque quando um objeto no tem mai s o foco. Se a propri edade esti ver
confi gurada para True, o texto sel eci onado no est em destaque, a menos que o
objeto tenha o foco. Caso contrri o, o texto sel eci onado sempre aparece em
destaque. O val or padro desta propri edade True.
IMEMode
objeto. Essa propri edade apl i ca-se apenas a programas escri tos em i di omas
em outros apl i cati vos. Foi manti da por moti vos de compati bi l i dade com a
especi fi cao padro dos objetos Mi crosoft Forms. As opes di sponvei s so as
segui ntes:
OPO DESCRIO
1 - fmIMEModeOn
I ME ati vado.
2 - fmIMEModeOff
l argura total .
l argura total .
l argura.
l argura total .
8 - fmIMEModeAlpha
mei a l argura.
total .
l argura.
total .
12 - fmIMEModeHanzi
l argura.
IntegralHeight
A propri edade IntegralHeight ajusta a al tura da rea de edi o do texto, caso a
rea di sponvel ul trapasse o tamanho do objeto. Se esta propri edade esti ver
confi gurada para True, a al tura da rea de edi o do texto reajustada para
coi nci di r com o tamanho atual do objeto, permi ti ndo assi m a exi bi o compl eta do
Visualizao 209
contedo do texto. Caso contrri o, a rea de edi o do texto conti nua com seu
tamanho ori gi nal . Se os textos so mai ores que o espao di sponvel , estes no so
exi bi dos no objeto.
LineCount
A propri edade LineCount retorna o nmero de l i nhas do objeto. Esta propri edade
Locked
MaxLength
A propri edade MaxLength determi na o nmero mxi mo de caracteres no objeto.
Confi gurando esta propri edade como 0 (zero), no h l i mi te de caracteres no
objeto.
Multiline
A propri edade Multiline i ndi ca se o texto ter ml ti pl as l i nhas (True) ou ser uma
cai xa de texto si mpl es (Fal se). Isto pode ser vi sual i zado quando o objeto Vi ewer
est em execuo. O val or padro desta propri edade Fal se.
PasswordChar
Converte o texto do objeto para um caractere especi al , confi gurado na
propri edade. Uti l i ze esta propri edade para proteger i nformaes sensvei s, como
senhas ou cdi gos de segurana. O val or de PasswordChar o caractere
(normal mente um asteri sco) que aparece em um objeto, ao i nvs dos caracteres
reai s que o usuri o di gi ta. Se no for especi fi cado um caractere, o control e exi be
os caracteres di gi tados pel o usuri o.
ScrollBars
Especi fi ca se o objeto possui barras de rol agem verti cai s, hori zontai s ou
ambas. As opes di sponvei s so as segui ntes:
0 - fmScrollBarNone: no exi be barras de rol agem
1 - fmScrollBarHorizontal: exi be uma barra de rol agem hori zontal
2 - fmScrollBarVertical: exi be uma barra de rol agem verti cal
O val or padro desta propri edade 0 - fmScrollBarNone.
210 Visualizao
SelectionMargin
Habi l i ta ou desabi l i ta a margem de sel eo do objeto. Se esta propri edade
esti ver confi gurada para True, ao cl i car na margem do objeto, o texto ser
sel eci onado. Caso contrri o, ao cl i car na margem o texto no ser sel eci onado.
NOTA: Se a propri edade SelectionMargin esti ver confi gurada para True quando o
objeto for i mpresso, a margem de sel eo tambm ser i mpressa.
SelLength
Retorna o nmero de caracteres sel eci onados no objeto. Esta propri edade
SelStart
Indi ca o ponto i ni ci al do texto sel eci onado ou o ponto de i nsero, se nenhum
texto for sel eci onado. Esta propri edade acessvel apenas em tempo de execuo.
SelText
Retorna o texto sel eci onado no objeto. Esta propri edade acessvel apenas em
tempo de execuo.
SpecialEffect
OPO DESCRIO
ou ambos.
estar em rel evo.
superi or esquerda.
TabKeyBehavior
Determi na se as tabul aes so permi ti das na regi o de edi o. Se a propri edade
Visualizao 211
esti ver confi gurada para True, ao pressi onar a tecl a TAB i nseri do um caractere de
espaamento na regi o de edi o. Caso contrri o, ao pressi onar TAB, o foco
passado para o prxi mo objeto na ordem de tabul ao.
Text
Retorna o texto sendo di gi tado na opo sel eci onada. Esta propri edade
TextAlign
segui ntes:
2 - fmTextAlignCenter: al i nha o texto com o centro do objeto
TextLength
Retorna o nmero de caracteres di gi tados no objeto. Esta propri edade acessvel
Value
o texto na rea de edi o. Esta propri edade do ti po Variant, e pode assumi r
val ores de todo e qual quer ti po (Date, Boolean, String, etc.).
WordWrap
4.3.2.12.11 Boto Incremento-Decremento
Esta seo contm i nformaes sobre eventos e propriedades do objeto Boto
Incremento-Decremento. Este objeto no possui mtodos associ ados.
4.3.2.12.11.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Boto Incremento-
Decremento.
SpinDown
SpinDown()
Ocorre quando o usuri o pressi ona a seta para bai xo. Este evento decrementa a
propri edade Value do objeto.
212 Visualizao
SpinUp
SpinUp()
Ocorre quando o usuri o pressi ona a seta para ci ma. Este evento i ncrementa a
propri edade Value do objeto.
Esta seo contm i nformaes sobre as propri edades do objeto Boto Incremento-
Decremento.
Delay
Especi fi ca um tempo de espera para o objeto. A propri edade Delay afeta a
durao de tempo entre os eventos SpinUp, SpinDown e Change consecuti vos,
gerados quando o usuri o cl i ca e mantm pressi onado o boto Incremento-
Decremento. O pri mei ro evento ocorre i medi atamente. O tempo de espera at a
segunda ocorrnci a do evento de ci nco vezes o val or especi fi cado na
propri edade Delay. Aps o tempo i ni ci al , o i nterval o entre os eventos o val or
especi fi cado para Delay.
O val or padro de Delay 50ms. Isto si gni fi ca que o objeto i ni ci a o pri mei ro evento
depoi s de 250ms (ci nco vezes o val or especi fi cado), e i ni ci a cada evento
subsequente depoi s de 50ms.
Max
A propri edade Max uti l i zada para determi nar o l i mi te mxi mo do objeto.
Min
A propri edade Min uti l i zada para determi nar o l i mi te mni mo do objeto.
Orientation
A propri edade Orientation uti l i zada para determi nar a ori entao do objeto
na Tel a. As opes di sponvei s para esta propri edade so as segui ntes:
-1 - fmOrientationAuto: determi na automati camente a ori entao com base nas
di menses do objeto, i sto , conforme el e foi cri ado
0 - fmOrientationVertical: o objeto di sposto verti cal mente
1 - fmOrientationHorizontal: o objeto di sposto hori zontal mente
O val or padro desta propri edade -1 - fmOrientationAuto.
SmallChange
A propri edade SmallChange especi fi ca a quanti dade de movi mento que ocorre
quando o usuri o cl i ca em uma seta de rol agem no objeto. O val or padro desta
Visualizao 213
propri edade 1.
Value
Nmero i ntei ro entre os val ores defi ni dos pel as propri edades Min e Max. Indi ca a
posi o i ni ci al do i ncremento ou decremento. No acei ta val ores menores que o
val or de Min, nem mai ores que o val or de Max.
4.3.2.12.12 Barra de Rolagem
Esta seo contm i nformaes sobre eventos e propriedades do objeto Barra de
Rol agem. Este objeto no possui mtodos associ ados.
4.3.2.12.12.1 Eventos
Esta seo contm i nformaes sobre eventos do objeto Barra de Rol agem.
Scroll
Scroll()
Gerado quando o pontei ro da barra de rol agem movi do para al guma di reo.
Esta seo contm i nformaes sobre propri edades do objeto Barra de Rol agem.
Delay
Especi fi ca um tempo de espera para o objeto. A propri edade Delay afeta a
durao de tempo entre eventos Change consecuti vos, gerados quando o usuri o
cl i ca e mantm pressi onada a barra de rol agem. O pri mei ro evento ocorre
i medi atamente. O tempo de espera at a segunda ocorrnci a do evento de ci nco
vezes o val or especi fi cado na propri edade Delay. Aps o tempo i ni ci al , o i nterval o
entre os eventos o val or especi fi cado para Delay.
O val or padro de Delay 50ms. Isto si gni fi ca que o objeto i ni ci a o pri mei ro evento
depoi s de 250ms (ci nco vezes o val or especi fi cado), e i ni ci a cada evento
subsequente depoi s de 50ms.
LargeChange
Especi fi ca a quanti dade de passos do cursor da Barra de Rol agem. O val or da
propri edade LargeChange a quanti dade pel a qual a propri edade Value al terada,
quando o usuri o cl i ca na rea entre a cai xa de rol agem e o cursor da barra de
rol agem. Qual quer val or i ntei ro permi ti do para a propri edade LargeChange, mas
o i nterval o recomendado de -32,767 a +32,767, sendo que este val or deve estar
entre os val ores determi nados nas propri edade Max e Min da Barra de Rol agem.
214 Visualizao
Max
A propri edade Max uti l i zada para determi nar o l i mi te mxi mo do objeto.
Min
A propri edade Min uti l i zada para determi nar o l i mi te mni mo do objeto.
Orientation
A propri edade Orientation uti l i zada para determi nar a ori entao do objeto
na Tel a. As opes di sponvei s para esta propri edade so as segui ntes:
-1 - fmOrientationAuto: determi na automati camente a ori entao com base nas
di menses do objeto, i sto , conforme el e foi cri ado
0 - fmOrientationVertical: o objeto di sposto verti cal mente
1 - fmOrientationHorizontal: o objeto di sposto hori zontal mente
O val or padro desta propri edade -1 - fmOrientationAuto.
ProportionalThumb
A propri edade ProportionalThumb especi fi ca se o tamanho da cai xa de rol agem
i gual di menso do objeto. Se a propri edade esti ver confi gurada para True, a
cai xa da Barra de Rol agem tem a mesma di menso do objeto. Caso contrri o, se for
di mensi onado o objeto, a cai xa de rol agem permanece com o tamanho ori gi nal . O
SmallChange
A propri edade SmallChange especi fi ca a quanti dade de movi mento que ocorre
quando o usuri o cl i ca em uma seta de rol agem no objeto. O val or padro desta
propri edade 1.
Value
Nmero i ntei ro entre os val ores defi ni dos pel as propri edades Min e Max. Indi ca a
posi o i ni ci al da barra de rol agem. No acei ta val ores menores que o val or de
Min, nem mai ores que o val or de Max.
4.3.2.13 E2Controls
Esta seo contm i nformaes sobre eventos, mtodos e propri edades de objetos
E2Control s.
Esta seo contm i nformaes sobre propri edades comuns aos objetos
E2Control s.
Visualizao 215
4.3.2.13.1.1 Frame_BorderColor
Defi ne uma cor para a mol dura do objeto.
4.3.2.13.1.2 Frame_BorderEnabled
Habi l i ta ou desabi l i ta a mol dura do objeto.
4.3.2.13.1.3 Frame_BorderThickness
Defi ne a espessura da mol dura do objeto, em pi xel s.
4.3.2.13.1.4 Frame_Color
Defi ne a cor de fundo da rea de ttul o do objeto. O val or padro desta
4.3.2.13.1.5 Frame_Enable
Habi l i ta ou desabi l i ta a exi bi o da mol dura do objeto. O val or padro desta
propri edade Verdadei ro, exceto para o objeto E2Button.
4.3.2.13.1.6 Frame_Enable3D
Habi l i ta ou desabi l i ta o efei to 3D para a mol dura do objeto.
4.3.2.13.1.7 Frame_Separator
Habi l i ta ou desabi l i ta a exi bi o de uma l i nha separadora entre o ttul o e o
objeto.
4.3.2.13.1.8 Frame_Set3DInset
Se esta propri edade esti ver ajustada para Verdadei ro, a borda do objeto
aparecer rebai xada. Se esti ver em Fal so (val or padro), a borda do objeto
aparecer ressal tada.
4.3.2.13.1.9 Frame_Thickness3D
Defi ne a espessura da borda 3D da mol dura do objeto, em pi xel s.
4.3.2.13.1.10 Frame_Title
Esta propri edade defi ne o ttul o da mol dura do objeto.
216 Visualizao
4.3.2.13.1.11 Frame_TitleColor
Defi ne a cor da fonte do ttul o da mol dura. O val or padro desta propri edade
preto (RGB(0, 0, 0)).
4.3.2.13.1.12 Frame_TitleEnabled
Habi l i ta ou desabi l i ta a exi bi o do ttul o da mol dura. O val or padro desta
propri edade Verdadei ro.
4.3.2.13.1.13 Frame_TitleFont
A propri edade Frame_TitleFont uti l i zada para determi nar a fonte do ttul o da
mol dura. Esta propri edade no pode ser uti l i zada em scri pts ou em Associ aes,
sendo confi gurada uni camente vi a Studi o.
4.3.2.13.2 E2Animation
Esta seo contm i nformaes sobre propriedades do objeto E2Ani mati on. Este
Esta seo contm i nformaes sobre as propri edades do objeto E2Ani mati on.
BackgroundColor
Esta propri edade defi ne a cor de fundo do objeto E2Ani mati on. O val or padro
desta propri edade branco (RGB(255, 255, 255)).
BlinkTime
Defi ne o i nterval o de tempo, em mi l i ssegundos, do efei to de pi scar do objeto.
Border
Habi l i ta ou desabi l i ta a exi bi o de uma borda ao redor do objeto.
DefaultZone
Defi ne a zona padro que ser mostrada quando o Tag associ ado esti ver fora dos
l i mi tes das outras zonas defi ni das para o objeto.
IsTransparent
Se o val or desta propri edade for verdadei ro, defi ne que o fundo do objeto ser
transparente, permi ti ndo que o fundo da Tel a aparea. Caso contrri o, a cor de
fundo ser sl i da, defi ni da em BackgroundColor.
Visualizao 217
Value
Essa propri edade defi ne o val or que i r determi nar qual a Zona ati va. O val or
padro dessa propri edade 0 (zero).
Zones
Col eo de Zonas do objeto E2Ani mati on.
4.3.2.13.2.2 Coleo de Zonas
Esta seo contm i nformaes sobre os mtodos do objeto Col eo de Zonas. Este
objeto no contm eventos nem propri edades associ adas.
Mtodos
Esta seo contm i nformae sobre os mtodos do objeto Col eo de Zonas.
Add
Add([AxisName])
Adi ci ona uma nova Zona na Col eo de Zonas. O parmetro AxisName opci onal e
no tem efei to, sendo manti do por questes de compati bi l i dade com verses
anteri ores.
Remove
Remove(Index)
Remove uma Zona. O parmetro Index i ndi ca o ndi ce da Zona que deve ser
removi da.
Defi ne um conjunto de i magens de bi tmap que sero usadas para cri ar o efei to de
ani mao no objeto. As Zonas podem ser confi guradas acessando a janel a
Propriedades do objeto, na aba E2Animation. As opes dessa janel a so as
segui ntes:
Opes disponveis na aba E2Animation
OPO DESCRIO
Zonas
Li stagem com todas as Zonas defi ni das
no objeto.
Boto Adicionar
Adi ci ona uma nova Zona.
Boto Remover
Apaga a Zona sel eci onada.
Zona Padro
Defi ne a Zona sel eci onada como a Zona
padro do objeto.
Pisca
Defi ne se o bi tmap i r pi scar quando o
val or do objeto esti ver dentro do
i nterval o da Zona.
Dica
Mostra um texto de ajuda sobre a Zona.
Mnimo
Val or mni mo para a vari ao da Zona.
218 Visualizao
OPO DESCRIO
Mximo
Val or mxi mo para a vari ao da Zona.
Arquivo de imagem
Nome do arqui vo de bi tmap que ser
mostrado quando o val or do objeto
esti ver dentro do i nterval o da Zona.
Exemplo
Mostra uma prvi a do arqui vo de bi tmap
da Zona sel eci onada.
Propriedades
Esta seo contm i nformaes sobre as propri edades das Zonas do objeto
E2Ani mati on.
Blink
Indi ca que esta Zona parti ci pa do efei to de pi scar. O val or padro dessa
propri edade Fal so.
Filename
Indi ca qual o nome do arqui vo de i magem uti l i zado na Zona.
Maximum
Defi ne o val or mxi mo para a Zona. O val or padro dessa propri edade 20000.
Minimum
Defi ne o val or mni mo para a Zona. O val or padro dessa propri edade 0 (zero).
TipEnable
Habi l i ta ou desabi l i ta a di ca para a Zona. O val or padro dessa propri edade
Fal so.
TipText
Defi ne a di ca para a Zona. O val or padro dessa propri edade uma String em
branco.
4.3.2.13.3 E2Bitmap
Esta seo contm i nformaes sobre propriedades do objeto E2Bi tmap. Este objeto
Esta seo contm i nformaes sobre as propri edades do objeto E2Bi tmap.
Filename
Defi ne o nome do arqui vo de i magem associ ado ao E2Bi tmap. O cami nho do
arqui vo pode ser tanto o cami nho compl eto do arqui vo no di sco, quanto o cami nho
Visualizao 219
rel ati vo apl i cao (quando o arqui vo de i magem i nseri do como um Recurso da
apl i cao). O val or padro desta propri edade vazi o.
IsTransparent
Esta propri edade habi l i ta ou desabi l i ta a transparnci a do objeto, baseada na
cor defi ni da na propri edade TransparentColor.
TransparentColor
Defi ne qual cor ser consi derada pel a propri edade IsTransparent como sendo
transparente. O val or padro desta propri edade branco (RBG(255, 255, 255)).
4.3.2.13.4 E2Button
Esta seo contm i nformaes sobre eventos e propriedades do objeto E2Button.
Este objeto no possui mtodos associ ados.
4.3.2.13.4.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto E2Button.
OnRelease
OnRelease()
Este evento gerado quando o boto do mouse sol to.
Esta seo contm i nformaes sobre as propri edades do objeto E2Button.
Action
Esta propri edade defi ne o comportamento do objeto E2Button quando cl i cado.
Os val ores possvei s para esta propri edade so:
0 - Momentary: Comportamento normal do boto, aparecendo rebai xado
somente enquanto o mouse est pressi onado
1 - Toggle: Possui doi s estados, l i gado e desl i gado
2 - Jog: Al terna entre doi s val ores, um quando o boto pressi onado e outro
quando o boto sol to
O val or padro desta propri edade 0 - Momentary.
Alignment
Determi na o al i nhamento do texto do boto. Os val ores possvei s desta
propri edade so:
220 Visualizao
0 - HorizontalAlignmentLeft: Al i nha o texto esquerda
1 - HorizontalAlignmentCenter: Al i nha o texto ao centro
2 - HorizontalAlignmentRight: Al i nha o texto di rei ta
O val or padro desta propri edade 1 - HorizontalAlignmentCenter.
BackgroundColor0
Defi ne a cor de fundo do boto, quando no est pressi onado. O val or padro
desta propri edade ci nza (RGB(192, 192, 192)).
BackgroundColor1
Defi ne a cor de fundo do boto, quando est pressi onado. O val or padro desta
Bitmap0
Defi ne a i magem do boto, quando no est pressi onado. O val or padro desta
propri edade vazi o.
Bitmap1
Defi ne a i magem do boto, quando est pressi onado. O val or padro desta
Text0
Defi ne o texto do boto, quando no est pressi onado. O val or padro desta
propri edade "DESLIGADO".
Text1
Defi ne o texto do boto, quando est pressi onado. O val or padro desta
propri edade "LIGADO".
TextColor0
Defi ne a cor do texto do boto, quando no est pressi onado. O val or padro
desta propri edade preto (RGB(0, 0, 0)).
TextColor1
Defi ne a cor do texto do boto, quando est pressi onado. O val or padro desta
TextFont0
A propri edade TextFont0 uti l i zada para determi nar a fonte do boto, quando
no est pressi onado. Esta propri edade no pode ser uti l i zada em scri pts ou em
Associ aes, sendo confi gurada uni camente vi a Studi o.
Visualizao 221
TextFont1
A propri edade TextFont1 uti l i zada para determi nar a fonte do boto, quando
est pressi onado. Esta propri edade no pode ser uti l i zada em scri pts ou em
Associ aes, sendo confi gurada uni camente vi a Studi o.
Type
Defi ne o ti po do boto. Os val ores possvei s para esta propri edade so os
segui ntes:
0 - ButtonTypeKey: comportamento normal de um boto
1 - ButtonTypeSwitchH: o comportamento do boto o de uma chave di vi di da
hori zontal mente
2 - ButtonTypeSwitchV: o comportamento do boto o de uma chave di vi di da
verti cal mente
3 - ButtonTypeLeverH: o comportamento do boto o de uma al avanca que se
movi menta da esquerda para a di rei ta e vi ce-versa
4 - ButtonTypeLeverV: o comportamento do boto o de uma al avanca que se
movi menta de ci ma para bai xo e vi ce-versa
5 - ButtonTypeTransparent: o boto transparente
6 - ButtonTypeUserBitmap: o boto al terna a exi bi o das i magens defi ni das nas
propri edades Bitmap0 e Bitmap1
7 - ButtonTypeCheckbox: o comportamento do boto o mesmo de uma Cai xa de
Sel eo
8 - ButtonTypeRadio: o comportamento do boto o mesmo de um Boto de
Opes
O val or padro desta propri edade 0 - ButtonTypeKey.
Value
A propri edade Value um Variant que assume o val or conti do na propri edade
Value0 se o boto no est pressi onado, e o val or conti do na propri edade Value1
se o boto est pressi onado.
Value0
Defi ne o val or da propri edade Value, quando o boto no est pressi onado.
Value1
Defi ne o val or da propri edade Value, quando o boto est pressi onado.
222 Visualizao
4.3.2.13.5 E2Display
Esta seo contm i nformaes sobre propriedades do objeto E2Di spl ay. Este
Esta seo contm i nformaes sobre as propri edades do objeto E2Di spl ay.
BackgroundColor
Esta propri edade defi ne a cor de fundo do objeto. O val or padro desta
BackgroundStyle
Defi ne o esti l o de fundo do objeto. Os val ores desta propri edade so os
segui ntes:
0 - bsTransparent: o fundo transparente
1 - bsOpaque: a cor defi ni da em BackgroundColor vsi vel
O val or padro desta propri edade 1 - bsOpaque.
Format
Contm um texto que representa uma mscara, dentro da qual os val ores do
objeto sero mostrados. Esta mscara pode representar vri os ti pos de val ores:
Geral: No possui formatao especfi ca, adaptando-se automati camente ao
val or especi fi cado
Nmero: Apresenta nmeros com parte i ntei ra e fraci onri a. O usuri o pode
optar por at 15 casas deci mai s, por usar ou no um separador de mi l hares, e
por apresentar nmeros negati vos com si nal ou entre parnteses. Para nmeros
mui to grandes ou mui to pequenos, recomenda-se uti l i zar o formato Cientfico
Data: Apresenta val ores numri cos de data e hora (quando vl i dos). Para
representar apenas a hora, use o formato equi val ente
Hora: Apresenta val ores numri cos de hora e data (quando vl i dos). Para
representar apenas a data, use o formato equi val ente
Porcentagem: Mul ti pl i ca o nmero por 100 e adi ci ona o smbol o de
porcentagem. Admi te at 15 casas deci mai s
Cientfico: Apresenta o nmero em notao de manti ssa e expoente. Ideal para
nmeros de magni tude vari ada. Admi te at 15 casas deci mai s
Especial: Permi te formatar nmeros i ntei ros em bases no deci mai s
Visualizao 223
(hexadeci mal , octal ou bi nri a, por exempl o)
Outro: Permi te edi tar di retamente o cdi go de formatao desejado, ou
sel eci onar um formato cri ado anteri ormente
HorizontalAlignment
Defi ne o al i nhamento hori zontal do texto do E2Di spl ay. Os val ores desta
0 - HorizontalAlignmentLeft: al i nha hori zontal mente esquerda
1 - HorizontalAlignmentCenter: al i nha hori zontal mente ao centro
2 - HorizontalAlignmentRight: al i nha hori zontal mente di rei ta
MultiLine
Defi ne se o objeto possui ml ti pl as l i nhas ou no. Esta propri edade s ter efei to
se a propri edade Value for do ti po String.
TextColor
Defi ne a cor do texto do objeto. O val or padro desta propri edade preto (RGB(0,
0, 0)).
TextFont
A propri edade TextFont uti l i zada para determi nar a fonte do objeto. Esta
propri edade no pode ser uti l i zada em Associ aes. Veja a propri edade TextFont
dos objetos Texto, Di spl ay e SetPoi nt para mai ores i nformaes sobre as
subpropri edades que podem ser modi fi cadas vi a scri pt.
Value
Esta propri edade contm um Variant que pode assumi r val ores de todo e
qual quer ti po de dados, e a forma de apresentao desses val ores ser defi ni da
pel a propri edade Format.
VerticalAlignment
Defi ne o al i nhamento verti cal do texto do E2Di spl ay. Os val ores desta
0 - VerticalAlignmentTop: al i nha verti cal mente com a parte superi or do objeto
1 - VerticalAlignmentMiddle: al i nha verti cal mente com o centro do objeto
2 - VerticalAlignmentBottom: al i nha verti cal mente com a parte i nferi or do objeto
O val or padro desta propri edade 1 - VerticalAlignmentMiddle.
224 Visualizao
4.3.2.13.6 E2Gauge
Esta seo contm i nformaes sobre propriedades do objeto E2Gauge. Este objeto
Esta seo contm i nformaes sobre as propri edades do objeto E2Gauge.
BackgroundColor
BulletsVisible
Exi be ou esconde as marcas da escal a em forma de bullet.
DecimalPlaces
Esta propri edade defi ne o nmero de casas deci mai s para o val or nomi nal do
E2Gauge.
FrameColor
Defi ne a cor de fundo do objeto.
HiColorLegend
Defi ne a cor da l egenda para o l i mi te Al to. O val or padro desta propri edade
amarel o (RGB(255, 255, 0)).
HiDiv
Marca o i nci o da escal a para o l i mi te Al to. O val or padro dessa propri edade
13300.
HiHiColorLegend
Defi ne a cor da l egenda para o l i mi te Mui to Al to. O val or padro desta
propri edade vermel ho (RGB(255, 0, 0)).
HiHiDiv
Marca o i nci o da escal a para o l i mi te Mui to Al to. O val or padro dessa
propri edade 16600.
HiHiLimitVisible
Habi l i ta ou desabi l i ta a exi bi o do l i mi te Mui to Al to.
HiLimit
Visualizao 225
O val or mxi mo dessa propri edade 1 e o mni mo l i mi tado pel a propri edade
LowLimit. O val or padro dessa propri edade 0,7.
HiLimitVisible
Habi l i ta ou desabi l i ta a exi bi o do l i mi te Al to.
LegendVisible
Exi be uma barra ao l ongo do objeto E2Gauge, onde podem ser confi guradas
di ferentes cores, dependendo da fai xa de val ores. O val or padro desta
propri edade True.
LimitVisible
Defi ne se os val ores mni mos e mxi mos da escal a aparecem ou no no grfi co.
LowColorLegend
Defi ne a cor da l egenda para o l i mi te Bai xo. O val or padro desta propri edade
verde escuro (RGB(0, 128, 0)).
LowDiv
Marca o i nci o da escal a para o l i mi te Bai xo. O val or padro dessa propri edade
6600.
LowLimit
O val or mni mo dessa propri edade 0,1, e o mxi mo l i mi tado pel a propri edade
HiLimit. O val or padro dessa propri edade 0,62.
LowLimitVisible
Habi l i ta ou desabi l i ta a exi bi o do l i mi te Bai xo.
LowLowColorLegend
Defi ne a cor da l egenda para o l i mi te Mui to Bai xo. O val or padro desta
propri edade verde (RGB(0, 255, 0)).
LowLowDiv
Marca o i nci o da escal a para o l i mi te Mui to Bai xo. O val or padro dessa
propri edade 3300.
LowLowLimitVisible
Habi l i ta ou desabi l i ta a exi bi o do l i mi te Mui to Bai xo.
Maximum
Defi ne o val or mxi mo da escal a do E2Gauge.
226 Visualizao
Minimum
Defi ne o val or mni mo da escal a do E2Gauge.
NeedleColor
Defi ne a cor do pontei ro do E2Gauge. O val or padro desta propri edade branco
(RGB(255, 255, 255)).
NeedleThickness
Defi ne a espessura do pontei ro do E2Gauge, em pi xel s. O val or padro dessa
propri edade 2, e s so acei tos os val ores 1 ou 2.
NormalColor
Defi ne a cor da l egenda para o l i mi te Normal . O val or padro desta propri edade
ol i va (RGB(128, 128, 0)).
NumberOfPoints
Defi ne o nmero de subdi vi ses que estaro vi svei s na escal a do objeto.
Orientation
Defi ne a ori entao do objeto E2Gauge. Os val ores possvei s desta propri edade
so os segui ntes:
0 - Left: a parte i nferi or do objeto est al i nhada com o l ado esquerdo da
mol dura
1 - Up: a parte i nferi or do objeto est al i nhada com a parte de ci ma da mol dura
2 - Down: a parte i nferi or do objeto est al i nhada com a parte de bai xo da
mol dura
3 - Right: a parte i nferi or do objeto est al i nhada com o l ado di rei to da mol dura
O val or padro desta propri edade 2 - Down.
Reverted
Habi l i ta ou desabi l i ta a reverso da escal a do objeto.
ShowFrame
Habi l i ta ou desabi l i ta a exi bi o do fundo ao l ongo do percurso do pontei ro.
StartAngle
Defi ne o ngul o i ni ci al de exi bi o do pontei ro do objeto E2Gauge.
SubTickColor
Defi ne a cor das subdi vi ses da escal a. O val or padro desta propri edade
Visualizao 227
preto (RGB(0, 0, 0)).
SubTicksVisible
Habi l i ta ou desabi l i ta a exi bi o das subdi vi ses da escal a.
TextColor
Defi ne a cor do texto da escal a. O val or padro desta propri edade preto (RGB(0,
0, 0)).
TextFont
A propri edade TextFont uti l i zada para determi nar a fonte do texto da escal a.
Esta propri edade no pode ser uti l i zada em Associ aes. Veja a propri edade
TextFont dos objetos Texto, Di spl ay e SetPoi nt para mai ores i nformaes sobre as
ThickTicks
Habi l i ta ou desabi l i ta a exi bi o de di vi sores da escal a mai s espessos. O val or
padro dessa propri edade Fal so.
TickColor
Defi ne a cor dos di vi sores da escal a. O val or padro desta propri edade preto
(RGB(0, 0, 0)).
TicksVisible
Habi l i ta ou desabi l i ta a exi bi o das di vi ses da escal a.
TickValues
Habi l i ta ou desabi l i ta a exi bi o dos val ores das di vi ses da escal a.
TotalNumberOfSubTicks
Defi ne o nmero total de subdi vi ses que sero mostradas na escal a.
Value
Esta propri edade defi ne um val or entre as propri edades Maximum e Minimum da
escal a do objeto.
ValueVisible
Habi l i ta ou desabi l i ta a exi bi o do val or conti do na propri edade Value. O val or
4.3.2.13.7 E2Setpoint
Esta seo contm i nformaes sobre propriedades do objeto E2Setpoi nt. Este
228 Visualizao
Esta seo contm i nformaes sobre as propri edades do objeto E2Setpoi nt.
AutoSend
Se esta propri edade esti ver em True (val or padro), o val or defi ni do na
propri edade Value atual i zado nas Associ aes assi m que o objeto perder o foco.
Caso contrri o, as Associ aes s recebem o val or quando for usada a tecl a ENTER.
BackgroundColor
BackgroundStyle
Defi ne o esti l o de fundo do objeto. Os val ores desta propri edade so os
segui ntes:
0 - bsTransparent: o fundo transparente
1 - bsOpaque: a cor defi ni da em BackgroundColor vsi vel
O val or padro desta propri edade 1 - bsOpaque.
EnableMaxLimit
Habi l i ta ou desabi l i ta a defi ni o de um l i mi te mxi mo para o val or do
E2Setpoi nt.
EnableMinLimit
Habi l i ta ou desabi l i ta a defi ni o de um l i mi te mni mo para o val or do
E2Setpoi nt.
Format
Contm um texto que representa uma mscara, dentro da qual os val ores do
objeto sero mostrados. Esta mscara pode representar vri os ti pos de val ores:
Visualizao 229
HorizontalAlignment
Defi ne o al i nhamento hori zontal do texto do E2Setpoi nt. Os val ores desta
HScroll
Habi l i ta ou desabi l i ta a exi bi o de uma barra de rol agem hori zontal no texto,
caso a propri edade Multiline esteja em True.
MaxLimit
Li mi te mxi mo que pode ser ati ngi do pel a propri edade Value do objeto. O val or
padro dessa propri edade 200. O l i mi te s veri fi cado se a propri edade
EnableMaxLimit esti ver habi l i tada.
MinLimit
Li mi te mni mo que pode ser ati ngi do pel a propri edade Value do objeto. O val or
padro dessa propri edade 0. O l i mi te s veri fi cado se a propri edade
EnableMinLimit esti ver habi l i tada.
MultiLine
Defi ne se o objeto possui ml ti pl as l i nhas ou no. Esta propri edade s estar
di sponvel se a propri edade Value for do ti po String.
ReadOnly
Indi ca se o objeto pode ser edi tado ou no em tempo de execuo. O val or
230 Visualizao
Refresh
Indi ca se o val or do E2Setpoi nt ser atual i zado ou no sempre que o val or do Tag
mudar. O val or padro desta propri edade Verdadei ro.
SelectAllOnFocus
Habi l i ta ou desabi l i ta a sel eo de todos os caracteres do E2Setpoi nt quando o
objeto recebe o foco. O val or padro dessa propri edade Verdadei ro.
TextColor
Defi ne a cor do texto do objeto. O val or padro desta propri edade preto (RGB(0,
0, 0)).
TextFont
A propri edade TextFont uti l i zada para determi nar a fonte do objeto. Esta
propri edade no pode ser uti l i zada Associ aes. Veja a propri edade TextFont dos
objetos Texto, Di spl ay e SetPoi nt para mai ores i nformaes sobre as
Type
Defi ne o ti po de Setpoi nt. Os val ores possvei s desta propri edade so os
segui ntes:
0 - setpointString: acei ta quai squer caracteres al fanumri cos
1 - setpointNumeric: acei ta somente caracteres numri cos e o separador deci mal
(ponto ou vrgul a, dependendo das confi guraes regi onai s)
2 - setpointDateTime: acei ta somente val ores de data e hora, que sero
converti dos para o formato defi ni do nas confi guraes regi onai s
O val or padro desta propri edade 1 - setpointNumeric.
Value
Esta propri edade defi ne um val or para o E2Setpoi nt. A forma como esse val or
ser vi sual i zado defi ni da na propri edade Format.
VerticalAlignment
Defi ne o al i nhamento verti cal do texto do E2Setpoi nt. Os val ores desta
0 - VerticalAlignmentTop: al i nha verti cal mente com a parte superi or do objeto
1 - VerticalAlignmentMiddle: al i nha verti cal mente com o centro do objeto
2 - VerticalAlignmentBottom: al i nha verti cal mente com a parte i nferi or do objeto
Visualizao 231
O val or padro desta propri edade 1 - VerticalAlignmentMiddle.
VScroll
Habi l i ta ou desabi l i ta a exi bi o de uma barra de rol agem verti cal no texto, caso
a propri edade Multiline esteja em True.
4.3.2.13.8 E2Text
Esta seo contm i nformaes sobre propriedades do objeto E2Text. Este objeto
Esta seo contm i nformaes sobre as propri edades do objeto E2Text.
BlinkTime
Defi ne o i nterval o de tempo, em mi l i ssegundos, do efei to de pi scar do objeto.
DefaultZone
Defi ne a Zona padro do objeto.
Value
Esta propri edade contm um Variant que pode assumi r val ores de todo e
qual quer ti po de dados (Integer, Boolean, String, etc.).
Zones
Col eo de Zonas do objeto E2Text.
4.3.2.13.8.2 Coleo de Zonas
Esta seo contm i nformaes sobre os mtodos do objeto Col eo de Zonas do
objeto E2Text. Este objeto no possui eventos nem propri edades associ adas.
Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Col eo de Zonas do
E2Text.
Add
Add([AxisName])
Adi ci ona uma nova Zona na Col eo de Zonas. O parmetro AxisName opci onal e
no tem efei to, sendo manti do por questes de compati bi l i dade com verses
anteri ores.
232 Visualizao
Remove
Remove(Index)
Remove uma Zona. O parmetro Index i ndi ca o ndi ce da Zona que deve ser
removi da.
Zonas
Defi ne um conjunto de Zonas para o objeto E2Text. Estas Zonas podem ser
confi guradas acessando a janel a de propri edades do objeto, na aba Zonas. As
opes di sponvei s nesta aba so as segui ntes:
Opes disponveis na aba Zonas
OPO DESCRIO
Zonas
Li stagem com todas as Zonas defi ni das
no objeto.
Adicionar
Adi ci ona uma nova Zona.
Remover
Remove a Zona sel eci onada.
Pisca a cada (ms)
Defi ne se o texto e o fundo da Zona i ro
pi scar quando o val or do objeto esti ver
dentro do i nterval o da Zona.
Mensagem
Texto da mensagem exi bi da quando o
Alinhamento
Defi ne o al i nhamento do texto.
Fonte
Defi ne a fonte do texto.
Cor de fundo
Defi ne a cor de fundo da Zona.
Transparente
Defi ne se o fundo do objeto ser
transparente quando a Zona esti ver
ati va.
Zona padro
Defi ne a Zona sel eci onada como a Zona
padro do objeto.
Pisca
Defi ne se a Zona i r pi scar quando o
Mnimo
Val or mni mo para a Zona.
Mximo
Val or mxi mo para a Zona.
Dica
Mostra um texto de ajuda para a Zona.
Exemplo
Mostra um exempl o do comportamento
da Zona em tempo de execuo.
A seo a segui r contm i nformaes sobre as propriedades do objeto Zona de uma
Col eo de Zonas de um objeto E2Text. Este objeto no possui eventos nem mtodos
associ ados.
Visualizao 233
Propriedades
Esta seo contm i nformaes sobre as propri edades das Zonas do objeto E2Text.
BackgroundColor
Defi ne a cor de fundo do texto da Zona. O val or padro dessa propri edade
branco (RGB(255, 255, 255)).
Blink
Indi ca que esta Zona parti ci pa do efei to de pi scar. O val or padro dessa
propri edade Fal so. Se esti ver habi l i tada, esta Zona al terna com a Zona padro,
conforme o tempo defi ni do na propri edade BlinkTime do objeto E2Text.
HorizontalAlignment
Defi ne o al i nhamento do texto. Os val ores possvei s so:
Maximum
Defi ne o val or mxi mo para a Zona. O val or padro dessa propri edade 20000.
Message
Defi ne o texto associ ado Zona. Esta mensagem ser mostrada quando o Tag
associ ado esti ver dentro dos l i mi tes da Zona.
Minimum
Defi ne o val or mni mo para a Zona. O val or padro dessa propri edade 0 (zero).
TextColor
Defi ne a cor do texto da Zona. O val or padro dessa propri edade preto (RGB(0,
0, 0)).
TextFont
Defi ne o esti l o, a cor e o tamanho da fonte usada para mostrar o texto da
mensagem. Esta propri edade no pode ser uti l i zada Associ aes. Veja a
propri edade TextFont dos objetos Texto, Di spl ay e SetPoi nt para mai ores
i nformaes sobre as subpropri edades que podem ser modi fi cadas vi a scri pt.
234 Visualizao
TipEnable
Habi l i ta ou desabi l i ta a di ca para a Zona. O val or padro dessa propri edade
Fal so.
TipText
Defi ne a di ca para a Zona. O val or padro dessa propri edade uma String vazi a.
Transparent
Defi ne que o fundo do objeto ser transparente quando esta Zona esti ver ati va.
4.3.2.14 Elipse KeyPad
Esta seo contm i nformaes sobre mtodos e propriedades do objeto El i pse
KeyPad. Este objeto no possui eventos associ ados.
4.3.2.14.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto El i pse KeyPad.
4.3.2.14.1.1 Hide
Hide()
Ocul ta o El i pse KeyPad. Este mtodo no tem efei to se o KeyPad j est i nvi svel .
4.3.2.14.1.2 Show
Show()
Mostra o El i pse KeyPad. Este mtodo no tem efei to se o KeyPad j est vi svel na
tel a.
Esta seo contm i nformaes sobre as propri edades do objeto El i pse KeyPad.
4.3.2.14.2.1 AutoHideOnEnter
Automati camente ocul ta o KeyPad quando a tecl a ENTER do tecl ado vi rtual
pressi onada.
4.3.2.14.2.2 AutoHideOnEsc
Automati camente ocul ta o KeyPad quando a tecl a ESC do tecl ado vi rtual
pressi onada.
Visualizao 235
4.3.2.14.2.3 Layout
Permi te al terar o layout de apresentao do KeyPad. Os val ores possvei s dessa
propri edade so:
br-simple: Mostra um tecl ado al fanumri co
Exemplo de KeyPad alfanumrico
num: Mostra um tecl ado numri co
Exemplo de KeyPad numrico
Exempl o:
' Alterna entre os modos Alfanumrico e Numrico
236 Visualizao
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 di mi nui o tamanho ori gi nal do KeyPad, uti l i zando um fator de
mul ti pl i cao. O tamanho ori gi nal do KeyPad mostrado na tabel a a segui r:
Valores padro de tamanho do KeyPad
LAYOUT LARGURA ALTURA
Alfanumrico
550 px 250 px
Numrico
200 px 300 px
O exempl o a segui r redi mensi ona o KeyPad para 75% do tamanho ori gi nal .
Sub Botao1_Click()
Application.GetKeyPad().SizeFactor = 0.75
Application.GetKeyPad().Show()
End Sub
4.3.2.14.2.5 Sound
Permi te al terar o som emi ti do ao cl i car-se em uma tecl a do KeyPad. O val or
padro desta propri edade uma String vazi a, si gni fi cando que nenhum som
emi ti do ao cl i car-se em uma tecl a. Caso seja al terado o val or dessa propri edade,
necessri o que o novo val or seja o cami nho absol uto de um arqui vo no formato
WAV ou ento que este arqui vo esteja i ncl udo no Domni o como um Recurso.
4.3.2.14.2.6 X
A coordenada X do canto superi or esquerdo do objeto KeyPad. Esta propri edade
pode ser usada para mover o KeyPad no senti do hori zontal .
4.3.2.14.2.7 Y
A coordenada Y do canto superi or esquerdo do objeto KeyPad. Esta propri edade
pode ser usada para mover o KeyPad no senti do verti cal .
4.4 E3Alarm
E3Al arm.
Visualizao 237
4.4.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto E3Al arm.
4.4.1.1 KeyPress
KeyPress(KeyAscii)
Ocorre quando o E3Al arm tem o foco de tecl ado e o usuri o pressi ona uma tecl a,
que corresponde a um caractere que pode ser mostrado em tel a (uma tecl a ANSI, de
Tecl a BACKSPACE
Tecl a ESC
Pressi onando-se a tecl a TAB
Pressi onando-se a tecl a ENTER
Pressi onando-se a tecl a DEL (essa tecl a no padro ANSI)
Pressi onando-se as setas do tecl ado
Enquanto um usuri o pressi ona uma tecl a que produz um cdi go ANSI, o E3Al arm
4.4.1.2 MouseMove
MouseMove()
Ocorre quando o pontei ro do mouse se move sobre o objeto E3Al arm.
238 Visualizao
4.4.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto E3Al arm.
4.4.2.1 AboutBox
AboutBox()
Este mtodo exi be uma cai xa de di l ogo com i nformaes sobre verso e copyright
do objeto E3Al arm.
4.4.2.2 AckAll
AckAll([Operator])
Permi te reconhecer gl obal mente todos os al armes. Operator uma String opci onal ,
que i ndi ca o nome do operador que reconheceu o al arme. Esse val or ser mostrado
na col una Operator do E3Al arm. Se for omi ti do, ser uti l i zado o usuri o atual do
Vi ewer, ou ento "(Sem usuri o)", caso no haja nenhum usuri o l ogado. Para o
reconheci mento em si necessri o que o usuri o l ogado tenha permi sso para
reconhecer al armes.
4.4.2.3 AckCurrentFilter
AckCurrentFilter([Operator])
Permi te reconhecer todos os al armes do fi l tro corrente. Operator uma String
opci onal , que i ndi ca o nome do operador que reconheceu o al arme. Esse val or ser
mostrado na col una Operator do E3Al arm. Se for omi ti do, ser uti l i zado o usuri o
atual do Vi ewer, ou ento "(Sem usuri o)", caso no haja nenhum usuri o l ogado.
Para o reconheci mento em si necessri o que o usuri o l ogado tenha permi sso
para reconhecer al armes.
4.4.2.4 AckSelected
AckSelected([Operator])
Permi te reconhecer os al armes sel eci onados. Se no houver al arme sel eci onado no
E3Al arm, o mtodo fal ha. O usuri o poder reconhecer o al arme (neste caso, ser
i nseri do um novo regi stro no Banco de Dados i ndi cando o reconheci mento), e no
E3Al arm a l i nha correspondente i ndi car que el e foi reconheci do. Operator uma
String opci onal , que i ndi ca o nome do operador que reconheceu o al arme. Esse
val or ser mostrado na col una Operator do E3Al arm. Se for omi ti do, ser uti l i zado
o usuri o atual do Vi ewer, ou ento "(Sem usuri o)", caso no haja nenhum
usuri o l ogado. Para o reconheci mento em si necessri o que o usuri o l ogado
tenha permi sso para reconhecer al armes.
Visualizao 239
4.4.2.5 GetFocusedEvent
GetFocusedEvent()
Este mtodo retorna um objeto com as propri edades do evento sel eci onado (aquel e
que tem o foco atual ) no E3Al arm, caso haja al gum evento sel eci onado. Se nenhum
evento esti ver sel eci onado, o mtodo retornar um objeto Nothing.
As propri edades do objeto retornado contm os val ores dos campos do evento
sel eci onado. O objeto contm uma cpi a dos val ores no momento da chamada do
mtodo, portanto se houver uma mudana no evento sel eci onado, as propri edades
no sero atual i zadas automati camente, sendo necessri o uti l i zar o mtodo
sempre que houver necessi dade de obter i nformaes atual i zadas do evento
sel eci onado. As propri edades do objeto retornado pel o mtodo so as segui ntes:
Propriedades do objeto retornado por GetFocusedEvent
NOME DESCRIO
Acked
I nforma se o al arme foi reconheci do ou
no. Este campo pode assumi r os val ores 0,
no reconheci do e 1, reconheci do.
AckRequired
Determi na o reconheci mento automti co
do al arme. Este campo apresenta os
val ores 0, reconheci mento automti co e 1,
reconheci mento manual .
AckTime
Regi stra a data e hora do E3 no momento
em que o al arme reconheci do, ou zero
(30/12/1899), enquanto o al arme no for
reconheci do. No caso de al armes que no
pedem reconheci mento, o campo assume a
data e hora do E3 no momento em que o
al arme fi ca ati vo.
ActorID
Nome do operador que reconheceu o
al arme. Pode ser:
O usuri o l ogado no Vi ewer, quando o
reconheci mento fei to no E3Al arm (ou
"Sem usuri o", se no h usuri o
l ogado)
"System", quando o reconheci mento
automti co (ou seja, para al armes que
pedem reconheci mento)
Um nome passado por scri pt (por
exempl o, usando AckArea, AckAllAlarms,
LogTrackingEvent do Servi dor de Al armes,
ou Ack da Fonte de Al armes)
O l i mi te deste campo, quando armazenado
no Banco de Dados, de 50 caracteres.
240 Visualizao
NOME DESCRIO
AlarmSourceName
Regi stra o nome da Fonte de Al arme. O
l i mi te deste campo, quando armazenado
no Banco de Dados, de 100 caracteres. Por
exempl o, FonteAlarme1.
Area
Para eventos de al armes, o nome da rea
a qual a Fonte de Al armes pertence. Para
outros eventos (por exempl o, usando o
mtodo LogTrackingEvent do Servi dor de
Al armes), pode ser um texto defi ni do pel o
usuri o. O l i mi te deste campo, quando
armazenado no Banco de Dados, de 100
caracteres.
ConditionActive
I ndi ca se a Fonte de Al armes est em
al arme. Este campo apresenta os estados
0, condi o no ati va e 1, condi o ati va.
ConditionName
Nome da condi o, se for um evento de
al arme. Este campo pode apresentar os
segui ntes val ores:
Banda Morta: Fonte de Al arme do ti po
Banda Morta
Digital: Fonte de Al arme do ti po Di gi tal
Nvel: Fonte de Al arme do ti po Anal gi co
TaxaDeVariao: Fonte de Al arme do ti po
Taxa de Vari ao
Se o evento no for um al arme (por
exempl o, usando o mtodo LogTrackingEvent
do Servi dor de Al armes), este val or ser
sempre uma String vazi a.O l i mi te deste
campo, quando armazenado no Banco de
Dados, de 100 caracteres.
CurrentValue
Determi na o val or da Fonte de Al arme
(converti do para Double) no momento do
evento. Para outros eventos (por exempl o,
usando o mtodo LogTrackingEvent), o val or
ser sempre zero (0). O l i mi te deste campo,
quando armazenado no Banco de Dados,
de 100 caracteres.
Enabled
Determi na se a veri fi cao do al arme est
habi l i tada. Este campo apresenta os
estados 0, veri fi cao da Fonte de Al arme
desabi l i tada e 1, veri fi cao da Fonte de
Al arme habi l i tada.
Visualizao 241
NOME DESCRIO
EventCategory
Categori a do evento. Para al armes, este
campo pode assumi r os segui ntes val ores:
Banda Morta: Fonte de Al arme do ti po
Banda Morta
Digital: Fonte de Al arme do ti po Di gi tal
Nvel: Fonte de Al arme do ti po Anal gi co
TaxaDeVariao: Fonte de Al arme do ti po
Taxa de Vari ao
Para outros eventos (por exempl o, usando
o mtodo LogTrackingEvent do Servi dor de
Al armes), o campo pode assumi r val ores
defi ni dos pel o usuri o. O l i mi te deste
EventCLSID
I denti fi cador ni co para toda a vi da de um
al arme. Quando um al arme novo ocorre em
uma Fonte, gerado um novo nmero de
EventCLSI D; assi m, el e i r manter esse
mesmo CLSI D no banco de dados, enquanto
no sai r da l i sta de al armes ati vos e no
reconheci dos.
EventTime
Data e hora do val or da Fonte de Al arme no
momento do evento.
EventTimeUTC
Data e hora do val or da Fonte de Al arme no
momento do evento, com rel ao ao
horri o de Greenwi ch. O val or o mesmo
do campo EventTime, sendo manti do no E3
por questes de compati bi l i dade.
EventType
Ti po do evento. Para eventos de al arme,
sempre Condition. Para outros eventos, pode
ser um texto defi ni do pel o usuri o, como
por exempl o, usando o mtodo
LogTrackingEvent do Servi dor de Al armes
(Tracki ng, Si mpl e, etc.). O l i mi te deste
FormattedValue
Mostra o val or formatado da Fonte de
Al arme que vai para o seu evento. O l i mi te
deste campo, quando armazenado no
Banco de Dados, de 100 caracteres. NOTA:
Este campo somente de l ei tura.
FullAlarmSourceName
Regi stra o cami nho compl eto da Fonte de
Al arme, i ncl ui ndo reas, nome da
Confi gurao de Al armes e de possvei s
Pastas onde esta possa estar i nseri da. Por
exempl o,
Pasta1.ConfigAlarmes1.Area1.FonteA
larme1.
242 Visualizao
NOME DESCRIO
InTime
Regi stra a data e hora do val or no
momento em que el e entra na condi o de
al arme.
Message
o texto confi gurado na Fonte de Al arme,
ou especi fi cado por um outro evento (por
exempl o, usando o mtodo LogTrackingEvent
do Servi dor de Al armes). O l i mi te deste
OutTime
Regi stra a data e hora do val or no
momento em que el e sai da condi o de
al arme; ou zero (30/12/1899), enquanto o
al arme ai nda no tenha sado da condi o
ati va.
Quality
Qual i dade do val or da Fonte de Al arme no
momento do evento. Este campo assume os
val ores numri cos
0 - 63: qual i dade rui m
64 - 127: qual i dade i ncerta
128 - 191: val or i ndefi ni do
192 - 255: qual i dade boa
exempl o, se el e esti ver usando o mtodo
LogTrackingEvent do Servi dor de Al armes),
este campo ser i gual a uma String vazi a.
Exempl o: Rui m (0); I ncerta (64); ?? (128); Boa
(192).
Severity
o val or de severi dade confi gurado na
Fonte de Al arme. Este campo pode assumi r
os val ores 0, al ta; 1, mdi a; 2, bai xa. El e
pode tambm assumi r outro val or defi ni do
pel o usuri o se for um evento, como por
exempl o quando esti ver usando o mtodo
LogTrackingEvent.
Source
Para eventos de al arme, i nforma a
expresso uti l i zada para aval i ar as
condi es de al arme. O l i mi te deste
Dados, de 100 caracteres. Por exempl o,
Dados.TagDemo1.Value.
Visualizao 243
NOME DESCRIO
SubConditionName
Nome da subcondi o, se for um evento de
al arme. Este campo pode assumi r os
segui ntes val ores:
BM: Al arme de Banda Morta
DIG: Al arme Di gi tal
TV: Al arme Taxa de Vari ao
LOLO: Al arme Anal gi co na fai xa Mui to
Bai xo
LO: Al arme Anal gi co na fai xa Bai xo
HI: Al arme Anal gi co na fai xa Al to
HIHI: Al arme Anal gi co na fai xa Mui to
Al to
exempl o, se el e esti ver usando o mtodo
LogTrackingEvent do Servi dor de Al armes),
este campo ser i gual a uma String vazi a. O
l i mi te deste campo, quando armazenado
no Banco de Dados, de 100 caracteres.
UserField
Propri edade de l ei tura i ndexada, cujo
ndi ce vari a de 1 at o nmero total de
campos cri ados pel o usuri o.
Exempl o:
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)
244 Visualizao
str = str & "FormattedValue = " & evt.FormattedValue & Chr
(13)
str = str & "UserField(1) = " & evt.UserField(1) & 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 i nformaes sobre as propri edades do objeto E3Al arm.
NOTA: O E3 uti l i za, para defi ni o de coordenadas e espessura, o si stema Hi metri c.
seja, cada 1000 uni dades equi val em a um centmetro. Assi m, este o padro
adotado na descri o das propri edades do E3, quando apl i cvel .
4.4.3.1 ActiveAlarms
Determi na o nmero total de al armes ati vos do objeto. Esta propri edade
4.4.3.2 ActiveHighAlarms
Indi ca o nmero de al armes ati vos com severi dade al ta. Esta propri edade
4.4.3.3 ActiveHighNACKAlarms
Indi ca o nmero de al armes no reconheci dos com severi dade al ta. Esta
propri edade somente de l ei tura.
4.4.3.4 ActiveLowAlarms
Indi ca o nmero de al armes ati vos com severi dade bai xa. Esta propri edade
Visualizao 245
4.4.3.5 ActiveLowNACKAlarms
Indi ca o nmero de al armes no reconheci dos com severi dade bai xa. Esta
4.4.3.6 ActiveMedAlarms
Indi ca o nmero de al armes ati vos com severi dade mdi a. Esta propri edade
4.4.3.7 ActiveMedNACKAlarms
Indi ca o nmero de al armes no reconheci dos com severi dade mdi a. Esta
4.4.3.8 ActiveNACKAlarms
Indi ca o nmero total de al armes que esto sem reconheci mento no objeto (ati vos
ou no). Esta propri edade somente de l ei tura.
4.4.3.9 AlarmServer
Nome do Servi dor de Al armes ni co exi stente na apl i cao.
4.4.3.10 AllowAckAll
Habi l i ta a opo presente no menu contextual do E3Al arm, que permi te o
reconheci mento de todos os al armes. O val or padro desta propri edade True.
4.4.3.11 AllowAckCurrentFilter
reconheci mento de todos os al armes do fi l tro atual . Se no houverem al armes
vi svei s, a propri edade no tem efei to. O val or padro desta propri edade True.
4.4.3.12 AllowAckSelected
reconheci mento de al armes sel eci onados. Se no houver al armes sel eci onados, a
propri edade no tem efei to. O val or padro desta propri edade True.
4.4.3.13 AllowColumnClick
Habi l i ta ou desabi l i ta a sel eo dos campos e a di reo de ordenao destes,
atravs do cl i que no cabeal ho das col unas do E3Al arm em tempo de execuo. Se
esta opo esti ver confi gurada para True e o cabeal ho esti ver vi svel (ver a
246 Visualizao
propri edade ColumnHeader), ao cl i car no ttul o da col una os dados sero
ordenados, tendo esta col una como chave. Cl i cando novamente nesta mesma
col una, a ordenao ser fei ta na di reo contrri a (muda-se a ordem ascendente
para descendente e vi ce-versa). Ao cl i car na col una com a tecl a SHIFT pressi onada,
o campo usado como segunda chave. Como na chave pri mri a, um segundo cl i que
com SHIFT i nverte a ordenao do campo secundri o.
4.4.3.14 AreaFilter
Control a as reas de al armes vi svei s no E3Al arm. Se seu val or no for uma
String vazi a, so apresentados eventos cujo nome das reas comecem com o texto
i ndi cado. Por exempl o, se AreaFilter i gual a "Ana", so mostrados os al armes de
reas como "Anal ogi cos.Producao" ou "Anal i se", mas no "Di gi tai s.Anal i se" ou
"Di gi tai s.Producao". Quando a propri edade SimpleAreaFilter esti ver confi gurada
como Fal se, a rea de Al arme tambm permi te o uso de cori ngas para a fi l tragem (*
ou ?), e permi te ml ti pl os fi l tros de rea, separados por doi s pontos. Os cori ngas
permi ti dos so:
"*": Acei ta nenhum ou qual quer quanti dade de caracteres
"?": Acei ta um caractere qual quer
"#": Acei ta um dgi to qual quer
"[ ]": Permi te especi fi car um conjunto de caracteres
"[ab]": Acei ta um caractere se for "a" ou "b"
"[f-h]": Acei ta um caractere entre "f" e "h"
"[!cz]": Acei ta um caractere que no seja nem "c" nem "z"
"[!m-p]": Acei ta um caractere que no esteja entre "m" e "p"
O padro dessa propri edade uma String vazi a, ou seja, sem fi l tragem por rea
(ver tambm as propri edades CustomFilter, SimpleAreaFilter, ShowHighPriority,
ShowMediumPriority e ShowLowPriority).
NOTA: A propri edade AreaFilter corresponde propri edade Filter, di sponvel at a
verso 4.0 do E3.
4.4.3.15 BannerMode
Habi l i ta a vi sual i zao de apenas uma mensagem no E3Al arm. A mensagem
mostrada depender da confi gurao de ordenao e sempre estar sel eci onada. O
val or padro desta propri edade Fal so. Para mai ores i nformaes sobre a
confi gurao de ordenao, consul te o tpi co Aba Ordenao, no Manual do
Usurio do E3.
Visualizao 247
4.4.3.16 BorderColor
Defi ne a cor da borda do E3Al arm. O val or padro desta propri edade preto
(RGB(0, 0, 0)).
4.4.3.17 BorderThickness
Defi ne a espessura da borda do E3Al arm. O val or desta propri edade pode vari ar
entre 0 (zero, que desabi l i ta a borda) e 10, e seu padro 1 (um).
4.4.3.18 ColumnHeader
Quando confi gurada como True, esta propri edade habi l i ta a vi sual i zao do
cabeal ho do E3Al arm. O cabeal ho tambm permi te que seja fei ta a reordenao
dos dados da tabel a vi sual mente (ver propri edade AllowColumnClick). O val or
4.4.3.19 CustomFilter
Permi te i nformar um fi l tro customi zado para os al armes, na forma de uma
expresso. Os segui ntes campos esto di sponvei s para uti l i zao na expresso do
fi l tro:
AckRequired (Booleano): Indi ca se necessri o reconhecer esta mensagem.
Acked (Booleano): Indi ca se esta mensagem j foi reconheci da.
AckTime (Data): Data e hora em que a condi o de al arme foi reconheci da (ou
zero se no foi reconheci da).
ActiveSource (Inteiro): -1: None, 0: Acti veSource, 1: Scada, 2: Operator, 3: CCLi nk,
4: Bi l l i ng, 5: Cal cul ated, 6: Database, 100: Topol ogyProcessor, 101: PowerFl ow,
102: StateEsti mator, 103: LoadSheddi ng.
ActorID (String): Logi n do usuri o que reconheceu a mensagem (ou uma String
vazi a se a mensagem ai nda no foi reconheci da).
AlarmArea (String): rea deste al arme.
AlarmSourceName (String): Nome do objeto Fonte de Al arme (apenas o nome, no
o cami nho compl eto).
ChangeMask (Inteiro): Campo no uti l i zado pel o E3 atual mente, sempre em 0
(zero).
ConditionName (String): Nome da l ti ma condi o de al arme ati va.
ConditionActive (Booleano): Indi ca se a condi o de al arme est ati va.
Cookie (Inteiro): Identi fi ca uma Fonte de Al arme durante uma seo de execuo.
248 Visualizao
CurrentValue (Double): Val or da Fonte no momento em que a condi o de al arme
fi cou ati va.
Enabled (Booleano): Indi ca se a veri fi cao de al armes na Fonte de Al arme est
habi l i tada.
EventCategory (String): Nome da categori a do al arme (por exempl o, "Nvel ", "Taxa
de Vari ao", "Banda Morta", "Di gi tal " ou "Di screto").
EventTime (Data): Data e hora da l ti ma atual i zao do evento.
EventTimeUTC (Data): Data e hora (UTC) da l ti ma atual i zao do evento.
EventType (String): "Event" (evento) ou "Condi ti on" (al arme).
FullAlarmSourceName (String): Nome compl eto do objeto Fonte de Al arme.
FormattedValue (String): Contm o val or (formatado) da Fonte no momento em
que a condi o de al arme fi cou ati va.
InTime (Data): Data e hora em que a condi o de al arme fi cou ati va.
Message (String): Mensagem do al arme.
OutTime (Data): Data e hora em que a condi o sai u de al arme (ou zero se ai nda
est ati va).
Quality (String): "Boa (xxx)", "Rui m (xxx)" ou "Incerta (xxx)".
Severity (Inteiro): 0: Al ta, 1: Mdi a ou 2: Bai xa.
Source (String): Li nk da Fonte de Al arme.
SubConditionName (String): Nome da subcondi o de al arme (por exempl o,
"LOLO", "LO", "HI", "HIHI", "DIG", etc.).
Os campos defi ni dos pel o usuri o tambm podem ser uti l i zados na expresso do
fi l tro, uti l i zando-se o nome defi ni do no Servi dor de Al armes.
Ao todo, as mensagens que aparecem na l i stagem do E3Al arm sempre passam por
ci nco fi l tros:
Fi l tro por ti po (al arme ou evento) (propri edade FilterType)
Fi l tro por severi dade (propri edades ShowLowPriority, ShowMediumPriority e
ShowHighPriority)
Fi l tro por rea (propri edades AreaFilter e SimpleAreaFilter)
Fi l tro pel a propri edade CustomFilter
Fi l tro do sumri o de al armes (equi val ente expresso "Enabl ed AND
(Condi ti onActi ve OR (AckRequi red AND NOT Acked))")
Visualizao 249
Exempl os de uti l i zao da propri edade CustomFilter:
Para um campo de usuri o chamado IsSupressed, e que se quei ra mostrar
apenas al armes em que este campo tem val or di ferente de zero, a expresso a ser
uti l i zada a segui nte:
IsSupressed <> 0
Para mostrar apenas mensagens com a subcondi o "HIHI" ou "LOLO" de objetos
de al arme cujo nome i ni ci e por "Pressure", a expresso a ser uti l i zada a
segui nte:
(SubConditionName = "HIHI" OR SubConditionName = "LOLO") AND
(Mid(AlarmSourceName, 1, 8) = "Pressure")
4.4.3.20 Domain
Especi fi ca o Domni o ao qual o E3Al arm i r se conectar. O padro desta
propri edade uma String vazi a, ou seja, o E3Al arm se conecta ao mesmo Domni o
do Vi ewer onde el e se encontra. Por exempl o, \\NomeDeOutroServidor.
4.4.3.21 Enabled
Habi l i ta o objeto Acti veX no projeto. O val or padro desta propri edade True.
4.4.3.22 FilterType
Efetua os fi l tros de al arme. As opes di sponvei s so:
1 - OnlyAlarms: mostra apenas al armes
2 - OnlyEvents: mostra apenas eventos
3 - AlarmsAndEvents: mostra tanto al armes quanto eventos
4.4.3.23 Font
Determi na a fonte (ti po de l etra) do cabeal ho e das l i nhas do E3Al arm. Esta
propri edade somente de l ei tura e s pode ser modi fi cada vi a Studi o, no em
tempo de execuo.
4.4.3.24 FourthSortAscending
Quando esta propri edade esti ver confi gurada para Fal se, a ordenao de eventos
pel o campo quaternri o ser no senti do descendente. Caso contrri o, o senti do
ser ascendente. O val or padro desta propri edade Fal se.
250 Visualizao
4.4.3.25 FourthSortField
Determi na o campo quaternri o para a ordenao dos eventos no E3Al arm. O
nome do campo deve ser sempre especi fi cado em i ngl s (veja os campos
di sponvei s no Manual do Usurio do E3). O val or padro dessa propri edade uma
String vazi a. Esta propri edade no tem efei to quando as propri edades
PrimarySortField, SecondarySortField ou ThirdSortField forem confi guradas como
uma String vazi a.
4.4.3.26 GridBkColor
Esta propri edade determi na a cor de fundo do E3Al arm. O val or padro desta
propri edade a cor confi gurada no Wi ndows para o i tem Janela (Painel de Controle
- Vdeo - Aparncia - Avanada).
4.4.3.27 InactiveHighNACKAlarms
Indi ca o nmero de al armes i nati vos e no reconheci dos com severi dade al ta.
Esta propri edade somente de l ei tura.
4.4.3.28 InactiveLowNACKAlarms
Indi ca o nmero de al armes i nati vos e no reconheci dos com severi dade bai xa.
4.4.3.29 InactiveMedNACKAlarms
Indi ca o nmero de al armes i nati vos e no reconheci dos com severi dade mdi a.
4.4.3.30 InactiveNACKAlarms
Determi na o nmero total de al armes i nati vos e no reconheci dos. Esta
4.4.3.31 PopupMenu
Habi l i ta um menu contextual ao cl i car com o boto di rei to do mouse sobre o
objeto E3Al arm. O val or padro desta propri edade True.
4.4.3.32 PrimarySortAscending
pel o campo pri mri o ser no senti do descendente. Caso contrri o, o senti do ser
ascendente. O val or padro desta propri edade Fal se.
Visualizao 251
4.4.3.33 PrimarySortField
Determi na o campo pri mri o para a ordenao dos eventos no E3Al arm. O nome
do campo deve ser sempre especi fi cado em i ngl s (veja os campos di sponvei s no
Manual do Usurio do E3). O val or padro dessa propri edade "EventTi me".
Quando esta propri edade uma String vazi a, as propri edades SecondarySortField,
ThirdSortField e FourthSortField no tm efei to.
4.4.3.34 SecondarySortAscending
Quando esta propri edade esti ver confi gurada para True, a ordenao de eventos
pel o campo secundri o ser no senti do ascendente. Caso contrri o, o senti do ser
descendente. O val or padro desta propri edade Fal se.
4.4.3.35 SecondarySortField
Determi na o campo secundri o para a ordenao dos eventos no E3Al arm. O
nome do campo deve ser sempre especi fi cado em i ngl s (veja os campos
di sponvei s no Manual do Usurio do E3). O val or padro dessa propri edade uma
String vazi a. Esta propri edade no tem efei to quando a propri edade
PrimarySortField for confi gurada como uma String vazi a.
4.4.3.36 ShowHighPriority
Fi l tra quai s al armes so mostrados ou no, de acordo com a sua severi dade.
Quando esti ver em True, so mostrados os al armes de severi dade al ta; do
contrri o, estes al armes no so mostrados. O val or padro desta propri edade
True.
4.4.3.37 ShowLowPriority
Quando esti ver em True, so mostrados os al armes de severi dade bai xa; do
True.
4.4.3.38 ShowMediumPriority
Quando esti ver em True, so mostrados os al armes de severi dade mdi a; do
True.
252 Visualizao
4.4.3.39 SimpleAreaFilter
Quando esta propri edade for i gual a Verdadei ro, o comportamento de fi l tragem
pel o nome de rea de Al armes baseado apenas na coi nci dnci a da parte i ni ci al
do nome. Quando for i gual a Fal so, o comportamento l eva em conta todo o nome da
rea, mas permi te o uso de caracteres cori nga e ml ti pl os fi l tros de rea, que
devem ser separados por doi s pontos. Ver tambm a propri edade AreaFilter, que
especi fi ca o fi l tro por nome de rea.
4.4.3.40 ThirdSortAscending
pel o campo terci ri o ser no senti do descendente. Caso contrri o, o senti do ser
ascendente. O val or padro desta propri edade Fal se.
4.4.3.41 ThirdSortField
Determi na o campo terci ri o para a ordenao dos eventos no E3Al arm. O nome
do campo deve ser sempre especi fi cado em i ngl s (veja os campos di sponvei s no
Manual do Usurio do E3). O val or padro dessa propri edade uma String vazi a.
Esta propri edade no tem efei to quando as propri edades PrimarySortField ou
SecondarySortField forem confi guradas como uma String vazi a.
4.5 E3Browser
E3Browser.
4.5.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto E3Browser.
4.5.1.1 KeyPress
KeyPress(KeyAscii)
Ocorre quando o E3Browser tem o foco de tecl ado e o usuri o pressi ona uma tecl a,
que corresponde a um caractere que pode ser mostrado em tel a (uma tecl a ANSI, de
Tecl a BACKSPACE
Visualizao 253
Tecl a ESC
Pressi onando-se a tecl a TAB
Pressi onando-se a tecl a ENTER
Pressi onando-se a tecl a DEL (essa tecl a no padro ANSI)
Pressi onando-se as setas do tecl ado
Enquanto um usuri o pressi ona uma tecl a que produz um cdi go ANSI, o E3Browser
4.5.1.2 MouseMove
MouseMove()
Ocorre quando o pontei ro do mouse se move sobre o objeto E3Browser.
4.5.1.3 OnDrawRow
OnDrawRow(Selected, Line, TextColor, BackColor)
Este evento passa quatro parmetros: Selected i ndi ca se a l i nha est sel eci onada;
Line i ndi ca o nmero da l i nha sendo desenhada; TextColor i ndi ca a cor do texto da
l i nha; e BackColor i ndi ca a cor de fundo do texto. Se a cor for modi fi cada dentro
deste evento, esta modi fi cao ser usada pel o E3Browser no desenho da l i nha.
Outra modi fi cao i mportante que se o mtodo GetColumnValue for chamado de
dentro do evento, os val ores retornados sero os da l i nha sendo desenhada, e no
os da l i nha sel eci onada.
4.5.1.4 OnFormatCell
OnFormatCell(Column, FieldName, OriginalValue, FormattedValue)
Este evento permi te personal i zar o formato do texto das cl ul as do E3Browser. Os
parmetros deste evento so os segui ntes:
Column: ndi ce da col una vi svel do E3Browser (i ni ci ando em 0). Permi te
i denti fi car a col una da cl ul a que est sendo formatada
FieldName: Texto com o nome do campo da col una sendo formatada
254 Visualizao
OriginalValue: Val or no formatado da cl ul a, do ti po Variant
FormattedValue: Val or formatado, do ti po Variant, de acordo com a
confi gurao da col una do E3Browser. Se for modi fi cado dentro do evento,
permi te al terar o texto formatado
Exempl o (formatao de campos de Al armes):
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"
ElseIf OriginalValue = 1 Then
FormattedValue = "Mdia"
Else
FormattedValue = "Baixa"
End If
End If
End Sub
4.5.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto E3Browser.
4.5.2.1 AboutBox
AboutBox()
Este mtodo exi be uma cai xa de di l ogo com i nformaes sobre verso e copyright
do objeto E3Browser.
4.5.2.2 ClearFields
ClearFields()
Li mpa a formatao de col unas e l i nhas do E3Browser.
4.5.2.3 GetColumnValue
GetColumnValue(Index)
Retorna o val or de uma cl ul a, na col una i nformada e na l i nha sel eci onada. Este
mtodo possui o parmetro Index, que determi na o ndi ce da col una desejada.
Visualizao 255
4.5.2.4 Requery
Requery()
O mtodo Requery atual i za a Consul ta, uti l i zando sua confi gurao atual , e
retorna os dados para o E3Browser.
4.5.2.5 RetrieveE3QueryFields
RetrieveE3QueryFields()
O mtodo RetrieveE3QueryFields l a estrutura de dados da consul ta e atual i za a
formatao do E3Browser, com os campos defi ni dos na consul ta. Se for bem
sucedi do, retorna True. Caso contrri o, retorna Fal se. Este mtodo especi al mente
ti l quando se preci sa usar um ni co E3Browser para exi bi r dados de di ferentes
tabel as ou consul tas.
4.5.3 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto E3Browser.
4.5.3.1 AllowColumnResize
Habi l i ta ou desabi l i ta a confi gurao do tamanho das col unas da grade do
objeto, em tempo de execuo. Se esta propri edade esti ver confi gurada para Fal se,
o tamanho das col unas fi xo e no poder ser modi fi cado.
4.5.3.2 AllowRowResize
Habi l i ta ou desabi l i ta a confi gurao do tamanho das l i nhas da grade do objeto,
em tempo de execuo. Se esta propri edade esti ver confi gurada para Fal se, o
tamanho das l i nhas fi xo e no poder ser modi fi cado.
4.5.3.3 ColumnWidth
Determi na a l argura das col unas do E3Browser, em pi xel s.
4.5.3.4 CurSel
Indi ca a posi o atual do cursor do E3Browser, ou seja, o ndi ce da l i nha em que
el e est posi ci onado.
4.5.3.5 E3Query
Retorna o objeto Consul ta do E3Browser, para que se possa acessar suas
propri edades.
256 Visualizao
4.5.3.6 Fields
Retorna o objeto Campos do E3Browser, que contm a l i sta com todos os
campos da tabel a, tornando possvel a sua refernci a atravs dos i tens dessa
col eo. O val or padro desta propri edade vazi o. Exempl o:
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
4.5.3.7 FixedBkColor
Especi fi ca a cor do fundo da pri mei ra col una do E3Browser. O val or padro
desta propri edade a cor bege (RGB(236, 233, 216)).
4.5.3.8 FixedColumnWidth
Determi na a l argura da pri mei ra col una do E3Browser, em pi xel s. O val or padro
desta propri edade 30 pi xel s.
4.5.3.9 FixedRowFont
Determi na a fonte (texto) uti l i zada na l i nha de cabeal ho do E3Browser. Esta
confi gurada somente vi a Studi o. O val or padro desta propri edade a fonte Ari al .
4.5.3.10 FixedRowHeight
Determi na a al tura (em pi xel s) da l i nha de cabeal ho do E3Browser. O val or
4.5.3.11 FixedTextColor
Muda a cor do cabeal ho do E3Browser.
Determi na a cor de fundo da rea de dados do E3Browser. O val or padro desta
propri edade a cor branca (RGB(255, 255, 255)).
Visualizao 257
4.5.3.13 GridFont
Determi na a fonte uti l i zada nos textos da rea de dados do E3Browser. O val or
padro desta propri edade a fonte Ari al . Esta propri edade no pode ser uti l i zada
em scri pts ou em Associ aes, sendo confi gurada somente vi a Studi o.
4.5.3.14 GridLineColor
Determi na a cor das l i nhas da grade de dados do E3Browser. O val or padro
4.5.3.15 GridLinesType
Determi na o ti po de l i nhas a serem desenhadas na grade de dados do
E3Browser.
Opes disponveis para GridLinesType
OPO DESCRIO
0 - GLNone
Sem l i nhas separadoras.
1 - GLHorz
Somente as l i nhas hori zontai s (padro).
2 - GLVert
Somente as l i nhas verti cai s.
3 - GLBoth
Li nhas verti cai s e hori zontai s.
4.5.3.16 RefreshTime
Especi fi ca o tempo de atual i zao da Consul ta em rel ao ao Banco de Dados.
Atravs desta propri edade possvel veri fi car as atual i zaes dos dados no
Hi stri co rel aci onado, referente a um determi nado tempo esti pul ado (em
mi l i ssegundos). Quando a propri edade RefreshTime for i gual a 0, no h
atual i zao dos dados, e el es permanecem i nal terados.
4.5.3.17 RowHeight
Defi ne a al tura das l i nhas da E3Browser, em pi xel s. O val or padro desta
propri edade 20.
4.5.3.18 SelectRow
Estabel ece a possi bi l i dade de sel eo das l i nhas do E3Browser. Se esti ver
confi gurada para True, ser possvel sel eci onar as l i nhas; do contrri o, as l i nhas
no podem ser sel eci onadas.
258 Visualizao
4.5.3.19 SourceQuery
Contm a refernci a para o objeto Consul ta ao qual o E3Browser est associ ado.
NOTA: Para trocar a Consul ta do E3Browser por mei o de um scri pt (caso a nova
Consul ta modi fi que os campos da Consul ta ori gi nal ), al m de al terar a
propri edade SourceQuery, preci so uti l i zar os mtodos RetrieveE3QueryFields e
Requery.
4.5.3.20 TextBkColor
Especi fi ca a cor de fundo das cl ul as de dados do E3Browser. O val or padro
desta propri edade a cor branca (RGB(255, 255, 255)).
4.5.3.21 TextColor
Especi fi ca a cor do texto do E3Browser. O val or padro desta propri edade a cor
preta (RGB(0,0,0)).
4.5.3.22 TitleTipBkColor
Especi fi ca a cor do fundo do texto da di ca do E3Browser. O val or padro desta
propri edade a cor preta (RGB(0, 0, 0)).
4.5.3.23 TitleTipTextColor
Especi fi ca a cor do texto da di ca do E3Browser. O val or padro desta
propri edade a cor ci nza (RGB(204, 204, 204)).
4.5.3.24 ToolbarBkColor
Especi fi ca a cor de fundo da barra de funes do E3Browser. O val or padro
desta propri edade bege (RGB(236, 233, 216)).
4.5.3.25 ToolbarFont
Determi na a fonte uti l i zada nos textos da barra de funes do E3Browser. Esta
confi gurada somente vi a Studi o.
4.5.3.26 ToolbarForeColor
Especi fi ca a cor de frente da barra de funes do E3Browser. O val or padro
desta propri edade preto (RGB(0, 0, 0)).
Visualizao 259
4.5.4 Campos do E3Browser
Esta seo contm i nformaes sobre propriedades dos campos do objeto
E3Browser. Estes campos no possuem eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades dos campos do objeto
E3Browser.
4.5.4.1.1 BkColor
Determi na a cor de fundo do campo do E3Browser. O val or padro a cor
confi gurada no Wi ndows para o i tem 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 val or padro dessa propri edade preto (RGB
(0, 0, 0)).
4.5.4.1.3 Format
Confi gura o formatador usado na col una.
4.5.4.1.4 Name
Retorna o nome do campo.
4.5.4.1.5 Visible
Habi l i ta ou desabi l i ta a vi si bi l i dade do campo sel eci onado na Consul ta do
E3Browser. Se a propri edade esti ver confi gurada para True, o campo ser vi svel no
E3Browser. Caso contrri o, o campo no mostrado no E3Browser, em tempo de
execuo. O val or padro True.
4.5.4.1.6 Width
Retorna a l argura do campo, em uni dades Hi metri c.
4.6 E3Chart
E3Chart.
260 Visualizao
4.6.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto E3Chart.
4.6.1.1 OnCursorChange
OnCursorChange()
Ocorre quando o cursor do E3Chart muda de posi o. Por exempl o, pode-se cri ar
um scri pt para este evento quando for necessri o mostrar os val ores de posi o do
cursor na Tel a. Exempl o:
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
4.6.1.2 OnLegendClick
OnLegendClick(Row, Col, RowData)
Ocorre quando o usuri o cl i ca em uma l i nha da Legenda. Os parmetros Row e Col
i ndi cam, respecti vamente, a l i nha e a col una cl i cadas. O parmetro RowData o
ndi ce da Pena da Legenda onde ocorreu o cl i que. Exempl o:
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 mai s Consul tas so encerradas no objeto. Quando o evento
gerado, a chamada do mtodo FitAll ou FitPen pode causar probl emas caso se
esteja uti l i zando a Consul ta automti ca, j que o mtodo ati va outras Consul tas
at que todos os dados sejam l i dos. Neste caso, recomendado que o val or
passado pel os parmetros destes mtodos seja 1 (um), o que enquadra
verti cal mente as Penas.
4.6.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto E3Chart.
Visualizao 261
4.6.2.1 ClearPenMarks
ClearPenMarks()
Remove as marcas de pesqui sa de todas as Penas do E3Chart.
4.6.2.2 CopyConfig
CopyConfig(SourceChart[, Flags])
O mtodo CopyConfig copi a as confi guraes de um E3Chart para outro. O
parmetro SourceChart i ndi ca o E3Chart de ori gem, cujas propri edades sero
copi adas para o E3Chart que chamou o mtodo.
NOTA: No caso dos Rel atri os, o mtodo CopyConfig i r funci onar somente com
Penas do ti po Histrica.
Por exempl o, para copi ar a confi gurao de um E3Chart que est em uma Tel a
(ScreenChart) para outro que est dentro de um Rel atri o (ReportChart), o
segui nte scri pt pode ser adi ci onado no objeto Report associ ado ao Rel atri o:
Sub OnBeforePrint
Set Chart = _
Report.Sections("PageHeader").Controls("ReportChart")
Chart.CopyConfig(Application.GetFrame()._
Screen.Item("ScreenChart"))
Chart.LoadData()
Chart.FitAll()
End Sub
NOTA: Este mtodo tambm possui o parmetro opci onal e no usado Flags,
somente para fi ns de compati bi l i dade com verses anteri ores.
4.6.2.3 FitAll
FitAll([FitStyle])
Enquadra todas as Penas no E3Chart. O parmetro opci onal FitStyle i ndi ca o modo
de enquadramento das Penas em tempo de execuo:
0: Enquadra ambos os Ei xos ao mesmo tempo
1: Enquadra apenas o Ei xo Verti cal
2: Enquadra apenas o Ei xo Hori zontal
262 Visualizao
4.6.2.4 FitPen
FitPen(Pen[, FitStyle])
Enquadra uma Pena no E3Chart, especi fi cada pel o ndi ce ou pel o nome. O
parmetro Pen defi ne a Pena que ser enquadrada no E3Chart (ndi ce ou nome da
Pena). O parmetro opci onal FitStyle i ndi ca o modo de enquadramento das Penas
em tempo de execuo:
0: Enquadra ambos os Ei xos ao mesmo tempo
1: Enquadra apenas o Ei xo Verti cal
2: Enquadra apenas o Ei xo Hori zontal
Exempl o:
Set Chart = Screen.Item("E3Chart1")
Chart.FitPen(1)
Chart.FitPen("Pen1", 1)
' Enquadra a Pen1 somente na vertical
End Sub
4.6.2.5 LoadData
LoadData()
Carrega os dados no E3Chart. Este mtodo especi al mente usado para carregar os
dados antes de i mpri mi r, quando usado em um objeto Rel atri o.
NOTA: O mtodo LoadData ser sncrono somente se a Pena no esti ver em modo
Automtico.
4.6.2.6 ResetConfig
ResetConfig([Flags])
Remove todas as confi guraes ajustadas em um E3Chart, devol vendo-o ao estado
i ni ci al .
NOTA: Este mtodo tambm possui o parmetro opci onal e no usado Flags,
somente para fi ns de compati bi l i dade com verses anteri ores.
4.6.2.7 ShowCursors
ShowCursors()
Ati va o modo Pesquisa de Intervalo. Em tempo de execuo, este recurso pode ser
Visualizao 263
acessado atravs do cl i que com o boto di rei to do mouse sobre o objeto e
sel eci onando a opo Pesquisar Intervalos do menu de contexto.
4.6.2.8 ZoomIn
ZoomIn()
O mtodo ZoomIn aumenta o zoom no E3Chart, i sto , aproxi ma a vi sual i zao das
Penas. Em tempo de execuo, este recurso pode ser acessado atravs do cl i que
com o boto di rei to do mouse sobre o objeto e sel eci onando a opo Mais Zoom do
menu de contexto.
4.6.2.9 ZoomOut
ZoomOut()
O mtodo ZoomOut di mi nui o zoom no E3Chart, i sto , afasta a vi sual i zao das
Penas no E3Chart. Em tempo de execuo, este recurso pode ser acessado atravs
do cl i que com o boto di rei to do mouse sobre o E3Chart e sel eci onando a opo
Menos Zoom.
4.6.3 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto E3Chart.
4.6.3.1 Axes
Retorna a col eo de Ei xos do E3Chart. A parti r da, as propri edades da col eo
de Ei xos podem ser modi fi cadas.
4.6.3.2 BackColor
Determi na a cor de fundo do E3Chart. Para que esta cor aparea, a propri edade
ShowBackground deve estar confi gurada como True. O val or padro desta
propri edade bege (RGB(236, 233, 216)).
4.6.3.3 CursorBegin
Defi ne a posi o do cursor i ni ci al , entre 0 e 1. necessri o executar o mtodo
ShowCursors ou habi l i tar a opo Pesquisa de Intervalos para que os cursores
apaream.
4.6.3.4 CursorColor
Estabel ece a cor do cursor de pesqui sa de i nterval o. O val or padro vermel ho
(RGB(255, 0, 0)).
264 Visualizao
4.6.3.5 CursorEnd
Defi ne a posi o do cursor fi nal , entre 0 e 1. necessri o executar o mtodo
ShowCursors ou habi l i tar a opo Pesquisa de Intervalos para que os cursores
apaream.
4.6.3.6 CursorLineStyle
Esti l o de l i nha do cursor de pesqui sa de i nterval o. As opes di sponvei s so:
Opes disponveis para CursorLineStyle
OPO DESCRIO
0 - LS_Solid
Apl i ca uma l i nha sl i da no cursor de
i nterval o do E3Chart.
1 - LS_Dash
Apl i ca uma l i nha tracejada no cursor de
2 - LS_Dot
Apl i ca uma l i nha ponti l hada no cursor
de i nterval o do E3Chart.
3 - LS_Dashdot
Apl i ca uma l i nha trao e ponto no cursor
de i nterval o do E3Chart.
4 - LS_Dashdotdot
Apl i ca uma l i nha trao ponto ponto no
cursor de i nterval o do E3Chart.
5 - LS_Null
Apl i ca uma l i nha i nvi svel no cursor de
4.6.3.7 CursorLineWidth
Estabel ece a l argura do cursor de i nterval o.
4.6.3.8 CursorSearchStyle
Permi te que o cursor pesqui se os pontos do grfi co, de acordo com as segui ntes
opes:
0 - PointNearest: Pesqui sa o ponto mai s prxi mo
1 - LinearInterpolation: Pesqui sa um ponto i nterpol ado
2 - PointPrevious: Pesqui sa o ponto anteri or
4.6.3.9 ForeColor
Determi na a cor de frente do E3Chart. O val or padro desta propri edade preto
(RGB(0, 0, 0)).
Visualizao 265
Determi na a cor de fundo da grade do E3Chart. O val or padro desta propri edade
branco (RGB(255, 255, 255)). Exempl o:
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
Determi na o ttul o do Ei xo Hori zontal pri nci pal . Exempl o:
Set E3Chart1= Screen.Item("E3Chart1")
Old = E3Chart1.HorAxisTitle
MsgBox "Prxima"
E3Chart1.HorAxisTitle = "!Teste"
MsgBox "Voltar"
E3Chart1.HorAxisTitle = Old
End Sub
4.6.3.12 HorGrid
Determi na o ti po de l i nha que ser apl i cada na grade hori zontal do E3Chart.
Opes disponveis para HorGrid
OPO DESCRIO
0 - Solid
Apl i ca uma l i nha sl i da na grade
hori zontal do E3Chart.
1 - Dash
Apl i ca uma l i nha tracejada na grade
2 - Dot
Apl i ca uma l i nha ponti l hada na grade
hori zontal do E3Chart (padro).
3 - Dashdot
Apl i ca uma l i nha trao e ponto na grade
4 - Dashdotdot
Apl i ca uma l i nha trao ponto ponto na
grade hori zontal do E3Chart.
5 - Invisible
Apl i ca uma l i nha i nvi svel na grade
Exempl o:
266 Visualizao
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
Determi na a cor da grade hori zontal do objeto E3Chart. O val or padro desta
propri edade ci nza (RGB(192, 192, 192)). Exempl o:
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
4.6.3.14 HorMinorTicks
Determi na o nmero de subdi vi ses das escal as hori zontai s da grade. O val or
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
Determi na o val or i ni ci al apl i cado na escal a hori zontal pri nci pal da grade. Este
val or pode ser numri co para E3Charts XY, ou Data para E3Charts com escal a de
tempo fi xa. Para E3Charts de tempo real , esta propri edade no apl i cada, sendo
ento uti l i zada a propri edade TimeSpan.
4.6.3.16 HorScaleEnd
Determi na o val or fi nal apl i cado na escal a hori zontal pri nci pal da grade. Este
val or pode ser numri co para E3Charts XY, ou Data para E3Charts com escal a de
Visualizao 267
tempo fi xa. Para E3Charts de tempo real , esta propri edade no apl i cada, sendo
ento uti l i zada a propri edade TimeSpan. Exempl o:
Sub ComboBox1_Change()
' Define qual consulta deseja mostrar
current_query_index = ListIndex
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()
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 val ores da
escal a hori zontal sero mostrados. Esta mscara pode representar vri os ti pos de
val ores:
268 Visualizao
A mscara destes formatos, como exempl i fi cadas no campo Tipo, ser exi bi da na
Janel a de Propri edades (por exempl o, d/M/yy H:mm, 0E-00, etc.).
4.6.3.18 HorTickUnit
Determi na o nmero de subdi vi ses entre as marcas da grade. Quando esta
propri edade esti ver com val or 0, o espaamento ser automti co. Exempl o:
Sub SubCommandButton1_Click()
Old = E3Chart1.HorTickUnit
For i = 0 To 30 Step 10
E3Chart1.HorTickUnit = i
MsgBox "E3Chart1.HorTickUnit = " & CStr(i)
Next
MsgBox "Voltar"
E3Chart1.HorTickUnit = Old
End Sub
4.6.3.19 Legend
Retorna o objeto Legenda do E3Chart. A parti r da, as propri edades da Legenda
podem ser modi fi cadas.
4.6.3.20 MouseMode
Sel eci ona uma das opes de tempo de execuo do menu do E3Chart. Os
val ores possvei s para essa propri edade so:
0 - MouseModeZoom: Col oca o mouse em modo Zoom por rea sel eci onada. Esta
opo est di sponvel nos grfi cos de escal a numri ca em XY e escal a fi xa.
Equi val e a sel eci onar a opo Caixa de Zoom do menu em tempo de execuo do
E3Chart
1 - MouseModePan: Col oca o mouse em modo de movi mentao das escal as.
Equi val e a sel eci onar a opo Mover do menu em tempo de execuo do E3Chart
2 - MouseModePanH: Col oca o mouse em modo de movi mentao das escal as
somente na di reo hori zontal . Equi val e a sel eci onar a opo Mover
horizontalmente do menu em tempo de execuo do E3Chart
3 - MouseModeSearch: Col oca o mouse em modo de pesqui sa de val ores nos
Visualizao 269
dados das Penas. Equi val e a sel eci onar a opo Pesquisar do menu em tempo de
execuo do E3Chart
4 - MouseModeCursors: Habi l i ta a opo de pesqui sa de i nterval os de tempo.
Equi val e a sel eci onar a opo Pesquisar Intervalos do menu em tempo de
execuo do E3Chart
4.6.3.21 Padding
Esta propri edade determi na a di stnci a, em pi xel s, entre o grfi co e a borda do
objeto E3Chart, conforme pode ser observado nas fi guras segui ntes atravs das
setas vermel has. O val or padro desta propri edade 10. Exempl o:
Propriedade Padding igual a 10
270 Visualizao
Propriedade Padding igual a 30
4.6.3.22 Pens
Retorna o objeto Col eo de Penas do E3Chart. O objeto Col eo de Penas
uti l i zado para i nseri r, remover ou acessar as Penas di sponvei s no E3Chart. Esta
propri edade somente de l ei tura. Exempl o:
For Each pen In Screen.Item("E3Chart1").Pens
pen.Visible = True
Next
End Sub
4.6.3.23 Queries
Retorna o objeto Col eo de Consul tas dentro do E3Chart. O objeto Col eo de
Consul tas uti l i zado para i nseri r, remover ou acessar as Consul tas di sponvei s no
E3Chart. Esta propri edade somente de l ei tura.
4.6.3.24 RefreshTime
Esta propri edade determi na o tempo de atual i zao do E3Chart.
Visualizao 271
4.6.3.25 ScaleFont
Determi na a fonte do texto uti l i zada na grade. Exempl o:
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
Habi l i ta ou desabi l i ta a vi sual i zao do fundo do grfi co. Se a propri edade for
i gual a True, o fundo do grfi co mostrado. Caso contrri o, o grfi co fi ca com o
fundo transparente. A cor escol hi da na propri edade BackColor no aparece se esta
propri edade esti ver em Fal se (opo padro). Exempl o:
E3Chart1.ShowBackground = Not E3Chart1.ShowBackground
End Sub
4.6.3.27 ShowBottomScale
Se a propri edade esti ver confi gurada para True, o Ei xo Hori zontal pri nci pal
mostrado na base da grade. Caso contrri o, no mostrado. O val or padro True.
Exempl o:
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
Habi l i ta ou desabi l i ta a vi sual i zao do fundo da grade. Se a propri edade for
i gual a True (padro), o fundo da grade mostrado. Caso contrri o, a grade fi ca
com o fundo transparente. A cor escol hi da na propri edade GridBkColor no aparece
se esta propri edade esti ver em Fal se. Exempl o:
Set Chart1 = Screen.Item("E3Chart1")
Chart1.ShowGridBackground = Not Chart1.ShowGridBackground
End Sub
272 Visualizao
4.6.3.29 ShowLeftScale
Se a propri edade esti ver confi gurada para True, o Ei xo Verti cal pri nci pal ser
mostrado esquerda da grade. Caso contrri o, fi ca i nvi svel . Exempl o:
Chart.ShowLeftScale = Not Chart.ShowLeftScale
End Sub
4.6.3.30 ShowPopupMenu
Habi l i ta ou desabi l i ta a opo de mostrar o menu em tempo de execuo do
E3Chart. Se o val or for i gual a True, o menu ser mostrado quando o usuri o cl i car
com o boto di rei to do mouse sobre o grfi co do E3Chart. Se o val or for i gual a
Fal se, o menu no mostrado. O val or padro dessa propri edade True.
4.6.3.31 ShowRightScale
Se a propri edade esti ver confi gurada para True, o Ei xo Verti cal pri nci pal da
escal a ser mostrado di rei ta da grade. Caso contrri o, fi ca i nvi svel . Exempl o:
Chart.ShowRightScale = Not Chart.ShowRightScale
End Sub
4.6.3.32 ShowTitle
Se a propri edade esti ver confi gurada para True, o ttul o pri nci pal do E3Chart
vi svel . Caso contrri o, fi ca i nvi svel . A propri edade Title contm o ttul o que ser
mostrado no E3Chart. Exempl o:
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
Visualizao 273
4.6.3.33 ShowTopScale
Se a propri edade esti ver confi gurada para True, o Ei xo Hori zontal pri nci pal
mostrado no topo da grade. Caso contrri o, no mostrado. O val or padro
Fal se. Exempl o:
Chart.ShowTopScale = Not Chart.ShowTopScale
End Sub
4.6.3.34 TimeSpan
Indi ca a escal a de tempo que aparece no Ei xo Hori zontal pri nci pal do E3Chart,
quando este for confi gurado para mostrar a escal a de tempo real . O val or desta
propri edade sempre em segundos. O val or padro desta propri edade 60.
4.6.3.35 Title
Determi na o ttul o pri nci pal do E3Chart. Para que o ttul o aparea no E3Chart, a
propri edade ShowTitle deve ser confi gurada para True.
4.6.3.36 TitleFont
Determi na a fonte do ttul o pri nci pal do E3Chart. Exempl o:
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
Determi na o ttul o do Ei xo Verti cal pri nci pal .
4.6.3.38 VerGrid
Determi na o ti po de l i nha que ser apl i cada na grade verti cal do E3Chart.
Opes disponveis para VerGrid
OPO DESCRIO
0 - Solid
Apl i ca uma l i nha sl i da na grade verti cal
do E3Chart.
274 Visualizao
OPO DESCRIO
1 - Dash
Apl i ca uma l i nha tracejada na grade
verti cal do E3Chart.
2 - Dot
Apl i ca uma l i nha ponti l hada na grade
verti cal do E3Chart (padro).
3 - Dashdot
Apl i ca uma l i nha trao e ponto na grade
4 - Dashdotdot
Apl i ca uma l i nha trao ponto ponto na
grade verti cal do E3Chart.
5 - Invisible
Apl i ca uma l i nha i nvi svel na grade
4.6.3.39 VerGridColor
Determi na a cor da l i nha do Ei xo Verti cal pri nci pal da grade. O val or padro
4.6.3.40 VerMinorTicks
Determi na o nmero de subdi vi ses entre as marcas do Ei xo Verti cal pri nci pal da
grade. O val or padro desta propri edade 1.
4.6.3.41 VerScaleBegin
Determi na o val or no topo no Ei xo Verti cal pri nci pal da grade do E3Chart. O val or
4.6.3.42 VerScaleEnd
Determi na o val or na base do Ei xo Verti cal pri nci pal da grade. O val or padro
desta propri edade -100.
4.6.3.43 VerScaleFormat
Contm um texto que representa uma mscara, dentro da qual os val ores da
escal a verti cal sero mostrados. Esta mscara pode representar vri os ti pos de
val ores:
Geral: No possui formatao especi fi ca, adaptando-se automati camente ao
Visualizao 275
(hexadeci mal , octal e bi nri a, por exempl o)
A mscara destes formatos, como exempl i fi cado no campo Tipo, ser exi bi da na
Janel a de Propri edades (por exempl o, d/M/yy H:mm, 0E-00, etc.).
4.6.3.44 VerTickUnit
Determi na o nmero de subdi vi ses entre as marcas da grade. Quando esta
propri edade esti ver com val or 0, o espaamento ser automti co. Exempl o:
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 i nformaes sobre mtodos e propriedades do objeto Col eo
de Penas. Este objeto no possui eventos associ ados.
4.6.4.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Col eo de Penas.
NOTA: A Col eo de Penas do E3Chart deve ser acessada atravs da propri edade
Pens.
276 Visualizao
4.6.4.1.1 AddPen
AddPen(Pen)
O mtodo AddPen adi ci ona uma nova Pena ao E3Chart, retornando a Pena cri ada.
Exempl o:
' 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
' Cria uma pena e associa a TagDemo1.
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)
Modi fi ca a ordem de desenho das Penas no E3Chart. Este mtodo possui os
segui ntes parmetros:
Source: Determi na o ndi ce da Pena a ser movi da (comeando em um)
Dest: Determi na o desti no da Pena (comeando em um)
Uma si tuao em que este mtodo especi al mente ti l quando tem-se uma Pena
com o desenho de l i nha e outra com o desenho de rea. Se a Pena de rea for
desenhada depoi s da Pena de l i nha, el a poder esconder a l ti ma. A sol uo ento
seri a i nverter a ordem de desenho destas Penas. Exempl o:
' Move a pena 1 para a posio 2.
Screen.Item("E3Chart1").Pens.ChangePenPos(1, 2)
End Sub
Visualizao 277
4.6.4.1.3 Item
Item(Index)
O mtodo Item retorna um objeto Pena da Col eo de Penas, especi fi cado pel o
ndi ce. Este mtodo possui o parmetro Index, que pode ser do ti po numri co (se
corresponder ao ndi ce da Pena) ou texto (se corresponder ao nome da Pena).
Exempl o:
' 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 especi fi cado. Este mtodo
possui o parmetro Name, que determi na o nome da Pena a ser removi da. Exempl o:
Screen.Item("E3Chart1").Pens.Remove(1)
End Sub
4.6.4.1.5 SetCursorPos
SetCursorPos(X, Range)
Posi ci ona o cursor de cada Pena do E3Chart. Equi val e ao comportamento de
chamar o mtodo SetCursorPos de cada Pena.
Esta seo contm i nformaes sobre as propri edades do objeto Col eo de Penas.
4.6.4.2.1 Count
Contm o nmero total de Penas i nseri das no E3Chart. Esta propri edade
4.6.4.3 Penas
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Pena. Este
4.6.4.3.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Pena.
278 Visualizao
4.6.4.3.1.1 AddPoint
AddPoint(ValueX, ValueY[, Quality])
Adi ci ona um ponto ao fi nal do buffer de tempo real . O tamanho do buffer s
vl i do aps a conexo da Pena. Se a Pena for cri ada no Studi o, a conexo
automti ca, mas se for cri ada vi a scri pt necessri o chamar o mtodo Connect
aps sua cri ao. Este mtodo deve ser usado com Penas de tempo real , e com a
propri edade UseTimeStamp em Fal se. O parmetro opci onal Quality i ndi ca a
qual i dade do ponto a ser i nseri do. Se este parmetro no for i nformado, a
qual i dade do ponto ser consi derada boa (192). O nmero de pontos que podem
ser adi ci onados a uma Pena est rel aci onado ao tamanho do buffer (propri edade
BufferSize da Pena).
4.6.4.3.1.2 Clear
Clear()
Apaga os dados do buffer de tempo real , sem di mi nui r seu tamanho. Este mtodo
no desconecta Associ aes, nem tampouco remove dados hi stri cos.
4.6.4.3.1.3 Connect
Connect()
O mtodo Connect faz a Pena conectar-se ao servi dor para receber os dados de
tempo real , associ ando as propri edades XLink e YLink. Se a Pena j esti ver
conectada, o mtodo fi ca i nati vo. Exempl o:
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 l i mpa os dados atuai s e faz com que a Pena no receba mai s
os dados de tempo real do seu Tag associ ado. Se a Pena j esti ver desconectada o
mtodo fi ca i nati vo. Quando o mtodo Disconnect usado em uma Pena Mi sta
(DataSourceType i gual a 2), el e remove a parte de tempo real , permanecendo a
parte hi stri ca. Em tempo de execuo, para que os dados de tempo real sejam
mostrados novamente preci so chamar o mtodo Connect. Exempl o:
Pen1.Disconnect()
Pen1.Connect()
End Sub
Visualizao 279
4.6.4.3.1.5 GetCursorPos
GetCursorPos(X, Y)
Retorna a posi o em que o cursor i nterceptou 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 sucedi do retorna True, caso contrri o, retorna Fal se. Exempl o:
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 mai s prxi mo ao val or de entrada em
ValueX. O parmetro ValueX i nforma o val or de refernci a para a busca do ponto, e
depoi s recebe o val or efeti vo da coordenada X do ponto mai s prxi mo encontrado.
O parmetro ValueY retorna o val or efeti vo da coordenada Y do ponto mai s
prxi mo encontrado. O mtodo retorna True se encontrou um ponto, e Fal se caso
contrri o.
4.6.4.3.1.7 SetCursorPos
SetCursorPos(X, Range)
Posi ci ona o cursor da Pena do E3Chart. O parmetro X i ndi ca em qual posi o o
cursor deve ser posi ci onado, si mi l ar ao comportamento de mover o cursor na
pesqui sa com o mouse. O cursor movi do para a posi o mai s prxi ma i ndi cada
por X. O parmetro Range opci onal e usado como val i dao. O cursor s ser
movi do se o ponto vl i do esti ver dentro do i nterval o. Qual quer val or negati vo
i ndi ca que o i nterval o passado no deve ser usado. Exempl o:
' 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)
280 Visualizao
' Envia o cursor para o ponto (1, 10).
SetCursorPos (2, 4)
Este mtodo retorna True se o cursor foi movi do, caso contrri o retorna Fal se.
Esta seo contm i nformaes sobre as propri edades do objeto Pena.
4.6.4.3.2.1 AutoQuery
Quando a propri edade AutoQuery est confi gurada para True, di z-se que a Pena
do ti po Consulta Automtica, ou si mpl esmente Pena Automtica. O objeti vo da
Pena Automti ca di mi nui r o consumo de memri a e o tempo de consul ta. Para
i sso, el a apl i ca fi l tros no campo E3Timestamp para trazer somente os dados
necessri os para dentro da rea do E3Chart. Toda vez que o perodo vi svel do
E3Chart for al terado, a Pena Automti ca trar os dados que esto fal tando para
compl etar o desenho daquel e perodo. Al m di sso, a Consul ta Automti ca tambm
compl eta os dados hi stri cos que esto fal tando para conectar as partes hi stri ca
e de tempo real da Pena. Se, por acaso, os dados hi stri cos no chegarem aps
tri nta segundos, a Consul ta Automti ca cancel ada naquel e trecho. Veja tambm a
propri edade MaxGapTime para mai ores detal hes.
Devi do ao modo como a Consul ta Automti ca apl i ca fi l tros para o campo
E3Timestamp, el a no est di sponvel para consul tas de Storage e cdi go SQL
customi zados pel o usuri o. Ou seja, mesmo que a propri edade AutoQuery esteja
confi gurada para True, el a no tem efei to se a Consul ta for do ti po Storage. Uma
das formas de reconhecer a Consul ta Automti ca o desenho hachurado na tel a do
E3Chart. Toda vez que aparecem hachuras no desenho, si gni fi ca que naquel e
perodo est ocorrendo uma Consul ta Automti ca. Quando o contorno da parte
hachurada esti ver na cor vermel ha, si gni fi ca que a Consul ta Automti ca daquel e
trecho est fal hando. Nesse caso, o E3Chart refaz a Consul ta do trecho com
probl emas.
Visualizao 281
NOTA: Di ferentemente da parte de tempo real , onde cada Pena possui seu prpri o
buffer de dados, a parte hi stri ca da Pena armazenada na Consul ta e
comparti l hada entre as Penas. Por exempl o, quando uma Consul ta tem trs
campos, E3Timestamp, Campo1 e Campo2, estes dados fi cam armazenados dentro da
Consul ta e esto di sposi o para as Penas que comparti l ham aquel a Consul ta.
Com i sso, a parte comum, geral mente o campo E3Timestamp, pode ser usada por
duas Penas di ferentes, sem que os dados sejam dupl i cados. No caso das Penas
Automti cas, duas Penas di ferentes podem usar a mesma tabel a e, devi do a
escal as di ferentes, el as podem carregar perodos di ferentes da Consul ta. Nessa
si tuao, cada Pena herda automati camente a parte carregada pel a outra Pena.
O objeto Consul ta no pode funci onar si mul taneamente em modo Automtico e No
Automtico. I sso si gni fi ca tambm que se Penas di ferentes, uma Automti ca e outra
No Automti ca, qui serem comparti l har a mesma Consul ta, esta Consul ta vai se
adaptar pri mei ra Pena que uti l i z-l a. Ou seja, a propri edade AutoQuery no
garante que a Consul ta do ti po Automtico, dependendo de outros fatores.
4.6.4.3.2.2 AverageY
Informa a mdi a da Pena no i nterval o, caso a propri edade EnableCalc esteja
habi l i tada. Caso o E3Chart esteja no modo de Pesquisa de Intervalos, mostra a
mdi a neste i nterval o; do contrri o, mostra a mdi a no i nterval o entre o i nci o e o
fi m no Ei xo Hori zontal . Val ores com qual i dade rui m no so consi derados caso a
propri edade ShowBadPoints esteja desabi l i tada. Esta propri edade somente de
l ei tura.
4.6.4.3.2.3 BkColor
Determi na a cor de fundo usada em uma Pena do ti po rea. O val or padro desta
4.6.4.3.2.4 BufferSize
Determi na o nmero de pontos manti dos na Pena de tempo real . Aps este val or,
os dados mai s anti gos so descartados. Nas Penas hi stri cas, esta propri edade
no tem efei to. Esta propri edade ser consi derada somente aps a conexo da
Pena. Para mai ores i nformaes, veja o mtodo Connect. O val or padro desta
propri edade 1000, e deve ser sempre mai or que 0. Exempl o:
Pen1.Disconnect()
Pen1.BufferSize = 5000
Pen1.Connect()
End Sub
4.6.4.3.2.5 Color
Determi na a cor da l i nha da Pena no E3Chart. O val or padro desta propri edade
vazi o.
282 Visualizao
4.6.4.3.2.6 DataSourceType
Determi na a ori gem dos dados da Pena. As opes di sponvei s para esta
Opes disponveis para DataSourceType
OPO DESCRIO
0 - Tempo Real
I ndi ca conexo da Pena a um Tag
atual i zado em tempo real .
1 - Histrico
I ndi ca conexo da Pena aos dados
vi ndos de uma consul ta.
2 - Pena Mista
I ndi ca conexo da Pena a Tags de tempo
real e dados hi stri cos
si mul taneamente.
Quando a propri edade DataSourceType for i gual a 0 (Tempo Real ), as propri edades
XLink e YLink i nformam os links uti l i zados; ou ento a propri edade UseTimeStamp
i nforma que a propri edade XLink no ser usada, estando em seu l ugar o timestamp
da propri edade YLink. Quando a propri edade DataSourceType for i gual a 1
(Hi stri co), as propri edades XField e YField i nformam os campos da tabel a a serem
usados. A propri edade QueryName i ndi ca o nome da tabel a usada. Quando
DataSourceType for i gual a 2 (Pena Mi sta), as opes 0 e 1 funci onaro
si mul taneamente para a Pena.
NOTA: Em tempo de execuo, quando a propri edade for al terada e a Pena dei xar
de mostrar os dados de tempo real , ser preci so chamar o mtodo Connect para que
estes dados sejam mostrados novamente.
Exempl o:
MsgBox "Clique OK para criar a pena."
Set Pen = E3Chart1.Pens.AddPen("Pen1")
Pen.DataSourceType = 0 ' Tempo real
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
Visualizao 283
4.6.4.3.2.7 DigitalData
Determi na o esti l o de pl otagem di gi tal . Se a propri edade esti ver confi gurada para
True, o esti l o de pl otagem di gi tal assume que a vari ao do dado seja de forma
di gi tal , ou seja, que seu val or em rel ao ao l ti mo vari ou i nstantaneamente. Caso
contrri o, a vari ao consi derada l i near e os pontos so uni dos por um
segmento de reta. O val or padro desta propri edade True.
4.6.4.3.2.8 EnableCalc
Habi l i ta ou desabi l i ta o cl cul o da mdi a, mni mos e mxi mos dentro do
i nterval o.
4.6.4.3.2.9 EnableHighLimit
Habi l i ta ou desabi l i ta a veri fi cao do l i mi te al to.
4.6.4.3.2.10 EnableLowLimit
Habi l i ta ou desabi l i ta a veri fi cao do l i mi te bai xo.
4.6.4.3.2.11 EU
Esta propri edade uti l i zada para i denti fi car a uni dade de engenhari a que o
val or representa, como por exempl o graus, metros, KW/h, etc.
4.6.4.3.2.12 HighlightMaxGapTime
Especi fi ca se a l i nha que conecta vi sual mente a parte hi stri ca e a parte de
tempo real de uma Pena Mi sta (defi ni da em MaxGapTime) deve ter uma cor
(defi ni da em MaxGapTimeColor) e um esti l o (defi ni do em MaxGapTimeStyle)
di ferenci ados. O val or padro desta propri edade Fal so.
4.6.4.3.2.13 HighLimit
Determi na o l i mi te de al arme al to.
4.6.4.3.2.14 InterpolatedBeginY
Informa o val or do ponto i nterpol ado onde o cursor i ni ci al cruza com a Pena.
4.6.4.3.2.15 InterpolatedEndY
Informa o val or do ponto i nterpol ado onde o cursor fi nal cruza com a Pena. Esta
284 Visualizao
4.6.4.3.2.16 LimitPenBkColor
Determi na a cor de fundo da Pena quando em al arme.
4.6.4.3.2.17 LimitPenColor
Determi na a cor da Pena quando em al arme.
4.6.4.3.2.18 LowLimit
Determi na o l i mi te de al arme bai xo.
4.6.4.3.2.19 MaxGapTime
Permi te especi fi car um tempo l i mi te a ser consi derado para a conexo vi sual
entre a parte hi stri ca e a parte de tempo real de uma Pena Mi sta. O val or padro
desta propri edade 0. O val or desta propri edade pode ser modi fi cado em tempo de
execuo.
NOTA: Esta propri edade est di sponvel a parti r da verso 3.5. Para apl i caes
cri adas em verses anteri ores e abertas na verso 3.5, o val or da propri edade
sempre 0.
4.6.4.3.2.20 MaxGapTimeColor
Permi te confi gurar a cor da conexo vi sual entre a parte hi stri ca e a parte de
tempo real de uma Pena Mi sta, defi ni da na propri edade MaxGapTime. O val or
padro desta propri edade vermel ho (RGB(255, 0, 0)).
4.6.4.3.2.21 MaxGapTimeStyle
Especi fi ca o esti l o da l i nha que estabel ece uma conexo vi sual entre a parte
hi stri ca e a parte de tempo real de uma Pena Mi sta, confi gurada na propri edade
MaxGapTime. Os val ores possvei s para esta propri edade so os segui ntes:
0: Sl i da
1: Tracejada
2: Ponti l hada
3: Trao - Ponto
4: Trao - Ponto - Ponto
5: Invi svel
Visualizao 285
NOTA: A opo 5 (I nvi svel ) desta propri edade s pode ser sel eci onada vi a scri pt.
4.6.4.3.2.22 MaxY
Informa o val or mxi mo da Pena no i nterval o, caso a propri edade EnableCalc
esteja habi l i tada. Caso o E3Chart esteja no modo de Pesquisa de Intervalos, mostra
a mdi a nesse i nterval o; do contrri o, mostra a mdi a no i nterval o entre o i nci o e
o fi m no Ei xo Hori zontal . Val ores com qual i dade rui m no so consi derados caso a
l ei tura.
4.6.4.3.2.23 MinY
Informa o val or mni mo da Pena no i nterval o, caso a propri edade EnableCalc
esteja habi l i tada. Caso o E3Chart esteja no modo de Pesquisa de Intervalos, mostra
a mdi a nesse i nterval o; do contrri o, mostra a mdi a no i nterval o entre o i nci o e
o fi m no Ei xo Hori zontal . Val ores com qual i dade rui m no so consi derados caso a
l ei tura.
4.6.4.3.2.24 Name
Determi na o nome da Pena.
4.6.4.3.2.25 PenStyle
Determi na o esti l o de l i nha da Pena. O val or padro desta propri edade 0
(zero). As opes di sponvei s so as segui ntes:
Opes disponveis para PenLineStyle
OPO DESCRIO
0 - LsSolid
Li nha sl i da.
1 - LsDash
Li nha tracejada.
2 - LsDot
Li nha ponti l hada.
3 - LsDashDot
Li nha trao-ponto.
4 - LsDashDotDot
Li nha trao-ponto-ponto.
5 - LsNull
Sem l i nha.
NOTA: A uti l i zao de um val or di ferente de 0 (LsSolid) nesta propri edade,
combi nada com a uti l i zao da propri edade Width com val ores mai ores do que 1
(um), pode degradar a performance de desenho da Pena.
286 Visualizao
4.6.4.3.2.26 PenType
Determi na o ti po de desenho da Pena no E3Chart:
0: Li nha
1: Ponto
2: Ponto e Li nha
3: rea
4.6.4.3.2.27 QueryName
Determi na o nome da Consul ta que a Pena est uti l i zando. Esta propri edade
uti l i zada se a propri edade DataSourceType esti ver confi gurada para 1 (Hi stri co).
4.6.4.3.2.28 ScaleX
A propri edade ScaleX i ndi ca a escal a X do E3Chart a qual a Pena est associ ada.
A escal a confi gurada para ScaleX tem ori entao hori zontal , ou seja, pode estar
posi ci onada no topo ou na base do E3Chart. Exempl o:
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 propri edade ScaleY i ndi ca a escal a Y do E3Chart a qual a Pena est associ ada. A
escal a confi gurada para ScaleY tem ori entao verti cal , estando posi ci onada
esquerda ou di rei ta do objeto. Exempl o:
Set Pen = Chart.Pens.AddPen("PenaDoTagDemo2")
Pen.UseTimeStamp = True
' A escala deve existir previamente.
Pen.ScaleY = "EscalaParaTagDemo2"
Pen.Connect
End Sub
Visualizao 287
4.6.4.3.2.30 ScanValue
Defi ne o tempo de l ei tura esperado do Tag da Pena de tempo real . Este val or
l evado em conta no modo de desenho anal gi co. Quando o val or ul trapassa o
val or determi nado por ScanValue, consi dera-se que o val or do Tag no foi al terado
no i nterval o. De outra forma, quando o ScanValue i gual a zero, os dados da Pena
so sempre conectados com uma reta l i gando os doi s pontos, como se o val or
esti vesse vari ando de forma l i near. A uni dade desta propri edade em
mi l i ssegundos.
4.6.4.3.2.31 ShowAverage
Habi l i ta a exi bi o da mdi a da Pena no E3Chart. Esta propri edade s tem efei to
caso a propri edade EnableCalc esteja habi l i tada.
4.6.4.3.2.32 ShowBadPoints
Quando desabi l i tada, os pontos com qual i dade rui m no sero pl otados. Se a
Pena esti ver traando l i nhas, as l i nhas que passam pel os pontos de qual i dade
rui m no sero conectadas. Para que a qual i dade dos pontos seja l evada em
consi derao na parte hi stri ca da Pena, o campo nomecampo_quality deve estar
sel eci onado na Consul ta do E3Chart. Quando habi l i tada, todos os pontos so
pl otados normal mente.
4.6.4.3.2.33 ShowMinMax
Habi l i ta a exi bi o dos pontos mni mo e mxi mo da Pena no E3Chart. Esta
propri edade s tem efei to caso a propri edade EnableCalc esteja habi l i tada.
4.6.4.3.2.34 UseTimeStamp
Determi na que ser uti l i zado, para o Ei xo Hori zontal , o val or do timestamp
associ ado ao Ei xo Verti cal . Veja exempl o na descri o da propri edade
DataSourceType.
4.6.4.3.2.35 Visible
Determi na se a Pena est vi svel no E3Chart. Se a opo esti ver confi gurada para
True, a Pena vi svel em tempo de execuo. Caso contrri o, a Pena fi ca i nvi svel .
Exempl o:
Pen1.Visible = Not Pen1.Visible
End Sub
288 Visualizao
4.6.4.3.2.36 Width
Determi na a l argura da l i nha da Pena no E3Chart. O val or padro desta
propri edade 0 (zero).
NOTA: A uti l i zao de val ores mai ores do que 1 (um) nesta propri edade, combi nada
com a uti l i zao da propri edade PenStyle com um val or di ferente de 0 (LsSolid), pode
degradar a performance de desenho da Pena.
4.6.4.3.2.37 XField
Nome do campo da Consul ta usado para pl otar o dado em uma escal a
hori zontal . usada para Penas hi stri cas.
4.6.4.3.2.38 XLink
Nome do link usado para pl otar o dado em uma escal a hori zontal . Quando o
val or desta propri edade al terado, a Pena automati camente desconectada. Aps
a confi gurao, preci so chamar o mtodo Connect para que a Pena comece a
receber os dados rel ati vos a este link. usada para Penas de tempo real .
4.6.4.3.2.39 XMaxY
Informa o val or X rel ati vo ao ponto MaxY. Esta propri edade somente de l ei tura.
4.6.4.3.2.40 XMinY
Informa o val or X rel ati vo ao ponto MinY. Esta propri edade somente de l ei tura.
4.6.4.3.2.41 YField
Nome do campo da Consul ta usado para pl otar o dado em uma escal a verti cal .
usada para Penas hi stri cas.
4.6.4.3.2.42 YLink
Nome do link usado para pl otar o dado em uma escal a verti cal . Quando o val or
desta propri edade al terado, a Pena automati camente desconectada. Aps a
confi gurao, preci so chamar o mtodo Connect para que a Pena comece a
receber os dados rel ati vos a este link. usada para Penas de tempo real .
4.6.5 Coleo de Eixos
de Ei xos. Este objeto no possui eventos associ ados.
Visualizao 289
4.6.5.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Col eo de Ei xos.
4.6.5.1.1 AddAxis
AddAxis(AxisName)
Adi ci ona um novo Ei xo com o nome determi nado no parmetro AxisName e retorna
o Ei xo cri ado. Caso se tente cri ar um Ei xo com um nome que j exi ste, ser
mostrada uma mensagem de erro. Querendo-se que o nome seja gerado
automati camente, deve se passar o parmetro AxisName em branco. Exempl o:
Set newAxis = Chart.Axes.AddAxis("")
newAxis.Color = RGB(255, 0, 0)
End Sub
4.6.5.1.2 Remove
Remove(Index)
Remove o Ei xo atravs de seu nome ou ndi ce, conforme especi fi cado no parmetro
Index. Os Ei xos pri nci pai s 0 e 1 no podem ser removi dos. Caso se tente remov-
l os, aparecer uma mensagem de erro. Exempl os:
' Este exemplo remove todos os eixos adicionais
Set Chart = Screen.Item("E3Chart")
While (Chart.Axes.Count > 2)
Chart.Axes.Remove(2)
Wend
End Sub
' Remove um eixo adicional, se existir
Chart.Axes.Remove(2)
End Sub
Esta seo contm i nformaes sobre as propri edades do objeto Col eo de Ei xos.
4.6.5.2.1 Count
Retorna o nmero total de Ei xos do E3Chart, i ncl ui ndo os doi s Ei xos pri nci pai s
(Hori zontal e Verti cal ).
290 Visualizao
4.6.5.2.2 HorAxis
Retorna o Ei xo Hori zontal pri nci pal . Este Ei xo tambm parti ci pa da l i sta de Ei xos.
Exempl o:
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.3 Item
Retorna o Ei xo atravs de seu nome ou ndi ce. O ndi ce 0 sempre o Ei xo
Hori zontal pri nci pal e o ndi ce 1 sempre o Ei xo Verti cal pri nci pal . Exempl o:
MsgBox Chart.axes.HorAxis.Name & ", " & _
Chart.axes.Item("NomeDoEixo").Name
End Sub
4.6.5.2.4 VerAxis
Retorna o Ei xo Verti cal pri nci pal . Este Ei xo tambm parti ci pa da l i sta de Ei xos.
Exempl os:
MsgBox Chart.axes.Item("NomeDoEixo").Name & ", " & _
Chart.axes.VerAxis.Name
End Sub
4.6.5.3 Eixos
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Ei xo. Este
4.6.5.3.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Ei xo.
Visualizao 291
NOTA: HorAxis e VerAxis so propri edades da Col eo de Ei xos que acessam os Ei xos
padro Hori zontal e Verti cal , respecti vamente. Por exempl o, ao i nvs de uti l i zar
Chart.Axes.Item("EixoHorizontal"), pode-se uti l i zar Chart.Axes.HorAxis.
Demai s Ei xos cri ados pel o usuri o tero nomes prpri os, escol hi dos caso a caso.
4.6.5.3.1.1 GetHistoricPeriod
GetHistoricPeriod(Begin, End)
Retorna o i nterval o de tempo mostrado na escal a hi stri ca. O parmetro Begin
i ndi ca a data i ni ci al da escal a hi stri ca, e End i ndi ca a data fi nal . Exempl o:
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 val ores mni mo e mxi mo da escal a
numri ca, respecti vamente. Exempl o:
Sub CommandButton1_DBClick()
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 uni dade de tempo confi gurada na escal a de tempo real . O parmetro
Period recebe o val or da escal a de tempo. Exempl o:
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 (subdi vi ses da escal a) e a uni dade
confi gurada. O parmetro TickSpacing determi na o espaamento entre os ticks, e
TimeUnit determi na a uni dade. Quando este parmetro est em zero, si gni fi ca que
automti co. A uni dade no uti l i zada quando a escal a numri ca. As opes
292 Visualizao
di sponvei s no parmetro TimeUnit so as mesmas demonstradas na tabel a do
mtodo GetRealTimePeriod. Exempl o:
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)
Confi gura o perodo de tempo para a escal a hi stri ca. O parmetro Begin
determi na o perodo i ni ci al da escal a, e End determi na o perodo fi nal da escal a.
Exempl o:
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)
Confi gura os val ores mni mo e mxi mo da escal a numri ca. O val or mni mo
determi nado pel o parmetro Min e o mxi mo por Max. Exempl o:
Sub Circulo1_Click()
Chart.Axes.Item("NomeDoEixo").SetMinMax -10, 500
End Sub
4.6.5.3.1.7 SetRealTimePeriod
SetRealTimePeriod(Times, TimeUnit)
Ajusta o i nterval o de tempo na uni dade defi ni da pel o parmetro TimeUnit. As
opes di sponvei s neste parmetro so as mesmas demonstradas na tabel a do
mtodo GetRealTimePeriod. O parmetro Times determi na o i nterval o de tempo, e a
uni dade da escal a especi fi cado por TimeUnit. O Ei xo fi ca sempre sendo
atual i zado neste modo (tempo real ). Exempl o:
' tuSeconds = 0, tuMinutes =1, tuHours = 2, tuDays = 3,
' tuWeeks = 4, tuMonths = 5, tuYears = 6
' 2 minutos
Chart.Axes.Item("NomeDoEixo").SetRealTimePeriod 2, 1
Visualizao 293
Chart.Axes.Item("NomeDoEixo").SetTickSpacing 30, 0
End Sub
4.6.5.3.1.8 SetTickSpacing
SetTickSpacing(TickSpacing, TimeUnit)
Confi gura o espaamento entre os ticks (subdi vi ses da escal a) usando a uni dade.
O espaamento entre os ticks determi nado pel o parmetro TickSpacing. O
parmetro TimeUnit determi na a uni dade. Caso a escal a seja numri ca, a uni dade
no consi derada. As opes di sponvei s no parmetro TimeUnit so as mesmas
demonstradas na tabel a do mtodo GetRealTimePeriod. Exempl o:
' 10 (caso seja a escala numrica,
' o valor da unidade no considerado)
End Sub
Esta seo contm i nformaes sobre as propri edades do objeto Ei xo.
NOTA: HorAxis e VerAxis so propri edades da Col eo de Ei xos que acessam os Ei xos
padro hori zontal e verti cal , respecti vamente. Por exempl o, ao i nvs de uti l i zar
Chart.Axes.Item("EixoHorizontal"), pode-se uti l i zar Chart.Axes.HorAxis.
Demai s Ei xos cri ados pel o usuri o tero nomes prpri os, escol hi dos caso a caso.
4.6.5.3.2.1 Color
Determi na a cor pri nci pal do Ei xo.
4.6.5.3.2.2 EnableTextColor
Esta propri edade, quando habi l i tada, especi fi ca que o texto do Ei xo ter a mesma
cor da escal a, confi gurada na propri edade Color. O val or padro desta
4.6.5.3.2.3 Format
Determi na a formatao dos val ores do Ei xo. Exempl o:
' Muda a formatao
strOldFormat = Chart.Axes.Item("NomeDoEixo").Format
MsgBox "Clique para setar a formatao automtica."
Chart.Axes.Item("NomeDoEixo").Format = "" ' Automatico
294 Visualizao
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
Determi na a cor das l i nhas da grade. Exempl o:
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
Determi na o esti l o da l i nha da grade. As opes di sponvei s so as segui ntes:
Opes disponveis para GridStyle
OPO DESCRIO
0 - solid
O esti l o da l i nha da grade sl i da.
1 - dash
O esti l o da l i nha da grade ponti l hada.
2 - dot
O esti l o da l i nha da grade tracejada.
3 - dashdot
O esti l o da l i nha da grade ponti l hada
e tracejada.
4 - dashdotdot
O esti l o da l i nha da grade trao-ponto-
ponto.
5 - invisible
No h l i nhas vi svei s na grade
(i nvi svel ).
Exempl o:
' 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
Visualizao 295
4.6.5.3.2.6 Inverse
Inverte a ordem dos val ores mni mo e mxi mo na escal a numri ca. Normal mente,
em escal as verti cai s, o val or mni mo aparece abai xo, e o val or mxi mo aci ma. Nas
escal as hori zontai s, o val or mni mo aparece na esquerda, e o val or mxi mo na
di rei ta. Quando a propri edade Inverse esti ver confi gurada para True, no entanto,
esta ordem ser i nverti da, val ores mxi mos abai xo ou esquerda, val ores mni mos
aci ma ou di rei ta. Exempl o:
Chart.Axes.Item("NomeDoEixo").Inverse = Not _
Chart.Axes.Item("NomeDoEixo").Inverse
End Sub
4.6.5.3.2.7 MinorTicks
Determi na o nmero total de subdi vi ses entre as escal as. Exempl o:
Chart.Axes.Item("NomeDoEixo").MinorTicks = _
Chart.Axes.Item("NomeDoEixo").MinorTicks + 1
End Sub
4.6.5.3.2.8 Mirror
Indi ca o espel hamento do Ei xo. Se a propri edade esti ver confi gurada para True, o
Ei xo ser espel hado no l ado oposto do Ei xo ori gi nal . Caso contrri o, o Ei xo
permanece na mesma posi o. Exempl o:
Sub CommandButton1_DBClick()
Chart.Axes.Item("NomeDoEixo").Mirror = Not _
Chart.Axes.Item("NomeDoEixo").Mirror
End Sub
4.6.5.3.2.9 Name
Determi na o nome do Ei xo.
4.6.5.3.2.10 Position
Determi na a posi o do Ei xo em rel ao grade do E3Chart. As opes
di sponvei s so as segui ntes:
Opes disponveis para Position
OPO DESCRIO
0 - axpLeft
O Ei xo posi ci onado esquerda da
escal a.
296 Visualizao
OPO DESCRIO
1 - axpRight
O Ei xo posi ci onado di rei ta da escal a.
2 - axpTop
O Ei xo posi ci onado no topo da escal a.
3 - axpBottom
O Ei xo posi ci onado na base da escal a.
Exempl o:
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
Determi na o ti po de escal a mostrada pel o Ei xo. As opes di sponvei s deste i tem
so as segui ntes:
Opes disponveis para ScaleType
OPO DESCRIO
0 - atNumberScale
Escal a numri ca.
1 - atLastPeriod
Mostra l ti mo perodo (Tempo Real ).
2 - atPeriod
I nterval o de tempo (Hi stri ca).
Exempl o:
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
Determi na a vi sual i zao das l i nhas da grade. Se a propri edade esti ver
confi gurada para True, as l i nhas da grade so mostradas. Caso contrri o, as
l i nhas so escondi das. Exempl o:
Visualizao 297
Chart.Axes.Item("NomeDoEixo").ShowGrid = Not _
Chart.Axes.Item("NomeDoEixo").ShowGrid
End Sub
4.6.5.3.2.13 Title
Determi na o ttul o do Ei xo. Exempl o:
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
Determi na a vi si bi l i dade do Ei xo na grade. Se a propri edade esti ver confi gurada
para True, o Ei xo vi svel na grade. Caso contrri o, o Ei xo fi ca i nvi svel . Exempl o:
Set Chart = Screen.Item(E3Chart1)
Chart.Axes.Item("NomeDoEixo").Visible = Not _
Chart.Axes.Item("NomeDoEixo").Visible
End Sub
4.6.6 Coleo de Consultas
de Consul tas. Este objeto no possui eventos associ ados.
4.6.6.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Col eo de Consul tas.
4.6.6.1.1 AddQuery
AddQuery(QueryName[, IsInternal])
Adi ci ona uma Consul ta na Col eo de Consul tas do E3Chart. Este mtodo possui os
parmetros QueryName, que determi na o nome da Consul ta que est sendo
adi ci onada, e IsInternal, que opci onal , obsol eto e no deve ser i nformado.
4.6.6.1.2 Item
Item(Index)
O mtodo Item retorna um objeto Consul ta da Col eo de Consul tas, especi fi cado
298 Visualizao
pel o ndi ce. Este mtodo possui o parmetro Index, que pode ser do ti po numri co
(se corresponder ao ndi ce da Consul ta) ou texto (se corresponder ao nome da
Consul ta).
4.6.6.1.3 Remove
Remove(Index)
Remove o objeto Consul ta especi fi cado pel o nome ou pel o ndi ce da Col eo de
Consul tas. Este mtodo possui o parmetro Index, que pode ser do ti po numri co
(se corresponder ao ndi ce da Consul ta) ou texto (se corresponder ao nome da
Consul ta).
4.6.6.1.4 UpdateData
UpdateData()
Atual i za os dados de todas as Consul tas. Exempl o:
Sub Texto1_Click()
E3Chart1.Queries.UpdateData()
End Sub
Esta seo contm i nformaes sobre as propri edades do objeto Col eo de
Consul tas.
4.6.6.2.1 Count
Contm o nmero total de Consul tas do E3Chart. Esta propri edade somente de
l ei tura.
4.6.7 Legenda
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Legenda.
Este objeto no possui eventos associ ados.
4.6.7.1 Mtodos
Na Legenda, podem ser sel eci onadas vri as col unas. Cada col una mostra um ti po
de i nformao e possui um nome e um val or correspondente. A segui r, tem-se a
tabel a da descri o das col unas possvei s na Legenda.
Visualizao 299
Opes disponveis para identificao das colunas
OPO VALOR NOME DESCRIO
Cor da Pena 6 Color
Mostra a cor da
Pena.
Descrio da Pena 5 Description
Mostra a
propri edade
DocString da Pena.
DifX 15 DiffX
Mostra a di ferena
entre os cursores
i ni ci al e fi nal .
DifY 16 DiffY
Mostra a di ferena
entre os pontos
i nterpol ados i ni ci al
e fi nal no Ei xo Y.
EscalaX 8 ScaleX
Mostra o nome da
escal a associ ada ao
Tag X.
EscalaY 9 ScaleY
Mostra o nome da
escal a associ ada ao
Tag Y.
Estado 7 Status
Mostra o status da
Pena.
FimX 14 XEnd
Mostra a posi o
fi nal do cursor.
FimY 18 YEnd
Mostra o ponto
i nterpol ado onde o
cursor fi nal cruza a
Pena.
IncioX 13 XBegin
Mostra a posi o
i ni ci al do cursor.
IncioY 17 YBegin
Mostra o ponto
i nterpol ado onde o
cursor i ni ci al cruza a
Pena.
MximoY 12 MaxY
Mostra o val or
mxi mo da Pena no
i nterval o.
MdiaY 10 AverageY
Mostra o val or
mdi o da Pena no
i nterval o.
MnimoY 11 MinY
Mostra o val or
mni mo da Pena no
i nterval o.
Nome da pena 0 Name
Mostra o nome da
Pena.
Nome do tag X 1 TagX
Mostra o nome do
Tag X associ ado
Pena.
300 Visualizao
OPO VALOR NOME DESCRIO
Nome do tag Y 2 TagY
Mostra o nome do
Tag Y associ ado
Pena.
Unidade 19 EU
Mostra a uni dade
associ ada Pena.
Valor do tag X 3 TagXValue
Mostra o val or do
Tag X associ ado
Pena. Este val or
mostrado quando o
grfi co est no
modo de Pesqui sa.
Valor do tag Y 4 TagYValue
Mostra o val or do
Tag Y associ ado
Pena. Este val or
mostrado quando o
grfi co est no
modo de Pesqui sa.
4.6.7.1.1 ChangeColumnPos
ChangeColumnPos(Source, Dest)
Troca a posi o entre duas col unas. Possui os segui ntes parmetros:
Source: ndi ce da col una que ser movi da para Dest
Dest: ndi ce da col una que ser movi da para Source
Exempl o:
Screen.Item("E3Chart1").Legend.ChangeColumnPos 1, 2
End Sub
4.6.7.1.2 Count
Count()
Retorna o nmero de col unas da Legenda.
4.6.7.1.3 InsertColumn
InsertColumn(Col, Index)
Insere uma nova col una na Legenda. Este mtodo possui os segui ntes parmetros:
Col: Identi fi ca a col una a ser i nseri da (ver Tabela de Identificao das Colunas, no
i nci o do tpi co Mtodos da Legenda).
Index: Determi na a posi o em que a col una ser i nseri da.
Visualizao 301
Exempl o:
'Mostra o nome da Pena
Screen.Item("E3Chart1").Legend.InsertColumn 0, 0
End Sub
'Mostra a cor da Pena
Screen.Item("E3Chart1").Legend.InsertColumn "Color", 0
End Sub
4.6.7.1.4 Item
Item(Col)
Retorna uma col una da Legenda pel o nome ou pel o ndi ce. O parmetro Col
determi na o ndi ce ou o nome da col una (ver Tabela de Identificao das Colunas, no
i nci o do tpi co Mtodos da Legenda).
4.6.7.1.5 RemoveColumn
RemoveColumn(Col)
Remove uma col una. Este mtodo possui o parmetro Col, que determi na a col una
que ser removi da (ver Tabela de Identificao das Colunas, no i nci o do tpi co
Mtodos da Legenda).
Esta seo contm i nformaes sobre as propri edades do objeto Legenda.
4.6.7.2.1 BackColor
Confi gura ou retorna a cor de fundo da Legenda. O val or padro desta
4.6.7.2.2 EnableTextColor
Esta propri edade, quando habi l i tada, especi fi ca que o texto da Legenda ter a
mesma cor da Pena, confi gurada na propri edade Color. O val or padro desta
302 Visualizao
4.6.7.2.3 LegendPos
Indi ca a posi o da Legenda no E3Chart.
Opes disponveis para LegendPos
OPO DESCRIO
0 - lgTop
Mostra a Legenda no topo.
1 - lgLeft
Mostra a Legenda esquerda.
2 - lgBottom
Mostra a Legenda na base.
3 - lgRight
Mostra a Legenda di rei ta.
4.6.7.2.4 ShowAllPens
Quando a propri edade for True, todas as Penas do E3Chart so mostradas na
Legenda. A propri edade Visible da Pena i gnorada. Quando em Fal se, somente as
Penas com a propri edade Visible i gual a True sero mostradas. Exempl o:
E3Chart1.Legend.ShowAllPens = Not _
E3Chart1.Legend.ShowAllPens
End Sub
4.6.7.2.5 ShowHeader
Determi na a vi si bi l i dade do ttul o da Legenda (cabeal ho). Se a opo for
confi gurada para True, o ttul o da Legenda mostrado. Caso contrri o, o ttul o fi ca
i nvi svel .
4.6.7.2.6 Size
Determi na o tamanho da Legenda. Este tamanho pode si gni fi car a al tura ou
l argura, dependendo da posi o da Legenda.
4.6.7.2.7 Visible
Determi na a vi si bi l i dade da Legenda. Se a opo esti ver confi gurada como True, a
Legenda vi svel no E3Chart. Caso contrri o, fi ca i nvi svel .
4.6.7.3 Colunas da Legenda
Esta seo contm i nformaes sobre propriedades do objeto Col unas da Legenda.
Visualizao 303
Esta seo contm i nformaes sobre as propri edades do objeto Col unas da
Legenda.
4.6.7.3.1.1 Caption
Permi te defi ni r um ttul o para a Col una.
4.6.7.3.1.2 Column
Retorna o i denti fi cador da Col una. Veja a Tabela de Identificao das Colunas.
4.6.7.3.1.3 Format
Confi gura o formatador usado na Col una.
4.6.7.3.1.4 Index
Retorna a posi o da Col una na Legenda.
4.6.7.3.1.5 Name
Determi na o nome da Col una. O nome das Col unas pode ser vi sto na Tabela de
Identificao das Colunas.
4.6.7.3.1.6 TextAlign
Retorna o al i nhamento do texto da Col una. As opes di sponvei s para esta
Opes disponveis para TextAlign
OPO DESCRIO
0 - taLeft
Al i nhamento esquerdo.
1 - taRight
Al i nhamento di rei to.
2 - taCenter
Al i nhamento central i zado.
4.6.7.3.1.7 Width
Retorna a l argura da Col una.
4.7 E3Playback
E3Pl ayback. Este objeto no possui eventos associ ados.
304 Visualizao
4.7.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto E3Pl ayback.
4.7.1.1 Pause
Pause()
Congel a o rel gi o de playback no tempo atual .
4.7.1.2 Play
Play()
Ini ci a a reproduo dos dados no horri o atual de playback, avanando o rel gi o
de acordo com a vel oci dade de reproduo atual .
4.7.1.3 Stop
Stop()
Interrompe o playback, os dados de Tags e al armes so removi dos das Tel as e
nenhuma nova consul ta fei ta ao Banco de Dados.
4.7.2 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto E3Pl ayback.
4.7.2.1 CurrentTime
Mostra a data e a hora atual do objeto E3Pl ayback. Esta propri edade est
di sponvel somente em tempo de execuo.
4.7.2.2 DBServer
Indi ca o nome do objeto Banco de Dados que contm os dados hi stri cos do
apl i cati vo.
4.7.2.3 InitialScreen
Indi ca a Tel a que ser mostrada i ni ci al mente no E3Pl ayback. Se essa
propri edade for dei xada em branco, ser uti l i zada a Tel a i ni ci al do objeto Vi ewer.
4.7.2.4 PlaybackState
Informa o estado atual do objeto E3Pl ayback. Esta propri edade est di sponvel
somente em tempo de execuo e as opes so as segui ntes:
Visualizao 305
Opes da propriedade PlaybackState
OPO DESCRIO
0 - Parado
O rel gi o de playback est parado.
1 - Reproduzindo
O rel gi o de playback est se movendo.
2 - Pausado
O rel gi o de playback est pausado.
4.8 Relatrios
Rel atri o.
4.8.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Rel atri o.
4.8.1.1 OnAfterPrint
OnAfterPrint()
Ini ci ado aps uma Seo ter si do montada no Rel atri o. Pode-se uti l i zar este
evento para atual i zar qual quer contador cuja uti l i zao seja necessri a depoi s do
Rel atri o ser compl etado.
4.8.1.2 OnBeforePrint
OnBeforePrint()
Ini ci ado antes da Seo ter si do montada no Rel atri o. Pode-se uti l i zar este evento
para modi fi car o val or de um objeto no Rel atri o antes que este seja i mpresso.
Recomenda-se que os campos da Consul ta do Rel atri o no sejam acessados
quando este evento esti ver sendo uti l i zado.
4.8.1.3 OnDataInitialize
OnDataInitialize()
Ocorre antes do evento OnReportStart. Este evento permi te acrescentar e
confi gurar campos col eo Fields de um Rel atri o, antes de sua gerao.
Exempl o:
Sub OnDataInitialize()
Fields.Add "Nome"
Fields.Add "Setor"
Fields.Add "Cdigo"
End Sub
306 Visualizao
4.8.1.4 OnError
OnError(Number, Description, SCode, Source, HelpFile, HelpContext, CancelDisplay)
Gerado por um erro i nterno no Rel atri o. Se este evento no for tratado, o E3 i r
mostrar uma mensagem de erro genri ca.
Variveis do evento OnError
NOME DESCRIO
Number
Nmero i ntei ro i denti fi cador do erro.
Description
String com a descri o do erro.
SCode
I ntei ro com o cdi go de erro do
subsi stema OLE (no uti l i zado).
Source
String com o objeto ori gem do erro.
HelpFile
String com o nome e cami nho do arqui vo
de ajuda.
HelpContext
Nmero de contexto do tpi co de ajuda
referente ao erro (i ntei ro).
CancelDisplay
Bool eano que i ndi ca se o erro deve ser
mostrado em uma MessageBox.
4.8.1.5 OnFetchData
OnFetchData(eof)
Di sparado toda vez que um novo regi stro processado. Este evento uti l i zado para
executar um scri pt que modi fi ca os val ores dos campos que foram adi ci onados ao
Rel atri o em um scri pt associ ado ao evento OnDataInitialize. A vari vel eof tem o
val or padro True e i ndi ca que aps o scri pt o processamento do regi stro atual do
Rel atri o foi encerrado.
4.8.1.6 OnFormat
OnFormat()
Ini ci ado depoi s que os dados so l i dos e carregados no Rel atri o, mas antes da
Seo ser preparada para a i mpresso. Este evento pode ser uti l i zado para
modi fi car o layout da Seo do Rel atri o ou de qual quer outro objeto.
4.8.1.7 OnHyperlink
OnHyperlink(Button, Link)
Ocorre quando um link cl i cado no Rel atri o. Pode-se uti l i zar este evento para
executar um scri pt que redi reci one um link ou para confi gurar um link no Rel atri o.
A vari vel Button i ndi ca qual boto foi cl i cado (normal mente, 1) e a vari vel Link
determi na qual o endereo que ser segui do.
Visualizao 307
4.8.1.8 OnNoData
OnNoData()
Ocorre quando no h dados a serem i mpressos no Rel atri o. Pode-se uti l i zar este
evento para executar um scri pt que mostre uma mensagem de erro na tel a,
acusando a fal ta de dados para i mpri mi r e cancel e o Rel atri o.
4.8.1.9 OnPageEnd
OnPageEnd()
Ocorre ao fi nal da i mpresso de cada pgi na do Rel atri o.
4.8.1.10 OnPageStart
OnPageStart()
Ocorre no i nci o da i mpresso de cada pgi na do Rel atri o.
4.8.1.11 OnPrintProgress
OnPrintProgress(PageNumber)
Ocorre enquanto uma pgi na do Rel atri o est sendo i mpressa. A vari vel
PageNumber i ndi ca o nmero da pgi na atual .
4.8.1.12 OnReportEnd
OnReportEnd()
Di sparado no fi nal da gerao do Rel atri o, aps fi nal i zar a sua i mpresso.
4.8.1.13 OnReportStart
OnReportStart()
Di sparado no i nci o da gerao do Rel atri o, antes de comear a sua i mpresso.
4.8.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Rel atri o.
4.8.2.1 Export
Export([ExportFilter[, ExportFileName]])
Impri me um Rel atri o de acordo com o formato especi fi cado no arqui vo. Este
mtodo possui o parmetro ExportFilter, que determi na o fi l tro para o Rel atri o,
308 Visualizao
i ndi cando o formato para a exportao. Pode assumi r as segui ntes opes:
PDF: Exporta os dados para o formato Adobe PDF
Excel: Exporta os dados para o formato de uma pl ani l ha do Excel
HTML: Exporta os dados para o formato HTML
TEXT: Exporta os dados para um arqui vo texto
RTF: Exporta os dados para o formato Ri ch Text Format
TIFF: Exporta os dados para o formato Tag Image Fi l e Format
Ao si mpl esmente i nformar o nome de um fi l tro, como exposto aci ma, os dados
sero exportados uti l i zando-se as propri edades em comum de cada fi l tro. Pode-se
modi fi car as propri edades comuns de um fi l tro de exportao atravs do mtodo
GetExportFilter, antes de exportar os dados. O nome do arqui vo deve ser i nformado
no parmetro ExportFileName. Exempl o:
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"
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
Visualizao 309
4.8.2.2 GetExportFilter
GetExportFilter(FilterName)
Retorna um objeto que especi fi ca a customi zao dos parmetros de exportao.
Este mtodo possui o parmetro FilterName, que determi na o fi l tro para o Rel atri o,
i ndi cando o ti po de formato para a exportao. Pode assumi r as segui ntes opes:
PDF: Exporta os dados para o formato Adobe PDF
Excel: Exporta os dados para o formato de uma pl ani l ha do Excel
HTML: Exporta os dados para o formato HTML
TEXT: Exporta os dados para um arqui vo texto
RTF: Exporta os dados para o formato Ri ch Text Format
TIFF: Exporta os dados para o formato Tag Image Fi l e Format
Depoi s de obti do o fi l tro, as segui ntes propri edades podem ser modi fi cadas:
Propriedades passveis de modificao
PROPRIEDADE FILTRO DESCRIO
AutoRowHeight
Excel Em True (padro), confi gura
a al tura da l i nha
automati camente. Em
Fal se, confi gura a al tura
para o mai or el emento na
l i nha.
BorderSpace
Excel Espaamento mni mo entre
as cl ul as. O val or padro
de 59 twi ps.
CreateCSSFile
HTML Se verdadei ro, gera um
arqui vo CSS no di retri o
i ndi cado por
HTMLOutputPath.
DoubleBoundaries
Excel Em True, i ndi ca que os
el ementos al i nhados
di rei ta devem repor os
al i nhados esquerda na
mesma col una. Caso
contrri o, dei xe em Fal se
para l i berar mai s espao.
ExportRange
HTML I ndi ca uma fai xa de
pgi nas para serem
exportadas. Por exempl o,
"1, 2, 3-9, 14".
310 Visualizao
PROPRIEDADE FILTRO DESCRIO
FaxExport
TI FF Objeto que permi te
exportar os dados no
formato RFC 1314 TI FF.
FileName
Todos I nforma o nome do arqui vo
para o qual os dados sero
exportados.
GenPageBreaks
HTML Em True, col ocar quebras
de pgi na abai xo do
el emento mai s i nferi or em
cada pgi na do Rel atri o.
HTMLOutputPath
HTML Cami nho padro para os
arqui vos HTML.
JPGQuality
PDF I ndi ca o nvel de qual i dade
das i magens exportadas
(de 0 a 100).
MinColumnWidth
Excel Tamanho mni mo da
col una. O val or padro
1011 twi ps.
MinRowHeight
Excel Tamanho mni mo da l i nha.
MultiSheet
Excel Em True, cada pgi na no
Rel atri o vai para uma
pl ani l ha separada.
PageDelimiter
TEXT Confi gura ou retorna o
caractere del i mi tador entre
pgi nas.
SuppressEmptyLines
TEXT Reti ra ou i nsere l i nhas
vazi as, para efei to de
layout.
TextDelimiter
HTML Confi gura ou retorna o
caractere del i mi tador entre
os textos.
TrimEmptySpace
Excel Em True, o espao verti cal
entre os el ementos ser
el i mi nado. O padro
Fal se.
Unicode
TEXT Determi na se o texto vai
ser sal vo em formato
Uni code (16 bi ts).
WebCacheOutput
HTML Em True, o Rel atri o ser
exportado para o servi o
de WebCache. Caso
contrri o (padro), no
ser exportado.
4.8.2.3 Print
Print()
Impri me um Rel atri o.
Visualizao 311
4.8.2.4 PrintPreview
PrintPreview()
Faz uma prvi a de i mpresso de Rel atri o na Tel a. Se o Rel atri o for mostrado
corretamente na Tel a, retorna True. Caso o usuri o aperte o boto Cancel ou
acontea al gum erro, retorna Fal se. Exempl o:
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: Este mtodo no est di sponvel para Rel atri os carregados usando o
mtodo LoadReport do Servi dor.
4.8.2.5 Query
Query()
Retorna o objeto Consul ta atual mente sel eci onado no Rel atri o. Para mai ores
i nformaes a respei to deste objeto, veja o captul o Consultas. Exempl o:
Sub Rect_Click()
Set Query = Application.LoadReport("[Relatrio3]").Query()
Query.SetVariableValue("Chave1", "XYZ")
End Sub
4.8.3 Propriedades
Para cri ar um scri pt no Rel atri o, uti l i za-se o Edi tor de Scri pts do Rel atri o,
acessado atravs do boto Editor de Scripts e para vi sual i zar o Rel atri o, uti l i za-se
o boto Gerar Relatrio, ambos l ocal i zados na Barra de Ferramentas do Rel atri o.
Os scri pts do Rel atri o uti l i zam al guns procedi mentos, dependendo do objeto ou
da Seo onde se deseja i ncl ui r o cdi go. Por exempl o:
Report.Sections("PageHeader").Controls("E3Chart1")._
GridBkColor= RGB(255, 0, 255).
Onde:
PageHeader: o nome da Seo onde o objeto est i ncl uso no Rel atri o
E3Chart1: o nome do objeto que est dentro da Seo especi fi cada, neste caso
PageHeader
GridBkColor: o nome da propri edade do objeto, neste caso E3Chart
312 Visualizao
RGB(255, 0, 255): o parmetro ou ao da propri edade. Neste caso, mudar a cor
de fundo do grfi co para rosa
Sendo assi m, para fazer-se um scri pt no Rel atri o, usa-se o segui nte concei to:
Report.Sections("NomeDaSeo").Controls("NomeDoObjeto")._
NomeDaPropriedade=parmetros_da_propriedade
NOTA: O objeto Rel atri o encapsul a um objeto Acti veReports (ou AR), que o
Rel atri o propri amente di to.
4.8.3.1 Caption
Contm o ttul o do Rel atri o que aparece na barra de ttul o da janel a de
vi sual i zao (preview). O val or padro desta propri edade uma String vazi a.
4.8.4 Layout
Esta seo contm i nformaes sobre propriedades do objeto Layout do Rel atri o.
Esta seo contm i nformaes sobre as propri edades do objeto Layout do
Rel atri o.
NOTA: As propri edades aqui descri tas so parte do objeto Acti veReport (ou AR) que
encapsul ado no objeto Rel atri o. Estas propri edades so vl i das apenas dentro
do escopo do AR e no podem ser acessadas fora desse objeto.
4.8.4.1.1 _PageBottomMargin
Determi na a margem i nferi or do Rel atri o, em twi ps (1 twi p = 1/1440 pol egada). O
val or padro desta propri edade 1440 (1 pol ou 2,54 cm).
4.8.4.1.2 _PageLeftMargin
Determi na a margem esquerda do Rel atri o, em twi ps (1 twi p = 1/1440 pol egada).
O val or padro desta propri edade 1440 (1 pol ou 2,54 cm).
4.8.4.1.3 _PageRightMargin
Determi na a margem di rei ta do Rel atri o, em twi ps (1 twi p = 1/1440 pol egada). O
val or padro desta propri edade 1440 (1 pol ou 2,54 cm).
Visualizao 313
4.8.4.1.4 _PageTopMargin
Determi na a margem superi or do Rel atri o, em twi ps (1 twi p = 1/1440 pol egada).
O val or padro desta propri edade 1440 (1 pol ou 2,54 cm).
4.8.4.1.5 AllowSplitters
Permi te que a tel a de vi sual i zao do Rel atri o seja di vi di da em duas partes.
Essa propri edade s est di sponvel em tempo de execuo. Se a propri edade
esti ver confi gurada para Fal se (val or padro), a barra para di vi so no aparece na
tel a.
4.8.4.1.6 documentName
Determi na o nome do documento para o Rel atri o. Este nome aparece no
gerenci ador de i mpresso e pode ser usado para i denti fi car mai s faci l mente o
Rel atri o. O val or padro desta propri edade "Acti veReports Document".
4.8.4.1.7 MaxPages
Estabel ece o nmero mxi mo de pgi nas para o Rel atri o. Quando este nmero
al canado, o E3 para de processar o documento. O val or padro desta propri edade
10.
4.8.4.1.8 ParentReport
Esta propri edade uma vari vel de uso i nterno do si stema e contm uma
refernci a para o objeto Rel atri o. A propri edade somente de l ei tura, e vl i da
apenas para os eventos OnDataInitialize e OnReportEnd.
4.8.4.1.9 PrintWidth
Determi na a l argura da rea de i mpresso do Rel atri o, em twi ps. Se o tamanho
do Rel atri o for mudado em tempo de execuo, a l argura de i mpresso tambm
dever ser ajustada, para garanti r que o Rel atri o i r ocupar toda a rea de
i mpresso. O tamanho da rea de i mpresso deve tambm i ncl ui r a l argura das
margens, para que o Rel atri o no fi que mai or que o tamanho do papel . Se i sto
acontecer, o erro ser assi nal ado por uma l i nha ponti l hada vermel ha i mpressa em
cada pgi na do Rel atri o.
4.8.4.1.10 RulerVisible
Quando confi gurado como True, i ndi ca que sero mostradas uma rgua verti cal
e outra hori zontal na janel a de vi sual i zao do Rel atri o. Do contrri o, as rguas
fi caro i nvi svei s.
314 Visualizao
4.8.4.1.11 ScriptDebuggerEnabled
Habi l i ta ou desabi l i ta o depurador do Acti veReports (JIT), para depurar os scri pts
associ ados aos Rel atri os. Este depurador no est di sponvel em todo o E3,
apenas nos Rel atri os.
4.8.4.1.12 ScriptLanguage
Indi ca a l i nguagem usada para i nterpretar os scri pts associ ados a um Rel atri o.
A l i nguagem padro o VBScri pt, mas JScri pt tambm pode ser uti l i zada.
4.8.4.1.13 ShowParameterUI
Habi l i ta ou desabi l i ta os parmetros da cai xa de di l ogo da Consul ta, que
aparece quando o Rel atri o est sendo executado. Se a propri edade esti ver
confi gurada para True, os parmetros da cai xa de di l ogo da Consul ta sero
mostrados. Caso contrri o, estes parmetros no so mostrados.
4.8.4.1.14 Status
Retorna o status do Rel atri o. As opes di sponvei s para esta propri edades
so as segui ntes:
Opes disponveis para Status
OPO DESCRIO
0 - DDStatIdle
I ndi ca que o Rel atri o est fechado.
1 - DDStartRunning
I ndi ca que o Rel atri o est sendo
executado.
2 - DDStartCompleted
I ndi ca que o Rel atri o est compl eto.
3 - DDStartCanceled
I ndi ca que o Rel atri o foi cancel ado.
4.8.4.1.15 TOCEnabled
Habi l i ta ou desabi l i ta o ndi ce do Rel atri o. Se a propri edade esti ver confi gurada
para True, o ndi ce do Rel atri o habi l i tado; do contrri o, o Rel atri o no ter
ndi ce. O val or padro desta propri edade True.
4.8.4.1.16 TOCVisible
Determi na a vi si bi l i dade do ndi ce do Rel atri o. Se a propri edade esti ver
confi gurada para True, o ndi ce do Rel atri o mostrado; do contrri o, o ndi ce fi ca
i nvi svel . O val or padro desta propri edade True.
Visualizao 315
4.8.4.1.17 ToolbarVisible
Habi l i ta ou desabi l i ta a Barra de Ferramentas da janel a de prvi a de i mpresso
do Rel atri o. Se a propri edade esti ver confi gurada para True, a barra habi l i tada;
do contrri o, no haver barra de ferramentas nesta janel a.
4.8.4.1.18 UserData
Confi gura ou retorna as i nformaes especfi cas do usuri o. Esta propri edade
si mi l ar propri edade Tag do Vi sual Basi c, mas ser exportada e sal va em um
arqui vo .rpx. Pode ser usada para sal var e carregar qual quer i nformao
personal i zada necessri a ao desenho do Rel atri o.
4.8.4.1.19 Version
Retorna o nmero da verso do produto.
4.8.4.1.20 WaterMark
Adi ci ona uma i magem de fundo ao Rel atri o (marca d'gua). As marcas d'gua
so textos ou fi guras que aparecem sob o texto do documento. Normal mente, el as
tornam o documento vi sual mente mai s i nteressante.
316 Visualizao
Exemplo de marca d'gua
O val or padro desta propri edade vazi o (sem i magem).
4.8.4.1.21 WaterMarkAlignment
Determi na o al i nhamento da marca d'gua no Rel atri o. As opes di sponvei s
para esta propri edade so as segui ntes:
Opes disponveis para WaterMarkAlignment
OPO DESCRIO
0 - ddPATopLeft
Al i nha a i magem ao topo e esquerda.
1 - ddPATopRight
Al i nha a i magem ao topo e di rei ta.
2 - ddPACenter
Al i nha a i magem ao centro (padro).
3 - ddPABottomLeft
Al i nha a i magem base e esquerda.
4 - ddPABottonRight
Al i nha a i magem base e di rei ta.
4.8.4.1.22 WaterMarkPrintOnPages
Indi ca o nmero das pgi nas do Rel atri o que recebero a marca d'gua. A
si ntaxe uti l i zada pode i ncl ui r uma ni ca pgi na, uma extenso de pgi nas, ou
mesmo uma combi nao de ambos. Exempl o: 1, 5-8, 9, 10-15.
Visualizao 317
4.8.4.1.23 WaterMarkSizeMode
Confi gura o efei to do tamanho da marca d'gua na pgi na do Rel atri o. As
Opes disponveis para WaterMarkSizeMode
OPO DESCRIO
0 - ddSMClicp
A marca d'gua mostrada no Rel atri o
no seu tamanho ori gi nal .
1 - ddSMStretch
A marca d'gua i r preencher toda a
pgi na do Rel atri o.
2 - ddSMZoom
A marca d'gua ser aumentada at fi car
do tamanho da pgi na do Rel atri o.
4.8.5 Seo
Esta seo contm i nformaes sobre propriedades comuns do objeto Seo do
Rel atri o. Este objeto no possui eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades comuns do objeto Seo do
Rel atri o.
4.8.5.1.1 BackColor
Especi fi ca a cor de fundo da Seo do Rel atri o. O efei to desta propri edade s
ser vi svel se a propri edade BackStyle esti ver habi l i tada para a opo 1 -
ddBKNormal. O val or padro branco (RGB(255, 255, 255)).
4.8.5.1.2 BackStyle
Especi fi ca o esti l o de fundo da Seo do Rel atri o. As opes di sponvei s para
0 - ddBKTransparent: fundo transparente
1 - ddBKNormal: fundo normal
4.8.5.1.3 CanGrow
Determi na a apl i cao de stretch ao texto da pgi na do Rel atri o. Caso a l argura
ou a al tura da pgi na sejam aumentadas, o texto acompanha esta vari ao. Se a
propri edade esti ver confi gurada para True, o texto acompanha as vari aes de
al tura e de l argura do objeto. Caso contrri o, este permanece com as confi guraes
i ni ci ai s. O val or padro desta propri edade True.
318 Visualizao
4.8.5.1.4 CanShrink
Determi na a apl i cao do efei to de encol hi mento ao texto da pgi na do
Rel atri o. Caso a l argura ou a al tura da pgi na sejam di mi nudas, o texto
acompanha esta vari ao. Se a propri edade esti ver confi gurada para True, o texto
acompanha as vari aes de al tura e l argura do objeto. Caso contrri o, este
permanece com as confi guraes i ni ci ai s. O val or padro desta propri edade
True.
4.8.5.1.5 height
Determi na a al tura da Seo da pgi na do Rel atri o. O val or padro desta
propri edade 360.
4.8.5.1.6 IsRepeating
Determi na a repeti o da Seo na l ti ma pgi na do Rel atri o. Se a propri edade
esti ver confi gurada para True, a Seo ser repeti da na l ti ma pgi na. Caso
contrri o, no haver esta repeti o.
4.8.5.1.7 Name
Indi ca o nome da Seo do Rel atri o.
4.8.5.1.8 Type
Retorna o ti po da Seo. As opes di sponvei s so:
OPO DESCRIO
0 - ReportHeader
Seo ti po ReportHeader (Cabeal ho de
Rel atri o).
1 - ReportFooter
Seo ti po ReportFooter (Rodap de
Rel atri o).
2 - PageHeader
Seo ti po PageHeader (Cabeal ho de
pgi na).
3 - PageFooter
Seo ti po PageFooter (Rodap de
pgi na).
4 - GroupHeader
Seo ti po GroupHeader (Cabeal ho de
grupo).
5 - GroupFooter
Seo ti po GroupFooter (Rodap de
grupo).
6 - Detail
Seo ti po Detai l (rea para contedo do
Rel atri o).
Visualizao 319
4.8.5.1.9 Visible
Habi l i ta ou desabi l i ta a vi si bi l i dade da Seo no Rel atri o. Se a propri edade
esti ver confi gurada para True, a Seo vi svel no Rel atri o. Caso contrri o, no
vi svel . O val or padro desta propri edade True.
4.8.5.2 Group Header
Esta seo contm i nformaes sobre propriedades do objeto Group Header do
Esta seo contm i nformaes sobre as propri edades do objeto Group Header do
Rel atri o.
4.8.5.2.1.1 ColumnLayout
Determi na se o GroupHeader i r uti l i zar o mesmo layout das col unas
confi guradas na Seo Detail. Se a propri edade esti ver confi gurada para True, o
nmero de col unas na Seo Detail ser o mesmo do GroupHeader ou GroupFooter
associ ados. Caso contrri o, el e permanece com as confi guraes padro.
4.8.5.2.1.2 DataField
Retorna os dados dos campos do Rel atri o. Defi ne um campo obri gatri o para
um grupo dentro do contedo da Seo Detail. Este val or ajustado ao nome de
todos os campos na fonte de dados do Rel atri o ou ao nome de um campo
customi zado que est i nseri do na col eo de campos. Quando esta propri edade
ajustada, o Rel atri o cri a um grupo novo cada vez que o val or do campo muda nos
regi stros de dados do detal he.
4.8.5.2.1.3 GrpKeepTogether
Determi na se a Seo GroupHeader ser i mpressa como um bl oco ni co na
mesma pgi na do Rel atri o. As opes di sponvei s so as segui ntes:
Opes disponveis para GrpKeepTogether
OPO DESCRIO
0 - GrpNone
A pgi na pode ser quebrada
i medi atamente depoi s de um
GroupHeader.
1 - GrpFirstDetails
O GroupHeader ser i mpresso com a
pri mei ra Seo Detail da mesma pgi na
ou col una do Rel atri o.
320 Visualizao
OPO DESCRIO
2 - GrpAll
O GroupHeader, Detail e Footer de grupo
sero i mpressos juntos na mesma
pgi na do Rel atri o.
O val or padro desta propri edade 0 - GrpNone.
4.8.5.2.1.4 KeepTogether
Determi na se as Sees do Rel atri o sero i mpressas como um ni co bl oco, na
mesma pgi na. As opes di sponvei s para esta propri edade so as segui ntes:
Opes disponveis para KeepTogether
OPO DESCRIO
0 - ddGrpNone
H uma quebra de pgi na depoi s do
Rel atri o.
1 - ddGrpFirstDetail
O Rel atri o i mpri mi r a Seo Detail na
mesma pgi na ou col una.
4.8.5.2.1.5 NewColumn
Insere uma nova quebra de col una antes ou depoi s da i mpresso da Seo no
Rel atri o. As opes di sponvei s para esta propri edade so as segui ntes:
Opes disponveis para NewColumn
OPO DESCRIO
0 - ddNPNone
No h quebra de pgi na na Seo.
1 - ddNBefore
I ni ci a a i mpresso da Seo em uma
nova pgi na.
2 - ddNPAfter
I ni ci a uma nova pgi na depoi s de
i mpri mi r a Seo.
3 - ddNPBeforeAfter
I ni ci a a i mpresso em uma nova pgi na
e uma nova pgi na depoi s de i mpri mi r a
Seo.
4.8.5.2.1.6 NewPage
Insere uma quebra de pgi na no Rel atri o. As opes di sponvei s para esta
Opes disponveis para NewPage
OPO DESCRIO
0 - ddNPNone
No h quebra de pgi na na Seo
(padro).
1 - ddNBefore
I ni ci a a i mpresso em uma nova pgi na.
Visualizao 321
OPO DESCRIO
2 - ddNPAfter
I ni ci a uma nova pgi na depoi s da
i mpresso da Seo.
3 - ddNPBeforeAfter
e i ni ci a uma nova pgi na depoi s de
i mpri mi r a Seo.
4.8.5.2.1.7 Repeat
Determi na se o GroupHeader ser i mpresso novamente depoi s de ser associ ado
Seo Detail quando h ml ti pl as pgi nas, col unas ou quebras de pgi nas no
Rel atri o. As opes di sponvei s so as segui ntes:
Opes disponveis para Repeat
OPO DESCRIO
0 - ddRepeatNone
No h rei mpresso do grupo de
cabeal ho (padro).
1 - ddRepeatOnPage
I mpri me o grupo de cabeal hos no topo
da pgi na conforme as especi fi caes da
Seo Detail.
2 - ddRepeatOnColumn
I mpri me o grupo de cabeal hos no topo
da col una da pgi na do Rel atri o
conforme as especi fi caes da Seo
Detail.
3 - ddRepeatAll
I mpri me o grupo de cabeal hos e os
demai s objetos no topo da pgi na do
Rel atri o conforme as especi fi caes da
Seo Detail.
4.8.5.2.1.8 UnderlayNext
Determi na se a Seo deve i mpri mi r uma Seo depoi s da outra,
consecuti vamente. Se a propri edade esti ver confi gurada para True, a Seo
segui nte comear a i mpresso a parti r da coordenada superi or da Seo na
pgi na do Rel atri o. Caso contrri o, este recurso no uti l i zado. O val or padro
4.8.5.3 Detail
Esta seo contm i nformaes sobre propriedades do objeto Detai l do Rel atri o.
Esta seo contm i nformaes sobre as propri edades do objeto Detai l do
Rel atri o.
322 Visualizao
4.8.5.3.1.1 ColumnCount
Determi na o nmero de col unas na Seo Detail do Rel atri o. A l argura de cada
col una deve ser i gual a rea i mpri mvel do Rel atri o, di vi di da pel o nmero de
col unas. O val or padro desta propri edade 1.
4.8.5.3.1.2 ColumnDirection
A propri edade ColumnDirection determi na a di reo da i mpresso das col unas
da Seo Detail. As opes di sponvei s so as segui ntes:
Opes disponveis para ColumnDirection
OPO DESCRIO
0 - ddCDDownAcross
I mpri me cada col una da Seo Detail de
ci ma para bai xo e depoi s passa para a
prxi ma col una di rei ta.
1 - ddCDAcrossDown
I mpri me cada col una da Seo Detail da
di rei ta para a esquerda e assi m por
di ante.
O layout determi nado conforme a opo confi gurada:
Opo ddCDDownAccross
Visualizao 323
Opo ddCDAccrossDown
4.8.5.3.1.3 ColumnSpacing
Determi na o espaamento da col una na Seo Detail. O val or padro desta
propri edade 0.
OPO DESCRIO
0 - ddGrpNone
Rel atri o.
O Rel atri o i mpri mi r a Seo Detail na
324 Visualizao
OPO DESCRIO
0 - ddNPNone
1 - ddNBefore
nova pgi na.
2 - ddNPAfter
i mpri mi r a Seo.
3 - ddNPBeforeAfter
Seo.
4.8.5.3.1.6 NewPage
OPO DESCRIO
0 - ddNPNone
1 - ddNBefore
2 - ddNPAfter
i mpresso da Seo.
3 - ddNPBeforeAfter
i mpri mi r a Seo.
4.8.5.4 Group Footer
Esta seo contm i nformaes sobre propriedades do objeto Group Footer do
Esta seo contm i nformaes sobre as propri edades do objeto Group Footer do
Rel atri o.
4.8.5.4.1.1 ColumnLayout
Determi na se o GroupFooter i r uti l i zar o mesmo layout das col unas
confi guradas na Seo Detail. Se a propri edade esti ver confi gurada para True, o
nmero de col unas na Seo Detail i r refl eti r no GroupHeader ou no GroupFooter
associ ados. Caso contrri o, permanece com as confi guraes padro. O val or
Visualizao 325
OPO DESCRIO
0 - ddGrpNone
Rel atri o.
O Rel atri o i mpri mi r a seo Detail na
OPO DESCRIO
0 - ddNPNone
1 - ddNBefore
nova pgi na.
2 - ddNPAfter
i mpri mi r a Seo.
3 - ddNPBeforeAfter
Seo.
4.8.5.4.1.4 NewPage
OPO DESCRIO
0 - ddNPNone
No h quebra de pgi na na Seo
(padro).
1 - ddNBefore
2 - ddNPAfter
i mpresso da Seo.
3 - ddNPBeforeAfter
i mpri mi r a Seo.
326 Visualizao
4.8.5.4.1.5 PrintAtBottom
Determi na se o GroupFooter ou o rodap do Rel atri o sero i mpressos no p da
pgi na. Se a propri edade esti ver confi gurada para True e o Rel atri o conti ver um
rodap de pgi na, o GroupFooter e o rodap do Rel atri o sero i mpressos aci ma
da Seo Rodap de Pgi na. Confi gurando mai s de uma Seo para i mpri mi r o p
da pgi na do Rel atri o, far com que as Sees segui ntes do rodap sejam
i mpressas em pgi nas separadas.
4.8.6 Objetos
Esta seo contm i nformaes sobre propri edades dos Objetos do Rel atri o. Estes
objetos no possuem eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades comuns aos objetos do
Rel atri o.
4.8.6.1.1 BackColor
Especi fi ca a cor de fundo do objeto no Rel atri o. O efei to desta propri edade s
ser vi svel se a propri edade BackStyle esti ver habi l i tada para a opo 1 -
ddBKNormal. O val or padro desta propri edade branco (RGB(255, 255, 255)).
NOTA: esta propri edade no vl i da para os objetos Li nha e Quebra de Pgi na.
4.8.6.1.2 BackStyle
Especi fi ca o esti l o do fundo dos objetos do Rel atri o. As opes di sponvei s
para esta propri edade so as segui ntes:
0 - ddBKTransparent: transparente (mostra a cor defi ni da pel a propri edade
BackColor da Seo)
1 - ddBKNormal: normal (mostra a cor defi ni da pel a propri edade BackColor do
objeto)
O val or padro 0 - ddBKTransparent.
NOTA: esta propri edade no vl i da para os objetos Li nha, Cdi go de Barras,
Quebra de Pgi na e Tabel a.
Visualizao 327
4.8.6.1.3 height
Esta propri edade determi na a al tura do objeto no Rel atri o.
4.8.6.1.4 left
Retorna o val or do posi ci onamento esquerdo do objeto no Rel atri o.
4.8.6.1.5 Name
Determi na o nome do objeto. O val or padro desta propri edade uma String
vazi a.
4.8.6.1.6 Tag
Retorna o ti po do Tag associ ado ao objeto, i sto , Boolean, String, Integer, etc.
4.8.6.1.7 Top
Retorna o val or do topo do objeto.
NOTA: esta propri edade no vl i da para o objeto Li nha.
4.8.6.1.8 Visible
Determi na a vi si bi l i dade do objeto no Rel atri o. Se a opo esti ver confi gurada
para True, o objeto vi svel no Rel atri o. Caso contrri o, o objeto est ocul to. O
NOTA: esta propri edade no vl i da para o objeto Quebra de Pgi na.
4.8.6.1.9 Width
Esta propri edade determi na a l argura do objeto no Rel atri o.
328 Visualizao
4.8.6.2 Cdigo de Barras
Esta seo contm i nformaes sobre propriedades do objeto Cdi go de Barras do
Esta seo contm i nformaes sobre as propri edades do objeto Cdi go de Barras
do Rel atri o.
4.8.6.2.1.1 Alignment
Determi na o al i nhamento do texto do objeto no Rel atri o. As opes di sponvei s
so as segui ntes:
0 - ddtxLeft: al i nha o texto esquerda do objeto
1 - ddtxRight: al i nha o texto di rei ta do objeto
2 - ddtxCenter: al i nha o texto ao centro do objeto
4.8.6.2.1.2 BarWidth
Determi na a l argura das barras do Cdi go de Barras. Confi gurando a l argura
para 1, a barra do objeto expandi da em at 15 pontos, e assi m por di ante. Quanto
mai or o nmero confi gurado na propri edade, mai or a l argura da barra do cdi go
de barras. O val or padro desta propri edade 1.
4.8.6.2.1.3 Caption
Contm o texto do objeto propri amente di to. O val or padro desta propri edade
uma String vazi a.
4.8.6.2.1.4 CaptionPosition
Especi fi ca a posi o do texto da propri edade Caption no objeto. As opes
0 - ddbcCaptionNone: o texto da propri edade Caption no aparece no Cdi go de
Barras
1 - ddbcCaptionAbove: o texto da propri edade Caption aparece aci ma do Cdi go
de Barras
2 - ddbcCaptionBelow: o texto da propri edade Caption aparece abai xo do Cdi go
de Barras
O val or padro desta propri edade 0 - ddbcCaptionNone.
Visualizao 329
Confi gura ou retorna o dado associ ado ao objeto. Este dado associ ado pode ser
um campo da tabel a no Banco de Dados forneci do pel o objeto Consul ta; uma
expresso matemti ca com campos da Consul ta e funes do VBScri pt (neste caso,
o campo deve ser precedi do do smbol o de i gual ); ou um Tag ou propri edade do E3.
Neste caso o val or atual da vari vel ser mostrado ao real i zar a i mpresso. O
NOTA: O servi dor deve estar sendo executado para que o val or da vari vel possa ser
capturado.
4.8.6.2.1.6 Direction
Determi na a ori entao espaci al dos Cdi gos de Barra. As opes di sponvei s
nesta propri edade so as segui ntes:
Opes disponveis para Direction
OPO DESCRIO
0 - ddbcLeftToRight
O Cdi go de Barras di reci onado da
esquerda para a di rei ta.
1 - ddbcRightToLeft
O Cdi go de Barras di reci onado da
di rei ta para a esquerda.
2 - ddbcTopToBottom
O Cdi go de Barras di reci onado de
bai xo para ci ma.
3 - ddbcBottomToTop
O Cdi go de Barras di reci onado de
ci ma para bai xo.
O val or padro desta propri edade 0 - ddbcLeftToRight.
4.8.6.2.1.7 EnableCheckSum
Habi l i ta ou desabi l i ta a l ei tura do val or de checksum (caractere de objeto do
Cdi go de Barras). Se a propri edade esti ver habi l i tada para Fal se, somente cdi gos
com checksum sero afetados.
4.8.6.2.1.8 Font
Determi na a fonte do objeto no texto estabel eci do pel a propri edade Caption. O
val or padro desta propri edade "Ari al ".
NOTA: Esta propri edade no usada em scri pts ou em Associ aes, sendo edi tada
somente vi a E3 Studi o.
330 Visualizao
4.8.6.2.1.9 Forecolor
Especi fi ca a cor de preenchi mento de frente do objeto. Nos scri pts, uti l i ze a
val or padro desta propri edade preto (RGB(0, 0, 0)).
4.8.6.2.1.10 Style
Determi na o esti l o do Cdi go de Barras. As opes di sponvei s so as segui ntes:
Opes disponveis para Style
OPO DESCRIO
0 - ddbcNone
Esti l o de cdi go de barras padro.
1 - ddbcAnsi39
Esti l o de cdi go de barras ANSI 3 de 9
(Cdi go 39). Uti l i ze l etras, nmeros, -,*, $,
/, +, %, etc.
2 - ddbcAnsi39x
Esti l o de cdi go de barras ANSI
estendi do 3 de 9 (Cdi go estendi do 39).
Uti l i ze caracteres compl etos ASCI I .
3 - ddbcCode_2_of_5
Esti l o de cdi go de barras 2 de 5. Uti l i ze
somente nmeros.
4 - ddbcCode25intlv
Esti l o de cdi go de barras i ntercal ado 2
de 5. Uti l i ze somente nmeros.
5 - ddbcCode25mat
Esti l o de cdi go de barras Matri z 25.
6 - ddbcCode39
Esti l o de cdi go de barras Cdi go 39,
uti l i ze l etras, nmeros, -,*, $, /, +, %, etc.
7 - ddbcCode39x
Esti l o de cdi go de barras Cdi go 39
estendi do. Uti l i ze caracteres compl etos
ASCI I .
8 - ddbcCode_128_a
Esti l o de cdi go de barras 128 A. Uti l i ze
nmeros, pontuaes, ou l etras.
9 - ddbcCode_128_b
Esti l o de cdi go de barras 128 B. Uti l i ze
stri ngs, nmeros, pontuaes, ou l etras.
10 - ddbcCode_128_c
Esti l o de cdi go de barras 128 C. Uti l i ze
somente nmeros.
11 - ddbcCode_128auto
Esti l o de cdi go de barras 128
Automti co. Uti l i ze caracteres compl etos
ASCI I . Sel eci ona automati camente
cdi gos entre 128 A, B e C para setar no
cdi go de barras o val or menor.
12 - ddbcCode_93
Esti l o de cdi go de barras Cdi go 93.
Uti l i ze l etras, nmeros, -,*,$, /,+,%, etc.
13 - ddbcCode_93x
Esti l o de cdi go de barras Cdi go 93
estendi do. Uti l i ze caracteres compl etos
ASCI I .
14 - ddbcMSI
Esti l o de cdi go de barras Cdi go MSI .
Uti l i ze somente nmeros.
Visualizao 331
OPO DESCRIO
15 - ddbcPostNet
Esti l o de cdi go de barras PostNet.
Uti l i ze somente nmeros com uma
veri fi cao di gi tal .
16 - ddbcCodabar
Esti l o de cdi go de barras. Uti l i ze A, B, C,
D, +, -, :, /, ou nmeros.
17 - ddbcEAN_8
Esti l o de cdi go de barras EAN-8. Uti l i ze
somente nmeros (7 nmeros e
veri fi cao di gi tal ).
18 - ddbcEAN_13
Esti l o de cdi go de barras EAN-13. Uti l i ze
19 - ddbcUPC_A
Esti l o de cdi go de barras UPC-A. Uti l i ze
20 - ddbcUPC_EO
Esti l o de cdi go de barras UPC-E1. Uti l i ze
somente nmeros. Usado para smbol os
de compresso-zero UPC. Na
propri edade Caption, pode-se entrar com
6 dgi tos do cdi go UPC-E ou com 11
dgi tos. Se um cdi go com 11 dgi tos
i nseri do, o cdi go de barras converte
para 6 dgi tos UPC-E, se possvel . Seno,
converte-se de 11 para 6 dgi tos UPC-E e
nada mostrado.
21 - ddbcUPC_E1
Esti l o de cdi go de barras UPC-E1. Uti l i ze
somente nmeros. A l argura da entrada
de dados do UPC E1 de 6 caracteres
numri cos.
22 - ddbcRM4SCC
Esti l o de cdi go de barras Royal Mai l
RM4SCC. Uti l i ze somente l etras e
nmeros (com veri fi cao di gi tal ). Este
cdi go de barras uti l i zado no Rei no
Uni do.
23 - ddbcUCCEAN128
Esti l o de cdi go de barras UCC/EAN_128.
Uti l i ze caracteres compl etos ASCI I . A
verso especi al do cdi go 128 usado
na apl i cao HI BC.
4.8.6.3 Elipse, Retngulo e Retngulo Arredondado
Esta seo contm i nformaes sobre propriedades dos objetos El i pse, Retngul o e
Retngul o Arredondado do Rel atri o. Estes objetos no possuem eventos nem
mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades dos objetos El i pse,
Retngul o e Retngul o Arredondado do Rel atri o.
332 Visualizao
Especi fi ca a cor da l i nha do objeto. O val or padro desta propri edade preto
(RGB(0, 0, 0)).
4.8.6.3.1.2 LineStyle
Determi na o esti l o da l i nha do objeto. As opes di sponvei s desta propri edade
so as segui ntes:
Opes disponveis para LineStyle
OPO DESCRIO
0 - ddLSTransparent
A l i nha do objeto fi ca transparente.
1 - ddLSSolid
A l i nha do objeto aparece sl i da.
2 - ddLSDash
A l i nha do objeto fi ca tracejada.
3 - ddLSDot
A l i nha do objeto fi ca ponti l hada.
4 - ddLSDashDot
A l i nha do objeto fi ca tracejada.
5 - ddLSDashDotDot
A l i nha do objeto fi ca ponti l hada,
tracejada e ponti l hada.
O val or padro desta propri edade 1 - ddLSSolid.
4.8.6.3.1.3 LineWeight
Especi fi ca a l argura da l i nha do objeto. Confi gurando a l argura para 1, a l i nha do
objeto expandi da em at 15 pontos, se for 2, a l i nha expandi da em at 30
pontos e assi m por di ante. Quanto mai or o nmero confi gurado na propri edade,
mai or a l argura do objeto. O val or padro desta propri edade 1.
4.8.6.3.1.4 Shape
Permi te al terar a forma do objeto. As opes di sponvei s so as segui ntes:
Opes disponveis para Shape
OPO DESCRIO
0 - ddSHRectangle
Formato retangul ar.
1 - ddSHEllipse
Formato el pti co ou ci rcul ar.
2 - ddSHRoundRect
Formato de retngul o arredondado.
4.8.6.4 Figura
Esta seo contm i nformaes sobre propriedades do objeto Fi gura do Rel atri o.
Visualizao 333
Esta seo contm i nformaes sobre as propri edades do objeto Fi gura do
Rel atri o.
capturado.
4.8.6.4.1.2 Forecolor
Especi fi ca a cor do preenchi mento do fundo do objeto. Nos scri pts, uti l i ze a
funo do VBScri pt RGB para formar a cor a ser associ ada a esta propri edade. O
4.8.6.4.1.3 hyperLink
Especi fi ca o link atri budo ao texto. Para uti l i zar este recurso, use o evento
OnHyperLink. O val or padro desta propri edade uma String vazi a.
Especi fi ca a cor da l i nha do objeto. O val or padro desta propri edade preto
(RGB(0, 0, 0)).
Determi na o esti l o da l i nha do objeto. As opes di sponvei s desta propri edade
so as segui ntes:
OPO DESCRIO
0 - ddLSTransparent
A l i nha fi ca transparente no objeto.
1 - ddLSSolid
A l i nha aparece sl i da no objeto.
2 - ddLSDash
A l i nha fi ca tracejada no objeto.
3 - ddLSDot
A l i nha fi ca ponti l hada no objeto.
334 Visualizao
OPO DESCRIO
4 - ddLSDashDot
A l i nha fi ca tracejada e ponti l hada no
objeto.
5 - ddLSDashDotDot
A l i nha fi ca ponti l hada, tracejada e
ponti l hada no objeto.
O val or padro desta propri edade 1 - ddLSSolid.
Especi fi ca a l argura da l i nha do objeto. Confi gurando a l agura para 1, a l i nha do
objeto expandi da em at 15 pontos, e assi m por di ante. Quanto mai or o nmero
confi gurado na propri edade, mai or a l argura do objeto. O val or padro desta
propri edade 1.
4.8.6.4.1.7 Picture
Especi fi ca o arqui vo de fi gura para o objeto. As extenses permi ti das so
.bmp, .gi f, .jpg, .cur, .i co, .emf e .wmf. O val or padro desta propri edade uma
String vazi a.
4.8.6.4.1.8 PictureAlignment
Determi na o al i nhamento da fi gura no objeto. As opes di sponvei s so as
segui ntes:
Opes disponveis para PictureAlignment
OPO DESCRIO
0 - ddPATopLeft
Al i nha a fi gura no topo esquerdo do
objeto.
1 - ddPATopRight
Al i nha a fi gura no topo di rei to do objeto.
2 - ddPACenter
Al i nha a fi gura no centro do objeto.
3 - ddPABottomLeft
Al i nha a fi gura esquerda do objeto.
4 - ddPABottomRight
Al i nha a fi gura di rei ta do objeto.
O val or padro desta propri edade 2 - ddPACenter.
4.8.6.4.1.9 SizeMode
Especi fi ca o tamanho do objeto. As opes di sponvei s so as segui ntes:
Opes disponveis para SizeMode
OPO DESCRIO
0 - ddsMClip
Mostra o objeto no seu tamanho atual .
Visualizao 335
OPO DESCRIO
1 - ddsMStretch
Ajusta o objeto de acordo com a sua
rea.
2 - ddsMZoom
Ajusta a al tura ou a l argura da i magem
do objeto dentro da rea especi fi cada,
sem di storc-l a.
4.8.6.5 SetPoint
Esta seo contm i nformaes sobre propriedades do objeto SetPoi nt do Rel atri o.
Esta seo contm i nformaes sobre as propri edades do objeto SetPoi nt do
Rel atri o.
Determi na o al i nhamento do texto no objeto. As opes di sponvei s para esta
propri edade so:
0 - Left: al i nhamento esquerda (padro)
1 - Right: al i nhamento di rei ta
2 - Center: al i nhamento central i zado
4.8.6.5.1.2 CanGrow
Determi na a apl i cao do efei to de stretch ao texto do objeto. Caso a l argura ou
al tura do objeto sejam aumentadas, o texto acompanha esta vari ao. Se a
al tura e l argura do objeto. Caso contrri o, este permanece com as confi guraes
4.8.6.5.1.3 CanShrink
Determi na a apl i cao do efei to de encol hi mento ao texto do objeto. Caso a
l argura ou al tura do objeto sejam di mi nudas, o texto acompanha esta vari ao. Se
a propri edade esti ver confi gurada para True, o texto acompanha as vari aes de
4.8.6.5.1.4 ClassName
Retorna a cl asse do objeto. Esta propri edade somente de l ei tura.
336 Visualizao
capturado.
4.8.6.5.1.6 Font
Esta propri edade determi na a fonte do texto no objeto. O val or padro desta
propri edade uma String vazi a. Esta propri edade no pode ser uti l i zada em scri pts
ou em Associ aes e confi gurada somente vi a Studi o.
A propri edade ForeColor especi fi ca a cor de fundo do objeto. Nos scri pts, uti l i ze
a funo do VBScri pt RGB para montar a cor a ser associ ada a esta propri edade. O
A propri edade hyperLink determi na o link que ser atri budo ao texto. Para
uti l i zar este recurso, use o evento OnHyperLink.
4.8.6.5.1.10 OutputFormat
Confi gura ou retorna a formatao do texto da propri edade Text, uti l i zado nas
confi guraes das funes de formatao (FormatCurrency, FormatDateTime,
FormatNumber e FormatPercent) do Vi sual Basi c.
4.8.6.5.1.11 Style
Retorna o esti l o do texto confi gurado no objeto. Esta propri edade somente de
l ei tura.
Visualizao 337
4.8.6.5.1.12 SummaryDistinctField
Determi na o nome do campo que ser usado pel a funo sel eci onada na
propri edade SummaryFunc. Esta propri edade s vl i da se a funo defi ni da em
SummaryFunc for do grupo de funes Distinct Summary, o qual abrange as funes
de nmeros 9 at 15, e quando a propri edade SummaryType tem val or di ferente de
0.
4.8.6.5.1.13 SummaryFunc
Determi na o ti po de funo que ser usada para processar os val ores do campo
especi fi cado na propri edade DataField, como l i stado na tabel a a segui r. Esta
propri edade s vl i da quando a propri edade SummaryType tem val or di ferente
de 0.
Opes disponveis para SummaryFunc
OPO DESCRIO
0 - Sum
Cal cul a a soma de todos os val ores
dentro do i nterval o de totai s
especi fi cado (grupo, pgi na ou
Rel atri o).
1 - Avg
Cal cul a a mdi a de todos os val ores
Rel atri o).
2 - Count
Conta o nmero de val ores dentro do
i nterval o de totai s especi fi cado (grupo,
pgi na ou Rel atri o).
3 - Min
Mostra o menor val or (val or mni mo)
Rel atri o).
4 - Max
Mostra o mai or val or (val or mxi mo)
Rel atri o).
5 - Var
Cal cul a a vari nci a dos val ores dentro do
i nterval o de totai s especi fi cado (grupo,
pgi na ou Rel atri o).
6 - VarP
Cal cul a a vari nci a popul aci onal dos
val ores dentro do i nterval o de totai s
Rel atri o).
7 - Dev
Cal cul a o desvi o padro dos val ores
Rel atri o).
338 Visualizao
OPO DESCRIO
8 - DevP
Cal cul a o desvi o padro popul aci onal
dos val ores dentro do i nterval o de totai s
Rel atri o).
9 - DSum
Cal cul a a soma de todos os val ores
di sti ntos dentro do i nterval o de totai s
Rel atri o).
10 - DAvg
Cal cul a a mdi a baseada nos val ores
di sti ntos dentro do i nterval o de totai s
rel atri o).
11 - DCount
Conta o nmero dos val ores di sti ntos
Rel atri o).
12 - DVar
Cal cul a a vari nci a dos val ores di sti ntos
Rel atri o).
13 - DVarP
Cal cul a a vari nci a popul aci onal dos
val ores di sti ntos dentro do i nterval o de
totai s especi fi cado (grupo, pgi na ou
Rel atri o).
14 - DDev
Cal cul a o desvi o padro dos val ores
Rel atri o).
15 - DDevP
Cal cul a o desvi o padro popul aci onal
dos val ores di sti ntos dentro do i nterval o
de totai s especi fi cado (grupo, pgi na ou
Rel atri o).
4.8.6.5.1.14 SummaryGroup
Esta propri edade s vl i da quando a propri edade SummaryType for i gual a 3 -
SubTotal. SummaryGroup i ndi ca qual o nome da seo GroupHeader que ser
usada para control ar os subtotai s, ou seja, a cada mudana de val or no
GroupHeader, o somatri o rei ni ci ado.
NOTA: Quando esta propri edade uti l i zada, as propri edades CanShrink e CanGrow
fi cam desabi l i tadas.
4.8.6.5.1.15 SummaryRunning
Determi na se ser fei to o total de somatri os acumul ados, de acordo com as
opes:
Visualizao 339
0 - None: no faz o total
1 - Group: cal cul a os totai s acumul ados para cada i nterval o de totai s
especi fi cado
2 - All: cal cul a o total acumul ado para todos os val ores do rel atri o,
i ndependente do agrupamento.
Esta propri edade s vl i da quando a propri edade SummaryType tem val or
di ferente de 0.
4.8.6.5.1.16 SummaryType
Determi na o ti po ou nvel de total i zao a ser gerada. As opes di sponvei s so
as segui ntes:
Opes disponveis para SummaryType
OPO DESCRIO
0 - None
Sem gerao de somatri o.
1 - GrandTotal
Especi fi ca que ser total i zado todo o
contedo do Rel atri o.
2 - PageTotal
Especi fi ca que ser gerado um subtotal
por pgi na.
3 - SubTotal
Especi fi ca que ser gerado um subtotal
para cada grupo, defi ni do na
propri edade SummaryGroup.
4 - PageCount
Especi fi ca o contador de pgi na.
4.8.6.5.1.17 Text
Determi na o texto que ser atri budo ao objeto.
4.8.6.5.1.18 VerticalAlignment
Determi na o al i nhamento verti cal do objeto, a saber:
0 - Top: al i nhamento pel o topo
1 - Middle: al i nhamento ao centro
2 - Bottom: al i nhamento pel a base
4.8.6.5.1.19 WordWrap
funci one, a propri edade Multiline deve ser obri gatori amente i gual a True. Se for
Fal se, a confi gurao white-space:nowrap i r aparecer na propri edade Style.
340 Visualizao
4.8.6.6 Texto
Esta seo contm i nformaes sobre propriedades do objeto Texto do Rel atri o.
Esta seo contm i nformaes sobre as propri edades do objeto Texto do
Rel atri o.
A propri edade Alignment determi na o al i nhamento do texto, a saber:
0 - ddtxLeft: al i nhamento esquerda
1 - ddtxRight: al i nhamento di rei ta
2 - ddtxCenter: al i nhamento central i zado (val or padro)
4.8.6.6.1.2 Angle
A propri edade Angle i ndi ca o ngul o do texto. O val or da propri edade deve ser
especi fi cado em dci mos de graus, ou seja, para que o texto seja mostrado em um
ngul o de 45 graus, o val or deve ser i gual 450. O val or padro desta propri edade
0 (posi ci onamento hori zontal ).
4.8.6.6.1.3 Caption
A propri edade Caption contm o texto do objeto propri amente di to. O val or
4.8.6.6.1.4 ClassName
A propri edade ClassName permi te especi fi car uma cl asse CSS gl obal (i ndi cada
em uma fol ha de esti l os CSS externa) a ser apl i cada ao texto. Uma cl asse CSS
(Cascading Style Sheet) um padro de formatao que determi na ti po e tamanho
de l etra ou al i nhamento e espaamento do pargrafo, entre outras caractersti cas.
Atravs de CSS, pode-se apl i car um padro de formatao pr-defi ni do a um texto,
agi l i zando e uni fi cando a apresentao dos textos. Para apl i car um esti l o
especfi co, pode-se uti l i zar a propri edade Style. O val or padro dessa propri edade
o esti l o Normal .
4.8.6.6.1.5 Font
Esta propri edade i ndi ca o nome da fonte (ti po das l etras) do texto. O val or
padro desta propri edade uma String vazi a (o E3 i r usar o padro do si stema).
Visualizao 341
NOTA: Esta propri edade no pode ser uti l i zada em scri pts ou Associ aes,
confi gurada somente vi a Studi o e s pode ser modi fi cada em tempo de
confi gurao.
A propri edade Forecolor especi fi ca a cor de preenchi mento do fundo do objeto.
Nos scri pts, uti l i ze a funo RGB do VBScri pt para montar a cor a ser associ ada a
esta propri edade. O val or padro desta propri edade preto (RGB(0, 0, 0)).
A propri edade hyperLink determi na um link que ser atri budo ao objeto. Para
uti l i zar este recurso, use o evento OnHyperLink. O val or padro desta propri edade
uma String vazi a.
4.8.6.6.1.9 Style
A propri edade Style permi te especi fi car um esti l o CSS (Cascading Style Sheet) para
o texto, em substi tui o ao esti l o gl obal . O val or da propri edade deve ser uma
String CSS vl i da, caso contrri o a propri edade ser i gnorada. O val or padro
desta propri edade uma String vazi a (o E3 i r usar o padro do si stema). Exempl o:
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 propri edade VerticalAlignment determi na o al i nhamento verti cal do texto, a
saber:
0 - ddTxTop: al i nhamento pel o topo (padro)
1 - ddTxMiddle: al i nhamento central i zado
2 - ddTxBottom: al i nhamento pel a base
342 Visualizao
4.8.6.6.1.11 WordWrap
4.8.6.7 Linha
Esta seo contm i nformaes sobre propriedades do objeto Li nha do Rel atri o.
Esta seo contm i nformaes sobre as propri edades do objeto Li nha do
Rel atri o.
A propri edade LineColor especi fi ca a cor da l i nha do objeto O val or padro desta
Esta propri edade determi na o esti l o da l i nha do objeto. O val or padro desta
propri edade 1 - ddLSSolid. As outras opes di sponvei s desta propri edade so as
segui ntes:
OPO DESCRIO
0 - ddLSTransparent
A l i nha fi ca transparente no objeto.
1 - ddLSSolid
A l i nha aparece sl i da no objeto.
2 - ddLSDash
A l i nha fi ca tracejada no objeto.
3 - ddLSDot
A l i nha fi ca ponti l hada no objeto.
4 - ddLSDashDot
A l i nha fi ca tracejada e ponti l hada no
objeto.
5 - ddLSDashDotDot
A l i nha fi ca ponti l hada, tracejada e
ponti l hada no objeto.
A propri edade LineWeight especi fi ca a l argura da l i nha do objeto. Confi gurando
a l argura para 1, a l i nha do objeto expandi da em at 15 pontos, se a l argura for
2, a l i nha do objeto expandi da em at 30 pontos, e assi m por di ante. Quanto
mai or o nmero confi gurado na propri edade, mai or a l argura do objeto. O val or
Visualizao 343
4.8.6.7.1.4 X1
A propri edade X1 habi l i ta ou desabi l i ta a posi o do ponto i ni ci al da l i nha no
ei xo X.
4.8.6.7.1.5 X2
A propri edade X2 determi na a posi o do ponto fi nal da l i nha no ei xo X. O val or
padro desta propri edade vazi o.
4.8.6.7.1.6 Y1
A propri edade Y1 determi na a posi o do ponto i ni ci al da l i nha no ei xo Y. O val or
4.8.6.7.1.7 Y2
A propri edade Y2 determi na a posi o do ponto fi nal da l i nha no ei xo Y. O val or
4.8.6.8 Quebra de Pgina
Esta seo contm i nformaes sobre propriedades do objeto Quebra de Pgi na do
Esta seo contm i nformaes sobre as propri edades do objeto Quebra de Pgi na
do Rel atri o.
4.8.6.8.1.1 Enabled
A propri edade Enabled habi l i ta ou desabi l i ta o objeto no Rel atri o. Se a opo
esti ver confi gurada para True, o objeto habi l i tado no Rel atri o. Caso contrri o, o
objeto fi ca desabi l i tado. O val or padro desta propri edade True.
4.8.6.9 Tabela
Esta seo contm i nformaes sobre propriedades do objeto Tabel a do Rel atri o.
Esta seo contm i nformaes sobre as propri edades do objeto Tabel a do
Rel atri o.
344 Visualizao
4.8.6.9.1.1 CanGrow
Determi na a apl i cao do efei to de stretch ao texto do objeto. Caso a l argura ou
al tura do objeto sejam aumentadas, o texto acompanha esta vari ao. Se a
4.8.6.9.1.2 CanShrink
Determi na a apl i cao do efei to de encol hi mento ao texto do objeto. Caso a
l argura ou al tura do objeto sejam di mi nudas, o texto acompanha esta vari ao. Se
a propri edade esti ver confi gurada para True, o texto acompanha as vari aes de
4.8.6.9.1.3 CloseBorder
Esta propri edade habi l i ta ou desabi l i ta a vi sual i zao da l i nha da borda da base
da tabel a, caso a mesma ul trapasse mai s de uma pgi na no Rel atri o.
4.8.6.9.1.4 left
A propri edade left retorna o val or do posi ci onamento esquerdo do objeto no
Rel atri o. O val or padro desta propri edade vazi o.
4.8.6.10 E3Chart
Esta seo contm i nformaes sobre propriedades do objeto E3Chart do Rel atri o.
Exemplo de utilizao das propriedades do E3Chart em um Relatrio
Os scri pts abai xo devem ser cri ados na seo PageHeader do Rel atri o, uti l i zando
o evento OnBeforePrint. Exempl os:
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
Visualizao 345
' que ser utilizado no relatrio.
Set chartfrom = _
Application.GetFrame().Screen.Item("E3Chart1")
Set chart = _
Report.Sections("PageHeader").Controls("E3Chart2")
chart.CopyConfig(chartfrom)
chart.LoadData()
chart.FitAll
End Sub
NOTA: A descri o das propri edades do E3Chart no Rel atri o so as mesmas
expl i cadas no tpi co Propriedades do E3Chart.
346 Objetos de Servidor
5
Objetos de Servidor
CAPTULO
Esta seo contm i nformaes sobre as propriedades comuns aos objetos de
Servi dor. Estes objetos no possuem eventos nem mtodos comuns. Os objetos que
comparti l ham propri edades de Servi dor so os segui ntes:
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 i nformaes sobre as propri edades comuns a todos os objetos
de Servi dor.
5.1.1 IsAlarmArea
Habi l i ta ou desabi l i ta a funci onal i dade de rea de Al arme para os objetos de
Servi dor. Esta propri edade no est di sponvel nos objetos rea de Al arme, Fonte
de Al arme e Servi dor de Al armes. O val or padro desta propri edade Fal so. Ao
habi l i tar esta propri edade, o objeto passar a contar com as mesmas
propri edades de uma rea de Alarme.
5.1.2 Propriedades Comuns a Objetos de Servidor como
reas de Alarme
Esta seo contm i nformaes sobre propri edades comuns a objetos de servi dor
que se comportam como reas de Al arme.
Objetos de Servidor 347
5.1.2.1 ActiveAlarms
Determi na o nmero de al armes ati vos dentro do objeto. Esta propri edade
somente de l ei tura e seu val or padro 0 (zero).
5.1.2.2 ActiveHighAlarms
5.1.2.3 ActiveHighNACKAlarms
5.1.2.4 ActiveLowAlarms
5.1.2.5 ActiveLowNACKAlarms
5.1.2.6 ActiveMedAlarms
5.1.2.7 ActiveMedNACKAlarms
5.1.2.8 ActiveNACKAlarms
Indi ca o nmero de al armes que esto sem reconheci mento dentro da rea. Esta
5.1.2.9 Alarm
Estabel ece a exi stnci a de al armes ati vos dentro do objeto. Se a opo esti ver em
True, exi ste pel o menos um al arme ati vo dentro do objeto, e a propri edade
ActiveAlarms far a l ei tura no servi dor, i ndi cando a quanti dade de al arme ati vos.
Caso contrri o, a propri edade ActiveNACKAlarms far a l ei tura dos al armes sem
reconheci mento. Esta propri edade somente de l ei tura.
5.1.2.10 AlarmVerify
Habi l i ta a veri fi cao de todos os al armes dentro do objeto. Depoi s de
habi l i tada esta veri fi cao (True), se a propri edade ActiveAlarms possui r val or
mai or que 0 (zero), o servi dor veri fi ca tanto os al armes ati vos quanto os sem
reconheci mento, l i stando estes l ti mos pel a propri edade ActiveNACKAlarms. Esta
propri edade ti l para evi tar-se o efei to de aval anche de al guns si stemas, onde o
aconteci mento de um evento gera uma grande quanti dade de al armes
correl aci onados.
5.1.2.11 InactiveHighNACKAlarms
5.1.2.12 InactiveLowNACKAlarms
5.1.2.13 InactiveMedNACKAlarms
5.1.2.14 InactiveNACKAlarms
5.1.2.15 UserFields
Retorna um objeto que uma col eo de Campos de Usuri o de Al armes de um
objeto de Servi dor. Veja o i tem Coleo de Campos de Usurio de Alarmes para
mai ores i nformaes sobre a col eo de objetos retornados por esta propri edade.
5.2 Coleo de Campos de Usurio de Alarmes
de Campos de Usuri o de Al armes de objetos de Servi dor do E3, retornada pel a
propri edade UserFields de reas de Alarme e Fontes de Alarme.
5.2.1 Mtodos Comuns
Esta seo contm i nformaes sobre os mtodos comuns col eo de Campos de
Usuri o de Al armes de objetos de Servi dor do E3.
5.2.1.1 Item
Item(Index)
Retorna um objeto Campo de Usuri o de Al armes i ndi cado pel o parmetro Index,
que pode ser o val or da propri edade Index (i ntei ro) ou o val or da propri edade
Name (texto) do objeto.
5.2.2 Propriedades Comuns
Campos de Usuri o de Al armes de objetos de Servi dor do E3.
5.2.2.1 Count
Retorna o nmero de objetos fi l hos (i tens) de uma col eo de Campos de Usuri o
de Al armes. Se a Col eo no contm objetos fi l hos, esta propri edade retorna o
val or 0 (zero).
5.2.3 Campo de Usurio de Alarmes
Esta seo contm i nformaes sobre as propriedades dos objetos do ti po Campo
de Usuri o de Al armes conti dos na Col eo de Campos de Usuri o de Al armes
retornada pel a propri edade UserFields de reas de Alarme, Fontes de Alarme e de
Objetos de Servidor com comportamento de rea de Al arme. Este objeto no possui
eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades dos objetos do ti po Campo
de Usuri o de Al armes conti dos na col eo de Campos de Usuri o de Al armes.
5.2.3.1.1 Index
Retorna o ndi ce deste objeto na Col eo de Campos de Usuri o de Al armes. Este
val or pode ser uti l i zado como parmetro para o mtodo Item da Col eo.
5.2.3.1.2 Link
Retorna ou modi fi ca a Associ ao confi gurada para este Campo de Usuri o de
Al armes. Para al terar em tempo de execuo a Associ ao confi gurada nesta
propri edade, deve-se desati var o objeto. Por exempl o:
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 Col eo de Campos de Usuri o de Al armes. Este
val or pode ser uti l i zado como parmetro para o mtodo Item da Col eo.
5.2.3.1.4 Value
Retorna ou confi gura o val or atual do Campo de Usuri o de Al armes. Esta
propri edade tem um comportamento di ferenci ado dependendo se o objeto est
ati vo ou i nati vo. Com o objeto ati vo, o val or retornado na l ei tura desta propri edade
obedece segui nte l i sta de pri ori dades:
1. Se h um val or forado (propri edade ValueSource i gual a evsForcedValue),
retorna este val or
2. Se h uma Associ ao confi gurada (propri edade ValueSource i gual a evsLink),
retorna o val or atual da Associ ao
3. Busca o val or deste Campo de Usuri o na rea hi erarqui camente superi or
(percorre a hi erarqui a de reas em senti do ascendente)
4. Se no h nenhuma rea hi erarqui camente superi or que tenha um val or
forado ou uma Associ ao confi gurada para este Campo de Usuri o, recupera
o val or padro do Campo de Usuri o confi gurado no Servi dor de Al armes
Se o objeto esti ver i nati vo, a l ei tura desta propri edade retorna o val or forado,
caso exi sta (propri edade ValueSource i gual a evsForcedValue). Se no h um val or
forado, a l ei tura da propri edade fal ha.
O comportamento das escri tas nesta propri edade o mesmo, tanto com o objeto
ati vo como i nati vo. A escri ta fal ha caso haja uma Associ ao confi gurada
(propri edade ValueSource i gual a evsLink). Caso contrri o, o novo val or acei to e a
propri edade ValueSource automati camente confi gurada para evsForcedValue.
5.2.3.1.5 ValueSource
Especi fi ca a fonte da propri edade Value deste Campo de Usuri o de Al armes. Os
val ores possvei s para esta propri edade so os segui ntes:
0 - evsInherited: A propri edade Value herdada do Servi dor de Al armes ou da
rea superi or (val or padro)
1 - evsLink: A propri edade Value forneci da pel a propri edade Link
2 - evsForcedValue: A propri edade Value forneci da pel o usuri o
Esta propri edade acei ta escri tas tanto com o objeto ati vo como i nati vo. Em ambos
os casos, no possvel escrever o val or evsLink. Para trocar a propri edade
ValueSource para o val or evsLink, deve-se escrever di retamente na propri edade Link
(desati vando o objeto se esti ver em tempo de execuo).
NOTA: Ao exportar um objeto Campo de Usuri o de Al armes, a propri edade
ValueSource deve ser col ocada aps as propri edades Link e Value na ordem das
col unas.
5.3 Objetos em Tempo de Execuo do Servidor
Esta seo contm i nformaes sobre objetos que s podem ser uti l i zados em
tempo de execuo, o Servi dor (Appl i cati on) e as Pastas de Apl i cati vo.
5.3.1 Servidor
Esta seo contm i nformaes sobre mtodos especfi cos do objeto Server
(Appl i cati on). Este objeto possui os mtodos gerai s Item e Save, al m das
propri edades Name e Count, descri tos na seo Eventos, Mtodos e Propriedades
Gerais dos Objetos. O objeto no possui eventos associ ados.
5.3.1.1 Mtodos
Esta seo contm i nformaes sobre os mtodos especfi cos do objeto Servi dor.
NOTA: Os mtodos aqui descri tos s podem ser uti l i zados em tempo de execuo,
no estando di sponvei s no Studi o.
5.3.1.1.1 ClearFailure
ClearFailure(FailureName)
Este mtodo deve ser chamado para i ndi car que uma fal ha reportada por
ReportFailure no est mai s ati va. O parmetro FailureName contm o nome da
fal ha (defi ni do pel o usuri o) e deve ser passado para o mtodo ReportFailure,
quando de sua chamada.
5.3.1.1.2 E3GetActor
E3GetActor()
Este mtodo retorna o nome de l ogon do usuri o que i ni ci ou a requi si o atual no
E3Run. Se o E3Run no esti ver atual mente tratando uma operao gerada por outro
processo, retorna a String "System". Se no houver nenhum usuri o l ogado no
processo que gerou a requi si o atual , retorna a String "Anonymous".
5.3.1.1.3 LoadReport
LoadReport(ReportName)
Carrega um model o de Rel atri o. Veja o mtodo LoadReport do objeto Vi ewer para
um exempl o de uso.
NOTA: O mtodo PrintPreview do objeto Rel atri o no est di sponvel em Rel atri os
carregados uti l i zando este mtodo.
5.3.1.1.4 ReportFailure
ReportFailure(FailureName, FailureDescription, FailureWeight)
Este mtodo permi te que o apl i cati vo reporte fal has para o Servi dor, que podem ser
vi sual i zadas cl i cando com o boto di rei to sobre o cone do E3 na rea de
Noti fi cao. Quando o mtodo usado, o cone do E3 na rea de Noti fi cao
comea a pi scar em vermel ho, i ndi cando a ocorrnci a da fal ha. As fal has
reportadas so normal mente condi es que i mpedem que o apl i cati vo funci one
parci al mente (probl ema de comuni cao em uma porta seri al , link de rede i nati vo,
banco de dados sem conexo, etc.), e que normal mente no podem ser detectadas
pel o Servi dor. Este mtodo tem duas fi nal i dades:
Avi sar o operador do si stema a respei to de probl emas em um servi dor
Auxi l i ar o gerenci ador automti co de hot-standby a deci di r qual servi dor est
mai s apto para executar o apl i cati vo
NOTA: O mtodo ReportFailure s est di sponvel no Servi dor.
O mtodo ReportFailure possui os segui ntes parmetros:
Parmetros do mtodo ReportFailure
NOME DESCRIO
FailureName
Contm o nome da fal ha (defi ni do pel o
usuri o). Este mesmo parmetro deve
ser passado para o mtodo ClearFailure
quando o apl i cati vo detectar que a fal ha
no est mai s ati va. Por exempl o, "Fal ha
COM1".
FailureDescription
Descri o textual da fal ha (defi ni da pel o
usuri o). Por exempl o, "Fal ha de
comuni cao na porta COM1".
FailureWeight
Defi ne a severi dade (ou peso) da fal ha.
O val or 0 i ndi ca um avi so (sem
gravi dade). Val ores mai ores que zero
i ndi cam fal has. Quanto mai or o val or,
mai s grave a fal ha.
Exempl o:
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 permi te regi strar mensagens em um arqui vo texto. As mensagens so
gravadas em um arqui vo com o mesmo nome e cami nho do arqui vo de Domni o,
com a extenso .txt. Por exempl o, se a apl i cao de Domni o for c:\teste.dom, as
mensagens sero regi stradas no arqui vo c:\teste.txt. Cada nova mensagem
adi ci onada sempre no fi nal do arqui vo. Caso haja fal ha no regi stro no arqui vo
(como por exempl o, di rei to de acesso negado, fal ta de espao em di sco, etc.),
ocorrer um erro de scri pt.
Este mtodo pode ser usado, por exempl o, para regi strar mensagens de depurao
de scri pts que no sejam executados no Vi ewer (haja vi sta que neste caso no
possvel uti l i zar o mtodo MsgBox).
Parmetros do mtodo Trace
NOME DESCRIO
MessageText
Mensagem de texto defi ni da pel o
usuri o.
LogTimeStamp
(Opci onal ) Bool eano que i ndi ca se cada
regi stro deve ter a data e a hora
(timestamp). Se omi ti do, assume True.
BreakLine
(Opci onal ) Bool eano que i ndi ca a
presena ou no de uma quebra de l i nha
ao fi nal de cada mensagem. Em Fal se,
faz com que o arqui vo tenha todos os
regi stros em uma s l i nha. Se omi ti do,
assume True.
5.3.1.1.6 TrackEvent
TrackEvent(EventMessage, Comment, TimeStamp)
O mtodo TrackEvent permi te gerar eventos vi a scri pt manual mente. Veja o mtodo
TrackEvent do objeto Vi ewer para mai s i nformaes.
5.3.2 Pastas de Aplicativo
O objeto Pasta de Apl i cati vo semel hante ao objeto Pasta de Dados, do objeto
Servidor de Dados, permi ti ndo agrupar objetos do Servi dor dentro de pastas.
Contudo, exi stem di ferenas i mportantes:
O objeto Pasta de Apl i cati vo s est di sponvel em tempo de execuo
O objeto possui as propri edades gerai s Application, Count, Name, Parent e
PathName, al m dos mtodos gerai s Item e Save
O objeto permi te uti l i zar o comando For Each do VBScri pt para enumerar seus
objetos fi l hos, mas este acesso l eva em conta apenas os objetos do Servi dor, no
l i stando, por exempl o, Tel as e Recursos que estejam dentro das pastas
A pasta rai z a parti r da qual possvel enumerar os objetos sempre o objeto
Servidor
5.4 Objetos em Tempo de Configurao
Esta seo contm i nformaes sobre objetos que s podem ser uti l i zados em
tempo de confi gurao.
5.4.1 E3StudioApplication
Esta seo contm i nformaes sobre mtodos especfi cos do objeto
E3Studi oAppl i cati on. Este objeto no possui eventos nem propri edades especfi cos.
5.4.1.1 Mtodos
Esta seo contm i nformaes sobre os mtodos especfi cos do objeto
E3Studi oAppl i cati on.
NOTA: Os mtodos aqui descri tos s podem ser uti l i zados no Studi o, no estando
di sponvei s em tempo de execuo.
5.4.1.1.1 CreateFile
CreateFile(ProjectName, ClassName[, FileName, FolderName, RunWizard,
OpenView])
Cri a um novo objeto em um arqui vo de projeto (.prj). Os parmetros deste mtodo
so os segui ntes:
ProjectName: o nome do arqui vo de projeto onde o objeto ser i nseri do. Este
parmetro no pode ser vazi o, e o arqui vo de projeto deve estar carregado no
Studi o. Pode ser o cami nho compl eto do arqui vo de projeto ou o cami nho
rel ati vo ao arqui vo de Domni o. No h necessi dade de adi ci onar a extenso .prj
ClassName: o nome da cl asse do objeto que ser cri ado. Veja a tabel a a segui r
para os val ores permi ti dos neste parmetro
FileName: o nome do objeto i nseri do. Se este parmetro for omi ti do, ser
uti l i zado o nome padro para a cri ao do objeto de ti po i ndi cado em
ClassName. O tamanho mxi mo permi ti do para este parmetro de 32 caracteres
e se j exi sti r, ser automati camente i ncrementado
FolderName: o nome da Pasta onde o objeto ser cri ado. Se este parmetro for
omi ti do, o objeto cri ado na rai z do arqui vo de projeto. O nome da Pasta deve
obedecer s mesmas regras da seo de Notas do mtodo RenameFolder
RunWizard: Bool eano que i ndi ca se o assi stente de confi gurao da cl asse
i ndi cada por ClassName ser aberto aps a execuo do mtodo. O val or padro
deste parmetro Verdadei ro
OpenView: Bool eano que i ndi ca se o edi tor do objeto i nseri do ser aberto aps
a execuo do mtodo. O val or padro deste parmetro Verdadei ro
Valores possveis para o parmetro ClassName
OBJETO A SER CRIADO VALOR DO PARMETRO
Banco de Dados
DB.DBServer
Configurao de Alarmes
DB.Al armConfi g
Driver de Comunicao
I ODrv.I ODri ver
Driver de Comunicao OPC
I ODrv.OPCDri ver
Frmula
DB.Formul a
Histrico
DB.Hi st
OBJETO A SER CRIADO VALOR DO PARMETRO
Quadro
Panel .FrameSet
Relatrio
Panel .Report
Servidor de Alarmes
DB.Al armServer
Servidor de Dados
Panel .DataServer
Storage
DB.Hi stori an
Tela
Panel .Screen
Viewer
Panel .Vi ewer
5.4.1.1.2 CreateFolder
CreateFolder(ProjectName, FolderName[, ParentFolder])
Cri a uma nova Pasta com o nome defi ni do em FolderName, dentro do arqui vo de
projeto (.prj) ProjectName, e cujo objeto pai i ndi cado por ParentFolder. As
segui ntes restri es se apl i cam a este mtodo:
O arqui vo de projeto i ndi cado no parmetro ProjectName deve exi sti r, e estar
aberto no Studi o
Se o parmetro FolderName for vazi o, ser uti l i zado o nome padro para cri ao
de Pastas. Por exempl o, Pasta1
O tamanho mxi mo permi ti do para o parmetro FolderName de 32 caracteres
Se o nome i ndi cado no parmetro FolderName j exi sti r, o nome ser
automati camente i ncrementado
O nome da Pasta em FolderNome deve obedecer s mesmas regras da seo de
Notas do mtodo RenameFolder
A Pasta i ndi cada no parmetro ParentFolder deve exi sti r. Se o parmetro for
omi ti do, a nova Pasta cri ada na rai z do arqui vo de projeto
5.4.1.1.3 CreatePRJ
CreatePRJ(Filename)
Cri a um novo arqui vo de projeto (.prj) com o nome Filename, e o adi ci ona ao
Domni o corrente, se exi sti r. Se o parmetro Filename no for um cami nho absol uto,
ser uti l i zado um cami nho rel ati vo ao Domni o, ou o cami nho padro para
arqui vos de projeto (sal vo no Regi stro do Wi ndows). A extenso .prj adi ci onada
automati camente, se necessri o.
5.4.1.1.4 RenameFolder
RenameFolder(OldName, NewName)
Permi te renomear uma Pasta em um arqui vo de projeto aberto no Studi o,
pertencente ou no ao Domni o. O parmetro OldName o cami nho compl eto da
Pasta que se deseja renomear, e o parmetro NewName o novo nome, sem o
cami nho.
NOTAS:
Se o cami nho compl eto da Pasta no parmetro OldName ou o novo nome no
parmetro NewName comea com um caractere que no seja uma l etra (sem
acentos nem ""), ou se possui um caractere qual quer que no seja uma l etra
(sem acentos nem ""), um al gari smo (0-9) ou subl i nhado, obri gatri o o uso de
col chetes no nome
Se o parmetro NewName i nvl i do, se o parmetro OldName contm um erro de
si ntaxe, ou ai nda se o cami nho i ndi cado em OldName no foi encontrado em
nenhum arqui vo de projeto aberto, ocorrer um erro de scri pt
Arqui vos de projeto protegi dos por senha devero ser desbl oqueados antes da
uti l i zao deste mtodo
5.5 Drivers
Esta seo contm i nformaes sobre eventos, mtodos e propri edades dos
segui ntes 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
Dri ver de Comuni cao.
5.5.1.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Dri ver de Comuni cao.
5.5.1.1.1 AfterStart
AfterStart()
Ocorre depoi s que o Dri ver de Comuni cao i ni ci ou a comuni cao. comum fazer-
se um scri pt para este evento uti l i zando o mtodo Write para fazer confi guraes
em equi pamentos. Exempl o:
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
5.5.1.1.2 AfterStop
AfterStop()
Ocorre depoi s que o Dri ver fi nal i zou a comuni cao. Uti l i ze o evento AfterStop
para fazer al guma ao que seja necessri a aps termi nada a comuni cao do
Dri ver.
5.5.1.1.3 BeforeStart
BeforeStart()
Ocorre quando o Dri ver est prestes a i ni ci ar a comuni cao. Uti l i ze o evento
BeforeStart para fazer al guma ao que seja necessri a antes de i ni ci ar a
comuni cao, como por exempl o a confi gurao de parmetros do Dri ver. Exempl o:
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 Dri ver est prestes a fi nal i zar a comuni cao. Uti l i ze o evento
BeforeStop para fazer al guma ao que seja necessri a antes que a comuni cao
seja termi nada, como por exempl o, escrever ou l er val ores do equi pamento ou
di sposi ti vo, antes que a comuni cao no esteja mai s di sponvel .
5.5.1.1.5 OnCommError
OnCommError(EvtType, Size, Element, N1, N2, N3, N4)
Ocorre quando al gum erro de escri ta ou l ei tura detectado pel o Dri ver de
Comuni cao. Uti l i ze o evento OnCommError para saber quando ocorreu uma
fal ha de escri ta ou l ei tura no Dri ver. As vari vei s de evento recebem i nformaes
sobre o erro ocorri do. Com estes val ores, possvel rastrear quai s Tags esto
apresentando probl emas de comuni cao.
Variveis do evento OnCommError
NOME DESCRIO
EvtType
I nforma qual o ti po de operao o Dri ver
estava efetuando quando ocorreu o erro,
conforme as opes a segui 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 escri 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 cao). Size determi nado pel o
nmero de el ementos do Bl oco. Param1
N1, Param2 N2, Param3 N3 e Param4
N4
3: Erro de escri ta de um Bl oco (Bl oco de
Comuni cao). Size determi nado pel o
nmero de el ementos do Bl oco. Param1
N1, Param2 N2, Param3 N3 e Param4
N4
Size
Quanti dade de val ores sendo escri tos ou
l i dos.
Element
ndi ce do el emento que estava sendo l i do
ou escri to, dentro do Bl oco.
N1
Parmetro 1 da operao de l ei tura ou
escri ta que gerou o erro.
N2
N3
N4
Exempl o:
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
End Sub
5.5.1.1.6 OnCommErrorEx
OnCommErrorEx(ErrorInfo)
Ocorre l ogo aps a execuo do mtodo OnCommError.
Informaes do parmetro ErrorInfo
NOME DESCRIO
ErrorInfo.EvtType
I ndi ca o ti po de operao que causou o
erro:
0: l ei tura de Tag
1: escri ta em Tag
2: l ei tura de Bl oco
3: escri ta em Bl oco
ErrorInfo.Size
Tamanho do Bl oco que ocasi onou o erro
(se for um Tag, o Size 1).
ErrorInfo.Element
ndi ce do El emento de Bl oco que causou o
erro.
ErrorInfo.Nx
Parmetros Nx ou Bx (x = 1, 2, 3 ou 4) da
operao que causou o erro.
ErrorInfo.ParamDevice
Parmetro ParamDevice (String) da operao
que causou o erro.
ErrorInfo.ParamItem
Parmetro ParamItem (String) da operao
que causou o erro.
5.5.1.1.7 OnTagRead
OnTagRead(Tag)
Ocorre na l ei tura de um Tag, sempre que um novo val or ou um erro for retornado
pel o Dri ver de Comuni cao. Ou seja, se o val or ou a qual i dade do Tag no
mudarem, o evento no ser di sparado. Para que o evento funci one, a propri edade
EnableDriverEvent deve obri gatori amente estar habi l i tada. Al m di sso, a
propri edade PercentDeadband tambm pode exercer i nfl unci a sobre a ocorrnci a
do evento, caso a propri edade EnableDeadband esteja habi l i tada. Exempl o:
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
5.5.1.1.8 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escri ta for di sparada em qual quer Tag do Dri ver.
Variveis do evento OnTagWrite
NOME DESCRIO
Tag
Uma refernci a para o objeto do Tag que
est sofrendo a escri ta. Por exempl o,
pode-se acessar a propri edade do Tag
com a si ntaxe Tag.DocString.
Succeeded
Um val or Bool eano que i ndi ca o sucesso
da escri ta (True = sucesso, Fal se = fal ha).
User
Parmetro que recebe o usuri o que fez
a escri ta. O val or padro deste
parmetro "System". Se no houver
nenhum usuri o l ogado no Vi ewer que
gerou o evento, este parmetro contm o
val or "Anonymous".
5.5.1.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Dri ver de
Comuni cao.
5.5.1.2.1 Write
Write(N1, N2, N3, N4, Value[, WriteSyncMode])
Executa a escri ta de um dado no equi pamento. Este mtodo retorna um Bool eano
que i ndi ca o sucesso ou no da operao.
Os parmetros N1 a N4 correspondem aos parmetros N do Dri ver. O parmetro
Value defi ne o val or a ser escri to no Dri ver. O parmetro WriteSyncMode permi te
uti l i zar um modo de escri ta di ferente do uti l i zado pel o Dri ver. As opes
di sponvei s para este parmetro so:
0: Usa o modo de escri ta confi gurado no Dri ver (padro)
1: Executa uma escri ta sncrona
2: Executa uma escri ta assncrona (sem confi rmao)
Se o parmetro WriteSyncMode for omi ti do, ser tambm uti l i zado o modo de
escri ta confi gurado no Dri ver. Para mai ores detal hes sobre estes parmetros,
consul te a documentao do Dri ver.
5.5.1.2.2 WriteEx
WriteEx(N1, N2, N3, N4, Value[, Timestamp[, Quality[, WriteStatus[,
WriteSyncMode]]]])
Faz a escri ta de um dado no equi pamento. Este mtodo retorna um Bool eano que
i ndi ca o sucesso ou no da operao.
Os parmetros N1 a N4 correspondem aos parmetros N do Dri ver. O parmetro
Value defi ne o val or a ser escri to no Dri ver. Para mai ores detal hes sobre estes
parmetros, consul te a documentao do Dri ver.
Os parmetros Timestamp, Quality e WriteStatus so opci onai s. Se omi ti dos, o
comportamento do mtodo o mesmo do mtodo Write. Timestamp especi fi ca a
data e hora a ser escri ta no Tag (se suportada pel o equi pamento). Se omi ti do,
assumi da a data e hora do momento da operao de escri ta. Quality i ndi ca a
qual i dade (de 0 a 255). Se omi ti do, assumi da a qual i dade Boa (192). WriteStatus
recebe um val or retornado pel o Dri ver, que i ndi ca o status da escri ta (se suportado
pel o Dri ver, de acordo com sua documentao prpri a). O parmetro
WriteSyncMode permi te uti l i zar o modo de escri ta di ferente do uti l i zado no Dri ver.
As opes di sponvei s para este parmetro so:
0: usa o modo de escri ta confi gurado no Dri ver
1: executa uma escri ta sncrona
2: executa uma escri ta assncrona (sem confi rmao)
Se o parmetro for omi ti do, ser tambm uti l i zado o modo de escri ta confi gurado
no Dri ver. Exempl o:
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
Esta seo contm i nformaes sobre as propri edades do objeto Dri ver de
Comuni cao.
5.5.1.3.1 DisableIOServerPool
Fora o Dri ver a no parti ci par do Pool de processos do IOServer, ou seja, o
Dri ver i r rodar em um IOServer excl usi vo. O val or padro desta propri edade
Fal so.
NOTA: Para mai s i nformaes, consul te o tpi co Pool de Processos IOServer, no Manual
do Usurio.
5.5.1.3.2 DriverLocation
Defi ne qual ser o dri ver uti l i zado pel o objeto Dri ver de Comuni cao para
efetuar a comuni cao com o equi pamento ou di sposi ti vo. Esta propri edade acei ta
uma String com o cami nho compl eto do dri ver, caso el e no esteja no mesmo
di retri o do Domni o, ou o cami nho rel ati vo se el e esti ver no mesmo di retri o do
Domni o. Caso no haja um Domni o aberto no Studi o, o cami nho rel ati vo ser
consi derado a parti r da pasta onde se encontra o projeto ou bi bl i oteca contendo o
objeto Dri ver de Comuni cao. Aps i sso, a propri edade DriverName mudar para
a descri o do dri ver. Esta propri edade no pode ser modi fi cada aps i ni ci ada a
comuni cao. O val or padro desta propri edade uma String vazi a.
NOTA: Aconsel ha-se uti l i zar sempre a opo Procurar DLL, no menu contextual do
objeto Dri ver de Comuni cao, para confi gurar corretamente esta propri edade.
5.5.1.3.3 DriverName
A propri edade DriverName contm uma String que descreve o dri ver associ ado
ao objeto Dri ver de Comuni cao. Para i sso, deve-se antes confi gurar a
propri edade DriverLocation. Esta propri edade somente de l ei tura e no est
di sponvel em tempo de execuo.
5.5.1.3.4 EnableReadGrouping
Permi te oti mi zaes de l ei tura (agrupamento automti co de Tags). Esta
propri edade no pode ser al terada em tempo de execuo. Seu val or padro True.
A oti mi zao de l ei tura s acontecer se o Dri ver suportar este recurso.
5.5.1.3.5 P1
Uti l i ze a propri edade P1 para confi gurar o dri ver. Consul te a documentao do
dri ver para sua correta parametri zao. Esta propri edade no pode ser modi fi cada
aps i ni ci ada a comuni cao. Exempl o:
' 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.6 P2
aps i ni ci ada a comuni cao. O val or padro desta propri edade 0. Exempl o:
P1 = 2
P2 = 1
P3 = 9600
End Sub
5.5.1.3.7 P3
P1 = 2
P2 = 1
P3 = 9600
End Sub
5.5.1.3.8 P4
P1 = 2
P2 = 1
P3 = 9600
P4 = 500
End Sub
5.5.1.3.9 ParamDevice
Defi ne o endereo do equi pamento acessado pel o dri ver. Esta propri edade
herdada pel os Tags fi l hos do dri ver, que podem sobrescrever este val or, se
necessri o.
5.5.1.3.10 ReadRetries
Indi ca o nmero de re-tentati vas de l ei tura do dri ver em caso de erro. Se for
confi gurada para 2, por exempl o, i ndi ca que o dri ver vai tentar duas vezes mai s
uma comuni cao fal hada, sem contar a tentati va ori gi nal .
5.5.1.3.11 ShareMaximum
A propri edade ShareMaximum defi ne o nmero mxi mo de Dri vers de
Comuni cao que sero agrupados em um I/O Server comparti l hado. Esta
propri edade s uti l i zada se a propri edade ShareServer esti ver habi l i tada.
Exempl o:
' 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 propri edade ShareServer esti ver confi gurada para True, i sto si gni fi ca que
este dri ver i r comparti l har sua execuo entre os demai s objetos Dri ver de
Comuni cao que possuam a mesma String em DriverLocation. Isto i mpl i ca que
somente o pri mei ro Dri ver de Comuni cao confi gurado executar a i ni ci al i zao
da comuni cao. Todos os demai s objetos Dri ver de Comuni cao comparti l hados
i gnoraro todos os parmetros de confi gurao P1 at P4, e tambm outras
confi guraes. Do contrri o, se a propri edade esti ver confi gurada para Fal se, o
dri ver no comparti l har qual quer ti po de comuni cao com outros objetos Dri ver
de Comuni cao. Esta propri edade no pode ser modi fi cada aps i ni ci ada a
comuni cao. O val or padro desta propri edade Fal se.
5.5.1.3.13 WriteFeedbackMode
Esta propri edade permi te control ar a confi rmao (ou feedback) das escri tas em
Tags. apl i cvel somente a Tags que possam ser l i dos, ou seja, possuam a
propri edade AllowRead em True. Atravs desta propri edade, possvel tornar mai s
i medi ata a l ei tura de Tags que recebem escri tas. Esta propri edade possui as
segui ntes opes de confi gurao:
Opes disponveis para WriteFeedbackMode
OPO DESCRIO
0 - wfWaitNextRead
A l ei tura do Tag ser fei ta normal mente
no prxi mo scan.
1 - wfImmediateReadAfterWrite
Aps cada escri ta, uma l ei tura de
confi rmao ser fei ta o mai s cedo
possvel .
2 - wfTrustWriteSuccess
Se o dri ver i ndi car sucesso na escri ta, o
val or escri to assumi do di retamente
pel o Tag, sem l -l o do PLC.
O val or padro desta propri edade 1 - wfImmediateReadAfterWrite. Apl i caes
anteri ores exi stnci a desta propri edade assumem o val or 0 - wfWaitNextRead
quando carregadas. Exempl o:
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: Quando for usado o modo 2 - wfTrustWriteSuccess, o timestamp e a qual i dade
podem fi car errados, j que em uma escri ta bem sucedi da, o val or assumi do pel o
Tag sem buscar o timestamp e a qual i dade no PLC. Al m di sso, o prpri o val or
assumi do pode ter um pequeno desvi o devi do a qual quer ti po de arredondamento
que possa ocorrer no dri ver ou no PLC. Deve ser l evado em conta ai nda que al guns
dri vers ou protocol os podem i ndi car sucesso, mesmo quando a escri ta fal hou. Por
tudo i sso, os outros modos (1 - wfImmediateReadAfterWrite ou 0 - wfWaitNextRead)
devem ser preferi dos sempre que possvel .
5.5.1.3.14 WriteRetries
Indi ca o nmero de re-tentati vas de escri ta do dri ver em caso de erro. Se for i gual
a 2, i ndi ca que o dri ver vai tentar duas vezes mai s uma comuni cao fal hada, sem
contar a tentati va ori gi nal .
5.5.1.3.15 WriteSyncMode
Determi na como as escri tas sero envi adas para o I/O Server (modo sncrono
ou assncrono). Esta propri edade possui as segui ntes opes de confi gurao:
Opes disponveis para WriteSyncMode
OPO DESCRIO
0 - wsmDefault
Modo sncrono (padro).
1 - wsmSync
Modo sncrono. Sempre que um val or
escri to em al gum Tag, o E3Run envi a a
escri ta para o I /O Server e aguarda o
retorno da escri ta.
2 - wsmAsyncUnconfirmed
Modo assncrono sem confi rmao.
Todas as escri tas so envi adas para o I /
O Server sem aguardar o retorno, e
assume-se sempre que a escri ta
funci onou. Quando em modo assncrono,
os mtodos de escri ta dos Tags (Write,
WriteEx) sempre retornam True
i medi atamente, e o status da escri ta
(nos mtodos que retornam este status)
fi ca sempre vazi o (Empty). O evento
OnTagWrite do dri ver executado assi m
que a escri ta envi ada para o I /O Server,
e o parmetro Succeeded fi ca sempre em
True.
As escri tas assncronas sero executadas pel o I/O Server assi m que o dri ver fi car
di sponvel (quando a l ei tura atual termi nar). Se vri as escri tas assncronas forem
envi adas para o I/O Server, o dri ver s retomar as l ei turas depoi s que todas as
escri tas assncronas forem executadas.
5.5.1.4 Bloco de Comunicao
Bl oco de Comuni cao.
5.5.1.4.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Bl oco de Comuni cao.
5.5.1.4.1.1 OnRead
OnRead()
Ocorre quando uma l ei tura do Bl oco de Comuni cao efetuada pel o dri ver. Uti l i ze
o evento OnRead quando for necessri o efetuar al guma operao l ogo aps al gum
dado ter si do modi fi cado no objeto Bl oco de Comuni cao, como por exempl o as
propri edades Quality, TimeStamp ou ai nda a propri edade Value de al gum El emento
do Bl oco. Exempl o:
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 i nformaes sobre os mtodos do objeto Bl oco de Comuni cao.
5.5.1.4.2.1 Write
Write([WriteSyncMode])
Executa a escri ta do val or corrente do Bl oco de Comuni cao no equi pamento.
Normal mente, este comando de scri pt s usado quando a propri edade
AllowWrite deste objeto for Fal se.
O parmetro WriteSyncMode permi te uti l i zar o modo de escri ta di ferente do
uti l i zado no dri ver. As opes di sponvei s para este parmetro so:
0: usa o modo de escri ta confi gurado no dri ver
no dri ver. Para mai ores detal hes, consul te a documentao do dri ver. Este mtodo
retorna um Bool eano que i ndi ca o sucesso ou no da operao.
5.5.1.4.2.2 WriteEx
WriteEx([Value[, Timestamp[, Quality[, WriteStatus[, WriteSyncMode]]]]])
Executa a escri ta de um val or no equi pamento. Todos os seus parmetros so
opci onai s; se omi ti dos, o comportamento do mtodo i gual ao do mtodo Write.
Este mtodo retorna um Bool eano que i ndi ca o sucesso ou no da operao.
O parmetro Value defi ne o val or a ser escri to no dri ver. O ti po de dado depende do
dri ver; se omi ti do, assumi do o val or corrente do Tag. Timestamp especi fi ca a data
e hora a ser escri ta no Tag (se suportada pel o equi pamento). Se omi ti do,
recebe um val or retornado pel o dri ver, que i ndi ca o status da escri ta (se suportado
pel o dri ver, de acordo com sua documentao prpri a).
1: faz uma escri ta sncrona
2: faz uma escri ta assncrona (sem confi rmao)
no dri ver. Exempl o:
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
Esta seo contm i nformaes sobre as propri edades do objeto Bl oco de
Comuni cao.
5.5.1.4.3.1 AdviseType
Control a o modo Advise. As opes di sponvei s so:
Opes disponveis para AdviseType
OPO DESCRIO
0 - AlwaysInAdvise
O Tag manti do atual i zado se a
propri edade AllowRead for True.
1 - AdviseWhenLinked
O Tag s atual i zado se AllowRead for
True e o Tag esti ver associ ado a al gum
objeto ati vo, por exempl o, um Di spl ay de
uma Tel a aberta, um Al arme habi l i tado,
entre outros. A associ ao do Tag para
esse propsi to pode ser fei ta nas
segui ntes propri edades: Value, RawValue,
Quality e de Bit00 a Bit31 de El ementos de
Bl oco, e Quality e TimeStamp de Bl ocos de
Comuni cao.
5.5.1.4.3.2 AllowRead
Defi ne se este Bl oco dever ou no ser l i do pel o Dri ver de Comuni cao. Caso a
propri edade AllowRead esteja habi l i tada, ento o Dri ver automati camente
atual i zar os El ementos de comuni cao i nseri dos neste Bl oco, em i nterval os de
tempo defi ni dos pel a propri edade Scan. Caso contrri o, este Bl oco de Comuni cao
no ser l i do ou atual i zado. Esta propri edade pode ser modi fi cada em tempo de
execuo. O val or padro desta propri edade True. Exempl o:
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
Defi ne se este Bl oco dever ou no ser escri to quando for modi fi cada a
propri edade Value de seus El ementos do Bl oco de Comuni cao. Se esta
propri edade esti ver confi gurada para True, as modi fi caes sero envi adas para o
equi pamento ou di sposi ti vo associ ado ao Dri ver de Comuni cao. Caso contrri o
as modi fi caes sero i gnoradas. Os El ementos de comuni cao no acei taro
val ores, caso esta propri edade esteja confi gurada para Fal se, a no ser que a
propri edade AllowRead tambm esteja confi gurada para Fal se. Exempl o:
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
Especi fi ca a qual conjunto de dados no equi pamento ou no di sposi ti vo este Tag
estar associ ado. Consul te a documentao do dri ver para sua correta
parametri zao. Esta propri edade pode ser modi fi cada aps i ni ci ada a
comuni cao. Exempl o:
Sub Bloco1_BeforeStart()
B1 = 2
B2 = 1
B3 = 9600
End Sub
5.5.1.4.3.5 B2
B1 = 2
B2 = 1
B3 = 9600
End Sub
5.5.1.4.3.6 B3
B1 = 2
B2 = 1
B3 = 9600
End Sub
5.5.1.4.3.7 B4
B1 = 2
B2 = 1
B3 = 9600
B4 = 524
End Sub
5.5.1.4.3.8 EnableDeadBand
A propri edade EnableDeadBand habi l i ta ou desabi l i ta a propri edade
PercentDeadBand dos El ementos do Bl oco. Se esta propri edade esti ver confi gurada
para True, o val or do Bl oco atual i zado somente se este mudar e o novo val or
exceder o l i mi te defi ni do pel a propri edade PercentDeadBand de qual quer um dos
El ementos do Bl oco. Caso contrri o, o Bl oco sempre atual i zado e o l i mi te de
banda morta no veri fi cado. Sempre que possvel , recomendado manter a banda
morta habi l i tada, poi s el a mel hora a performance da aqui si o e do
processamento de dados. Normal mente, a banda morta ser desabi l i tada apenas
para os Tags que retornem val ores representando eventos que preci sam ser
tratados no evento OnRead do Tag. O val or padro desta propri edade True.
NOTAS:
Caso haja mai s de um El emento de Bl oco mapeado para o mesmo ndi ce, a
confi gurao de banda morta uti l i zada ser aquel a que resul te no menor val or
absol uto de banda morta.
Se al gum ndi ce do Bl oco possui r um El emento no mapeado, a banda morta
neste ndi ce ser i gual a 0, ou seja, qual quer vari ao no val or do El emento vi ol a
a banda morta.
Se a propri edade EnableDeadBand esti ver habi l i tada, o l ti mo val or envi ado ao
Bl oco comparado com o val or l i do no momento, El emento por El emento. Se
qual quer um dos El ementos do Bl oco vi ol ar sua banda morta, o Bl oco i ntei ro
ser atual i zado.
5.5.1.4.3.9 EnableDriverEvent
Esta propri edade uti l i zada para control ar a gerao do evento OnTagRead, que
ocorre no Dri ver de Comuni cao que contm o Bl oco. Se a propri edade
EnableDriverEvent do Tag esti ver confi gurada para True, ser habi l i tada a gerao
do evento OnTagRead por este Tag. Caso contrri o, no ocorre. Os trs ti pos de
El ementos de Comuni cao (Tag de Comuni cao, Bl oco de Comuni cao e
El emento de Bl oco) podem gerar este evento. O evento ocorre no dri ver e no no
Bl oco.
5.5.1.4.3.10 ParamDevice
Defi ne o endereo do equi pamento acessado pel o Bl oco. Esta propri edade
herdada do Dri ver, mas seu val or pode ser sobrescri to, se necessri o.
5.5.1.4.3.11 ParamItem
Identi fi ca o dado que o Bl oco acessa dentro de um equi pamento.
5.5.1.4.3.12 Quality
A propri edade Quality i nforma qual a qual i dade do val or conti do na propri edade
Value. Cada vez que o Dri ver atri bui um novo val or para o Bl oco, el e tambm
confi gura a qual i dade daquel e dado. Esta propri edade somente para l ei tura. O
val or padro desta propri edade 0 (Qual i dade Rui m).
NOTA: Para mai ores i nformaes sobre qual i dade, consul te o tpi co Qualidade no
Manual do Usurio do E3.
5.5.1.4.3.13 Scan
Especi fi ca qual tempo de varredura ser uti l i zado pel o servi dor para atual i zar o
Bl oco. Esta propri edade representada em mi l i ssegundos e pode ser modi fi cada
aps i ni ci ada a comuni cao, sendo uti l i zada apenas quando a propri edade
AllowRead esti ver habi l i tada. Ao confi gurar esta propri edade nos di versos Bl ocos
presentes na apl i cao, recomenda-se aumentar o val or da propri edade Scan para
aquel es Bl ocos que no vari am mui to no equi pamento ou no di sposi ti vo,
possi bi l i tando assi m que outros Bl ocos de mai or pri ori dade sejam l i dos com
mai or frequnci a, aumentando assi m a performance geral do si stema. O val or
padro desta propri edade 1000 (1 segundo). O val or do scan deve ser mai or que
zero. Exempl o:
Sub Bloco de comunicacao1_BeforeStart()
Scan = 152
End Sub
5.5.1.4.3.14 Size
Defi ne o tamanho do conjunto de val ores deste Bl oco. Consul te a documentao
do dri ver uti l i zado para conhecer qual o l i mi te para esta propri edade, de acordo
com os parmetros B1 at B4. Cri ando os El ementos de Bl oco, possi bi l i ta-se o
acesso aos val ores l i dos e tambm permi te a escri ta de val ores para o
equi pamento ou di sposi ti vo. Esta propri edade no pode ser modi fi cada aps a
comuni cao ser i ni ci ada. O val or padro desta propri edade 0. Exempl o:
Sub Bloco de comunicacao1_BeforeStart()
Size = 10
End Sub
5.5.1.4.3.15 TimeStamp
A propri edade TimeStamp atual i zada sempre que ocorrer al guma mudana de
val or ou de estado nas propri edades Value ou Quality. El e i nforma qual a data e
hora associ ada tanto ao val or quanto qual i dade do Bl oco de Comuni cao. Esta
uma propri edade somente para l ei tura. O val or padro desta propri edade
00:00:00.
5.5.1.4.4 Elemento de Bloco de Comunicao
Esta seo contm i nformaes sobre mtodos e propriedades do objeto El emento
de Bl oco de Comuni cao. Este objeto no possui eventos associ ados.
5.5.1.4.4.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto El emento de Bl oco de
Comuni cao.
Write
Executa a escri ta do val or corrente do El emento de Bl oco no equi pamento.
WriteEx
pel o dri ver, de acordo com sua documentao prpri a). O parmetro
WriteSyncMode permi te uti l i zar o modo de escri ta di ferente do uti l i zado no dri ver.
Sub Tag1_OnRead()
End Sub
Esta seo contm i nformaes sobre as propri edades do objeto El emento de Bl oco
de Comuni cao.
Bit00 at Bit31
As propri edades de bi t Bit00 at Bit31 representam juntas os 32 bi ts do val or
presente na propri edade Value do El emento de Bl oco, sendo Bit00 o bi t menos
si gni fi cati vo e Bit31 o bi t mai s si gni fi cati vo. Modi fi car cada um destes bi ts i mpl i ca
na i gual modi fi cao da propri edade Value do El emento, e vi ce-versa, mas i sto
somente ocorre quando a propri edade UseBitFields esti ver confi gurada para True.
O val or padro destas propri edades Fal se.
DeviceHigh
A propri edade DeviceHigh defi ne o val or mxi mo ati ngi do pel o El emento de Bl oco
no equi pamento ou no di sposi ti vo. Esta propri edade uti l i zada no cl cul o do val or
da propri edade PercentDeadBand, e tambm para fazer o ajuste de escal a do val or
proveni ente do equi pamento ou do di sposi ti vo antes de ser atri budo
propri edade Value. Da mesma forma, no momento da escri ta fei ta a operao
i nversa antes de envi ar o val or para o Dri ver. Esta converso s ocorre quando a
propri edade EnableScaling est confi gurada para True. O val or padro desta
propri edade 1000.
NOTA: Os val ores dos bi ts (as propri edades Bit00 at Bit31) no so afetados pel o
ajuste na escal a, ou seja, representam os bi ts dos val ores l i dos pel o equi pamento
antes da converso.
DeviceLow
A propri edade DeviceLow defi ne qual o val or mni mo ati ngi do por este El emento
no equi pamento ou no di sposi ti vo. Esta propri edade uti l i zada no cl cul o do val or
da propri edade PercentDeadBand, e tambm para fazer o ajuste de escal a do val or
proveni ente do equi pamento ou do di sposi ti vo antes de ser atri budo
propri edade Value. Da mesma forma, no momento da escri ta, fei ta a operao
i nversa antes de envi ar o val or para o Dri ver. Esta converso s ocorre quando a
propri edade 0.
NOTA: Os val ores dos bi ts (as propri edades Bit00 at Bit31) no so afetados pel o
ajuste na escal a, ou seja, representam os bi ts dos val ores l i dos pel o equi pamento
antes da converso.
EnableDriverEvent
Bl oco.
EnableScaling
A propri edade EnableScaling habi l i ta ou desabi l i ta a escal a de val or para o val or
envi ado e recebi do do equi pamento ou do di sposi ti vo. Se esta propri edade esti ver
confi gurada para True, todo val or proveni ente do equi pamento ou do di sposi ti vo
sofrer ajuste de escal a conforme as propri edades DeviceHigh, DeviceLow, EUHigh
e EULow antes de ser atri budo propri edade Value. Caso contrri o, nenhum ajuste
de escal a ser efetuado em nenhum dos doi s senti dos (escri ta e l ei tura). O val or
padro desta propri edade Fal se. Exempl o:
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 propri edade uti l i zada para i denti fi car qual uni dade de engenhari a seu
val or representa, como por exempl o: graus, metros, KW/h, etc. Exempl o:
Sub ElementodeBloco1_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EUHigh
Defi ne qual o val or mxi mo que dever ser atri budo propri edade Value,
ajustando a escal a ao val or do equi pamento ou do di sposi ti vo antes desta
atri bui o. Da mesma forma, no momento da escri ta fei ta a operao i nversa
antes de envi ar o val or para o dri ver. Esta converso s ocorre quando a
propri edade 1000. Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EULow
Defi ne qual o val or mni mo que dever ser atri budo propri edade Value,
atri bui o. Da mesma forma, no momento da escri ta, fei ta a operao i nversa
DeviceHigh = 255
DeviceLow = 0
EULow = 100
EULow = 0
End Sub
Index
Especi fi ca a posi o que o El emento de Bl oco ocupa entre os el ementos
confi gurados pel a propri edade Size do Bl oco de Comuni cao no qual el e est
i nseri do. Esta propri edade acei ta val ores de 0 at um nmero menor do que a val or
defi ni do em Size. Por exempl o: confi gurando um Bl oco de Comuni cao para ter
Size i gual a 20, o nmero mxi mo vl i do para a propri edade Index ser 19 e o
mni mo ser 0. Esta propri edade pode ser al terada aps i ni ci ada a comuni cao. O
val or padro desta propri edade 0, porm ao mapear os El ementos de um Bl oco o
Studi o automati camente ajusta o parmetro Index para um val or de acordo com o
especi fi cado. Exempl o:
Index = 15
End Sub
PercentDeadBand
A propri edade PercentDeadBand determi na a vari ao mni ma do val or (banda
morta) de um El emento de Bl oco, para que seu val or no E3 seja atual i zado. Este
val or especi fi cado como um percentual da di ferena entre as propri edades
DeviceHigh e DeviceLow. Esta propri edade s ser uti l i zada caso a propri edade
EnableDeadBand do Bl oco esteja confi gurada para True. Se a propri edade
PercentDeadBand for i gual a 0, o El emento de Bl oco no ter banda morta, e
qual quer vari ao no seu val or ser repassada para o E3. Caso contrri o, s ser
envi ado para o E3 um novo val or cuja di ferena, em rel ao ao val or atual no E3,
seja mai or que a banda morta. O val or padro desta propri edade 0 (zero).
Quality
Value. Cada vez que o Dri ver atri bui um novo val or para o El emento, el e tambm
RawValue
Acessa o val or ori gi nal do El emento anteri or escal a, ou seja, i ndependente da
confi gurao da propri edade EnableScaling. Ento, se esta propri edade for Fal se, as
propri edades Value e RawValue apresentam o mesmo comportamento.
UseBitFields
Se esta propri edade esti ver confi gurada para True, toda vez que o val or da
propri edade Value for modi fi cada, el e atual i zar os bi ts referentes s
propri edades Bit00 at Bit31. Da mesma forma, atual i zar o val or de Value toda vez
que al guma das propri edades Bit00 at Bit31 mudar de val or e posteri ormente
envi ar para o equi pamento ou para o di sposi ti vo se a propri edade AllowWrite do
Bl oco de Comuni cao esti ver confi gurada para True. Caso contrri o, os bi ts no
sofrero nem acarretaro qual quer mudana. Esta propri edade pode ser
atual i zada aps ter si do i ni ci ada a comuni cao. O val or padro desta
Value
Atual i zada sempre que uma nova l ei tura vl i da de um val or do equi pamento ou
do di sposi ti vo for fei ta, uti l i zando-se a parametri zao B1 at B4 do Bl oco de
Comuni cao onde este El emento esti ver i nseri do, e consi derando-se sua posi o
na tabel a l i da atravs da propri edade Index. O ti po desta vari vel (nmero i ntei ro,
ponto fl utuante, texto) depende do dri ver ao qual o El emento est associ ado e da
sua parametri zao.
Esta propri edade somente ser atual i zada desta forma se a propri edade AllowRead
do objeto Bl oco de Comuni cao ao qual o El emento pertence esti ver confi gurada
para True, e quando no houver erros de comuni cao (neste caso somente as
propri edades Quality e TimeStamp sero atual i zadas), de acordo com o tempo de
varredura defi ni do em Scan. Outra forma de uti l i zar esta propri edade para
escrever val ores no equi pamento ou no di sposi ti vo, bastando para i sto atri bui r um
novo val or propri edade Value ou a al gum dos bi ts Bit00 a Bit31. Neste caso, a
propri edade AllowWrite do objeto Bl oco de Comuni cao deve estar confi gurada
para True.
Esta tambm a propri edade padro do objeto El emento de Bl oco. Sendo assi m,
uma refernci a por val or a um El emento de Bl oco no necessi ta obri gatori amente
expl i ci tar a propri edade Value para acessar o val or. Caso esta propri edade no
esteja sendo atual i zada, veri fi que se a propri edade Index est corretamente
confi gurada. O val or padro desta propri edade vazi o (sem val or). Exempl o:
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 i nformaes sobre as propriedades do objeto Pasta do Dri ver de
Comuni cao. Este objeto no possui eventos nem mtodos associ ados.
Esta seo contm i nformaes sobre as propri edades do objeto Pasta do Dri ver de
Comuni cao.
Defi ne o endereo do equi pamento acessado pel a Pasta. Esta propri edade
herdada do Dri ver, e seu val or pode ser sobrescri to, se necessri o.
5.5.1.6 Tag de Comunicao
Tag de Comuni cao.
5.5.1.6.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Tag de Comuni cao.
5.5.1.6.1.1 OnRead
OnRead()
Ocorre quando efetuada uma l ei tura do Tag pel o dri ver. Uti l i ze o evento OnRead
quando for necessri o efetuar al guma operao l ogo aps al gum dado ser
modi fi cado no Tag, como por exempl o, as propri edades Value, Quality ou
TimeStamp. Este evento gerado por uma l ei tura em background. Exempl o:
Sub CommTag1_OnRead()
' 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 i nformaes sobre os mtodos do objeto Tag de Comuni cao.
5.5.1.6.2.1 Write
Executa a escri ta do val or corrente do Tag de Comuni cao no equi pamento.
5.5.1.6.2.2 WriteEx
pel o dri ver, de acordo com sua documentao prpri a). O parmetro
WriteSyncMode permi te uti l i zar o modo de escri ta di ferente do uti l i zado no dri ver.
Sub Tag1_OnRead()
End Sub
Esta seo contm i nformaes sobre as propri edades do objeto Tag de
Comuni cao.
5.5.1.6.3.1 AdviseType
Opes disponveis para a propriedade AdviseType
OPO DESCRIO
0 - AlwaysInAdvise
propri edade AllowRead for True.
O Tag s atual i zado se AllowRead for
True e o Tag esti ver associ ado a al gum
objeto ati vo, por exempl o, um Di spl ay de
uma Tel a aberta, um Al arme habi l i tado,
entre outros. A associ ao do Tag para
esse propsi to pode ser fei ta nas
segui ntes propri edades: Value, RawValue,
TimeStamp, Quality e Bit00 at Bit31 do
Tag de Comuni cao.
Exempl o:
MsgBox Application._
Application.GetObject("Driver1.Tag1").AdviseType
End Sub
5.5.1.6.3.2 AllowRead
Confi gure esta propri edade para defi ni r se este Tag dever ou no ser l i do pel o
Dri ver de Comuni cao. Se esta propri edade esti ver confi gurada para True, o dri ver
automati camente atual i zar as propri edades Value e Bits (de Bit00 at Bit31) deste
objeto em i nterval os de tempo defi ni dos pel a propri edade Scan. Caso contrri o,
este Tag de Comuni cao no ser l i do. Esta propri edade pode ser modi fi cada em
tempo de execuo. O val or padro desta propri edade True. Exempl o:
Sub Botao1_Click()
' Faz com que seja parada a leitura do tag
Set obj = Application.GetObject("Driver1.tag")
End Sub
5.5.1.6.3.3 AllowWrite
Confi gure esta propri edade para defi ni r se este Tag dever ou no ser escri to
automati camente quando for modi fi cada a propri edade Value ou qual quer
propri edade Bit (de Bit00 at Bit31). Se esta propri edade esti ver confi gurada para
True, as modi fi caes sero envi adas para o equi pamento ou di sposi ti vo
associ ado ao Dri ver de Comuni cao. Caso contrri o, as modi fi caes sero
i gnoradas. O val or padro desta propri edade True. Exempl o:
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do tag
End Sub
5.5.1.6.3.4 Bit00 at Bit31
presente na propri edade Value do objeto Tag de Comuni cao, sendo Bit00 o bi t
menos si gni fi cati vo e Bit31 o bi t mai s si gni fi cati vo. Modi fi car cada um destes bi ts
i mpl i ca na i gual modi fi cao da propri edade Value do Tag, e vi ce-versa, mas i sto
somente ocorre quando a propri edade UseBitFields esti ver confi gurada para True.
O val or padro destas propri edades Fal se.
5.5.1.6.3.5 DeviceHigh
A propri edade DeviceHigh defi ne qual o val or mxi mo ati ngi do pel o Tag no
equi pamento ou di sposi ti vo. Esta propri edade ser uti l i zada para fazer o ajuste de
escal a do val or proveni ente do equi pamento ou di sposi ti vo antes de ser atri budo
propri edade Value. Da mesma forma, no momento da escri ta fei ta a operao
i nversa antes de envi ar o val or para o dri ver. Esta converso s ocorre quando a
Sub Tag_OnStartRunning()
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os val ores dos bi ts (Propri edades Bit00 at Bit31) no so afetados pel o
ajuste de escal a. I sto , representam os bi ts do val or l i do do equi pamento, antes
da converso.
5.5.1.6.3.6 DeviceLow
A propri edade DeviceLow defi ne o val or mni mo ati ngi do por este Tag no
equi pamento ou no di sposi ti vo. Esta propri edade ser uti l i zada para fazer o ajuste
de escal a do val or proveni ente do equi pamento ou do di sposi ti vo antes de ser
atri budo propri edade Value. Da mesma forma, no momento da escri ta fei ta a
operao i nversa antes de envi ar o val or para o dri ver. Esta converso s ocorre
quando a propri edade EnableScaling est confi gurada para True. Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
ajuste de escal a, i sto , representam os bi ts do val or l i do do equi pamento, antes
da converso.
5.5.1.6.3.7 EnableDeadBand
A propri edade EnableDeadBand habi l i ta ou desabi l i ta a propri edade
PercentDeadBand. Se esta propri edade esti ver confi gurada para True, o val or do
Tag atual i zado somente se este mudar e o novo val or exceder o l i mi te defi ni do
pel a propri edade PercentDeadBand. Caso contrri o, o Tag sempre atual i zado e o
l i mi te de deadband (banda morta) no veri fi cado. Sempre mantenha a banda
morta (deadband) habi l i tada, poi s el a mel hora a performance da aqui si o de
dados e processamento. Voc deve desabi l i tar o deadband somente em casos onde
o Dri ver de Comuni cao esti ver retornando eventos de Tags Di gi tai s ou
Anal gi cos, e seja necessri o processar estes eventos vi a scri pt no evento OnRead
do Tag. O val or padro desta propri edade True.
5.5.1.6.3.8 EnableDriverEvent
Bl oco.
5.5.1.6.3.9 EnableScaling
envi ado e recebi do do equi pamento ou do di sposi ti vo. Se esta propri edade esti ver
confi gurada para True, todo val or proveni ente do equi pamento ou do di sposi ti vo
sofrer ajuste de escal a nas propri edades DeviceHigh, DeviceLow, EUHigh e EULow,
antes de ser atri budo propri edade Value. Caso contrri o, nenhum ajuste de
escal a ser efetuado em nenhum dos doi s senti dos (escri ta e l ei tura). Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
5.5.1.6.3.10 EU
Esta propri edade uti l i zada para i denti fi car a uni dade de engenhari a que o
val or representa, como por exempl o, graus, metros, KW/h, etc. Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
5.5.1.6.3.11 EUHigh
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
da converso.
5.5.1.6.3.12 EULow
DeviceHigh = 255
DeviceLow = 0
EULow = 100
End Sub
NOTA: Os val ores dos bi ts (propri edades Bit00 at Bit31) no so afetados pel o
da converso.
5.5.1.6.3.13 N1
Especi fi ca a vari vel do equi pamento ou do di sposi ti vo a que este Tag estar
associ ado. Consul te a documentao do dri ver para sua correta parametri zao.
Esta propri edade pode ser modi fi cada aps i ni ci ada a comuni cao. O val or
N1 = 10
End Sub
5.5.1.6.3.14 N2
N2 = 3
End Sub
5.5.1.6.3.15 N3
N1 = 10
N3 = 5
N4 = 20
End Sub
5.5.1.6.3.16 N4
N1 = 10
N4 = 20
End Sub
Defi ne o endereo do equi pamento acessado pel o Tag. Esta propri edade
herdada do dri ver, mas seu val or pode ser sobrescri to, se necessri o.
5.5.1.6.3.18 ParamItem
Identi fi ca o dado que o Tag acessa dentro de um equi pamento.
5.5.1.6.3.19 PercentDeadBand
A propri edade PercentDeadBand determi na a vari ao mni ma do val or (banda
morta) de um Tag, para que seu val or no E3 seja atual i zado. Este val or
especi fi cado como um percentual da di ferena entre as propri edades DeviceHigh e
DeviceLow. Esta propri edade s ser uti l i zada caso a propri edade EnableDeadBand
do mesmo Tag esteja confi gurada para True. Se a propri edade PercentDeadband for
i gual a 0, o Tag no ter banda morta, e qual quer vari ao no seu val or ser
repassada para o E3. Caso contrri o, s ser envi ado para o E3 um novo val or cuja
di ferena, em rel ao ao val or atual no E3, seja mai or que a banda morta. O val or
padro desta propri edade 0 (zero).
5.5.1.6.3.20 Quality
Value. Cada vez que o Dri ver atri bui um novo val or para o Tag, el e tambm
5.5.1.6.3.21 RawValue
Acessa o val or ori gi nal do Tag anteri or escal a, ou seja, i ndependentemente da
5.5.1.6.3.22 Scan
Uti l i ze a propri edade Scan para especi fi car o tempo de varredura que ser
uti l i zado pel o servi dor para atual i zar a propri edade Value. Esta propri edade
representada em mi l i ssegundos e pode ser modi fi cada aps i ni ci ada a
comuni cao, sendo uti l i zada apenas quando a propri edade AllowRead esti ver
confi gurada para True. Ao confi gurar esta propri edade nos di versos Tags presentes
na apl i cao, recomenda-se aumentar o val or da propri edade Scan para aquel es
Tags que no vari am mui to no equi pamento ou no di sposi ti vo, possi bi l i tando
assi m que outros Tags de mai or pri ori dade sejam l i dos com mai or frequnci a,
aumentando assi m a performance geral do si stema. O val or padro desta
propri edade 1000 (1 segundo). O val or do scan deve ser mai or que 0. Exempl o:
Scan = 1500
End Sub
5.5.1.6.3.23 TimeStamp
val or ou estado nas propri edades Value ou Quality. El e i nforma qual a data e hora
associ ada tanto ao val or quanto qual i dade do Tag de Comuni cao. Esta uma
propri edade somente para l ei tura. O val or padro desta propri edade 00:00:00.
5.5.1.6.3.24 UseBitFields
Caso a propri edade UseBitFields esteja confi gurada para True, toda vez que o
val or da propri edade Value for modi fi cado, el e atual i zar os bi ts referentes s
envi ar para o equi pamento ou para o di sposi ti vo, se a propri edade AllowWrite
esti ver confi gurada para True. Caso contrri o, os bi ts no sofrero nem
acarretaro qual quer mudana. Esta propri edade pode ser atual i zada aps ter si do
i ni ci ada a comuni cao.
ajuste de escal a, i sto , representam os bi ts do val or l i do do equi pamento, antes
da converso.
5.5.1.6.3.25 Value
Atual i zada sempre que uma nova l ei tura vl i da de um val or do equi pamento ou
do di sposi ti vo for fei ta, uti l i zando-se a parametri zao N1 at N4. O ti po desta
vari vel (nmero i ntei ro, ponto fl utuante, texto) depende do dri ver ao qual o Tag
est associ ado e da sua parametri zao.
esti ver confi gurada para True, e quando no houver erros de comuni cao (neste
caso somente as propri edades Quality e TimeStamp sero atual i zadas), de acordo
com o tempo de varredura defi ni do em Scan. Outra forma de uti l i zar esta
propri edade para escrever val ores no equi pamento ou no di sposi ti vo, bastando
para i sto atri bui r um novo val or propri edade Value ou a al gum dos bi ts Bit00 at
Bit31. Neste caso, a propri edade AllowWrite deve estar confi gurada para True.
Esta tambm a propri edade padro do objeto Tag de Comuni cao. Sendo assi m,
uma refernci a por val or a um Tag de Comuni cao no necessi ta
obri gatori amente expl i ci tar a propri edade Value para acessar o val or. O val or
padro desta propri edade vazi o (sem val or). Exempl o:
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")
MsgBox "Valor atual de tag1: " & obj.Value
' sem mostrar a propriedade Value, que o padro
MsgBox "Valor atual de tag1: " & obj
End Sub
da converso.
5.5.2 Driver de Comunicao OPC
Esta seo contm i nformaes sobre os eventos e propriedades do objeto Dri ver
de Comuni cao OPC. Este objeto no possui mtodos associ ados.
5.5.2.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Dri ver de Comuni cao
OPC.
5.5.2.1.1 OnTagRead
OnTagRead(Tag)
Ocorre na l ei tura de um Tag, sempre que um novo val or ou um erro for retornado
pel o Servi dor OPC. Ou seja, se o val or ou a qual i dade do Tag no mudarem, o
evento no ser di sparado. Para que este evento ocorra, a propri edade
EnableDriverEvent do Tag deve obri gatori amente estar habi l i tada.
5.5.2.1.2 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escri ta for di sparada em qual quer Tag do Dri ver. Para que o
evento ocorra, a propri edade EnableDriverEvent do Tag deve obri gatori amente
estar habi l i tada. Se a escri ta for assncrona, o evento OnTagWrite ser gerado
apenas quando o servi dor envi ar a resposta i ndi cando o efeti vo sucesso ou no da
escri ta.
Variveis do evento OnTagWrite
NOME DESCRIO
Tag
Uma refernci a para o objeto Tag que
est sofrendo a escri ta. Por exempl o,
pode-se acessar a propri edade do Tag
usando a si ntaxe Tag.DocString.
Succeeded
Um val or Bool eano que i ndi ca sucesso
ou fal ha na escri ta.
User
Parmetro que recebe o usuri o que fez
a escri ta. O val or padro deste
parmetro "System". Se no houver
nenhum usuri o l ogado no Vi ewer que
gerou o evento, este parmetro contm o
val or "Anonymous". Se a escri ta for
assncrona, ou se ocorreu uma fal ha
reportada de forma assncrona, este
parmetro sempre contm o val or
"System".
Comuni cao OPC.
5.5.2.2.1 Compatibility
Permi te control ar o uso das i nterfaces padro OPC pel o Cl i ente OPC do E3. As
0 - AnyVersion: funci onamento normal (recomendado), o OPC dri ver i r
comuni car com servi dores DA 2.0x e 1.0a (dando prefernci a ao uso de
i nterfaces 2.0x)
1 - Version10A: permi te forar a comuni cao no padro DA 1.0a para
servi dores que suportam DA 2.0x e 1.0a
2 - Version20: permi te forar a comuni cao apenas no padro OPC DA 2.0
Essa propri edade no pode ser modi fi cada quando a comuni cao do cl i ente OPC
esti ver habi l i tada (tanto no Studi o quanto em tempo de execuo).
NOTA: Apenas em l ti mo caso o dri ver deve ser confi gurado com um val or di ferente
de 0 - AnyVersion (val or padro). Esta propri edade de uso avanado, e se apl i ca
restri tamente para contornar al guma si tuao de possvel i ncompati bi l i dade com
al gum servi dor OPC especfi co.
5.5.2.2.2 ReconnectPeriod
Control a o perodo da conexo com o Servi dor OPC. Se a conexo for perdi da, o
dri ver para e rei ni ci a at que esta ao retorne sucesso. O perodo confi gurado
em mi l i ssegundos e quando o val or confi gurado para 0, a reconexo
desabi l i tada. Pel o fato do Dri ver OPC ser parado e i ni ci ado, os eventos BeforeStart
e AfterStop sero gerados. Quando a conexo for perdi da, todos os Tags
rel aci onados sero desconectados do seu estado atual (bad/qual i ty/nul l val ue).
Exempl o:
Sub DriverOPC1_AfterStart()
Application.GetObject("DriverOPC1.GrupoOPC1")._
ReconnectPeriod = 0
End Sub
5.5.2.2.3 ServerId
Determi na o servi dor ao qual o Dri ver OPC deve se conectar. Apesar do val or
padro da propri edade ser vazi o, se o campo esti ver vazi o, o objeto OPC no i r
conectar. Esta propri edade s pode ser modi fi cada quando o Dri ver OPC no est
conectado. Exempl o:
Set Opc = Application.GetObject("DriverOPC1")
Opc.Deactivate
Opc.ServerId = "ElipseSCADA.OPCSvr.1"
Opc.ServerMachine = "\\server2"
Opc.Activate
End Sub
5.5.2.2.4 ServerMachine
A propri edade ServerMachine determi na o endereo da estao onde est
rodando o servi dor OPC. Para apl i caes que esto rodando l ocal mente, esta
propri edade pode fi car em branco (padro). Caso contrri o, ser necessri o
especi fi car o cami nho (por exempl o, \\NomeServi dor). Esta propri edade s pode ser
modi fi cada quando o Dri ver OPC esti ver desconectado. Exempl o:
Set Opc = Application.GetObject("DriverOPC1")
Opc.Deactivate
Opc.ServerId = "ElipseSCADA.OPCSvr.1"
Opc.ServerMachine = "\\server2"
Opc.Activate
End Sub
5.5.2.2.5 ServerName
A propri edade ServerName retorna o nome ou a descri o do servi dor OPC. Esta
propri edade di ferente da propri edade ServerID, que um cdi go. Exempl o:
Sub Driver OPC1_AfterStart()
MsgBox _
Application.GetObject("DriverOPC1.GrupoOPC1").ServerName
End Sub
5.5.2.2.6 ServerStatus
Determi na o estado da conexo com o servi dor OPC. As opes di sponvei s so
as segui ntes:
Opes disponveis para ServerStatus
OPO DESCRIO
-1 - ServerStatus_Unknown
O Dri ver OPC est conectado ao servi dor
OPC mas o estado no i nformado ou o
cl i ente OPC possui a propri edade
ReconnectPeriod em 0.
0 - ServerStatus_NoConnected
O Dri ver OPC no est conectado ao
servi dor OPC. I sso acontece quando, por
exempl o, o Dri ver OPC no est ati vo, ou
a conexo no foi estabel eci da por
al gum probl ema qual quer.
Os val ores a segui r so i nformados apenas quando a propri edade
ReconnectPeriod di ferente de 0. Esta passagem de perodo especi fi cando o estado
buscada no servi dor. Caso o estado no seja i nformado corretamente, a
propri edade pode manter o val or i gual a -1, ou a desconexo pode ser detectada
neste caso, l evando a propri edade ServerStatus para 0. Os val ores so baseados
nos ci nco estados padro defi ni dos para servi dores OPC.
Opes disponveis para ReconnectPeriod diferente de zero
OPO DESCRIO
1 - ServerStatus_Running
O servi dor est rodando normal mente.
2 - ServerStatus_Failed
O servi dor no est rodando. Um erro
no especi fi cado ocorreu no servi dor.
3 - ServerStatus_NoConfig
O servi dor est rodando, porm sem
i nformaes de confi gurao.
4 - ServerStatus_Suspended
O servi dor foi suspenso
temporari amente.
5 - ServerStatus_Test
O servi dor est em modo de teste.
Exempl o:
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: Para obter o comportamento equi val ente a uma propri edade Bool eana, o
recomendado usar ServerStatus di ferente de 0 (zero). I sso basi camente di ferenci a
apenas entre haver a conexo ou no, desconsi derando estados mai s especfi cos
do servi dor. Al m di sso, dessa forma, a expresso i ndepende do uso da
propri edade ReconnectPeriod di ferente de 0 (zero).
5.5.2.2.7 WriteFeedbackMode
Esta propri edade permi te control ar a confi rmao (ou feedback) das escri tas em
Tags. As opes de confi guraco dessa propri edade esto descri tas na tabel a a
segui r.
Opes disponveis para a propriedade WriteFeedbackMode
OPO DESCRIO
0 - wfWaitNextRead
Aps a escri ta, aguarda normal mente a
prxi ma l ei tura.
1 - wfImmediateReadAfterWrite
Fora uma l ei tura assncrona de
di sposi ti vo l ogo aps cada escri ta.
2 - wfTrustWriteSuccess
O val or escri to assumi do pel o Tag
i medi atamente, caso a escri ta tenha
funci onado.
O val or padro dessa propri edade 0 - wfWaitNextRead para apl i cati vos cri ados
antes da i mpl ementao desta propri edade, e 1 - wfImmediateReadAfterWrite
para apl i cati vos cri ados a parti r de sua i mpl ementao.
NOTAS:
A propri edade WriteFeedbackMode do Dri ver OPC no pode ser al terada com o
objeto ati vo.
Na opo 2 - wfTrustWriteSuccess, no caso de escri tas assncronas, o val or
assumi do no Tag aps o agendamento da escri ta, se a operao foi bem
sucedi da. Porm, se a escri ta fal har posteri ormente, o val or no Tag pode fi car
errado. No caso da escri ta sncrona, o val or assumi do l ogo aps o trmi no da
escri ta, se houver sucesso.
Veja tambm a propri edade WriteFeedbackMode do objeto Dri ver de Comuni cao,
cujo comportamento semel hante.
5.5.2.3 Grupo OPC
Esta seo contm i nformaes sobre os mtodos e propriedades do objeto Grupo
OPC. Este objeto no possui eventos associ ados.
5.5.2.3.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Grupo OPC.
5.5.2.3.1.1 Refresh
Refresh(Source)
Fora o servi dor a reenvi ar os val ores de todos os Tags do Grupo que estejam com
a l ei tura habi l i tada, tenham el es mudado de val or ou no. O parmetro Source
determi na o argumento da fonte de dados do dri ver. Se o val or i nformado for 1
(RefreshFromCache), os val ores envi ados so os val ores do cache do servi dor. Do
contrri o, se o val or i nformado for 2 (RefreshFromDevice), os val ores envi ados so
atual i zados no cache do servi dor antes de serem envi ados. Para que este mtodo
funci one, a propri edade Enable do Grupo, bem como a l ei tura de pel o menos um
Tag do Grupo, deve estar habi l i tada. Para mai ores i nformaes sobre o mecani smo
de habi l i tao de l ei tura (modo Advise), veja as propri edades AllowRead e
AdviseType do Tag.
Esta seo contm i nformaes sobre as propri edades do objeto Grupo OPC.
5.5.2.3.2.1 BlockMode
A propri edade BlockMode determi na o comportamento de ati vao ou
desati vao do Grupo OPC. Quando esta propri edade esti ver confi gurada para
True, a comuni cao dos Tags OPC do Grupo ser i ni ci ada em conjunto. Isso em
geral ocasi ona uma mel hor performance (menor tempo de ati vao), por mi ni mi zar
o nmero de chamadas ao servi dor OPC. Quando a propri edade esti ver
confi gurada para Fal se, o comportamento ser de ati var a comuni cao de cada
Tag OPC do Grupo i ndi vi dual mente (de acordo com a sequnci a normal de ati vao
dos objetos). Com i sso, por exempl o, o pri mei ro Tag do Grupo (na ordem vi sta no
Organi zer) i r comuni car antes do l ti mo Tag. Apesar de mai s l ento, pode ser uma
vantagem usar esse modo de ati vao do Bl oco quando se deseja, por exempl o,
fazer al guma operao (uma escri ta no Tag, por exempl o) em um scri pt do evento
OnStartRunning do Tag. Na desati vao ocorre tudo de manei ra anl oga. Quando o
val or da propri edade True, a desati vao da comuni cao dos Tags do Grupo
ocorre em conjunto, ao trmi no da desati vao de todo Grupo OPC. Caso a
propri edade esteja confi gurada para Fal se, a desati vao da comuni cao ocorre
i ndi vi dual mente para cada Tag (de acordo com a sequnci a normal de desati vao
de objetos).
5.5.2.3.2.2 DeadBand
A propri edade DeadBand permi te ajustar o nvel mni mo de vari ao de um Tag
OPC, para que este seja atual i zado. Essa propri edade s se apl i ca para os Tags do
Grupo que forem consi derados do ti po anal gi co pel o servi dor OPC ao qual o OPC
Dri ver est conectado. O i nterval o vl i do para esta propri edade entre 0 e 100%.
Um val or de 0 (zero) para a propri edade DeadBand si gni fi ca que qual quer vari ao
do val or de um Tag do Grupo i mpl i ca na atual i zao do Grupo. Esse val or
percentual apl i cado para cada Tag em rel ao aos seus l i mi tes de engenhari a
(que fi cam defi ni dos no servi dor OPC). Para que um Tag seja atual i zado, a segui nte
expresso deve ser verdadei ra (i sso aval i ado no Servi dor OPC):
Abs(Valor_guardado_anteriormente Valor_corrente) >
(DeadBand / 100) * Abs(Limite_Superior Limite_Inferior)
5.5.2.3.2.3 Enable
A propri edade Enable habi l i ta a atual i zao dos Tags dentro de um Grupo OPC.
Se esta propri edade esti ver em Fal se, nenhum Tag dentro do Grupo OPC ser
atual i zado. Caso contrri o, os Tags que tenham a propri edade AllowRead
confi gurada para True e que estejam em modo Advise (para mai ores i nformaes,
ver a propri edade AdviseType), sero manti dos atual i zados de acordo com o tempo
de atual i zao (propri edade Scan) e a banda morta (propri edade DeadBand) do
Grupo. Estando essa propri edade em Fal se, no possvel uti l i zar o mtodo Refresh
do Grupo.
5.5.2.3.2.4 RealScan
Tempo de varredura efeti vamente uti l i zado pel o servi dor OPC.
5.5.2.3.2.5 Scan
Especi fi ca o tempo de varredura de atual i zao dos Tags do Grupo que ser
uti l i zado pel o servi dor. Esta propri edade representada em mi l i ssegundos e pode
ser modi fi cada aps i ni ci ada a comuni cao, sendo uti l i zada apenas quando a
propri edade Enable esti ver confi gurada para True.
Ao confi gurar esta propri edade nos di versos Tags presentes na apl i cao,
recomenda-se aumentar o val or da propri edade Scan para aquel es Grupos de Tags
que no vari am mui to no equi pamento ou di sposi ti vo, possi bi l i tando assi m que
outros Grupos de Tags de mai or pri ori dade sejam l i dos com mai or frequnci a,
aumentando assi m a performance e a resposta do si stema. O val or padro desta
propri edade 1000.
5.5.2.3.3 Bloco de Comunicao OPC
Bl oco de Comuni cao OPC.
5.5.2.3.3.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Bl oco de Comuni cao
OPC.
OnRead
OnRead()
Ocorre quando um val or do Bl oco de Comuni cao OPC recebi do do Servi dor
OPC. Uti l i ze o evento OnRead quando for necessri o efetuar al guma operao l ogo
aps al gum dado ter si do modi fi cado no objeto Bl oco de Comuni cao OPC
(propri edades Bit00 at Bit31, Quality, RawValue, TimeStamp e Value de al gum
El emento do Bl oco de Comuni cao OPC).
5.5.2.3.3.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Bl oco de Comuni cao
OPC.
Write
Write()
Executa a escri ta do val or corrente do Bl oco OPC no equi pamento. Para mai ores
detal hes, consul te a documentao do Dri ver. Este mtodo retorna um Booleano
WriteEx
WriteEx([Value[, SyncWrite]])
opci onai s. Se omi ti dos, o comportamento do mtodo i gual ao do mtodo Write.
Este mtodo retorna um Booleano que i ndi ca o sucesso ou no da operao. O
parmetro Value defi ne o val or a ser escri to no Dri ver. O ti po de dado depende do
Dri ver. Se omi ti do, assumi do o val or corrente do Bl oco. O parmetro SyncWrite
um Booleano que especi fi ca se a operao descri ta deve ser sncrona (True) ou
assncrona (Fal se). Se for omi ti do, ser usado o val or especi fi cado na propri edade
SyncWrite do Bl oco.
NOTA: assi m como no mtodo Write, a escri ta fei ta i ndependente de o val or ser
di ferente do val or atual do Bl oco, bem como i ndependente da propri edade
AllowWrite do Bl oco ser True ou Fal se. Al m di sso, se a escri ta funci ona mas o
Bl oco no est em scan (seja porque a propri edade AllowRead Fal se, ou porque
usa a opo AdviseWhenLinked quando no est sendo associ ado), o val or escri to
assumi do i medi atamente com qual i dade boa e timestamp do momento da escri ta.
Esta seo contm i nformaes sobre as propri edades do objeto Bl oco de
Comuni cao OPC.
AdviseType
OPO DESCRIO
0 - AlwaysInAdvise
propri edade AllowRead do Bl oco OPC for
True e a propri edade Enabled do Grupo
OPC tambm for True.
O Tag s atual i zado se a propri edade
AllowRead do Bl oco OPC e a propri edade
Enabled do Grupo OPC forem True, e o Tag
esti ver associ ado a al gum objeto ati vo,
por exempl o, um Di spl ay de uma Tel a
aberta, um Al arme habi l i tado, entre
outros. A associ ao do Tag para esse
propsi to pode ser fei ta nas segui ntes
propri edades: Value, RawValue, Quality e
Bit00 at Bit31 de El ementos de Bl oco
OPC, e Quality e TimeStamp de Bl ocos OPC.
Exempl o:
GetObject("DriverOPC.GrupoOPC.SCRIPT1").AdviseType
End Sub
AllowRead
Confi gure esta propri edade para defi ni r se este Bl oco dever ou no ser l i do pel o
Dri ver OPC. Caso a propri edade AllowRead esteja confi gurada para True, ento o
dri ver automati camente atual i zar as propri edades Value e Bi ts (de Bit00 at Bit31)
dos el ementos do bl oco OPC em i nterval os de tempo. Caso contrri o, este Bl oco
OPC no ser l i do se a propri edade AllowRead esti ver confi gurada para Fal se. Esta
propri edade pode ser modi fi cada em tempo de execuo. O val or padro desta
propri edade True. Exempl o:
Sub Botao1_Click()
End Sub
AllowWrite
Confi gure esta propri edade para defi ni r se este Tag dever ou no ser escri to
automati camente quando a propri edade Value ou qual quer propri edade Bi t (de
Bit00 at Bit031) for modi fi cada. Se a propri edade esti ver em True, as modi fi caes
sero envi adas para o equi pamento ou di sposi ti vo associ ado ao Dri ver OPC, seno
as modi fi caes sero i gnoradas. Estando esta propri edade confi gurada para True,
ento o dri ver automati camente atual i zar as propri edades Value e Bi ts (de Bit00
at Bit31) deste objeto, em i nterval os de tempo. Caso contrri o, este Bl oco OPC no
ser l i do. O val or padro desta propri edade True. Exempl o:
Sub Botao1_Click()
End Sub
DataType
Propri edade somente de l ei tura. Determi na o ti po de dado associ ado ao Bl oco
OPC (ver tabel a a segui r).
Opes disponveis para DataType
OPO DESCRIO
0 - _Undefined
Val or uni di mensi onal no defi ni do
(vazi o).
1 - _Null
Val or nul o.
2 - _Integer
Val or uni di mensi onal i ntei ro de 16 bi ts
si nal i zado.
3 - _Long
si nal i zado.
4 - _Single
Val or uni di mensi onal de ponto fl utuante
de 32 bi ts.
5 - _Double
de 64 bi ts.
6 - _Currency
Val or uni di mensi onal monetri o com 4
casas deci mai s.
7 - _Date
8 - _String
Val or l i teral (texto).
9 - _Object
Val or uni di mensi onal de refernci a a um
objeto.
10 - _Error
Val or uni di mensi onal de cdi go de erro.
11 - _Boolean
Val or uni di mensi onal bool eano
(verdadei ro ou fal so).
OPO DESCRIO
12 - _Variant
Dados de qual quer ti po usados para
objetos e outros val ores para os quai s o
ti po de dados desconheci do.
13 - _UnkObject
objeto.
14 - _Decimal
de 96 bi ts.
36 - _Record
Val or uni di mensi onal de gravao.
16 - _Char
Val or uni di mensi onal i ntei ro de 8 bi ts.
17 - _Byte
uti l i zado para cri ao de DLLs e para
OLE. Ocupa 1 byte de memri a.
18 - _Word
19 - _Dword
20 - _LongLong
si nal i zado.
21 - _DDWord
22 - _Integer_
Nmeros sem deci mai s, cujo i nterval o de
ocorrnci a dever ser de -32.768 a 32.767.
Ocupa 2 bytes.
23 - _Uinteger
Nmero i ntei ro sem si nal (no caso
equi val e a um DWord), que vai de 0 a
4294967295 (2
32
- 1).
8194 - _ArrInteger
Array uni di mensi onal de val ores
i ntei ros.
8195 - _ArrLong
Array uni di mensi onal de val ores i ntei ros
de 32 bi ts si nal i zados.
8196 - _ArrSingle
Array uni di mensi onal de val ores de
ponto fl utuante de 32 bi ts.
8197 - _ArrDouble
8198 - _ArrCurrency
monetri os com 4 casas deci mai s.
8199 - _ArrDate
Array uni di mensi onal de val ores de data
e hora.
8200 - _ArrString
Array uni di mensi onal de val ores l i terai s
(texto).
8201 - _ArrObject
refernci a a um objeto.
8202 - _ArrError
cdi go de erro.
8203 - _ArrBoolean
bool eanos (verdadei ro ou fal so).
8204 - _ArrVariant
Array de dados de qual quer ti po usados
para objetos e outros val ores para os
quai s o ti po de dados desconheci do.
8205 - _ArrUnkObject
OPO DESCRIO
8206 - _ArrDecimal
8228 - _ArrRecord
Array uni di mensi onal de val ores record.
8208 - _ArrChar
Array uni di mensi onal de val ores char.
8209 - _ArrByte
Array uni di mensi onal de bytes, que so
val ores uti l i zados para cri ao de DLLs e
para OLE. Ocupa 1 byte de memri a.
8210 - _ArrWord
de 32 bi ts.
8211 - _ArrDWord
de 32 bi ts.
8212 - _ArrLongLong
de 16 bi ts.
8213 - _ArrDDWord
8214 - _ArrInteger_
8215 - _ArrUInteger
Array uni di mensi onal de nmeros
i ntei ros sem si nal (neste caso equi val e
a um DWord), que vai de 0 a 4294967295
(2
32
-1).
EnableDriverEvent
ocorre no Dri ver de Comuni cao OPC que contm o Bl oco. Se a propri edade
EnableDriverEvent do Bl oco esti ver confi gurada para True, a cada l ei tura vi nda do
servi dor OPC, seja com erro ou no, ser gerado o evento OnTagRead no objeto
Dri ver OPC que contm este Bl oco. Caso contrri o, o evento no ocorre. Tambm
quando a propri edade EnableDriverEvent ti ver o val or True, a cada escri ta que seja
envi ada para o servi dor OPC ser gerado o evento OnTagWrite no objeto OPC
Dri ver que contm o Bl oco. Se a escri ta for assncrona, o evento OnTagWrite ser
gerado apenas quando o servi dor envi ar a resposta i ndi cando o efeti vo sucesso ou
no da escri ta. Nesse caso, o evento ser gerado apenas se a propri edade
EnableDriverEvent for True nesse momento, e no no momento do envi o da escri ta.
O val or padro dessa propri edade Fal se.
ItemID
A propri edade ItemID determi na o cami nho que i denti fi ca o Bl oco OPC no
servi dor ao qual o Dri ver OPC se conecta. A defi ni o deste cami nho fl exvel e
depende do servi dor especfi co. Normal mente, os servi dores especi fi cam um
espao de ID com i tens hi errqui cos, do ti po ItemPai.ItemFilho.Tag1. A propri edade
ItemID funci ona como uma chave ni ca para os dados, consi derando o onde ou o
qu permi te ao servi dor OPC se conectar fonte dos dados. Apesar de o val or
padro ser vazi o, necessri o especi fi car al gum val or para que o Bl oco OPC seja
vl i do.
Quality
Value. Cada vez que o Dri ver atri bui um novo val or para o Bl oco, el e tambm
Size
Defi ne o tamanho do conjunto de val ores do Bl oco. Consul te a documentao do
dri ver uti l i zado, para conhecer qual o l i mi te para esta propri edade, de acordo com
os parmetros B1 at B4. Cri ando os El ementos para o Bl oco, possi bi l i ta-se acessar
os val ores l i dos e tambm permi te a escri ta de val ores para o equi pamento ou
di sposi ti vo. Esta propri edade no pode ser modi fi cada aps i ni ci ada a
comuni cao. O val or padro desta propri edade 0. Exempl o:
Sub BlocoOPC1_OnStartRunning()
Size = 12
End Sub
SyncWrite
A propri edade SyncWrite determi na o ti po de escri ta usada por um Bl oco OPC. Se
a propri edade esti ver confi gurada para True, a escri ta ser sncrona, i sto , o
Dri ver OPC espera o resul tado da escri ta do servi dor. Caso contrri o, a escri ta
assncrona, i sto , o val or do Tag OPC ser envi ado e o processamento do Dri ver
OPC conti nuar i medi atamente. O val or padro desta propri edade Fal se.
NOTA: No modo assncrono (propri edade desabi l i tada), a performance da
comuni cao tende a ser mel hor, porm no modo sncrono (propri edade
habi l i tada), o sucesso da operao de escri ta veri fi cado e i nformado.
TimeStamp
hora associ ada tanto ao val or quanto qual i dade do Bl oco OPC. Esta uma
5.5.2.3.3.4 Elemento de Bloco de Comunicao OPC
Esta seo contm i nformaes sobre eventos e propriedades do objeto El emento
de Bl oco de Comuni cao OPC. Este objeto no possui mtodos associ ados.
Eventos
Esta seo contm i nformaes sobre os eventos do objeto El emento de Bl oco de
Comuni cao OPC.
OnRead
OnRead()
Ocorre quando um val or do El emento de Bl oco de Comuni cao OPC recebi do
pel o Servi dor OPC. Uti l i ze o evento OnRead quando for necessri o efetuar al guma
operao l ogo aps al gum dado ter si do modi fi cado no objeto El emento de Bl oco
de Comuni cao OPC (propri edades Bit00 at Bit31, Quality, RawValue ou Value).
Propriedades
Esta seo contm as propri edades do objeto El emento de Bl oco de Comuni cao
OPC.
Bit00 at Bit31
presente na propri edade Value do objeto El emento de Bl oco OPC, sendo Bit00 o bi t
menos si gni fi cati vo e Bit31 o bi t mai s si gni fi cati vo. Modi fi car cada um destes bi ts
i mpl i ca na i gual modi fi cao da propri edade Value do El emento, e vi ce-versa, mas
i sto somente ocorre quando a propri edade UseBitFields esti ver confi gurada para
True. O val or padro destas propri edades Fal se.
DeviceHigh
A propri edade DeviceHigh defi ne o val or mxi mo ati ngi do por um El emento de
Bl oco no equi pamento ou no di sposi ti vo. Esta propri edade ser uti l i zada para fazer
o ajuste de escal a do val or proveni ente do equi pamento ou di sposi ti vo antes de ser
atri budo propri edade Value. Da mesma forma, no momento da escri ta fei ta a
quando a propri edade EnableScaling est confi gurada para True. O val or padro
' que varia de 0 a 255 no OPC, mas significam na
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
DeviceLow
A propri edade DeviceLow defi ne o val or mni mo ati ngi do por um El emento no
de escal a do val or proveni ente do equi pamento ou di sposi ti vo antes de ser
atri budo propri edade Value. Da mesma forma, no momento da escri ta, fei ta a
quando a propri edade EnableScaling est confi gurada para True. O val or padro
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EnableScaling
envi ado e recebi do do equi pamento ou di sposi ti vo. Se esta propri edade esti ver
confi gurada para True, todo val or proveni ente do equi pamento ou di sposi ti vo
sofrer ajuste de escal a conforme as propri edades DeviceHigh, DeviceLow, EUHigh
e EULow antes de ser atri budo propri edade Value. O mesmo ocorrer quando
uma escri ta for necessri a, quando o val or presente em Value sofrer ajuste de
escal a (sem com i sso al terar a propri edade Value) e posteri ormente ser envi ado
para o equi pamento ou di sposi ti vo. Caso a propri edade EnableScaling tenha o val or
Fal se, nenhum ajuste de escal a ser efetuado em nenhum dos doi s senti dos (escri ta
e l ei tura). O val or padro desta propri edade Fal se. Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EU
Identi fi ca a uni dade de engenhari a representada por seu val or, como por
exempl o, graus, metros, KW/h, etc. Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EUHigh
DeviceHigh = 255
DeviceLow = 0
EULow = 100
EULow = 0
End Sub
EULow
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
Index
Uti l i ze esta propri edade para especi fi car a posi o que um El emento ocupa entre
os El ementos confi gurados pel a propri edade Size do objeto Bl oco OPC no qual el e
est i nseri do. Esta propri edade acei ta val ores de 0 at um nmero menor do que a
val or defi ni do em Size. Por exempl o, confi gurando um Bl oco OPC para ter Size i gual
a 20, o nmero mxi mo vl i do para a propri edade Index ser 19 e o mni mo 0. Esta
propri edade pode ser al terada aps i ni ci ada a comuni cao. O val or padro da
propri edade 0, porm ao mapear os El ementos de um Bl oco o Studi o
automati camente confi gura o parmetro Index para um val or de acordo com o
especi fi cado. Exempl o:
Sub Elemento1_OnRead()
MsgBox Index
End Sub
Quality
A propri edade Quality representa o estado de qual i dade do val or conti do na
propri edade Value.
RawValue
Acessa o val or ori gi nal do el emento anteri or escal a, ou seja,
i ndependentemente da confi gurao da propri edade EnableScaling. Ento, se esta
propri edade for Fal se, as propri edades Value e RawValue apresentam o mesmo
comportamento.
UseBitFields
Caso a propri edade UseBitFields tenha o val or True, toda vez que o val or da
propri edade Value for modi fi cada, el e atual i zar os bi ts referentes s
envi ar para o equi pamento ou di sposi ti vo se a propri edade AllowWrite do Bl oco
de Comuni cao esti ver confi gurada para True. Caso contrri o, se a propri edade
UseBitFields esti ver confi gurada para Fal se, os bi ts no sofrero nem acarretaro
qual quer mudana. Esta propri edade pode ser atual i zada aps ter si do i ni ci ada a
comuni cao. O val or padro desta propri edade Fal se.
Value
Atual i zada sempre que um novo val or l i do no servi dor OPC, de acordo com a
especi fi cao da propri edade ItemID do Bl oco OPC onde este objeto est i nseri do,
e consi derando a propri edade Index (que especi fi ca a posi o do El emento no vetor
do Bl oco). O ti po desta propri edade (nmero i ntei ro, ponto fl utuante, texto, etc.)
depende do dri ver ao qual el e est associ ado e da sua parametri zao.
do objeto Bl oco OPC ao qual o El emento pertence esti ver confi gurada para True, e
de acordo com o tempo de varredura defi ni do na propri edade Scan do Grupo OPC
que contm o Bl oco. Se a propri edade AllowWrite do objeto Bl oco OPC esti ver
confi gurada em True, pode-se escrever val ores no equi pamento ou no di sposi ti vo
si mpl esmente atri bui ndo um novo val or para a propri edade Value.
Esta tambm a propri edade padro do objeto El emento de Bl oco OPC. Sendo
assi m, uma refernci a por val or a um objeto El emento de Bl oco OPC no necessi ta
obri gatori amente expl i ci tar a propri edade Value para acessar o val or. Caso esta
propri edade no esteja sendo atual i zada, veri fi que se a propri edade Index est
corretamente confi gurada (seu val or deve ser zero at o tamanho do Bl oco OPC
menos um). Exempl o:
Sub Botao1_Click()
' Acessa um elemento e mostra o valor atual
' elm1 um objeto tipo Elemento de Bloco OPC
Set obj = Application.GetObject_
("OPCDriver1.Grupo1.BlocoOPC1.elm1")
MsgBox "Valor atual de elm1: " & obj.Value
' sem mostrar a propriedade Value, que padro
MsgBox "Valor atual de elm1: " & obj
End Sub
5.5.2.3.4 Tag de Comunicao OPC
Tag de Comuni cao OPC.
5.5.2.3.4.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Tag de Comuni cao
OPC.
OnRead
OnRead()
Ocorre quando um val or do Tag de Comuni cao OPC recebi do do Servi dor OPC.
Uti l i ze o evento OnRead quando for necessri o efetuar al guma operao l ogo aps
al gum dado ter si do modi fi cado no objeto Tag de Comuni cao OPC (propri edades
Bit00 at Bit31, Quality, RawValue, TimeStamp ou Value).
5.5.2.3.4.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Tag de Comuni cao
OPC.
Write
Write()
Executa a escri ta do val or corrente do Tag OPC no equi pamento. Para mai ores
detal hes, consul te a documentao do Dri ver. Este mtodo retorna um Booleano
WriteEx
WriteEx([Value[, SyncWrite]])
opci onai s. Se omi ti dos, o comportamento do mtodo i gual ao do mtodo Write.
Este mtodo retorna um Booleano que i ndi ca o sucesso ou no da operao. O
parmetro Value defi ne o val or a ser escri to no Dri ver. O ti po de dado depende do
Dri ver. Se omi ti do, assumi do o val or corrente do Tag. O parmetro SyncWrite
um Booleano que especi fi ca se a operao descri ta deve ser sncrona (True) ou
assncrona (Fal se). Se for omi ti do, ser usado o val or especi fi cado na propri edade
SyncWrite do Tag.
NOTA: assi m como no mtodo Write, a escri ta fei ta i ndependente de o val or ser
di ferente do val or atual do Tag, bem como i ndependente da propri edade
AllowWrite do Tag ser True ou Fal se. Al m di sso, se a escri ta funci ona mas o Tag
no est em scan (seja porque a propri edade AllowRead Fal se, ou porque usa a
opo AdviseWhenLinked quando no est sendo associ ado), o val or escri to
assumi do i medi atamente com qual i dade boa e timestamp do momento da escri ta.
Esta seo contm as propri edades do objeto Tag de Comuni cao OPC.
AdviseType
OPO DESCRIO
0 - AlwaysInAdvise
propri edade AllowRead do Tag OPC for
True e a propri edade Enable do Grupo
OPC tambm for True.
O Tag s atual i zado se a propri edade
AllowRead do Tag OPC e a propri edade
Enable do Grupo OPC forem True, e o Tag
esti ver associ ado a al gum objeto ati vo,
por exempl o, um Di spl ay de uma Tel a
aberta, um Al arme habi l i tado, entre
outros. A associ ao do Tag para esse
propsi to pode ser fei ta nas segui ntes
propri edades: Value, RawValue,
TimeStamp, Quality e Bit00 at Bit31 de
Tags OPC.
Exempl o:
GetObject("DriverOPC.GrupoOPC.TagOPC1").AdviseType
End Sub
AllowRead
Defi ne se este Tag dever ou no ser l i do pel o Dri ver OPC. Caso a propri edade
esteja confi gurada para True, o dri ver automati camente atual i zar as
propri edades Value e Bi ts (de Bit00 at Bit31) deste objeto em i nterval os de tempo.
Caso contrri o, este Tag OPC no ser l i do. Esta propri edade pode ser modi fi cada
em tempo de execuo. O val or padro desta propri edade True. Exempl o:
Sub Botao1_Click()
End Sub
AllowWrite
Defi ne se este Tag dever ou no ser escri to automati camente quando a
propri edade Value ou qual quer propri edade Bi t (de Bit00 at Bit31) for modi fi cada.
Se a propri edade esti ver em True, as modi fi caes sero envi adas para o
equi pamento ou di sposi ti vo associ ado ao Dri ver OPC; do contrri o, as
modi fi caes sero i gnoradas. O val or padro desta propri edade True. Exempl o:
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do tag
End Sub
Bit00 at Bit31
presente na propri edade Value do objeto Tag de Comuni cao OPC, sendo Bit00 o
bi t menos si gni fi cati vo e Bit31 o bi t mai s si gni fi cati vo. Modi fi car cada um destes
bi ts i mpl i ca na i gual modi fi cao da propri edade Value do Tag, e vi ce-versa, mas
i sto somente ocorre quando a propri edade UseBitFields esti ver confi gurada para
True. O val or padro destas propri edades Fal se.
da converso.
DataType
Propri edade somente de l ei tura. Determi na o ti po de dado associ ado ao Tag
OPC (ver tabel a a segui r).
Opes disponveis para DataType
OPO DESCRIO
0 - _Undefined
Val or uni di mensi onal no defi ni do
(vazi o).
1 - _Null
Val or nul o.
2 - _Integer
si nal i zado.
3 - _Long
si nal i zado.
4 - _Single
de 32 bi ts.
5 - _Double
de 64 bi ts.
6 - _Currency
Val or uni di mensi onal monetri o com 4
casas deci mai s.
7 - _Date
8 - _String
Val or l i teral (texto).
9 - _Object
objeto.
10 - _Error
Val or uni di mensi onal de cdi go de erro.
11 - _Boolean
Val or uni di mensi onal bool eano
(verdadei ro ou fal so).
12 - _Variant
Dados de qual quer ti po usados para
objetos e outros val ores para os quai s o
ti po de dados desconheci do.
13 - _UnkObject
objeto.
14 - _Decimal
de 96 bi ts.
36 - _Record
Val or uni di mensi onal de gravao.
16 - _Char
17 - _Byte
uti l i zado para cri ao de DLLs e para
OLE. Ocupa 1 byte de memri a.
18 - _Word
19 - _Dword
20 - _LongLong
si nal i zado.
21 - _DDWord
22 - _Integer_
Nmeros sem deci mai s, cujo i nterval o de
ocorrnci a dever ser de -32.768 a 32.767.
Ocupa 2 bytes.
23 - _Uinteger
Nmero i ntei ro sem si nal (no caso
equi val e a um DWord), que vai de 0 a
4294967295 (2
32
- 1).
8194 - _ArrInteger
i ntei ros.
8195 - _ArrLong
OPO DESCRIO
8196 - _ArrSingle
8197 - _ArrDouble
8198 - _ArrCurrency
monetri os com 4 casas deci mai s.
8199 - _ArrDate
Array uni di mensi onal de val ores de data
e hora.
8200 - _ArrString
Array uni di mensi onal de val ores l i terai s
(texto).
8201 - _ArrObject
8202 - _ArrError
cdi go de erro.
8203 - _ArrBoolean
bool eanos (verdadei ro ou fal so).
8204 - _ArrVariant
Array de dados de qual quer ti po usados
para objetos e outros val ores para os
quai s o ti po de dados desconheci do.
8205 - _ArrUnkObject
8206 - _ArrDecimal
8228 - _ArrRecord
Array uni di mensi onal de val ores record.
8208 - _ArrChar
Array uni di mensi onal de val ores char.
8209 - _ArrByte
Array uni di mensi onal de bytes, que so
val ores uti l i zados para cri ao de DLLs e
para OLE. Ocupa 1 byte de memri a.
8210 - _ArrWord
de 32 bi ts.
8211 - _ArrDWord
de 32 bi ts.
8212 - _ArrLongLong
de 16 bi ts.
8213 - _ArrDDWord
8214 - _ArrInteger_
de 16 bi ts si nal i zados
8215 - _ArrUInteger
Array uni di mensi onal de nmeros
i ntei ros sem si nal (no caso equi val e a
um DWord), que vai de 0 a 4294967295 (2
32
- 1).
DeviceHigh
A propri edade DeviceHigh defi ne o val or mxi mo ati ngi do por um Tag no
de escal a do val or proveni ente do equi pamento ou do di sposi ti vo antes de ser
quando a propri edade EnableScaling esti ver confi gurada para True, seno, os
val ores permanecem os mesmos. O val or padro desta propri edade 1000.
Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
da converso.
DeviceLow
A propri edade DeviceLow defi ne o val or mni mo ati ngi do por um tag no
de escal a do val or proveni ente do equi pamentoou do di sposi ti vo antes de ser
quando a propri edade EnableScaling est confi gurada para True, seno as
confi guraes permanecem as mesmas. O val or padro desta propri edade 0.
Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
da converso.
EnableDriverEvent
ocorre no Dri ver de Comuni cao OPC que contm o Tag. Se a propri edade
EnableDriverEvent do Tag esti ver confi gurada para True, a cada l ei tura vi nda do
servi dor OPC, seja com erro ou no, ser gerado o evento OnTagRead no objeto
Dri ver OPC que contm este Tag. Caso contrri o, o evento no ocorre. Tambm
quando a propri edade EnableDriverEvent ti ver o val or True, a cada escri ta que seja
envi ada para o servi dor OPC, ser gerado o evento OnTagWrite no objeto Dri ver
OPC que contm o Tag. Se a escri ta for assncrona, o evento OnTagWrite ser
gerado apenas quando o servi dor envi ar a resposta i ndi cando o efeti vo sucesso ou
no da escri ta. Nesse caso, o evento ser gerado apenas se a propri edade
EnableDriverEvent for True nesse momento, e no no momento do envi o da escri ta.
O val or padro dessa propri edade Fal se.
EnableScaling
Se esta propri edade esti ver confi gurada para True, todo val or proveni ente do
equi pamento ou do di sposi ti vo sofrer ajuste de escal a conforme as propri edades
EUHigh e EULow antes de ser atri budo propri edade Value. Caso a propri edade
EnableScaling tenha o val or confi gurado para Fal se, nenhum ajuste de escal a ser
efetuado em nenhum dos doi s senti dos (tanto para escri ta como para l ei tura). O
val or padro desta propri edade Fal se. Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EU
Identi fi ca a uni dade de engenhari a representada pel o val or, como por exempl o,
graus, metros, KW/h, etc. O val or desta propri edade vazi o. Exempl o:
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EUHigh
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
da converso.
EULow
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
da converso.
ItemID
A propri edade ItemID determi na o cami nho que i denti fi ca o Tag OPC no servi dor
OPC ao qual o Dri ver OPC se conecta. A defi ni o desse cami nho fl exvel e
depende do servi dor especfi co. Normal mente os servi dores especi fi cam um espao
de ID com i tens hi errqui cos, do ti po ItemPai.ItemFilho.Tag1. Esta propri edade
funci ona como uma chave ni ca para os dados, consi derando o onde ou o qu
permi te o servi dor OPC se conectar fonte dos dados. Apesar de o val or padro ser
vazi o, necessri o especi fi car al gum val or para que o Tag OPC seja vl i do.
Quality
Value. Cada vez que o Dri ver atri bui um novo val or para o Tag, el e tambm
RawValue
Acessa o val or ori gi nal do Tag anteri or escal a, ou seja, i ndependentemente da
SyncWrite
A propri edade SyncWrite determi na o ti po de escri ta usada por um Tag OPC. Se a
propri edade esti ver confi gurada para True, a escri ta ser sncrona, i sto , o Dri ver
OPC espera o resul tado da escri ta do servi dor. Caso contrri o, a escri ta
assncrona, i sto , o val or do Tag OPC ser envi ado e o processamento do Dri ver
OPC conti nuar i medi atamente. O val or padro desta propri edade Fal se.
NOTA: No modo assncrono (propri edade confi gurada para Fal se), a performance da
comuni cao tende a ser mel hor, porm no modo sncrono (propri edade
confi gurada para True), o sucesso da operao de escri ta veri fi cado e i nformado.
TimeStamp
hora associ ada tanto ao val or quanto qual i dade do Tag OPC. Esta uma
UseBitFields
Caso a propri edade UseBitFields tenha o val or True, toda vez que o val or da
propri edade Value for modi fi cada el e atual i zar os bi ts referentes s propri edades
Bit00 at Bit31. Da mesma forma atual i zar o val or de Value toda vez que al guma
das propri edades Bit00 at Bit31 mudar de val or e posteri ormente envi ar para o
equi pamento ou di sposi ti vo se a propri edade AllowWrite esti ver confi gurada para
True. Caso contrri o, se a propri edade UseBitFields esti ver confi gurada para Fal se,
os bi ts no sofrero qual quer mudana. Esta propri edade pode sofrer atual i zao
aps ter si do i ni ci ada a comuni cao. O val or padro desta propri edade Fal se.
Exempl o:
Sub TagOPC1_Click()
UseBitFields = True
End Sub
da converso.
Value
A propri edade Value atual i zada quando fei ta uma nova l ei tura vl i da de um
val or do equi pamento ou do di sposi ti vo uti l i zando sua parametri zao, porm o
ti po desta vari vel (nmero i ntei ro, ponto fl utuante, texto) depende do Dri ver OPC,
ao qual el e est associ ado e da sua parametri zao. Esta propri edade somente i r
ser atual i zada desta forma se a propri edade AllowRead esti ver confi gurada para
True e quando no houver erros de comuni cao (neste caso somente as
propri edades Quality e TimeStamp so atual i zadas), mas de acordo com o tempo
de varredura defi ni do no Grupo ao qual el e pertence. Outra forma de uti l i zar esta
propri edade escrever val ores no equi pamento ou di sposi ti vo. Basta para i sso,
atri bui r um novo val or para a propri edade Value ou al gum dos bi ts Bit00 at Bit31,
desde que a propri edade AllowWrite esteja confi gurado para True. Esta
propri edade tambm a propri edade padro do objeto Tag OPC. Sendo assi m, uma
refernci a por val or a um objeto Tag OPC no necessi ta obri gatori amente expl i ci tar
a propri edade Value para acessar o val or. O val or padro desta propri edade
vazi o. Exempl o:
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 i nformaes sobre as propriedades do objeto Dri ver de
Comuni cao OPC UA. Este objeto no possui eventos nem mtodos associ ados.
Comuni cao OPC UA.
5.5.3.1.1 EndPointURL
Propri edade de l ei tura e escri ta que especi fi ca o cami nho (ponto de conexo) do
servi dor OPC UA ao qual o cl i ente i r se conectar. Esta propri edade no pode ser
al terada com a comuni cao ati va.
5.5.3.1.2 Password
Propri edade de l ei tura e escri ta que especi fi ca a senha do usuri o que ser
usado na conexo com o servi dor OPC UA. Essa propri edade usada em conjunto
com a propri edade UserName, e seu val or padro uma String vazi a.
NOTA: Esta propri edade pode ser al terada com a comuni cao ati va, mas esta
al terao s ter efei to quando o Cl i ente OPC UA for rei ni ci ado.
5.5.3.1.3 SecurityMode
Propri edade de l ei tura e escri ta que especi fi ca o modo de segurana que ser
usado na conexo com o servi dor OPC UA. Esta propri edade no pode ser al terada
com a comuni cao ati va. Os val ores possvei s para esta propri edade so os
segui ntes:
1: usmNone (no uti l i za nenhum modo de segurana na conexo)
2: usmSi gn (uti l i za autenti cao na conexo)
3: usmSi gnAndEncrypt (uti l i za autenti cao e cri ptografi a na conexo)
Esta propri edade usada em conjunto com a propri edade SecurityPolicy para
determi nar o ti po de segurana da conexo. O val or padro desta propri edade 1
(usmNone), ou seja, nenhuma segurana.
NOTA: Se a propri edade SecurityMode for di ferente de usmNone, necessri o que o
servi dor OPC UA acei te o certi fi cado da i nstnci a do cl i ente E3. A forma como um
certi fi cado acei to ou reconheci do por um servi dor OPC UA depende do servi dor.
5.5.3.1.4 SecurityPolicy
Propri edade de l ei tura e escri ta que especi fi ca a pol ti ca de segurana
(cri ptografi a) usada na conexo com o servi dor OPC UA. Esta propri edade no pode
ser al terada com a comuni cao ati va. Os val ores possvei s para esta propri edade
so os segui ntes:
1: uspNone (no uti l i za cri ptografi a na conexo)
2: uspBasi c128Rsa15 (uti l i za o al gori tmo RSA com chave de 128 bi ts na conexo)
3: uspBasi c256 (uti l i za o al gori tmo AES com chave de 256 bi ts na conexo)
Esta propri edade usada em conjunto com a propri edade SecurityMode para
determi nar o ti po de segurana da conexo. O val or padro desta propri edade 1
(uspNone), ou seja, nenhuma pol ti ca de segurana.
5.5.3.1.5 TimeoutCall
Propri edade de l ei tura e escri ta que especi fi ca o tempo l i mi te de uma chamada
ao servi dor OPC UA, em mi l i ssegundos. Esta propri edade no pode ser al terada
com a comuni cao ati va, seu val or deve ser mai or que 0 (zero) e seu val or padro
10000 (10 segundos).
NOTA: No padro OPC UA, vri as chamadas permi tem conti nuar a comuni cao, com
ml ti pl as respostas do servi dor. Desta forma, este tempo acaba por ser o tempo
l i mi te de resposta do servi dor OPC UA.
5.5.3.1.6 TimeoutConnection
Propri edade de l ei tura e escri ta que especi fi ca o tempo l i mi te da conexo, em
mi l i ssegundos. O val or padro desta propri edade 10000 (10 segundos) e seu
val or deve ser mai or que 0 (zero). Esta propri edade no pode ser al terada com a
comuni cao ati va.
5.5.3.1.7 TimeoutSession
Propri edade de l ei tura e escri ta que especi fi ca o tempo l i mi te para a renovao
da sesso de comuni cao do cl i ente E3 com o servi dor OPC UA, em mi l i ssegundos.
O val or padro desta propri edade 600000 (10 mi nutos) e este val or deve ser
mai or que 0 (zero). Esta propri edade no pode ser al terada com a comuni cao
ati va.
5.5.3.1.8 UserName
Propri edade de l ei tura e escri ta que especi fi ca o nome do usuri o que ser
usado na conexo com o servi dor OPC UA. Essa propri edade usada em conjunto
com a propri edade Password. O val or padro desta propri edade uma String vazi a.
NOTA: Esta propri edade pode ser al terada com a comuni cao ati va, mas esta
al terao s ter efei to quando o Cl i ente OPC UA for rei ni ci ado.
5.6 Servidor de Dados
Esta seo contm i nformaes sobre eventos, mtodos e propri edades dos
segui ntes objetos: Consulta, Pasta de Dados, Tag Contador, Tag Demo, Tag Interno e
Tag Timer.
5.6.1 Consulta
Consul ta.
5.6.1.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Consul ta.
5.6.1.1.1 OnAsyncQueryFinish
OnAsyncQueryFinish(Recordset, Error)
Ocorre no retorno do mtodo GetAsyncADORecordset. O parmetro Recordset o
ADO Recordset gerado pel a Consul ta, e o parmetro Error um Bool eano que,
quando verdadei ro, mostra que o objeto no consegui u ser gerado. Exempl o:
Sub Consulta1_OnAsyncQueryFinish(Recordset, Error)
MsgBox "Retornou " + CStr(Recordset.RecordCount) + "
registros"
End Sub
5.6.1.2 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Consul ta.
5.6.1.2.1 AddField
AddField(Name[, Table])
O mtodo AddField adi ci ona um novo campo da tabel a na Consul ta. O parmetro
Name determi na o nome do novo campo que ser adi ci onado Consul ta. O
parmetro Table determi na o nome da tabel a a que o campo pertence. Este mtodo
foi desenvol vi do apenas para manter a compati bi l i dade com o anti go objeto
Consul ta do E3Chart. Exempl o:
Sub Botao1_Click()
Screen.Item("E3Browser").Item("Consulta").AddField "Campo1"
End Sub
NOTA: Este mtodo i r fal har se a propri edade QueryType esti ver confi gurada para o
val or 1 - qtStorage.
5.6.1.2.2 AddStorageTag
AddStorageTag(Name, FieldType)
Adi ci ona um Tag pertencente ao Storage Consul ta. O parmetro Name recebe o
nome do Tag a ser adi ci onado. O parmetro FieldType i ndi ca o ti po deste Tag (0:
Double, 1: Bit, 2: String, 3: Integer). Retorna um Bool eano i ndi cando o sucesso (ou
no) da operao.
val or 0 - qtDBServer.
5.6.1.2.3 AddTable
AddTable(Name)
Adi ci ona uma tabel a do banco de dados na Consul ta. O parmetro Table determi na
o nome da tabel a a ser adi ci onada.
5.6.1.2.4 AddUaField
AddUaField(Name[, Alias[, Function]])
Este mtodo adi ci ona, em tempo de execuo, um campo a uma consul ta
confi gurada para o ti po OPC UA. O mtodo retorna Verdadei ro se for bem sucedi do
e Fal so se houver fal ha. Os parmetros deste mtodo so os segui ntes:
Name: Uma String com o cami nho (Col una) do campo
Alias: Uma String com o ttul o do campo. Se este parmetro for omi ti do assume
uma String vazi a
Function: Uma String com o ti po de funo de agregao do campo, caso seja
usada uma consul ta do ti po Dados Processados. Se este parmetro for omi ti do,
assume o val or Interpolative
Em uma consul ta de ti po Dados Brutos (propri edade UaQueryType com val or i gual
a zero), este mtodo fal ha se j houver um campo defi ni do. Este mtodo s tem
efei to se a propri edade QueryType esti ver confi gurada para OPC UA (val or i gual a
2: qtOpcUa). Do contrri o, retorna Fal so.
5.6.1.2.5 Execute
Execute(ImmediateExecute)
O mtodo Execute executa um comando SQL que no tenha retorno (como DELETE,
UPDATE ou INSERT), confi gurado na propri edade SQL da Consul ta. O parmetro
ImmediateExecute i ndi ca se a operao passar pel as fi l as de operaes (arqui vos
.e3i e .e3o) antes de chegar ao Banco de Dados (caso esteja confi gurada como
Fal so), ou se ser envi ada di retamente para o Banco de Dados (caso esteja
confi gurada como Verdadei ro). A vantagem de se uti l i zar a Consul ta para executar
comandos a uti l i zao de vari vei s, como em uma consul ta si mpl es. Exempl o de
comandos SQL:
DELETE FROM teste WHERE cod > 10
UPDATE teste SET cod = 10 WHERE cod > 10
INSERT INTO teste(cod) VALUES(10)
Exempl o:
Screen.Item("Consulta1").Execute
End Sub
5.6.1.2.6 GetADORecordSet
GetADORecordSet()
O mtodo GetADORecordSet retorna um Recordset do ti po ADO (ActiveX Data
Object), resul tante da execuo da Consul ta confi gurada. Exempl o:
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: Para mai ores i nformaes sobre o objeto ADORecordset retornado por este
mtodo, consul te a documentao da Mi crosoft no l i nk http://msdn.microsoft.com/en-
us/library/ms675841(VS.85).aspx (somente em i ngl s).
5.6.1.2.7 GetAsyncADORecordSet
GetAsyncADORecordSet()
Cri a uma Consul ta e, quando el a esti ver fi nal i zada, gera o evento
OnAsyncQueryFinish do prpri o objeto, passando para este evento o resul tado
(Recordset) gerado pel a Consul ta.
5.6.1.2.8 GetE3QueryFields
GetE3QueryFields()
O mtodo GetE3QueryFields retorna a Coleo de Campos (col unas) de uma
Consul ta. Cada i tem desta Col eo possui propri edades que podem ser
modi fi cadas, conforme descri to no tpi co Campo da Consulta. Exempl o:
Sub Botao1_Click()
' Percorre a coleo de Campos,
' 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: Para usar este mtodo, a Consul ta dever ser previ amente cri ada em tempo
de confi gurao.
5.6.1.2.9 RemoveField
RemoveField(FieldName[, Table])
O mtodo RemoveField remove um campo previ amente i ncl udo em uma Consul ta.
O parmetro FieldName determi na o nome do campo que ser removi do. O
parmetro Table determi na o nome da tabel a a qual o campo pertence. Este mtodo,
a exempl o do mtodo AddField, foi i ncl udo para manter a compati bi l i dade com as
verses anti gas da Consul ta do E3Chart. Exempl o:
Screen.Item("E3Browser").Item("Consulta")._
RemoveField "Campo1"
End Sub
5.6.1.2.10 RemoveStorageTag
RemoveStorageTag(Name)
Remove um Tag previ amente confi gurado na Consul ta. O parmetro Name i ndi ca o
nome do Tag. Retorna um Bool eano i ndi cando o sucesso (ou no) da operao.
val or 0 - qtDBServer.
5.6.1.2.11 RemoveTable
RemoveTable(TableName)
Remove uma tabel a da Consul ta. O parmetro TableName determi na o nome da
tabel a a ser removi da.
5.6.1.2.12 RemoveUaField
RemoveUaField(Name)
Este mtodo remove o campo com o nome especi fi cado, se exi sti r. O parmetro
Name uma String com o nome (Col una) do campo. O mtodo retorna Verdadei ro se
for bem sucedi do e Fal so se houver fal ha. Este mtodo s tem efei to se a
propri edade QueryType esti ver confi gurada para OPC UA (val or i gual a 2:
qtOpcUa). Do contrri o, retorna Fal so.
5.6.1.2.13 SetVariableValue
SetVariableValue(VarName, Value)
O mtodo SetVariableValue ajusta o val or de uma vari vel confi gurada na
Consul ta, de forma que este val or possa ser i nformado como um fi l tro ou
parmetro antes de a Consul ta ser real i zada. Deve ser defi ni do o nome da vari vel
(VarName) e seu val or (Value), que pode ser um nmero, texto ou data e hora.
Exempl o:
Set cons = Screen.Item("E3Browser1").Item("Consulta1")
DataInicial = now - 1
DataFinal = now
cons.SetVariableValue "DataIni", DataInicial
cons.SetVariableValue "DataFim", DataFinal
End Sub
Esta seo contm i nformaes sobre as propri edades do objeto Consul ta.
NOTA: No recomendvel o acesso di reto destas propri edades vi a scri pts. O i deal
acessar o objeto Consul ta, passando parmetros atravs do mtodo
SetVariableValue e modi fi cando fi l tros ou campos atravs da col eo retornada com
o mtodo GetE3QueryFields.
5.6.1.3.1 CursorLocation
Defi ne o l ocal onde a Consul ta ser gerada e mani pul ada, sob o ponto de vi sta
do SGBD (Si stema Gerenci ador do Banco de Dados). As opes di sponvei s so:
0 - clServer: a Consul ta ser gerada no SGBD (servi dor)
1 - clClient: a Consul ta ser gerada no Servi dor (cl i ente)
O val or padro desta propri edade 1 - clClient. Ver tambm a propri edade
CursorType.
NOTA: Esta propri edade no tem efei to para Bancos de Dados em que a
propri edade SourceType seja i gual a 0 - stAccess, poi s neste caso sempre o
Servi dor que gera e mani pul a a Consul ta. Entretanto, para SourceType i gual a 1 -
stOracle ou 2 - stSqlServer, aconsel ha-se uti l i zar a opo 1 - clClient. Para mai ores
i nformaes, consul te a documentao da propri edade CursorLocation e da
enumerao CursorLocationEnum do objeto ADO (ActiveX Data Object).
5.6.1.3.2 CursorType
Defi ne o ti po de Consul ta de acordo com a vi sual i zao dos dados. O val or
padro desta propri edade 0 - ctKeyset. Todas as opes di sponvei s esto na
tabel a a segui r.
Opes disponveis para CursorType
OPO DESCRIO
0 - ctKeyset
Qual quer mudana nos regi stros
i ni ci al mente retornados pel a Consul ta
ser vi svel (Padro).
1 - ctStatic
Nenhuma mudana nos regi stros
i ni ci al mente retornados pel a Consul ta
ser vi svel .
2 - ctDynamic
Todos os novos regi stros adi ci onados na
Consul ta sero vi svei s, al m das
mudanas nos regi stros i ni ci al mente
retornados pel a Consul ta.
5.6.1.3.3 DataSource
Indi ca o objeto Banco de Dados, Storage ou Dri ver de Comuni cao OPC UA que
ser usado na Consul ta. Esta propri edade somente de l ei tura, mas pode ser
modi fi cada em tempo de execuo.
5.6.1.3.4 Fields
Texto com os campos a serem vi sual i zados na Consul ta, separados por vrgul a.
Corresponde ao argumento da cl usul a SELECT do cdi go SQL da Consul ta. Em
branco (vazi o), determi na que a Consul ta deve mostrar todos os campos da tabel a.
Esta propri edade somente de l ei tura, mas pode ser modi fi cada em tempo de
execuo.
5.6.1.3.5 FunctionSubType
Especi fi ca o subti po da funo i ndi cada por FunctionType. Apenas as opes 1 -
ftArchivedValue, 2 - ftTagAttribute e 6 - ftCalculatedData possuem subti pos. Para as
outras funes, FunctionSubType assume o val or -1 - fsNoSubType. A tabel a a
segui r mostra os possvei s val ores da propri edade, de acordo com a funo
escol hi da na propri edade FunctionType:
Subtipos para funo ArchivedValue (FunctionType = 1)
SUBTIPO DESCRIO
0 - fsPreviousArchivedValue
Val or armazenado i medi atamente
anteri or ao timestamp forneci do.
1 - fsInterpolatedArchivedValue
Val or cal cul ado a parti r do val or anteri or
e posteri or.
2 - fsNextArchivedValue
Val or armazenado i medi atamente
posteri or ao timestamp.
3 - fsExactArchivedValue
Se for encontrado um val or armazenado
no exato i nstante que foi forneci do pel o
timestamp.
Subtipos para funo TagAttribute (FunctionType = 2)
SUBTIPO DESCRIO
0 - fsTagAttributeDescription
Si gni fi cado ou descri o do Tag.
1 - fsTagAttributeSource
Cami nho do Tag que est sendo
armazenado.
2 - fsTagAttributeType
Ti po de dado: Double, Boolean ou String.
3 - fsTagAttributeEU
Uni dade de engenhari a.
4 - fsTagAttributeLowEng
Li mi te i nferi or.
5 - fsTagAttributeHighEng
Li mi te superi or.
6 - fsTagAttributeDeadBand
Banda morta para gravao.
7 - fsTagAttributeDeadBandUnit
Uni dade da banda morta (val or absol uto
ou porcentagem).
8 - fsTagAttributeMinRecTime
Tempo mni mo para gravao (vari aes
menores que esse i nterval o so
desprezadas).
SUBTIPO DESCRIO
9 - fsTagAttributeMaxRecTime
Tempo mxi mo para gravao (a
ausnci a de vari ao nesses i nterval os
fora uma gravao).
Subtipos para funo CalculatedData (FunctionType = 6)
SUBTIPO DESCRIO
0 - fsTotalCalculatedData
Total dos val ores.
1 - fsMinimumCalculatedData
Val or mni mo.
2 - fsMaximumCalculatedData
Val or mxi mo.
3 - fsStandardCalculatedData
Desvi o padro.
4 - fsRangeCalculatedData
Ampl i tude dos val ores.
5 - fsMeanCalculatedData
Mdi a dos val ores.
6 - fsMedianCalculatedData
Medi ana dos val ores.
5.6.1.3.6 FunctionType
Esta propri edade vl i da quando um objeto Storage fonte da Consul ta (i sto
i ndi cado pel a propri edade DataSource). El a especi fi ca a funo que i r defi ni r os
dados gerados pel a Consul ta. Al gumas funes possuem subfunes, que podem
ser i ndi cadas na propri edade FunctionSubType. A propri edade FunctionType pode
assumi r os segui ntes val ores:
Opes disponveis para FunctionType
OPO DESCRIO
-1 - ftNoFunction
No h nenhuma funo defi ni da. Este
val or no est di sponvel quando a
propri edade QueryType est confi gurada
para o val or 1 - qtStorage.
0 - ftLastValue
Retorna o l ti mo val or armazenado na
Base de Dados.
1 - ftArchivedValue
Retorna um val or armazenado em
rel ao a um determi nado i nstante de
tempo defi ni do na vari vel TimeStamp.
O ti po de rel ao defi ni do na
propri edade FunctionSubType.
2 - ftTagAttribute
Devol ve um atri buto do Tag, defi ni do na
propri edade FunctionSubType.
3 - ftCompressedDataNValues
Retorna, para um ni co Tag, N val ores
defi ni dos na vari vel NumVals,
armazenados a parti r de um i nstante
i ni ci al , defi ni do na vari vel StartTime.
4 - ftCompressedDataStartEndTime
Retorna, para um ni co Tag, os val ores
armazenados que esto entre o i nterval o
defi ni do pel as vari vei s StartTime e
EndTime.
OPO DESCRIO
5 - ftSampledData
Retorna, para um ou mai s Tags, os
val ores i nterpol ados (ou seja,
esti mados) entre os i nstantes defi ni dos
pel as vari vei s StartTime e EndTime, a
i nterval os fi xos defi ni dos pel a vari vel
TimeInterval.
6 - ftCalculatedData
Retorna, para um ou mai s Tags, o
resul tado de operaes matemti cas
apl i cadas aos dados entre os i nstantes
defi ni dos pel as vari vei s StartTime e
EndTime, a i nterval os fi xos defi ni dos
pel a vari vel TimeInterval.
NOTA: As vari vei s tambm podem ser defi ni das em tempo de execuo a parti r da
chamada do mtodo SetVariableValue da Consul ta.
5.6.1.3.7 GroupBy
Texto correspondente ao argumento da cl usul a GROUP BY do cdi go SQL da
Consul ta. Esta propri edade somente de l ei tura, mas pode ser modi fi cada em
tempo de execuo.
5.6.1.3.8 Having
Texto correspondente ao argumento da cl usul a HAVING do cdi go SQL da
Consul ta. Esta propri edade normal mente uti l i zada com a propri edade GroupBy.
Esta propri edade somente de l ei tura, mas pode ser modi fi cada em tempo de
execuo.
5.6.1.3.9 IgnoreQuality
Permi te i ndi car se os dados com qual i dade rui m sero i ncl udos ou no no
resul tado da Consul ta. Esta propri edade s tem efei to se o objeto Consul ta esti ver
uti l i zando um Storage como fonte de dados. Esta propri edade pode ser modi fi cada
por scri pt em tempo de execuo.
5.6.1.3.10 OrderBy
Texto correspondente ao argumento da cl usul a ORDER BY do cdi go SQL da
Consul ta. Esta propri edade somente de l ei tura, mas pode ser modi fi cada em
tempo de execuo.
5.6.1.3.11 QueryType
Indi ca o ti po de consul ta a ser real i zada. Os val ores possvei s para esta
-1 - qtUndefined: O objeto Consul ta i ni ci al mente tentar executar a consul ta em
um objeto Banco de Dados. Se fal har, tentar execut-l a em um objeto Storage.
Este o val or padro para Consul tas cri adas no Studi o ou em tempo de execuo
0 - qtDBServer: O objeto Consul ta tentar executar a consul ta somente em um
objeto Banco de Dados
1 - qtStorage: O objeto Consul ta tentar executar a consul ta somente em um
objeto Storage
2 - qtOpcUa: O objeto Consul ta tentar executar a consul ta somente em um
objeto Dri ver de Comuni cao OPC UA
NOTAS:
No caso de mani pul ao de Consul tas em tempo de execuo, recomenda-se
confi gurar esta propri edade para o ti po desejado antes de efetuar as demai s
confi guraes do objeto, especi al mente no caso de reuti l i zao de um objeto
Consul ta para di ferentes fontes de dados.
Para apl i caes cri adas em verses anteri ores, ao abri r a apl i cao no Studi o
essa propri edade ser automati camente confi gurada para -1 - qtUndefined.
Os mtodos AddStorageTag e RemoveStorageTag fal haro se esta propri edade
esti ver confi gurada para 0 - qtDBServer.
A propri edade FunctionType no acei tar o val or -1 - ftNoFunction se esta
propri edade esti ver confi gurada para o val or 1 - qtStorage.
Os mtodos AddField, AddTable e RemoveTable fal haro se esta propri edade
esti ver confi gurada para o val or 1 - qtStorage.
Se esta propri edade esti ver confi gurada para -1 - qtUndefined, a tentati va de
executar a Consul ta em um objeto Storage (ao fal har a Consul ta em um objeto
Banco de Dados) fal har se a propri edade FunctionType esti ver confi gurada para -
1 - ftNoFunction ou se a propri edade FunctionSubType esti ver confi gurada para um
val or i nvl i do.
5.6.1.3.12 SQL
Contm o cdi go SQL especi fi cado para a Consul ta. Esta propri edade somente
para l ei tura, mas pode ser modi fi cada em tempo de execuo.
5.6.1.3.13 Table
A propri edade Table contm as tabel as que sero consul tadas (por exempl o,
Al arms a tabel a de al armes ou eventos). Corresponde ao argumento da cl usul a
FROM do cdi go SQL da Consul ta. Esta propri edade somente de l ei tura, mas pode
ser modi fi cada em tempo de execuo.
5.6.1.3.14 UaNamespaceArray
Esta propri edade retorna um objeto que uma Coleo de Namespaces OPC UA,
usada pel os campos confi gurados na Consul ta. Esta propri edade somente de
l ei tura.
5.6.1.3.15 UaQueryType
Esta uma propri edade de l ei tura e escri ta que permi te determi nar se a
Consul ta do ti po Dados Brutos (0: uqtRaw) ou do ti po Dados Processados (1:
uqtProcessed, val or padro). No Studi o esta propri edade somente de l ei tura. Em
tempo de execuo el a permi te confi gurar o ti po da consul ta OPC UA, mas s acei ta
escri tas se a propri edade QueryType esti ver confi gurada para OPC UA (val or i gual
a 2: qtOpcUa).
5.6.1.3.16 Where
Determi na a condi o da Consul ta que fi l tra os regi stros da tabel a a serem
vi sual i zados, ou seja, s sero vi sual i zados os regi stros que sati sfi zerem a
condi o. Corresponde ao argumento WHERE do cdi go SQL da Consul ta. Esta
propri edade somente de l ei tura, mas pode ser modi fi cada em tempo de execuo.
5.6.1.4 Coleo de Campos
Esta seo contm i nformaes sobre os mtodos e as propriedades do objeto
Col eo de Campos da Consul ta. Este objeto no possui eventos especfi cos.
5.6.1.4.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Col eo de Campos da
Consul ta.
5.6.1.4.1.1 Add
Add(NewItem)
Adi ci ona um novo objeto Campo da Consul ta na Col eo de Campos de uma
Consul ta, i ndi cado pel o parmetro NewItem.
5.6.1.4.1.2 Item
Item(Index)
Retorna um objeto Campo da Consul ta da Col eo de Campos. O parmetro Index
pode ser o ndi ce nmeri co deste Campo ou seu nome.
5.6.1.4.1.3 RefreshUaNodeIds
RefreshUaNodeIds()
Atual i za todos os Campos da Consul ta, buscando os Identi fi cadores de Ns OPC UA
(NodeIds) no servi dor e atual i zando a propri edade UaNodeId dos Campos da
Consul ta. Para que este mtodo funci one, as segui ntes condi es devem ser
atendi das:
A propri edade QueryType da Consul ta deve estar confi gurada para 2: qtOpcUa
A Consul ta deve apontar para um Dri ver de Comuni cao OPC UA vl i do
O Dri ver de Comuni cao OPC UA confi gurado na Consul ta deve estar ati vo e
conectado
5.6.1.4.1.4 Remove
Remove(Index)
Remove um objeto Campo da Consul ta da Col eo de Campos de uma Consul ta. O
parmetro Index pode ser tanto uma String com o nome do Campo da Consul ta
quanto o ndi ce deste objeto na Col eo de Campos.
Campos da Consul ta.
5.6.1.4.2.1 Count
Retorna o nmero de objetos Campo da Consul ta nesta Col eo. Esta propri edade
5.6.1.4.3 Campo da Consulta
Esta seo contm i nformaes sobre as propriedades do objeto Campo da
Consul ta. Este objeto no possui eventos nem mtodos especfi cos.
Esta seo contm i nformaes sobre as propri edades do objeto Campo da
Consul ta.
Alias
Apel i do do Campo na Consul ta.
ColumnName
Nome da col una. Este nome deve exi sti r nas tabel as adi ci onadas nesta Consul ta.
Criteria
Fi l tro que ser apl i cado sobre o Campo.
Function
Funo para a qual o Campo pode ser passado como parmetro.
GroupBy
Em Verdadei ro, i ndi ca que o Campo faz parte de um agrupamento.
OrderBy
Ordenao dos dados do Campo. Os val ores vl i dos so "ASC" (ordenao
ascendente), "DESC" (ordenao descendente) ou uma String vazi a (sem ordenao).
Qual quer val or di ferente si gni fi ca que o Campo no possui ordenao.
OrderNumber
Nmero de ordem do Campo em rel ao aos outros Campos que compem a
ordenao da Consul ta. Este val or s ser acei to como mai or que 0 (zero) se o
Campo ti ver um ti po de ordenao (defi ni do na propri edade OrderBy). Este val or
ter que ser menor ou i gual ao nmero de Campos que compem a ordenao da
Consul ta.
TableName
Nome da tabel a a que pertence o Campo. Esta tabel a deve ter si do adi ci onada na
confi gurao da Consul ta.
UaNodeId
Retorna um objeto do ti po Identificador de N OPC UA, com a confi gurao do
N que i denti fi ca um campo de uma consul ta OPC UA em um determi nado servi dor
OPC UA. No Studi o esta propri edade apenas representada por um cone, na
col una Id da confi gurao de campos da Consul ta.
Visible
Em Verdadei ro, i ndi ca que o Campo est vi svel .
5.6.1.5 Coleo de Namespaces OPC UA
de Namespaces OPC UA (UaNamespaceArray). Este objeto no possui eventos
especfi cos.
5.6.1.5.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Col eo de
Namespaces OPC UA.
5.6.1.5.1.1 Add
Add(Item)
Adi ci ona um i denti fi cador de Namespace, sempre ao fi nal da Col eo. O
parmetro Item uma String que defi ne o Namespace. Este parmetro no pode ser
vazi o.
5.6.1.5.1.2 Item
Item(Index)
Retorna o i denti fi cador de Namespace do ndi ce especi fi cado. O parmetro Index
deve ser um LONG vari ando entre 0 (zero) e Count menos 1 (um).
5.6.1.5.1.3 Remove
Remove(Index)
Remove o Namespace do ndi ce especi fi cado. Note que i sto i mpl i ca em mudar os
ndi ces dos Namespaces de ndi ce superi or ao removi do. No possvel remover os
ndi ces 0 (zero) e 1 (um). O parmetro Index um val or (LONG) que i denti fi ca o
Namespace que se deseja remover da Col eo, vari ando entre 2 (doi s) e Count
menos 1 (um).
Namespaces OPC UA.
5.6.1.5.2.1 Count
Retorna o total de Namespaces da col eo. O val or mni mo desta propri edade
sempre 2 (doi s), j que os ndi ces 0 e 1 esto sempre presentes.
5.6.1.5.3 Identificador de N OPC UA
Esta seo contm i nformaes sobre propriedades do objeto Identi fi cador de N
OPC UA (E3UaNodeId). Este objeto no possui eventos nem mtodos especfi cos.
Esta seo contm i nformaes sobre as propri edades do objeto Identi fi cador de
N OPC UA.
GUID
Propri edade de l ei tura e escri ta que i denti fi ca este objeto, caso a propri edade
Type seja i gual a 2: nitGUID. Se a propri edade Type for di ferente de 2 (doi s), a
l ei tura desta propri edade retorna erro. J a escri ta nesta propri edade fora sempre
com que a propri edade Type seja modi fi cada para 2 (doi s). O val or desta
propri edade uma String do ti po GUID (Globally Unique Identifier, ou Identi fi cador
ni co Gl obal ), um val or de 128 bi ts. Caso esta propri edade seja confi gurada com o
val or "{00000000-0000-0000-0000-000000000000}", este objeto ser i denti fi cado
como Null.
NamespaceIndex
Propri edade de l ei tura e escri ta que i denti fi ca a qual Namespace se refere este
Identi fi cador. Este ndi ce deve estar entre 0 (zero) e o nmero de Namespaces
menos 1 (um) que o servi dor possui r. No caso da defi ni o do campo na Consul ta,
o ndi ce se refere Coleo de Namespaces OPC UA defi ni da no objeto Consul ta
(que em um dado momento pode ser di ferente da Col eo de Namespaces do
servi dor). Seu val or nunca pode ser mai or que 65535, poi s o padro OPC UA defi ne
que este um val or de 16 bi ts.
Numeric
Type seja i gual a 0: nitNumeric. Se a propri edade Type for di ferente de 0 (zero), a
l ei tura desta propri edade retorna erro. J a escri ta nesta propri edade fora sempre
com que a propri edade Type seja modi fi cada para 0 (zero). Um val or 0 (zero) nesta
propri edade i denti fi ca este objeto como Null.
Opaque
Type seja i gual a 3: nitOpaque. O val or desta propri edade um vetor de bytes, ou
seja, uma String de caracteres no necessari amente vl i dos ou i mpri mvei s. Se a
propri edade Type for di ferente de 3 (trs), a l ei tura desta propri edade retorna erro.
J a escri ta nesta propri edade fora sempre com que a propri edade Type seja
modi fi cada para 3 (trs). Uma String vazi a nesta propri edade i denti fi ca este objeto
como Null.
String
Type seja i gual a 1: nitString. Se a propri edade Type for di ferente de 1 (um), a
l ei tura desta propri edade retorna erro. J a escri ta na propri edade fora sempre
com que a propri edade Type seja modi fi cada para 1 (um). Uma String vazi a nesta
propri edade i denti fi ca este objeto como Null.
Type
Propri edade de l ei tura e escri ta que determi na qual o ti po de i denti fi cador este
objeto uti l i za. Os val ores possvei s para esta propri edade so os segui ntes:
0 - nitNumeric: O i denti fi cador um nmero (LONG)
1 - nitString: O i denti fi cador uma String
2 - nitGUID: O i denti fi cador uma String do ti po GUID (Globally Unique Identifier)
3 - nitOpaque: O i denti fi cador um vetor de bytes
Sempre que esta propri edade modi fi cada, o val or do i denti fi cador forado para
Null.
5.6.2 Pasta de Dados
O objeto Pasta de Dados no contm eventos, mtodos ou propri edades
especfi cos, somente gerai s. Estes podem ser vi sual i zados na seo Eventos,
Mtodos e Propriedades Gerais dos Objetos.
5.6.3 Tag Contador
Esta seo contm i nformaes sobre eventos e propriedades do objeto Tag
Contador. Este objeto no possui mtodos associ ados.
5.6.3.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Tag Contador.
5.6.3.1.1 OnPreset
OnPreset()
Ocorre toda vez que o val or da propri edade Preset al canado.
Esta seo contm i nformaes sobre as propri edades do objeto Tag Contador.
5.6.3.2.1 AutoRestart
Indi ca que a contagem deve ser recomeada do zero aps ter si do ati ngi do o
val or estabel eci do na propri edade Preset. Esta propri edade somente vl i da
quando a propri edade CounterType est confi gurada com o val or 0 - Preset.
5.6.3.2.2 CounterType
Defi ne o comportamento do contador. Os val ores di sponvei s para esta
propri edade so:
0 - Preset: a contagem i nterrompi da quando o val or estabel eci do na
propri edade Preset ati ngi do
1 - Infinite: a contagem prossegue i ndefi ni damente
5.6.3.2.3 Enabled
Ini ci a ou para o contador. Em True, a contagem i ni ci ada; em Fal se, el a
i nterrompi da.
5.6.3.2.4 Increment
Defi ne o i nterval o de atual i zao da propri edade Value. Caso esta propri edade
tenha seu val or modi fi cado enquanto a contagem esti ver em curso, esta
modi fi cao s ter efei to quando o contador for parado e rei ni ci ado.
5.6.3.2.5 Preset
Li mi te a ser ati ngi do pel o contador, em segundos. Caso o val or de Preset no seja
um ml ti pl o de Increment, o Tag i r ati ngi r este val or antes do prxi mo
i ncremento.
5.6.3.2.6 ResetCounterWhenEnabled
Habi l i ta o rei nci o da contagem (do zero) cada vez que o val or da propri edade
Enabled retorna a True. Quando desabi l i tada, o contador rei ni ci a a contagem de
onde el a foi i nterrompi da anteri ormente.
5.6.3.2.7 Value
Mostra a contagem do contador, em segundos. Propri edade somente de l ei tura.
Essa propri edade recebe val ores ml ti pl os de Increment, exceto quando a
propri edade Enabled ajustada para Fal se. Nesse caso, o val or ser o do momento
em que o Tag foi desabi l i tado. Ao rei ni ci ar a contagem, o val or da propri edade ser
o prxi mo ml ti pl o de Increment. O val or mxi mo dessa propri edade
2147483647 (0x7FFFFFFF).
5.6.4 Tag Demo
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Tag Demo.
5.6.4.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Tag Demo.
5.6.4.1.1 Reset
Reset()
Zera a fase (desl ocamento em tempo) da forma de onda do Tag. A fase da onda
somente ser zerada quando o Tag esti ver habi l i tado. Este mtodo, quando o Tag
esti ver habi l i tado, no tem efei to nos Tags do ti po CurrentTime e Random, que no
so peri di cos. Quando o Tag esti ver desabi l i tado, seu val or si mpl esmente
zerado, i ndependentemente do ti po de Tag.
Esta seo contm i nformaes sobre as propri edades do objeto Tag Demo.
5.6.4.2.1 Enabled
A propri edade Enabled habi l i ta ou desabi l i ta a vari ao do Tag Demo. Se Enabled
esti ver confi gurado para Fal se, a vari ao estar desabi l i tada. Caso contrri o, o
Tag atual i zar a propri edade Value conforme a confi gurao das propri edades
Period e Scan. O val or padro desta propri edade True.
5.6.4.2.2 Maximum
A propri edade Maximum determi na o val or mxi mo do Tag. O val or padro desta
' 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 propri edade Minimum determi na o val or mni mo do Tag. O val or padro desta
' 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
Defi ne o compri mento da forma de onda, em mi l i ssegundos. No se apl i ca
quando a propri edade Type esti ver confi gurada para 0 - Random ou 3 -
CurrentTime. O val or padro desta propri edade 10000 ms. Exempl o:
Sub TagDemo1_OnStartRunning()
Period = 1000
End Sub
5.6.4.2.5 Scan
A propri edade Scan defi ne o i nterval o de tempo, em mi l i ssegundos, entre duas
vari aes da propri edade Value. Uti l i ze esta propri edade se voc desejar mai or ou
menor quanti dade de dados gerados pel o Tag Demo. O val or padro desta
propri edade 1000. O val or do scan deve ser mai or que 0. Exempl o:
Sub Linha1_Click()
Application.GetObject("Dados.TagDemo2").Scan = 200
End Sub
5.6.4.2.6 TimeStamp
val or ou estado nas propri edades Value ou Quality. El a i nforma qual a data e hora
associ ada tanto ao val or quanto qual i dade do Tag Demo. Esta uma propri edade
somente para l ei tura. O val or padro desta propri edade 00:00:00.
5.6.4.2.7 Type
Determi na o ti po de onda do Tag. Modi fi que a propri edade conforme a tabel a a
segui r. Quando a propri edade Type esti ver confi gurado para 3 (CurrentTime), a
propri edade Value i r conter a data e hora atual do servi dor.
VALOR FORMA DE ONDA
0
Random (al eatri a)
1
Si ne (onda seni de)
2
Square (onda quadrada)
3
CurrentTi me (data e hora)
4
RampUp (borda de subi da)
5
RampDown (borda de desci da)
6
RampUpDown (borda de subi da e
desci da)
Exempl o:
Sub Linha1_Click()
Application.GetObject("Dados.TagDemo2").Type = 2
End Sub
5.6.4.2.8 Value
A propri edade Value vari a de acordo com o ti po da forma de onda, estabel eci da
na propri edade Type. Esta uma propri edade apenas de l ei tura. O val or padro
Sub Figura1_Click()
MsgBox Application.GetObject("Dados.TagDemo2").Value = 10
End Sub
5.6.5 Tag Interno
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Tag
Interno. Este objeto no possui eventos associ ados.
5.6.5.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Tag Interno.
5.6.5.1.1 WriteEx
WriteEx([NewValue[, NewTimestamp[, NewQuality]]])
Permi te modi fi car o val or, a data e hora e a qual i dade de um Tag Interno em uma
ni ca operao. Este mtodo retorna um Bool eano que i ndi ca o sucesso ou no da
operao.
O parmetro NewValue especi fi ca o novo val or do Tag; se omi ti do, o val or do Tag
no modi fi cado. O parmetro NewTimestamp especi fi ca a nova data e hora do
Tag; se omi ti do, uti l i za-se a data e hora do momento da chamada do mtodo. O
parmetro NewQuality especi fi ca a nova qual i dade do Tag; se omi ti da, ser
assumi da a qual i dade Boa (192). Todos estes parmetros podem ser omi ti dos.
Exempl o:
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
Esta seo contm i nformaes sobre as propri edades do objeto Tag Interno.
5.6.5.2.1 Quality
Informa a qual i dade do val or conti do na propri edade Value. Esta propri edade
de l ei tura e escri ta, mas sempre que o val or do Tag Interno for modi fi cado, seja por
scri pt ou por uma Associ ao, el a ser atual i zada de acordo. Exempl o:
MsgBox Application.GetObject("Dados.TagInterno1").Quality
End Sub
5.6.5.2.2 Retentive
A propri edade Retentive determi na se o val or do Tag Interno deve ser
armazenado automati camente, caso o Domni o seja parado. Se esta propri edade
esti ver confi gurada para True, o val or do Tag Interno ser armazenado
automati camente, no caso de troca de servi dor do Domni o ati vo. Isso garante que
o val or do Tag ser si ncroni zado com um servi dor standby. Assi m, quando o
servi dor for executado, o val or do Tag ser o mesmo do servi dor que parou. Caso
contrri o, o val or do Tag ser ajustado para o val or i ni ci al sempre que o Domni o
for executado ou ocorrer troca do servi dor ati vo. Esta propri edade no tem efei to
se for al terada em tempo de execuo. Exempl o:
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: Esta propri edade s vl i da para Tags I nternos conti dos no Servi dor. Tags
I nternos conti dos no Vi ewer no podem ser retenti vos.
5.6.5.2.3 TimeStamp
A propri edade TimeStamp i nforma a data e hora associ ada ao val or conti do na
propri edade Value. Esta propri edade de l ei tura e escri ta, mas sempre que o val or
do Tag Interno for modi fi cado, seja por scri pt ou por uma Associ ao, el a ser
atual i zada de acordo.
5.6.5.2.4 Value
A propri edade Value do ti po Variant, o que permi te armazenar val ores de todo e
qual quer ti po, desde um i ntei ro at refernci as para objetos (veja o exempl o a
segui r). Uti l i ze-o para guardar val ores dentro do Vi ewer ou Servi dor e para trocar
dados entre os di versos pontos da apl i cao. O val or padro desta propri edade
vazi o. Esta propri edade de l ei tura e escri ta. Exempl o:
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 i nformaes sobre eventos e propriedades do objeto Tag Ti mer.
5.6.6.1 Eventos
Esta seo contm i nformaes sobre os eventos do objeto Tag Ti mer.
5.6.6.1.1 OnPreset
OnPreset()
Ocorre toda vez que o val or da propri edade NextExecTime al canado.
Esta seo contm i nformaes sobre as propri edades do objeto Tag Ti mer.
5.6.6.2.1 Enabled
Habi l i ta ou desabi l i ta o Ti mer. O val or padro desta propri edade True.
5.6.6.2.2 NextExecTime
Exi be o prxi mo horri o de di sparo. uma propri edade somente de l ei tura.
5.6.6.2.3 RepeatInterval
uti l i zada sempre que o Tag for do ti po Contnuo. O val or padro desta
propri edade 00:00:01.
5.6.6.2.4 StartTime
Data e hora i ni ci al do Ti mer. Para o ti po Single, a prpri a data e hora de
di sparo. Para os demai s, o momento a parti r do qual o Ti mer comea a di sparar.
O val or padro o di a e a hora l ocai s.
5.6.6.2.5 TriggerType
Ti po de di sparo do Ti mer. As opes di sponvei s so:
Opes disponveis para TriggerType
OPO DESCRIO
0 - ttSingle
Di sparo ni co.
1 - ttContinuous
Di sparo contnuo.
2 - ttDaily
Di sparo di ri o.
3 - ttMonthly
Di sparo mensal .
5.7 Banco de Dados
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Banco de
Dados. Este objeto no possui eventos associ ados.
5.7.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Banco de Dados.
5.7.1.1 SetDBParameters
SetDBParameters(ServerName, UserName, Password, DBName)
String de conexo com o DB nas propri edades do objeto Banco de Dados. O
parmetro ServerName determi na o nome do servi dor. O parmetro UserName
determi na o nome do usuri o. O parmetro Password determi na a senha do l ogi n
para se conectar ao banco de dados. O parmetro DBName o nome do banco de
dados uti l i zado no SQL Server. Para os demai s bancos de dados, esse parmetro
no uti l i zado.
5.7.2 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Banco de Dados.
5.7.2.1 ConnectionActive
Mostra o status da conexo pri nci pal do Banco de Dados. Se a conexo esti ver
ati va, a propri edade tem o val or True. Caso contrri o, tem o val or Fal se.
5.7.2.2 EnableLocalCreation
Defi ne se o Vi ewer cri ar a conexo do Banco de Dados l ocal mente ou no. A
conexo l ocal ser uti l i zada somente para a cri ao de Consul tas. Se a
propri edade esti ver habi l i tada (True), o Vi ewer tenta cri ar a conexo l ocal mente, e
se i sso no for possvel , busca a Consul ta pedi da no servi dor. O val or padro desta
5.7.2.3 EnableSynchronization
Indi ca ao E3, se habi l i tada (True), que el e tambm deve fazer a gravao dos
dados em uma segunda base de dados si mul taneamente, para permi ti r uma mai or
segurana. Se a propri edade esti ver habi l i tada e houver um servi dor StandBy, o E3
faz a si ncroni zao entre os bancos de dados dos doi s servi dores. O val or padro
desta propri edade Fal se, ou seja, a si ncroni a est desabi l i tada.
5.7.2.4 NetLibrary
Confi gura o ti po de bi bl i oteca de rede do Banco de Dados. As opes di sponvei s
so:
Opes disponveis para NetLibrary
OPO DESCRIO
0 - Default
Bi bl i oteca do ti po padro.
1 - NamedPipes
Bi bl i oteca do ti po Named Pi pes.
2 - TcpIp
Bi bl i oteca do ti po Wi nsock TCP/I P.
3 - SpxIpx
Bi bl i oteca do ti po SPX/I PX.
4 - BanyanVines
Bi bl i oteca do ti po Banyan Vi nes.
5 - MultiProtocol
Bi bl i oteca do ti po Mul ti -protocol o (RPC).
NOTA: a propri edade NetLibrary somente est di sponvel no Banco de Dados do
ti po SQL Server.
5.7.2.5 nRetries
Esta propri edade especi fi ca o nmero de vezes que o E3 tentar executar uma
operao de banco de dados, al m da pri mei ra tentati va. O val or padro desta
propri edade 5. Se o val or desta propri edade for i gual a 0 (zero), ser fei ta apenas
uma tentati va por operao. Caso haja uma perda de conexo com o banco de
dados durante qual quer uma das tentati vas, a operao abortada e as tentati vas
restantes so desconsi deradas.
5.7.2.6 ReconnectDelay
A propri edade ReconnectDelay determi na o tempo de espera (em mi l i ssegundos)
para o si stema fazer uma tentati va de restabel ecer uma conexo perdi da com o
banco de dados. O val or padro desta propri edade 2000 (2 segundos).
5.7.2.7 SourceDatabase
Caso o Banco de Dados seja do ti po Access, este o nome do arqui vo .mdb. Caso
o Banco de Dados seja do ti po SQL Server, este o nome do servi dor SQL
concatenado com o banco de dados escol hi do, no formato Servi dor/Banco de
Dados. Caso o Banco de Dados seja do ti po Oracle, este o nome da conexo
cri ada. Esta propri edade somente para l ei tura.
5.7.2.8 SourceType
Indi ca o banco de dados uti l i zado pel o objeto. As opes di sponvei s so:
0 - stAccess: Banco de dados Access
1 - stOracle: Banco de dados Oracl e
2 - stSqlServer: Banco de dados SQL Server
5.7.2.9 TimeOutCommand
Contm o tempo de espera para qual quer operao do banco de dados, antes que
o si stema gere um erro por timeout. O val or padro 180 (3 mi nutos).
5.7.2.10 TimeOutConnection
Contm o tempo de espera pel a real i zao da conexo com o banco de dados,
antes que o si stema gere um erro por timeout. O val or padro 15 segundos.
5.7.2.11 TotalFailedWrites
Contm o nmero total de erros em operaes de banco de dados que
aconteceram at o momento.
5.7.2.12 UserName
Logi n uti l i zado para se conectar ao banco de dados. Esta propri edade somente
para l ei tura.
5.7.2.13 UseTransaction
Defi ne se o Servi dor de Banco de Dados i r uti l i zar as transaes do banco de
dados ou no. Se True, cada bl oco de operaes (200 operaes) de banco de
dados (operaes do Hi stri co, Storage, Formul as e Al armes) sero executadas de
uma vez s, ou seja, em uma transao.
5.8 Histricos
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Hi stri co.
5.8.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Hi stri co.
5.8.1.1 StartAcquisition
StartAcquisition()
Habi l i ta o Hi stri co a gravar os val ores do seus campos peri odi camente, a parti r
da taxa especi fi cada na propri edade ScanTime. Este mtodo pode ser chamado a
qual quer momento aps a chamada do mtodo StopAcquisition. O comportamento
padro deste mtodo i ni ci ar a apl i cao habi l i tado, ou seja, este mtodo
sempre executado i nternamente ao se i ni ci ar o Hi stri co. Exempl o:
Sub Botao1_Click()
' Quando clica no boto, habilita o histrico.
Application.GetObject("Hist1").StartAcquisition()
End Sub
5.8.1.2 StopAcquisition
StopAcquisition()
Desabi l i ta a gravao dos regi stros por perodo no Hi stri co, i ndependente do
val or especi fi cado na propri edade ScanTime. A gravao por perodo fi ca
desabi l i tada at o mtodo StartAcquisition ser chamado. O comportamento padro
do objeto Hi stri co i ni ci ar a apl i cao com a gravao habi l i tada. Exempl o:
Sub Hist1_OnStartRunning()
' Desabilita o Histrico assim que iniciar.
StopAcquisition()
End Sub
5.8.1.3 WriteRecord
WriteRecord()
Insere uma nova l i nha de i nformao no banco de dados. Os val ores so obti dos a
parti r dos val ores atuai s de cada uma das vari vei s especi fi cadas como fontes de
dados dos campos do Hi stri co. Uti l i za-se este mtodo em duas si tuaes:
Para gravar uma nova l i nha de dados antes do tempo previ sto para a prxi ma
gravao quando o Hi stri co est habi l i tado por tempo
Para gravar um novo conjunto de dados quando o Hi stri co est desabi l i tado
Exempl o:
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 i nformaes sobre as propri edades do objeto Hi stri co.
5.8.2.1 BackupDiscardInterval
Indi ca a quanti dade de uni dades de tempo durante a qual os dados de backup
sero manti dos na tabel a pri nci pal e na tabel a de backup, at serem descartados
(por exempl o, para manter os dados por 24 meses na tabel a pri nci pal , e mai s sei s
meses na tabel a de backup, o val or da propri edade deve ser de 30 meses). Esta
propri edade trabal ha em conjunto com a propri edade BackupDiscardTimeUnit. O
val or padro desta propri edade 12 (doze uni dades de tempo i ndi cadas em
BackupDiscardTimeUnit).
NOTA: O tempo total i ndi cado pel a combi nao das propri edades
BackupDiscardInterval e BackupDiscardTimeUnit deve ser mai or que o tempo i ndi cado
pel as propri edades DiscardInterval e DiscardTimeUnit.
5.8.2.2 BackupDiscardTimeUnit
A propri edade BackupDiscardTimeUnit i ndi ca a uni dade de tempo em que os
dados de backup fi caro armazenados at serem descartados. As opes
di sponvei s so:
0 - dtHour: horas
1 - dtDay: di as
2 - dtMonth: meses (padro)
3 - dtMinute: mi nutos
Esta propri edade trabal ha em conjunto com a propri edade BackupDiscardInterval.
5.8.2.3 CacheSize
Defi ne o tamanho do bl oco de regi stros que deve ser l i do pel o Hi stri co antes de
ser envi ado para o banco de dados. Por exempl o, se CacheSize i gual a 4, sero
envi ados bl ocos contendo quatro regi stros cada um para o objeto Banco de Dados
associ ado. Os val ores vl i dos para esta propri edade devem estar no i nterval o
entre 1 e 4. O val or padro desta propri edade 1.
NOTA: O bl oco de regi stros envi ado a cada 1 segundo, mesmo que no tenha
ati ngi do o tamanho confi gurado na propri edade CacheSize.
5.8.2.4 CompressedTable
Habi l i ta o uso de banda morta para a gravao de dados. O val or padro desta
5.8.2.5 DBServer
Indi ca o objeto Banco de Dados uti l i zado no Hi stri co para cri ao de tabel as e
regi stros de dados. O val or padro desta propri edade uma String vazi a.
5.8.2.6 DeadBand
Esta propri edade trabal ha em conjunto com a propri edade CompressedTable.
Indi ca o val or cal cul ado sobre o l ti mo val or gravado (em percentagem) que defi ne
se este novo val or ser gravado. Se o val or gravado no for numri co, sua
modi fi cao faz com que todos os val ores sejam gravados.
5.8.2.7 DiscardInterval
Esta propri edade trabal ha em conjunto com a propri edade DiscardTimeUnit. A
propri edade DiscardInterval i ndi ca o i nterval o de tempo durante o qual os dados do
Hi stri co fi caro armazenados na tabel a do banco de dados, at serem
descartados. O val or padro desta propri edade 1 (uma uni dade de tempo
i ndi cada em DiscardTimeUnit). Se esta propri edade for confi gurada com um val or
menor ou i gual ao val or da propri edade BackupDiscardInterval, o E3
automati camente ajusta o val or de BackupDiscardInterval como o dobro do val or
de DiscardInterval. Esta propri edade pode ser modi fi cada em tempo de execuo.
5.8.2.8 DiscardTimeUnit
Esta propri edade trabal ha em conjunto com a propri edade DiscardInterval. A
propri edade DiscardTimeUnit i ndi ca a uni dade de tempo em que os dados da tabel a
fi caro armazenados at serem descartados. As opes di sponvei s so:
0 - dtHour: horas
1 - dtDay: di as
5.8.2.9 EnableBackupTable
Cri a uma tabel a de backup onde os dados descartados permanecero por
segurana. Se confi gurada para True, a tabel a ser cri ada; do contrri o, no
haver tabel a de backup. O val or padro desta propri edade Fal se.
5.8.2.10 EnableDiscard
Indi ca descarte dos dados do Hi stri co aps um certo tempo. Se confi gurada
para Fal se, os dados sero armazenados i ndefi ni damente na tabel a; do contrri o,
sero descartados aps determi nado tempo. O val or padro dessa propri edade
Fal se.
5.8.2.11 EnableQualityLogs
Quando em True, ao i ni ci ar o Hi stri co o E3 gera um regi stro i gual ao pri mei ro
regi stro col etado mas com qual i dade rui m (0) e timestamp de um segundo antes.
5.8.2.12 ScanTime
Defi ne a vari ao de i nterval o do tempo, em mi l i ssegundos, que o Hi stri co i r
esperar para executar a aqui si o e gravao de um novo regi stro na tabel a. Uti l i ze
esta propri edade se houver necessi dade de mai or ou menor quanti dade de dados
gerados por segundo. O val or padro desta propri edade 1000.
5.8.2.13 TableName
Defi ne o nome da tabel a que ser uti l i zada no Hi stri co.
5.8.2.14 UserTable
Quando esta propri edade est confi gurada para True, i denti fi ca que o Hi stri co
do usuri o, ou seja, os dados da tabel a foram i mportados do banco de dados. Caso
contrri o, um Hi stri co normal do E3. Esta propri edade apenas de l ei tura.
5.8.2.15 UseTagQuality
Se for True, o Hi stri co vai usar o val or de qual i dade da fonte do Tag; caso
contrri o, ser uti l i zado o mtodo anti go de aval i ao (0: val or duvi doso; 1: val or
bom).
5.8.2.16 VerificationInterval
Esta propri edade trabal ha em conjunto com a propri edade VerificationUnit para
control ar o i nterval o de tempo que o E3 veri fi ca a anti gui dade dos dados, para
depoi s descart-l os. O val or padro desta propri edade 1 (uma uni dade de tempo
i ndi cada em VerificationUnit).
5.8.2.17 VerificationUnit
Esta propri edade trabal ha em conjunto com a propri edade VerificationInterval.
A propri edade VerificationUnit i ndi ca a uni dade de tempo em que ser fei ta a
veri fi cao para descarte dos dados. As opes di sponvei s so:
0 - dtHour: horas
1 - dtDay: di as
5.9 Storage
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Storage.
5.9.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Storage.
5.9.1.1 CreateNewSession
CreateNewSession([DefaultType[, DefaultMinRecTime[, DefaultMaxRecTime[,
DefaultDeadBand[, DefaultDeadBandUnit[, DefaultScanTime]]]]]])
Cri a uma Sesso com a capaci dade de i ncl ui r dados em um Storage, de forma
i ndependente da aqui si o normal . Os parmetros opci onai s so uti l i zados nas
confi guraes dos Tags da Sesso, caso no i nformados em sua cri ao. So el es,
respecti vamente:
DefaultType: Ti po de dado (0: Double, 1: Bit, 2: String, ou 3: Integer). Se nenhum
val or for i nformado, ser uti l i zado o val or 0 (Double).
DefaultMinRecTime: Interval o mni mo de tempo entre gravaes. Se nenhum val or
for i nformado, ser uti l i zado o val or 0 (zero)
DefaultMaxRecTime: Interval o mxi mo de tempo sem gravaes. Se nenhum val or
for i nformado, ser uti l i zado o val or 3600
DefaultDeadBand: Banda morta. Se nenhum val or for i nformado, ser uti l i zado o
val or 1 (um)
DefaultDeadBandUnit: Uni dade da banda morta do Tag (0: Porcentagem ou 1:
Absoluta). Se nenhum val or for i nformado, ser uti l i zado o val or 1 (Absoluta)
DefaultScanTime: Tempo de varredura. Se nenhum val or for i nformado, ser
uti l i zado o val or 0 (zero)
Este mtodo i r funci onar mesmo que o objeto Storage no tenha nenhum campo
confi gurado.
5.9.1.2 StartAcquisition
StartAcquisition()
Ini ci a ou retoma a gerao de dados que vo para o Banco de Dados. O Storage
recebe noti fi caes sobre quai s Tags cadastrados sofreram modi fi cao, e quando
i sto acontece el e veri fi ca se os regi stros sero gravados ou no. Quando este
mtodo chamado, a noti fi cao de mudana e a gerao de gravaes sero
i ni ci adas ou retomadas. Exempl o:
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
noti fi caes sobre quai s Tags cadastrados sofreram modi fi cao, e quando i sto
acontece el e veri fi ca se os regi stros sero gravados ou no. Quando este mtodo
chamado, a noti fi cao de mudana e a gerao de gravaes so paral i sadas.
Exempl o:
Sub Storage1_OnStartRunning()
' Desabilita o Storage assim que iniciar
StopAcquisition()
End Sub
5.9.2 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Storage.
5.9.2.1 BackupDiscardInterval
Indi ca a quanti dade de uni dades de tempo durante as quai s os dados de backup
sero manti dos na tabel a pri nci pal e na tabel a de backup, at serem descartados
5.9.2.2 BackupDiscardTimeUnit
dados de backup fi caro armazenados, at serem descartados. As opes
di sponvei s so:
0 - dtHour: horas
1 - dtDay: di as
5.9.2.3 CacheSize
Defi ne o tamanho do bl oco de regi stros que deve ser l i do pel o Storage antes de
ser envi ado para o banco de dados. Por exempl o, se CacheSize i gual a 4, sero
envi ados bl ocos contendo quatro regi stros cada um para o objeto Banco de Dados
associ ado. O val or padro desta propri edade 10.
NOTA: O bl oco de regi stros envi ado a cada 1 segundo, mesmo que no tenha
ati ngi do o tamanho confi gurado na propri edade CacheSize.
5.9.2.4 CompressionRate
Mostra a taxa de compresso de dados obti da at o momento.
5.9.2.5 DBServer
Indi ca o objeto Banco de Dados uti l i zado no Storage para cri ao de tabel as e
regi stros de dados. O val or padro desta propri edade uma String vazi a.
5.9.2.6 DiscardInterval
Hi stri co fi caro armazenados na tabel a do banco de dados, at serem
automati camente ajusta o val or de BackupDiscardInterval com o dobro do val or de
DiscardInterval. Esta propri edade pode ser modi fi cada em tempo de execuo.
5.9.2.7 DiscardTimeUnit
propri edade DiscardTimeUnit i ndi ca a uni dade de tempo em que os dados fi caro
armazenados at serem descartados. As opes di sponvei s so:
0 - dtHour: horas
1 - dtDay: di as
5.9.2.8 EnableBackupTable
Cri a uma tabel a de backup onde os dados descartados permanecero por
segurana. Se confi gurada para True, a tabel a ser cri ada; do contrri o, no
haver tabel a de backup. O val or padro desta propri edade Fal se.
5.9.2.9 EnableDiscard
Habi l i ta o descarte dos dados aps um determi nado tempo. Se confi gurada para
Fal se, os dados sero armazenados i ndefi ni damente na tabel a; do contrri o, sero
descartados aps determi nado tempo. O val or padro dessa propri edade Fal se.
5.9.2.10 Fields
Col eo que aponta para os Campos cri ados no Storage. Para cada Campo
possvel vi sual i zar as propri edades Name e Link, e modi fi car as propri edades Type,
MinRecTime, MaxRecTime, DeadBand, ScanTime e DeadBandUnit.
5.9.2.11 StringFieldSize
Esta propri edade especi fi ca o tamanho mxi mo que os campos do ti po String do
objeto Storage podero ter (ser o tamanho uti l i zado na cri ao do campo Value
da tabel a de Strings).
5.9.2.12 TableName
Defi ne o nome da tabel a que ser uti l i zada no Storage.
5.9.2.13 VerificationInterval
5.9.2.14 VerificationUnit
Esta propri edade trabal ha em conjunto com a propri edade VerificationInterval.
A propri edade VerificationUnit i ndi ca a uni dade de tempo em que ser fei ta a
0 - dtHour: horas
1 - dtDay: di as
5.9.3 Campo do Storage
Esta seo contm i nformaes sobre propriedades do objeto Campo do Storage.
Esta seo contm i nformaes sobre as propri edades do objeto Campo do Storage.
5.9.3.1.1 DeadBand
Banda morta uti l i zada para cl cul o do al gori tmo do Storage. Indi ca a preci so
que o usuri o est di sposto a perder em cada Campo a ser armazenado. Quanto
mai or o val or da propri edade DeadBand, mai s compacto ser o banco de dados
(menos dados sero gravados). Este val or pode ser especi fi cado em uni dades
absol utas ou como um percentual do val or atual do Tag, conforme confi gurado na
propri edade DeadBandUnit.
5.9.3.1.2 DeadBandUnit
Uni dade da propri edade DeadBand. Pode ser especi fi cado em uni dades absol utas
ou como um percentual do val or atual do Tag.
5.9.3.1.3 Link
Determi na a fonte de dados que ser associ ada ao Campo. Propri edade apenas
de l ei tura.
5.9.3.1.4 MaxRecTime
Di ferena mxi ma, em segundos, entre os timestamps de doi s regi stros
consecuti vos armazenados no banco de dados, i sto , o tempo mxi mo sem que
nenhum dado seja gravado. Por exempl o, se um Tag no esti ver vari ando de val or,
mesmo assi m o val or atual deve ser escri to no banco de dados sempre que o
nmero de segundos confi gurado em MaxRecTime for ati ngi do. Este comportamento
pode ser desabi l i tado col ocando-se o val or 0 (zero).
5.9.3.1.5 MinRecTime
Di ferena mni ma, em mi l i ssegundos, entre os timestamps de doi s regi stros
quai squer de mesma qual i dade armazenados no banco de dados, i sto , o tempo
mni mo para que um novo dado seja gravado. Este parmetro serve para l i mi tar o
nmero de regi stros escri tos em um banco de dados, no caso de um Tag sofrer
vari aes bruscas de val or. Este comportamento pode ser desabi l i tado col ocando-
se o val or 0 (zero).
5.9.3.1.6 Name
Propri edade que retorna o nome confi gurado para este Campo no objeto Storage.
Atravs del e, possvel buscar i tens na col eo.
5.9.3.1.7 ScanTime
Retorna ou confi gura o tempo de varredura (em mi l i ssegundos) do Campo, ou
seja, de quanto em quanto tempo o val or do Tag ser real i mentado no al gori tmo de
compactao de dados, caso no esteja vari ando. Se o val or desta propri edade for
i gual a 0 (zero), o val or da propri edade MaxRecTime ser uti l i zado para este
mesmo propsi to.
5.9.3.1.8 Type
Retorna o ti po do objeto no formato do Storage (0: Double, 1: Bit, 2: String, 3:
Integer). Esta propri edade de l ei tura e escri ta, mas s acei ta mudanas enquanto
a col eta de dados para este Campo ai nda no comeou.
NOTA: Os ti pos de dados Bit, String e Integer no so submeti dos ao al gori tmo de
compactao do Storage. Portanto, sempre que h uma vari ao no val or ou na
qual i dade do Campo, o val or gravado no banco de dados. As propri edades
DeadBand, DeadBandUnit, MaxRecTime e MinRecTime no tm efei to nestes ti pos de
dados, poi s so excl usi vas do al gori tmo de compactao.
5.9.4 Sesso do Storage
Esta seo contm i nformaes sobre os mtodos do objeto Sesso do Storage. Este
objeto no possui eventos nem propri edades associ ados.
5.9.4.1 Mtodos
Esta seo contm i nformaes 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 pel a i nsero de Tags temporri os na estrutura da
Sesso. Se os parmetros opci onai s no forem preenchi dos, sero uti l i zado os
val ores defi ni dos na cri ao da Sesso pel o mtodo CreateNewSession do Storage.
Os parmetros deste mtodo so descri tos na tabel a a segui r.
Parmetros do mtodo AddField
PARMETRO DESCRIO
FieldName
Nome do Tag temporri o (obri gatri o).
Type
Ti po do Tag (opci onal ). Os val ores
possvei s so 0: Double, 1: Bit, 2: String ou
3: Integer. O val or padro deste
parmetro 0 (Double).
MinRecTime
I nterval o mni mo de tempo entre as
gravaes (opci onal ). O val or padro
deste parmetro 0 (zero).
PARMETRO DESCRIO
MaxRecTime
I nterval o mxi mo de tempo sem
gravaes (opci onal ). O val or padro
deste parmetro 3600.
DeadBand
Banda morta do Tag temporri o
(opci onal ). O val or padro deste
parmetro 1 (um).
DeadBandUnit
Uni dade de banda morta do Tag
temporri o (opci onal ). Os val ores
possvei s so 0: Porcentagem ou 1:
Absoluta. O val or padro deste parmetro
1 (Absoluta).
ScanTime
Tempo de varredura do Tag temporri o
(opci onal ). O val or padro deste
parmetro 0 (zero).
Este mtodo retorna Verdadei ro se o Tag foi corretamente adi ci onado na Sesso, e
Fal so caso contrri o.
5.9.4.1.2 AddValue
AddValue(FieldName, Timestamp, Quality, Value)
Adi ci ona um val or a um Tag temporri o na Sesso. Os parmetros deste mtodo
so descri tos na tabel a a segui r.
Parmetros do mtodo AddValue
PARMETRO DESCRIO
FieldName
Nome do campo ao qual o val or ser
adi ci onado. Este nome deve exi sti r na
confi gurao ori gi nal do Storage, ou
ento deve ter si do adi ci onado
previ amente pel o mtodo AddField.
Timestamp
Estampa de tempo do val or a ser
adi ci onado.
Quality
Qual i dade do val or a ser adi ci onado.
Value
Val or a ser adi ci onado.
Este mtodo retorna Verdadei ro se o val or foi adi ci onado corretamente, e Fal so
caso contrri o.
5.9.4.1.3 Commit
Commit()
Grava todos os dados manti dos em memri a pel a Sesso no banco de dados do
Storage. Este mtodo retorna Verdadei ro se os dados foram gravados corretamente,
e Fal so caso contrri o.
5.10 Frmulas
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Frmul a.
5.10.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Frmul a.
5.10.1.1 CreateUnit
CreateUnit(UnitName)
Cri a uma uni dade na tabel a de frmul as. Este mtodo possui o parmetro
UnitName que determi na o nome da uni dade a ser cri ada. Retorna True se consegui r
real i zar a operao; caso contrri o, retorna Fal se. Exempl o:
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)
Cri a um conjunto de val ores na tabel a de frmul as. Este mtodo possui o
parmetro ValueName, que determi na o nome do conjunto a ser cri ado. Retorna
True se consegui r real i zar a operao; caso contrri o, retorna Fal se. Exempl o:
Sub Botao1_Click()
Dim val
' Quando clica no boto, cria um novo Valor
Application.GetObject("Formula1").CreateValue("Modelo5")
End Sub
5.10.1.3 DeleteUnit
DeleteUnit(UnitName)
Apaga uma uni dade na tabel a de frmul as. Este mtodo possui o parmetro
UnitName, que i nforma o nome da uni dade a ser apagada. Retorna True se
consegui r real i zar a operao; caso contrri o, retorna Fal se. Exempl o:
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 val ores na tabel a de frmul as. Este mtodo possui o
parmetro ValueName, que i nforma o conjunto de val ores a ser apagado. Retorna
True se consegui r real i zar a operao; caso contrri o, retorna Fal se. Exempl o:
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)
Veri fi ca se uma determi nada uni dade exi ste no banco de dados das frmul as. Este
mtodo possui o parmetro UnitName, que determi na o nome da uni dade a ser
encontrada. O mtodo retorna True se consegui r real i zar a operao; caso
contrri o, retorna Fal se. Exempl o:
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)
Veri fi ca se um determi nado conjunto de val ores exi ste no banco de dados de
frmul as. Este mtodo possui o parmetro ValueName, que i nforma o nome do
conjunto a ser veri fi cado. Retorna True se consegui r real i zar a operao; caso
contrri o, retorna Fal se. Exempl o:
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)
Col oca na vari vel i ndi cada em Val o Tag associ ado uni dade UnitName do
templ ate TemplateName. Retorna True se a operao foi bem-sucedi da, ou Fal se,
caso contrri o. Exempl o:
Sub Botao1_Click()
Dim qualTag, qualFormula
Application.GetObject("Formula1").GetUnitData _
"Unidade1", "Template2", var1
End Sub
5.10.1.8 GetValueData
GetValueData(ValueName, TemplateName, Val)
Col oca na vari vel Val o val or do conjunto de val ores ValueName que est
associ ado ao templ ate TemplateName. Retorna True se a operao foi bem-
sucedi da, ou Fal se, caso contrri o. Exempl o:
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 val ores para uma uni dade de desti no, sem apresentar
nenhuma mensagem. Este mtodo possui os parmetros UnitName, que determi na o
nome da uni dade e ValueName, que determi na o nome do conjunto de val ores.
Retorna True quando executado com sucesso, e Fal se quando fal ha (o que no
si gni fi ca um erro de scri pt, necessari amente). Exempl o:
Sub Botao1_Click()
Application.GetObject("Formula1").LoadFormulaValuesQuiet _
"Unidade3", "Valor1"
End Sub
NOTA: Este mtodo tambm acessado atravs do objeto Viewer.
5.10.1.10 RenameUnit
RenameUnit(UnitName, NewUnitName)
Renomei a uma determi nada uni dade exi stente na tabel a de frmul as. Retorna True
se consegui r real i zar a operao, ou Fal se, caso contrri o. Este mtodo possui os
parmetros UnitName, que determi na o nome da uni dade a ser encontrada; e
NewUnitName, que i nforma o novo nome da uni dade. Exempl o:
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)
Renomei a um determi nado conjunto de val ores exi stente na tabel a de frmul as.
Retorna True se consegui r real i zar a operao ou Fal se, caso contrri o. Este
mtodo possui os parmetros ValueName, que i nforma o nome do conjunto de
val ores e NewValueName, que i nforma o novo nome do conjunto de val ores.
Exempl o:
Sub Botao1_Click()
Application.GetObject("Formula1").RenameValue "Modelo5",
"ModeloABC"
End Sub
5.10.1.12 SaveFormulaValues
SaveFormulaValues(UnitName, ValueName[, IgnoreErrors])
Este mtodo sal va os val ores atuai s dos Tags de uma uni dade de ori gem em um
conjunto de val ores na tabel a de frmul as. Este mtodo no faz a veri fi cao dos
l i mi tes, caso o template tenha uma restri o do ti po absol uta. O parmetro
UnitName o nome da uni dade de ori gem e o parmetro ValueName o conjunto de
val ores que ser sal vo. Retorna True se consegui r real i zar a operao. Do
contrri o, retorna Fal se. O parmetro IgnoreErrors, quando em True, faz com que
todos os val ores sejam gravados, i ndependente de haver erros de associ aes na
Frmul a. Seu val or padro Fal se, no entanto. Exempl o:
Sub Botao1_Click()
Application.GetObject("Formula1") SaveFormulaValues
"Unidade1", "Valor1"
End Sub
5.10.1.13 SetUnitData
SetUnitData(UnitName, TemplateName, Data)
Carrega para a tabel a de frmul as o Tag i denti fi cado para um certo model o
(template), em uma determi nada uni dade. Retorna True se consegui r real i zar a
operao ou Fal se, caso contrri o. Este mtodo possui os parmetros UnitName,
que i nforma o nome da uni dade, TemplateName, que i nforma o nome do template
do Tag e Data, que i nforma o nome da vari vel que contm o nome do Tag. Exempl o:
Sub Botao1_Click()
Application.GetObject("Formula1").SetUnitData _
"Unidade2", "Template5", 50
End Sub
5.10.1.14 SetValueData
SetValueData(ValueName, TemplateName, Data)
Al tera o val or referente a um template defi ni do para um determi nado conjunto de
val ores. Este mtodo faz a veri fi cao dos l i mi tes, retornando True se consegui r
real i zar a operao ou Fal se, caso contrri o. Este mtodo possui os parmetros
ValueName, que determi na o nome do conjunto de val ores, TemplateName, que
determi na o nome do template e Data, que determi na o nome da vari vel que possui
o val or. Exempl o:
Sub Botao1_Click()
Application.GetObject("Formula1").SetValueData _
"Unidade2", "Template1", 100
End Sub
NOTA: Para mai ores i nformaes sobre o mtodo SetValueData, consul te os arti gos
KB 35, KB 280 e KB 727, do Elipse Knowledgebase.
5.10.2 Propriedades
Esta seo contm i nformaes sobre as propri edades do objeto Frmul a.
5.10.2.1 DBServer
Indi ca o nome do banco de dados onde sero gravadas as i nformaes da
Frmul a, ou seja, as uni dades e os conjuntos de val ores. O val or padro desta
propri edade uma String vazi a.
5.10.2.2 ImmediateExecute
Quando habi l i tada, faz com que a Frmul a escreva seus regi stros di retamente no
Banco de Dados, sem preci sar passar por suas fi l as de operaes (arqui vos .e3i e
.e3o). Isso faz com que as operaes fei tas no Banco de Dados sejam vi stas de
forma mai s rpi da.
5.10.2.3 TableName
Indi ca o nome das tabel as onde fi caro as i nformaes das Frmul as. O val or
5.11 Alarmes
Esta seo contm i nformaes sobre eventos, mtodos e propri edades dos objetos
Confi gurao de Al armes, reas de Al arme, Fontes de Al arme e Servi dor de Al armes.
5.11.1 Configurao de Alarmes
O objeto Confi gurao de Al armes no contm eventos, mtodos ou propri edades
especfi cos, somente gerai s. Estes podem ser vi sual i zados na seo Eventos,
Mtodos e Propriedades Gerais dos Objetos.
5.11.2 reas de Alarme
Esta seo contm i nformaes sobre propriedades do objeto rea de Al arme. Este
Esta seo contm i nformaes sobre as propri edades do objeto rea de Al arme.
5.11.2.1.1 ActiveAlarms
Determi na o nmero de al armes ati vos dentro da rea do si stema. Esta
propri edade somente de l ei tura e seu val or padro 0 (zero).
5.11.2.1.2 ActiveHighAlarms
5.11.2.1.3 ActiveHighNACKAlarms
5.11.2.1.4 ActiveLowAlarms
5.11.2.1.5 ActiveLowNACKAlarms
5.11.2.1.6 ActiveMedAlarms
5.11.2.1.7 ActiveMedNACKAlarms
5.11.2.1.8 ActiveNACKAlarms
Indi ca o nmero de al armes que esto sem reconheci mento dentro da rea. Esta
5.11.2.1.9 Alarm
Estabel ece a exi stnci a de al armes ati vos dentro da rea. Se a opo esti ver em
True, o si stema tem pel o menos um al arme ati vo dentro da rea, e a propri edade
ActiveAlarms far a l ei tura no si stema, i ndi cando a quanti dade de al arme ati vos.
Caso contrri o, a propri edade ActiveNACKAlarms far a l ei tura dos al armes sem
reconheci mento. Esta propri edade somente de l ei tura.
5.11.2.1.10 AlarmVerify
Habi l i ta a veri fi cao de todos os al armes dentro da rea. Depoi s de habi l i tada
esta veri fi cao (True), se a propri edade ActiveAlarms possui r val or mai or que 0
(zero), o si stema veri fi ca tanto os al armes ati vos quanto os sem reconheci mento,
l i stando estes l ti mos pel a propri edade ActiveNACKAlarms. Esta propri edade ti l
para evi tar-se o efei to de aval anche de al guns si stemas, onde o aconteci mento de
um evento gera uma grande quanti dade de al armes correl aci onados.
5.11.2.1.11 InactiveHighNACKAlarms
5.11.2.1.12 InactiveLowNACKAlarms
5.11.2.1.13 InactiveMedNACKAlarms
5.11.2.1.14 InactiveNACKAlarms
5.11.2.1.15 UserFields
Retorna um objeto que uma col eo de Campos de Usuri o de Al armes de uma
rea de Al arme. Veja o i tem Coleo de Campos de Usurio de Alarmes para
5.11.3 Fontes de Alarme
Esta seo contm i nformaes sobre mtodos e propriedades comuns ao objeto
Fonte de Al arme. Este objeto no possui eventos comuns associ ados.
NOTA: Quando um objeto Fonte de Al arme desabi l i tado ou desati vado, as
propri edades ActiveNACKAlarm, Alarm, CurrentSeverity, CurrentSubConditionName,
FormattedValue, RawAlarm e Value assumem seus val ores padro, i ndi cando que a
Fonte de Al arme no est vi ncul ada a uma mensagem de al arme ati va. Neste caso,
os val ores das propri edades Alarm e ActiveNACKAlarm so propagados para os
contadores das reas superi ores.
Para que as propri edades ci tadas recebam um val or di ferente do padro,
necessri o que as segui ntes condi es estejam presentes:
A Fonte de Al arme deve estar habi l i tada e ati vada
As reas de Alarme (e todos os objetos hi erarqui camente superi ores) devem estar
habi l i tadas e ati vadas
O Servidor de Alarmes deve estar ati vado
Esta seo contm i nformaes sobre os mtodos comuns aos objetos Fontes de
Al arme.
5.11.3.1.1 Ack
Ack([ActorID])
Executa o reconheci mento de um al arme confi gurado no objeto Fonte de Al armes. O
mtodo retorna um Bool eano que i ndi ca o sucesso ou no da operao. O
parmetro ActorID i nforma o nome do usuri o responsvel pel o reconheci mento
dos al armes. Este parmetro opci onal e, se for omi ti do, assume o l ogon do
usuri o do Vi ewer, "Anonymous" se no h usuri o l ogado, ou "System" se a
chamada do mtodo foi ori gi nada no servi dor.
5.11.3.1.2 GetAlarm
GetAlarm()
Retorna um objeto que permi te o acesso s confi guraes especfi cas de cada ti po
de al arme. Isto permi te veri fi car ou modi fi car em tempo de execuo as
propri edade de um determi nado al arme. Dependendo do ti po de al arme, o mtodo
retornar as segui ntes propri edades:
Alarme Digital: Responsvel pel as confi guraes de al arme di gi tal
Propriedades do Alarme Digital
ITEM DESCRIO
DigitalReturnMessageText
Mensagem de retorno do al arme di gi tal .
Digital
Habi l i ta ou desabi l i ta a veri fi cao de
al arme di gi tal .
DigitalLimit
Li mi te para o al arme di gi tal .
DigitalMessageText
Texto da mensagem de al arme di gi tal .
DigitalSeverity
Severi dade do al arme di gi tal . Conjunto de
val ores:
0: Al ta
1: Mdi a
2: Bai xa
DigitalAckRequired
Necessi dade de reconheci mento para este
ti po de al arme (di gi tal ).
Alarme Analgico: Responsvel pel as confi guraes do al arme anal gi co.
Propri edades deste objeto (tem quatro nvei s de al arme):
Propriedades do Alarme Analgico
ITEM DESCRIO
LevelDeadBand
Banda morta para o al arme de nvei s.
LevelReturnMessageText
Mensagem de retorno de al arme.
Alarme LoLo (Muito Baixo)
ITEM DESCRIO
LoLo
al arme Mui to Bai xo.
LoLoLimit
Li mi te para o nvel de al arme Mui to Bai xo.
LoLoMessageText
Texto da mensagem de al arme Mui to
Bai xo.
ITEM DESCRIO
LoLoSeverity
I mportnci a do nvel de al arme Mui to
Bai xo. Conjunto de val ores:
0: Al ta
1: Mdi a
2: Bai xa
LoLoAckRequired
nvel de al arme (Mui to Bai xo).
Alarme Lo (Baixo)
ITEM DESCRIO
Lo
al arme Bai xo.
LoLimit
Li mi te para o nvel de al arme Bai xo.
LoMessageText
Texto da mensagem de al arme Bai xo.
LoSeverity
I mportnci a do nvel de al arme Bai xo.
Conjunto de val ores:
0: Al ta
1: Mdi a
2: Bai xa
LoAckRequired
nvel de al arme (Bai xo).
Alarme Hi (Alto)
ITEM DESCRIO
Hi
al arme Al to.
HiLimit
Li mi te para o nvel de al arme Al to.
HiMessageText
Texto da mensagem de al arme Al to.
HiSeverity
I mportnci a do nvel de al arme Al to.
0: Al ta
1: Mdi a
2: Bai xa
HiAckRequired
nvel de al arme (Al to).
Alarme HiHi (Muito Alto)
ITEM DESCRIO
HiHi
al arme Mui to Al to.
HiHiLimit
Li mi te para o nvel de al arme Mui to Al to.
ITEM DESCRIO
HiHiMessageText
Texto da mensagem de al arme Mui to Al to.
HiHiSeverity
I mportnci a do nvel de al arme Mui to Al to.
0: Al ta
1: Mdi a
2: Bai xa
HiHiAckRequired
nvel de al arme (Mui to Al to).
Alarme Taxa de Variao: Responsvel por confi guraes de al arme de taxa de
vari ao
Propriedades do Alarme Taxa de Variao
ITEM DESCRIO
ROCReturnMessageText
Mensagem de retorno da taxa de mudana.
ROC
al arme de taxa de vari ao.
ROCLimit
Li mi te para o al arme de taxa de mudana.
Para o al arme ocorrer, basta que o val or do
Tag associ ado ul trapasse esse val or em
um segundo.
ROCMessageText
Texto da mensagem de al arme de taxa de
mudana.
ROCSeverity
I mportnci a do al arme de taxa de
mudana. Conjunto de val ores:
0: Al ta
1: Mdi a
2: Bai xa
ROCAckRequired
ti po de al arme (taxa de mudana).
Alarme Banda Morta: Responsvel por confi guraes de al arme de banda morta
Propriedades do Alarme Banda Morta
ITEM DESCRIO
DeadBandSetPoint
Li mi te de banda morta do al arme. Cada vez
que o val or do Tag associ ado ul trapassar o
val or desta propri edade para mai s ou para
menos do val or de DeadBandLimit, o al arme
ocorrer.
DeadBandReturnMessageText
Mensagem de retorno de al arme de banda
morta.
DeadBand
al arme de banda morta.
ITEM DESCRIO
DeadBandLimit
Li mi te para o al arme de banda morta.
DeadBandMessageText
Texto da mensagem de al arme de banda
morta.
DeadBandSeverity
I mportnci a do al arme de banda morta.
0: Al ta
1: Mdi a
2: Bai xa
DeadBandAckRequired
ti po de al arme (banda morta).
Exempl o:
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: as propri edades rel ati vas a cada ti po de al arme podem ser acessadas
di retamente por scri pts e Associ aes, bem como vi sual i zadas na Li sta de
Propri edades do objeto, no mai s sendo obri gatri a sua edi o vi a mtodo
GetAlarm.
Esta seo contm i nformaes sobre as propri edades comuns aos objetos Fonte
de Al arme.
5.11.3.2.1 ActiveNACKAlarm
Se ajustada para True, i ndi ca que a Fonte no foi reconheci da desde a l ti ma
ati vao. Esta propri edade somente de l ei tura. O val or padro desta propri edade
Fal se.
5.11.3.2.2 Alarm
Se ajustada para True, i ndi ca a condi o ati va do al arme. O val or padro desta
5.11.3.2.3 AlarmVerify
Se ajustada para True, habi l i ta a veri fi cao da Fonte de Al arme (ou seja, a
gerao do al arme).
5.11.3.2.4 AreaNameOverride
Determi na um nome al ternati vo para a rea que contm a Fonte de Al arme. O
NOTAS:
Quando esta propri edade est vazi a, o nome da Fonte de Al arme composto dos
nomes dos objetos rea hi erarqui camente superi ores.
Esta propri edade, mesmo quando preenchi da, no i nfl uenci a nos contadores da
reas de Al arme hi erarqui camente superi ores, que conti nuaro contando os
al armes desta Fonte de Al arme.
Se esta propri edade for al terada em tempo de execuo, o novo val or s entrar
em vi gor quando ocorrer o prxi mo al arme nesta Fonte de Al arme.
5.11.3.2.5 CurrentSeverity
Indi ca a l ti ma severi dade do al arme ati vo, a saber:
0: Al ta
1: Mdi a
2: Bai xa
O val or padro desta propri edade -1, i ndi cando que a Fonte de Al arme no est
ati va.
5.11.3.2.6 CurrentSubConditionName
Determi na o nome da l ti ma condi o de al arme ati va. As opes di sponvei s
para esta propri edade so:
Opes disponveis para CurrentSubConditionName
OPO DESCRIO
LOLO
Al arme Anal gi co na fai xa LOLO.
LO
Al arme Anal gi co na fai xa LO.
HI
Al arme Anal gi co na fai xa HI .
HIHI
Al arme Anal gi co na fai xa HI HI .
BM
Al arme de Banda Morta.
TV
Al arme Taxa de Vari ao.
DIG
Al arme Di gi tal .
O val or padro desta propri edade uma String vazi a.
5.11.3.2.7 Delay
Especi fi ca um tempo de atraso para o al arme (em ms), tanto na entrada quanto
na sada da condi o. Quando essa propri edade esti ver em 0 (que ser sempre o
val or padro), no apl i cado nenhum atraso. Quando for di ferente de 0, o al arme
s ser ati vado ou desati vado se permanecer na mesma condi o por um tempo
mai or ou i gual ao especi fi cado.
5.11.3.2.8 DoubleAckRequired
Quando confi gurada como True, i ndi ca que o al arme pode ser reconheci do tanto
quando est ati vo como quando passa a i nati vo, ou seja, pode ser reconheci do
dupl amente. Quando confi gurada como Fal se, i ndi ca que o al arme s pode ser
reconheci do uma vez, e ao ser reconheci do sai da l i sta de al armes. Al armes que
no necessi tem reconheci mento (propri edade AckRequired) no possi bi l i tam esta
personal i zao. Apl i caes anteri ores verso 2.5 vm com esta propri edade
confi gurada como Fal se.
5.11.3.2.9 Event
Quando confi gurada como Verdadei ro, i ndi ca que o al arme do ti po Evento. Um
al arme do ti po Evento, ao ser ati vado, reconheci do pel o usuri o "System".
Portanto, ao ser reconheci do nada acontece (no tem efei to al gum), assi m como
no i ncrementa o nmero de al armes ati vos nem o nmero de al armes no
reconheci dos. No pode ser modi fi cada em tempo de execuo.
5.11.3.2.10 Format
formatadores usados nas pl ani l has de dados, segui ndo a mesma si ntaxe bsi ca.
So suportados os segui ntes ti pos de dados:
DADOS DESCRIO
Numrico
bi nri a e octal .
Texto
Textos em geral .
Booleano
Val ores bol eanos.
Data e Hora
5.11.3.2.11 FormattedValue
Contm o val or do al arme conforme a propri edade Value, formatado de acordo
com a propri edade Format. Esta propri edade somente de l ei tura. O val or padro
desta propri edade Nul l .
5.11.3.2.12 RawAlarm
Indi ca se o al arme deve estar ati vo, i ndependentemente da espera. Quando a
espera for i gual a 0 (zero), o val or de RawAlarm ser o mesmo da propri edade
Alarm. Esta propri edade somente de l ei tura. O val or padro desta propri edade
Fal se.
5.11.3.2.13 Source
Contm a expresso que dever ser aval i ada para determi nar se o al arme deve
ocorrer ou no.
5.11.3.2.14 UserFields
Retorna um objeto que uma col eo de Campos de Usuri o de Al armes de uma
Fonte de Al arme. Veja o i tem Coleo de Campos de Usurio de Alarmes para
5.11.3.2.15 Value
Contm o val or do que foi aval i ado para determi nar se o al arme ocorre ou no. O
val or padro desta propri edade Nul l .
5.11.3.3 Fonte de Alarme Analgico
Esta seo contm i nformaes sobre propriedades do objeto Fonte de Al arme
Anal gi co. Este objeto no possui eventos nem mtodos associ ados.
Quando o val or da propri edade Event (comum a todas as Fontes de Al arme) est
confi gurado para Verdadei ro, as propri edades HiEvent, HiHiEvent, LoEvent e
LoLoEvent no podem ser modi fi cadas (todas as subcondi es do al arme se
comportam como eventos).
Esta seo contm i nformaes sobre as propri edades do objeto Fonte de Al arme
Anal gi co.
5.11.3.3.1.1 Hi
Habi l i ta ou desabi l i ta a veri fi cao de al armes do ti po Hi.
5.11.3.3.1.2 HiAckRequired
Indi ca que o al arme do ti po Hi requer reconheci mento.
5.11.3.3.1.3 HiEvent
Defi ne se a subcondi o Hi do Al arme deve ser tratada como um evento. Se a
propri edade Event, comum s Fontes de Al arme, esti ver confi gurada para
Verdadei ro, esta propri edade no pode ser modi fi cada e seu val or fi ca sempre em
Verdadei ro. Al m di sso, esta propri edade no pode ser modi fi cada em tempo de
execuo.
5.11.3.3.1.4 HiHi
Habi l i ta ou desabi l i ta a veri fi cao de al armes do ti po HiHi.
5.11.3.3.1.5 HiHiAckRequired
Indi ca que o al arme do ti po HiHi requer reconheci mento.
5.11.3.3.1.6 HiHiEvent
Defi ne se a subcondi o HiHi do Al arme deve ser tratada como um evento. Se a
execuo.
5.11.3.3.1.7 HiHiLimit
Indi ca o nvel em que o al arme HiHi ser ati vado.
5.11.3.3.1.8 HiHiMessageText
Ajusta a mensagem de texto do l i mi te do al arme de ti po HiHi.
5.11.3.3.1.9 HiHiSeverity
Indi ca o nvel de i mportnci a do al arme de ti po HiHi. As opes so:
0: Al ta
1: Mdi a
2: Bai xa
5.11.3.3.1.10 HiLimit
Indi ca o nvel em que o al arme Hi ser ati vado.
5.11.3.3.1.11 HiMessageText
Ajusta a mensagem de texto do l i mi te do al arme de ti po Hi.
5.11.3.3.1.12 HiSeverity
Indi ca o nvel de i mportnci a do al arme de ti po Hi. As opes so:
0: Al ta
1: Mdi a
2: Bai xa
5.11.3.3.1.13 LevelDeadBand
Banda morta para os l i mi tes do nvel do al arme.
5.11.3.3.1.14 LevelReturnMessageText
Ajusta a mensagem de retorno do nvel do al arme.
5.11.3.3.1.15 Lo
Habi l i ta ou desabi l i ta a veri fi cao de al armes do ti po Lo.
5.11.3.3.1.16 LoAckRequired
Indi ca que o al arme do ti po Lo requer reconheci mento.
5.11.3.3.1.17 LoEvent
Defi ne se a subcondi o Lo do Al arme deve ser tratada como um evento. Se a
execuo.
5.11.3.3.1.18 LoLimit
Indi ca o nvel em que o al arme Lo ser ati vado.
5.11.3.3.1.19 LoLo
Habi l i ta ou desabi l i ta a veri fi cao de al armes do ti po LoLo.
5.11.3.3.1.20 LoLoAckRequired
Indi ca que o al arme do ti po LoLo requer reconheci mento.
5.11.3.3.1.21 LoLoEvent
Defi ne se a subcondi o LoLo do Al arme deve ser tratada como um evento. Se a
execuo.
5.11.3.3.1.22 LoLoLimit
Indi ca o nvel em que o al arme LoLo ser ati vado.
5.11.3.3.1.23 LoLoMessageText
Ajusta a mensagem de texto do l i mi te do al arme de ti po LoLo.
5.11.3.3.1.24 LoLoSeverity
Indi ca o nvel de i mportnci a do al arme de ti po LoLo. As opes so:
0: Al ta
1: Mdi a
2: Bai xa
5.11.3.3.1.25 LoMessageText
Ajusta a mensagem de texto do l i mi te do al arme de ti po Lo.
5.11.3.3.1.26 LoSeverity
Indi ca o nvel de i mportnci a do al arme de ti po Lo. As opes so:
0: Al ta
1: Mdi a
2: Bai xa
5.11.3.4 Fonte de Alarme Digital
Di gi tal . Este objeto no possui eventos nem mtodos associ ados.
Di gi tal .
5.11.3.4.1.1 Digital
Habi l i ta ou desabi l i ta a veri fi cao de al arme di gi tal .
5.11.3.4.1.2 DigitalAckRequired
Necessi dade de reconheci mento para o al arme di gi tal .
5.11.3.4.1.3 DigitalLimit
Li mi te para o al arme di gi tal .
5.11.3.4.1.4 DigitalMessageText
Texto da mensagem de al arme di gi tal .
5.11.3.4.1.5 DigitalReturnMessageText
Mensagem de retorno do al arme di gi tal .
5.11.3.4.1.6 DigitalSeverity
Severi dade do al arme di gi tal . Conjunto de val ores:
0: Al ta
1: Mdi a
2: Bai xa
5.11.3.5 Fonte de Alarme Banda Morta
Banda Morta. Este objeto no possui eventos nem mtodos associ ados.
Banda Morta.
5.11.3.5.1.1 DeadBand
Habi l i ta ou desabi l i ta a veri fi cao de al arme de banda morta.
5.11.3.5.1.2 DeadBandAckRequired
Necessi dade de reconheci mento para o al arme de banda morta.
5.11.3.5.1.3 DeadBandLimit
Li mi te para o al arme de banda morta.
5.11.3.5.1.4 DeadBandMessageText
Texto da mensagem de al arme de banda morta.
5.11.3.5.1.5 DeadBandReturnMessageText
Mensagem de retorno de al arme de banda morta.
5.11.3.5.1.6 DeadBandSetpoint
Li mi te de banda morta do al arme. Cada vez que o val or do Tag associ ado
ul trapassar o val or desta propri edade para mai s ou para menos do val or de
DeadBandLimit, o al arme ocorrer.
5.11.3.5.1.7 DeadBandSeverity
Importnci a do al arme de banda morta. Conjunto de val ores:
0: Al ta
1: Mdi a
2: Bai xa
5.11.3.6 Fonte de Alarme Taxa de Variao
Esta seo contm i nformaes sobre propriedades do objeto Fonte de Al arme Taxa
de Vari ao. Este objeto no possui eventos nem mtodos associ ados.
Taxa de Vari ao.
5.11.3.6.1.1 ROC
Habi l i ta ou desabi l i ta a veri fi cao de al arme de taxa de vari ao.
5.11.3.6.1.2 ROCAckRequired
Necessi dade de reconheci mento para o al arme de taxa de vari ao.
5.11.3.6.1.3 ROCLimit
Li mi te para o al arme de taxa de vari ao. Para o al arme ocorrer, basta que o
val or do Tag associ ado ul trapasse esse val or em um segundo.
5.11.3.6.1.4 ROCMessageText
Texto da mensagem do al arme de taxa de vari ao.
5.11.3.6.1.5 ROCReturnMessageText
Mensagem de retorno do al arme de taxa de vari ao.
5.11.3.6.1.6 ROCSeverity
Importnci a do al arme de taxa de vari ao. Conjunto de val ores:
0: Al ta
1: Mdi a
2: Bai xa
5.11.3.7 Fonte de Alarme Discreto
Di screto. Este objeto no possui eventos nem mtodos associ ados.
Quando o val or da propri edade Event (comum a todas as Fontes de Al arme) est
confi gurado para Verdadei ro, a propri edade Kind dos objetos da col eo de
Subcondi es da Fonte de Al arme Di screto no pode ser modi fi cada (todas as
subcondi es do al arme se comportam como eventos).
Di screto.
5.11.3.7.1.1 DiscreteReturnMessageText
Retorna ou modi fi ca a mensagem de retorno da Fonte de Al arme Di screto. Se
al gum dos objetos da col eo de Subcondies ti ver sua propri edade Kind
confi gurada para 2 (Retorno), a propri edade Message deste objeto ser uti l i zada,
ao i nvs do val or defi ni do em DiscreteReturnMessageText.
5.11.3.7.1.2 SubConditions
Retorna um objeto que uma col eo das Subcondi es da Fonte de Al arme
Di screto. Veja o i tem Coleo de Subcondies para mai ores i nformaes sobre a
col eo de objetos retornados por esta propri edade.
5.11.3.7.2 Coleo de Subcondies
de Subcondi es retornada pel a propri edade SubConditions de uma Fonte de
Al arme Di screto.
5.11.3.7.2.1 Mtodos Comuns
Esta seo contm i nformaes sobre os mtodos comuns col eo de
Subcondi es de uma Fonte de Al arme Di screto.
AddSubCondition
AddSubCondition([Name, Caption, Message, Kind, AckRequired, Severity, Value])
Adi ci ona um objeto Subcondi o col eo de Subcondi es. Este mtodo possui os
segui ntes parmetros opci onai s:
Parmetros do mtodo AddSubCondition
PARMETRO DESCRIO
Name
O nome do objeto. Corresponde
propri edade Name do objeto
Subcondi o. Se for omi ti do, a
Subcondi o ser cri ada com o nome
"Subcondi cao". Se o val or passado neste
parmetro j exi sti r na col eo, ser
automati camente i ncrementado.
Caption
A descri o do objeto. Corresponde
propri edade Caption do objeto
Subcondi o.
PARMETRO DESCRIO
Message
O texto da mensagem da Subcondi o.
Corresponde propri edade Message do
objeto Subcondi o.
Kind
O ti po de comportamento desta
Subcondi o. Os val ores possvei s para
este parmetro so: 0 - Al arme (padro);
1 - Evento; 2 - Retorno. Corresponde
propri edade Kind do objeto Subcondi o.
AckRequired
I ndi ca se esta Subcondi o exi ge
reconheci mento. Corresponde
propri edade AckRequired do objeto
Subcondi o. O val or padro desta
propri edade Verdadei ro.
Severity
O ti po de severi dade desta Subcondi o.
Os val ores possvei s para este parmetro
so: 0 - Al ta; 1 - Mdi a (padro); 2 - Bai xa.
Corresponde propri edade Severity do
objeto Subcondi o.
Value
Parmetro que contm um val or que ser
aval i ado para determi nando se o al arme
ocorre ou no. Corresponde
propri edade Value, comum s Fontes de
Al arme.
Item
Item(Index)
Retorna uma refernci a para um objeto Subcondi o, i ndi cado por Index. Este
parmetro pode ser o ndi ce na col eo (i ni ci ando em 1) ou o nome do objeto
(propri edade Name).
RemoveSubCondition
RemoveSubCondition(Index)
Remove o objeto Subcondi o, i ndi cado pel o parmetro Index. Este parmetro pode
ser o ndi ce na col eo (i ni ci ando em 1) ou o nome do objeto (propri edade Name).
5.11.3.7.2.2 Propriedades Comuns
Subcondi es de uma Fonte de Al arme Di screto.
Count
Retorna o nmero de objetos fi l hos (i tens) de uma col eo de Subcondi es. Esta
propri edade trabal ha em conjunto com o mtodo Item. Se a col eo no possui
objetos fi l hos, o val or retornado 0 (zero).
5.11.3.7.2.3 Subcondies
Esta seo contm i nformaes sobre propriedades de objetos do ti po Subcondio
conti dos na col eo retornada pel a propri edade SubConditions da Fonte de Al arme
Di screto. Este objeto no possui eventos nem mtodos associ ados.
Propriedades
Esta seo contm i nformaes sobre propri edades do objeto Subcondi o.
AckRequired
Indi ca se este objeto Subcondi o requer reconheci mento.
Caption
Descri o da Subcondi o.
Enabled
Habi l i ta ou desabi l i ta a Subcondi o.
Kind
Indi ca o comportamento da Subcondi o. Os val ores possvei s para esta
0: Al arme
1: Evento
2: Retorno
Se a propri edade Event, comum s Fontes de Al arme, esti ver confi gurada para
Verdadei ro, esta propri edade no pode ser modi fi cada e seu val or fi ca sempre em 1
(Evento). Al m di sso, esta propri edade no pode ser modi fi cada em tempo de
execuo.
Limit
Defi ne o val or da Fonte de Al arme para gerar a Subcondi o.
Message
A mensagem do evento quando a Subcondi o est ati va. Se a propri edade Kind
esti ver confi gurada como 2 (Retorno), esta propri edade ser consi derada como a
mensagem de retorno do al arme.
Name
Nome do objeto Subcondi o. Este val or no di ferenci a mai scul as e
mi nscul as.
Severity
O ti po de severi dade desta Subcondi o. Os val ores possvei s para esta
propri edade so:
0: Al ta
1: Mdi a
2: Bai xa
5.11.4 Servidor de Alarmes
Esta seo contm i nformaes sobre mtodos e propriedades do objeto Servi dor
de Al arme. Este objeto no possui eventos associ ados.
5.11.4.1 Mtodos
Esta seo contm i nformaes sobre os mtodos do objeto Servi dor de Al arme.
5.11.4.1.1 AckAllAlarms
AckAllAlarms([ActorID])
Executa o reconheci mento de todos os al armes do servi dor, i ndependente da rea.
O mtodo retorna um Bool eano que i ndi ca o sucesso ou no da operao. O
chamada do mtodo foi ori gi nada no servi dor. Exempl o:
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 reconheci mento dos al armes em uma determi nada rea. O mtodo
retorna um Bool eano que i ndi ca o sucesso ou no da operao. O parmetro Area
especi fi ca o nome da(s) rea(s) cujos al armes sero reconheci dos, atravs da
comparao entre os trechos i ni ci ai s dos nomes. Por exempl o, AckArea("ANA")
reconheceri a al armes das reas "ANALOGICOS", "ANA.AREA2", etc. Se o val or deste
parmetro for vazi o, o mtodo ter o mesmo comportamento de AckAllAlarms. O
chamada do mtodo foi ori gi nada no servi dor. Exempl o:
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)
Si mul a um evento ou al arme e o envi a di reto para o banco de dados do servi dor de
al armes, sem passar pel o E3Al arm. Por i sto, este evento no pode ser vi sto no
E3Al arm, nem tampouco o al arme pode ser reconheci do.
Cada parmetro do mtodo permi te especi fi car o val or do campo de mesmo nome
no evento. Os campos do evento so preenchi dos de acordo com os parmetros do
mtodo:
Parmetros do mtodo LogTrackingEvent
NOME DESCRIO
Message
Parmetro texto que especi fi ca o
contedo do campo Mensagem do evento.
Se omi ti do, assume uma String vazi a.
ActorID
Parmetro texto opci onal que especi fi ca
o contedo do campo Operador do evento.
Se omi ti do, assume o l ogon do usuri o
do Vi ewer, "Anonymous" se no h
usuri o l ogado, ou "System" se a
chamada do mtodo foi ori gi nada no
servi dor.
Area
contedo do campo rea do evento. Se
omi ti do, assume uma String vazi a.
Severity
Parmetro numri co que determi na a
severi dade do evento. Se omi ti do,
assume o val or 0, ou seja, severi dade
al ta.
EventTime
Especi fi ca o timestamp do evento. Se
omi ti do, assume o val or do timestamp do
momento da chamada do mtodo.
Source
contedo do campo Fonte do evento. Se
omi ti do, assume uma String vazi a.
EventCategory
Parmetro texto que especi fi ca a
categori a do evento. Se omi ti do, assume
uma String vazi a.
NOME DESCRIO
EventType
Parmetro texto que especi fi ca o ti po do
evento. Se omi ti do, assume o val or
"Tracki ng".
UserFields
Parmetro do ti po Vetor, onde cada
posi o assume o val or do campo
especi fi cado pel o usuri o.
AlarmSourceName
Parmetro texto que especi fi ca o nome
da Fonte de Al arme. Se omi ti do, assume
uma String vazi a.
FullAlarmSourceName
cami nho compl eto da Fonte de Al arme,
i ncl ui ndo a rea, a Confi gurao de
Al arme e as possvei s Pastas onde o
al arme est i nseri do. Se omi ti do,
assume uma String vazi a.
Os demai s campos do evento no podem ser especi fi cados e sempre assumem os
val ores a segui r:
Valor (CurrentValue): 0.0
Qualidade (Quality): ""
Condio Ativa (ConditionActive): 0 (Fal se)
Nome da Condio (ConditionName): ""
Nome da Subcondio (SubConditionName): ""
Reconhecido (Acked): 1 (True)
Precisa Ack (AckRequired): 0 (Fal se)
Habilitado (Enabled): 1 (True)
EventTimeUTC: *Sempre i gual a EventTime (como em eventos de al arme)
Mscara (ChangeMask): 0
Cookie: 0
NOTA: O mtodo fal ha se a opo Guarde alarmes no banco de dados esti ver
desmarcada, ou quando fal ha o armazenamento no banco de dados.
Exempl o:
' No parmetro UserFields, para cada elemento do array,
' ser mostrado o valor atribudo a ele.
Application.GetObject("ServidorAlarmes1").LogTrackingEvent_
"Clicou no boto", Application.User, "Operao", 2, , _
"Boto1", , , array(1, 2, "a", "b")
End Sub
Esta seo contm i nformaes sobre as propri edades do objeto Servi dor de
Al arme.
5.11.4.2.1 ActiveAlarms
Determi na o nmero total de al armes ati vos do si stema. Esta propri edade
5.11.4.2.2 ActiveHighAlarms
5.11.4.2.3 ActiveHighNACKAlarms
5.11.4.2.4 ActiveLowAlarms
5.11.4.2.5 ActiveLowNACKAlarms
5.11.4.2.6 ActiveMedAlarms
5.11.4.2.7 ActiveMedNACKAlarms
5.11.4.2.8 ActiveNACKAlarms
Indi ca o nmero total de al armes que esto sem reconheci mento no si stema
(ati vos ou no). Esta propri edade somente de l ei tura.
5.11.4.2.9 BackupDiscardInterval
Indi ca a quanti dade de uni dades de tempo durante o qual os dados de backup
so manti dos na tabel a pri nci pal e na tabel a de backup, at que sejam descartados
5.11.4.2.10 BackupDiscardTimeUnit
dados de backup permanecem armazenados at serem descartados. As opes
di sponvei s so:
0 - dtHour: horas
1 - dtDay: di as
5.11.4.2.11 DataSource
Defi ne o objeto Banco de Dados que uti l i zado para gravao dos dados dos
al armes. O val or padro desta propri edade uma String vazi a, ou seja, no h
nenhum Banco de Dados para armazenar os dados.
5.11.4.2.12 DiscardInterval
Hi stri co permanecem armazenados na tabel a do banco de dados, at que sejam
automati camente ajusta o val or de BackupDiscardInterval como o dobro do val or
de DiscardInterval. Esta propri edade pode ser modi fi cada em tempo de execuo.
5.11.4.2.13 DiscardTimeUnit
propri edade DiscardTimeUnit i ndi ca a uni dade de tempo em que os dados da tabel a
permanecem armazenados at que sejam descartados. As opes di sponvei s so:
0 - dtHour: horas
1 - dtDay: di as
5.11.4.2.14 EnableBackupTable
Cri a uma tabel a de backup onde os dados descartados permanecem por
segurana. Se confi gurada para True, a tabel a cri ada; do contrri o, no h tabel a
de backup. O val or padro desta propri edade True.
5.11.4.2.15 EnableDiscard
Indi ca descarte dos dados dos al armes aps um certo tempo. Se confi gurada
para Fal se, os dados so armazenados i ndefi ni damente na tabel a; do contrri o,
so descartados aps determi nado tempo. O val or padro dessa propri edade
Fal se.
5.11.4.2.16 InactiveHighNACKAlarms
5.11.4.2.17 InactiveLowNACKAlarms
5.11.4.2.18 InactiveMedNACKAlarms
5.11.4.2.19 InactiveNACKAlarms
5.11.4.2.20 Logging
Cri a o regi stro das i nformaes dos al armes no banco de dados especi fi cado
pel a propri edade DataSource. Se confi gurado para Fal se, o regi stro no cri ado; do
contrri o, o regi stro fei to. O val or padro desta propri edade Fal se.
5.11.4.2.21 TableName
Defi ne um nome para a tabel a de al armes. O val or padro "Al arms". Pode ser
modi fi cada em tempo de execuo e seu efei to i medi ato.
5.11.4.2.22 VerificationInterval
5.11.4.2.23 VerificationUnit
Esta propri edade trabal ha em conjunto com a propri edade VerificationInternal.
A propri edade VerificationUnit i ndi ca a uni dade de tempo em que fei ta a
0 - dtHour: horas
1 - dtDay: di as
486 Dvidas Mais Frequentes
6
Dvidas Mais Frequentes
CAPTULO
Como fazer para que uma Tela janelada mostre a barra de ttulo com botes de
minimizar, maximizar e fechar?
Para i sto, deve-se uti l i zar o mtodo SetFrameOptions do Di vi sor. O parmetro Flags
especi fi ca caractersti cas da janel a. O val or 127 defi ne uma janel a com os botes
Minimizar, Maximizar e Fechar vi svei s.
Como abrir uma Tela modal?
Para abri r uma Tel a modal , uti l i ze o mtodo DoModal do Vi ewer. Por exempl o:
Application.DoModal "Tela1", "Ttulo1", 0, 0, 400, 200, 0, 1
Este cdi go abre uma Tel a de nome Tela1, com o ttul o "Ttul o1", na posi o (0, 0),
com 400 pi xel s de l argura e 200 pi xel s de al tura, passa o val or 0 como parmetro
para a Tel a e habi l i ta a barra de ttul o da janel a.
Como fao para copiar valores de uma linha do E3Browser para um Tag?
Pri mei ro, sel eci one a l i nha (ou o regi stro) desejada no E3Browser. Depoi s, uti l i ze o
mtodo GetColumnValue do E3Browser. O parmetro Index o ndi ce da col una a
ser copi ada (i ni ci ando em 0).
Como impedir que o usurio digite uma String em um SetPoint?
Veri fi que se o val or di gi tado numri co no evento Validate. Por exempl o:
Sub Text1_Validate(Cancel, NewValue)
If NOT IsNumeric(newValue) Then
MsgBox "O valor deve ser numrico."
Cancel = True
End If
End Sub
Como abrir um calendrio para selecionar data e hora ao clicar em um SetPoint?
Usando o mtodo ShowDatePicker no evento Click do SetPoi nt. Por exempl o:
Sub Text1_Click()
Dim datevalue
If Application.ShowDatePicker(datevalue) Then
Value = datevalue
End If
End Sub
Dvidas Mais Frequentes 487
Como reconhecer todos os alarmes de uma rea?
Para reconhecer todos os al armes de uma rea por scri pt, possvel uti l i zar o
mtodo AckArea. Este mtodo tem doi s parmetros, a saber:
Area o nome da rea de Al armes da qual se quer reconhecer o al arme
User o nome do operador l ogado, que pode ser o i tem Application.User
Para reconhecer todos os al armes ati vos, possvel uti l i zar o mtodo AckAllAlarms.
Como executar uma ao ao clicar em um boto especfico do mouse ou em uma
tecla?
Usando os eventos KeyDown ou KeyUp da Tel a. Estes eventos so di sparados
quando uma tecl a pressi onada ou sol ta e retornam doi s parmetros. Um o
cdi go ASCII da tecl a que foi pressi onada, e o outro i ndi ca a condi o das tecl as
SHIFT e CTRL no momento em que a tecl a foi pressi onada. A i dei a comparar o
parmetro de retorno do evento com o cdi go em ASCII do caractere esperado.
Como criar um script WhileRunning?
Cri ando um evento associ ado a al guma propri edade que tenha sempre o mesmo
val or. Por exempl o, a propri edade Visible de um objeto de Tel a. Enquanto o objeto
esti ver vi svel (com a propri edade Visible i gual a True), o scri pt ser executado.
Porm recomendado evi tar o uso de scri pts do ti po WhileRunning, poi s podem
prejudi car a performance da apl i cao. Na mai ori a dos casos, el es podem ser
substi tudos por Associ aes.
Como criar um script OnValueChanged?
Cri ando um evento associ ado propri edade Value do Tag, que seja executado
quando a propri edade al terar o seu val or.
NOTA: Ateno para no usar mtodos do Vi ewer no Servi dor, como por exempl o o
mtodo MsgBox. Se for o caso, o evento pode ser cri ado na Tel a ou at no prpri o
objeto Vi ewer, ao i nvs de ser cri ado no Tag.
Como criar Tags e objetos de Tela em tempo de execuo?
Usando o mtodo AddObject. Por exempl o, o scri pt a segui r cri a Tags de
Comuni cao no Dri ver Driver1.
Set obj = Application.GetObject("Driver1")
For i = 1 To 100
Set tag = obj.AddObject("IOTag", false)
tag.Name = "IOTag" & CStr(i)
488 Dvidas Mais Frequentes
tag.Activate
Next
Como mostrar uma mensagem na Tela ao alterar o valor de um Tag?
Cri ando um evento na Tel a associ ado propri edade Value do Tag, que seja
executado quando a propri edade al terar o seu val or. Neste evento, uti l i ze o mtodo
MsgBox para mostrar a mensagem.
Como criar uma Consulta com filtro por data antes de montar um Relatrio?
Para fazer i sto, necessri o confi gurar o objeto Consul ta (ver o captul o Consulta),
que acompanha o Rel atri o, e cri ar as vari vei s necessri as na col una Filtro. No
evento de chamada de Rel atri o, use um scri pt semel hante a este:
Set relatorio = Application.LoadReport("[Relatrio1]")
Set consulta = Relatorio.Query()
Consulta.SetVariableValue "Variavel1", Valor1
Consulta.SetVariableValue "Variavel2", Valor2
Relatorio.PrintPreview()
Onde:
[Relatrio1] o nome do Rel atri o a ser chamado
Variavel1, Variavel2 so as vari vei s cri adas no fi l tro do campo E3TimeStamp
Valor1, Valor2 so as datas a serem consul tadas
Para veri fi car outros ti pos de fi l tros, consul te o captul o Consulta ou a
documentao di sponvel no Elipse Knowledgebase.
Como depurar erros de scripts no servidor e no Viewer?
Caso o evento seja executado no Vi ewer, uti l i ze o mtodo MsgBox. J se o evento for
executado no servi dor, uti l i ze o mtodo Trace.
Matriz
Rua 24 de Outubro, 353 - 10 andar
90510-002 Porto Alegre RS
Fone: (51) 3346-4699
Fax: (51) 3222-6226
E-mail: elipse@elipse.com.br
Filial SP
Rua dos Pinheiros, 870 - Conj. 141/142
05422-001 So Paulo - SP
Fone: (11) 3061-2828
Fax: (11) 3061-2828
E-mail: elipse-sp@elipse.com.br
Filial PR
Av. Sete de Setembro, 4698/1705
80240-000 Curitiba - PR
Fone: (41) 3342-0120
Fax: (41) 3342-0120
E-mail: elipse-pr@elipse.com.br
Consulte nosso website para informaes sobre o representante do seu estado.
www.elipse.com.br
USA
2501 Blue Ridge Road, Suite 250
Raleigh - NC - 27607 USA
Fone: +1 (252) 995-6885
Fax: +1 (252) 995-5686
E-mail: info@elipse-software.com
Filial MG
Rua Antnio de Albuquerque, 156
7 andar Sala 705
30112-010 Belo Horizonte - MG
Fone: (31) 2511-2121
E-mail: elipse-mg@elipse.com.br
Taiwan
9F., No.12, Beiping 2nd St., Sanmin Dist.
807 Kaohsiung City - Taiwan
Telefone: +886 (7) 323-8468
Fax: +886 (7) 323-9656
E-mail: evan@elipse.com.br
Filial RJ
Praia de Botafogo, 300/525
22250-044 Rio de Janeiro - RJ
Fone: (21) 2158-1015
Fax: (21) 2158-1099
E-mail: elipse-rj@elipse.com.br
kb.elipse.com.br
elipse@elipse.com.br

E3scripts PTB

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

E3scripts PTB

Enviado por

Direitos autorais:

Formatos disponíveis

Copyright 2014 Elipse Software Ltda. Todos os direitos reservados. Verso 4.

Você também pode gostar