Documente Academic
Documente Profesional
Documente Cultură
I
5.9 ..........................................................................................................................................
Históricos 563
5.10..........................................................................................................................................
Storage 568
5.11..........................................................................................................................................
Fórmulas 575
5.12..........................................................................................................................................
Alarmes 580
6.................................................................................................................................................
Dúvidas Mais Frequentes 607
II
CAPÍTULO
Introdução
1
Os Scripts são módulos de linguagem de programação nos quais se pode criar
procedimentos associados a eventos específicos, permitindo uma maior
flexibilidade no desenvolvimento de aplicações. Cada objeto (item de um
aplicativo) do Elipse Power possui uma lista de eventos previamente definidos, mas
também é possível definir novos eventos próprios do usuário.
1.1 Objetos
Os Objetos são componentes de software reutilizáveis que permitem maximizar o
uso e aumentar a qualidade e produtividade em seus aplicativos.
Um objeto no Elipse Power encapsula ou contém três diferentes partes
(propriedades, métodos e eventos) que podem ser manipuladas para a utilização
das vantagens de sua funcionalidade na aplicação.
Propriedades definem atributos de um objeto, como a aparência de um objeto de
Tela ou o valor inicial de um objeto quando o aplicativo é iniciado.
Métodos são funções que realizam uma ação específica dentro ou com um objeto.
Eventos são notificações geradas por um objeto em resposta a alguma ocorrência
em particular, como um clique de mouse ou uma mudança no valor de um Tag,
entre outros.
Uma das principais características dos objetos e das linguagens orientadas a
objeto é a capacidade de herança entre eles, ou seja, estes podem herdar as
características de um ou mais objetos, tendo as mesmas funcionalidades
específicas. Assim, pode se ter vários objetos trabalhando em conjunto para prover
características de um outro objeto derivado.
Tome como exemplo o objeto E3Chart. Ele é composto internamente de vários
objetos, como títulos, legendas, escalas, divisões, consultas e penas. Note que cada
objeto contribui para a funcionalidade do todo: as escalas ajudam a localizar os
valores dos pontos no E3Chart; as legendas, a identificar a pena e seus valores; e a
pena realiza o desenho dos valores no E3Chart.
Através da manipulação de objetos dentro do E3Chart, pode-se criar duas
instâncias deste objeto bastante diferentes entre si. Para se manipular um objeto
específico, deve-se acessá-lo através de uma hierarquia. Se os dois objetos E3Chart
estiverem na mesma Tela, deve-se acessar primeiro a Tela, depois o E3Chart
desejado, depois uma de suas propriedades ou objetos filhos. Quando há vários
objetos de um mesmo tipo, geralmente eles podem ser acessados através de uma
coleção (collection). Uma coleção é um objeto especial que gerencia um conjunto de
objetos semelhantes. Um exemplo no objeto E3Chart é a coleção Pens, que permite
Introdução 1
o acesso a todas as penas do E3Chart.
1.2 Scripts
A linguagem que o Elipse Power Studio usa em seus scripts é o VBScript, um
subconjunto da linguagem Visual Basic® desenvolvida pela Microsoft. O VBScript
possui um interpretador rápido, leve e portável, desenvolvido para uso em
navegadores para a Internet e outras aplicações que usam ActiveX Controls,
Automation Servers e Java Applets.
Conforme visto anteriormente, os scripts são associados a eventos de um objeto.
Entretanto, para facilitar e aumentar a velocidade de desenvolvimento, o Elipse
Power já incorpora algumas ações mais comuns que poderiam ser realizadas com
scripts, através de assistentes chamados Picks. Pode-se portanto definir que um
determinado evento executará um script, um Pick ou uma combinação deles, em
uma sequência também pré-definida.
Cada Editor do Elipse Power Studio apresenta pelo menos duas abas na parte
inferior: Design e Scripts, com exceção dos objetos Banco de Dados e Servidor de
Alarmes, que não possuem a aba Design. Os objetos e seus filhos podem ser
manipulados na aba Design. Para manipular seus scripts, utilize a aba Scripts. As
opções disponíveis na aba Scripts estão descritas na tabela a seguir.
Opções disponíveis na aba Scripts
ÍCONE OPÇÃO DESCRIÇÃO
Lista de Objetos Sel eci ona o objeto
cujo s cri pt s erá
ma ni pul a do
Lista de Eventos Sel eci ona o
evento a s er
a pl i ca do a o
objeto
Script Adi ci ona um s cri pt
a s s oci a do a o
evento
Pick Abrir Tela Adi ci ona um Pi ck
Abrir Tela
Pick Abrir Tela Adi ci ona um Pi ck
Modal Abrir Tela Modal
Pick Executar Adi ci ona um Pi ck
Aplicação Executar Aplicação
Pick Carregar Valor Adi ci ona um Pi ck
Carregar Valor
Pick Inverter Valor Adi ci ona um Pi ck
Inverter Valor
Pick Imprimir Adi ci ona um Pi ck
Relatório Imprimir Relatório
2 Introdução
ÍCONE OPÇÃO DESCRIÇÃO
Remover script ou Remove o s cri pt
Pick selecionado ou o Pi ck
s el eci ona do na
Li s ta de Ações
Mover script ou Pick Move a a çã o
selecionado para s el eci ona da pa ra
cima ci ma , na ordem da
Li s ta de Ações
pa ra o evento
Mover script ou Pick Move a a çã o
selecionado para s el eci ona da pa ra
baixo ba i xo, na ordem
da Li s ta de Ações
pa ra o evento
AppBrowser Abre a ja nel a do
AppBrows er
Procurar Bus ca por
ocorrênci a s de um
determi na do texto
Sel eci ona na l i s ta
de res ul ta dos a
Procurar anterior
ocorrênci a
a nteri or
Procurar próxima Sel eci ona na l i s ta
de res ul ta dos a
ocorrênci a
s egui nte
Substituir Subs ti tui a s
ocorrênci a s
encontra da s por
outro texto
es peci fi ca do
Criar evento do Cri a um evento de
usuário us uá ri o
Remover evento do Remove o evento
usuário de us uá ri o
s el eci ona do
Editar evento do Edi ta o evento de
usuário us uá ri o
s el eci ona do
Compila o script Compi l a o s cri pt
selecionado s el eci ona do,
mos tra ndo os
erros no pa i nel
Mens a gens
Compilar todos os Compi l a todos os
scripts deste evento s cri pts a s s oci a dos
a o evento
Introdução 3
ÍCONE OPÇÃO DESCRIÇÃO
Compila todos os Compi l a todos os
eventos deste eventos
objeto a s s oci a dos a o
objeto
A ordem de execução das ações é de cima para baixo. Para alterar a ordem, pode-se
utilizar as opções e . Utilize a opção para verificar se não há erros no script
especificado para o evento. As mensagens de erro do compilador são apresentadas
no painel Mensagens, que pode estar em uma janela flutuante ou ancorado na
parte inferior ou superior da aba Scripts. Clique duas vezes no erro caso deseje que
ele seja selecionado no script.
Mensagem do compilador
Introdução 5
Adicionando um script ao objeto
3. Digite os comandos VBScript desejados na caixa de edição de texto.
NOTA: Uti l i ze o ca ra ctere de s ubl i nha do qua ndo des eja r a cres centa r uma quebra de
l i nha , pa ra dei xa r o códi go ma i s l egível . O ca ra ctere de s ubl i nha do i ndi ca que o
códi go conti nua na l i nha s ubs equente.
Por exemplo:
If intTemperaturaCaldeira3 > 120 and _
intTemperaturaCaldeira4 > 120 Then
bEnviarAlarme = True
bAlarmeLigado = True
End If
Cada evento pode ter vários scripts e vários Picks associados, chamados Ações do
Evento. A lista das ações pode ser vista na parte superior da janela de edição de
scripts. Cada objeto pode ter qualquer quantidade de eventos com scripts ou Picks
associados.
6 Introdução
NOTA: Ao cl i ca r com o botã o di rei to do mous e s obre qua l quer des ta s a ções
des cri ta s a nteri ormente, a bre-s e um menu contextua l que pos s i bi l i ta recorta r,
copi a r e col a r s cri pts e Picks entre eventos .
1.3 Picks
Os Picks implementam uma forma mais amigável de realizar procedimentos mais
comuns, poupando tempo de configuração. Entre eles, estão ações como troca de
Tela ou atribuição de valores, bastante comuns na criação de um projeto. A seguir
são descritos os Picks disponíveis na aba Scripts.
Introdução 7
OPÇÃO DESCRIÇÃO
No quadro Indi ca o Qua dro onde a Tel a s erá
vi s ua l i za da . Se es ti ver em bra nco, s erá o
Qua dro pri nci pa l (_top).
Zoom inicial Defi ne o zoom da Tel a , qua ndo
mos tra da .
Parâmetro Indi ca um pa râ metro a s er pa s s a do na
cha ma da da Tel a .
Habilitar scroll da tela Ha bi l i ta o us o da s ba rra s de rol a gem na
Tel a .
Especificar posição da tela Indi ca a pos i çã o da Tel a , em pi xel s .
Especificar tamanho da tela Indi ca o ta ma nho da Tel a , em pi xel s ou
Hi metri c.
Estilo da janela Abre a ca i xa de di á l ogo Estilo de janela.
8 Introdução
Caixa de diálogo Estilo de Janela
Introdução 9
Configurações do Pick Abrir Tela Modal
Opções disponíveis no Pick Abrir Tela Modal
OPÇÃO DESCRIÇÃO
Abrir a tela Sel eci ona a Tel a a s er a berta .
Título Defi ne o títul o da ja nel a . Es s e texto s erá
conca tena do com o nome da Tel a .
Zoom inicial Defi ne o zoom da Tel a , qua ndo
mos tra da .
Parâmetro Indi ca um pa râ metro a s er pa s s a do na
cha ma da da Tel a .
Habilitar scroll da tela Ha bi l i ta o us o da s ba rra s de rol a gem na
Tel a .
Especificar a posição da tela Determi na a pos i çã o, em pi xel s , do
qua dro na Tel a , a pa rti r do ca nto
s uperi or es querdo da Tel a .
Especificar o tamanho da tela Determi na a l a rgura e a a l tura , em pi xel s
ou Hi metri c, da Tel a .
Estilo da janela Permi te confi gura r o es ti l o da ja nel a a
s er mos tra da , defi ni ndo títul o e a
di s poni bi l i da de da s borda s e botões de
fecha r, entre outra s opções (ver o tópi co
Caixa de Diálogo Estilo de Janela).
10 Introdução
1.3.3 Executar Aplicação
Executa uma aplicação específica.
Introdução 11
1.3.4 Carregar Valor
Carrega um valor em um Tag.
Introdução 13
1.3.6 Imprimir Relatório
Permite imprimir um Relatório em uma impressora ou em tela.
14 Introdução
OPÇÃO DESCRIÇÃO
Especificar o tamanho da tela Es peci fi ca o ta ma nho da prévi a de
i mpres s ã o na tel a , em pi xel s ou em
Hi metri c. Se es tes va l ores nã o forem
defi ni dos , a prévi a de i mpres s ã o é cri a da
com o ta ma nho de 500 x 500 pi xel s e a
ja nel a é a berta ma xi mi za da . Se a pena s
uma da s di mens ões for defi ni da , l a rgura
ou a l tura , a outra di mens ã o é confi gura da
pa ra 500 pi xel s e a ja nel a nã o é a berta
ma xi mi za da .
Introdução 15
Janela para a adição de eventos definidos pelo usuário
Opções disponíveis na janela Eventos
OPÇÃO DESCRIÇÃO
Nome do Evento Nome que i denti fi ca o evento.
Propriedade ou expressão Expres s ã o gera dora do evento. Pode s er
copi a da a tra vés do AppBrows er, a o cl i ca r
em .
Sempre que a propriedade for uma condição Indi ca que o evento é do ti po etOnEvent (o
verdadeira evento ocorre no momento que a
expres s ã o for verda dei ra ) ou etWhileEvent
(o evento ocorre ci cl i ca mente, em
i nterva l os pré-defi ni dos ).
Repetir o evento Qua ndo preenchi do, i ndi ca que o evento é
do ti po etWhileEvent. Indi ca o ci cl o de
repeti çã o do evento em mi l i s s egundos ,
i s to é, de qua nto em qua nto tempo el e
ocorre, enqua nto a expres s ã o gera dora for
verda dei ra .
Sempre que a propriedade alterar o seu Indi ca que o evento é do ti po
valor etOnValueChanged, i s to é, o evento ocorre
s empre que a expres s ã o gera dora muda r
de va l or.
Tratar a desconexão como mudança de Indi ca s e a conexã o ou des conexã o da
valor expres s ã o gera dora do evento deve s er
tra ta da como muda nça .
16 Introdução
2. Clique em OK para completar o processo e inserir o evento. Ele aparece na lista
de eventos.
3. Para alterar este evento, selecione-o e clique em Editar evento do usuário .A
janela anterior é aberta novamente para a edição de dados do evento.
4. Para apagar este evento, selecione-o e clique em Remover evento do usuário
.
IMPORTANTE: Qua ndo s e cl i ca em Remover evento do usuário, os s cri pts des te evento
s ã o perdi dos .
Introdução 17
CAPÍTULO
Programando no Elipse Power
2
Apesar de a maioria dos aspectos do VBScript se aplicarem à programação de
scripts no Elipse Power, algumas particularidades devem ser destacadas no que diz
respeito às implementações do conceito de orientação a objetos no sistema.
O VBScript é uma linguagem baseada no Visual Basic que traz a capacidade de
scripting (roteirização) para aplicações que rodam no sistema operacional
Windows.
O VBScript troca informações com as aplicações utilizando a tecnologia ActiveX
Scripting. Com o ActiveX Scripting, navegadores e outras aplicações cliente, como o
Viewer, podem compilar scripts e chamar funções, dentre outros procedimentos.
Isso possibilita que scripts desenvolvidos para uma aplicação ou biblioteca, que
devam ser executados na interface gráfica, possam ser executados tanto no Viewer
quanto em um navegador de Internet, sem a necessidade de qualquer adaptação do
aplicativo.
Mais informações sobre o VBScript podem ser obtidas no manual Guia de
Referência do VBScript, no Grupo de Programas Elipse Power.
Pode-se declarar múltiplas variáveis separando cada nome de variável com uma
vírgula. Por exemplo:
Dim Esquerda, Direita, Topo, Base
Tais limitações são decorrentes do fato de que, por definição, existe uma
independência entre o que cada uma das estações Viewer está executando ou
visualizando e o servidor, e vice-versa. Por isso, todas as atividades, tanto do
servidor como do Viewer, necessitam ser coordenadas de forma assíncrona ou
através de eventos para operarem de forma harmoniosa.
Logo, devido a esta independência ao se criar um script, primeiro deve-se obter
uma referência correta dos objetos que se deseja manipular, ou seja, é necessário
que o objeto seja primeiramente encontrado nos vários módulos do Elipse Power.
Vale repetir que, ao se editar um script, o usuário poderá utilizar o AppBrowser,
que permite copiar para o script o caminho de um método ou propriedade de forma
completa, auxiliando-o na criação de scripts.
Portanto, para acessar os objetos externos que estão sendo manipulados em um
script, são utilizadas algumas diretivas básicas. Por exemplo, para se manipular o
valor de um Tag de Comunicação, o caminho é Servidor - Driver - Pasta (se houver) -
Tag. Já se o objetivo é manipular um botão na Tela, o caminho é Viewer - Quadro
(se houver) - Tela - Botão.
Existem basicamente três localizações de origem de scripts, do ponto de vista da
metodologia para acesso dos objetos:
Servidor
Telas e Quadros (Viewer)
ElipseX (bibliotecas): podem ser XObjects (rodam no servidor) e XControls
(rodam no Viewer)
Ou ainda:
20 Programando no Elipse Power
Sub Button1_Click()
Application.GetObject("Driver1.tag001").AllowRead = False
End Sub
Neste caso, a variável obj está apontando para o objeto Driver1 e na próxima vez
que se quiser acessar algum objeto que descende de Driver1 dentro do script,
pode-se utilizar a variável obj diretamente. Isto traz um ganho de performance, já
que cada chamada do método GetObject faz um acesso ao servidor. Através desta
técnica, chamadas desnecessárias ao servidor são evitadas. Este exemplo usa o
comando Set, que será explicado mais adiante. Note que a utilização de variáveis
também torna o código mais claro e de modificação mais fácil. Caso seja
necessário alterar o objeto no qual queremos executar comandos, basta mudar a
linha de atribuição dessa variável.
A palavra Application nos scripts pode indicar tanto funções que são executadas no
Viewer quanto no servidor. Neste caso, o objeto Application sabe de antemão quais
funções devem ser executadas tanto para um quanto para o outro caso. Não é
possível, entretanto, executar funções de Viewer dentro do servidor, assim como
também não é possível executar funções de servidor dentro do Viewer.
Aba Design
Se o ElipseX possui objetos internos, então é possível utilizar o método Item para
obter uma referência destes objetos, como no script a seguir:
Sub XControl1_OnStartRunning()
Item("Texto1").Value = "motor"
Item("Retangulo1").ForegroundColor = RGB(212, 208, 20)
End Sub
XControl (exemplo)
Para alterar a propriedade Propriedade1 do XControl pode-se fazer o seguinte
script no evento Click de um botão:
Sub CommandButton1_Click()
Screen.Item("XControl11").Propriedade1 = True
End Sub
Ou ainda:
Sub CommandButton1_Click()
28 Programando no Elipse Power
Parent.Item("XControl11").Propriedade1 = True
End Sub
XObject (exemplo)
Um script para alterar a propriedade Valor do XObject seria:
Sub CommandButton1_Click()
Application.GetObject("Dados.XObject11").Valor = 123
End Sub
Ou ainda:
Sub CommandButton1_Click()
Application.GetObject("Dados").Item("XObject11").Valor = 123
End Sub
Note que:
As Associações dentro da biblioteca são internas, e seu formato é
Nome_do_Controle.Nome_da_Propriedade
O objeto, depois de inserido na Tela, deve ter estas propriedades associadas
aos Tags verdadeiros, para cada um dos motores
Uma Associação de um Tag para a propriedade Estado tem que ser realizada
para cada objeto MotorA
2.4.1 Propriedades
Para referenciar as propriedades de um objeto, deve-se usar o método GetObject. A
sintaxe é a seguinte:
Application.GetObject("<objeto>").<propriedade>
Que é equivalente a:
Button1.Value = False
2.4.2 Métodos
A sintaxe a seguir exemplifica a chamada de um método que não precisa de
parâmetros:
Application.GetObject("<objeto>").<metodo>
Sub CommandButton2_Click()
' Remove a primeira Pena
Screen.Item("E3Chart1").Pens.Remove 0
End Sub
NOTA: O pri mei ro objeto em uma col eçã o pos s ui índi ce 1 (um).
Ou ainda:
Sub CommandButton1_Click()
' Modifica a cor da pena com nome "Pena2"
Screen.Item("E3Chart1").Pens.Item("Pena2").Color = RGB(212,
208, 20)
End Sub
Neste exemplo foi feita a mesma tarefa que na seção anterior, porém a parte
referente a como chegar até o objeto específico havia sido omitida. Sem o comando
Set, a mesma chamada teria que ser escrita da seguinte forma:
Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(212, 208, 20)
Aparentemente, não existe vantagem neste caso, pois pode-se fazer tudo em uma
única linha de código. Porém, se logo abaixo no mesmo script outras operações
forem necessárias, o processo se torna mais simples e rápido se a chamada ao
método Item não tiver sido colocada em todas as linhas.
Sub CommandButton1_Click()
' Exemplo ruim
Screen.Item("E3Chart1").Pens.Item(0).Color = RGB(212, 208,
20)
Screen.Item("E3Chart1").Pens.Item(1).Color = RGB(200, 208,
20)
Screen.Item("E3Chart1").Pens.Item(2).Color = RGB(100, 208,
20)
End Sub
Sub CommandButton2_Click()
' Exemplo melhor
Set Penas = Screen.Item("E3Chart1").Pens
Penas.Item(0).Color = RGB(212, 208, 20)
Penas.Item(1).Color = RGB(200, 208, 20)
Penas.Item(2).Color = RGB(100, 208, 20)
End Sub
2.7 E3Globals
O E3Globals é um módulo do Elipse Power que contém métodos de uso global. Os
métodos GetCurrentWindowsUserName, GetLocalTime e GetLocalTimeUTC não
podem ser utilizados em Associações, somente em scripts. O restante dos métodos
pode ser utilizado tanto em scripts quanto em Associações.
A forma de utilização destes métodos admite duas sintaxes, E3Globals.<método>
ou simplesmente <método>, exceto no caso do objeto Relatório, onde a sintaxe
E3Globals.<método> é obrigatória.
2.7.1 Métodos
Esta seção contém informações sobre os métodos do módulo E3Globals.
2.7.1.2 BShr
BShr(Value, Bits[, PreserveSign])
Retorna o valor passado no parâmetro Value deslocado à direita o número de bits
especificado no parâmetro Bits. Este método retorna um erro caso o parâmetro Bits
esteja fora da faixa permitida (entre 0 e 31). O parâmetro PreserveSign é um
Booleano opcional que, se verdadeiro, preenche os bits à esquerda com uma cópia
do bit de sinal. O valor padrão deste parâmetro (Falso) preenche os bits à esquerda
com zeros. Este método está disponível tanto em Associações quanto em scripts.
2.7.1.3 Choose
Choose(Index, Values)
Retorna um dos itens especificados em Values, baseado no parâmetro Index
(iniciando em zero). Este método retorna Null caso o valor de Index seja menor que
0 (zero) ou maior ou igual ao número de valores em Values. Este método está
disponível tanto em Associações quanto em scripts.
2.7.1.4 E3Format
E3Format(Value, Format)
Formata a expressão em Value utilizando o formato especificado em Format. Este
formato utiliza as mesmas definições da propriedade Format de objetos Texto,
Display e SetPoint. Este método está disponível tanto em Associações quanto em
scripts.
2.7.1.6 GetComputerName
GetComputerName()
Retorna uma String contendo o nome do computador atual. Este método está
disponível tanto em Associações quanto em scripts.
2.7.1.7 GetCurrentWindowsUserName
GetCurrentWindowsUserName()
Retorna uma String contendo o nome do usuário logado no processo corrente. Este
método não está disponível em Associações, somente em scripts.
2.7.1.8 GetLocalTime
GetLocalTime()
Retorna a data e hora do computador local, com precisão de milissegundos e no
fuso horário local. Este método não está disponível em Associações, somente em
scripts.
2.7.1.9 GetLocalTimeUTC
GetLocalTimeUTC()
Retorna a data e hora do computador local, com precisão de milissegundos e no
fuso horário UTC (Tempo Universal Coordenado). Este método não está disponível
em Associações, somente em scripts.
2.7.1.10 IIf
IIf(Condition, ExprTrue, ExprFalse)
Retorna a expressão contida em ExprTrue se a condição avaliada em Condition for
verdadeira, e a expressão contida em ExprFalse se a condição avaliada for falsa.
Este método está disponível tanto em Associações quanto em scripts.
2.7.1.11 OPCGetLimit
OPCGetLimit(Quality)
Retorna a informação de Limite de uma Qualidade OPC especificada no parâmetro
Quality. Este método está disponível tanto em Associações quanto em scripts. Os
valores possíveis de retorno deste método são:
0: Livre
1: Baixo
2: Alto
3: Constante
2.7.1.12 OPCGetQuality
OPCGetQuality(Quality)
Retorna a informação de Qualidade de uma Qualidade OPC especificada no
parâmetro Quality. Este método está disponível tanto em Associações quanto em
scripts. Os valores possíveis de retorno deste método são:
0: Ruim
1: Incerta
2: Não utilizada
3: Boa
2.7.1.13 OPCGetSubStatus
OPCGetSubStatus(Quality)
Retorna a informação de Substatus (de 0 a 15) de uma Qualidade OPC especificada
no parâmetro Quality. Este método está disponível tanto em Associações quanto em
scripts. O Padrão OPC especifica os seguintes valores:
Qualidade Boa:
0: não especificado
1: sobrescrita local
Qualidade Ruim:
2.7.1.14 OPCGetVendor
OPCGetVendor(Quality)
Retorna a informação de Reservado para o Fabricante (de 0 a 255) de uma
Qualidade OPC especificada em Quality. Este método está disponível tanto em
Associações quanto em scripts.
2.7.1.15 OPCIsBad
OPCIsBad(Quality)
Retorna verdadeiro se a Qualidade OPC é Ruim, ou falso caso contrário. Este
método está disponível tanto em Associações quanto em scripts.
2.7.1.16 OPCIsGood
OPCIsGood(Quality)
Retorna verdadeiro se a Qualidade OPC é Boa, ou falso caso contrário. Este método
está disponível tanto em Associações quanto em scripts.
2.7.1.17 OPCIsUncertain
OPCIsUncertain(Quality)
Retorna verdadeiro se a Qualidade OPC é Incerta, ou falso caso contrário. Este
2.7.1.18 OPCMakeQuality
OPCMakeQuality(QualityFlag, SubStatus, Limit, Vendor)
Retorna um novo valor de Qualidade OPC utilizando os valores passados nos
parâmetros QualityFlag, SubStatus, Limit e Vendor. Este método está disponível tanto
em Associações quanto em scripts. Os valores possíveis para cada um dos
parâmetros são os seguintes:
QualityFlag: Especifica a qualidade do valor
0: Ruim
1: Incerta
3: Boa
SubStatus: Especifica o substatus do valor (entre 0 e 15, veja o método
OPCGetSubStatus para os valores possíveis). Se este parâmetro for omitido,
assume o valor 0
Limit: Especifica o limite do valor. Se este parâmetro for omitido, assume o valor
0
0: Livre
1: Baixo
2: Alto
3: Constante
Vendor: Valor específico do fabricante (entre 0 e 255). Se este parâmetro for
omitido, assume o valor 0
2.7.1.19 OPCSetLimit
OPCSetLimit(Quality, Limit)
Modifica a informação de Limite de uma Qualidade OPC e retorna o valor
modificado. Este método está disponível tanto em Associações quanto em scripts.
Os valores possíveis para o parâmetro Limit são:
0: Livre
1: Baixo
2: Alto
3: Constante
2.7.1.21 OPCSetSubStatus
OPCSetSubStatus(Quality, SubStatus)
Modifica a informação de Substatus de uma Qualidade OPC (de 0 a 15) e retorna o
valor modificado. Este método está disponível tanto em Associações quanto em
scripts. O Padrão OPC especifica os seguintes valores:
Qualidade Boa:
0: não especificado
1: sobrescrita local
Qualidade Ruim:
0: não especificado
1: erro de configuração
2: não conectado
3: falha no dispositivo
4: último valor conhecido
5: falha de comunicação
6: fora de serviço
Qualidade Incerta:
0: não especificado
1: último valor utilizável
4: sensor não confiável
5: unidade de engenharia excedida
2.7.1.22 OPCSetVendor
OPCSetVendor(Quality, Vendor)
Modifica a informação de Reservado para o Fabricante (de 0 a 255) de uma
Qualidade OPC e retorna o valor modificado. Este método está disponível tanto em
Associações quanto em scripts.
2.7.1.23 SetBit
SetBit(Value, BitIndex, BitValue)
Ajusta o valor de Value (verdadeiro ou falso) do bit especificado em BitIndex para
BitValue. Este método retorna um erro caso o parâmetro BitIndex esteja fora da
faixa permitida (entre 0 e 31). Este método está disponível tanto em Associações
quanto em scripts.
2.7.1.24 SourceTypeName
SourceTypeName(SourceType)
Retorna uma String com a descrição da Fonte de Medida ativa (propriedade
ActiveSource dos objetos Medida Analógica e Medida Discreta do Elipse Power). Este
método está disponível tanto em Associações quanto em scripts. Os valores
possíveis para o parâmetro SourceType são os seguintes:
-1: String vazia
0: Fonte Ativa
1: SCADA
2: Operador
3: Centro de Comando
4: Faturamento
5: Calculada
6: Banco de Dados
100: Processador Topológico
101: Fluxo de Potência
102: Estimador de Estados
103: Descarte de Cargas
104: Modelagem de Cargas para Distribuição
2.8.1 Eventos
Eventos são ocorrências relacionadas a um objeto, que permitem disparar ações
programadas. Existem basicamente, dois tipos de eventos: Físicos (ou Externos) e
Internos. Os Eventos Físicos são, por exemplo, ações do usuário. No caso do usuário
digitar algo no teclado, a informação relevante pode ser a tecla pressionada, ou se
o usuário apontar e clicar com o mouse, a informação relevante é a posição do
cursor e o status dos botões. Os Eventos Internos são, por exemplo, mudanças de
valor de uma variável (Tag) na aplicação. Como o Tag pode ser associado a um
dispositivo externo, diz-se que os eventos internos podem ter associações físicas,
como a mudança da temperatura de uma câmara, por exemplo.
Note que na chamada tem-se duas variáveis, KeyCode e Shift. O Elipse Power irá
atribuir valores a essas variáveis automaticamente no momento da ocorrência do
evento. Neste caso, KeyCode irá receber o código da tecla pressionada e Shift
receberá Verdadeiro ou Falso, conforme a tecla SHIFT esteja pressionada ou não.
2.8.1.2 OnStartRunning
OnStartRunning()
Ocorre tão logo um objeto seja iniciado. Exemplo (Meses é um Tag Interno e utiliza
o evento OnStartRunning para inicializar o vetor):
Sub Meses_OnStartRunning()
Value = Array ("Janeiro", "Fevereiro", "Março", "Abril",_
Programando no Elipse Power 49
"Maio", "Junho", "Julho", "Agosto", "Setembro", "Outubro",_
"Novembro", "Dezembro")
End Sub
2.8.1.3 OnStopRunning
OnStopRunning()
Ocorre quando termina a execução de uma instância deste objeto. Utilize o evento
OnStopRunning para realizar operações de finalização para o objeto. Exemplo:
Sub TagInterno1_OnStopRunning()
' Quando finaliza o objeto TagInterno1
' atribui False ao TagInterno2
Set tag2 = Application.GetObject("Dados.TagInterno2")
tag2.Value = False
End Sub
2.8.2 Métodos
Neste capítulo são listados os métodos comuns aos objetos do Elipse Power. Cada
entrada mostra o nome do método com seus respectivos parâmetros, na sintaxe
correta, e um exemplo de utilização do método.
Os parênteses usados nas citações de métodos neste manual servem apenas como
indicativo para diferenciá-los das propriedades. Nos scripts, deve-se seguir esta
mesma regra.
2.8.2.2 Activate
Activate()
Ativa um objeto que está inativo no momento. Exemplo:
2.8.2.3 AddObject
AddObject(ClassName[, Activate[, ObjectName]])
O método AddObject adiciona um novo objeto à aplicação. Este método possui o
parâmetro ClassName, que indica o tipo de objeto que é criado. Por exemplo, para
se criar um retângulo na Tela, o parâmetro ClassName deve ser "DrawRect". O
objeto criado fica contido no objeto que chamou o método AddObject e pode ser
acessado através do método Item.
O parâmetro Activate é opcional e indica se o objeto é ativado após a criação. Se o
objeto for ativado, as Associações e scripts ficam habilitados. Se o objeto for
criado com Activate em Falso, mais tarde ele pode ser ativado pelo método Activate.
O parâmetro ObjectName também é opcional e indica um nome para o objeto
criado. Caso o nome já exista, o novo nome é automaticamente incrementado. Se o
parâmetro não for informado, o novo objeto é nomeado a partir do nome da classe
definida no parâmetro ClassName.
O objeto só é criado se ele for de um tipo compatível com o objeto que o contém.
Para se ter certeza que o objeto foi criado, pode-se utilizar o método IsObject.
NOTA: Apena s os objetos que pos s uem a opçã o Inserir no s eu menu contextua l
podem a ces s a r es te método.
2.8.2.4 Context
Context(ContextName)
Retorna o objeto que implementa o contexto indicado pelo parâmetro ContextName,
que deve ser uma String entre aspas duplas. Este método falha se nenhum objeto na
hierarquia superior do objeto que está chamando este método implementar o
contexto indicado. Os seguintes contextos estão disponíveis:
Container: Objetos de servidor e do Viewer (objetos inseridos em arquivos de
projeto ou em pastas dentro de projetos)
Area: Áreas de Alarme, ou qualquer objeto de servidor cuja propriedade
IsAlarmArea esteja configurada para Verdadeiro
Programando no Elipse Power 51
Device: Objetos Bay, Trecho, Disjuntor, Barramento, Capacitor, Carga de
Distribuição, Alimentador, Gerador, Segmento de Linha de Transmissão,
Carga, Reator, Subestação, Chave, Chave Fusível, Transformador de Dois
Enrolamentos, Transformador de Três Enrolamentos e Linha de Transmissão
Group: Objetos Grupo de Comandos, Grupo de Intertravamentos, Grupo de
Medidas, Grupo de Proteções e Terminal
SwitchGear: Objetos Disjuntor, Chave e Chave Fusível
Transformer: Objetos Transformador de Dois Enrolamentos e Transformador
de Três Enrolamentos
2.8.2.5 Deactivate
Deactivate()
Este método desativa um objeto criado ou previamente ativado pelo método
Activate. Pode-se desativar um objeto quando for necessário realizar uma
configuração prévia (inicialização de propriedades, por exemplo), ou quando se
desejar realizar testes nos quais o objeto não pode estar presente e ativo. Exemplo:
Sub CommandButton1_Click()
Dim obj, novo
Set obj = Application.GetObject("Dados")
Set novo = obj.AddObject("DemoTag", True)
' Desativa o objeto.
novo.Deactivate()
End Sub
2.8.2.6 DeleteObject
DeleteObject(ChildName)
Apaga do projeto o objeto especificado. O parâmetro ChildName é uma String
(ignora maiúsculas e minúsculas) que indica o objeto filho que se deseja apagar. O
método retorna Verdadeiro caso tenha conseguido apagar o objeto, ou Falso caso o
objeto filho não exista.
Para se apagar um objeto a partir de uma referência a um elemento, utiliza-se o
método DeleteObject do objeto pai. Exemplo:
Sub CommandButton1_Click()
Set obj = Application.GetObject("Dados")
If obj.DeleteObject("Tag001") Then
MsgBox("Tag apagado com sucesso!")
Else
MsgBox("Falha em apagar: o tag não existe.")
End If
End Sub
NOTA: Apena s os objetos que pos s uem a opçã o Inserir no s eu menu contextua l
podem a ces s a r es te método.
2.8.2.8 GetObject
GetObject(ObjectPath)
O método GetObject retorna a referência do objeto especificado em ObjectPath. Isto
permite acessar todas as propriedades ou métodos do objeto. Esta é uma prática
bastante comum na programação de scripts no Elipse Power. Ela facilita a
manipulação de objetos e deixa o código mais inteligível. Exemplo:
Sub CommandButton1_Click()
' Atribui o valor 20 à propriedade Value do objeto
' TagInterno1 que está em Dados.
Set tag = Application.GetObject("Dados.TagInterno1")
tag.Value = 20
End Sub
2.8.2.9 Item
Item(ItemId)
Retorna a referência para o objeto filho ItemId do objeto que chamou o método. O
método Item pode buscar um objeto tanto pelo nome quanto pelo índice (inteiro, de
1 até o especificado na propriedade Count). Se o índice ou o nome especificado for
válido, o método Item retorna a referência do objeto. Caso contrário, o método
retorna um erro de "Parâmetro Inválido". Exemplo:
Sub Tela1_Click()
' Atribui a obj a referência 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
54 Programando no Elipse Power
2.8.2.10 Save
Save()
Este método salva o objeto especificado, que foi modificado em tempo de execução
(runtime). Os objetos filhos também são salvos, conforme as especificações do
objeto pai. Este método não é válido para os objetos Tela e Viewer. Exemplo:
Sub CommandButton1_Click()
Set area = Application.GetObject("ConfigAlarms")._
AddObject("Area", True)
Application.GetObject("ConfigAlarms").Save()
End Sub
2.8.3 Propriedades
Todo objeto possui Propriedades, que servem para guardar informações a respeito
de suas características. Por exemplo, um objeto do tipo Retângulo possui a
propriedade Name, que contém seu nome, e as propriedades Width e Height, que
guardam a sua largura e a sua altura, respectivamente, entre outras propriedades.
Neste capítulo são listadas todas as propriedades gerais dos objetos do Elipse
Power. Cada entrada traz o nome da propriedade, sua descrição e, quando
aplicável, um exemplo de seu uso.
As propriedades são identificadas por um ícone que indica o tipo de dado
suportado em seu conteúdo. Os tipos de dados disponíveis estão descritos na
tabela a seguir.
Tipos de dados disponíveis
ÍCONE TIPO DE DADO DESCRIÇÃO
Retorna Verda dei ro (True)
Booleano
ou Fa l s o (Fa l s e)
Numérico Retorna um i ntei ro ou
Double (pos i ti vo ou
nega ti vo), a s er defi ni do
pel a propri eda de
Retorna uma da ta no
Data ca l endá ri o Gregori a no
(i ni ci a ndo em 1899)
Texto Retorna um texto
Retorna um ti po va ri á vel ,
Variant que pode a s s umi r vá ri os
forma tos
2.8.3.1 Application
A propriedade Application retorna o objeto de aplicação relacionado ao
contexto atual do objeto. Com o objeto Aplicação é possível, por exemplo, buscar
outros objetos presentes no aplicativo. Exemplo:
Sub Tela1_Click()
' Quando clica na tela, atribui um valor e abre um MessageBox
set obj = Application.GetObject("Dados.TagInterno1")
obj.Value = 100
MsgBox "Valor do TagInterno1: " & obj.Value
End Sub
2.8.3.2 Count
Retorna o número de objetos filhos (itens) que o objeto possui. Esta propriedade
funciona em conjunto com o método Item. Se o objeto não possuir filhos, o valor
retornado será 0 (zero). Exemplo:
Sub Tela1_Click()
' Busca todos os objetos de tela
' e ajusta a propriedade
' ForegroundColor para vermelho
Dim obj
For i = 1 To Count
Set obj = Item(i) ' Objeto filho
obj.ForegroundColor = RGB(255, 0, 0)
Next
End Sub
2.8.3.4 Links
Retorna um objeto que é uma coleção das conexões (ou Associações) de um
objeto qualquer do Elipse Power. Esta propriedade é acessível apenas em tempo de
execução. Veja o item Coleção de Associações para maiores informações sobre a
coleção de objetos retornados por esta propriedade.
2.8.3.5 Name
Identifica cada um dos objetos presentes no sistema. Alterar esta propriedade
implica em modificar todas as outras propriedades ou scripts que utilizam este
objeto. Não é aconselhável a alteração desta propriedade em tempo de execução.
Exemplo:
Sub CommandButton9_Click()
MsgBox "O nome da Tela é " & (Screen.Name)
End Sub
2.8.3.6 Parent
Retorna o objeto pai deste objeto. Sendo assim, se um objeto está inserido na
Tela, a propriedade Parent retorna "Tela". Da mesma forma, se um Tag Interno está
inserido diretamente abaixo de um Servidor de Dados, a propriedade Parent do Tag
Interno apontará para o Servidor de Dados. Exemplo:
Sub Retangulo1_Click()
' Ao clicar no Retangulo1,
' troca a cor do Retangulo2
Parent.Item("Retangulo2").ForegroundColor = RGB(255, 0, 0)
End Sub
2.8.3.7 PathContainer
Retorna uma String contendo o caminho do objeto que contém o objeto atual,
incluindo as Pastas. Este valor é determinado apenas no momento em que for
requisitado, por isso não é recomendado criar Associações para esta propriedade.
2.8.3.9 PathVolume
Retorna uma String contendo o nome do arquivo .prj ou .lib que contém o objeto.
No Studio, a propriedade retorna o caminho completo do projeto ou biblioteca (c:
\folder\folder\volume.prj). Em tempo de execução, os objetos que rodam no Viewer
retornam sempre uma String vazia. Já os que rodam no servidor retornam o
caminho relativo do projeto ou biblioteca, conforme ele esteja armazenado no
Domínio (volume.prj). Este valor é determinado apenas no momento em que for
requisitado, por isso não é recomendado criar Associações para esta propriedade.
2.8.4.1.1 CreateLink
CreateLink(Property, Source[, Type])
Este método permite criar uma Associação com uma propriedade do objeto. Em
caso de sucesso, o método retorna o objeto criado. Caso contrário, ocorre um erro
de script e o método retorna Nothing. O método possui os seguintes parâmetros:
Property: Especifica o nome da propriedade para a qual é criada a
Associação
Source: Especifica o nome do objeto de origem da Associação
Type (opcional): Especifica o tipo de Associação a ser criada. Quando este
parâmetro for omitido, é criada uma Associação Simples
Exemplo:
Sub CommandButton1_Click()
On Error Resume Next
Dim Bind
Set Bind = Screen.Item("Texto1").Links.Item("Value")
If Bind Is Nothing Then
MsgBox "Texto1 não está associado a nenhum objeto."
Dim Source
Source = "Dados.TagInterno1.Value"
MsgBox "Criando uma conexão em '" & Source & "'."
Set Bind = Screen.Item("Texto1").Links._
Programando no Elipse Power 59
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 método retorna um objeto Associação de uma determinada propriedade de um
objeto. Se for um texto, Property especifica o nome da propriedade cuja Associação
deseja-se acessar. A Associação também pode ser acessada numericamente pelo
índice Index. Este índice deve ser de 1 até Count. Caso não exista Associação com a
propriedade, ou o índice seja inválido, ocorrerá um erro de script. Como as demais
coleções, Links permite o uso do comando For Each do VBScript. Exemplo:
Sub Texto1_Click()
For Each Link In Links
MsgBox "Origem do link: " & Link.Source
Next
End Sub
2.8.4.1.3 RemoveLink
RemoveLink(Property)
Este método remove uma Associação com a propriedade especificada por Property,
caso ela exista. Caso não exista Associação com a propriedade especificada, o
método não tem efeito. Exemplo:
Sub CommandButton2_Click()
On Error Resume Next
Dim Bind
Set Bind = Screen.Item("ScrollBar1").Links.Item("Value")
If Bind Is Nothing Then
' Se a conexão não existe
MsgBox "ScrollBar1 não 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.3 Associações
Esta seção contém informações sobre os objetos do tipo Associação contidos na
coleção de Associações retornada pela propriedade Links. Os tipos de Associações
disponíveis são os seguintes:
Simples
Bidirecional
Analógica
Digital
Tabela
Reversa
Múltipla
2.8.4.3.1.1 Property
2.8.4.3.1.2 Source
2.8.4.3.1.3 Type
2.8.4.3.3.1 Propriedades
2.8.4.3.4.1 Propriedades
2.8.4.3.5.1 Propriedades
2.8.4.3.6.1 Métodos
Esta seção contém informações sobre os métodos do objeto Associação por Tabela.
InsertRow
InsertRow([Row])
Insere uma nova linha na tabela. O parâmetro Row é opcional e especifica em que
posição da tabela deve ser inserida a linha. Quando omitido, assume o
comportamento padrão de inserir a linha no fim da tabela, o que equivale a usar
Row igual a -1. Quando informado e não for -1, deve ser um valor entre 1 e Count, e
a nova linha criada desloca as linhas de índice maior ou igual para a direção
ascendente dos índices. Uma linha nova sempre assume os seguintes valores
padrão para as propriedades:
Min: 0.0
Max: 1.0
Blink: False
BlinkValue: 0.0
Value: 0.0
Exemplo:
2.8.4.3.6.2 Propriedades
2.8.4.3.7.1 Propriedades
2.8.4.3.8.1 Métodos
2.8.4.3.8.2 Propriedades
3.1.1 Eventos
Esta seção contém informações sobre os eventos dos objetos XControls e XObjects.
3.1.1.1 Constructor
Constructor()
Disparado quando o ElipseX é iniciado. Pode-se utilizar este evento para rodar um
script que inicie valores internos de um ElipseX, por exemplo.
3.1.1.2 CustomConfig
CustomConfig()
Permite configurações automatizadas nas instâncias de ElipseX. Uma opção de
configuração aparece no menu contextual das instâncias de ElipseX sempre que
existir um script associado ao evento CustomConfig da definição do ElipseX.
Quando a opção é selecionada no menu, o evento é disparado. O texto que aparece
na opção do menu pode ser informado na propriedade CustomConfigText da
definição do ElipseX. Se esta propriedade estiver em branco, aparece o texto
"Configurar".
Bibliotecas do Usuário 73
Menu contextual da instância do ElipseX
3.1.2 Propriedades
Esta seção contém informações sobre as propriedades dos objetos XControls e
XObjects.
74 Bibliotecas do Usuário
3.1.2.1 CustomConfigText
Indica o texto que deverá aparecer no menu para a opção de configuração da
instância do ElipseX. A opção só irá aparecer se existir um script associado ao
evento CustomConfig da definição do ElipseX. Se o valor da propriedade estiver em
branco, aparecerá o texto "Configurar" na opção do menu. O valor padrão desta
propriedade é uma String vazia.
3.2.1 Eventos
Esta seção contém informações sobre os eventos do objeto Propriedade de um
ElipseX.
3.2.1.1 OnPropertyChanged
OnPropertyChanged()
Ocorre quando uma propriedade de um ElipseX é modificada. Pode-se utilizar este
evento para disparar scripts que executem ações de acordo com determinado
status de um ElipseX.
3.2.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Propriedade de
um ElipseX.
3.2.2.1 DefaultValue
Define o valor inicial para a Propriedade quando uma nova instância do objeto é
criada. Se a Propriedade está configurada como retentiva, ela será inicializada
com este valor cada vez que o objeto for carregado. O valor padrão desta
propriedade é vazio (Empty).
3.2.2.2 HelpString
Texto contendo a descrição da Propriedade. Este texto será mostrado na parte
inferior da Lista de Propriedades no Studio quando a Propriedade for selecionada.
O valor padrão desta propriedade é uma String vazia.
Bibliotecas do Usuário 75
3.2.2.3 Persistable
Indica se a Propriedade é salva no arquivo de projeto (Verdadeiro) ou se está
disponível apenas em tempo de execução (Falso). O valor padrão desta propriedade
é Verdadeiro. Se esta propriedade for configurada com o valor Falso, a Propriedade
não pode ser editada no Studio, nem salva ou lida do arquivo de projeto.
Entretanto, a Propriedade ainda é visível no AppBrowser. Esta propriedade é
representada pelo ícone .
Quando esta propriedade está configurada para Verdadeiro, a Propriedade recebe
seu valor padrão (propriedade DefaultValue) apenas na criação de uma instância.
Se a propriedade DefaultValue for alterada, as instâncias do objeto já criadas não
são afetadas.
Quando esta propriedade está configurada para Falso, a Propriedade recebe seu
valor padrão sempre que uma instância é carregada, ou seja, sempre que a
propriedade DefaultValue for alterada, todas as instâncias já criadas são
inicializadas com o novo valor padrão.
3.2.2.4 Public
Quando uma Propriedade de um ElipseX é pública (True), ela será visível fora da
Biblioteca. Caso contrário, a Propriedade será interna e somente visível para o
objeto. O valor padrão desta propriedade é True. A Propriedade pública é
representada pelo ícone .
3.2.2.5 Retentive
Indica se o valor atual da Propriedade em tempo de execução é persistido no
arquivo de Domínio (Verdadeiro), enquanto o Domínio estiver carregado.
Propriedades retentivas têm o seguinte comportamento:
Propagam o seu valor para o servidor em Standby
Mantêm o seu valor se a aplicação é atualizada em tempo de execução
Mantém o seu valor se a aplicação é parada (desde que o Domínio não seja
fechado)
NOTAS:
Es ta propri eda de s omente es tá di s ponível pa ra Propri eda des cujo ti po de da dos
nã o s eja um objeto (Variant, Double, Integer, etc.)
O us o des ta propri eda de em Verda dei ro i mpl i ca em um a umento no us o de
memóri a e CPU por pa rte do E3Run, por i s to deve s er uti l i za da com ca utel a
76 Bibliotecas do Usuário
3.2.2.6 Type
Determina o tipo de valores que a Propriedade irá aceitar (por exemplo, Boolean,
Double, Integer, Variant, etc.). Quando for especificado um objeto como tipo (por
exemplo DemoTag, IOTag, XObject, etc.), esta propriedade terá o seguinte
comportamento:
Caso o ElipseX esteja inativo: A propriedade funciona como uma String, que
especifica o caminho da instância de um objeto do tipo configurado
Caso o ElipseX esteja ativo: Na escrita, a propriedade funciona da mesma maneira
de quando o objeto está desativado. Porém, na leitura a propriedade retorna o
objeto especificado, caso ele exista. Se o caminho não aponta para um objeto
existente no momento, a propriedade retorna Nothing
Bibliotecas do Usuário 77
CAPÍTULO
Visualização
4
Esta seção contém informações sobre eventos, métodos e propriedades dos objetos
de visualização do Elipse Power:
Viewer
Quadros e Divisores
Telas e Objetos de Tela
E3Alarm
E3Browser
E3Chart
E3Playback
Relatórios
PowerExplorer
4.1 Viewer
Esta seção contém informações sobre eventos, métodos e propriedades do objeto
Viewer.
4.1.1 Eventos
Esta seção contém informações sobre os eventos do objeto Viewer.
4.1.1.1 OnInactive
OnInactive()
Este evento ocorre enquanto o Viewer estiver inativo, se a propriedade
EnableInactivity estiver em Verdadeiro. Ele inicia quando se constata que o usuário
está sem utilizar o Viewer por um período de tempo igual ou superior ao valor da
propriedade InactivityTime.
Em um script para este evento, o usuário pode programar o que deseja fazer
quando o Viewer estiver inativo por um determinado período de tempo. Por
exemplo, é possível determinar que após 20 minutos sem uso seja efetuado o logout
do Viewer. Exemplo:
Sub Viewer_OnInactive()
Logout(false)
If MsgBox("Essa sessão do Viewer foi fechada_
78 Visualização
devido à inatividade.") = 0 Then
Application.GetFrame("").OpenScreen "TelaInicial", 0
End Sub
4.1.1.2.1 OnLogin
OnLogin()
Ocorre quando um usuário executa um login na aplicação (autenticação de
usuário) com sucesso. O login na aplicação pode ser executado através do método
Login ou quando um objeto que só pode ser acessado por usuários com um
determinado nível de autorização exige autenticação.
4.1.1.2.2 OnLogout
OnLogout()
Ocorre quando é executado um logout, ou seja, a saída do usuário de uma
aplicação. O logout é feito através da chamada ao método Logout.
4.1.2 Métodos
Esta seção contém informações sobre os métodos do objeto Viewer.
4.1.2.1 CaptureScreen
CaptureScreen(Filename)
O método CaptureScreen captura a Tela atual e a salva em um arquivo. Este método
é semelhante ao efeito realizado pela tecla PRINT SCREEN no Windows. O
parâmetro Filename determina o nome do arquivo no qual a Tela é salva.
Exemplo:
Sub CommandButton1_Click()
Screen.Frame.CaptureScreen "c:\temp\tela.bmp"
End Sub
Visualização 79
4.1.2.2 ChangePassword
ChangePassword()
Este método abre uma caixa de diálogo para permitir a troca de senha do usuário
atual. O método retorna Verdadeiro se o usuário atual tem permissão para trocar a
senha. Caso contrário, retorna Falso, indicando que houve falha na operação, ou
que não é possível trocar a senha porque o usuário não tem autorização.
4.1.2.3 DoModal
DoModal(Screen, Title, Left, Top, Width, Height, Arg, Flags)
Abre uma Tela modal, que é uma janela que não permite clicar em outras Telas ou
janelas enquanto ela não for fechada. O parâmetro Title passado neste método só é
utilizado se a propriedade Caption estiver vazia. Do contrário, este parâmetro é
ignorado. Este método possui os seguintes parâmetros:
Screen: Determina o nome da Tela
Title: Determina o título da janela modal
Left, Top: Posição XY da janela modal, em pixels
Width: Largura da janela modal, em pixels ou Himetric
Height: Altura da janela modal, em pixels ou Himetric
Arg: Determina a variável a ser usada no evento OnPreShow da Tela
Flags: Determina a combinação utilizada na janela modal. Tal combinação é
realizada somando-se os valores da tabela correspondentes às opções que o
usuário deseja. Quando o valor especificado for -1 (menos um), são
adotadas as configurações do Viewer para a janela modal. Quando este
valor for diferente de -1 (menos um), pode-se fazer as combinações descritas
na tabela a seguir
Combinações possíveis para o parâmetro Flags
VALOR DESCRIÇÃO
1 Ha bi l i ta a ba rra de títul o na ja nel a
2 Ha bi l i ta o botã o Fechar na ja nel a
4 Ha bi l i ta o botã o Minimizar na ja nel a
8 Ha bi l i ta o botã o Maximizar na ja nel a
16 Ha bi l i ta a borda na ja nel a
32 Es peci fi ca que a ja nel a pode s er
di mens i ona da
80 Visualização
VALOR DESCRIÇÃO
64 Es peci fi ca que a ja nel a pode s er movi da
256 Es peci fi ca que a ja nel a perma nece no
topo da Tel a
512 Es peci fi ca que a ja nel a é confi gura da no
es ti l o Barra de Ferramentas
1024 Des a bi l i ta os botões de objeto
2048 Centra l i za a Tel a moda l no Qua dro, ta nto
hori zonta l qua nto verti ca l mente
Exemplo:
Sub Botao1_Click()
' Ao clicar no Botão, abre uma outra Tela modal
Application.DoModal "Tela1", "Titulo", 0, 0, 400, 200, 0, 3
End Sub
NOTA: Os va l ores de ta ma nho nes te método podem s er i nforma dos como números
ou Strings. No ca s o de números , s ã o cons i dera dos em pi xel s . No ca s o de Strings, s e
vi erem a compa nha dos da uni da de "hm", s ã o i nterpreta dos como Hi metri c.
Qua l quer outro ca s o é cons i dera do em pi xel s .
4.1.2.4 ESign
ESign(ObjName[, Description[, Action[, From[, To[, User[, Comment]]]]]])
O método ESign é utilizado para executar uma validação da alteração de um campo,
através de assinatura eletrônica. Quando este método é utilizado, a caixa de
diálogo da figura a seguir é mostrada.
Visualização 81
Caixa de Diálogo de Assinatura Eletrônica
Parâmetros do método ESign
PARÂMETRO DESCRIÇÃO
ObjName Texto que contém o nome de um Ta g ou
outro objeto da a pl i ca çã o.
Description Texto que contém a des cri çã o de
ObjName. Es te pa râ metro é opci ona l e, s e
for omi ti do, a ca i xa de di á l ogo tenta
bus ca r os da dos da propri eda de
DocString de ObjName.
Action Texto que contém a a çã o a s er executa da
(por exempl o, "Al tera çã o do va l or"). Es te
pa râ metro é opci ona l e o s eu va l or
pa drã o é uma String va zi a .
From Variant que contém o va l or ori gi na l ou o
es ta do que va i s er a l tera do. Es te
pa râ metro é opci ona l .
To Variant que contém o novo va l or do Ta g
ou o va l or a s er a pl i ca do em Action. Es te
pa râ metro é opci ona l .
82 Visualização
PARÂMETRO DESCRIÇÃO
User Texto de retorno. Recebe o nome de login
s el eci ona do na ca i xa de di á l ogo. Es te
pa râ metro é opci ona l .
Comment Texto de retorno. Recebe o comentá ri o
di gi ta do na ca i xa de di á l ogo. Es te
pa râ metro é opci ona l .
Login integrado
Este método retorna Verdadeiro se o usuário clicar em OK, e se os campos Usuário e
Senha forem válidos. Caso contrário, se a caixa de diálogo for cancelada ou se o
login ou a senha estiverem errados, após três tentativas o método retorna Falso. Em
caso de falha, User e Comment são configurados para uma String vazia.
Os comentários pré-definidos são armazenados no Registro do Windows. Apenas
os últimos 26 comentários são salvos. Cada vez que a janela é criada, os últimos
comentários são buscados no Registro e usados para preencher a lista de seleção.
Se um novo comentário for informado pelo usuário, ele é salvo e o mais antigo é
descartado, caso não haja posição livre. Se for utilizado um comentário já
existente, este passa a ser o primeiro da lista de comentários mais recentes.
Exemplo:
Sub Button1_Click()
Visualização 83
Dim Tag, User, Comment
Set Tag = Application.GetObject("IO.Inputs.I001")
If Application.ESign(Tag.PathName, , "Alteração do Valor", _
Tag.Value, 1, User, Comment) Then
If Tag.WriteEx = 1 Then
Application.TrackEvent _
"Tag IO.Inputs.I001 alterado para 1 " &_
"pelo usuário" & User, Comment
End If
End If
End Sub
4.1.2.5 ExecuteExternalApp
ExecuteExternalApp(AppPath, Arguments, InitialDir, CmdShow[, ProcessId])
Este método executa um aplicativo externo de nome e caminho AppPath, com os
argumentos Arguments, iniciando no diretório de trabalho InitialDir. Quando
especificado um documento em AppPath, o aplicativo associado a este documento
é executado, e o documento é passado como um dos parâmetros do aplicativo.
ProcessID recebe o número que identifica o processo (este número é utilizado no
método IsAppRunning e é o mesmo valor que aparece no Gerenciador de Tarefas do
Windows, na coluna PID). O parâmetro CmdShow especifica o modo de abertura da
janela do aplicativo, conforme descrito na tabela a seguir.
Opções disponíveis para o parâmetro CmdShow
OPÇÃO DESCRIÇÃO
0 Es conde a ja nel a e a ti va outra ja nel a .
1 Ati va e mos tra a ja nel a . Se a ja nel a
es ti ver ma xi mi za da ou mi ni mi za da , el a é
res ta ura da pa ra o ta ma nho e pos i çã o
ori gi na i s . Uma a pl i ca çã o deve
es peci fi ca r es te va l or qua ndo es ti ver
mos tra ndo uma ja nel a pel a pri mei ra vez.
2 Ati va a ja nel a e mos tra -a mi ni mi za da .
3 Ati va a ja nel a e mos tra -a ma xi mi za da .
4 Mos tra a ja nel a com s eu ta ma nho e
pos i çã o ma i s recentes . A ja nel a a ti va
perma nece a ti va .
5 Ati va a ja nel a e mos tra -a com s eu
ta ma nho e pos i çã o a tua i s .
6 Mi ni mi za a ja nel a e a ti va a próxi ma
ja nel a de nível s uperi or.
7 Mos tra a ja nel a mi ni mi za da . A ja nel a
a ti va perma nece a ti va .
8 Mos tra a ja nel a em s eu es ta do a tua l . A
ja nel a a ti va perma nece a ti va .
84 Visualização
OPÇÃO DESCRIÇÃO
9 Ati va e mos tra a ja nel a . Se a ja nel a
es ti ver ma xi mi za da ou mi ni mi za da , el a é
res ta ura da pa ra o ta ma nho e pos i çã o
ori gi na i s . Uma a pl i ca çã o deve
es peci fi ca r es te va l or qua ndo es ti ver
res ta ura ndo uma ja nel a que es ta va
mi ni mi za da .
Exemplo:
Sub CommandButton1_Click()
Dim ret
Application.ExecuteExternalApp "calc.exe", "", "", 1, ret
Application.GetObject("Dados.TagInterno1").Value = ret
End Sub
4.1.2.6 Exit
Exit()
Este método fecha a janela no Viewer. Exemplo:
Sub_Botao1.Click()
Application.Exit()
EndSub
4.1.2.7 GetFormulaUnitDataObj
GetFormulaUnitDataObj(FormulaName)
Este método obtém a configuração das Unidades existentes em uma determinada
Fórmula. As Unidades são o destino dos dados salvos na Fórmula (valores). Este
método possui o parâmetro FormulaName, que é o nome da Fórmula.
Utilize o método GetFormulaUnitDataObj para obter uma coleção das Unidades de
uma Fórmula. Este método retorna Verdadeiro se conseguir realizar a operação ou
Falso, caso não consiga. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botão, mostra uma caixa de
' mensagem(MessageBox) com o número de Units e o nome da
' Primeira Unit
Set obj = Application.GetFormulaUnitDataObj("Formula1")
MsgBox CStr(obj.Count)
Visualização 85
MsgBox CStr(obj.Name(1))
End Sub
4.1.2.8 GetFormulaValueDataObj
GetFormulaValueDataObj(FormulaName)
Este método obtém a configuração dos valores existentes em uma determinada
Fórmula. Os valores são o conjunto de dados salvos na Fórmula. Este método
possui o parâmetro FormulaName, que é o nome da Fórmula.
Utilize o método GetFormulaValueDataObj para obter uma coleção de valores na
Fórmula. Este método retorna Verdadeiro se conseguir realizar a operação ou
Falso, caso não consiga. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botão, mostra uma caixa de mensagem
' (MessageBox) com o número 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])
Este método procura por um objeto Divisor que já esteja aberto no Viewer atual.
Este método possui o parâmetro FrameName, que é opcional e determina o nome do
Quadro a ser buscado. Caso o valor especificado em FrameName seja vazio, ele
retorna um Quadro que contém todos os Divisores ou a Tela ativa no momento.
Com o retorno deste método, utilize os métodos do Divisor, como por exemplo o
método OpenScreen, para abrir uma outra Tela. Exemplo:
Sub Botao1_Click()
' Ao clicar neste Botão, recebe o Quadro 'Menu'
' e substitui a Tela atual deste Quadro pela Tela 'Opções'
Set novoQuadro = Application.GetFrame("Menu")
' novoQuadro possui um objeto do tipo Divisor
novoQuadro.OpenScreen "Opções", 0
End Sub
4.1.2.10 GetFullUserName
GetFullUserName()
O método GetFullUserName retorna o nome completo do usuário logado no Elipse
Power. Caso não haja nenhum usuário logado, é retornada uma String vazia.
86 Visualização
4.1.2.11 GetKeyPad
GetKeyPad()
Retorna uma referência para o objeto Elipse KeyPad, permitindo manipular um
teclado virtual flutuante em aplicações desenvolvidas com o Elipse Power. Veja o
Manual do Usuário do Elipse Power para maiores informações sobre este objeto. Os
métodos e propriedades do Elipse KeyPad estão descritos no capítulo ActiveX -
Elipse KeyPad.
4.1.2.12 GetMouseX
GetMouseX()
Retorna a coordenada X do ponteiro do mouse, em pixels, referente à área total da
tela do computador.
4.1.2.13 GetMouseY
GetMouseY()
Retorna a coordenada Y do ponteiro do mouse, em pixels, referente à área total da
tela do computador.
4.1.2.14 GetPowerExplorer
GetPowerExplorer(ObjectPath)
Retorna um objeto que permite configurar a janela do PowerExplorer. O parâmetro
ObjectPath indica o objeto de Servidor ao qual o PowerExplorer está vinculado. Em
um script, deve-se utilizar este método da seguinte forma:
Sub
Visualização 87
Set PE = Application.GetPowerExplorer("SE1.Bay1.Breaker1")
End Sub
4.1.2.15 GetScreen
GetScreen(ScreenName)
Este método retorna um objeto Tela, cujo nome deve ser especificado no parâmetro
ScreenName. O valor de retorno deste método pode ser utilizado no método
ShowScreen do objeto Divisor.
4.1.2.16 GetValue
GetValue(TagName)
O método GetValue busca pelo valor de um objeto especificado no parâmetro
TagName. Se TagName apontar para uma propriedade, este método retorna o valor
da propriedade. Se por outro lado o parâmetro TagName especificar um objeto, o
método retorna o valor da propriedade Value do objeto. Exemplo:
Sub Botao1_Click()
' Ao clicar no Botão,
' recupera o valor de um Tag
' sendo executado em um Servidor de Dados
X = Application.GetValue("Dados1.TagInterno1")
End Sub
4.1.2.17 IsAppRunning
IsAppRunning(ProcessId)
Indica se uma aplicação iniciada pelo método ExecuteExternalApp está em
execução. Retorna Verdadeiro se o aplicativo identificado no sistema operacional
por ProcessId está em execução. Caso contrário, retorna Falso. Exemplo:
Sub CommandButton1_Click()
Application.ExecuteExternalApp _
"www.elipse.com.br", "", "", 1, processID
While Application.IsAppRunning(processID)
' Espera pelo final da aplicação
Wend
MsgBox "Terminou a aplicação!"
End Sub
88 Visualização
4.1.2.18 IsUserMemberOfGroup
IsUserMemberOfGroup(GroupName[, UserName])
Este método verifica se um usuário pertence a um determinado grupo. Possui os
seguintes parâmetros:
GroupName: Nome do grupo de usuários que se quer verificar
UserName: Nome do usuário que se quer verificar. Se este parâmetro for
omitido, ou for igual a uma String vazia, o método considera o usuário
atualmente logado no Viewer
4.1.2.19 IsWebViewer
IsWebViewer()
Verifica se o aplicativo está sendo visualizado pelo WebViewer. O método retorna
Verdadeiro se a aplicação estiver sendo executada no WebViewer. Caso contrário,
retorna Falso.
4.1.2.20 LoadFormulaDlg
LoadFormulaDlg(FormulaName[, UnitName[, ValueName]])
Este método apresenta uma caixa de diálogo que permite ao usuário escolher o
conjunto de valores e a Unidade de destino, carregando uma Fórmula. Este método
possui o parâmetro FormulaName, que determina o nome do objeto Fórmula que vai
ser operado.
Utilize o método LoadFormulaDlg para abrir uma caixa de diálogo para
carregamento dos dados do objeto Fórmula especificado por FormulaName. Nesta
caixa é possível especificar qual conjunto de valores (UnitName) é enviado para
qual conjunto de Tags (ValueName). Nesta caixa de mensagem o usuário conta com
todos os conjuntos de valores e Unidades disponíveis no objeto Fórmula, podendo
atribuir um a outro livremente. Ao clicar em OK, o conjunto de valores é carregado
na Unidade especificada. Exemplo:
Sub Botao1_Click()
' Abre a caixa de diálogo para operar
Dim val
Application.LoadFormulaDlg("Formula1")
End Sub
Visualização 89
4.1.2.21 LoadFormulaValues
LoadFormulaValues(FormulaName, UnitName, ValueName)
Este método carrega automaticamente um conjunto de valores para uma Unidade
de destino, apresentando uma caixa de diálogo que permite ao usuário informar
valores diferentes daqueles definidos na Fórmula. Este método possui os
parâmetros FormulaName, que determina o nome da Fórmula, UnitName, que
determina o nome da Unidade e ValueName, que determina o nome do conjunto de
valores.
Uma caixa de mensagem aparece permitindo ao usuário informar valores
diferentes daqueles definidos para cada um dos valores da Fórmula.
NOTA: O método retorna um va l or l ógi co, ou s eja , retorna Verda dei ro qua ndo é
executa da com s uces s o e Fa l s o qua ndo fa l ha , o que nã o s i gni fi ca que houve um
erro no s cri pt.
Exemplo:
Sub Botao1_Click()
Application.LoadFormulaValues "Formula1",
"Unidade1", "Valor1"
End Sub
4.1.2.22 LoadFormulaValuesQuiet
LoadFormulaValuesQuiet(FormulaName, UnitName, ValueName)
Carrega um conjunto de valores para uma Unidade de destino, sem apresentar
nenhuma mensagem. Este método possui os parâmetros FormulaName, que
determina o nome da Fórmula, UnitName, que determina o nome da Unidade e
ValueName, que determina o nome do conjunto de valores. Exemplo:
Sub Botao1_Click()
Application.LoadFormulaValuesQuiet "Formula1",_
"Unidade3", "Valor1"
End Sub
4.1.2.23 LoadReport
LoadReport(ReportName)
Carrega um modelo de Relatório. O parâmetro ReportName é o nome do Relatório a
ser carregado. Exemplo:
Sub Rect_Click()
' Carregando o relatório pré-definido
90 Visualização
Set strRep = Application.LoadReport("[Relatório3]")
strRep.PrintPreview ' Visualizando a impressão
End Sub
4.1.2.24 Login
Login([Mode])
Abre uma caixa de diálogo para o login (autenticação de usuário) na aplicação. O
usuário logado permanece na memória até que seja feito outro login ou logout
(saída do usuário da aplicação). Este método possui o parâmetro Mode, que é um
Booleano que determina se uma mensagem de confirmação ou falha da operação
deve ser mostrada (o padrão é Falso). Quando uma Tela estiver para ser aberta
(através do método OpenScreen), este método verifica se existe alguma
configuração de segurança. Caso exista, a Tela só é aberta se o usuário logado tem
permissão. Caso não tenha permissão, abre-se uma caixa de diálogo para o login.
4.1.2.25 LoginUser
LoginUser(Username, UserPassword)
Executa o login de um usuário específico sem mostrar nenhuma mensagem. O
parâmetro Username é o nome do usuário e o parâmetro UserPassword é a senha
deste usuário. O método retorna Verdadeiro se o login do usuário foi bem-sucedido,
e Falso caso contrário. Se o usuário passado no parâmetro Username estiver
configurado para trocar de senha no próximo login, o método retorna Falso.
4.1.2.26 Logout
Logout([Mode])
Executa o logout (saída do usuário atual da aplicação) do Viewer. Caso não haja
um usuário logado, este método não tem efeito. A partir deste momento, considera-
se que um usuário "anônimo" está utilizando a aplicação (pode-se utilizar o evento
OnLogout para executar um script para ir para a Tela inicial ou finalizar a
aplicação). Este método possui o parâmetro opcional Mode, que é um Booleano que
determina se uma mensagem de confirmação ou falha da operação deve ser
mostrada (o padrão é Falso).
4.1.2.27 PasswordConfirm
PasswordConfirm(Mode)
Este método abre uma caixa de diálogo solicitando a reconfirmação da senha do
usuário atualmente logado. Retorna Verdadeiro se a senha for confirmada, ou
Falso caso contrário. O parâmetro Booleano Mode determina se deve ser executado
Visualização 91
um logout em caso de falha na confirmação (Verdadeiro) ou não (Falso).
Confirmação de senha
Se a caixa de diálogo for fechada através do botão Cancelar, o método retorna
Falso. Caso não haja usuário logado, o método retorna Falso, mas sem abrir a
caixa de diálogo. Caso a senha digitada não esteja correta, a solicitação é repetida
até no máximo três vezes. Se o usuário digitar a senha incorreta nestas três vezes, a
caixa de diálogo é fechada e o método retorna Falso.
4.1.2.28 Playsound
Playsound(Filename)
Executa um arquivo de som cujo caminho e nome estão indicados no parâmetro
Filename. O arquivo deve seguir as seguintes especificações:
Deve estar no formato de som do Windows (extensão .wav)
Se o arquivo estiver no projeto (adicionado através do comando Inserir
recurso), o nome do arquivo deve estar entre colchetes
Se foi criada uma pasta no projeto e o arquivo foi adicionado através do
comando Inserir recurso, o caminho deve ser especificado entre aspas (por
exemplo, "c:\som\ding.wav"). Se o arquivo estiver no diretório local, o nome
não precisa de aspas, basta colocar o caminho (por exemplo, c:\som
\ding.wav).
Exemplo:
Sub TelaInicial_OnAlarm()
' Se existir um alarme ativo, executa um som de alerta.
' Quando o alarme é reconhecido, o som para.
Set Alarme = Application._
92 Visualização
GetObject("ConfigAlarmes1.Area1.FonteAlarme1")
If Alarme.ActiveNACKAlarms = True Then
Application.PlaySound("[ringin.wav]")
End If
End Sub
4.1.2.29 SelectMenu
SelectMenu(Menu[, Left, Top])
Este método mostra um menu contextual conforme especificado pelo parâmetro
Menu. Este parâmetro é um texto que consiste em várias opções delimitadas pela
barra vertical (|), sendo que cada uma destas Strings é uma opção do menu. Caso
haja um conjunto de dois delimitadores sucessivos (||), um separador é inserido.
Use os caracteres de abre e fecha chaves para criar um submenu. Um asterisco na
frente de uma String indica que a opção está marcada. Já um sinal de exclamação
indica que a opção está desabilitada.
A posição da caixa de diálogo pode ser configurada através dos parâmetros Left e
Top, que indicam a distância da margem esquerda e do topo da Tela em pixels,
respectivamente. Caso estes parâmetros não sejam informados, o menu é
posicionado de acordo com o local onde o clique do mouse foi acionado.
Este método retorna 0 (zero) se nenhuma opção foi selecionada, ou o número da
opção, sendo 1 (um) a primeira opção contida no texto, 2 (dois) a segunda opção, e
assim por diante. Exemplo:
Sub Botao1_Click()
op = _
Application.SelectMenu(_
"Opção1||Opção2{*Opção2|Opção3}|Opção4|!Opção5")
If op = 1 Then
MsgBox "Opção 1 foi escolhida"
ElseIf op = 2 Then
MsgBox "Opção 2 foi escolhida"
ElseIf op = 3 Then
MsgBox "Opção 3 foi escolhida"
ElseIf op = 4 Then
MsgBox "Opção 4 foi escolhida"
ElseIf op = 0 Then
MsgBox "Nenhuma opção foi escolhida"
End If
End Sub
4.1.2.30 SetValue
SetValue(TagName, NewVal)
Este método configura o valor de um objeto dentro do servidor. O método SetValue
procura por um objeto ou propriedade em execução no servidor e atribui o valor
especificado no parâmetro definido em TagName. O tipo e o valor do parâmetro
NewVal devem ser suportados pelo objeto especificado em TagName. Exemplo:
Visualização 93
Sub Botao1_Click()
' Ao clicar em Botao1, atribui o valor 20
' para a propriedade Value do Tag
Application.SetValue "Dados1.TagInterno1", 20
End Sub
4.1.2.31 ShowDatePicker
ShowDatePicker(DateValue, Left, Top[, DefaultDate])
Abre uma caixa de diálogo para a alteração da data e da hora. Este método retorna
Verdadeiro se o usuário confirmar a data, ou Falso se o usuário cancelar a edição.
A nova data é retornada no parâmetro DateValue. A posição da caixa de diálogo
pode ser configurada através dos parâmetros Left e Top, que indicam a distância da
margem esquerda e do topo da tela em pixels, respectivamente. Caso estes
parâmetros não sejam informados, a caixa de diálogo é centralizada. O valor do
parâmetro DefaultDate é a data e a hora do momento em que a caixa de diálogo foi
aberta. Se não for informada a data, assume a data atual. Se não for informada a
hora, inicia como "00:00:00". Se nem a data nem a hora forem informadas, inicia
com a data e a hora atuais. Exemplo:
Sub Texto2_Click()
Dim novaHora
Application.ShowDatePicker novaHora, 300, 300
MsgBox "A hora é: " & novaHora
End Sub
4.1.2.32 ShowFilePicker
ShowFilePicker(Open, FileName[, Extension, Flags, Filter])
Exibe as caixas de diálogo Salvar e Abrir Arquivo do Windows. O parâmetro Open
indica o tipo de caixa de diálogo a ser aberta. Se Verdadeiro, abre a caixa de
diálogo Abrir Arquivo. Se Falso, abre a caixa de diálogo Salvar. O parâmetro
FileName indica a variável onde é armazenado o nome do arquivo a ser salvo ou
carregado, caso o método retorne Verdadeiro. Este parâmetro deve ser
obrigatoriamente uma variável. O parâmetro Extension é opcional e informa a
extensão do arquivo padrão a ser anexada ao nome do arquivo na caixa de
entrada, quando a extensão não for informada. Caso esteja vazio, nenhuma
extensão é concatenada ao final do nome do arquivo. Extensões múltiplas podem
ser especificadas usando-se o caractere de ponto e vírgula como delimitador. A
String deve terminar com barras duplas verticais (||).
O parâmetro Flags é opcional e define o comportamento da caixa de diálogo. É um
número inteiro correspondendo à soma dos valores da tabela a seguir. O
parâmetro Filter é opcional e define um conjunto de pares de Strings que
especificam filtros que podem ser aplicados aos arquivos. A primeira String
descreve o filtro e a segunda indica o tipo de extensão a ser utilizada.
94 Visualização
Combinações possíveis para o parâmetro Flags
VALOR DESCRIÇÃO
1 CREATEPROMPT: Se o us uá ri o es peci fi ca r
um a rqui vo que nã o exi s te, es te flag
permi te que s eja ques ti ona do s obre a
cri a çã o do a rqui vo. Se es col her cri a r o
a rqui vo, a ca i xa de di á l ogo é fecha da e o
nome do a rqui vo é retorna do no
pa râ metro Filename. Ca s o contrá ri o, a
ca i xa de di á l ogo perma nece a berta .
2 FILEMUSTEXIST: Es peci fi ca que o us uá ri o
s ó pode di gi ta r nomes de a rqui vos
exi s tentes . Ca s o contrá ri o, a ca i xa de
di á l ogo mos tra um a vi s o na ca i xa de
mens a gens .
4 NOCHANGEDIR: Recupera o di retóri o
a tua l pa ra o va l or ori gi na l ca s o o us uá ri o
tenha muda do de di retóri o enqua nto
bus ca va o a rqui vo. Nã o tem efei to pa ra a
ca i xa de di á l ogo Abrir Arquivo no
Wi ndows XP.
8 NODEREFERENCELINKS: Confi gura a ca i xa
de di á l ogo pa ra retorna r o a rqui vo de
a ta l ho (.l nk) s el eci ona do. Se es te flag
nã o for es peci fi ca do, a ca i xa de di á l ogo
retorna o ca mi nho e nome de a rqui vo
referenci a dos pel o a rqui vo de a ta l ho.
16 NOREADONLYRETURN: Determi na que o
a rqui vo retorna do nã o s eja s omente
pa ra l ei tura , e o di retóri o nã o é
protegi do contra gra va çã o.
32 PATHMUSTEXIST: Es peci fi ca que o us uá ri o
pode i nforma r a pena s a rqui vos e
di retóri os vá l i dos , ca s o contrá ri o uma
ca i xa de mens a gem é mos tra da pa ra
a vi s a r o us uá ri o.
64 READONLY: Permi te que a opçã o Somente
Leitura s eja s el eci ona da i ni ci a l mente
qua ndo a ca i xa de di á l ogo é cri a da .
128 OVERWRITEPROMPT: Permi te que a ca i xa
de di á l ogo Salvar Como gere uma
mens a gem i nforma ndo da exi s tênci a do
a rqui vo, e pede confi rma çã o pa ra
s obres crever o a rqui vo.
Exemplo de filtro:
"Arquivos de Chart (*.xlc)|*.xlc|Planilhas Excel (*.xls)_
|*.xls|Arquivos de Dados (*.xlc;*.xls)|*.xlc; *.xls
Visualização 95
|Todos os arquivos (*.*)|*.*||"
4.1.2.33 ShowPickColor
ShowPickColor(ColorValue[, Color, Left, Top])
Abre a caixa de diálogo Cores do Windows para selecionar uma cor. O valor
decimal da cor selecionada é retornado no parâmetro ColorValue. O parâmetro
Color indica uma cor previamente selecionada na paleta de cores. Se este
parâmetro não for informado, assume o valor 0 (zero, preto). A posição da caixa de
diálogo pode ser configurada através dos parâmetros Left e Top, que indicam,
respectivamente, a distância da margem esquerda e do topo da tela, em pixels.
Caso estes parâmetros não sejam informados, a caixa de diálogo é centralizada.
Exemplo:
Sub CommandButton_Click()
Dim novaCor
Dim corPadrao
corPadrao = 65280 ' Verde Claro
If Application.ShowPickColor(novaCor, corPadrao, 90, 90) Then
Screen.Item("Retangulo1").ForegroundColor = novaCor
Screen.Item("Texto1").Value = novaCor
End If
End Sub
4.1.2.34 ShowPowerExplorer
ShowPowerExplorer(Title, RootObject[, Left, Top, ReadOnly, ScreenObject, BKColor])
Mostra uma janela com todas as Medidas Analógicas e Discretas, Comandos e
Proteções do objeto selecionado. Os parâmetros deste método são listados na
tabela a seguir.
Parâmetros do método ShowPowerExplorer
PARÂMETRO DESCRIÇÃO
Title Determi na o títul o da ja nel a .
Corres ponde à propri eda de Title do
objeto PowerExpl orer.
RootObject Ca mi nho do equi pa mento de da dos .
Left Pa râ metro opci ona l . Coordena da
hori zonta l da ja nel a , em pi xel s . Veja o
método SetWindowPlacement do objeto
PowerExpl orer pa ra ma i ores i nforma ções
s obre o comporta mento des te
pa râ metro.
Top Pa râ metro opci ona l . Coordena da verti ca l
da ja nel a , em pi xel s . Veja o método
SetWindowPlacement do objeto
PowerExpl orer pa ra ma i ores i nforma ções
s obre o comporta mento des te
pa râ metro.
96 Visualização
PARÂMETRO DESCRIÇÃO
ReadOnly Pa râ metro opci ona l . Se a jus ta do pa ra
Fa l s o (va l or pa drã o), permi te que s eja m
a l tera dos os va l ores da s Medi da s cuja
propri eda de ActiveSource s eja i gua l a 2 -
Operador (Discretas ou Analógicas), e
ta mbém envi a r Coma ndos . Corres ponde
à propri eda de ReadOnly do objeto
PowerExpl orer.
ScreenObject Pa râ metro opci ona l . Informa o objeto
grá fi co a s s oci a do a es te método,
fa zendo com que os termi na i s do objeto
grá fi co s eja m rea l ça dos . Corres ponde à
propri eda de ScreenObject do objeto
PowerExpl orer.
BKColor Pa râ metro opci ona l . Cor de fundo do
Di s pl a y contendo os va l ores da s
Medi da s , Coma ndos e Proteções .
Corres ponde à propri eda de
DisplayBkColor do objeto PowerExpl orer.
Exemplo de uso:
Sub Botao1_Click()
Application.ShowPowerExplorer "Disjuntor 5201",_
"SE1.[5201]", 100, 100, False,_
Screen.Item("Breaker5201"), RGB(0,0,0)
End Sub
NOTA: As propri eda des do objeto PowerExpl orer podem s er confi gura da s no objeto
retorna do pel o método GetPowerExplorer.
4.1.2.35 Stopsound
Stopsound()
Para um som que esteja executando.
4.1.2.36 ToggleValue
ToggleValue(TagName, ValA, ValB)
O método ToggleValue busca o valor do objeto ou propriedade em execução no
servidor e compara com os parâmetros ValA e ValB. Se o valor buscado for igual a
ValB, o objeto ou propriedade especificado em TagName recebe o valor de ValA.
Caso contrário, recebe o valor de ValB. Caso o valor de TagName não seja nem ValA
nem ValB, o método ToggleValue atribui o valor especificado em ValA. Exemplo:
Sub Botao1_Click()
' Ao clicar no Botão, atribui o valor
Visualização 97
' a um Tag sendo executado em um Servidor de Dados.
' Atribui o valor 20 para o Tag.
Application.SetValue "Dados1.TagInterno1", 20
' Já que o valor do TagInterno1 já é 20,
' o método ToggleValue alterna o valor para 30.
Application.ToggleValue "Dados1.TagInterno1", 30, 20
End Sub
4.1.2.37 TrackEvent
TrackEvent(EventMessage[, Comment, TimeStamp])
O método TrackEvent permite gerar eventos via script manualmente. Estes eventos
podem ser gerados tanto no Viewer como no Servidor, e são registrados em uma
tabela no banco de dados do aplicativo.
Parâmetros do método TrackEvent
NOME DESCRIÇÃO
EventMessage Contém a mens a gem do evento (má xi mo
de 200 ca ra cteres ).
Comment (Opci ona l ) Contém comentá ri os
a di ci ona i s s obre o evento (má xi mo de
200 ca ra cteres ).
TimeStamp (Opci ona l ) Indi ca a da ta e hora em que o
evento ocorreu. Se nã o for es peci fi ca do,
o El i ps e Power a s s ume a da ta e a hora
a tua i s .
98 Visualização
4.1.2.38 UserAdministration
UserAdministration()
Este método abre uma caixa de diálogo que permite editar a lista de usuários do
Servidor. As funções disponíveis são:
Mostrar a lista de todos os usuários
Excluir usuários (não é possível excluir o usuário atual)
Adicionar e editar usuários
Editar as configurações de um usuário
Alterar a senha do usuário
Alterar os demais dados do usuário (login, nome, etc.)
IMPORTANTE: Apena s o Admi ni s tra dor pode ter a ces s o a o método UserAdministration.
A ca i xa de di á l ogo de confi gura çã o dos us uá ri os é a ces s ível s omente a o us uá ri o
ha bi l i ta do como Admi ni s tra dor.
4.1.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Viewer.
4.1.3.1 BlinkTime
Define o tempo, em milissegundos, entre cada mudança de estado quando um
objeto tem que piscar, ou seja, toda vez que algum objeto de Tela tem uma
Associação e é selecionada a opção Piscar. O valor padrão desta propriedade é 200
ms.
4.1.3.2 CacheEnable
Mantém em memória as Telas já abertas instanciadas no Viewer, permitindo uma
troca mais rápida entre elas. Se a propriedade estiver habilitada, então o cache de
Telas também é habilitado.
4.1.3.3 Caption
Determina o nome da aplicação que está utilizando o Viewer. O valor padrão
desta propriedade é uma String vazia.
Visualização 99
4.1.3.4 CenterWindow
Quando habilitada, determina que a janela de visualização do Viewer deve
iniciar centralizada. Caso contrário, é utilizada a configuração padrão. O valor
padrão desta propriedade é Verdadeiro.
4.1.3.5 CloseButton
Se esta propriedade estiver configurada como Verdadeiro, o botão Fechar é
habilitado no Viewer, e é possível utilizar este botão. Caso contrário, este botão
não aparece na janela. O valor padrão desta propriedade é Verdadeiro.
4.1.3.6 CommErrorBkColor
Propriedade utilizada para definir a cor de fundo de um SetPoint quando uma
Associação ou Conexão falha. O valor padrão desta propriedade é vermelho
(RGB(255, 0, 0)). Verifique também a propriedade EnableCommError.
4.1.3.7 CommErrorText
Propriedade utilizada para definir o texto de alerta quando uma Associação ou
Conexão falha. O valor padrão desta propriedade é "???". Verifique também a
propriedade EnableCommError.
4.1.3.8 CommErrorTextColor
Propriedade utilizada para definir a cor do texto de um SetPoint quando uma
Associação ou Conexão falha. O valor padrão desta propriedade é amarelo
(RGB(255, 255, 0)). Verifique também a propriedade EnableCommError.
4.1.3.9 DisableTaskSwitching
Se estiver configurada para Verdadeiro, desabilita a troca de janelas no Viewer.
Caso contrário, a troca de janelas é habilitada. O valor padrão desta propriedade é
Falso. Esta propriedade pode ser modificada em tempo de execução utilizando o
método SetDisableTaskSwitching.
4.1.3.10 EnableCommError
Habilita ou desabilita a visualização dos erros de comunicação. Por exemplo,
caso haja na Tela um SetPoint associado a um Tag de Comunicação, e a
comunicação do Elipse Power com este Tag falhe, é mostrado no SetPoint o texto
configurado na propriedade CommErrorText, com a cor informada na propriedade
CommErrorTextColor e a cor de fundo do SetPoint definida na propriedade
CommErrorBkColor. O valor padrão desta propriedade é Verdadeiro.
100 Visualização
4.1.3.11 EnableHeartbeat
Habilita ou desabilita o envio de uma mensagem de heartbeat (enviada em
intervalos fixos, que indica que o servidor está ativo) entre o Viewer e o servidor.
Caso o Viewer pare de receber as mensagens de heartbeat, é sinal de que algum
problema ocorreu, portanto a conexão deve ser abortada. O valor padrão desta
propriedade é Falso.
4.1.3.12 EnableInactivity
Habilita ou desabilita a verificação do período de inatividade do usuário. Para
maiores informações, veja o evento OnInactive do objeto Viewer. O valor padrão
desta propriedade é Falso. Esta propriedade não pode ser alterada em tempo de
execução.
4.1.3.13 EnableZoomMenu
Se estiver configurada como Verdadeiro, habilita a exibição do menu de
configuração do zoom da Tela através do botão direito do mouse em tempo de
execução, exceto quando algum script estiver configurado com informação
divergente nos eventos MouseDown ou MouseUp. Caso contrário, o menu não é
mostrado. O valor padrão desta propriedade é Verdadeiro.
4.1.3.14 HeartbeatPeriodMs
Indica o intervalo, em milissegundos, entre as mensagens de heartbeat enviadas
pelo Servidor. A mensagem de heartbeat sempre é enviada quando o servidor
permanece pelo período indicado por esta propriedade sem enviar nenhuma
mensagem para o Viewer. O valor padrão desta propriedade é 2000 (dois
segundos).
4.1.3.15 HeartbeatTimeoutMs
Indica o tempo, em milissegundos, que o Viewer tolera sem receber nenhuma
mensagem do Servidor. Se este tempo passar e nenhuma mensagem for recebida, o
Viewer assume que a conexão foi perdida e inicia o processo de reconexão. Este
tempo deve ser maior que o tempo determinado na propriedade
HeartbeatPeriodMs, de preferência maior que o dobro. O valor padrão desta
propriedade é 5000 (cinco segundos).
4.1.3.16 InactivityTime
Define o tempo máximo de espera por um evento de mouse ou de teclado antes do
período de inatividade, em minutos. Para maiores informações, veja o evento
OnInactive do objeto Viewer. O valor padrão desta propriedade é 5 (cinco) minutos.
Exemplo:
Visualização 101
Sub CommandButton3_Click()
MsgBox "A aplicação ficará inativa em " & _
Application.InactivityTime & " minuto(s)."
End Sub
4.1.3.17 InitialScreen
Indica a Tela ou Quadro inicial que deve ser mostrado quando o Viewer é aberto.
Através da propriedade WindowStyle é possível determinar se a janela deve iniciar
maximizada, janelada ou minimizada. O valor padrão desta propriedade é
"TelaInicial".
4.1.3.18 IsPlaybackMode
Se Verdadeiro, indica que o Viewer está em execução dentro de um E3Playback,
em modo playback. Esta propriedade é somente de leitura e só está disponível em
tempo de execução.
4.1.3.19 IsReadOnly
Se ajustada para Verdadeiro, indica que o Viewer está no modo Somente Leitura
(acesso restrito).
4.1.3.20 LoginRetries
Especifica o número de retentativas de login do Viewer, isto é, quantas vezes a
caixa de diálogo de login é exibida além da primeira vez. O valor padrão desta
propriedade é 2 (dois).
4.1.3.21 MaximizeButton
Se esta propriedade estiver configurada como Verdadeiro, o botão Maximizar é
habilitado no Viewer e é possível utilizar este botão. Caso contrário, este botão não
aparece na janela. O valor padrão desta propriedade é Verdadeiro.
4.1.3.22 MinimizeButton
Se esta propriedade estiver configurada como Verdadeiro, o botão Minimizar é
habilitado no Viewer e é possível utilizar este botão. Caso contrário, este botão não
aparece na janela. O valor padrão desta propriedade é Verdadeiro.
4.1.3.23 Params
Esta propriedade é um vetor de pares chave-valor, que retorna os parâmetros
passados para o Viewer através da opção de linha de comando -params. Todos os
valores são retornados como Strings. Por exemplo, se a linha de comando do
Viewer contiver os seguintes parâmetros:
102 Visualização
Viewer -params Idioma=PTB
4.1.3.24 ReconnectDialogDelaySec
Indica o número de segundos que o Viewer espera durante uma possível
reconexão ao servidor antes de mostrar uma mensagem avisando o usuário desta
ação (esta propriedade não afeta a primeira conexão). Se for igual a 0 (zero), a
mensagem de reconexão sempre é mostrada. Para evitar que a mensagem seja
mostrada, é recomendável colocar um número muito grande (um bilhão, por
exemplo).
4.1.3.25 RenderQuality
Controla a qualidade de desenho de todas as Telas, somente se o valor da
propriedade RenderQuality das Telas seja igual a 0 - rqDefault. Os valores
possíveis para esta propriedade são os seguintes:
0 - rqDefault: Utiliza o modo de qualidade normal, GDI (Graphics Device
Interface). Corresponde ao item Utilizar Padrão do menu contextual Qualidade
(todas as telas) do Viewer, em tempo de execução. Este é o valor padrão para
aplicações criadas em versões anteriores à 4.0
1 - rqNormal: Força o modo de qualidade normal (GDI) para o desenho de
todas as Telas. Corresponde ao item Forçar Qualidade Normal do menu
contextual Qualidade (todas as telas) do Viewer, em tempo de execução
2 - rqHighQuality: Força o modo de alta qualidade (GDI+) para o desenho de
Visualização 103
todas as Telas. Corresponde ao item Forçar Alta Qualidade do menu
contextual Qualidade (todas as telas) do Viewer, em tempo de execução. Este é
o valor padrão para aplicações criadas a partir da versão 4.0
4.1.3.26 ShowKeyPadOnEdit
Esta propriedade automaticamente habilita a exibição do Elipse KeyPad, sempre
que um objeto de Tela que permita edição receba o foco.
104 Visualização
4.1.3.27 TargetDPIX
Define o valor de pontos por polegada, na horizontal, do monitor do computador
de destino. O valor padrão desta propriedade é -1 (menos um), que assume o valor
do computador atual.
4.1.3.28 TargetDPIY
Define o valor de pontos por polegada, na vertical, do monitor do computador de
destino. O valor padrão desta propriedade é -1 (menos um), que assume o valor do
computador atual.
4.1.3.29 TargetMarginX
Define o número de pixels que devem ser descontados da resolução horizontal da
Tela (a área útil do Viewer). O valor padrão da propriedade é -1 (menos um), que
assume a configuração da janela do Viewer (com ou sem a barra de título, com ou
sem borda) em conjunto com a configuração do computador atual (largura de
borda e barra de título definidas pelo Windows).
4.1.3.30 TargetMarginY
Define o número de pixels que devem ser descontados da resolução vertical da
Tela (a área útil do Viewer). O valor padrão da propriedade é -1 (menos um), que
assume a configuração da janela do Viewer (com ou sem a barra de título, com ou
sem borda) em conjunto com a configuração do computador atual (largura de
borda e barra de título definidas pelo Windows).
4.1.3.31 TargetResolutionX
Define a resolução horizontal da Tela para a qual esta aplicação está destinada,
em pixels. O valor padrão desta propriedade é -1 (menos um), que assume a
resolução do computador atual.
4.1.3.32 TargetResolutionY
Define a resolução vertical da Tela para a qual esta aplicação está destinada, em
pixels. O valor padrão desta propriedade é -1 (menos um), que assume a resolução
do computador atual.
4.1.3.33 TitleBar
Se esta propriedade estiver habilitada, a barra de título do Viewer é mostrada,
conforme as especificações da propriedade Caption. Do contrário, ela é escondida.
O valor padrão desta propriedade é Verdadeiro.
Visualização 105
4.1.3.34 User
Contém o nome do usuário que está utilizando o Viewer. Esta propriedade é
somente para leitura.
4.1.3.35 ViewerLanguageId
Retorna o código do idioma do Viewer em execução. Os valores possíveis para
esta propriedade estão descritos na tabela a seguir. Esta propriedade é somente de
leitura e só está disponível em tempo de execução.
Valores disponíveis para ViewerLanguageId
DECIMAL HEXADECIMAL IDIOMA
4 0x0004 Chi nês Si mpl i fi ca do
1031 0x0407 Al emã o
1033 0x0409 Ingl ês Ameri ca no
1034 0x040A Es pa nhol
1046 0x0416 Português do Bra s i l
4.1.3.36 WindowBorder
Habilita ou desabilita uma borda na janela do Viewer. O valor padrão desta
propriedade é Verdadeiro. Esta propriedade é de leitura e escrita, mas alterar seu
valor em tempo de execução não altera a configuração do Viewer já aberto, apenas
das janelas que forem abertas utilizando a configuração do Viewer.
4.1.3.37 WindowHeight
Determina a altura da janela do Viewer, em pixels. O valor padrão desta
propriedade é 300.
4.1.3.38 WindowMovable
Indica se a janela pode ser movida. O valor padrão desta propriedade é
Verdadeiro. Esta propriedade é de leitura e escrita, mas alterar seu valor em tempo
de execução não altera a configuração do Viewer já aberto, apenas das janelas que
forem abertas utilizando a configuração do Viewer.
106 Visualização
4.1.3.39 WindowResizable
Indica se a janela pode ser redimensionada. Esta propriedade só tem efeito se a
propriedade WindowBorder for Verdadeira. O valor padrão desta propriedade é
Verdadeiro. Esta propriedade é de leitura e escrita, mas alterar seu valor em tempo
de execução não altera a configuração do Viewer já aberto, apenas das janelas que
forem abertas utilizando a configuração do Viewer.
4.1.3.40 WindowSmallTitle
Indica se a janela do Viewer deve ter a barra de título pequena. Esta propriedade
só tem efeito se a propriedade TitleBar for Verdadeira. O valor padrão desta
propriedade é Falso. Esta propriedade é de leitura e escrita, mas alterar seu valor
em tempo de execução não altera a configuração do Viewer já aberto, apenas das
janelas que forem abertas utilizando a configuração do Viewer.
4.1.3.41 WindowStayOnTop
Indica se a janela do Viewer deve sempre se sobrepor às outras janelas. O valor
padrão desta propriedade é Falso. Esta propriedade é de leitura e escrita, mas
alterar seu valor em tempo de execução não altera a configuração do Viewer já
aberto, apenas das janelas que forem abertas utilizando a configuração do Viewer.
4.1.3.42 WindowStyle
Define o estilo inicial de janela do Viewer. As opções disponíveis são:
0 - Maximized: Inicia o Viewer maximizado
1 - Windowed: Inicia o Viewer janelado
2 - Minimized: Inicia o Viewer minimizado
4.1.3.43 WindowWidth
Determina a largura da janela do Viewer, em pixels. O valor padrão desta
propriedade é 400.
Visualização 107
4.2.1.1 BringToFront
BringToFront()
Traz para a frente um Divisor que esteja escondido ou abaixo de outro.
4.2.1.2 CaptureScreen
CaptureScreen(Filename)
Captura o conteúdo de um Divisor, gravando-o no arquivo de nome e caminho
Filename, no formato BMP. Exemplo:
Sub CommandButton1_Click()
' Quando o botão é clicado, copia o conteúdo
' do Divisor para o arquivo Frame.bmp.
Screen.Frame.CaptureScreen("c:\temp\frame.bmp")
End Sub
4.2.1.3 Close
Close(Code)
Utilize o método Close para fechar a janela do Quadro. O parâmetro Code tem o
valor de retorno para o método DoModal, se a janela em questão tiver sido
chamada por este método. Exemplo:
Sub BotaoFecha_Click()
' Quando BotaoFecha for clicado, fecha a janela.
Screen.Close(0)
End Sub
4.2.1.4 FlashWindow
FlashWindow(Number, Time)
Este método permite que o ícone do Viewer comece a piscar na Área de Notificações
do Windows. O parâmetro Number determina o número de vezes que o ícone deve
piscar e Time determina o tempo, em milissegundos, entre um piscar e outro.
Exemplo:
Sub Texto1_Click()
Set quadro = Application.GetFrame("_top")
quadro.FlashWindow 50, 500
End Sub
4.2.1.5 MaximizeFrame
MaximizeFrame()
Maximiza um Quadro ou Tela modal.
108 Visualização
4.2.1.6 MinimizeFrame
MinimizeFrame()
Minimiza um Quadro ou Tela modal.
4.2.1.7 MoveFrame
MoveFrame([PosX, ][PosY, ][SizeX, ][SizeY])
Move e redimensiona um Divisor (Frame) para uma coordenada e um tamanho
específicos. Os parâmetros PosX e PosY informam a nova posição, em pixels, com
relação à esquerda e ao topo, respectivamente. Os parâmetros SizeX e SizeY
informam o novo comprimento e a nova altura, respectivamente, em pixels ou em
Himetric. Todos os parâmetros são opcionais. Exemplo:
Sub Tela2_OnPreShow(vArg)
' Quando a Tela2 é aberta no Divisor Teste, altera a posição
' e o tamanho do Divisor
Application.GetFrame("Teste").MoveFrame 100, 100, 200, 200
End Sub
NOTA: Os va l ores de ta ma nho nes te método podem s er i nforma dos como números
ou Strings. No ca s o de números , s ã o cons i dera dos em pi xel s . No ca s o de Strings, s e
vi erem a compa nha dos da uni da de "hm", s ã o i nterpreta dos como Hi metri c.
Qua l quer outro ca s o é cons i dera do em pi xel s .
4.2.1.8 OpenScreen
OpenScreen(ScreenName, Arg)
O método OpenScreen abre uma Tela dentro de um Divisor. O parâmetro
ScreenName determina o nome da Tela a ser aberta. É possível também especificar o
percentual de zoom da Tela e a habilitar a barra de rolagem através da chave "?",
como no modelo a seguir.
<nome-da-tela>?<zoom>?<habilitar-rolagem>
Sub Tela2_OnPreShow(vArg)
' A caixa de mensagem vai mostrar a
' frase "Isso é um Teste."
MsgBox vArg
End Sub
4.2.1.9 Refresh
Refresh(Force)
O método Refresh permite forçar o redesenho do conteúdo de uma Tela ou Divisor.
Ele deve ser usado em scripts de Viewer com processamento massivo (por exemplo,
laços) ou em chamadas de métodos que demandem muito tempo e exijam
indicações visuais ao usuário do progresso do processo.
Devido ao redesenho em geral ser uma operação pesada, a versão padrão do
método Refresh (sem parâmetros) é otimizada de forma a ignorar pedidos de
redesenho muito próximos, incluindo redesenho do próprio Elipse Power. Este
comportamento padrão é ideal para indicações de progresso em laços, onde
muitos redesenhos são realizados em sequência. O parâmetro Force desabilita esta
otimização, garantindo que para cada chamada do método Refresh seja realizado
um redesenho. Porém, ao utilizar-se esta opção, o método Refresh não pode ser
chamado repetidamente, como dentro de um laço. Exemplo:
Sub CommandButton1_Click()
' Desenha uma barra de progresso de uma operação
While i < 31
Screen.Item("Retangulo2")_
.HorizontalPercentFill = (i / 30) * 100
Frame.Refresh True
' <-- alguma operação demorada -->
Wend
End Sub
110 Visualização
4.2.1.10 RestoreFrame
RestoreFrame()
Permite restaurar a janela do Quadro para o seu tamanho original.
4.2.1.11 SetDisableTaskSwitching
SetDisableTaskSwitching(Disable)
Habilita ou desabilita a troca de janelas. O parâmetro Disable é um valor Booleano
que indica se a troca de janelas é habilitada ou não. Este método atualiza a
propriedade DisableTaskSwitching do objeto Viewer.
NOTAS:
Se ma i s de uma i ns tâ nci a do Vi ewer es ti ver executa ndo em uma mes ma
má qui na , e pel o menos uma des ta s i ns tâ nci a s uti l i za r o método
SetDisableTaskSwitching, a a l tera çã o a feta todos os Vi ewers des ta má qui na
Ca s o s eja neces s á ri o modi fi ca r o títul o ou o es ti l o da ja nel a , o método
SetFrameOptions deve s er uti l i za do a pós a cha ma da a o método
SetDisableTaskSwitching
4.2.1.12 SetForegroundWnd
SetForegroundWnd()
O método SetForegroundWnd ativa e move o foco para a janela do Viewer. Este
método é útil quando se deseja chamar a atenção do operador para algum evento
ocorrido, quando a janela do Viewer encontra-se escondida ou minimizada.
4.2.1.13 SetFrameOptions
SetFrameOptions(Title, Flags)
Utilizado para configurar o título do Quadro na janela e o estilo da janela. O
parâmetro Title é uma String que contém o título da janela. Este texto é mostrado se
a propriedade Caption da Tela estiver vazia.
O parâmetro Flags especifica o estilo da janela. Se este parâmetro for omitido, o
valor padrão é -1 (menos um). Este valor é usado para manter a configuração
anterior da janela. Quando o valor especificado não for -1 (menos um), pode-se
modificar o estilo da janela especificando a soma dos valores das combinações
descritas na tabela a seguir.
Combinações possíveis para o parâmetro Flags
VALOR DESCRIÇÃO
1 Ha bi l i ta a ba rra de títul o na ja nel a
2 Ha bi l i ta o botã o Fechar na ja nel a
Visualização 111
VALOR DESCRIÇÃO
4 Ha bi l i ta o botã o Minimizar na ja nel a
8 Ha bi l i ta o botã o Maximizar na ja nel a
16 Ha bi l i ta a borda na ja nel a
32 Es peci fi ca que a ja nel a pode s er
di mens i ona da (pa ra i s to, é neces s á ri o
que a ja nel a tenha uma borda )
64 Es peci fi ca que a ja nel a pode s er movi da
256 Es peci fi ca que a ja nel a fi ca no topo da
Tel a
512 Es peci fi ca que a ja nel a é confi gura da no
es ti l o Barra de Ferramentas
1024 Des a bi l i ta os botões de objeto
2048 Centra l i za a ja nel a
Exemplo:
Sub Tela_OnPreShow()
Frame.SetFrameOptions("Tela de Alarmes", 114)
End Sub
No exemplo anterior, o valor 114 (2 + 16 + 32 + 64) indica que a janela tem o botão
Fechar habilitado (2), tem uma borda (16), pode ser dimensionada (32) e pode ser
movida (64). O título da janela é "Tela de Alarmes".
Nos Picks Abrir Tela e Abrir Tela Modal também é possível configurar o estilo da
janela durante a edição, através da caixa de diálogo Estilo da Janela. Para mais
informações, veja o tópico Picks.
4.2.1.14 ShowScreen
ShowScreen(Screen, Zoom, Scrollbars[, Arg])
Este método carrega uma Tela no Divisor, fechando a Tela ou Quadro carregado
anteriormente. Os parâmetros disponíveis neste método são os seguintes:
Screen: O objeto Tela a ser carregado. Este objeto deve ser retornado pelo
método GetScreen do Viewer
Zoom: Percentual de zoom da Tela
Scrollbars: Booleano que indica se a barra de rolagem da Tela deve ou não
estar habilitada
Arg: String opcional cujo valor é usado no evento OnPreShow da Tela a ser
112 Visualização
carregada
NOTA: O pa râ metro Screen s omente a cei ta o objeto retorna do pel o método GetScreen
do Vi ewer. Es te método fa l ha ca s o s eja uti l i za do um objeto Tel a obti do a pa rti r de
outro método ou propri eda de, como por exempl o a propri eda de Screen, comum a
todos os objetos de Tel a .
4.2.2.1 IsHTML
A propriedade IsHTML retorna Verdadeiro se o Divisor contém código HTML
inserido no Quadro. Caso contrário, retorna Falso.
4.2.2.2 SplitBorder
Habilita ou desabilita a borda do Divisor e determina se a borda entre o Divisor
mandante e o Divisor restante deve ser exibida em tempo de execução. Esta
propriedade não tem efeito no Divisor restante. O valor padrão desta propriedade é
Verdadeiro.
4.2.2.3 SplitDockPosition
Indica a posição do Divisor desejado na Tela. As opções disponíveis estão
descritas na tabela a seguir.
Opções disponíveis para SplitDockPosition
OPÇÃO DESCRIÇÃO
0 - dockRemaining Pos i ci ona o Di vi s or como res ta nte, ou
s eja , el e ocupa o es pa ço que s obra na
Di vi s ã o hori zonta l ou verti ca l .
1 - dockTop Pos i ci ona o Di vi s or como ma nda nte,
a ci ma do res ta nte.
2 - dockBottom Pos i ci ona o Di vi s or como ma nda nte,
a ba i xo do res ta nte.
3 - dockLeft Pos i ci ona o Di vi s or como ma nda nte, à
es querda do res ta nte.
4 - dockRight Pos i ci ona o Di vi s or como ma nda nte, à
di rei ta do res ta nte.
Visualização 113
4.2.2.4 SplitLink
A propriedade SplitLink contém um link que deve ser mostrado no Divisor. É
possível especificar uma Tela do projeto, um executável ou um link na Internet. No
caso de Telas, é possível especificar um percentual de zoom e habilitar as barras de
rolagem usando a chave "?", como no modelo "<nome-da-tela>?<zoom>?<barra-de-
rolagem>", onde nome-da-tela é o nome da Tela a ser aberta. zoom é o percentual
de zoom e barra-de-rolagem é 1 (um) para habilitar ou 0 (zero) para desabilitar. Os
parâmetros zoom e barra-de-rolagem são válidos apenas se o link indicado se tratar
de uma Tela. Caso contrário, são ignorados. Se o parâmetro zoom não for
informado, assume 100%. Se o parâmetro barra-de-rolagem não for informado,
assume 1 (um), ou seja, habilitado.
4.2.2.5 SplitResizable
Determina se o Divisor mandante pode ser redimensionado em tempo de
execução. Esta propriedade não tem efeito no Divisor restante. O valor padrão
desta propriedade é Verdadeiro.
4.2.2.6 SplitValue
A propriedade SplitValue determina o valor que é atribuído ao Divisor do Quadro.
No Studio, este valor pode ser acompanhado da unidade "%" (porcentagem),
"hm" (Himetric) ou "px" (pixels). Se a unidade for omitida, o valor é considerado em
Himetric. Em tempo de execução, o valor deve ser numérico e sempre é considerado
como porcentagem.
4.2.3.1 Caption
A propriedade Caption define o título do Quadro a ser mostrado na barra de título
no Viewer.
4.3.1 Tela
Esta seção contém informações sobre eventos, métodos e propriedades do objeto
Tela.
114 Visualização
4.3.1.1 Eventos
Esta seção contém informações sobre os eventos do objeto Tela.
4.3.1.1.1 Click
Click()
Ocorre quando o botão esquerdo do mouse é pressionado sobre a Tela. Este evento
não ocorre se a Tela não estiver visível ou sua propriedade Enabled estiver
configurada para Falso. A visibilidade da Tela depende de três fatores:
Propriedade Visible igual a Verdadeiro, objeto pai visível e propriedade Layer do
objeto presente na camada da Tela.
4.3.1.1.2 DbClick
DbClick()
Ocorre quando há um duplo-clique, ou seja, o botão esquerdo do mouse é
pressionado rapidamente duas vezes sobre a Tela. Este evento não ocorre se o
objeto não estiver visível ou se sua propriedade Enabled estiver configurada para
Falso. A visibilidade do objeto depende de três fatores: Propriedade Visible igual a
Verdadeiro, objeto pai visível e propriedade Layer do objeto presente na camada da
Tela.
4.3.1.1.3 KeyDown
KeyDown(KeyCode, Shift)
Ocorre no momento em que uma tecla é pressionada, independente do foco na Tela.
Variáveis do evento KeyDown
NOME DESCRIÇÃO
KeyCode Número i ntei ro que i denti fi ca o ca ra ctere
ASCII da tecl a que foi pres s i ona da .
Shift Mos tra a tecl a pres s i ona da junta mente
com o botã o do mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
Exemplo:
Sub Tela1_KeyDown(KeyCode, Shift)
' Mostra uma caixa de mensagem quando
' o usuário pressiona uma tecla
MsgBox "Código da tecla: " & KeyCode
End Sub
Visualização 115
NOTA: Pa ra uma l i s ta com todos os códi gos de tecl a di s ponívei s pa ra o pa râ metro
KeyCode, cons ul te o a rti go Keys Enumeration no Microsoft Developer Network.
4.3.1.1.4 KeyUp
KeyUp(KeyCode, Shift)
Ocorre no momento em que uma tecla é solta, independente do foco na Tela.
Variáveis do evento KeyUp
NOME DESCRIÇÃO
KeyCode Número i ntei ro que i denti fi ca o ca ra ctere
ASCII da tecl a que foi pres s i ona da .
Shift Mos tra a tecl a pres s i ona da junta mente
com o botã o do mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
Exemplo:
Sub Tela1_KeyUp(KeyCode, Shift)
' Mostra uma caixa de mensagem quando o usuário
' soltar uma tecla
MsgBox "Código da tecla: " & KeyCode
End Sub
4.3.1.1.5 MouseDown
MouseDown(Button, ShiftState, MouseX, MouseY)
Ocorre quando se pressiona qualquer botão do mouse sobre a Tela. Utilize o
evento MouseDown para determinar ações específicas quando a Tela for clicada
pelo usuário.
Variáveis do evento MouseDown
NOME DESCRIÇÃO
Button Mos tra o botã o do mous e pres s i ona do:
1: O botã o do mous e pres s i ona do é o
es querdo
2: O botã o do mous e pres s i ona do é o
di rei to
116 Visualização
NOME DESCRIÇÃO
ShiftState Mos tra a tecl a pres s i ona da junta mente
com o botã o do mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
MouseX Mos tra a coordena da X onde o pontei ro do
mous e foi cl i ca do na Tel a .
MouseY Mos tra a coordena da Y onde o pontei ro do
mous e foi cl i ca do na Tel a .
Exemplo:
Sub TelaInicial_MouseDown(Button, ShiftState, MouseX, MouseY)
' Encerra a aplicação quando houver um clique de mouse
' no objeto TelaInicial.
Application.Exit()
End Sub
4.3.1.1.6 MouseUp
Exemplo:
Sub TelaInicial_MouseUp(Button, ShiftState, MouseX, MouseY)
' Encerra a aplicação apenas quando o usuário soltar o botão.
Visualização 117
Application.Exit()
End Sub
4.3.1.1.7 OnHide
OnHide()
Ocorre quando uma Tela está prestes a ser fechada. Utilize o evento OnHide quando
for necessário efetuar alguma operação antes do objeto Tela ser fechado. Este
evento pode ocorrer de diversas maneiras:
Quando a Tela for substituída por outra através dos métodos OpenScreen ou
ShowScreen
Quando o usuário fechar a janela onde está a Tela
Quando for utilizado o método Close do objeto Tela
Quando o Viewer for fechado ou encerrado
4.3.1.1.8 OnPreShow
OnPreShow(Arg)
Ocorre antes da Tela ser mostrada. A variável de evento Arg recebe o conteúdo do
parâmetro Arg dos métodos OpenScreen e ShowScreen, que geram este evento. Logo
após, é gerado o evento OnShow. Exemplo:
Sub Screen1_OnPreShow(Arg)
' O título da Tela Screen1 a ser mostrada
' foi passado como parâmetro na chamada do método
' OpenScreen que gerou o evento.
Caption = Arg
End Sub
4.3.1.1.9 OnShow
OnShow()
Ocorre no momento exato que uma Tela é mostrada. Utilize o evento OnPreShow
para efetuar alguma operação antes que a Tela seja exibida. Exemplo:
Sub TelaPrincipal_OnShow()
MsgBox "Seja bem-vindo ao sistema!"
End Sub
4.3.1.2 Métodos
Esta seção contém informações sobre os métodos do objeto Tela.
118 Visualização
4.3.1.2.1 Close
Close(Code)
Utilize o método Close para fechar a Tela. Este método gera o evento OnHide antes
de ser efetivamente executado. O parâmetro Code tem o valor de retorno para o
método DoModal, se a Tela em questão tiver sido chamada por este método.
Exemplo:
Sub BotaoFecha_Click()
' Quando BotaoFecha for clicado, fecha a janela
Screen.Close(0)
End Sub
4.3.1.2.2 FromPixelX
FromPixelX(XPixel)
Converte a coordenada X da Tela, indicada pelo parâmetro XPixel, de pixels para
Himetric. Este método é complementar ao método ToPixelX.
4.3.1.2.3 FromPixelY
FromPixelY(YPixel)
Converte a coordenada Y da Tela, indicada pelo parâmetro YPixel, de pixels para
Himetric. Este método é complementar ao método ToPixelY.
4.3.1.2.4 ToPixelX
ToPixelX(XHimetric)
Converte a coordenada X da Tela, indicada pelo parâmetro XHimetric, de Himetric
para pixels. Este método é complementar ao método FromPixelX.
4.3.1.2.5 ToPixelY
ToPixelY(YHimetric)
Converte a coordenada Y da Tela, indicada pelo parâmetro YHimetric, de Himetric
para pixels. Este método é complementar ao método FromPixelY.
4.3.1.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tela.
Visualização 119
NOTA: O El i ps e Power uti l i za pa ra defi ni çã o de coordena da s e es pes s ura o s i s tema
Hi metri c. Nes te s i s tema , ca da uni da de l ógi ca equi va l e a um mi l és i mo de
centímetro; ou s eja , ca da 1000 uni da des equi va l em a 1 centímetro. As s i m, es te é o
pa drã o a dota do na des cri çã o da s propri eda des do El i ps e Power, qua ndo a pl i cá vel .
4.3.1.3.1 BackgroundColor
Especifica a cor de preenchimento do fundo da Tela. Nos scripts, utilize o método
RGB do VBScript para montar a cor a ser associada a esta propriedade. O valor
padrão desta propriedade é cinza (RGB(192, 192, 192)).
4.3.1.3.2 Caption
A propriedade Caption define o título da Tela a ser mostrado na barra de título do
Viewer.
4.3.1.3.3 FillStyle
Esta propriedade especifica o estilo do preenchimento da Tela e dos objetos de
Tela. A tabela a seguir contém os valores válidos para a propriedade FillStyle.
Opções disponíveis para a propriedade FillStyle
OPÇÃO DESCRIÇÃO
0 - Solid O preenchi mento é s ól i do (pa drã o)
1 - Hollow Nã o há preenchi mento. Es te va l or nã o
es tá di s ponível pa ra o objeto Tel a
2 - Horizontal O preenchi mento é com l i s tra s
hori zonta i s
3 - Vertical O preenchi mento é com l i s tra s verti ca i s
4 - Downward O preenchi mento é com l i s tra s des cendo
da es querda pa ra a di rei ta em â ngul o de
45 gra us
5 - Upward O preenchi mento é com l i s tra s s ubi ndo
da es querda pa ra a di rei ta em â ngul o de
45 gra us
6 - Cross O preenchi mento é com l i s tra s
hori zonta i s e verti ca i s
7 - DiagonalCross O preenchi mento é com l i s tra s des cendo
e s ubi ndo da es querda pa ra a di rei ta em
â ngul o de 45 gra us
8 - Gradient O preenchi mento é em degra dê
uti l i za ndo ta nto ForegroundColor qua nto
BackgroundColor. O efei to é defi ni do pel a
propri eda de GradientStyle
9 - SemiTransparent Dei xa o objeto tra ns l úci do. Es te va l or
nã o es tá di s ponível pa ra o objeto Tel a
120 Visualização
OPÇÃO DESCRIÇÃO
10 - MouseArea O preenchi mento é va zi o, ma s o objeto
conti nua s ens ível a os eventos (pa drã o).
Es te va l or nã o es tá di s ponível pa ra o
objeto Tel a
11 - Background Preenche o objeto com a cor de fundo
12 - Picture Preenche o objeto com a fi gura
s el eci ona da na propri eda de PictureFile.
Es te va l or s ó es tá di s ponível pa ra o
objeto Tel a
4.3.1.3.4 ForegroundColor
Especifica a cor do preenchimento da frente da Tela. Nos scripts, utilize o
método RGB do VBScript para montar a cor a ser associada a esta propriedade. O
valor padrão para esta propriedade é preto (RGB(0, 0, 0)). Aplicações anteriores à
introdução desta propriedade têm ambas as propriedades ForegroundColor e
BackgroundColor configuradas com a cor antes armazenada na propriedade
BackgroundColor, e o estilo de preenchimento é configurado como 11 - Background,
que pinta toda a Tela com a cor de fundo (comportamento antigo, anterior à
criação dos estilos). Exemplo:
Sub Tela1_Click()
' Troca a cor de fundo da Tela para azul
ForegroundColor = RGB(0, 0, 255)
End Sub
4.3.1.3.5 GradientStyle
Esta propriedade especifica o estilo de preenchimento degradê da Tela. Esta
propriedade só é utilizada quando o valor da propriedade FillStyle estiver
configurado para 8 (Gradient). Os degradês consideram a mudança da cor partindo
de ForegroundColor e indo para BackgroundColor.
Opções disponíveis para GradientStyle
OPÇÃO DESCRIÇÃO
0 - LeftToRight Degra dê verti ca l da es querda pa ra a
di rei ta
1 - RightToLeft Degra dê verti ca l da di rei ta pa ra a
es querda
2 - VerFromCenter Degra dê verti ca l do centro pa ra a s
borda s
3 - VerToCenter Degra dê verti ca l da s borda s pa ra o
centro
4 - BottonUp Degra dê hori zonta l de ba i xo pa ra ci ma
5 - TopDown Degra dê hori zonta l de ci ma pa ra ba i xo
Visualização 121
OPÇÃO DESCRIÇÃO
6 - HorzFromCenter Degra dê do centro pa ra a s borda s
7 - HorzToCenter Degra dê da s borda s pa ra o centro
8 - DiagUpRight Degra dê di a gona l pa ra ci ma com a cor de
frente na di rei ta (pa drã o)
9 - DiagUpLeft Degra dê di a gona l pa ra ci ma com a cor de
frente na es querda
10 - DiagUpFromCenter Degra dê di a gona l pa ra ci ma do centro
pa ra a s borda s
11 - DiagUpToCenter Degra dê di a gona l pa ra ci ma da s borda s
pa ra o centro
12 - DiagDownLeft Degra dê di a gona l pa ra ba i xo com cor de
frente na es querda
13 - DiagDownRight Degra dê di a gona l pa ra ba i xo com cor de
frente na di rei ta
14 - DiagDownFromCenter Degra dê di a gona l pa ra ba i xo do centro
pa ra a s borda s
15 - DiagDownToCenter Degra dê di a gona l pa ra ba i xo da s borda s
pa ra o centro
16 - SpotSouthEast Degra dê com cor de frente pa rti ndo do
ca nto i nferi or di rei to
17 - SpotSouthWest Degra dê com cor de frente pa rti ndo do
ca nto i nferi or es querdo
18 - SpotNorthWest Degra dê com cor de frente pa rti ndo do
ca nto s uperi or es querdo
19 - SpotNorthEast Degra dê com cor de frente pa rti ndo do
ca nto s uperi or di rei to
20 - SpotFromCenter Degra dê com cor de fundo do centro pa ra
a s borda s
21 - SpotToCenter Degra dê com cor de fundo da s borda s
pa ra o centro
4.3.1.3.6 Layer
Esta propriedade define em quais camadas o objeto deve aparecer. O valor
representa uma máscara de 32 bits, um bit para cada camada. Portanto, podem ser
definidas até 32 camadas individuais. Assim, objetos podem ser agrupados
logicamente e mostrados ou escondidos apenas com a modificação da máscara da
propriedade Layer.
122 Visualização
Opções disponíveis na Lista de Propriedades
4.3.1.3.7 PictureFile
Contém o nome do arquivo da figura que é utilizada como fundo da Tela. Pode
ser qualquer formato já suportado no Elipse Power pelo objeto DrawPicture (*.bmp,
*.gif, *.jpg, *.cur, *.ico, *.emf, *.wmf, *.png e *.tif). O valor padrão desta propriedade
é uma String em branco. Esta propriedade só é válida se a propriedade FillStyle
estiver selecionada como 12 - Picture.
4.3.1.3.8 PicturePosition
Indica a posição da figura selecionada na propriedade PictureFile na Tela. Esta
propriedade só é válida se a propriedade FillStyle estiver selecionada como 12 -
Picture. As opções válidas estão descritas na tabela a seguir.
Opções disponíveis para PicturePosition
OPÇÃO DESCRIÇÃO
0 - Center Fi gura no ta ma nho ori gi na l , centra l i za da
na Tel a
Visualização 123
OPÇÃO DESCRIÇÃO
1 - Tile Fi gura no ta ma nho ori gi na l , repeti da
ta nta s vezes qua nta s forem neces s á ri a s
pa ra preencher a Tel a
2 - Stretch Fi gura redi mens i ona da pa ra preencher a
Tel a
3 - TopLeft Fi gura no ta ma nho ori gi na l , no ca nto
es querdo s uperi or da Tel a
4 - BottomLeft Fi gura no ta ma nho ori gi na l , no ca nto
es querdo i nferi or da Tel a
5 - BottomRight Fi gura no ta ma nho ori gi na l , no ca nto
di rei to i nferi or da Tel a
6 - TopRight Fi gura no ta ma nho ori gi na l , no ca nto
di rei to s uperi or da Tel a
4.3.1.3.9 RenderQuality
Controla a qualidade de desenho de uma Tela. Os valores possíveis para esta
propriedade são os seguintes:
0 - rqDefault: A qualidade de desenho da Tela utiliza o valor definido na
propriedade RenderQuality do Viewer. Este é o valor padrão desta
propriedade, mesmo em aplicações criadas em versões anteriores à 4.0
1 - rqNormal: Força o modo de qualidade normal (GDI) para o desenho da
Tela
2 - rqHighQuality: Força o modo de alta qualidade (GDI+) para o desenho da
Tela
A figura a seguir mostra o menu contextual de uma Tela em tempo de execução, com
as respectivas opções de configuração desta propriedade.
124 Visualização
Menu contextual da Tela em tempo de execução
Visualização 125
4.3.2.1.1 Click
Click()
Ocorre quando o botão esquerdo do mouse é pressionado sobre o objeto. Este
evento não ocorre se o objeto não estiver visível ou se sua propriedade Enabled
estiver configurada para Falso. A visibilidade do objeto depende de três fatores:
propriedade Visible igual a Verdadeiro, objeto pai visível e propriedade Layer do
objeto presente na camada da Tela.
4.3.2.1.2 DbClick
DbClick()
Ocorre quando há um duplo-clique, ou seja, o botão esquerdo do mouse é
pressionado rapidamente duas vezes sobre um objeto. Este evento não ocorre se o
objeto não estiver visível ou se sua propriedade Enabled estiver configurada para
Falso. A visibilidade do objeto depende de três fatores: propriedade Visible igual a
Verdadeiro, objeto pai visível e propriedade Layer do objeto presente na camada da
Tela.
4.3.2.1.3 KeyDown
KeyDown(KeyCode, Shift)
Ocorre no momento em que uma tecla é pressionada e o objeto está com o foco do
teclado. Note que este evento não é gerado se o objeto não estiver habilitado
(propriedade Enabled igual a Falso) ou este objeto não possuir o foco do teclado.
Variáveis do evento KeyDown
NOME DESCRIÇÃO
KeyCode Número i ntei ro que i denti fi ca o ca ra ctere
ASCII da tecl a que foi pres s i ona da .
Shift Mos tra a tecl a pres s i ona da junta mente
com o botã o do mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
4.3.2.1.4 KeyUp
KeyUp(KeyCode, Shift)
Ocorre no momento em que uma tecla é solta e o objeto está com o foco do teclado.
126 Visualização
Note que este evento não é gerado se o objeto não estiver habilitado (propriedade
Enabled igual a Falso) ou este objeto não possuir o foco do teclado.
Variáveis do evento KeyUp
NOME DESCRIÇÃO
KeyCode Número i ntei ro que i denti fi ca o ca ra ctere
ASCII da tecl a que foi pres s i ona da .
Shift Mos tra a tecl a pres s i ona da junta mente
com o botã o do mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
4.3.2.1.5 MouseDown
MouseDown(Button, ShiftState, MouseX, MouseY)
Ocorre quando se pressiona qualquer botão do mouse sobre o objeto.
Variáveis de evento MouseDown
NOME DESCRIÇÃO
Button Mos tra o botã o do mous e pres s i ona do:
1: O botã o do mous e pres s i ona do é o
es querdo
2: O botã o do mous e pres s i ona do é o
di rei to
ShiftState Mos tra a tecl a pres s i ona da junta mente
com o botã o do mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
MouseX Mos tra a coordena da X onde o botã o do
mous e foi cl i ca do na Tel a .
MouseY Mos tra a coordena da Y onde o botã o do
mous e foi cl i ca do na Tel a .
4.3.2.1.6 MouseUp
MouseUp(Button, ShiftState, MouseX, MouseY)
Ocorre quando se solta qualquer botão do mouse previamente clicado sobre o
objeto. Utilize o evento MouseUp para especificar ações que são disparadas
somente quando o botão do mouse for solto.
Visualização 127
Variáveis do evento MouseUp
NOME DESCRIÇÃO
Button Mos tra o botã o do mous e pres s i ona do:
1: O botã o do mous e pres s i ona do é o
es querdo
2: O botã o do mous e pres s i ona do é o
di rei to
ShiftState Mos tra a tecl a pres s i ona da junta mente
com o botã o do mous e:
4: Tecl a SHIFT
8: Tecl a CTRL
12: Tecl a s CTRL + SHIFT
MouseX Mos tra a coordena da X onde o botã o do
mous e foi cl i ca do na Tel a .
MouseY Mos tra a coordena da Y onde o botã o do
mous e foi cl i ca do na Tel a .
4.3.2.2.1 BringToFront
BringToFront()
Posiciona o objeto à frente de todos os outros objetos da Tela.
4.3.2.2.2 SendToBack
SendToBack()
Posiciona o objeto atrás de todos os outros objetos da Tela.
4.3.2.2.3 SetFocus
SetFocus()
Utilize o método SetFocus para mover o foco do ponteiro do mouse ou do teclado
para um objeto determinado.
128 Visualização
NOTA 1: O El i ps e Power uti l i za pa ra defi ni çã o de coordena da s e es pes s ura o
s i s tema Hi metri c. Nes te s i s tema , ca da uni da de l ógi ca equi va l e a um mi l és i mo de
centímetro; ou s eja , ca da 1000 uni da des equi va l em a 1 centímetro. As s i m, es te é o
pa drã o a dota do na des cri çã o da s propri eda des do El i ps e Power, qua ndo a pl i cá vel .
4.3.2.3.1 Angle
A propriedade Angle define o ângulo de rotação em graus, no sentido anti-
horário, que o objeto deve ser rotacionado. Isto também se aplica aos filhos que
este objeto tenha, respeitando as limitações de rotação de cada objeto filho. O
objeto rotaciona de acordo com o seu centro, que pode ser editado durante a
operação de rotação. O valor padrão desta propriedade é 0 (zero, sem rotação).
4.3.2.3.2 BackgroundColor
4.3.2.3.3 BackgroundStyle
Esta propriedade especifica o modo do preenchimento do fundo do objeto. Esta
propriedade habilita a utilização das propriedades VerticalPercentFill e
HorizontalPercentFill com valores diferentes de 100 e também da propriedade
FillStyle configurada entre os valores 2 (dois) e 8 (oito). Isto permite que a área
restante utilize a cor de fundo configurada em BackgroundColor para
preenchimento. A tabela a seguir contém os valores válidos para a propriedade
BackgroundStyle.
Opções disponíveis para BackgroundStyle
OPÇÃO DESCRIÇÃO
0 - Transparente Nenhum fundo des te objeto é
des enha do
1 - Opaco Ca s o vi s ível , o fundo é des enha do
Visualização 129
4.3.2.3.4 BorderColor
4.3.2.3.5 BorderStyle
A propriedade BorderStyle determina o estilo de borda que é aplicada ao objeto.
As opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para BorderStyle
OPÇÃO DESCRIÇÃO
0 - Normal Apl i ca uma borda s ól i da no objeto
(pa drã o)
1 - Dash Apl i ca uma borda com l i nha tra ceja da no
objeto
2 - Dot Apl i ca uma borda ponti l ha da no objeto
3 - Dashdot Apl i ca uma borda com tra ço-ponto no
objeto
4 - Dashdotdot Apl i ca uma borda com tra ço-ponto-ponto
no objeto
5 - Null O objeto nã o tem uma borda
4.3.2.3.6 BorderWidth
Define a espessura, em unidades Himetric, da linha ou da borda do objeto. Só é
utilizada se a propriedade BorderStyle não estiver configurada para o valor 5
(Null). O valor padrão desta propriedade é 0 (zero). Esta é uma exceção no sistema
de medidas do Elipse Power, pois quando seu valor é 0 (zero), a espessura da linha
ou da borda não é definida em unidades Himetric, mas sim em pixels. A
propriedade BorderWidth com valor igual a 0 (zero) indica a espessura de um
pixel.
4.3.2.3.7 Effect3D
Determina a aplicação de um efeito 3D no objeto selecionado. As opções
disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para Effect3D
OPÇÃO DESCRIÇÃO
0 - No3D Tra ns pa rente (pa drã o)
1 - Raised Apl i ca um efei to 3D em a l to rel evo
130 Visualização
OPÇÃO DESCRIÇÃO
2 - Sunken Apl i ca um efei to 3D em ba i xo rel evo
4.3.2.3.8 Effect3D_X
Especifica a dimensão do efeito 3D no eixo horizontal do objeto (eixo X). O valor
padrão desta propriedade é 30.
4.3.2.3.9 Effect3D_Y
Especifica a dimensão do efeito 3D no eixo vertical do objeto (eixo Y). O valor
padrão desta propriedade é 30.
4.3.2.3.10 Effect3DColorBase
Determina a cor da base do efeito 3D no objeto. O valor padrão desta
propriedade é preto (RGB(0, 0, 0)).
4.3.2.3.11 Effect3DColorTop
4.3.2.3.12 Enabled
Habilita ou desabilita o objeto, isto é, o foco e a resposta aos eventos gerados
pelo usuário. Se a propriedade estiver configurada para Verdadeiro, o objeto pode
receber o foco, responder a eventos gerados pelo usuário e está acessível através
de scripts (padrão). Caso contrário, o usuário não pode interagir com o objeto
usando o ponteiro do mouse, pressionando teclas ou teclas de atalho e o objeto
aparece esmaecido. Além disto, se o objeto exibir um bitmap, este bitmap
permanece esmaecido sempre que este objeto estiver desabilitado.
As propriedades Enabled e Locked (presente nos objetos Caixa de Seleção, Botão de
Opção, Lista de Seleção, Botão de Comando, Lista, Botão Liga-Desliga e Editor de
Texto) são interligadas. Quando as propriedades Enabled e Locked estiverem
ambas configuradas em Verdadeiro, o objeto pode receber foco e aparecer
normalmente na Tela, e os dados podem ser copiados mas não editados. Quando
Enabled for igual a Verdadeiro, mas Locked for igual a Falso, os dados podem ser
não só copiados mas também editados. No entanto, quando Enabled for igual a
Falso, o objeto não recebe foco e permanece esmaecido na Tela, independentemente
do status de Locked. Além disto, os dados não podem ser copiados nem tampouco
editados.
É possível combinar as configurações das propriedades Enabled e TabStop para
impedir que o usuário selecione um Botão de Comando com a tecla TAB, embora
ainda seja permitido ao usuário clicar neste botão. Definir a propriedade TabStop
Visualização 131
como Falso significa que o Botão de Comando não aparece na ordem de tabulação.
Entretanto, se Enabled for igual a Verdadeiro, o usuário ainda pode clicar no Botão
de Comando, desde que a propriedade TakeFocusOnClick esteja definida como
Verdadeiro.
4.3.2.3.13 FillStyle
Esta propriedade especifica o estilo do preenchimento do objeto. A tabela a
seguir contém os valores válidos para a propriedade FillStyle.
Opções disponíveis para FillStyle
OPÇÃO DESCRIÇÃO
0 - Solid O preenchi mento é s ól i do (pa drã o).
1 - Hollow Nã o há preenchi mento.
2 - Horizontal O preenchi mento é com l i s tra s
hori zonta i s .
3 - Vertical O preenchi mento é com l i s tra s verti ca i s .
4 - Downward O preenchi mento é com l i s tra s des cendo
da es querda pa ra a di rei ta em â ngul o de
45 gra us .
5 - Upward O preenchi mento é com l i s tra s s ubi ndo
da es querda pa ra a di rei ta em â ngul o de
45 gra us .
6 - Cross O preenchi mento é com l i s tra s
hori zonta i s e verti ca i s .
7 - DiagonalCross O preenchi mento é com l i s tra s des cendo
e s ubi ndo da es querda pa ra a di rei ta em
â ngul o de 45 gra us .
8 - Gradient O preenchi mento é em degra dê
uti l i za ndo ta nto o va l or da propri eda de
ForegroundColor qua nto o va l or da
propri eda de BackgroundColor. O efei to é
defi ni do pel a propri eda de GradientStyle.
9 - SemiTransparent Dei xa o objeto tra ns l úci do.
10 - MouseArea Nã o há preenchi mento, ma s o objeto
conti nua s ens ível a os eventos .
4.3.2.3.14 ForegroundColor
132 Visualização
azul (RGB(0, 0, 255)), exceto para os objetos Display e SetPoint, cujo valor padrão
para esta propriedade é branco (RGB(255, 255, 255)).
4.3.2.3.15 Frame
Retorna o Quadro pai do objeto. Esta propriedade é acessível apenas em tempo
de execução.
4.3.2.3.16 GradientStyle
Esta propriedade especifica o estilo de preenchimento degradê do objeto. Esta
propriedade só é utilizada quando o valor da propriedade FillStyle estiver
configurado para 8 (oito, Gradient). Os degradês consideram a mudança partindo
da cor configurada na propriedade ForegroundColor e indo para a cor configurada
na propriedade BackgroundColor.
Opções disponíveis para GradientStyle
OPÇÃO DESCRIÇÃO
0 - LeftToRight Degra dê verti ca l da es querda pa ra a
di rei ta
1 - RightToLeft Degra dê verti ca l da di rei ta pa ra a
es querda
2 - VerFromCenter Degra dê verti ca l do centro pa ra a s
borda s
3 - VerToCenter Degra dê verti ca l da s borda s pa ra o
centro
4 - BottomUp Degra dê hori zonta l de ba i xo pa ra ci ma
5 - TopDown Degra dê hori zonta l de ci ma pa ra ba i xo
6 - HorzFromCenter Degra dê do centro pa ra a s borda s
7 - HorzToCenter Degra dê da s borda s pa ra o centro
8 - DiagUpRight Degra dê di a gona l pa ra ci ma com a cor de
frente na di rei ta (pa drã o)
9 - DiagUpLeft Degra dê di a gona l pa ra ci ma com a cor de
frente na es querda
10 - DiagUpFromCenter Degra dê di a gona l pa ra ci ma do centro
pa ra a s borda s
11 - DiagUpToCenter Degra dê di a gona l pa ra ci ma da s borda s
pa ra o centro
12 - DiagDownLeft Degra dê di a gona l pa ra ba i xo com a cor
de frente na es querda
13 - DiagDownRight Degra dê di a gona l pa ra ba i xo com a cor
de frente na di rei ta
14 - DiagDownFromCenter Degra dê di a gona l pa ra ba i xo do centro
pa ra a s borda s
15 - DiagDownToCenter Degra dê di a gona l pa ra ba i xo da s borda s
pa ra o centro
16 - SpotSouthEast Degra dê com a cor de frente pa rti ndo do
ca nto i nferi or di rei to
Visualização 133
OPÇÃO DESCRIÇÃO
17 - SpotSouthWest Degra dê com a cor de frente pa rti ndo do
ca nto i nferi or es querdo
18 - SpotNorthWest Degra dê com a cor de frente pa rti ndo do
ca nto s uperi or es querdo
19 - SpotNorthEast Degra dê com a cor de frente pa rti ndo do
ca nto s uperi or di rei to
20 - SpotFromCenter Degra dê com a cor de fundo do centro
pa ra a s borda s
21 - SpotToCenter Degra dê com a cor de fundo da s borda s
pa ra o centro
IMPORTANTE: Um gra nde número de objetos s endo mos tra dos com degra dê,
s i mul ta nea mente, a ca rreta m uma perda de performa nce na a tua l i za çã o da Tel a . O
us o de fi gura s no l uga r pode res ol ver o probl ema .
4.3.2.3.17 HasFocus
Esta propriedade determina que o objeto selecionado está com o foco. Esta
propriedade é acessível apenas em tempo de execução.
4.3.2.3.18 Height
Determina a altura do objeto.
4.3.2.3.19 HorizontalFillStyle
Define como é o preenchimento horizontal do objeto. Esta propriedade trabalha
em conjunto com a propriedade HorizontalPercentFill, que informa qual
porcentagem do objeto deve ser preenchida. Estas duas propriedades permitem
uma simulação de um preenchimento de nível em um objeto, como ocorre em um
nível de um tanque, por exemplo.
Opções disponíveis para HorizontalFillStyle
OPÇÃO DESCRIÇÃO
0 - FillLeftToRight A porcenta gem de preenchi mento é da
es querda pa ra a di rei ta (pa drã o)
1 - FillRightToLeft A porcenta gem de preenchi mento é da
di rei ta pa ra a es querda
2 - FillCenterToEdgesH A porcenta gem de preenchi mento é do
centro pa ra a s borda s
4.3.2.3.20 HorizontalPercentFill
Utilize a propriedade HorizontalPercentFill para especificar qual a porcentagem
da área horizontal do objeto deve ser preenchida. Os valores aceitos por esta
134 Visualização
propriedade variam de 0 (zero) a 100. Esta propriedade trabalha em conjunto com
a propriedade HorizontalFillStyle, que informa como este preenchimento ocorre. O
valor padrão desta propriedade é 100.
4.3.2.3.21 Layer
Esta propriedade define em quais camadas o objeto deve aparecer. O valor
representa uma máscara de 32 bits, um bit para cada camada. Portanto, podem ser
definidas até 32 camadas individuais. Assim, objetos podem ser agrupados
logicamente e mostrados ou escondidos apenas com a modificação da máscara da
propriedade Layer.
4.3.2.3.22 MouseOver
A propriedade MouseOver informa se o ponteiro do mouse encontra-se em cima
da Tela. Caso afirmativo, a propriedade MouseOver é habilitada. Do contrário, é
desabilitada. Esta propriedade é apenas de leitura, e é acessível apenas em tempo
de execução. O valor padrão desta propriedade é Falso.
4.3.2.3.23 MouseOverChild
A propriedade MouseOverChild informa se o ponteiro do mouse encontra-se em
cima de um dos objetos inseridos na Tela. Caso afirmativo, a propriedade
MouseOverChild é habilitada. Do contrário, é desabilitada. Esta propriedade é
apenas de leitura, e é acessível apenas em tempo de execução. O valor padrão
desta propriedade é Falso.
4.3.2.3.24 Screen
Retorna a Tela pai do objeto. Esta propriedade é acessível apenas em tempo de
execução.
4.3.2.3.25 Shadow
Indica a presença do efeito de sombra no objeto. Se configurada para Verdadeiro,
o objeto possui uma sombra, cujas coordenadas são estabelecidas pelas
propriedades ShadowX e ShadowY. Do contrário, o objeto não possui o efeito de
sombra. O valor padrão desta propriedade é Falso.
4.3.2.3.26 ShadowColor
Visualização 135
4.3.2.3.27 ShadowX
4.3.2.3.28 ShadowY
4.3.2.3.29 TabStop
Esta propriedade determina a utilização da tecla TAB na aplicação. Se esta
propriedade estiver configurada em Verdadeiro, é possível utilizar a tecla TAB. Caso
contrário, esta tecla não pode ser utilizada.
4.3.2.3.30 Tip
A propriedade Tip mostra um texto popup quando o ponteiro do mouse estiver
por um breve momento sobre o objeto em execução.
4.3.2.3.31 VerticalFillStyle
Define como é o preenchimento vertical do objeto. Esta propriedade trabalha em
conjunto com a propriedade VerticalPercentFill, que informa qual porcentagem do
objeto deve ser preenchida. Estas duas propriedades permitem uma simulação de
um preenchimento de nível em um objeto.
Opções disponíveis para VerticalFillStyle
OPÇÃO DESCRIÇÃO
0 - FillBottomToTop A porcenta gem de preenchi mento é de
ba i xo pa ra ci ma
1 - FillTopToBottom A porcenta gem de preenchi mento é de
ci ma pa ra ba i xo
2 - FillCenterToEdgesV A porcenta gem de preenchi mento é do
centro pa ra a s borda s
4.3.2.3.32 VerticalPercentFill
4.3.2.3.33 Visible
Esta propriedade define a visibilidade do objeto. Se configurada como
Verdadeiro, o objeto permanece visível, desde que também sejam obedecidos os
seguintes fatores: o objeto pai deste objeto também deve estar visível e a
propriedade Layer deste objeto também deve estar presente na camada da Tela.
4.3.2.3.34 Width
Determina a largura do objeto, em unidades Himetric.
4.3.2.3.35 X
A propriedade X define a coordenada horizontal esquerda, em unidades Himetric,
do objeto.
4.3.2.3.36 Y
Esta propriedade define a coordenada vertical superior, em unidades Himetric, do
objeto.
4.3.2.4 Grupo
Esta seção contém informações sobre propriedades do Grupo de objetos. Este
objeto não possui eventos nem métodos associados.
4.3.2.4.1 Propriedades
4.3.2.4.1.1 EnableOverrideLineColor
4.3.2.4.1.2 OverrideFillColor
Visualização 137
preenchimento dos objetos contíguos no Grupo, ao invés da cor original. Nos
scripts, utilize o método RGB do VBScript para montar a cor a ser associada a esta
propriedade. O valor padrão desta propriedade é vermelho (RGB(255, 0, 0)).
4.3.2.4.1.3 OverrideFillMode
4.3.2.4.1.4 OverrideLineColor
4.3.2.5.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Retângulo
Arredondado.
4.3.2.5.1.1 RoundAspectX
4.3.2.5.1.2 RoundAspectY
4.3.2.6.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Arco de Elipse.
4.3.2.6.1.1 ArcBeginAngle
4.3.2.6.1.2 ArcEndAngle
Visualização 139
4.3.2.6.1.3 ArcStyle
OPÇÃO DESCRIÇÃO
0 - arc O es ti l o do des enho é um a rco
1 - chord O es ti l o do des enho é uma corda , uni ndo
o ponto i ni ci a l e fi na l
2 - pie O es ti l o do des enho é uma pi zza
(pa drã o)
Exemplo:
Sub CommandButton9_Click()
Screen.Item("Arco1").ArcStyle = 1
End Sub
4.3.2.7 Figura
Esta seção contém informações sobre propriedades do objeto Figura. Este objeto
não possui eventos nem métodos associados.
4.3.2.7.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Figura.
4.3.2.7.1.1 BackgroundColor
4.3.2.7.1.2 BackgroundStyle
140 Visualização
Opções disponíveis para BackgroundStyle
OPÇÃO DESCRIÇÃO
0 - Transparente Nenhum fundo des te objeto é
des enha do
1 - Opaco Ca s o vi s ível , o fundo é des enha do
4.3.2.7.1.3 Convert
4.3.2.7.1.4 EnableOverrideLineColor
4.3.2.7.1.5 Filename
Visualização 141
4.3.2.7.1.6 HorizontalFillStyle
4.3.2.7.1.7 HorizontalPercentFill
4.3.2.7.1.8 OverrideFillColor
NOTA: Es ta propri eda de s ó tem efei to qua ndo o objeto Fi gura es tá tra ba l ha ndo com
a rqui vos Metafile (WMF ou EMF).
142 Visualização
4.3.2.7.1.9 OverrideFillMode
Exemplo:
Sub DrawPicture1_Click()
' Ao clicar no objeto seta o modo
' Override para sólido e troca a cor de
' preenchimento da imagem para azul
OverrideFillMode = 2
OverrideFillColor = RGB(0, 0, 255)
End Sub
NOTA: Es ta propri eda de s ó tem efei to qua ndo o objeto Fi gura es tá tra ba l ha ndo com
a rqui vos Metafile (WMF ou EMF).
4.3.2.7.1.10 OverrideLineColor
Visualização 143
NOTA: Es ta propri eda de s ó tem efei to qua ndo o objeto Fi gura es tá tra ba l ha ndo com
a rqui vos Metafile (WMF ou EMF).
4.3.2.7.1.11 Shadow
4.3.2.7.1.12 ShadowColor
NOTA: Es ta propri eda de s ó tem efei to qua ndo o objeto Fi gura es tá tra ba l ha ndo com
a rqui vos Metafile (WMF ou EMF).
4.3.2.7.1.13 ShadowX
4.3.2.7.1.14 ShadowY
NOTA: Es ta propri eda de s ó tem efei to qua ndo o objeto Fi gura es tá tra ba l ha ndo com
a rqui vos Metafile (WMF ou EMF).
144 Visualização
4.3.2.7.1.15 TransparentColor
4.3.2.7.1.16 TransparentMode
Exemplo:
Sub DrawPicture1_Click()
' Deixa a cor da imagem azul transparente
' quando se clica no objeto Figura
TransparentMode = 1 ' ByColor
TransparentColor = RGB(0, 0, 255)
End Sub
4.3.2.7.1.17 TransparentPercent
Visualização 145
TransparentPercent = 50 ' 50% translúcido
End Sub
4.3.2.7.1.18 VerticalFillStyle
4.3.2.7.1.19 VerticalPercentFill
4.3.2.8.1 Eventos
Esta seção contém informações sobre os eventos dos objetos Texto, Display e
SetPoint.
4.3.2.8.1.1 Validate
Validate(Cancel, NewValue)
Ocorre após os testes de limites do SetPoint (ver propriedades MinLimit, MaxLimit,
EnableLimits) e antes do valor do SetPoint ser enviado para o Tag. A finalidade
deste evento é permitir que o usuário cancele o envio do valor do SetPoint para o
Tag.
O parâmetro Cancel é um Booleano que indica se a operação de atribuição do valor
do SetPoint ao Tag deve ser cancelada (Cancel igual a Verdadeiro). O padrão é
146 Visualização
Falso, ou seja, o valor do SetPoint é enviado ao Tag. NewValue é o valor que está
sendo avaliado. O valor antigo pode ser acessado pela propriedade Value do
SetPoint. Exemplo:
Sub Texto1_Validate(Cancel, NewValue)
' Mostra um MessageBox que pergunta ao usuário
' se ele deseja usar o novo valor digitado no SetPoint
message = "Valor atual: " & value & vbnewline & _
"Valor novo: " & NewValue & vbnewline & vbnewline & _
"Aceita o novo valor?"
If MsgBox (message, vbQuestion + vbYesNo, _
Cancel = True
End If
End Sub
4.3.2.8.2 Propriedades
Esta seção contém informações sobre as propriedades dos objetos Texto, Display e
SetPoint.
4.3.2.8.2.1 EnableLimits
4.3.2.8.2.2 Format
Visualização 147
4.3.2.8.2.3 IsSetPoint
4.3.2.8.2.4 KeepFormatWhenEditing
Permite que o valor do objeto seja editado com ou sem formatação. As opções
disponíveis são as seguintes:
0 - kfNever: O valor é sempre editado sem formatação (padrão)
1 - kfAutomatic: Permite que o valor seja editado no valor formatado, caso o
Elipse Power detecte que o texto formatado é passível de ser interpretado
como um valor
4.3.2.8.2.5 MaxLimit
4.3.2.8.2.6 MinLimit
4.3.2.8.2.7 Multiline
148 Visualização
4.3.2.8.2.8 SetPointDataType
Quando o texto digitado é enviado pelo SetPoint, este primeiro tenta converter o
valor para o tipo configurado (Word, String, Double, etc.). Se a conversão não for
possível, ou seja, o valor digitado é inválido para o tipo escolhido, nenhum valor é
enviado (por exemplo, se o usuário digitar -1 e o tipo for Byte). Já quando o valor
da propriedade for igual a 0 - stCurrentType, o tipo de dado enviado pelo SetPoint é
extraído do valor anterior presente no objeto. Caso o valor anterior seja Empty ou
Null, nenhuma conversão é realizada e o valor digitado é enviado como texto.
Exemplo:
Sub Combobox1_Change()
Screen.Item("Texto1").SetPointDataType = CInt(Left(Value, 2))
End Sub
4.3.2.8.2.9 StretchText
4.3.2.8.2.10 TextAlignment
4.3.2.8.2.11 TextColor
Esta propriedade especifica a cor da fonte do texto a ser exibido. Nos scripts,
utilize o método RGB do VBScript para montar a cor a ser associada a esta
propriedade. O valor padrão desta propriedade é preto (RGB(0, 0, 0)).
4.3.2.8.2.12 TextFont
Define as informações da fonte a ser utilizado pelo objeto. Esta propriedade não
pode ser utilizada em Associações e possui as sub-propriedades descritas na
tabela a seguir, modificáveis via script.
Sub-propriedades de TextFont
NOME TIPO DESCRIÇÃO
Name Stri ng O nome da fonte.
Size Ponto Fl utua nte O ta ma nho, em pontos , da
fonte.
Bold Bool ea no Indi ca s e o texto es tá em
negri to.
Italic Bool ea no Indi ca s e o texto es tá em
i tá l i co.
Underline Bool ea no Indi ca s e o texto es tá
s ubl i nha do.
Strikethrough Bool ea no Indi ca s e o texto es tá
ta cha do.
Weight Intei ro Indi ca a va ri a çã o do efei to
de negri to (a s ub-
propri eda de Bold) na fonte.
Os va l ores pa ra es ta s ub-
propri eda de podem va ri a r
entre 0 (zero, nã o i nterfere
no efei to de negri to) e
1000.
Charset Intei ro O conjunto de ca ra cteres
da fonte. Veja a ta bel a de
conjuntos de ca ra cteres a
s egui r, com os va l ores
di s ponívei s pa ra es ta s ub-
propri eda de.
150 Visualização
Valores disponíveis para a sub-propriedade Charset
VALOR DESCRIÇÃO
0 ANSI (American National Standards Institute)
1 Pa drã o (mos tra o conjunto de ca ra cteres
di s ponível na fonte)
2 Símbol os
128 Ja ponês (Shi ft-JIS)
129 Corea no
134 Chi nês Si mpl i fi ca do (GBK)
136 Chi nês Tra di ci ona l (Bi g5)
161 Grego
162 Turco
177 Hebra i co
178 Ára be
186 Bá l ti co
204 Ci ríl i co
222 Ta i l a ndês
238 Centro-Europeu
255 OEM (Original Equipment Manufacturer)
4.3.2.8.2.13 Value
4.3.2.8.2.14 VertTextAlignment
Visualização 151
OPÇÃO DESCRIÇÃO
1 - MidAlignment Al i nha mento verti ca l do texto no centro
do objeto
2 - BottomAlignment Al i nha mento verti ca l do texto na ba s e do
objeto
4.3.2.8.2.15 WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a Verdadeiro.
4.3.2.9 Escala
Esta seção contém informações sobre propriedades do objeto Escala. Este objeto
não possui eventos nem métodos associados.
4.3.2.9.1 Propriedades
Esta seção contém informações sobre propriedades do objeto Escala.
4.3.2.9.1.1 BackgroundColor
4.3.2.9.1.2 BorderColor
Esta propriedade determina a cor da borda que é aplicada no objeto Escala. Com
esta propriedade, é possível aplicar a cor padrão ou personalizá-la através da sua
edição. O valor padrão desta propriedade é branco (RGB(255, 255, 255)). Exemplo:
Sub Escala1_Click()
BorderColor = RGB (255, 0, 0)
End Sub
4.3.2.9.1.3 BorderStyle
152 Visualização
Opções disponíveis para BorderStyle
OPÇÃO DESCRIÇÃO
0 - Normal Apl i ca uma borda s ól i da na gra de
verti ca l da es ca l a (pa drã o)
1 - Dash Apl i ca uma borda de l i nha tra ceja da na
es ca l a
2 - Dot Apl i ca uma borda ponti l ha da na es ca l a
3 - Dashdot Apl i ca uma borda de tra ço e ponto na
es ca l a
4 - Dashdotdot Apl i ca uma borda de tra ço, ponto e ponto
na es ca l a
5 - Null O objeto nã o tem borda
4.3.2.9.1.4 BorderWidth
4.3.2.9.1.5 ForegroundColor
4.3.2.9.1.6 Format
Visualização 153
TIPO DE DADOS DESCRIÇÃO
Booleano Va l ores Bool ea nos
Data/Hora Ca l endá ri o Gregori a no
4.3.2.9.1.7 GradientStyle
154 Visualização
OPÇÃO DESCRIÇÃO
19 - SpotNorthEast Degra dê com cor de frente pa rti ndo do
ca nto s uperi or di rei to
20 - SpotFromCenter Degra dê com cor de fundo do centro pa ra
a s borda s
21 - SpotToCenter Degra dê com cor de fundo da s borda s
pa ra o centro
IMPORTANTE: Um gra nde número de objetos s endo mos tra dos com degra dê
s i mul ta nea mente a ca rreta uma perda de performa nce na a tua l i za çã o da Tel a . O
us o de fi gura s no l uga r pode res ol ver o probl ema .
Exemplo:
Sub Botao1_Click()
' Objeto fica com degrade
FillStyle = 8 ' GradientFill
GradientStyle = 0 ' leftToRight
End Sub
4.3.2.9.1.8 LineColor
4.3.2.9.1.9 MaximumValue
Esta propriedade determina o valor máximo atingido pela Escala. O valor padrão
desta propriedade é 100. Exemplo:
Sub CommandButton_Click()
' Ao clicar no botão, abre um MessageBox indicando
' o valor máximo da propriedade da escala
MsgBox CSTr(Screen.Item("Escala1").MaximumValue)
End Sub
4.3.2.9.1.10 MinimumValue
Esta propriedade determina o valor mínimo requerido pela Escala. O valor padrão
desta propriedade é 0 (zero). Exemplo:
Sub CommandButton1_Click()
' Ao clicar no botão, abre um MessageBox indicando
' o valor da propriedade Minimum do Escala1
MsgBox _
CSTr(Application.GetObject("Dados.Escala1").MinimumValue)
End Sub
Visualização 155
4.3.2.9.1.11 MinorTicks
4.3.2.9.1.12 MinorTicksPercentSize
Esta propriedade determina o tamanho das marcas que subdividem cada medida
do objeto Escala. O valor padrão desta propriedade é 10.
4.3.2.9.1.13 ScaleAlignment
4.3.2.9.1.14 ShowText
4.3.2.9.1.15 StretchText
4.3.2.9.1.16 TextAlignment
156 Visualização
OPÇÃO DESCRIÇÃO
1 - centerAlignment O a l i nha mento do texto é centra l i za do
2 - rightAlignment O a l i nha mento do texto é à di rei ta
4.3.2.9.1.17 TextColor
4.3.2.9.1.18 TextFont
4.3.2.9.1.19 Ticks
4.3.2.9.1.20 TicksPercentSize
Determina o tamanho das linhas que dividem o objeto Escala. Conforme for o
valor especificado nesta propriedade, maior ou menor é o tamanho da linha da
divisória padrão da Escala. O valor padrão desta propriedade é 20.
4.3.2.10.1 Propriedades
4.3.2.10.1.1 Detents
Visualização 157
End Sub
4.3.2.10.1.2 EnableOverrideLineColor
4.3.2.10.1.3 EnableSlider
4.3.2.10.1.4 OverrideFillColor
4.3.2.10.1.5 OverrideFillMode
Exemplo:
Sub DrawGroup1_Click()
' Ao clicar no objeto seta o modo
' Override para sólido e troca a cor de
' preenchimento da imagem para azul
OverrideFillMode = 2
OverrideFillColor = RGB(0, 0, 255)
End Sub
4.3.2.10.1.6 OverrideLineColor
4.3.2.10.1.7 RangeMax
4.3.2.10.1.8 RangeMin
4.3.2.10.1.9 Value
Indica o valor inicial do movimento. Deve ser um valor entre os valores nas
propriedades RangeMax e RangeMin.
Visualização 159
4.3.2.11 Animação com Rotação
Esta seção contém informações sobre propriedades do objeto Animação com
Rotação. Este objeto não possui eventos nem métodos associados.
4.3.2.11.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Animação com
Rotação.
4.3.2.11.1.1 Detents
4.3.2.11.1.2 EnableOverrideLineColor
4.3.2.11.1.3 EnableSlider
4.3.2.11.1.4 OverrideFillColor
4.3.2.11.1.5 OverrideFillMode
160 Visualização
OPÇÃO DESCRIÇÃO
1 - WireFrame Os objetos nã o s ã o preenchi dos ,
des enha m s omente s ua s borda s .
2 - SolidFill O preenchi mento dos objetos conti dos
no grupo é s ól i do com a cor es peci fi ca da
na propri eda de OverrideFillColor.
3 - ByBrightness O preenchi mento dos objetos conti dos
no grupo é s ól i do com a cor es peci fi ca da
pel a propri eda de OverrideFillColor, porém
l eva em conta qua l era a i ntens i da de da
cor ori gi na l de preenchi mento de ca da
objeto.
4.3.2.11.1.6 OverrideLineColor
4.3.2.11.1.7 RangeMax
4.3.2.11.1.8 RangeMin
4.3.2.11.1.9 RotationAngle
4.3.2.11.1.10 RotationDirection
Visualização 161
4.3.2.11.1.11 Value
Indica o valor inicial do movimento. Deve ser um valor entre os valores nas
propriedades RangeMax e RangeMin.
4.3.2.12.1.1 BeforeDragOver
4.3.2.12.1.2 BeforeDropOrPaste
Visualização 163
NOME DESCRIÇÃO
Data Da dos s endo a rra s ta dos pa ra o objeto a l vo,
propri a mente di tos .
Action Indi ca o res ul ta do, ba s ea do na s
confi gura ções do tecl a do, de uma opera çã o
de a rra s ta r e s ol ta r pendente:
2 - fmActionPaste: Col a o objeto
s el eci ona do no objeto a l vo
3 - fmActionDragDrop: Indi ca que o
us uá ri o a rra s tou o objeto s el eci ona do
de s ua ori gem e s ol tou-o s obre o objeto
a l vo
X, Y Pos i çã o do pontei ro do mous e dentro do
objeto a l vo, em pontos . X é medi do a pa rti r
do l a do es querdo do objeto e Y é medi do a
pa rti r do topo.
DragState Indi ca a condi çã o do pontei ro do mous e
qua ndo é gera do o evento:
0 - fmDragStateEnter: O pontei ro do
mous e es tá dentro do a l ca nce do objeto
1 - fmDragStateLeave: O pontei ro do
mous e es tá fora do a l ca nce do objeto
2 - fmDragStateOver: O pontei ro do mous e
es tá em uma nova pos i çã o, ma s a i nda
es tá dentro do a l ca nce do objeto
Effect Indi ca a s a ções que o objeto a l vo s uporta ,
ou s eja , o efei to de a rra s ta r s obre o objeto
em ques tã o:
0 - fmDropEffectNone: Objeto a l vo nã o
a cei ta copi a r ou mover de a l guma ori gem
1 - fmDropEffectCopy: Objeto a l vo permi te
copi a r de a l guma ori gem pa ra s i
2 - fmDropEffectMove: Objeto a l vo permi te
mover de a l guma ori gem pa ra s i
3 - fmDropEffectCopyOrMove: Objeto a l vo
permi te copi a r ou mover de a l guma
ori gem pa ra s i
Shift Intei ro cuja s oma dos fa tores i ndi ca o
s ta tus da s tecl a s SHIFT, CTRL e ALT:
1: Tecl a SHIFT pres s i ona da
2: Tecl a CTRL pres s i ona da
4: Tecl a ALT pres s i ona da
Por exempl o, um va l or i gua l a 5 i ndi ca que
a s tecl a s SHIFT e ALT es ta va m
pres s i ona da s (1 + 4 = 5).
164 Visualização
4.3.2.12.1.3 Change
Change()
Ocorre quando o valor da propriedade Value do objeto é modificada. A seguir estão
alguns exemplos de ações que disparam o evento Change:
Clicar em uma Caixa de Seleção, em um Botão de Opção ou em um Botão
Incremento-Decremento
Clicar ou selecionar palavras em uma Lista de Seleção ou em um Editor de
Texto
Selecionar diferentes abas em uma caixa de diálogo
Mover a barra de rolagem em um objeto Barra de Rolagem
Clicar nas setas de um Botão Incremento-Decremento
Selecionar diferentes páginas em um objeto multi-páginas
4.3.2.12.1.4 KeyPress
KeyPress(KeyAscii)
Ocorre quando o objeto tem o foco de teclado e o usuário pressiona uma tecla que
corresponde a um caractere que pode ser mostrado em tela (uma tecla ANSI, de
código indicado na variável KeyAscii), ou seja, o evento ocorre quando alguma das
teclas a seguir são pressionadas:
Qualquer caractere do teclado que possa ser impresso
Tecla CTRL combinada com qualquer caractere do alfabeto padrão
Tecla CTRL combinada com qualquer caractere especial
Tecla BACKSPACE
Tecla ESC
Visualização 165
Enquanto o usuário pressiona uma tecla que produz um código ANSI, o objeto
recebe os eventos KeyDown e KeyPress repetidamente. Quando o usuário libera a
tecla, o evento KeyUp ocorre. Para monitorar o estado físico do teclado ou
manipular teclas não reconhecidas pelo evento KeyPress (como teclas de função,
navegação, etc.), utilize os eventos KeyDown e KeyUp.
4.3.2.12.1.5 OnError
NOME DESCRIÇÃO
Number Número i ntei ro i denti fi ca dor do erro
Description String com a des cri çã o do erro
SCode Intei ro com o códi go de erro do
s ubs i s tema OLE (nã o uti l i za do)
Source String com o objeto que ori gi nou o erro
HelpFile String com o nome e o ca mi nho do
a rqui vo de a juda
HelpContext Número de contexto do tópi co de a juda
referente a o erro (Intei ro)
CancelDisplay Bool ea no que i ndi ca s e o erro deve s er
mos tra do em uma ca i xa de mens a gem
4.3.2.12.2.1 BackColor
Determina a cor de fundo do objeto. Nos scripts, utilize o método RGB do VBScript
para montar a cor a ser associada a esta propriedade. O valor padrão desta
propriedade para os objetos Lista de Seleção, Lista e Editor de Texto é a cor branca
(RGB(255, 255, 255)), e para os demais objetos é a cor bege (RGB(236, 233, 216)).
166 Visualização
4.3.2.12.2.2 ForeColor
4.3.2.12.2.3 MouseIcon
4.3.2.12.2.4 MousePointer
Visualização 167
OPÇÃO DESCRIÇÃO
12 - fmMousePointerHelpNoDrop Símbol o de Not (círcul o com uma l i nha
di a gona l ) na pa rte s uperi or do objeto
s endo a rra s ta do (i ndi ca um des ti no de
s ol ta r i nvá l i do)
13 - fmMousePointerAppStarting Seta com uma a mpul heta
14 - fmMousePointerHelp Seta com um ponto de i nterroga çã o
15 - fmMousePointerSizeAll Di mens i ona todo o curs or (s eta s
a ponta ndo pa ra norte, s ul , l es te e oes te)
99 - fmMousePointerCustom Us a o ícone es peci fi ca do pel a
propri eda de MouseIcon
4.3.2.12.3.1 Propriedades
168 Visualização
objeto.
BackStyle
A propriedade BackStyle define o estilo do plano de fundo para os objetos. As
opções disponíveis para esta propriedade são as seguintes:
0 - fmBackStyleTransparent: Define o objeto como transparente, isto é,
nenhum fundo deste objeto é desenhado
1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é
desenhado (valor padrão)
Caption
Define o texto que é mostrado no objeto.
Font
A propriedade Font é utilizada para determinar a fonte do objeto Caixa de
Seleção. Esta propriedade não pode ser utilizada em Associações e contém as
mesmas sub-propriedades descritas na propriedade TextFont dos objetos Texto,
Display e SetPoint.
GroupName
A propriedade GroupName é utilizado para criar um grupo de objetos
mutuamente exclusivos.
NOTA: Es ta propri eda de nã o é uti l i za da no El i ps e Power e foi ma nti da por moti vos
de compa ti bi l i da de com a es peci fi ca çã o pa drã o dos objetos Mi cros oft Forms .
Locked
A propriedade Locked habilita ou desabilita a edição do objeto. Se esta
propriedade estiver configurada para Verdadeiro, a edição não é permitida. Caso
contrário, é possível editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padrão desta propriedade é Falso.
Picture
A propriedade Picture especifica a figura (bitmap) atribuída ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: através da Lista de
Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o
caminho e o nome do arquivo que contém a figura. Para remover a figura, clique no
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
Visualização 169
espaço do teclado) não remove a figura. Exemplo:
Sub CommandButton1_Click()
Screen.Item("CheckBox1").Picture = LoadPicture("C:\aba.gif")
End Sub
PicturePosition
A propriedade PicturePosition especifica a posição da figura atribuída ao objeto
em relação a sua legenda. As opções disponíveis para esta propriedades estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade PicturePosition
OPÇÃO DESCRIÇÃO
0 - fmPicturePositionLeftTop A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
s uperi or da fi gura .
1 - fmPicturePositionLeftCenter A fi gura a pa rece à es querda da l egenda .
A l egenda é centra l i za da rel a ti va mente à
i ma gem.
2 - fmPicturePositionLeftBotton A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
i nferi or da fi gura .
3 - fmPicturePositionRightTop A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte s uperi or
da fi gura .
4 - fmPicturePositionRightCenter A fi gura a pa rece à di rei ta da l egenda . A
l egenda é centra l i za da rel a ti va mente à
fi gura .
5 - fmPicturePositionRightBotton A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte i nferi or
da fi gura .
6 - fmPicturePositionAboveLeft A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
7 - fmPicturePositionAboveCenter A fi gura a pa rece a ci ma da l egenda . A
l egenda é centra l i za da a ba i xo da fi gura
(pa drã o).
8 - fmPicturePositionAboveRight A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
9 - fmPicturePositionBelowLeft A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
10 - fmPicturePositionBelowCenter A fi gura a pa rece a ba i xo da l egenda . A
l egenda é centra l i za da a ci ma da fi gura .
11 - fmPicturePositionBelowRight A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
170 Visualização
SpecialEffect
A propriedade SpecialEffect especifica a aparência de um objeto. As opções
disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade SpecialEffect
OPÇÃO DESCRIÇÃO
0 - fmButtonEffectFlat O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera çã o de cor
ou a mbos .
2 - fmButtonlEffectSunken O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta , como s e es ti ves s e
a funda do na Tel a .
TextAlign
Especifica como o texto é alinhado no objeto. As opções disponíveis são as
seguintes:
1 - fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: Centraliza o texto com a extremidade direita do
objeto
3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto
TripleState
A propriedade TripleState determina até três estados de valores para o objeto. Se
a propriedade estiver configurada para Verdadeiro, o usuário pode selecionar
entre três opções de estados: Falso, Verdadeiro ou Nulo. O valor Nulo é exibido
como um botão sombreado. Caso contrário, o usuário pode selecionar entre os
valores Falso e Verdadeiro. O valor padrão desta propriedade é Falso.
Value
Indica o valor inicial do objeto e tem comportamento Booleano: Se Verdadeiro, o
objeto inicia selecionado e, do contrário, seu estado inicial é não selecionado. O
valor padrão desta propriedade é Falso.
WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto.
Esta seção contém informações sobre propriedades do objeto Botão de Opção. Este
objeto não possui eventos nem métodos associados.
Visualização 171
4.3.2.12.4.1 Propriedades
Caption
Define o texto que é mostrado no objeto.
Font
A propriedade Font é utilizada para determinar a fonte do objeto Botão de Opção.
Esta propriedade não pode ser utilizada em Associações e contém as mesmas sub-
propriedades descritas na propriedade TextFont dos objetos Texto, Display e
SetPoint.
172 Visualização
GroupName
A propriedade GroupName é utilizado para criar um grupo de objetos
mutuamente exclusivos.
NOTA: Es ta propri eda de nã o é uti l i za da no El i ps e Power e foi ma nti da por moti vos
de compa ti bi l i da de com a es peci fi ca çã o pa drã o dos objetos Mi cros oft Forms .
Locked
A propriedade Locked habilita ou desabilita a edição do objeto. Se esta
propriedade estiver configurada para Verdadeiro, a edição não é permitida. Caso
contrário, é possível editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padrão desta propriedade é Falso.
Picture
A propriedade Picture especifica a figura (bitmap) atribuída ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: através da Lista de
Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o
caminho e o nome do arquivo que contém a figura. Para remover a figura, clique no
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
espaço do teclado) não remove a figura. Exemplo:
Sub CommandButton1_Click()
Screen.Item("OptionButton1").Picture = LoadPicture("C:
\aba.gif")
End Sub
PicturePosition
A propriedade PicturePosition especifica a posição da figura atribuída ao objeto
em relação a sua legenda. As opções disponíveis para esta propriedades estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade PicturePosition
OPÇÃO DESCRIÇÃO
0 - fmPicturePositionLeftTop A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
s uperi or da fi gura .
1 - fmPicturePositionLeftCenter A fi gura a pa rece à es querda da l egenda .
A l egenda é centra l i za da rel a ti va mente à
i ma gem.
2 - fmPicturePositionLeftBotton A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
i nferi or da fi gura .
3 - fmPicturePositionRightTop A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte s uperi or
da fi gura .
Visualização 173
OPÇÃO DESCRIÇÃO
4 - fmPicturePositionRightCenter A fi gura a pa rece à di rei ta da l egenda . A
l egenda é centra l i za da rel a ti va mente à
fi gura .
5 - fmPicturePositionRightBotton A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte i nferi or
da fi gura .
6 - fmPicturePositionAboveLeft A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
7 - fmPicturePositionAboveCenter A fi gura a pa rece a ci ma da l egenda . A
l egenda é centra l i za da a ba i xo da fi gura
(pa drã o).
8 - fmPicturePositionAboveRight A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
9 - fmPicturePositionBelowLeft A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
10 - fmPicturePositionBelowCenter A fi gura a pa rece a ba i xo da l egenda . A
l egenda é centra l i za da a ci ma da fi gura .
11 - fmPicturePositionBelowRight A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
SpecialEffect
A propriedade SpecialEffect especifica a aparência de um objeto. As opções
disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade SpecialEffect
OPÇÃO DESCRIÇÃO
0 - fmButtonEffectFlat O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera çã o de cor
ou a mbos .
2 - fmButtonlEffectSunken O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta , como s e es ti ves s e
a funda do na Tel a .
TextAlign
Especifica como o texto é alinhado no objeto. As opções disponíveis são as
seguintes:
1 - fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: Centraliza o texto com a extremidade direita do
objeto
3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto
174 Visualização
TripleState
A propriedade TripleState determina até três estados de valores para o objeto. Se
a propriedade estiver configurada para Verdadeiro, o usuário pode selecionar
entre três opções de estados: Falso, Verdadeiro ou Nulo. O valor Nulo é exibido
como um botão sombreado. Caso contrário, o usuário pode selecionar entre os
valores Falso e Verdadeiro. O valor padrão desta propriedade é Falso.
Value
Indica o valor inicial do objeto e tem comportamento Booleano: se Verdadeiro, o
objeto inicia selecionado e, do contrário, seu estado inicial é não selecionado. O
valor padrão desta propriedade é Falso.
WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a Verdadeiro.
4.3.2.12.5.1 Eventos
4.3.2.12.5.2 Métodos
176 Visualização
Remove itens de uma Lista. Este método possui o parâmetro pvargIndex, que
especifica a linha que é excluída, iniciando em 0 (zero). Ou seja, o primeiro
elemento é 0 (zero), o segundo é 1 (um), e assim por diante. Exemplo:
Sub CommandButton2_Click()
ComboBox1.SetFocus
' Verifica se a lista contém dados selecionados
If ComboBox1.ListCount >= 1 Then
' Se não há nenhuma seleção,
' selecione o último dado da lista.
If ComboBox1.ListIndex = -1 Then
ComboBox1.ListIndex = ComboBox1.ListCount – 1
End If
ComboBox1.RemoveItem(ComboBox1.ListIndex)
End If
End Sub
4.3.2.12.5.3 Propriedades
Visualização 177
BackStyle
A propriedade BackStyle define o estilo do plano de fundo para este objeto. As
opções disponíveis para esta propriedade são as seguintes:
0 - fmBackStyleTransparent: Define o objeto como transparente, isto é,
nenhum fundo deste objeto é desenhado
1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é
desenhado (valor padrão)
BorderColor
Esta propriedade determina a cor da borda que é aplicada no objeto. Com esta
propriedade, é possível aplicar a cor padrão ou personalizá-la através da sua
edição. Para que esta propriedade seja aplicável, é necessário que a propriedade
BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padrão desta
propriedade é preto (RGB(0, 0, 0)).
BorderStyle
A propriedade BorderStyle determina o estilo de borda que é aplicada ao objeto.
As opções disponíveis são as seguintes:
0 - fmBorderStyleNone: Sem borda
1 - fmBorderStyleSingle: Com borda simples
BoundColumn
Determina a coluna da lista onde os dados são armazenados. Por exemplo, se
cada linha contém oito itens e a propriedade BoundColumn é 3 (três), o objeto
armazena as informações na terceira coluna da linha atualmente selecionada. Se o
valor for igual a 0 (zero), este valor é passado para a propriedade ListIndex do
objeto. Se o valor for igual a 1 (um) ou superior, o dado indicado é atribuído à
coluna referente ao valor especificado na propriedade. As colunas são numeradas
a partir de 1 (um).
NOTA: Es ta propri eda de nã o tem efei to no El i ps e Power e foi ma nti da por moti vos
de compa ti bi l i da de com a es peci fi ca çã o pa drã o dos objetos Mi cros oft Forms .
CanPaste
A propriedade CanPaste especifica se a Área de Transferência contém os dados
aos quais o objeto dá suporte. Se esta propriedade estiver configurada para
Verdadeiro, o objeto pode receber informações coladas da Área de Transferência.
Se os dados da Área de Transferência estiverem em um formato ao qual o objeto
178 Visualização
não dá suporte, o valor da propriedade CanPaste é Falso. Por exemplo, ao tentar
colar um bitmap em um objeto que só dê suporte a texto, CanPaste é Falso. Esta
propriedade é acessível apenas em tempo de execução.
Column
Especifica a linha e a coluna no objeto. Se for especificado somente o valor de
coluna, a propriedade Column lê ou escreve a coluna especificada na linha atual
do objeto. Por exemplo, "MinhaListadeSelecao.Column(3)" lê ou escreve a terceira
coluna do objeto. Esta propriedade é acessível apenas em tempo de execução.
ColumnCount
A propriedade ColumnCount especifica o número de colunas do objeto. A
configuração de ColumnCount como 0 (zero) não exibe nenhuma coluna, e a
configuração desta propriedade como -1 (menos um) exibe todas as colunas
disponíveis. O valor padrão desta propriedade é 1 (um).
ColumnHeads
A propriedade ColumnHeads habilita ou desabilita a exibição do título das
colunas no objeto. Se a propriedade estiver configurada para Verdadeiro, o título é
mostrado. Caso contrário, o título das colunas não é mostrado. O valor padrão é
Falso.
ColumnWidths
A propriedade ColumnWidths é utilizada para especificar a largura da coluna
do objeto, em pontos. Um valor igual a –1 (menos um) ou em branco faz com que a
largura seja calculada na coluna (a largura mínima de uma coluna calculada é 72
pontos, ou uma polegada). Um valor igual a 0 (zero) oculta a coluna. Para produzir
colunas mais estreitas, deve-se especificar a largura na propriedade ou utilizar
algum dos valores descritos na tabela a seguir.
Opções disponíveis para a propriedade ColumnWidths
OPÇÃO DESCRIÇÃO
90;72;90 A pri mei ra col una pos s ui 90 pontos (1,25
pol ega da ), a s egunda col una pos s ui 72
pontos (uma pol ega da ) e a tercei ra
col una pos s ui 90 pontos .
6 cm;0;6 cm A pri mei ra col una pos s ui 6 centímetros , a
s egunda col una es tá ocul ta e a tercei ra
col una pos s ui 6 centímetros . Como pa rte
da tercei ra col una é vi s ível , uma ba rra de
rol a gem hori zonta l a pa rece.
1,5 pol;0;2,5 pol A pri mei ra col una pos s ui 1,5 pol ega da s ,
a s egunda col una es tá ocul ta e a tercei ra
col una pos s ui 2,5 pol ega da s .
Visualização 179
OPÇÃO DESCRIÇÃO
2 pol;;2 pol A pri mei ra col una pos s ui 2 pol ega da s , a
s egunda col una pos s ui 1 pol ega da
(pa drã o) e a tercei ra col una pos s ui 2
pol ega da s . Como s omente meta de da
tercei ra col una é vi s ível , uma ba rra de
rol a gem hori zonta l a pa rece.
(Vazio) Toda s a s três col una s pos s uem a mes ma
l a rgura (1,33 pol ega da s ). O va l or pa drã o
des ta propri eda de é va zi o (o El i ps e
Power uti l i za o va l or pa drã o do s i s tema ).
CurTargetX
Retorna a posição horizontal de inserção de um texto no objeto. Esta posição é
medida em unidades himétricas (um himetro é igual a 0,0001 de um metro). Pode-se
usar CurTargetX e CurX para mover o ponto de inserção de um texto conforme o
usuário percorre o conteúdo do objeto. Quando o usuário move o ponto de
inserção para outra linha do texto, a propriedade CurTargetX especifica a posição
mais indicada para o ponto de inserção do texto desejado. A propriedade CurX é
definida neste valor se a linha do texto for maior que o valor de CurTargetX. Caso
contrário, a propriedade CurX é definida como o final da linha do texto. Esta
propriedade é acessível apenas em tempo de execução.
NOTA: Es ta propri eda de nã o tem efei to no El i ps e Power e foi ma nti da por moti vos
de compa ti bi l i da de com a es peci fi ca çã o pa drã o dos objetos Mi cros oft Forms .
CurX
A propriedade CurX especifica a posição atual horizontal do ponto de inserção no
objeto. Esta propriedades é aplicada em um objeto que possua várias linhas, isto é,
cuja propriedade Multiline está habilitada. O valor de retorno é válido quando o
objeto possui o foco. Pode-se usar a propriedade Multiline e a propriedade CurX
para posicionar o ponto de inserção do texto conforme o usuário usa a barra de
rolagem pelo conteúdo do objeto. Quando o usuário move o ponto de inserção para
uma outra linha de texto rolando o conteúdo do objeto, a propriedade CurTargetX
especifica a posição desejada para o ponto de inserção. A propriedade CurX é
definida com este valor se a linha de texto for maior do que o valor de CurTargetX.
Caso contrário, CurX é definido no fim da linha de texto. Esta propriedade é
acessível apenas em tempo de execução.
DragBehavior
Habilita ou desabilita o recurso de arrastar e soltar um texto no conteúdo do
objeto. As opções disponíveis para esta propriedade são as seguintes:
0 - fmDragBehaviorDisabled: Não permite a ação de arrastar e soltar o texto
no conteúdo do objeto
1 - fmDragBehaviorEnabled: Permite a ação de arrastar e soltar o texto no
180 Visualização
conteúdo do objeto
NOTA: A propri eda de DragBehavior nã o tem efei to s e a propri eda de Style es ti ver
confi gura da pa ra 2 - fmStyleDropDownList.
DropButtonStyle
Esta propriedade especifica o símbolo exibido no botão da Lista de Seleção. As
opções disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade DropButtonStyle
OPÇÃO DESCRIÇÃO
0 - fmDropButtonStylePlain Exi be um botã o pl a no, s em s ímbol o
1 - fmDropButtonStyleArrow Exi be um s eta pa ra ba i xo (pa drã o)
2 - fmDropButtonStyleEllipsis Exi be reti cênci a s
3 - fmDropButtonStyleReduce Exi be uma reta hori zonta l como um
ca ra ctere s ubl i nha do
LineCount
A propriedade LineCount retorna o número de linhas do objeto. Esta propriedade
é acessível apenas em tempo de execução.
182 Visualização
List
Retorna ou define as entradas da linha e da coluna na lista do objeto. A
numeração de linha e de coluna começa em 0 (zero), isto é, o número de linha da
primeira linha na lista é 0 (zero) e o número de coluna da primeira coluna é 0
(zero). O número da segunda linha ou coluna é um (um) e assim por diante. Esta
propriedade é acessível apenas em tempo de execução.
ListCount
Retorna o número de itens contidos na lista do objeto. Esta propriedade é
acessível apenas em tempo de execução.
ListIndex
Identifica o item atualmente selecionado na lista, chamado de índice. Os valores
de ListIndex vão de -1 (menos um) ao número total de linhas em uma lista menos
um (isto é, ListCount - 1). Quando nenhuma linha é selecionada, ListIndex retorna -1
(menos um). Quando o usuário seleciona uma linha em uma Lista de Seleção, o
sistema define o valor da propriedade ListIndex. O valor da propriedade ListIndex
da primeira linha de uma lista é 0 (zero), o valor da segunda linha é 1 (um) e assim
por diante. Esta propriedade é acessível apenas em tempo de execução.
ListRows
A propriedade ListRows determina o número máximo de linhas na lista do objeto.
O valor padrão desta propriedade é 8 (oito).
ListStyle
A propriedade ListStyle determina o estilo da lista do objeto. As opções
disponíveis para esta propriedade são as seguintes:
0 - fmListStylePlain: Listagem com os itens do plano de fundo em destaque
1 - fmListStyleOption: Exibe botões de opção ou caixas de seleção para uma
lista com várias opções. Quando o usuário seleciona um item do grupo, o
botão de opção associado ao item é selecionado e os botões de opção para
outros itens no grupo são desmarcados
NOTA: Se a propri eda de SelectionMargin es ti ver confi gura da pa ra Verda dei ro qua ndo
o objeto for i mpres s o, a ma rgem de s el eçã o ta mbém é i mpres s a .
SelLength
Retorna o número de caracteres selecionados no objeto. Esta propriedade é
acessível apenas em tempo de execução.
SelStart
Indica o ponto inicial do texto selecionado ou o ponto de inserção se nenhum
texto for selecionado. Esta propriedade é acessível apenas em tempo de execução.
SelText
Retorna o texto selecionado no objeto. Esta propriedade é acessível apenas em
tempo de execução.
ShowDropButtonWhen
A propriedade ShowDropButtonWhen especifica quando mostrar o botão
suspenso (tecla de navegação do objeto). As opções disponíveis para esta
propriedade são as seguintes:
0 - fmShowDropButtonWhenNever: Não mostra o botão suspenso em
nenhuma circunstância
1 - fmShowDropButtonWhenFocus: Mostra o botão suspenso quando o
objeto possui o foco
2 - fmShowDropButtonWhenAlways: Sempre mostra o botão suspenso
SpecialEffect
A propriedade SpecialEffect especifica a aparência de um objeto. As opções
disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade SpecialEffect
OPÇÃO DESCRIÇÃO
0 - fmSpecialEffectFlat O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera çã o de cor
ou a mbos .
1 - fmSpecialEffectRaised O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta , como s e es ti ves s e
em rel evo.
2 - fmSpecialEffectSunken O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda a pa recem a funda dos na Tel a .
Visualização 185
OPÇÃO DESCRIÇÃO
3 - fmSpecialEffectEtched A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
6 - fmSpecialEffectBump O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .
Style
Determina o estilo do objeto. As opções disponíveis são as seguintes:
0 - fmStyleDropDownCombo: A Lista de Seleção se comporta como uma caixa
de combinação suspensa. O usuário pode digitar um valor na região de
edição ou selecionar um valor da lista suspensa (padrão)
2 - fmStyleDropDownList: A Lista de Seleção se comporta como uma caixa de
listagem e o usuário deve escolher um valor da lista
Text
Retorna o texto da opção selecionada. Esta propriedade é acessível apenas em
tempo de execução.
TextAlign
Especifica como o texto é alinhado no objeto. As opções disponíveis são as
seguintes:
1 - fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: Centraliza o texto com o centro do objeto
3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto
TextColumn
A propriedade TextColumn identifica a coluna no objeto. Os valores para a
propriedade TextColumn vão de -1 (menos um) ao número de colunas na lista. O
valor de TextColumn para a primeira coluna é 1 (um), o valor da segunda coluna é
2 (dois), e assim por diante. A configuração de TextColumn como 0 (zero) exibe os
valores para a propriedade ListIndex. A configuração de TextColumn como -1
(menos um) exibe a primeira coluna que possui o valor da propriedade
ColumnWidths maior do que 0 (zero).
TextLength
Retorna o número de caracteres digitados no objeto. Esta propriedade é acessível
apenas em tempo de execução.
TopIndex
A propriedade TopIndex define ou retorna o item da lista que aparece na posição
mais próxima do topo na lista. Esta propriedade retorna o valor -1 (menos um) se a
186 Visualização
lista está vazia ou não é exibida.
Value
Este é o valor da propriedade BoundColumn das linhas atualmente selecionadas.
Uma mudança de valor na propriedade Value não implica em mudança de valor na
propriedade BoundColumn. Para adicionar ou apagar entradas em uma lista de
seleção, pode-se usar os métodos AddItem ou RemoveItem.
4.3.2.12.6.1 Eventos
4.3.2.12.6.2 Propriedades
Caption
Define o texto que é mostrado no objeto.
Font
A propriedade Font é utilizada para determinar a fonte do objeto Botão de
Comando. Esta propriedade não pode ser utilizada em Associações e contém as
mesmas sub-propriedades descritas na propriedade TextFont dos objetos Texto,
Display e SetPoint.
Locked
A propriedade Locked habilita ou desabilita a edição do objeto. Se esta
propriedade estiver configurada para Verdadeiro, a edição não é permitida. Caso
contrário, é possível editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padrão desta propriedade é Falso.
Picture
A propriedade Picture especifica a figura (bitmap) atribuída ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: através da Lista de
Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o
caminho e o nome do arquivo que contém a figura. Para remover a figura, clique no
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
espaço do teclado) não remove a figura.
PicturePosition
A propriedade PicturePosition especifica a posição da figura atribuída ao objeto
em relação a sua legenda. As opções disponíveis para esta propriedade estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade PicturePosition
OPÇÃO DESCRIÇÃO
0 - fmPicturePositionLeftTop A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
s uperi or da fi gura .
1 - fmPicturePositionLeftCenter A fi gura a pa rece à es querda da l egenda .
A l egenda é centra l i za da rel a ti va mente à
i ma gem.
188 Visualização
OPÇÃO DESCRIÇÃO
2 - fmPicturePositionLeftBottom A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
i nferi or da fi gura .
3 - fmPicturePositionRightTop A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte s uperi or
da fi gura .
4 - fmPicturePositionRightCenter A fi gura a pa rece à di rei ta da l egenda . A
l egenda é centra l i za da rel a ti va mente à
fi gura .
5 - fmPicturePositionRightBottom A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte i nferi or
da fi gura .
6 - fmPicturePositionAboveLeft A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
7 - fmPicturePositionAboveCenter A fi gura a pa rece a ci ma da l egenda . A
l egenda é centra l i za da a ba i xo da fi gura
(pa drã o).
8 - fmPicturePositionAboveRight A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
9 - fmPicturePositionBelowLeft A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
10 - fmPicturePositionBelowCenter A fi gura a pa rece a ba i xo da l egenda . A
l egenda é centra l i za da a ci ma da fi gura .
11 - fmPicturePositionBelowRight A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
TakeFocusOnClick
Especifica se o objeto recebe o foco quando clicado. Se a propriedade estiver
configurada para Verdadeiro, o objeto recebe o foco quando clicado. Caso
contrário, o objeto não recebe o foco.
WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto.
4.3.2.12.7 Texto
Esta seção contém informações sobre propriedades do objeto Texto. Este objeto não
possui eventos nem métodos associados.
Visualização 189
4.3.2.12.7.1 Propriedades
BorderColor
Esta propriedade determina a cor da borda que é aplicada no objeto. Com esta
propriedade, é possível aplicar a cor padrão ou personalizá-la através da sua
edição. Para que esta propriedade seja aplicável, é necessário que a propriedade
BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padrão desta
propriedade é preto (RGB(0, 0, 0)).
BorderStyle
A propriedade BorderStyle determina o estilo de borda que é aplicada ao objeto.
As opções disponíveis são:
0 - fmBorderStyleNone: Sem borda
1 - fmBorderStyleSingle: Com borda simples
Caption
Define o texto que é mostrado no objeto.
190 Visualização
Font
A propriedade Font é utilizada para determinar a fonte do objeto Texto. Esta
propriedade não pode ser utilizada em Associações e contém as mesmas sub-
propriedades descritas na propriedade TextFont dos objetos Texto, Display e
SetPoint.
Picture
A propriedade Picture especifica a figura (bitmap) atribuída ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: através da Lista de
Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o
caminho e o nome do arquivo que contém a figura. Para remover a figura, clique o
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
espaço do teclado) não remove a figura.
PicturePosition
A propriedade PicturePosition especifica a posição da figura atribuída ao objeto
em relação a sua legenda. As opções disponíveis para esta propriedade estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade PicturePosition
OPÇÃO DESCRIÇÃO
0 - fmPicturePositionLeftTop A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
s uperi or da fi gura .
1 - fmPicturePositionLeftCenter A fi gura a pa rece à es querda da l egenda .
A l egenda é centra l i za da rel a ti va mente à
i ma gem.
2 - fmPicturePositionLeftBottom A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
i nferi or da fi gura .
3 - fmPicturePositionRightTop A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte s uperi or
da fi gura .
4 - fmPicturePositionRightCenter A fi gura a pa rece à di rei ta da l egenda . A
l egenda é centra l i za da rel a ti va mente à
fi gura .
5 - fmPicturePositionRightBottom A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte i nferi or
da fi gura .
6 - fmPicturePositionAboveLeft A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
7 - fmPicturePositionAboveCenter A fi gura a pa rece a ci ma da l egenda . A
l egenda é centra l i za da a ba i xo da fi gura
(pa drã o).
Visualização 191
OPÇÃO DESCRIÇÃO
8 - fmPicturePositionAboveRight A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
9 - fmPicturePositionBelowLeft A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
10 - fmPicturePositionBelowCenter A fi gura a pa rece a ba i xo da l egenda . A
l egenda é centra l i za da a ci ma da fi gura .
11 - fmPicturePositionBelowRight A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
SpecialEffect
A propriedade SpecialEffect especifica a aparência de um objeto. As opções
disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade SpecialEffect
OPÇÃO DESCRIÇÃO
0 - fmSpecialEffectFlat O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera çã o de cor
ou a mbos .
1 - fmSpecialEffectRaised O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta . O objeto pa rece
es ta r em rel evo.
2 - fmSpecialEffectSunked O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda pa recem es ta r a funda dos na Tel a .
3 - fmSpecialEffectEtched A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
6 - fmSpecialEffectBump O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .
TextAlign
Especifica como o texto é alinhado no objeto. As opções disponíveis são as
seguintes:
1 - fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: Centraliza o texto com a extremidade direita do
objeto
3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto
WordWrap
192 Visualização
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a Verdadeiro.
4.3.2.12.8 Lista
Esta seção contém informações sobre métodos e propriedades do objeto Lista. Este
objeto não possui eventos associados.
4.3.2.12.8.1 Métodos
Visualização 193
End Sub
4.3.2.12.8.2 Propriedades
NOTA: Es ta propri eda de nã o tem efei to no El i ps e Power e foi ma nti da por moti vos
de compa ti bi l i da de com a es peci fi ca çã o pa drã o dos objetos Mi cros oft Forms .
Column
Especifica a linha e coluna no objeto. Se for especificado somente o valor de
coluna, a propriedade Column lê ou escreve a coluna especificada na linha atual
do objeto. Por exemplo, "MinhaListadeSelecao.Column(3)" lê ou escreve a terceira
coluna do objeto. Esta propriedade é acessível apenas em tempo de execução.
ColumnCount
A propriedade ColumnCount especifica o número de colunas do objeto. A
configuração de ColumnCount como 0 (zero) não exibe nenhuma coluna, e a
configuração desta propriedade como -1 (menos um) exibe todas as colunas
disponíveis. O valor padrão desta propriedade é 1 (um).
194 Visualização
ColumnHeads
A propriedade ColumnHeads habilita ou desabilita a exibição do título das
colunas no objeto. Se a propriedade estiver configurada para Verdadeiro, o título é
mostrado. Caso contrário, o título das colunas não é mostrado. O valor padrão é
Falso.
ColumnWidths
A propriedade ColumnWidths é utilizada para especificar a largura da coluna do
objeto, em pontos. Um valor igual a -1 (menos um) ou em branco faz com que a
largura seja calculada na coluna (a largura mínima de uma coluna calculada é 72
pontos, ou uma polegada). Um valor igual a 0 (zero) oculta a coluna. Para produzir
colunas mais estreitas, deve-se especificar a largura na propriedade ou utilizar
alguma dos valores descritos na tabela a seguir.
Opções disponíveis para a propriedade ColumnWidths
OPÇÃO DESCRIÇÃO
90;72;90 A pri mei ra col una pos s ui 90 pontos (1,25
pol ega da ), a s egunda col una pos s ui 72
pontos (uma pol ega da ) e a tercei ra
col una pos s ui 90 pontos .
6 cm;0;6 cm A pri mei ra col una pos s ui 6 centímetros , a
s egunda col una es tá ocul ta e a tercei ra
col una pos s ui 6 centímetros . Como pa rte
da tercei ra col una é vi s ível , uma ba rra de
rol a gem hori zonta l a pa rece.
1,5 pol;0;2,5 pol A pri mei ra col una pos s ui 1,5 pol ega da s ,
a s egunda col una es tá ocul ta e a tercei ra
col una pos s ui 2,5 pol ega da s .
2 pol;;2 pol A pri mei ra col una pos s ui 2 pol ega da s , a
s egunda col una pos s ui 1 pol ega da
(pa drã o) e a tercei ra col una pos s ui 2
pol ega da s . Como s omente meta de da
tercei ra col una é vi s ível , uma ba rra de
rol a gem hori zonta l a pa rece.
(Vazio) Toda s a s três col una s pos s uem a mes ma
l a rgura (1,33 pol ega da s ). O va l or pa drã o
des ta propri eda de é va zi o (o El i ps e
Power uti l i za o va l or pa drã o do s i s tema ).
Font
A propriedade Font é utilizada para determinar a fonte do objeto Lista. Esta
propriedade não pode ser utilizada em Associações e contém as mesmas sub-
propriedades descritas na propriedade TextFont dos objetos Texto, Display e
SetPoint.
Visualização 195
IMEMode
A propriedade IMEMode especifica o modo IME (Input Method Editor) de um
objeto. Essa propriedade aplica-se apenas em aplicativos escritos em idiomas
asiáticos (chinês simplificado, chinês tradicional, coreano e japonês) e é ignorada
em outros aplicativos. Ela não tem efeito no Elipse Power e foi mantida por motivos
de compatibilidade com a especificação padrão dos objetos Microsoft Forms. As
opções disponíveis estão descritas na tabela a seguir.
Opções disponíveis para a propriedade IMEMode
OPÇÃO DESCRIÇÃO
0 - fmIMEModeNoControl Nã o control a IME (pa drã o)
1 - fmIMEModeOn IME a ti va do
2 - fmIMEModeOff IME des a ti va do. Modo i ngl ês
3 - fmIMEModeDisable IME des a ti va do. O us uá ri o nã o pode
a ti va r IME pel o tecl a do
4 - fmIMEModeHiragana IME a ti va do com modo Hi ra ga na de
l a rgura tota l
5 - fmIMEModeKatakanaFull IME a ti va do com modo Ka ta ka na de
l a rgura tota l
6 - fmIMEModeKatakana IME a ti va do com modo Ka ta ka na de mei a
l a rgura
7 - fmIMEModeAlphaFull IME a ti va do com modo Al fa numéri co de
l a rgura tota l
8 - fmIMEModeAlpha IME a ti va do com modo Al fa numéri co de
mei a l a rgura
9 - fmIMEModeHangulFull IME a ti va do com modo Ha ngul de l a rgura
tota l
10 - fmIMEModeHangul IME a ti va do com modo Ha ngul de mei a
l a rgura
11 - fmIMEModeHanziFull IME a ti va do com modo Ha nzi de l a rgura
tota l
12 - fmIMEModeHanzi IME a ti va do com modo Ha nzi de mei a
l a rgura
IntegralHeight
A propriedade IntegralHeight ajusta a altura da área de edição do texto, caso a
área disponível ultrapasse o tamanho do objeto. Se esta propriedade estiver
configurada para Verdadeiro, a altura da área de edição do texto é reajustada para
coincidir com o tamanho atual do objeto, permitindo assim a exibição completa do
conteúdo do texto. Caso contrário, a área de edição do texto continua com seu
tamanho original. Se os textos são maiores que o espaço disponível, este não é
exibido no objeto.
List
Retorna ou define as entradas da linha e da coluna na lista do objeto. A
numeração de linha e de coluna começa com 0 (zero). Isto é, o número de linha da
196 Visualização
primeira linha na lista é 0 (zero) e o número de coluna da primeira coluna é 0
(zero). O número da segunda linha ou coluna é 1 (um), e assim por diante. Esta
propriedade é acessível apenas em tempo de execução.
ListCount
Retorna o número de itens contidos na lista do objeto. Esta propriedade é
acessível apenas em tempo de execução.
ListIndex
Identifica o item atualmente selecionado na lista, chamado de índice. Os valores
de ListIndex vão de -1 (menos um) ao número total de linhas em uma lista menos
um (isto é, ListCount - 1). Quando nenhuma linha é selecionada, ListIndex retorna -1
(menos um). Quando o usuário seleciona uma linha em uma Lista de Seleção, o
sistema define o valor da propriedade ListIndex. O valor da propriedade ListIndex
da primeira linha de uma lista é 0 (zero), o valor da segunda linha é 1 (um), e assim
por diante. Esta propriedade é acessível apenas em tempo de execução.
ListStyle
A propriedade ListStyle determina o estilo da lista do objeto. As opções
disponíveis para esta propriedade são as seguintes:
0 - fmListStylePlain: Listagem com os itens do plano de fundo em destaque
1 - fmListStyleOption: Exibe botões de opção ou caixas de seleção para uma
lista de várias opções. Quando o usuário seleciona um item do grupo, o
botão de opção associado ao item é selecionado e os botões de opção para
outros itens no grupo são desmarcados
Locked
A propriedade Locked habilita ou desabilita a edição do objeto. Se esta
propriedade estiver configurada para Verdadeiro, a edição não é permitida. Caso
contrário, é possível editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padrão desta propriedade é Falso.
MatchEntry
Procura, através do texto digitado pelo usuário, por uma entrada de texto que
coincida com os dados existentes no objeto. Ao encontrar uma coincidência no
texto, a linha é selecionada e o conteúdo da coluna é exibido. As opções
disponíveis são as seguintes:
Visualização 197
0 - fmMatchEntryFirstLetter: Procura pela entrada de texto que coincida com
o primeiro caractere digitado no objeto. Se for digitada repetidamente a
mesma letra, é passada para a próxima entrada de texto que comece com
esta letra, e assim por diante
1 - fmMatchEntryComplete: Conforme cada caractere é digitado, o objeto
procura por uma entrada de texto que coincida com os caracteres digitados
2 - fmMatchEntryNone: Não realiza a procura no objeto
198 Visualização
Opções disponíveis para a propriedade SpecialEffect
OPÇÃO DESCRIÇÃO
0 - fmSpecialEffectFlat O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera çã o de cor
ou a mbos .
1 - fmSpecialEffectRaised O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta . O objeto pa rece
es ta r em rel evo.
2 - fmSpecialEffectSunken O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda pa recem es ta r a funda dos na Tel a .
3 - fmSpecialEffectEtched A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
6 - fmSpecialEffectBump O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .
Text
Retorna o texto da opção selecionada. Esta propriedade é acessível apenas em
tempo de execução.
TextAlign
Especifica como o texto é alinhado no objeto. As opções disponíveis são as
seguintes:
1 - fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: Alinha o texto com o centro do objeto
3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto
TextColumn
A propriedade TextColumn identifica a coluna no objeto. Os valores para a
propriedade TextColumn vão de -1 (menos um) ao número de colunas na lista. O
valor TextColumn para a primeira coluna é 1 (um), o valor da segunda coluna é 2
(dois), e assim por diante. A configuração de TextColumn como 0 (zero) exibe os
valores para a propriedade ListIndex. A configuração de TextColumn como -1
(menos um) exibe a primeira coluna que possui o valor da propriedade
ColumnWidths maior do que 0 (zero).
TopIndex
A propriedade TopIndex define ou retorna o item da lista que aparece na posição
mais próxima do topo na lista. Esta propriedade retorna o valor -1 (menos um) se a
lista está vazia ou não é exibida.
Visualização 199
Value
Este é o valor da propriedade BoundColumn das linhas atualmente selecionadas.
Esta propriedade não tem efeito no Elipse Power e foi mantida por motivos de
compatibilidade com a especificação padrão dos objetos Microsoft Forms.
Esta seção contém informações sobre eventos e propriedades do objeto Botão Liga-
Desliga. Este objeto não possui métodos associados.
4.3.2.12.9.1 Eventos
4.3.2.12.9.2 Propriedades
200 Visualização
BackStyle
A propriedade BackStyle define o estilo do plano de fundo para o objeto. As
opções disponíveis para esta propriedade são as seguintes:
0 - fmBackStyleTransparent: Define o objeto como transparente, isto é,
nenhum fundo deste objeto é desenhado
1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é
desenhado (valor padrão)
Caption
Define o texto que é mostrado no objeto.
Font
A propriedade Font é utilizada para determinar a fonte do objeto Botão Liga-
Desliga. Esta propriedade não pode ser utilizada em Associações e contém as
mesmas sub-propriedades descritas na propriedade TextFont dos objetos Texto,
Display e SetPoint.
GroupName
A propriedade GroupName é utilizado para criar um grupo de objetos
mutuamente exclusivos. Esta propriedade é acessível apenas em tempo de
execução.
NOTA: Es ta propri eda de nã o é uti l i za da no El i ps e Power e foi ma nti da por moti vos
de compa ti bi l i da de com a es peci fi ca çã o pa drã o dos objetos Mi cros oft Forms .
Locked
A propriedade Locked habilita ou desabilita a edição do objeto. Se esta
propriedade estiver configurada para Verdadeiro, a edição não é permitida. Caso
contrário, é possível editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padrão desta propriedade é Falso.
Picture
A propriedade Picture especifica a figura (bitmap) atribuída ao objeto. Um
arquivo com imagem pode ser selecionado de duas maneiras: através da Lista de
Propriedades ou via scripts, utilizando-se a função LoadPicture para especificar o
caminho e o nome do arquivo que contém a figura. Para remover a figura, clique no
valor da propriedade Picture e pressione a tecla DEL. A tecla BACKSPACE (tecla de
espaço do teclado) não remove a figura.
Visualização 201
PicturePosition
A propriedade PicturePosition especifica a posição da figura atribuída ao objeto
em relação a sua legenda. As opções disponíveis para esta propriedade estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade PicturePosition
OPÇÃO DESCRIÇÃO
0 - fmPicturePositionLeftTop A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
s uperi or da fi gura .
1 - fmPicturePositionLeftCenter A fi gura a pa rece à es querda da l egenda .
A l egenda é centra l i za da rel a ti va mente à
i ma gem.
2 - fmPicturePositionLeftBottom A fi gura a pa rece à es querda da l egenda .
A l egenda é a l i nha da com a pa rte
i nferi or da fi gura .
3 - fmPicturePositionRightTop A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte s uperi or
da fi gura .
4 - fmPicturePositionRightCenter A fi gura a pa rece à di rei ta da l egenda . A
l egenda é centra l i za da rel a ti va mente à
fi gura .
5 - fmPicturePositionRightBottom A fi gura a pa rece à di rei ta da l egenda . A
l egenda é a l i nha da com a pa rte i nferi or
da fi gura .
6 - fmPicturePositionAboveLeft A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
7 - fmPicturePositionAboveCenter A fi gura a pa rece a ci ma da l egenda . A
l egenda é centra l i za da a ba i xo da fi gura
(pa drã o).
8 - fmPicturePositionAboveRight A fi gura a pa rece a ci ma da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
9 - fmPicturePositionBelowLeft A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
es querda da fi gura .
10 - fmPicturePositionBelowCenter A fi gura a pa rece a ba i xo da l egenda . A
l egenda é centra l i za da a ci ma da fi gura .
11 - fmPicturePositionBelowRight A fi gura a pa rece a ba i xo da l egenda . A
l egenda é a l i nha da com a extremi da de
di rei ta da fi gura .
SpecialEffect
A propriedade SpecialEffect especifica a aparência de um objeto. Esta
propriedade é acessível apenas em tempo de execução. As opções disponíveis para
esta propriedade estão descritas na tabela a seguir.
202 Visualização
Opções disponíveis para a propriedade SpecialEffect
OPÇÃO DESCRIÇÃO
0 - fmSpecialEffectFlat O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera çã o de cor
ou a mbos .
1 - fmSpecialEffectRaised O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta . O objeto pa rece
es ta r em rel evo.
2 - fmSpecialEffectSunken O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda pa recem es ta r a funda dos na Tel a .
3 - fmSpecialEffectEtched A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
6 - fmSpecialEffectBump O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .
TextAlign
Especifica como o texto é alinhado no objeto. As opções disponíveis são as
seguintes:
1 - fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: Alinha o texto ao centro do objeto
3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto
TripleState
A propriedade TripleState determina até três estados de valores para o objeto. Se
a propriedade estiver configurada para Verdadeiro, o usuário pode selecionar
entre três opções de estados: Falso, Verdadeiro ou Nulo. O valor Nulo é exibido
como um botão sombreado. Caso contrário, o usuário pode selecionar entre os
valores Falso e Verdadeiro. O valor padrão desta propriedade é Falso.
Value
Indica o valor inicial do objeto. Tem comportamento Booleano: Se Verdadeiro, o
objeto inicia selecionado e, do contrário, seu estado inicial é não selecionado. O
valor padrão desta propriedade é Falso.
WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto.
Visualização 203
4.3.2.12.10 Editor de Texto
4.3.2.12.10.1 Eventos
4.3.2.12.10.2 Métodos
4.3.2.12.10.3 Propriedades
204 Visualização
NOTA: Recomenda -s e evi ta r o us o da propri eda de AutoSize com um Edi tor de Texto
va zi o, que ta mbém uti l i ze a s propri eda des Multiline e WordWrap. Qua ndo o us uá ri o
di gi ta em um Edi tor de Texto com es ta s propri eda des a jus ta da s pa ra Verda dei ro,
el e a utoma ti ca mente s e redi mens i ona como uma ca i xa l onga e es trei ta , com um
ca ra ctere de l a rgura e uma l i nha de texto de compri mento.
AutoTab
A propriedade AutoTab habilita ou desabilita a tabulação automática no objeto.
Se a propriedade estiver configurada para Verdadeiro, a tabulação automática
ocorre. Caso contrário, não é utilizada.
Após o usuário digitar o número máximo de caracteres em um objeto (configurado
na propriedade MaxLength), o foco se move automaticamente para o próximo
objeto da ordem de tabulação, quando estes caracteres forem atingidos. Por
exemplo, quando se quer que um Editor de Texto exiba dados de estoque que
possuam sempre cinco caracteres, pode-se usar a propriedade MaxLength para
especificar o número máximo de caracteres a serem introduzidos no objeto e a
propriedade AutoTab para tabular automaticamente para o próximo objeto depois
que o usuário digitar cinco caracteres.
AutoWordSelect
Habilita ou desabilita a seleção automática de palavras no objeto. Se esta
propriedade estiver configurada para Verdadeiro, a palavra indicada é selecionada
no texto mais o espaço seguinte, caso se tenha selecionado parte dela. Caso
contrário, somente o caractere indicado na palavra é selecionado.
BackStyle
A propriedade BackStyle define o estilo do plano de fundo para os objetos. As
opções disponíveis para esta propriedade são as seguintes:
0 - fmBackStyleTransparent: Define o objeto como transparente, isto é,
nenhum fundo deste objeto é desenhado
1 - fmBackStyleOpaque: Define o objeto como opaco, isto é, o fundo é
desenhado (valor padrão)
BorderColor
Esta propriedade determina a cor da borda que é aplicada no objeto. Com esta
propriedade, é possível aplicar a cor padrão ou personalizá-la através da sua
edição. Para que esta propriedade seja aplicável, é necessário que a propriedade
BorderStyle esteja configurada para 1 - fmBorderStyleSingle. O valor padrão desta
propriedade é preto (RGB(0, 0, 0)).
Visualização 205
BorderStyle
A propriedade BorderStyle determina o estilo de borda que é aplicada ao objeto.
As opções disponíveis são:
0 - fmBorderStyleNone: Sem borda
1 - fmBorderStyleSingle: Com borda simples
CanPaste
A propriedade CanPaste especifica se a Área de Transferência contém os dados
aos quais o objeto dá suporte. Se a opção estiver configurada para Verdadeiro, o
objeto pode receber informações coladas da Área de Transferência. Se os dados da
Área de Transferência estiverem em um formato ao qual o objeto não dá suporte, o
valor da propriedade CanPaste é Falso. Por exemplo, ao se tentar colar um bitmap
em um objeto que só dê suporte a texto, CanPaste é Falso. Esta propriedade é
acessível apenas em tempo de execução.
CurLine
Especifica a linha corrente do objeto, ou seja, a linha que contém o ponto de
inserção de texto. O número da primeira linha é 0 (zero). O valor padrão desta
propriedade é 0 (zero).
CurTargetX
Retorna a posição horizontal de inserção de um texto no objeto. Esta posição é
medida em unidades himétricas (um himetro corresponde a 0,0001 de um metro).
Pode-se usar CurTargetX e CurX para mover o ponto de inserção de um texto
conforme o usuário percorre o conteúdo do objeto. Quando o usuário move o ponto
de inserção para outra linha do texto, a propriedade CurTargetX especifica a
posição mais indicada para o ponto de inserção do texto desejado. A propriedade
CurX é definida neste valor, se a linha do texto for maior que o valor de CurTargetX.
Caso contrário, a propriedade CurX é definida como o final da linha do texto. Esta
propriedade é acessível apenas em tempo de execução.
CurX
A propriedade CurX especifica a posição atual horizontal do ponto de inserção no
objeto. Esta propriedade é aplicada em um objeto que possua várias linhas, isto é,
a propriedade Multiline está habilitada. O valor de retorno é válido quando o
objeto possui o foco. Pode-se usar a propriedade Multiline e a propriedade CurX
para posicionar o ponto de inserção do texto, conforme o usuário usa a barra de
rolagem pelo conteúdo no objeto. Quando o usuário move o ponto de inserção para
uma outra linha de texto rolando o conteúdo do objeto, a propriedade CurTargetX
especifica a posição desejada para o ponto de inserção. A propriedade CurX é
definida com este valor se a linha de texto for maior do que o valor de CurTargetX.
Caso contrário, CurX é definido no fim da linha de texto. Esta propriedade é
acessível apenas em tempo de execução.
206 Visualização
DragBehavior
Habilita ou desabilita o recurso de arrastar e soltar um texto no conteúdo do
objeto. As opções disponíveis para esta propriedade são as seguintes:
0 - fmDragBehaviorDisabled: Não permite a ação de arrastar e soltar o texto
no conteúdo do objeto
1 - fmDragBehaviorEnabled: Permite a ação de arrastar e soltar o texto no
conteúdo do objeto
NOTA: A propri eda de DragBehavior nã o tem efei to s e a propri eda de Style es ti ver
confi gura da pa ra 2 (doi s ).
EnterFieldBehavior
Esta propriedade controla a forma como o conteúdo do texto é selecionado na
área de edição quando se pressiona a tecla TAB no objeto e não quando o objeto
recebe o foco como um resultado do método SetFocus. As opções disponíveis para
esta propriedade são as seguintes:
0 - fmEnterFieldBehaviorSelectAll: Seleciona todo o conteúdo do texto
quando a tecla TAB é pressionada no objeto (valor padrão)
1 - fmEnterFieldBehaviorRecallSelection: Deixa a seleção inalterada
EnterKeyBehavior
Define o efeito da tecla ENTER no objeto. Se esta propriedade estiver configurada
para Verdadeiro, ao pressionar a tecla ENTER uma nova linha é criada na área de
edição do texto no objeto. Caso contrário, ao pressionar a tecla ENTER o foco é
passado para o próximo objeto da ordem de tabulação. Isto também ocorre se a
propriedade Multiline estiver configurada para Falso, independente do valor da
propriedade EnterKeyBehavior.
A combinação das teclas CTRL + ENTER também depende do valor da propriedade
Multiline. Se esta propriedade estiver configurada para Verdadeiro, ao pressionar
estas teclas uma nova linha é criada na área de edição do texto do objeto,
independente do valor da propriedade EnterKeyBehavior. Se o valor da propriedade
for Falso, as teclas não têm efeito sobre o texto.
Font
A propriedade Font é utilizada para determinar a fonte do objeto Editor de Texto.
Esta propriedade não pode ser utilizada em Associações e contém as mesmas sub-
propriedades descritas na propriedade TextFont dos objetos Texto, Display e
SetPoint.
Visualização 207
HideSelection
A propriedade HideSelection especifica se o texto selecionado continua em
destaque quando um objeto não tem mais o foco. Se a propriedade estiver
configurada para Verdadeiro, o texto selecionado não está em destaque, a menos
que o objeto tenha o foco. Caso contrário, o texto selecionado sempre aparece em
destaque. O valor padrão desta propriedade é Verdadeiro.
IMEMode
A propriedade IMEMode especifica o modo IME (Input Method Editor) de um
objeto. Esta propriedade aplica-se apenas a programas escritos em idiomas
asiáticos (chinês simplificado, chinês tradicional, coreano e japonês) e é ignorada
em outros aplicativos. Foi mantida por motivos de compatibilidade com a
especificação padrão dos objetos Microsoft Forms. As opções disponíveis estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade IMEMode
OPÇÃO DESCRIÇÃO
0 - fmIMEModeNoControl Nã o control a IME (pa drã o)
1 - fmIMEModeOn IME a ti va do
2 - fmIMEModeOff IME des a ti va do. Modo i ngl ês
3 - fmIMEModeDisable IME des a ti va do. O us uá ri o nã o pode
a ti va r IME pel o tecl a do
4 - fmIMEModeHiragana IME a ti va do com modo Hi ra ga na de
l a rgura tota l
5 - fmIMEModeKatakanaFull IME a ti va do com modo Ka ta ka na de
l a rgura tota l
6 - fmIMEModeKatakana IME a ti va do com modo Ka ta ka na de mei a
l a rgura
7 - fmIMEModeAlphaFull IME a ti va do com modo Al fa numéri co de
l a rgura tota l
8 - fmIMEModeAlpha IME a ti va do com modo Al fa numéri co de
mei a l a rgura
9 - fmIMEModeHangulFull IME a ti va do com modo Ha ngul de l a rgura
tota l
10 - fmIMEModeHangul IME a ti va do com modo Ha ngul de mei a
l a rgura
11 - fmIMEModeHanziFull IME a ti va do com modo Ha nzi de l a rgura
tota l
12 - fmIMEModeHanzi IME a ti va do com modo Ha nzi de mei a
l a rgura
IntegralHeight
A propriedade IntegralHeight ajusta a altura da área de edição do texto, caso a
área disponível ultrapasse o tamanho do objeto. Se esta propriedade estiver
configurada para Verdadeiro, a altura da área de edição do texto é reajustada para
coincidir com o tamanho atual do objeto, permitindo assim a exibição completa do
208 Visualização
conteúdo do texto. Caso contrário, a área de edição do texto continua com seu
tamanho original. Se os textos são maiores que o espaço disponível, estes não são
exibidos no objeto.
LineCount
A propriedade LineCount retorna o número de linhas do objeto. Esta propriedade
é acessível apenas em tempo de execução.
Locked
A propriedade Locked habilita ou desabilita a edição do objeto. Se esta
propriedade estiver configurada para Verdadeiro, a edição não é permitida. Caso
contrário, é possível editar o objeto. Os valores configurados na propriedade
Enabled influenciam o comportamento de Locked. Para maiores detalhes, consulte
a propriedade Enabled. O valor padrão desta propriedade é Falso.
MaxLength
A propriedade MaxLength determina o número máximo de caracteres no objeto.
Configurando esta propriedade como 0 (zero), não há limite de caracteres no
objeto.
Multiline
A propriedade Multiline indica se o texto tem múltiplas linhas (Verdadeiro) ou é
uma caixa de texto simples (Falso). Isto pode ser visualizado quando o objeto
Viewer está em execução. O valor padrão desta propriedade é Falso.
PasswordChar
Converte o texto do objeto para um caractere especial, configurado na
propriedade. Utilize esta propriedade para proteger informações sensíveis, como
senhas ou códigos de segurança. O valor de PasswordChar é o caractere
(normalmente um asterisco) que aparece em um objeto, ao invés dos caracteres
reais que o usuário digita. Se não for especificado um caractere, o controle exibe os
caracteres digitados pelo usuário.
ScrollBars
Especifica se o objeto possui barras de rolagem verticais, horizontais ou ambas.
As opções disponíveis são as seguintes:
0 - fmScrollBarNone: Não exibe barras de rolagem
1 - fmScrollBarHorizontal: Exibe uma barra de rolagem horizontal
2 - fmScrollBarVertical: Exibe uma barra de rolagem vertical
Visualização 209
SelectionMargin
Habilita ou desabilita a margem de seleção do objeto. Se esta propriedade estiver
configurada para Verdadeiro, ao clicar na margem do objeto o texto é selecionado.
Caso contrário, ao clicar na margem o texto não é selecionado.
NOTA: Se a propri eda de SelectionMargin es ti ver confi gura da pa ra Verda dei ro qua ndo
o objeto for i mpres s o, a ma rgem de s el eçã o ta mbém é i mpres s a .
SelLength
Retorna o número de caracteres selecionados no objeto. Esta propriedade é
acessível apenas em tempo de execução.
SelStart
Indica o ponto inicial do texto selecionado ou o ponto de inserção, se nenhum
texto for selecionado. Esta propriedade é acessível apenas em tempo de execução.
SelText
Retorna o texto selecionado no objeto. Esta propriedade é acessível apenas em
tempo de execução.
SpecialEffect
A propriedade SpecialEffect especifica a aparência de um objeto. As opções
disponíveis para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade SpecialEffect
OPÇÃO DESCRIÇÃO
0 - fmSpecialEffectFlat O objeto a pa rece pl a no e pos s ui um
des ta que na borda , uma a l tera çã o de cor
ou a mbos .
1 - fmSpecialEffectRaised O objeto pos s ui um des ta que na pa rte
s uperi or es querda e uma s ombra na
pa rte i nferi or di rei ta . O objeto pa rece
es ta r em rel evo.
2 - fmSpecialEffectSunken O objeto pos s ui uma s ombra na pa rte
s uperi or es querda e um des ta que na
pa rte i nferi or di rei ta . O objeto e a s ua
borda pa recem es ta r a funda dos na Tel a .
3 - fmSpecialEffectEtched A borda pa rece es ta r es cul pi da a o redor
da extremi da de do objeto.
6 - fmSpecialEffectBump O objeto pos s ui um res s a l to na pa rte
i nferi or di rei ta e pa rece pl a no na pa rte
s uperi or es querda .
TabKeyBehavior
Determina se as tabulações são permitidas na região de edição. Se a propriedade
210 Visualização
estiver configurada para Verdadeiro, ao pressionar a tecla TAB é inserido um
caractere de espaçamento na região de edição. Caso contrário, ao pressionar TAB,
o foco é passado para o próximo objeto na ordem de tabulação.
Text
Retorna o texto sendo digitado na opção selecionada. Esta propriedade é
acessível apenas em tempo de execução.
TextAlign
Especifica como o texto é alinhado no objeto. As opções disponíveis são as
seguintes:
1 - fmTextAlignLeft: Alinha o texto com a extremidade esquerda do objeto
2 - fmTextAlignCenter: Alinha o texto com o centro do objeto
3 - fmTextAlignRight: Alinha o texto com a extremidade direita do objeto
TextLength
Retorna o número de caracteres digitados no objeto. Esta propriedade é acessível
apenas em tempo de execução.
Value
Este é o texto na área de edição. Esta propriedade é do tipo Variant, e pode
assumir valores de todo e qualquer tipo (Date, Boolean, String, etc.).
WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a Verdadeiro.
4.3.2.12.11.1 Eventos
Visualização 211
SpinUp
SpinUp()
Ocorre quando o usuário pressiona a tecla de seta para cima. Este evento
incrementa a propriedade Value do objeto.
4.3.2.12.11.2 Propriedades
212 Visualização
propriedade é 1 (um).
Value
Número inteiro entre os valores definidos pelas propriedades Min e Max. Indica a
posição inicial do incremento ou decremento. Não aceita valores menores que o
valor de Min, nem maiores que o valor de Max.
4.3.2.12.12.1 Eventos
4.3.2.12.12.2 Propriedades
Visualização 213
Max
A propriedade Max é utilizada para determinar o limite máximo do objeto.
Min
A propriedade Min é utilizada para determinar o limite mínimo do objeto.
Orientation
A propriedade Orientation é utilizada para determinar a orientação do objeto
na Tela. As opções disponíveis para esta propriedade são as seguintes:
-1 - fmOrientationAuto: Determina automaticamente a orientação com base
nas dimensões do objeto, isto é, conforme ele foi criado
0 - fmOrientationVertical: O objeto é disposto verticalmente
1 - fmOrientationHorizontal: O objeto é disposto horizontalmente
4.3.2.13 E2Controls
Esta seção contém informações sobre eventos, métodos e propriedades de objetos
E2Controls.
214 Visualização
4.3.2.13.1.1 Frame_BorderColor
4.3.2.13.1.2 Frame_BorderEnabled
4.3.2.13.1.3 Frame_BorderThickness
4.3.2.13.1.4 Frame_Color
4.3.2.13.1.5 Frame_Enable
4.3.2.13.1.6 Frame_Enable3D
4.3.2.13.1.7 Frame_Separator
4.3.2.13.1.8 Frame_Set3DInset
4.3.2.13.1.9 Frame_Thickness3D
4.3.2.13.1.10 Frame_Title
Visualização 215
4.3.2.13.1.11 Frame_TitleColor
4.3.2.13.1.12 Frame_TitleEnabled
4.3.2.13.1.13 Frame_TitleFont
4.3.2.13.2 E2Animation
Esta seção contém informações sobre propriedades do objeto E2Animation. Este
objeto não possui eventos nem métodos associados.
4.3.2.13.2.1 Propriedades
216 Visualização
Value
Essa propriedade define o valor que determina qual a Zona ativa. O valor padrão
desta propriedade é 0 (zero).
Zones
Coleção de Zonas do objeto E2Animation.
Esta seção contém informações sobre os métodos do objeto Coleção de Zonas. Este
objeto não contém eventos nem propriedades associadas.
Métodos
Esta seção contém informaçõe sobre os métodos do objeto Coleção de Zonas.
Add
Add([AxisName])
Adiciona uma nova Zona na Coleção de Zonas. O parâmetro AxisName é opcional e
não tem efeito, sendo mantido por questões de compatibilidade com versões
anteriores.
Remove
Remove(Index)
Remove uma Zona. O parâmetro Index indica o índice da Zona que deve ser
removida.
Zonas
Define um conjunto de imagens de bitmap que são usadas para criar o efeito de
animação no objeto. As Zonas podem ser configuradas acessando a janela
Propriedades do objeto, na aba E2Animation. As opções dessa janela estão
descritas na tabela a seguir.
Opções disponíveis na aba E2Animation
OPÇÃO DESCRIÇÃO
Zonas Li s ta gem com toda s a s Zona s defi ni da s
no objeto.
Adicionar Adi ci ona uma nova Zona .
Remover Apa ga a Zona s el eci ona da .
Zona Padrão Defi ne a Zona s el eci ona da como a Zona
pa drã o do objeto.
Pisca Defi ne s e o bi tma p pi s ca qua ndo o va l or
do objeto es ti ver dentro do i nterva l o da
Zona .
Dica Mos tra um texto de a juda s obre a Zona .
Visualização 217
OPÇÃO DESCRIÇÃO
Mínimo Va l or míni mo pa ra a va ri a çã o da Zona .
Máximo Va l or má xi mo pa ra a va ri a çã o da Zona .
Arquivo de imagem Nome do a rqui vo de bi tma p que é
mos tra do qua ndo o va l or do objeto
es ti ver dentro do i nterva l o da Zona .
Exemplo Mos tra uma prévi a do a rqui vo de bi tma p
da Zona s el eci ona da .
Propriedades
Esta seção contém informações sobre as propriedades das Zonas do objeto
E2Animation.
Blink
Indica que esta Zona participa do efeito de piscar. O valor padrão desta
propriedade é Falso.
Filename
Indica qual o nome do arquivo de imagem utilizado na Zona.
Maximum
Define o valor máximo para a Zona. O valor padrão desta propriedade é 20000.
Minimum
Define o valor mínimo para a Zona. O valor padrão desta propriedade é 0 (zero).
TipEnable
Habilita ou desabilita a dica para a Zona. O valor padrão desta propriedade é
Falso.
TipText
Define o texto da dica para a Zona. O valor padrão desta propriedade é uma
String em branco.
4.3.2.13.3 E2Bitmap
Esta seção contém informações sobre propriedades do objeto E2Bitmap. Este objeto
não possui eventos nem métodos associados.
4.3.2.13.3.1 Propriedades
4.3.2.13.4 E2Button
Esta seção contém informações sobre eventos e propriedades do objeto E2Button.
Este objeto não possui métodos associados.
4.3.2.13.4.1 Eventos
4.3.2.13.4.2 Propriedades
Visualização 219
propriedade são:
0 - HorizontalAlignmentLeft: Alinha o texto à esquerda
1 - HorizontalAlignmentCenter: Alinha o texto ao centro
2 - HorizontalAlignmentRight: Alinha o texto à direita
Visualização 221
4.3.2.13.5 E2Display
4.3.2.13.5.1 Propriedades
222 Visualização
Especial: Permite formatar números inteiros em bases não decimais
(hexadecimal, octal ou binária, por exemplo)
Outro: Permite editar diretamente o código de formatação desejado, ou
selecionar um formato criado anteriormente
HorizontalAlignment
Define o alinhamento horizontal do texto do E2Display. Os valores desta
propriedade são os seguintes:
0 - HorizontalAlignmentLeft: Alinha horizontalmente à esquerda
1 - HorizontalAlignmentCenter: Alinha horizontalmente ao centro
2 - HorizontalAlignmentRight: Alinha horizontalmente à direita
Visualização 223
objeto
4.3.2.13.6 E2Gauge
Esta seção contém informações sobre propriedades do objeto E2Gauge. Este objeto
não possui eventos nem métodos associados.
4.3.2.13.6.1 Propriedades
224 Visualização
HiHiLimitVisible
Habilita ou desabilita a exibição do limite Muito Alto.
HiLimit
O valor máximo dessa propriedade é 1 (um) e o mínimo é limitado pela
propriedade LowLimit. O valor padrão desta propriedade é 0,7.
HiLimitVisible
Habilita ou desabilita a exibição do limite Alto.
LegendVisible
Exibe uma barra ao longo do objeto E2Gauge, onde podem ser configuradas
diferentes cores, dependendo da faixa de valores. O valor padrão desta
propriedade é Verdadeiro.
LimitVisible
Define se os valores mínimos e máximos da escala aparecem ou não no gráfico.
LowColorLegend
Define a cor da legenda para o limite Baixo. O valor padrão desta propriedade é
verde escuro (RGB(0, 128, 0)).
LowDiv
Marca o início da escala para o limite Baixo. O valor padrão desta propriedade é
6600.
LowLimit
O valor mínimo desta propriedade é 0,1 e o máximo é limitado pela propriedade
HiLimit. O valor padrão desta propriedade é 0,62.
LowLimitVisible
Habilita ou desabilita a exibição do limite Baixo.
LowLowColorLegend
Define a cor da legenda para o limite Muito Baixo. O valor padrão desta
propriedade é verde (RGB(0, 255, 0)).
LowLowDiv
Marca o início da escala para o limite Muito Baixo. O valor padrão desta
propriedade é 3300.
LowLowLimitVisible
Habilita ou desabilita a exibição do limite Muito Baixo.
Visualização 225
Maximum
Define o valor máximo da escala do E2Gauge.
Minimum
Define o valor mínimo da escala do E2Gauge.
NeedleColor
Define a cor do ponteiro do E2Gauge. O valor padrão desta propriedade é branco
(RGB(255, 255, 255)).
NeedleThickness
Define a espessura do ponteiro do E2Gauge, em pixels. O valor padrão desta
propriedade é 2 (dois), e só são aceitos os valores 1 (um) ou 2 (dois).
NormalColor
Define a cor da legenda para o limite Normal. O valor padrão desta propriedade
é oliva (RGB(128, 128, 0)).
NumberOfPoints
Define o número de subdivisões que estão visíveis na escala do objeto.
Orientation
Define a orientação do objeto E2Gauge. Os valores possíveis desta propriedade
são os seguintes:
0 - Left: A parte inferior do objeto está alinhada com o lado esquerdo da
moldura
1 - Up: A parte inferior do objeto está alinhada com a parte de cima da
moldura
2 - Down: A parte inferior do objeto está alinhada com a parte de baixo da
moldura
3 - Right: A parte inferior do objeto está alinhada com o lado direito da
moldura
226 Visualização
StartAngle
Define o ângulo inicial de exibição do ponteiro do objeto E2Gauge.
SubTickColor
Define a cor das subdivisões da escala. O valor padrão desta propriedade é
preto (RGB(0, 0, 0)).
SubTicksVisible
Habilita ou desabilita a exibição das subdivisões da escala.
TextColor
Define a cor do texto da escala. O valor padrão desta propriedade é preto (RGB(0,
0, 0)).
TextFont
A propriedade TextFont é utilizada para determinar a fonte do texto da escala.
Esta propriedade não pode ser utilizada em Associações. Veja a propriedade
TextFont dos objetos Texto, Display e SetPoint para maiores informações sobre as
sub-propriedades que podem ser modificadas via script.
ThickTicks
Habilita ou desabilita a exibição de divisores da escala mais espessos. O valor
padrão desta propriedade é Falso.
TickColor
Define a cor dos divisores da escala. O valor padrão desta propriedade é preto
(RGB(0, 0, 0)).
TicksVisible
Habilita ou desabilita a exibição das divisões da escala.
TickValues
Habilita ou desabilita a exibição dos valores das divisões da escala.
TotalNumberOfSubTicks
Define o número total de subdivisões que são mostradas na escala.
Value
Esta propriedade define um valor entre as propriedades Maximum e Minimum da
escala do objeto.
ValueVisible
Habilita ou desabilita a exibição do valor contido na propriedade Value. O valor
Visualização 227
padrão desta propriedade é Falso.
4.3.2.13.7 E2Setpoint
4.3.2.13.7.1 Propriedades
228 Visualização
optar por até 15 casas decimais, por usar ou não um separador de milhares,
e por apresentar números negativos com sinal ou entre parênteses. Para
números muito grandes ou muito pequenos, recomenda-se utilizar o formato
Científico
Data: Apresenta valores numéricos de data e hora (quando válidos). Para
representar apenas a hora, use o formato equivalente
Hora: Apresenta valores numéricos de hora e data (quando válidos). Para
representar apenas a data, use o formato equivalente
Porcentagem: Multiplica o número por 100 e adiciona o símbolo de
porcentagem. Admite até 15 casas decimais
Científico: Apresenta o número em notação de mantissa e expoente. Ideal
para números de magnitude variada. Admite até 15 casas decimais
Especial: Permite formatar números inteiros em bases não decimais
(hexadecimal, octal ou binária, por exemplo)
Outro: Permite editar diretamente o código de formatação desejado, ou
selecionar um formato criado anteriormente
HorizontalAlignment
Define o alinhamento horizontal do texto do E2Setpoint. Os valores desta
propriedade são os seguintes:
0 - HorizontalAlignmentLeft: Alinha horizontalmente à esquerda
1 - HorizontalAlignmentCenter: Alinha horizontalmente ao centro
2 - HorizontalAlignmentRight: Alinha horizontalmente à direita
Visualização 229
MultiLine
Define se o objeto possui múltiplas linhas ou não. Esta propriedade só está
disponível se a propriedade Value for do tipo String.
ReadOnly
Indica se o objeto pode ser editado ou não em tempo de execução. O valor
padrão desta propriedade é Falso.
Refresh
Indica se o valor do E2Setpoint é atualizado ou não sempre que o valor do Tag
mudar. O valor padrão desta propriedade é Verdadeiro.
SelectAllOnFocus
Habilita ou desabilita a seleção de todos os caracteres do E2Setpoint quando o
objeto recebe o foco. O valor padrão desta propriedade é Verdadeiro.
TextColor
Define a cor do texto do objeto. O valor padrão desta propriedade é preto (RGB(0,
0, 0)).
TextFont
A propriedade TextFont é utilizada para determinar a fonte do objeto. Esta
propriedade não pode ser utilizada Associações. Veja a propriedade TextFont dos
objetos Texto, Display e SetPoint para maiores informações sobre as sub-
propriedades que podem ser modificadas via script.
Type
Define o tipo de Setpoint. Os valores possíveis desta propriedade são os
seguintes:
0 - setpointString: Aceita quaisquer caracteres alfanuméricos
1 - setpointNumeric: Aceita somente caracteres numéricos e o separador
decimal (ponto ou vírgula, dependendo das configurações regionais)
2 - setpointDateTime: Aceita somente valores de data e hora, que são
convertidos para o formato definido nas configurações regionais
230 Visualização
VerticalAlignment
Define o alinhamento vertical do texto do E2Setpoint. Os valores desta
propriedade são os seguintes:
0 - VerticalAlignmentTop: Alinha verticalmente com a parte superior do
objeto
1 - VerticalAlignmentMiddle: Alinha verticalmente com o centro do objeto
2 - VerticalAlignmentBottom: Alinha verticalmente com a parte inferior do
objeto
4.3.2.13.8 E2Text
Esta seção contém informações sobre propriedades do objeto E2Text. Este objeto
não possui eventos nem métodos associados.
4.3.2.13.8.1 Propriedades
Visualização 231
Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Zonas do
E2Text.
Add
Add([AxisName])
Adiciona uma nova Zona na Coleção de Zonas. O parâmetro AxisName é opcional e
não tem efeito, sendo mantido por questões de compatibilidade com versões
anteriores.
Remove
Remove(Index)
Remove uma Zona. O parâmetro Index indica o índice da Zona que deve ser
removida.
Zonas
Define um conjunto de Zonas para o objeto E2Text. Estas Zonas podem ser
configuradas acessando a janela de propriedades do objeto, na aba Zonas. As
opções disponíveis nesta aba estão descritas na tabela a seguir.
Opções disponíveis na aba Zonas
OPÇÃO DESCRIÇÃO
Zonas Li s ta gem com toda s a s Zona s defi ni da s
no objeto.
Adicionar Adi ci ona uma nova Zona .
Remover Remove a Zona s el eci ona da .
Pisca a cada (ms) Defi ne s e o texto e o fundo da Zona
pi s ca m qua ndo o va l or do objeto es ti ver
dentro do i nterva l o da Zona .
Mensagem Texto da mens a gem exi bi da qua ndo o
va l or do objeto es ti ver dentro do
i nterva l o da Zona .
Alinhamento Defi ne o a l i nha mento do texto.
Fonte Defi ne a fonte do texto.
Cor de fundo Defi ne a cor de fundo da Zona .
Transparente Defi ne s e o fundo do objeto é
tra ns pa rente qua ndo a Zona es ti ver
a ti va .
Zona padrão Defi ne a Zona s el eci ona da como a Zona
pa drã o do objeto.
Pisca Defi ne s e a Zona pi s ca qua ndo o va l or
do objeto es ti ver dentro do i nterva l o da
Zona .
Mínimo Va l or míni mo pa ra a Zona .
Máximo Va l or má xi mo pa ra a Zona .
232 Visualização
OPÇÃO DESCRIÇÃO
Dica Mos tra um texto de a juda pa ra a Zona .
Exemplo Mos tra um exempl o do comporta mento
da Zona em tempo de execuçã o.
Visualização 233
0, 0)).
TextFont
Define o estilo, a cor e o tamanho da fonte usada para mostrar o texto da
mensagem. Esta propriedade não pode ser utilizada em Associações. Veja a
propriedade TextFont dos objetos Texto, Display e SetPoint para maiores
informações sobre as sub-propriedades que podem ser modificadas via script.
TipEnable
Habilita ou desabilita a dica para a Zona. O valor padrão desta propriedade é
Falso.
TipText
Define o texto da dica para a Zona. O valor padrão desta propriedade é uma
String vazia.
Transparent
Define que o fundo do objeto é transparente quando esta Zona estiver ativa.
4.3.2.14.1 Métodos
4.3.2.14.1.1 Hide
Hide()
Oculta o Elipse KeyPad. Este método não tem efeito se o KeyPad já está invisível.
4.3.2.14.1.2 Show
Show()
Mostra o Elipse KeyPad. Este método não tem efeito se o KeyPad já está visível na
tela.
4.3.2.14.2 Propriedades
234 Visualização
4.3.2.14.2.1 AutoHideOnEnter
4.3.2.14.2.2 AutoHideOnEsc
4.3.2.14.2.3 Layout
Visualização 235
Exemplo de KeyPad numérico
Exemplo:
' Alterna entre os modos Alfanumérico e Numérico
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
4.3.2.14.2.6 X
4.3.2.14.2.7 Y
4.4 E3Alarm
Esta seção contém informações sobre eventos, métodos e propriedades do objeto
E3Alarm.
4.4.1 Eventos
Esta seção contém informações sobre os eventos do objeto E3Alarm.
4.4.1.1 KeyPress
KeyPress(KeyAscii)
Ocorre quando o E3Alarm tem o foco de teclado e o usuário pressiona uma tecla,
que corresponde a um caractere que pode ser mostrado em tela (uma tecla ANSI, de
código indicado no parâmetro KeyAscii), ou seja, o evento ocorre quando alguma
das teclas a seguir são pressionadas:
Qualquer caractere do teclado que possa ser impresso
Tecla CTRL combinada com qualquer caractere do alfabeto padrão
Tecla CTRL combinada com qualquer caractere especial
Tecla BACKSPACE
Tecla ESC
Visualização 237
Pressionando-se a tecla TAB
Pressionando-se a tecla ENTER
Pressionando-se a tecla DEL (esta tecla não é padrão ANSI)
Pressionando-se as setas do teclado
Quando uma tecla move o foco de um objeto a outro
Enquanto um usuário pressiona uma tecla que produz um código ANSI, o E3Alarm
recebe os eventos KeyDown e KeyPress repetidamente. Quando o usuário libera a
tecla, o evento KeyUp ocorre. Para monitorar o estado físico do teclado ou
manipular teclas não reconhecidas pelo evento KeyPress (como teclas de função,
navegação, etc.), utilize os eventos KeyDown e KeyUp.
4.4.1.2 MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse se move sobre o objeto E3Alarm.
4.4.2 Métodos
Esta seção contém informações sobre os métodos do objeto E3Alarm.
4.4.2.1 AboutBox
AboutBox()
Este método exibe uma caixa de diálogo com informações sobre versão e copyright
do objeto E3Alarm.
4.4.2.2 AckAll
AckAll([Operator])
Permite reconhecer globalmente todos os alarmes. Operator é uma String opcional
que indica o nome do operador que reconheceu o alarme. Este valor é mostrado na
coluna Operator do E3Alarm. Se for omitido, é utilizado o usuário atual do Viewer
ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o reconhecimento
em si é necessário que o usuário logado tenha a permissão Reconhecer alarme.
238 Visualização
4.4.2.3 AckCurrentFilter
AckCurrentFilter([Operator])
Permite reconhecer todos os alarmes do filtro corrente. Operator é uma String
opcional que indica o nome do operador que reconheceu o alarme. Este valor é
mostrado na coluna Operator do E3Alarm. Se for omitido, é utilizado o usuário
atual do Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o
reconhecimento em si é necessário que o usuário logado tenha a permissão
Reconhecer alarme.
4.4.2.4 AckSelected
AckSelected([Operator])
Permite reconhecer os alarmes selecionados. Se não houver alarme selecionado no
E3Alarm, o método falha. O usuário pode reconhecer o alarme (neste caso, é
inserido um novo registro no Banco de Dados indicando o reconhecimento), e no
E3Alarm a linha correspondente indica que ele foi reconhecido. Operator é uma
String opcional que indica o nome do operador que reconheceu o alarme. Este valor
é mostrado na coluna Operator do E3Alarm. Se for omitido, é utilizado o usuário
atual do Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para o
reconhecimento em si é necessário que o usuário logado tenha a permissão
Reconhecer alarme.
4.4.2.5 DeleteUnboundAll
DeleteUnboundAll([Operator])
Permite remover globalmente todos os alarmes não vinculados. Operator é uma
String opcional que indica o nome do operador que removeu o alarme. Este valor é
mostrado na coluna Operator do E3Alarm. Se for omitido, é utilizado o usuário
atual do Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado. Para a
remoção em si é necessário que o usuário logado tenha a permissão Remover
alarmes desvinculados.
4.4.2.6 DeleteUnboundCurrentFilter
DeleteUnboundCurrentFilter([Operator])
Permite remover todos os alarmes não vinculados do filtro corrente. Operator é
uma String opcional que indica o nome do operador que removeu o alarme. Este
valor é mostrado na coluna Operator do E3Alarm. Se for omitido, é utilizado o
usuário atual do Viewer ou "(Sem usuário)", caso não haja nenhum usuário logado.
Para a remoção em si é necessário que o usuário logado tenha a permissão
Remover alarmes desvinculados.
Visualização 239
4.4.2.7 DeleteUnboundSelected
DeleteUnboundSelected([Operator])
Permite remover os alarmes não vinculados selecionados. Se não houver alarme
não vinculado selecionado no E3Alarm, este método falha. O usuário pode remover
o alarme (neste caso, é inserido um novo registro no Banco de Dados indicando a
remoção), e no E3Alarm a linha correspondente indica que ele foi removido.
Operator é uma String opcional que indica o nome do operador que reconheceu o
alarme. Este valor é mostrado na coluna Operator do E3Alarm. Se for omitido, é
utilizado o usuário atual do Viewer ou "(Sem usuário)", caso não haja nenhum
usuário logado. Para a remoção em si é necessário que o usuário logado tenha a
permissão Remover alarmes desvinculados.
4.4.2.8 GetEventByIndex
GetEventByIndex(Index)
Retorna um objeto Evento de uma Coleção de Eventos, especificado pelo parâmetro
Index, que corresponde ao índice do objeto na Coleção. Para mais informações
sobre as propriedades do objeto retornado por este método, consulte o tópico
Evento - Propriedades.
4.4.2.9 GetFocusedEvent
GetFocusedEvent()
Este método retorna um objeto com as propriedades do evento selecionado (aquele
que tem o foco atual) no E3Alarm, caso haja algum evento selecionado. Se nenhum
evento estiver selecionado, o método retorna um objeto Nothing.
As propriedades do objeto retornado contém os valores dos campos do evento
selecionado. O objeto contém uma cópia dos valores no momento da chamada do
método. Portanto, se houver uma mudança no evento selecionado, as propriedades
não são atualizadas automaticamente, e é necessário utilizar este método sempre
que houver necessidade de obter informações atualizadas do evento selecionado.
As propriedades do objeto retornado por este método estão descritas no tópico
Evento - Propriedades.
4.4.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto E3Alarm.
240 Visualização
4.4.3.1 ActiveAlarms
Determina o número total de alarmes ativos no E3Alarm. Esta propriedade é
somente de leitura.
4.4.3.2 ActiveHighAlarms
Indica o número de alarmes ativos com severidade Alta. Esta propriedade é
somente de leitura.
4.4.3.3 ActiveHighNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Alta. Esta
propriedade é somente de leitura.
4.4.3.4 ActiveLowAlarms
Indica o número de alarmes ativos com severidade Baixa. Esta propriedade é
somente de leitura.
4.4.3.5 ActiveLowNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Baixa. Esta
propriedade é somente de leitura.
4.4.3.6 ActiveMedAlarms
Indica o número de alarmes ativos com severidade Média. Esta propriedade é
somente de leitura.
4.4.3.7 ActiveMedNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Média. Esta
propriedade é somente de leitura.
4.4.3.8 ActiveNACKAlarms
Indica o número total de alarmes que estão sem reconhecimento no E3Alarm
(ativos ou não). Esta propriedade é somente de leitura.
4.4.3.9 AlarmCount
Determina o número de alarmes no E3Alarm. Esta propriedade é somente de
leitura.
Visualização 241
4.4.3.10 AlarmServer
Nome do Servidor de Alarmes único existente na aplicação.
4.4.3.11 AllowAckAll
Habilita ou desabilita a opção Reconhecimento no menu contextual do E3Alarm,
que permite o reconhecimento de todos os alarmes. O valor padrão desta
propriedade é Verdadeiro.
4.4.3.12 AllowAckCurrentFilter
Habilita ou desabilita o item Todos os alarmes do filtro corrente da opção
Reconhecimento no menu contextual do E3Alarm, que permite o reconhecimento de
todos os alarmes do filtro atual. Se não houver alarmes visíveis, esta propriedade
não tem efeito. O valor padrão desta propriedade é Verdadeiro.
4.4.3.13 AllowAckSelected
Habilita ou desabilita o item Apenas os alarmes selecionados da opção
Reconhecimento no menu contextual do E3Alarm, que permite o reconhecimento de
alarmes selecionados. Se não houver alarmes selecionados, esta propriedade não
tem efeito. O valor padrão desta propriedade é Verdadeiro.
4.4.3.14 AllowColumnClick
Habilita ou desabilita a seleção dos campos e a direção de ordenação destes,
através do clique no cabeçalho das colunas do E3Alarm em tempo de execução. Se
esta opção estiver configurada para Verdadeiro e o cabeçalho estiver visível (veja a
propriedade ColumnHeader), ao clicar no título da coluna os dados são ordenados,
tendo esta coluna como chave. Clicando novamente nesta mesma coluna, a
ordenação é realizada na direção contrária (muda-se a ordem ascendente para
descendente e vice-versa). Ao clicar na coluna com a tecla SHIFT pressionada, o
campo é usado como segunda chave. Como na chave primária, um segundo clique
com SHIFT inverte a ordenação do campo secundário.
4.4.3.15 AllowDeleteUnboundAlarms
Habilita ou desabilita a opção Deletar alarmes desvinculados no menu contextual
do E3Alarm, que permite remover alarmes não vinculados. Se não houver alarmes
não vinculados, esta propriedade não tem efeito. O valor padrão desta propriedade
é Verdadeiro.
242 Visualização
4.4.3.16 AreaFilter
Controla as áreas de alarmes visíveis no E3Alarm. Se seu valor não for uma String
vazia, são apresentados eventos cujo nome das Áreas comecem com o texto
indicado. Por exemplo, se AreaFilter é igual a "Ana", são mostrados os alarmes de
Áreas como "Analogicos.Producao" ou "Analise", mas não "Digitais.Analise" ou
"Digitais.Producao". Quando a propriedade SimpleAreaFilter estiver configurada
como Falso, a Área de Alarme também permite o uso de coringas para a filtragem (*
ou ?), e permite múltiplos filtros de Área, separados por dois pontos. Os coringas
permitidos são:
"*": Aceita nenhum ou qualquer quantidade de caracteres
"?": Aceita um caractere qualquer
"#": Aceita um dígito qualquer
"[ ]": Permite especificar um conjunto de caracteres
"[ab]": Aceita um caractere se for "a" ou "b"
"[f-h]": Aceita um caractere entre "f" e "h"
"[!cz]": Aceita um caractere que não seja nem "c" nem "z"
"[!m-p]": Aceita um caractere que não esteja entre "m" e "p"
O padrão desta propriedade é uma String vazia, ou seja, sem filtragem por Área
(veja também as propriedades CustomFilter, SimpleAreaFilter, ShowHighPriority,
ShowMediumPriority e ShowLowPriority).
NOTA: A propri eda de AreaFilter corres ponde à propri eda de Filter, di s ponível a té a
vers ã o 4.0 do El i ps e Power.
4.4.3.17 BannerMode
Habilita a visualização de apenas uma mensagem no E3Alarm. A mensagem
mostrada depende da configuração de ordenação e sempre está selecionada. O
valor padrão desta propriedade é Falso. Para mais informações sobre a
configuração de ordenação, consulte o tópico Aba Ordenação, no Manual do
Usuário do Elipse Power.
4.4.3.18 BorderColor
Define a cor da borda do E3Alarm. O valor padrão desta propriedade é preto
(RGB(0, 0, 0)).
Visualização 243
4.4.3.19 BorderThickness
Define a espessura da borda do E3Alarm. O valor desta propriedade pode variar
entre 0 (zero, que desabilita a borda) e 10, e seu padrão é 1 (um).
4.4.3.20 ColumnHeader
Quando configurada como Verdadeiro, esta propriedade habilita a visualização
do cabeçalho do E3Alarm. O cabeçalho também permite que seja realizada a
reordenação dos dados da tabela visualmente (veja a propriedade
AllowColumnClick). O valor padrão desta propriedade é Verdadeiro.
4.4.3.21 Connections
Retorna uma coleção de Conexões no E3Alarm. Para mais informações sobre a
coleção retornada nesta propriedade, consulte o tópico Coleção de Conexões.
4.4.3.22 ConnectionStatusBarColor
Especifica a cor da barra de status de conexões do E3Alarm. O valor padrão
desta propriedade é preto (RGB(0, 0, 0)).
4.4.3.23 CustomFilter
Permite informar um filtro personalizado para os alarmes, na forma de uma
expressão. Os seguintes campos estão disponíveis para utilização na expressão do
filtro:
Acked (Booleano): Indica se esta mensagem já foi reconhecida
AckRequired (Booleano): Indica se é necessário reconhecer esta mensagem
AckTime (Data): Data e hora em que a condição de alarme foi reconhecida
(ou zero se não foi reconhecida)
ActiveSource (Inteiro): -1: None, 0: ActiveSource, 1: Scada, 2: Operator, 3:
CCLink, 4: Billing, 5: Calculated, 6: Database, 100: TopologyProcessor, 101:
PowerFlow, 102: StateEstimator, 103: LoadShedding, 104:
DistLoadModelling, 105: SelfHealing ou 106: ExternalReader
ActorID (String): Login do usuário que reconheceu a mensagem (ou uma
String vazia se a mensagem ainda não foi reconhecida)
AlarmSourceName (String): Nome do objeto Fonte de Alarme (apenas o nome,
não o caminho completo)
Area (String): Área deste alarme
ChangeMask (Inteiro): Campo não utilizado pelo Elipse Power atualmente,
244 Visualização
sempre em 0 (zero)
ConditionActive (Booleano): Indica se a condição de alarme está ativa
ConditionName (String): Nome da última condição de alarme ativa
Cookie (Inteiro): Identifica uma Fonte de Alarme durante uma sessão de
execução
CurrentValue (Double): Valor da Fonte no momento em que a condição de
alarme ficou ativa
Enabled (Booleano): Indica se a verificação de alarmes na Fonte de Alarme
está habilitada
EventCategory (String): Nome da categoria do alarme (por exemplo, "Nível",
"Taxa de Variação", "Banda Morta", "Digital" ou "Discreto")
EventTime (Data): Data e hora da última atualização do evento
EventTimeUTC (Data): Data e hora da última atualização do evento
EventType (String): "Event" (evento) ou "Condition" (alarme)
FormattedValue (String): Contém o valor (formatado) da Fonte no momento
em que a condição de alarme ficou ativa
FullAlarmSourceName (String): Nome completo do objeto Fonte de Alarme
InTime (Data): Data e hora em que a condição de alarme ficou ativa
Message (String): Mensagem do alarme
OutTime (Data): Data e hora em que a condição saiu de alarme (ou zero se
ainda está ativa)
Quality (String): "Boa (xxx)", "Ruim (xxx)" ou "Incerta (xxx)"
Severity (Inteiro): 0: Alta, 1: Média ou 2: Baixa
Source (String): Link da Fonte de Alarme
SubConditionName (String): Nome da sub-condição de alarme (por exemplo,
"LOLO", "LO", "HI", "HIHI", "DIG", etc.)
4.4.3.24 Domain
Especifica o Domínio ao qual o E3Alarm se conecta. O padrão desta propriedade
é uma String vazia, ou seja, o E3Alarm se conecta ao mesmo Domínio do Viewer
onde ele se encontra. Por exemplo, "\\NomedeOutroServidor".
4.4.3.25 Events
Retorna uma coleção de eventos no E3Alarm. Para mais informações sobre a
coleção retornada nesta propriedade, consulte o tópico Coleção de Eventos.
4.4.3.26 Filters
Retorna uma coleção de Filtros no E3Alarm. Para mais informações sobre a
coleção retornada nesta propriedade, consulte o tópico Coleção de Filtros.
4.4.3.27 FilterType
Efetua os filtros de alarme. As opções disponíveis são as seguintes:
1 - OnlyAlarms: Mostra apenas alarmes
2 - OnlyEvents: Mostra apenas eventos
3 - AlarmsAndEvents: Mostra tanto alarmes quanto eventos
246 Visualização
4.4.3.28 Font
Determina a fonte (tipo de letra) do cabeçalho e das linhas do E3Alarm. Esta
propriedade é somente de leitura e só pode ser modificada via Studio, não em
tempo de execução.
4.4.3.29 FourthSortAscending
Quando esta propriedade estiver configurada para Falso, a ordenação de eventos
pelo campo quaternário é no sentido descendente. Caso contrário, o sentido é
ascendente. O valor padrão desta propriedade é Falso.
4.4.3.30 FourthSortField
Determina o campo quaternário para a ordenação dos eventos no E3Alarm. O
nome do campo deve ser sempre especificado em inglês (veja os campos
disponíveis no Manual do Usuário do Elipse Power). O valor padrão desta
propriedade é uma String vazia. Esta propriedade não tem efeito quando as
propriedades PrimarySortField, SecondarySortField ou ThirdSortField forem
configuradas como uma String vazia.
4.4.3.31 GridBkColor
Esta propriedade determina a cor de fundo do E3Alarm. O valor padrão desta
propriedade é a cor configurada no Windows para o item Janela (Painel de Controle
- Vídeo - Aparência - Avançada).
4.4.3.32 InactiveHighNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Alta.
Esta propriedade é somente de leitura.
4.4.3.33 InactiveLowNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Baixa.
Esta propriedade é somente de leitura.
4.4.3.34 InactiveMedNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Média.
Esta propriedade é somente de leitura.
4.4.3.35 InactiveNACKAlarms
Determina o número total de alarmes inativos e não reconhecidos. Esta
propriedade é somente de leitura.
Visualização 247
4.4.3.36 PictureConnected
Caminho de um arquivo de imagem com o ícone para representar uma Conexão
da Coleção de Conexões do E3Alarm conectada com sucesso a um Servidor de
Alarmes. O valor padrão desta propriedade é uma String vazia (o E3Alarm
apresenta o ícone na barra de status para esta Conexão).
4.4.3.37 PictureNotConnected
Caminho de um arquivo de imagem com o ícone para representar uma Conexão
da Coleção de Conexões do E3Alarm não conectada a um Servidor de Alarmes. O
valor padrão desta propriedade é uma String vazia (o E3Alarm apresenta o ícone
na barra de status para esta Conexão).
4.4.3.38 PictureUnknown
Caminho de um arquivo de imagem com o ícone para representar uma Conexão
da Coleção de Conexões do E3Alarm com o status indefinido. O valor padrão desta
propriedade é uma String vazia (o E3Alarm apresenta o ícone na barra de status
para esta Conexão).
NOTA: O s ta tus i ndefi ni do i ndi ca que o E3Al a rm nã o recebeu uma confi rma çã o do
Servi dor de Al a rmes de que a conexã o teve s uces s o. Es te é o s ta tus pa drã o pa ra
vers ões a nteri ores à 4.7.
4.4.3.39 PopupMenu
Habilita um menu contextual ao clicar com o botão direito do mouse no objeto
E3Alarm. O valor padrão desta propriedade é Verdadeiro.
4.4.3.40 PrimarySortAscending
Quando esta propriedade estiver configurada para Falso, a ordenação de eventos
pelo campo primário é no sentido descendente. Caso contrário, o sentido é
ascendente. O valor padrão desta propriedade é Falso.
4.4.3.41 PrimarySortField
Determina o campo primário para a ordenação dos eventos no E3Alarm. O nome
do campo deve ser sempre especificado em inglês (veja os campos disponíveis no
Manual do Usuário do Elipse Power). O valor padrão desta propriedade é
"EventTime". Quando esta propriedade é uma String vazia, as propriedades
SecondarySortField, ThirdSortField e FourthSortField não têm efeito.
248 Visualização
4.4.3.42 SecondarySortAscending
Quando esta propriedade estiver configurada para Verdadeiro, a ordenação de
eventos pelo campo secundário é no sentido ascendente. Caso contrário, o sentido
é descendente. O valor padrão desta propriedade é Falso.
4.4.3.43 SecondarySortField
Determina o campo secundário para a ordenação dos eventos no E3Alarm. O
nome do campo deve ser sempre especificado em inglês (veja os campos
disponíveis no Manual do Usuário do Elipse Power). O valor padrão desta
propriedade é uma String vazia. Esta propriedade não tem efeito quando a
propriedade PrimarySortField for configurada como uma String vazia.
4.4.3.44 ShowConnectionStatusBar
Mostra ou esconde a barra de status de conexões do E3Alarm. O valor padrão
desta propriedade é Falso.
4.4.3.45 ShowHighPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Alta. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Verdadeiro.
4.4.3.46 ShowLowPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Baixa. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Verdadeiro.
4.4.3.47 ShowMediumPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Média. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Verdadeiro.
4.4.3.48 SimpleAreaFilter
Quando esta propriedade for igual a Verdadeiro, o comportamento de filtragem
pelo nome de Área de Alarmes é baseado apenas na coincidência da parte inicial
do nome. Quando for igual a Falso, o comportamento leva em conta todo o nome da
Área, mas permite o uso de caracteres coringa e múltiplos filtros de área, que
Visualização 249
devem ser separados por dois pontos. Veja também a propriedade AreaFilter, que
especifica o filtro por nome de área.
4.4.3.49 ThirdSortAscending
Quando esta propriedade estiver configurada para Falso, a ordenação de eventos
pelo campo terciário é no sentido descendente. Caso contrário, o sentido é
ascendente. O valor padrão desta propriedade é Falso.
4.4.3.50 ThirdSortField
Determina o campo terciário para a ordenação dos eventos no E3Alarm. O nome
do campo deve ser sempre especificado em inglês (veja os campos disponíveis no
Manual do Usuário do Elipse Power). O valor padrão desta propriedade é uma String
vazia. Esta propriedade não tem efeito quando as propriedades PrimarySortField ou
SecondarySortField forem configuradas como uma String vazia.
NOTA: A Col eçã o de Conexões pode s er a ces s a da a tra vés da propri eda de Connections
dos objetos Filtro de Alarmes e E3Alarm.
4.4.4.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Conexões.
4.4.4.1.1 Add
Add(ConnectionName)
Adiciona uma nova Conexão com o nome informado no parâmetro ConnectionName
e retorna a Conexão criada. Caso o usuário tente criar uma Conexão com um nome
já existente, uma mensagem de erro é mostrada. Para gerar um nome
automaticamente, deixe o parâmetro ConnectionName em branco.
4.4.4.1.2 Item
Item(Index)
Retorna um objeto Conexão da Coleção de Conexões, especificado pelo parâmetro
Index. Este parâmetro pode ser numérico, se corresponder ao índice do objeto na
Coleção, ou textual, se corresponder ao nome da Conexão (propriedade
ConnectionName do objeto Conexão).
250 Visualização
4.4.4.1.3 Remove
Remove(Index)
Remove um objeto Conexão da Coleção de Conexões através de seu nome ou índice,
especificado pelo parâmetro Index. A Conexão de índice 0 (zero) não pode ser
removida. Caso o usuário tente removê-la, uma mensagem de erro é mostrada.
4.4.4.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de
Conexões.
4.4.4.2.1 Count
Contém o número total de Conexões na Coleção de Conexões. Esta propriedade é
somente de leitura.
4.4.4.3 Conexão
Esta seção contém informações sobre as propriedades do objeto Conexão da
Coleção de Conexões. Este objeto não possui eventos nem métodos associados.
4.4.4.3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Conexão da
Coleção de Conexões.
4.4.4.3.1.1 AlarmServer
Nome do Servidor de Alarmes, que pode estar tanto em um Domínio local quanto
em um Domínio remoto.
4.4.4.3.1.2 ConnectionName
4.4.4.3.1.3 ConnectionStatus
Visualização 251
não está configurado corretamente
3 - Servidor de Alarmes não configurado: O Servidor de Alarmes (propriedade
AlarmServer) não está configurado
4 - Erro inesperado: Houve um erro inesperado na Conexão
5 - Status não identificado: Não foi possível receber uma confirmação da
conexão com o Servidor de Alarmes. Possivelmente o Servidor de Alarmes
está em um Domínio remoto com uma versão do E3 anterior à 4.7
4.4.4.3.1.4 DomainName
4.4.4.3.1.5 FilterConnection
NOTA: A Col eçã o de Eventos pode s er a ces s a da a tra vés da propri eda de Events dos
objetos Filtro de Alarmes e E3Alarm.
4.4.5.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Eventos.
4.4.5.1.1 Item
Item(Index)
Retorna um objeto Evento da Coleção de Eventos, especificado pelo parâmetro
Index. Este parâmetro pode ser numérico, se corresponder ao índice do objeto na
Coleção, ou textual, se corresponder ao nome da Fonte de Alarme (propriedade
AlarmSourceName do objeto Evento).
4.4.5.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de
Eventos.
252 Visualização
4.4.5.2.1 Count
4.4.5.3 Evento
Esta seção contém informações sobre as propriedades do objeto Evento da Coleção
de Eventos. Este objeto não possui eventos nem métodos associados.
4.4.5.3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Evento da Coleção
de Eventos.
4.4.5.3.1.1 Acked
4.4.5.3.1.2 AckRequired
4.4.5.3.1.3 AckTime
4.4.5.3.1.4 ActiveSource
4.4.5.3.1.5 ActorID
4.4.5.3.1.6 AlarmSourceName
4.4.5.3.1.7 Area
4.4.5.3.1.8 ConditionActive
4.4.5.3.1.9 ConditionName
Se o evento não for um alarme esta propriedade é sempre uma String vazia. Esta
propriedade é somente de leitura.
4.4.5.3.1.10 CurrentValue
4.4.5.3.1.11 Deleted
254 Visualização
4.4.5.3.1.12 DomainName
4.4.5.3.1.13 Enabled
4.4.5.3.1.14 EventCategory
4.4.5.3.1.15 EventCLSID
4.4.5.3.1.16 EventTime
4.4.5.3.1.17 EventTimeUTC
Visualização 255
4.4.5.3.1.18 EventType
4.4.5.3.1.19 FormattedValue
Mostra o valor formatado da Fonte de Alarme que vai para o evento. Esta
propriedade é somente de leitura.
4.4.5.3.1.20 FullAlarmSourceName
4.4.5.3.1.21 InTime
4.4.5.3.1.22 Message
4.4.5.3.1.23 OutTime
4.4.5.3.1.24 Quality
Se o evento não for um alarme esta propriedade é igual a uma String vazia.
Exemplo: "Ruim (0)", "Incerta (64)", "?? (128)", ou "Boa (192)".
256 Visualização
4.4.5.3.1.25 Severity
4.4.5.3.1.26 Source
4.4.5.3.1.27 SubConditionName
Se o evento não for um alarme esta propriedade é igual a uma String vazia. Esta
propriedade é somente de leitura.
4.4.5.3.1.28 Unbound
4.4.5.3.1.29 UserField
NOTA: A Col eçã o de Fi l tros pode s er a ces s a da a tra vés da propri eda de Filters dos
objetos Filtro de Alarmes e E3Alarm.
4.4.6.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Filtros.
4.4.6.1.1 Add
Add(FilterName)
Adiciona um novo Filtro com o nome informado no parâmetro FilterName e retorna
o Filtro criado. Caso o usuário tente criar um Filtro com um nome já existente, uma
mensagem de erro é mostrada. Para gerar um nome automaticamente, deixe o
parâmetro FilterName em branco.
4.4.6.1.2 Item
Item(Index)
Retorna um objeto Filtro da Coleção de Filtros, especificado pelo parâmetro Index.
Este parâmetro pode ser numérico, se corresponder ao índice do objeto na Coleção,
ou textual, se corresponder ao nome do Filtro (propriedade FilterName do objeto
Filtro).
4.4.6.1.3 Remove
Remove(Index)
Remove um objeto Filtro da Coleção de Filtros através de seu nome ou índice,
especificado pelo parâmetro Index. O Filtro de índice 0 (zero) não pode ser
removido. Caso o usuário tente removê-lo, uma mensagem de erro é mostrada.
4.4.6.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Filtros.
4.4.6.2.1 Count
258 Visualização
4.4.6.3 Filtro
Esta seção contém informações sobre as propriedades do objeto Filtro da Coleção
de Filtros. Este objeto não possui eventos nem métodos associados.
4.4.6.3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Filtro da Coleção
de Filtros.
4.4.6.3.1.1 AreaFilter
Controla as áreas de alarmes visíveis no Filtro. Se seu valor não for uma String
vazia, são apresentados eventos cujo nome das Áreas comecem com o texto
indicado. Por exemplo, se AreaFilter é igual a "Ana", são mostrados os alarmes de
Áreas como "Analogicos.Producao" ou "Analise", mas não "Digitais.Analise" ou
"Digitais.Producao". Quando a propriedade SimpleAreaFilter estiver configurada
como Falso, a Área de Alarme também permite o uso de coringas para a filtragem (*
ou ?), e permite múltiplos filtros de Área, separados por dois pontos. Os coringas
permitidos são:
"*": Aceita nenhum ou qualquer quantidade de caracteres
"?": Aceita um caractere qualquer
"#": Aceita um dígito qualquer
"[ ]": Permite especificar um conjunto de caracteres
"[ab]": Aceita um caractere se for "a" ou "b"
"[f-h]": Aceita um caractere entre "f" e "h"
"[!cz]": Aceita um caractere que não seja nem "c" nem "z"
"[!m-p]": Aceita um caractere que não esteja entre "m" e "p"
O padrão desta propriedade é uma String vazia, ou seja, sem filtragem por área
(veja também as propriedades CustomFilter, SimpleAreaFilter, ShowHighPriority,
ShowMediumPriority e ShowLowPriority).
4.4.6.3.1.2 CustomFilter
260 Visualização
Severity (Inteiro): 0: Alta, 1: Média ou 2: Baixa
Source (String): Link da Fonte de Alarme
SubConditionName (String): Nome da sub-condição de alarme (por exemplo,
"LOLO", "LO", "HI", "HIHI", "DIG", etc.)
4.4.6.3.1.3 FilterName
4.4.6.3.1.4 FilterType
4.4.6.3.1.5 ShowHighPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Alta. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Visualização 261
Verdadeiro.
4.4.6.3.1.6 ShowLowPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Baixa. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Verdadeiro.
4.4.6.3.1.7 ShowMediumPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Média. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Verdadeiro.
4.4.6.3.1.8 SimpleAreaFilter
4.5 E3Browser
Esta seção contém informações sobre eventos, métodos e propriedades do objeto
E3Browser.
4.5.1 Eventos
Esta seção contém informações sobre os eventos do objeto E3Browser.
4.5.1.1 KeyPress
KeyPress(KeyAscii)
Ocorre quando o E3Browser tem o foco de teclado e o usuário pressiona uma tecla,
que corresponde a um caractere que pode ser mostrado em tela (uma tecla ANSI, de
código indicado na variável KeyAscii). Ou seja, o evento ocorre quando alguma das
teclas a seguir são pressionadas:
Qualquer caractere do teclado que possa ser impresso
Tecla CTRL combinada com qualquer caractere do alfabeto padrão
262 Visualização
Tecla CTRL combinada com qualquer caractere especial
Tecla BACKSPACE
Tecla ESC
Enquanto um usuário pressiona uma tecla que produz um código ANSI, o E3Browser
recebe os eventos KeyDown e KeyPress repetidamente. Quando o usuário libera a
tecla, o evento KeyUp ocorre. Para monitorar o estado físico do teclado ou
manipular teclas não reconhecidas pelo evento KeyPress (como teclas de função,
navegação, etc.), utiliza-se os eventos KeyDown e KeyUp.
4.5.1.2 MouseMove
MouseMove()
Ocorre quando o ponteiro do mouse se move sobre o objeto E3Browser.
4.5.1.3 OnDrawRow
OnDrawRow(Selected, Line, TextColor, BackColor)
Este evento passa quatro parâmetros: Selected indica se a linha está selecionada;
Line indica o número da linha sendo desenhada; TextColor indica a cor do texto da
linha; e BackColor indica a cor de fundo do texto. Se a cor for modificada dentro
deste evento, esta modificação será usada pelo E3Browser no desenho da linha.
Outra modificação importante é que se o método GetColumnValue for chamado de
dentro do evento, os valores retornados serão os da linha sendo desenhada, e não
os da linha selecionada.
Visualização 263
4.5.1.4 OnFormatCell
OnFormatCell(Column, FieldName, OriginalValue, FormattedValue)
Este evento permite personalizar o formato do texto das células do E3Browser. Os
parâmetros deste evento são os seguintes:
Column: Índice da coluna visível do E3Browser (iniciando em 0). Permite
identificar a coluna da célula que está sendo formatada
FieldName: Texto com o nome do campo da coluna sendo formatada
OriginalValue: Valor não formatado da célula, do tipo Variant
FormattedValue: Valor formatado, do tipo Variant, de acordo com a configuração
da coluna do E3Browser. Se for modificado dentro do evento, permite alterar o
texto formatado
4.5.2 Métodos
Esta seção contém informações sobre os métodos do objeto E3Browser.
4.5.2.1 AboutBox
AboutBox()
Este método exibe uma caixa de diálogo com informações sobre versão e copyright
do objeto E3Browser.
264 Visualização
4.5.2.2 ClearFields
ClearFields()
Limpa a formatação de colunas e linhas do E3Browser.
4.5.2.3 GetColumnValue
GetColumnValue(Index)
Retorna o valor de uma célula, na coluna informada e na linha selecionada. Este
método possui o parâmetro Index, que determina o índice da coluna desejada.
4.5.2.4 Requery
Requery()
O método Requery atualiza a Consulta, utilizando sua configuração atual, e retorna
os dados para o E3Browser.
4.5.2.5 RetrieveE3QueryFields
RetrieveE3QueryFields()
O método RetrieveE3QueryFields lê a estrutura de dados da consulta e atualiza a
formatação do E3Browser, com os campos definidos na consulta. Se for bem
sucedido, retorna True. Caso contrário, retorna False. Este método é especialmente
útil quando se precisa usar um único E3Browser para exibir dados de diferentes
tabelas ou consultas.
4.5.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto E3Browser.
4.5.3.1 AllowColumnResize
Habilita ou desabilita a configuração do tamanho das colunas da grade do
objeto, em tempo de execução. Se esta propriedade estiver configurada para False,
o tamanho das colunas é fixo e não poderá ser modificado.
4.5.3.2 AllowRowResize
Habilita ou desabilita a configuração do tamanho das linhas da grade do objeto,
em tempo de execução. Se esta propriedade estiver configurada para False, o
tamanho das linhas é fixo e não poderá ser modificado.
Visualização 265
4.5.3.3 ColumnWidth
Determina a largura das colunas do E3Browser, em pixels.
4.5.3.4 CurSel
Indica a posição atual do cursor do E3Browser, ou seja, o índice da linha em que
ele está posicionado.
4.5.3.5 E3Query
Retorna o objeto Consulta do E3Browser, para que se possa acessar suas
propriedades.
4.5.3.6 Fields
Retorna o objeto Campos do E3Browser, que contém a lista com todos os
campos da tabela, tornando possível a sua referência através dos itens dessa
coleção. O valor padrão desta propriedade é vazio. Exemplo:
Sub E3Browser1_Click()
' Troca a cor do campo Campo1
Set fields = Screen.Item("E3Browser").Fields
Set campo1 = fields.Item("Campo1")
campo1.BkColor = RGB(255, 0, 0) ' Vermelho
' Mostra quantos campos tem o E3Browser
MsgBox fields.Count
' Mostra o nome dos campos do E3Browser
For Each field In fields
MsgBox field.Name
Next
End Sub
4.5.3.7 FixedBkColor
Especifica a cor do fundo da primeira coluna do E3Browser. O valor padrão
desta propriedade é a cor bege (RGB(236, 233, 216)).
4.5.3.8 FixedColumnWidth
Determina a largura da primeira coluna do E3Browser, em pixels. O valor padrão
desta propriedade é 30 pixels.
4.5.3.9 FixedRowFont
Determina a fonte (texto) utilizada na linha de cabeçalho do E3Browser. Esta
propriedade não pode ser utilizada em scripts ou em Associações, sendo
configurada somente via Studio. O valor padrão desta propriedade é a fonte Arial.
266 Visualização
4.5.3.10 FixedRowHeight
Determina a altura (em pixels) da linha de cabeçalho do E3Browser. O valor
padrão desta propriedade é 20.
4.5.3.11 FixedTextColor
Muda a cor do cabeçalho do E3Browser.
4.5.3.12 GridBkColor
Determina a cor de fundo da área de dados do E3Browser. O valor padrão desta
propriedade é a cor branca (RGB(255, 255, 255)).
4.5.3.13 GridFont
Determina a fonte utilizada nos textos da área de dados do E3Browser. O valor
padrão desta propriedade é a fonte Arial. Esta propriedade não pode ser utilizada
em scripts ou em Associações, sendo configurada somente via Studio.
4.5.3.14 GridLineColor
Determina a cor das linhas da grade de dados do E3Browser. O valor padrão
desta propriedade é cinza (RGB(192, 192, 192)).
4.5.3.15 GridLinesType
Determina o tipo de linhas a serem desenhadas na grade de dados do
E3Browser.
Opções disponíveis para GridLinesType
OPÇÃO DESCRIÇÃO
0 - GLNone Sem l i nha s s epa ra dora s .
1 - GLHorz Somente a s l i nha s hori zonta i s (pa drã o).
2 - GLVert Somente a s l i nha s verti ca i s .
3 - GLBoth Li nha s verti ca i s e hori zonta i s .
4.5.3.16 RefreshTime
Especifica o tempo de atualização da Consulta em relação ao Banco de Dados.
Através desta propriedade é possível verificar as atualizações dos dados no
Histórico relacionado, referente a um determinado tempo estipulado (em
milissegundos). Quando a propriedade RefreshTime for igual a 0, não há
atualização dos dados, e eles permanecem inalterados.
Visualização 267
4.5.3.17 RowHeight
Define a altura das linhas da E3Browser, em pixels. O valor padrão desta
propriedade é 20.
4.5.3.18 SelectRow
Estabelece a possibilidade de seleção das linhas do E3Browser. Se estiver
configurada para True, será possível selecionar as linhas; do contrário, as linhas
não podem ser selecionadas.
4.5.3.19 SourceQuery
Contém a referência para o objeto Consulta ao qual o E3Browser está associado.
4.5.3.20 TextBkColor
Especifica a cor de fundo das células de dados do E3Browser. O valor padrão
desta propriedade é a cor branca (RGB(255, 255, 255)).
4.5.3.21 TextColor
Especifica a cor do texto do E3Browser. O valor padrão desta propriedade é a cor
preta (RGB(0,0,0)).
4.5.3.22 TitleTipBkColor
Especifica a cor do fundo do texto da dica do E3Browser. O valor padrão desta
propriedade é a cor preta (RGB(0, 0, 0)).
4.5.3.23 TitleTipTextColor
Especifica a cor do texto da dica do E3Browser. O valor padrão desta
propriedade é a cor cinza (RGB(204, 204, 204)).
4.5.3.24 ToolbarBkColor
Especifica a cor de fundo da barra de funções do E3Browser. O valor padrão
desta propriedade é bege (RGB(236, 233, 216)).
268 Visualização
4.5.3.25 ToolbarFont
Determina a fonte utilizada nos textos da barra de funções do E3Browser. Esta
propriedade não pode ser utilizada em scripts ou em Associações, sendo
configurada somente via Studio.
4.5.3.26 ToolbarForeColor
Especifica a cor de frente da barra de funções do E3Browser. O valor padrão
desta propriedade é preto (RGB(0, 0, 0)).
4.5.4.1 Propriedades
Esta seção contém informações sobre as propriedades dos campos do objeto
E3Browser.
4.5.4.1.1 BkColor
Determina a cor de fundo do campo do E3Browser. O valor padrão é a cor
configurada no Windows para o item Janela do Painel de Controle (Painel de
Controle - Vídeo - Aparência - Avançada).
4.5.4.1.2 Color
Retorna a cor do texto do campo. O valor padrão dessa propriedade é preto
(RGB(0, 0, 0)).
4.5.4.1.3 Format
4.5.4.1.4 Name
Retorna o nome do campo.
4.5.4.1.5 Visible
4.6 E3Chart
Esta seção contém informações sobre eventos, métodos e propriedades do objeto
E3Chart.
4.6.1 Eventos
Esta seção contém informações sobre os eventos do objeto E3Chart.
4.6.1.1 OnCursorChange
OnCursorChange()
Ocorre quando o cursor do E3Chart muda de posição. Por exemplo, pode-se criar
um script para este evento quando for necessário mostrar os valores de posição do
cursor na Tela. Exemplo:
Sub E3Chart1_OnCursorChange()
Set Chart = Application.GetFrame("").Screen.Item("E3Chart1")
Set Pena = Chart.Pens.Item(0)
' O objeto Text1 deve mostrar a posição atual do cursor
Set Texto = Application.GetFrame("").Screen.Item("Text1")
If Pena.GetCursorPos(aa, bb) Then
Texto.Value = "Posição X = " & aa & "; Posição Y = " & bb
End If
End Sub
4.6.1.2 OnLegendClick
OnLegendClick(Row, Col, RowData)
Ocorre quando o usuário clica em uma linha da Legenda. Os parâmetros Row e Col
indicam, respectivamente, a linha e a coluna clicadas. O parâmetro RowData é o
índice da Pena da Legenda onde ocorreu o clique. Exemplo:
Sub E3Chart1_OnLegendClick(Row, Col, RowData)
Set texto = Screen.Item("Texto1")
texto.Value = Legend.Item(col).Name & " " & _
Pens.Item(RowData).name
End Sub
4.6.1.3 OnQueryFinish
OnQueryFinish()
Ocorre quando uma ou mais Consultas são encerradas no objeto. Quando o evento
270 Visualização
é gerado, a chamada dos métodos FitAll ou FitPen pode causar problemas caso se
esteja utilizando a Consulta automática, já que estes métodos ativam outras
Consultas até que todos os dados sejam lidos. Neste caso, é recomendado que o
valor passado pelos parâmetros destes métodos seja 1 (um), o que enquadra
verticalmente as Penas.
4.6.2 Métodos
Esta seção contém informações sobre os métodos do objeto E3Chart.
4.6.2.1 ClearPenMarks
ClearPenMarks()
Remove as marcas de pesquisa de todas as Penas do E3Chart.
4.6.2.2 CopyConfig
CopyConfig(SourceChart[, Flags])
O método CopyConfig copia as configurações de um E3Chart para outro. O
parâmetro SourceChart indica o E3Chart de origem, cujas propriedades são
copiadas para o E3Chart que chamou o método.
NOTA: No ca s o dos Rel a tóri os , o método CopyConfig funci ona s omente com Pena s do
ti po Histórica.
Por exemplo, para copiar a configuração de um E3Chart que está em uma Tela
(ScreenChart) para outro que está dentro de um Relatório (ReportChart), o
seguinte script pode ser adicionado no objeto Report associado ao Relatório.
Sub OnBeforePrint
Set Chart = _
Report.Sections("PageHeader").Controls("ReportChart")
Chart.CopyConfig(Application.GetFrame()._
Screen.Item("ScreenChart"))
Chart.LoadData()
Chart.FitAll()
End Sub
4.6.2.3 FitAll
FitAll([FitStyle])
Enquadra todas as Penas no E3Chart. O parâmetro opcional FitStyle indica o modo
Visualização 271
de enquadramento das Penas em tempo de execução:
0: Enquadra ambos os Eixos ao mesmo tempo
1: Enquadra apenas o Eixo Vertical
2: Enquadra apenas o Eixo Horizontal
4.6.2.4 FitPen
FitPen(Pen[, FitStyle])
Enquadra uma Pena no E3Chart, especificada pelo índice ou pelo nome. O
parâmetro Pen define a Pena a ser enquadrada no E3Chart (índice ou nome da
Pena). O parâmetro opcional FitStyle indica o modo de enquadramento das Penas
em tempo de execução:
0: Enquadra ambos os Eixos ao mesmo tempo
1: Enquadra apenas o Eixo Vertical
2: Enquadra apenas o Eixo Horizontal
Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.FitPen(1)
Chart.FitPen("Pen1", 1)
' Enquadra a Pen1 somente na vertical
End Sub
4.6.2.5 LoadData
LoadData()
Carrega os dados no E3Chart. Este método é especialmente usado para carregar os
dados antes de imprimir, quando usado em um objeto Relatório.
4.6.2.6 ResetConfig
ResetConfig([Flags])
Remove todas as configurações ajustadas em um E3Chart, devolvendo-o ao estado
inicial.
272 Visualização
NOTA: Es te método ta mbém pos s ui o pa râ metro opci ona l e nã o us a do Flags,
s omente pa ra fi ns de compa ti bi l i da de com vers ões a nteri ores .
4.6.2.7 ShowCursors
ShowCursors()
Ativa o modo Pesquisa de Intervalo. Em tempo de execução, este recurso pode ser
acessado clicando com o botão direito do mouse no objeto e selecionando a opção
Pesquisar Intervalos do menu contextual.
4.6.2.8 ZoomIn
ZoomIn()
O método ZoomIn aumenta o zoom no E3Chart, isto é, aproxima a visualização das
Penas. Em tempo de execução, este recurso pode ser acessado clicando com o
botão direito do mouse no E3Chart e selecionando a opção Mais Zoom do menu
contextual.
4.6.2.9 ZoomOut
ZoomOut()
O método ZoomOut diminui o zoom no E3Chart, isto é, afasta a visualização das
Penas no E3Chart. Em tempo de execução, este recurso pode ser acessado clicando
com o botão direito do mouse no E3Chart e selecionando a opção Menos Zoom do
menu contextual.
4.6.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto E3Chart.
4.6.3.1 Axes
Retorna a coleção de Eixos do E3Chart. A partir daí, as propriedades da coleção
de Eixos podem ser modificadas.
4.6.3.2 BackColor
Determina a cor de fundo do E3Chart. Para que esta cor apareça, a propriedade
ShowBackground deve estar configurada como Verdadeiro. O valor padrão desta
propriedade é bege (RGB(236, 233, 216)).
4.6.3.3 CursorBegin
Define a posição do cursor inicial, entre 0 (zero) e 1 (um). É necessário executar o
método ShowCursors ou habilitar a opção Pesquisa de Intervalos para que os
Visualização 273
cursores apareçam.
4.6.3.4 CursorColor
Estabelece a cor do cursor de pesquisa de intervalo. O valor padrão é vermelho
(RGB(255, 0, 0)).
4.6.3.5 CursorEnd
Define a posição do cursor final, entre 0 (zero) e 1 (um). É necessário executar o
método ShowCursors ou habilitar a opção Pesquisa de Intervalos para que os
cursores apareçam.
4.6.3.6 CursorLineStyle
Estilo de linha do cursor de pesquisa de intervalo. As opções disponíveis estão
descritas na tabela a seguir.
Opções disponíveis para CursorLineStyle
OPÇÃO DESCRIÇÃO
0 - LS_Solid Apl i ca uma l i nha s ól i da no curs or de
i nterva l o do E3Cha rt.
1 - LS_Dash Apl i ca uma l i nha tra ceja da no curs or de
i nterva l o do E3Cha rt.
2 - LS_Dot Apl i ca uma l i nha ponti l ha da no curs or
de i nterva l o do E3Cha rt.
3 - LS_Dashdot Apl i ca uma l i nha tra ço e ponto no curs or
de i nterva l o do E3Cha rt.
4 - LS_Dashdotdot Apl i ca uma l i nha tra ço ponto ponto no
curs or de i nterva l o do E3Cha rt.
5 - LS_Null Apl i ca uma l i nha i nvi s ível no curs or de
i nterva l o do E3Cha rt.
4.6.3.7 CursorLineWidth
Estabelece a largura do cursor de intervalo.
4.6.3.8 CursorSearchStyle
Permite que o cursor pesquise os pontos do gráfico, de acordo com as seguintes
opções:
0 - PointNearest: Pesquisa o ponto mais próximo
1 - LinearInterpolation: Pesquisa um ponto interpolado
2 - PointPrevious: Pesquisa o ponto anterior
274 Visualização
4.6.3.9 ForeColor
Determina a cor de frente do E3Chart. O valor padrão desta propriedade é preto
(RGB(0, 0, 0)).
4.6.3.10 GridBkColor
Determina a cor de fundo da grade do E3Chart. O valor padrão desta propriedade
é branco (RGB(255, 255, 255)). Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.GridBkColor
MsgBox "Próxima"
E3Chart1.GridBkColor = RGB(0, 255, 0)
MsgBox "Voltar"
E3Chart1.GridBkColor = Old
End Sub
4.6.3.11 HorAxisTitle
Determina o título do Eixo Horizontal principal. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1= Screen.Item("E3Chart1")
Old = E3Chart1.HorAxisTitle
MsgBox "Próxima"
E3Chart1.HorAxisTitle = "!Teste"
MsgBox "Voltar"
E3Chart1.HorAxisTitle = Old
End Sub
4.6.3.12 HorGrid
Determina o tipo de linha aplicada na grade horizontal do E3Chart. As opções
disponíveis estão descritas na tabela a seguir.
Opções disponíveis para HorGrid
OPÇÃO DESCRIÇÃO
0 - Solid Apl i ca uma l i nha s ól i da na gra de
hori zonta l do E3Cha rt.
1 - Dash Apl i ca uma l i nha tra ceja da na gra de
hori zonta l do E3Cha rt.
2 - Dot Apl i ca uma l i nha ponti l ha da na gra de
hori zonta l do E3Cha rt (pa drã o).
3 - Dashdot Apl i ca uma l i nha tra ço e ponto na gra de
hori zonta l do E3Cha rt.
4 - Dashdotdot Apl i ca uma l i nha tra ço ponto ponto na
gra de hori zonta l do E3Cha rt.
Visualização 275
OPÇÃO DESCRIÇÃO
5 - Invisible Apl i ca uma l i nha i nvi s ível na gra de
hori zonta l do E3Cha rt.
Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.HorGrid
For i = 0 To 5
E3Chart1.HorGrid = i
MsgBox "E3Chart1.HorGrid =" & CStr(i)
Next
MsgBox "Voltar"
E3Chart1.HorGrid = Old
End Sub
4.6.3.13 HorGridColor
Determina a cor da grade horizontal do objeto E3Chart. O valor padrão desta
propriedade é cinza (RGB(192, 192, 192)). Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.HorGridColor = RGB(255, 0, 0)
MsgBox "Próxima"
E3Chart1.HorGridColor = RGB(255, 0, 0)
MsgBox "Próxima"
E3Chart1.HorGridColor = RGB(0, 0, 255)
MsgBox "Voltar"
E3Chart1.HorGridColor = Old
End Sub
4.6.3.14 HorMinorTicks
Determina o número de subdivisões das escalas horizontais da grade. O valor
padrão desta propriedade é 1 (um). Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.HorMinorTicks
For i = 0 To 5
E3Chart1.HorMinorTicks = i
MsgBox "Próximo valor"
Next
E3Chart1.HorMinorTicks = Old
End Sub
276 Visualização
4.6.3.15 HorScaleBegin
Determina o valor inicial aplicado na escala horizontal principal da grade. Este
valor pode ser numérico para E3Charts XY, ou Data para E3Charts com escala de
tempo fixa. Para E3Charts de tempo real, esta propriedade não é aplicada, sendo
então utilizada a propriedade TimeSpan.
4.6.3.16 HorScaleEnd
Determina o valor final aplicado na escala horizontal principal da grade. Este
valor pode ser numérico para E3Charts XY, ou Data para E3Charts com escala de
tempo fixa. Para E3Charts de tempo real, esta propriedade não é aplicada, sendo
então utilizada a propriedade TimeSpan. Exemplo:
Sub ComboBox1_Change()
' Define qual consulta deseja mostrar
current_query_index = ListIndex
Set E3Chart1 = Screen.Item("E3Chart1")
i = 0
For Each query In E3Chart1.Queries
If i = current_query_index Then
query.FieldFilter(0) = "" ' Traz tudo
Set current_query = query
Else
query.FieldFilter(0) = "<0" ' Não traz nada para
' não 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
Contém um texto que representa uma máscara, dentro da qual os valores da
escala horizontal são mostrados. Esta máscara pode representar vários tipos de
valores:
Geral: Não possui formatação específica, adaptando-se automaticamente ao
valor especificado
Número: Apresenta números com parte inteira e fracionária. O usuário pode
optar por até 15 casas decimais, por usar ou não um separador de milhares
Visualização 277
e por apresentar números negativos com sinal ou entre parênteses. Para
números muito grandes ou muito pequenos, recomenda-se utilizar o formato
Científico
Data: Apresenta valores numéricos de data e hora (quando válidos). Para
representar apenas a hora, use o formato equivalente
Hora: Apresenta valores numéricos de hora e data (quando válidos). Para
representar apenas a data, use o formato equivalente
Porcentagem: Multiplica o número por 100 e adiciona o símbolo de
porcentagem. Admite até 15 casas decimais
Científico: Apresenta o número em notação de mantissa e expoente. Ideal
para números de magnitude variada. Admite até 15 casas decimais
Especial: Permite formatar números inteiros em bases não decimais
(hexadecimal, octal ou binária, por exemplo)
Outro: Permite editar diretamente o código de formatação desejado, ou
selecionar um formato criado anteriormente
4.6.3.18 HorTickUnit
Determina o número de subdivisões entre as marcas da grade. Quando esta
propriedade estiver com o valor 0 (zero), o espaçamento é automático. Exemplo:
Sub SubCommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.HorTickUnit
For i = 0 To 30 Step 10
E3Chart1.HorTickUnit = i
MsgBox "E3Chart1.HorTickUnit = " & CStr(i)
Next
MsgBox "Voltar"
E3Chart1.HorTickUnit = Old
End Sub
4.6.3.19 Legend
Retorna o objeto Legenda do E3Chart. A partir daí, as propriedades da Legenda
podem ser modificadas.
4.6.3.20 MouseMode
Seleciona uma das opções de tempo de execução do menu contextual do
E3Chart. Os valores possíveis para essa propriedade são os seguintes:
278 Visualização
0 - MouseModeZoom: Coloca o mouse em modo Zoom por área selecionada.
Esta opção está disponível nos gráficos de escala numérica em XY e escala
fixa. Equivale a selecionar a opção Caixa de Zoom do menu em tempo de
execução do E3Chart
1 - MouseModePan: Coloca o mouse em modo de movimentação das escalas.
Equivale a selecionar a opção Mover do menu em tempo de execução do
E3Chart
2 - MouseModePanH: Coloca o mouse em modo de movimentação das
escalas somente na direção horizontal. Equivale a selecionar a opção Mover
horizontalmente do menu em tempo de execução do E3Chart
3 - MouseModeSearch: Coloca o mouse em modo de pesquisa de valores nos
dados das Penas. Equivale a selecionar a opção Pesquisar do menu em
tempo de execução do E3Chart
4 - MouseModeCursors: Habilita a opção de pesquisa de intervalos de
tempo. Equivale a selecionar a opção Pesquisar Intervalos do menu em tempo
de execução do E3Chart
4.6.3.21 Padding
Esta propriedade determina a distância, em pixels, entre o gráfico e a borda do
objeto E3Chart, conforme pode ser observado nas figuras seguintes através das
setas vermelhas. O valor padrão desta propriedade é 10. Exemplo:
Visualização 279
Propriedade Padding igual a 10
280 Visualização
Propriedade Padding igual a 30
4.6.3.22 Pens
Retorna o objeto Coleção de Penas do E3Chart. O objeto Coleção de Penas é
utilizado para inserir, remover ou acessar as Penas disponíveis no E3Chart. Esta
propriedade é somente de leitura. Exemplo:
Sub CommandButton1_Click()
For Each pen In Screen.Item("E3Chart1").Pens
pen.Visible = True
Next
End Sub
4.6.3.23 Queries
Retorna o objeto Coleção de Consultas dentro do E3Chart. O objeto Coleção de
Consultas é utilizado para inserir, remover ou acessar as Consultas disponíveis no
E3Chart. Esta propriedade é somente de leitura.
4.6.3.24 RefreshTime
Esta propriedade determina o tempo de atualização do E3Chart.
Visualização 281
4.6.3.25 ScaleFont
Determina a fonte do texto utilizada na grade. Exemplo:
Sub CommandButton1_Click()
Screen.Item("E3Chart1").ScaleFont = "Times New Roman"
Screen.Item("E3Chart1").ScaleFont.Size = 12
Screen.Item("E3Chart1").ScaleFont.Italic = True
End Sub
4.6.3.26 ShowBackground
Habilita ou desabilita a visualização do fundo do gráfico. Se a propriedade for
igual a Verdadeiro, o fundo do gráfico é mostrado. Caso contrário, o gráfico
permanece com o fundo transparente. A cor selecionada na propriedade BackColor
não aparece se esta propriedade estiver em Falso (opção padrão). Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
E3Chart1.ShowBackground = Not E3Chart1.ShowBackground
End Sub
4.6.3.27 ShowBottomScale
Se a propriedade estiver configurada para Verdadeiro, o Eixo Horizontal
principal é mostrado na base da grade. Caso contrário, não é mostrado. O valor
padrão é Verdadeiro. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
oldBottomScale = E3Chart1.ShowBottomScale
MsgBox "Mostrar eixo"
E3Chart1.ShowBottomScale = True
MsgBox "Esconder eixo"
E3Chart1.ShowBottomScale = False
MsgBox "Voltar..."
E3Chart1.ShowBottomScale = oldBottomScale
End Sub
4.6.3.28 ShowGridBackground
Habilita ou desabilita a visualização do fundo da grade. Se a propriedade for
igual a Verdadeiro (padrão), o fundo da grade é mostrado. Caso contrário, a grade
permanece com o fundo transparente. A cor selecionada na propriedade
GridBkColor não aparece se esta propriedade estiver em Falso. Exemplo:
Sub CommandButton1_Click()
Set Chart1 = Screen.Item("E3Chart1")
Chart1.ShowGridBackground = Not Chart1.ShowGridBackground
End Sub
282 Visualização
4.6.3.29 ShowLeftScale
Se a propriedade estiver configurada para Verdadeiro, o Eixo Vertical principal é
mostrado à esquerda da grade. Caso contrário, permanece invisível. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.ShowLeftScale = Not Chart.ShowLeftScale
End Sub
4.6.3.30 ShowPopupMenu
Habilita ou desabilita a opção de mostrar o menu em tempo de execução do
E3Chart. Se o valor for igual a Verdadeiro, o menu é mostrado quando o usuário
clicar com o botão direito do mouse no gráfico do E3Chart. Se o valor for igual a
Falso, o menu não é mostrado. O valor padrão desta propriedade é Verdadeiro.
4.6.3.31 ShowRightScale
Se a propriedade estiver configurada para Verdadeiro, o Eixo Vertical principal
da escala é mostrado à direita da grade. Caso contrário, permanece invisível.
Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.ShowRightScale = Not Chart.ShowRightScale
End Sub
4.6.3.32 ShowTitle
Se a propriedade estiver configurada para Verdadeiro, o título principal do
E3Chart é visível. Caso contrário, permanece invisível. A propriedade Title contém o
título que é mostrado no E3Chart. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
oldTitle = E3Chart1.Title
oldShowTitle = E3Chart1.ShowTitle
E3Chart1.Title = "Teste!"
MsgBox "Mostrar"
E3Chart1.ShowTitle = True
MsgBox "Esconder"
E3Chart1.ShowTitle = False
MsgBox "Voltar"
E3Chart1.Title = oldTitle
E3Chart1.ShowTitle = oldShowTitle
End Sub
Visualização 283
4.6.3.33 ShowTopScale
Se a propriedade estiver configurada para Verdadeiro, o Eixo Horizontal
principal é mostrado no topo da grade. Caso contrário, não é mostrado. O valor
padrão é Falso. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Chart.ShowTopScale = Not Chart.ShowTopScale
End Sub
4.6.3.34 TimeSpan
Indica a escala de tempo que aparece no Eixo Horizontal principal do E3Chart,
quando este for configurado para mostrar a escala de tempo real. O valor desta
propriedade é sempre em segundos. O valor padrão desta propriedade é 60.
4.6.3.35 Title
Determina o título principal do E3Chart. Para que o título apareça no E3Chart, a
propriedade ShowTitle deve ser configurada para Verdadeiro.
4.6.3.36 TitleFont
Determina a fonte do título principal do E3Chart. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
E3Chart1.Title = "Teste"
E3Chart1.ShowTitle = True
MsgBox "Troca fonte"
E3Chart1.TitleFont = "Times New Roman"
MsgBox "Troca tamanho"
E3Chart1.TitleFont.Size = 20
End Sub
4.6.3.37 VerAxisTitle
Determina o título do Eixo Vertical principal.
4.6.3.38 VerGrid
Determina o tipo de linha a ser aplicada na grade vertical do E3Chart. As opções
disponíveis estão descritas na tabela a seguir.
Opções disponíveis para VerGrid
OPÇÃO DESCRIÇÃO
0 - Solid Apl i ca uma l i nha s ól i da na gra de verti ca l
do E3Cha rt.
284 Visualização
OPÇÃO DESCRIÇÃO
1 - Dash Apl i ca uma l i nha tra ceja da na gra de
verti ca l do E3Cha rt.
2 - Dot Apl i ca uma l i nha ponti l ha da na gra de
verti ca l do E3Cha rt (pa drã o).
3 - Dashdot Apl i ca uma l i nha tra ço e ponto na gra de
verti ca l do E3Cha rt.
4 - Dashdotdot Apl i ca uma l i nha tra ço ponto ponto na
gra de verti ca l do E3Cha rt.
5 - Invisible Apl i ca uma l i nha i nvi s ível na gra de
verti ca l do E3Cha rt.
4.6.3.39 VerGridColor
Determina a cor da linha do Eixo Vertical principal da grade. O valor padrão
desta propriedade é cinza (RGB(192, 192, 192)).
4.6.3.40 VerMinorTicks
Determina o número de subdivisões entre as marcas do Eixo Vertical principal da
grade. O valor padrão desta propriedade é 1 (um).
4.6.3.41 VerScaleBegin
Determina o valor no topo no Eixo Vertical principal da grade do E3Chart. O valor
padrão desta propriedade é 100.
4.6.3.42 VerScaleEnd
Determina o valor na base do Eixo Vertical principal da grade. O valor padrão
desta propriedade é -100.
4.6.3.43 VerScaleFormat
Contém um texto que representa uma máscara, dentro da qual os valores da
escala vertical são mostrados. Esta máscara pode representar vários tipos de
valores:
Geral: Não possui formatação especifica, adaptando-se automaticamente ao
valor especificado
Número: Apresenta números com parte inteira e fracionária. O usuário pode
optar por até 15 casas decimais, por usar ou não um separador de milhares
e por apresentar números negativos com sinal ou entre parênteses. Para
números muito grandes ou muito pequenos, recomenda-se utilizar o formato
Científico
Data: Apresenta valores numéricos de data e hora (quando válidos). Para
Visualização 285
representar apenas a hora, use o formato equivalente
Hora: Apresenta valores numéricos de hora e data (quando válidos). Para
representar apenas a data, use o formato equivalente
Porcentagem: Multiplica o número por 100 e adiciona o símbolo de
porcentagem. Admite até 15 casas decimais
Científico: Apresenta o número em notação de mantissa e expoente. Ideal
para números de magnitude variada. Admite até 15 casas decimais
Especial: Permite formatar números inteiros em bases não decimais
(hexadecimal, octal e binária, por exemplo)
Outro: Permite editar diretamente o código de formatação desejado, ou
selecionar um formato criado anteriormente
4.6.3.44 VerTickUnit
Determina o número de subdivisões entre as marcas da grade. Quando esta
propriedade estiver com o valor 0 (zero), o espaçamento é automático. Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
Old = E3Chart1.VerTickUnit
For i = 0 To 30 Step 10
E3Chart1.VerTickUnit = i
MsgBox "E3Chart1.VerTickUnit = " & CStr(i)
Next
MsgBox "Voltar"
E3Chart1.VerTickUnit = Old
End Sub
4.6.4.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Penas.
NOTA: A Col eçã o de Pena s do E3Cha rt deve s er a ces s a da a tra vés da propri eda de
Pens.
286 Visualização
4.6.4.1.1 AddPen
AddPen(PenName)
O método AddPen adiciona uma nova Pena ao E3Chart, retornando a Pena criada.
Exemplo:
Sub CommandButton1_Click()
' Cria uma pena sem nome.
Set Pen = Screen.Item("E3Chart1").Pens.AddPen("")
MsgBox Pen.Name
End Sub
SubCommandButton1_DbClick()
' Cria uma pena com o nome "Pen1".
' Se o nome existir, a pena é incrementada.
Sub CommandButton2_Click()
' Cria uma pena e associa a TagDemo1.
Set Chart = Screen.Item("E3Chart1")
Set Pen = Chart.Pens.AddPen("")
MsgBox Pen.Name
Pen.UsetimeStamp = True
Pen.YLink = "Dados.TagDemo1"
Pen.Connect()
End Sub
4.6.4.1.2 ChangePenPos
ChangePenPos(Source, Dest)
Modifica a ordem de desenho das Penas no E3Chart. Este método possui os
seguintes parâmetros:
Source: Determina o índice da Pena a ser movida (começando em um)
Dest: Determina o destino da Pena (começando em um)
Uma situação em que este método é especialmente útil é quando tem-se uma Pena
com o desenho de linha e outra com o desenho de área. Se a Pena de área for
desenhada depois da Pena de linha, ela pode esconder esta última. A solução então
seria inverter a ordem de desenho destas Penas. Exemplo:
Sub CommandButton1_Click()
' Move a pena 1 para a posição 2.
Screen.Item("E3Chart1").Pens.ChangePenPos(1, 2)
End Sub
Visualização 287
4.6.4.1.3 Item
Item(Index)
O método Item retorna um objeto Pena da Coleção de Penas, especificado pelo
índice. Este método possui o parâmetro Index, que pode ser do tipo numérico (se
corresponder ao índice da Pena) ou texto (se corresponder ao nome da Pena).
Exemplo:
Sub CommandButton1_Click()
' Obtém a primeira pena.
Set Pen1 = Screen.Item("E3Chart1").Pens.Item(0)
End Sub
4.6.4.1.4 Remove
Remove(Index)
Remove uma Pena da Coleção de Penas, especificada pelo nome ou pelo índice. Este
método possui o parâmetro Index, que pode ser do tipo numérico (se corresponder
ao índice da Pena) ou texto (se corresponder ao nome da Pena).
4.6.4.1.5 SetCursorPos
SetCursorPos(X, Range)
Posiciona o cursor de cada Pena do E3Chart. Equivale ao comportamento de
chamar o método SetCursorPos de cada Pena.
4.6.4.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Penas.
4.6.4.2.1 Count
Contém o número total de Penas inseridas no E3Chart. Esta propriedade é
somente de leitura.
4.6.4.3 Penas
Esta seção contém informações sobre métodos e propriedades do objeto Pena. Este
objeto não possui eventos associados.
4.6.4.3.1 Métodos
288 Visualização
4.6.4.3.1.1 AddPoint
4.6.4.3.1.2 Clear
Clear()
Apaga os dados do buffer de tempo real, sem diminuir seu tamanho. Este método
não desconecta Associações, nem tampouco remove dados históricos.
4.6.4.3.1.3 Connect
Connect()
O método Connect faz a Pena conectar-se ao servidor para receber os dados de
tempo real, associando as propriedades XLink e YLink. Se a Pena já estiver
conectada, o método permanece inativo. Exemplo:
Sub CommandButton1_Click()
Set Pen1 = Screen.Item("E3Chart1").Pens.Item("Pen1")
Pen1.Disconnect()
Pen1.Connect()
End Sub
4.6.4.3.1.4 Disconnect
Disconnect()
O método Disconnect limpa os dados atuais e faz com que a Pena não receba mais
os dados de tempo real do seu Tag associado. Se a Pena já estiver desconectada o
método permanece inativo. Quando o método Disconnect é usado em uma Pena
Mista (DataSourceType igual a 2), ele remove a parte de tempo real, permanecendo
a parte histórica. Em tempo de execução, para que os dados de tempo real sejam
mostrados novamente é preciso utilizar o método Connect. Exemplo:
Sub CommandButton1_Click()
Set Pen1 = Screen.Item("E3Chart1").Pens.Item("Pen1")
Pen1.Disconnect()
Pen1.Connect()
End Sub
Visualização 289
4.6.4.3.1.5 GetCursorPos
GetCursorPos(X, Y)
Retorna a posição em que o cursor interceptou a Pena no E3Chart. Este método
possui os parâmetros X e Y, que correspondem às coordenadas x e y do cursor. Se o
método for bem sucedido retorna Verdadeiro, caso contrário retorna Falso.
Exemplo:
Sub CommandButton1_Click()
For Each pen In Chart.Pens
If pen.GetCursorPos(aa, bb) Then
strResult = strResult & pen.name_
& " := " & CSTr(CDate(aa)) + _
"y " + CStr(bb) + vbNewLine
End If
Next
MsgBox strResult
End Sub
4.6.4.3.1.6 GetPoint
GetPoint(ValueX, ValueY)
Retorna as coordenadas X e Y do ponto mais próximo ao valor de entrada em
ValueX. O parâmetro ValueX informa o valor de referência para a busca do ponto, e
depois recebe o valor efetivo da coordenada X do ponto mais próximo encontrado.
O parâmetro ValueY retorna o valor efetivo da coordenada Y do ponto mais próximo
encontrado. O método retorna Verdadeiro se encontrou um ponto, e Falso caso
contrário.
4.6.4.3.1.7 SetCursorPos
SetCursorPos(X, Range)
Posiciona o cursor da Pena do E3Chart. O parâmetro X indica em qual posição o
cursor deve ser posicionado, similar ao comportamento de mover o cursor na
pesquisa com o mouse. O cursor é movido para a posição mais próxima indicada
por X. O parâmetro Range é opcional e usado como validação. O cursor só é
movido se o ponto válido estiver dentro do intervalo. Qualquer valor negativo
indica que o intervalo passado não deve ser usado. Exemplo:
' Existindo um ponto válido 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)
Este método retorna Verdadeiro se o cursor foi movido, caso contrário retorna
Falso.
4.6.4.3.2 Propriedades
4.6.4.3.2.1 AutoQuery
Visualização 291
NOTA: Di ferentemente da pa rte de tempo rea l , onde ca da Pena pos s ui s eu própri o
buffer de da dos , a pa rte hi s tóri ca da Pena é a rma zena da na Cons ul ta e é
compa rti l ha da entre a s Pena s . Por exempl o, qua ndo uma Cons ul ta tem três
ca mpos , E3Timestamp, Campo1 e Campo2, es tes da dos fi ca m a rma zena dos dentro da
Cons ul ta e es tã o à di s pos i çã o pa ra a s Pena s que compa rti l ha m a quel a Cons ul ta .
Com i s to, a pa rte comum, gera l mente o ca mpo E3Timestamp, pode s er us a da por
dua s Pena s di ferentes , s em que os da dos s eja m dupl i ca dos . No ca s o da s Pena s
Automá ti ca s , dua s Pena s di ferentes podem us a r a mes ma ta bel a e, devi do a
es ca l a s di ferentes , el a s podem ca rrega r períodos di ferentes da Cons ul ta . Nes ta
s i tua çã o, ca da Pena herda a utoma ti ca mente a pa rte ca rrega da pel a outra Pena .
O objeto Cons ul ta nã o pode funci ona r s i mul ta nea mente em modo Automático e Não
Automático. Is to s i gni fi ca ta mbém que s e Pena s di ferentes , uma Automá ti ca e outra
Nã o Automá ti ca , qui s erem compa rti l ha r a mes ma Cons ul ta , es ta Cons ul ta va i s e
a da pta r à pri mei ra Pena que uti l i zá -l a . Ou s eja , a propri eda de AutoQuery nã o
ga ra nte que a Cons ul ta é do ti po Automático, dependendo ta mbém de outros
fa tores .
4.6.4.3.2.2 AverageY
4.6.4.3.2.3 BkColor
Determina a cor de fundo usada em uma Pena do tipo Área. O valor padrão desta
propriedade é vazio.
4.6.4.3.2.4 BufferSize
Determina o número de pontos mantidos na Pena de tempo real. Após este valor,
os dados mais antigos são descartados. Nas Penas históricas, esta propriedade
não tem efeito. Esta propriedade é considerada somente após a conexão da Pena.
Para maiores informações, veja o método Connect. O valor padrão desta
propriedade é 1000, e deve ser sempre maior que 0 (zero). Exemplo:
Sub CommandButton1_Click()
Set Pen1 = Screen.Item("E3Chart1").Pens.Item("Pen1")
Pen1.Disconnect()
Pen1.BufferSize = 5000
Pen1.Connect()
End Sub
292 Visualização
4.6.4.3.2.5 Color
4.6.4.3.2.6 DataSourceType
NOTA: Em tempo de execuçã o, qua ndo a propri eda de for a l tera da e a Pena dei xa r
de mos tra r os da dos de tempo rea l , é preci s o uti l i za r o método Connect pa ra que
es tes da dos s eja m mos tra dos nova mente.
Exemplo:
Sub CommandButton1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
MsgBox "Clique OK para criar a pena."
Set Pen = E3Chart1.Pens.AddPen("Pen1")
Pen.DataSourceType = 0 ' Tempo real
Pen.YLink = "Dados.TagDemo1"
Pen.UseTimeStamp = True ' Em X usa o timestamp
Pen.Color = RGB(255, 0, 0)
Pen.Docstring = "Teste"
MsgBox "Clique OK para conectar."
Pen.Connect() ' Começa a receber os dados
Visualização 293
MsgBox "Clique OK para enquadrar."
E3Chart1.FitPen(0)
MsgBox "Clique OK para remover a pena."
E3Chart1.Pens.Remove(Pen.Name)
End Sub
4.6.4.3.2.7 DigitalData
4.6.4.3.2.8 EnableCalc
4.6.4.3.2.9 EnableHighLimit
4.6.4.3.2.10 EnableLowLimit
4.6.4.3.2.11 EU
4.6.4.3.2.12 HighlightMaxGapTime
4.6.4.3.2.13 HighLimit
4.6.4.3.2.14 InterpolatedBeginY
Informa o valor do ponto interpolado onde o cursor inicial cruza com a Pena. Esta
propriedade é somente de leitura.
294 Visualização
4.6.4.3.2.15 InterpolatedEndY
Informa o valor do ponto interpolado onde o cursor final cruza com a Pena. Esta
propriedade é somente de leitura.
4.6.4.3.2.16 LimitPenBkColor
4.6.4.3.2.17 LimitPenColor
4.6.4.3.2.18 LowLimit
4.6.4.3.2.19 MaxGapTime
4.6.4.3.2.20 MaxGapTimeColor
4.6.4.3.2.21 MaxGapTimeStyle
Especifica o estilo da linha que estabelece uma conexão visual entre a parte
histórica e a parte de tempo real de uma Pena Mista, configurada na propriedade
MaxGapTime. Os valores possíveis para esta propriedade são os seguintes:
0: Sólida
1: Tracejada
2: Pontilhada
3: Traço - Ponto
Visualização 295
4: Traço - Ponto - Ponto
5: Invisível
NOTA: A opçã o 5 (Invi s ível ) des ta propri eda de s ó pode s er s el eci ona da vi a s cri pt.
4.6.4.3.2.22 MaxY
4.6.4.3.2.23 MinY
4.6.4.3.2.24 Name
4.6.4.3.2.25 PenStyle
296 Visualização
4.6.4.3.2.26 PenType
4.6.4.3.2.27 QueryName
4.6.4.3.2.28 ScaleX
4.6.4.3.2.29 ScaleY
Visualização 297
4.6.4.3.2.30 ScanValue
Define o tempo de leitura esperado do Tag da Pena de tempo real. Este valor é
levado em conta no modo de desenho analógico. Quando o valor ultrapassa o valor
determinado por ScanValue, considera-se que o valor do Tag não foi alterado no
intervalo. De outra forma, quando o ScanValue é igual a 0 (zero), os dados da Pena
são sempre conectados com uma reta ligando os dois pontos, como se o valor
estivesse variando de forma linear. A unidade desta propriedade é em
milissegundos.
4.6.4.3.2.31 ShowAverage
4.6.4.3.2.32 ShowBadPoints
Quando desabilitada, os pontos com qualidade ruim não são plotados. Se a Pena
estiver traçando linhas, as linhas que passam pelos pontos de qualidade ruim não
são conectadas. Para que a qualidade dos pontos seja levada em consideração na
parte histórica da Pena, o campo nomecampo_quality deve estar selecionado na
Consulta do E3Chart. Quando habilitada, todos os pontos são plotados
normalmente.
4.6.4.3.2.33 ShowMinMax
4.6.4.3.2.34 UseTimeStamp
4.6.4.3.2.35 Visible
298 Visualização
4.6.4.3.2.36 Width
NOTA: A uti l i za çã o de va l ores ma i ores do que 1 (um) nes ta propri eda de, combi na da
com a uti l i za çã o da propri eda de PenStyle com um va l or di ferente de 0 (zero, LsSolid),
pode degra da r a performa nce de des enho da Pena .
4.6.4.3.2.37 XField
Nome do campo da Consulta usado para plotar o dado em uma escala horizontal.
É usada para Penas históricas.
4.6.4.3.2.38 XLink
Nome do link usado para plotar o dado em uma escala horizontal. Quando o
valor desta propriedade é alterado, a Pena é automaticamente desconectada. Após
a configuração, é preciso chamar o método Connect para que a Pena comece a
receber os dados relativos a este link. É usada para Penas de tempo real.
4.6.4.3.2.39 XMaxY
4.6.4.3.2.40 XMinY
4.6.4.3.2.41 YField
Nome do campo da Consulta usado para plotar o dado em uma escala vertical. É
usada para Penas históricas.
4.6.4.3.2.42 YLink
Nome do link usado para plotar o dado em uma escala vertical. Quando o valor
desta propriedade é alterado, a Pena é automaticamente desconectada. Após a
configuração, é preciso chamar o método Connect para que a Pena comece a
receber os dados relativos a este link. É usada para Penas de tempo real.
Visualização 299
4.6.5.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Eixos.
4.6.5.1.1 AddAxis
AddAxis(AxisName)
Adiciona um novo Eixo com o nome determinado no parâmetro AxisName e retorna
o Eixo criado. Caso se tente criar um Eixo com um nome que já existe, é mostrada
uma mensagem de erro. Querendo-se que o nome seja gerado automaticamente,
deve se passar o parâmetro AxisName em branco. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Set newAxis = Chart.Axes.AddAxis("")
newAxis.Color = RGB(255, 0, 0)
End Sub
4.6.5.1.2 Remove
Remove(Index)
Remove o Eixo através de seu nome ou índice, conforme especificado no parâmetro
Index. Os Eixos principais 0 (zero) e 1 (um) não podem ser removidos. Caso se tente
removê-los, aparece uma mensagem de erro. Exemplos:
Sub CommandButton1_Click()
' Este exemplo remove todos os eixos adicionais
Set Chart = Screen.Item("E3Chart")
While (Chart.Axes.Count > 2)
Chart.Axes.Remove(2)
Wend
End Sub
Sub CommandButton1_Click()
' Remove um eixo adicional, se existir
Set Chart = Screen.Item("E3Chart1")
Chart.Axes.Remove(2)
End Sub
4.6.5.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de Eixos.
4.6.5.2.1 Count
300 Visualização
4.6.5.2.2 HorAxis
Retorna o Eixo Horizontal principal. Este Eixo também participa da lista de Eixos.
Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
MsgBox Chart.axes.Item(0).Name & ", " & _
Chart.axes.Item(1).Name
MsgBox Chart.axes.HorAxis.Name & ", " & _
Chart.axes.Item("NomeDoEixo").Name
End Sub
4.6.5.2.3 Item
Retorna o Eixo através de seu nome ou índice. O índice 0 (zero) é sempre o Eixo
Horizontal principal e o índice 1 (um) é sempre o Eixo Vertical principal. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart")
MsgBox Chart.axes.Item(0).Name & ", " & _
Chart.axes.Item(1).Name
MsgBox Chart.axes.HorAxis.Name & ", " & _
Chart.axes.Item("NomeDoEixo").Name
End Sub
4.6.5.2.4 VerAxis
Retorna o Eixo Vertical principal. Este Eixo também participa da lista de Eixos.
Exemplos:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
MsgBox Chart.axes.Item(0).Name & ", " & _
Chart.axes.Item(1).Name
MsgBox Chart.axes.Item("NomeDoEixo").Name & ", " & _
Chart.axes.VerAxis.Name
End Sub
4.6.5.3 Eixos
Esta seção contém informações sobre métodos e propriedades do objeto Eixo. Este
objeto não possui eventos associados.
4.6.5.3.1 Métodos
Visualização 301
NOTA: HorAxis e VerAxis s ã o propri eda des da Col eçã o de Ei xos que a ces s a m os Ei xos
pa drã o Hori zonta l e Verti ca l , res pecti va mente. Por exempl o, a o i nvés de uti l i za r
"Cha rt.Axes .Item('Ei xoHori zonta l ')", pode-s e uti l i za r "Cha rt.Axes .HorAxi s ". Dema i s
Ei xos cri a dos pel o us uá ri o têm nomes própri os , es col hi dos ca s o a ca s o.
4.6.5.3.1.1 GetHistoricPeriod
GetHistoricPeriod(Begin, End)
Retorna o intervalo de tempo mostrado na escala histórica. O parâmetro Begin
indica a data inicial da escala histórica e End indica a data final. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart")
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 parâmetros Min e Max os valores mínimo e máximo da escala
numérica, respectivamente. Exemplo:
Sub CommandButton1_DBClick()
Set Chart = Screen.Item("E3Chart")
Chart.Axes.Item("NomeDoEixo").GetMinMax dmin, dmax
MsgBox CStr(dmin) & " " & CStr(max)
End Sub
4.6.5.3.1.3 GetRealTimePeriod
GetRealTimePeriod(Period)
Retorna a unidade de tempo configurada na escala de tempo real. O parâmetro
Period recebe o valor da escala de tempo. As unidades de tempo disponíveis estão
descritas na tabela a seguir.
Unidades de tempo disponíveis
VALOR DESCRIÇÃO
0 - tuSeconds Uni da de de tempo em s egundos
1 - tuMinutes Uni da de de tempo em mi nutos
2 - tuHours Uni da de de tempo em hora s
3 - tuDays Uni da de de tempo em di a s
4 - tuWeeks Uni da de de tempo em s ema na s
5 - tuMonths Uni da de de tempo em mes es
6 - tuYears Uni da de de tempo em a nos
302 Visualização
Exemplo:
Dim Unidade, Valor
Unidade = Screen.Item("E3Chart1").Axes.Item_
("EixoHorizontal").GetRealTimePeriod(Valor)
MsgBox "Valor: " & CStr(Valor) & " Unidade: " & CStr(Unidade)
4.6.5.3.1.4 GetTickSpacing
GetTickSpacing(TickSpacing, TimeUnit)
Retorna o espaçamento entre os ticks (subdivisões da escala) e a unidade
configurada. O parâmetro TickSpacing determina o espaçamento entre os ticks e
TimeUnit determina a unidade. Quando este parâmetro está em zero, significa que é
automático. A unidade não é utilizada quando a escala é numérica. Os valores
disponíveis para o parâmetro TimeUnit estão descritos no método
GetRealTimePeriod. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Unitvalue_
= Chart.Axes.Item("NomeDoEixo").GetTickSpacing(TickSpacing)
MsgBox "valor" = " & CStr(TickSpacing) & _
" unidade " & CStr(unitvalue)
End Sub
4.6.5.3.1.5 SetHistoricPeriod
SetHistoricPeriod(Begin, End)
Configura o período de tempo para a escala histórica. O parâmetro Begin determina
o período inicial da escala e End determina o período final da escala. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart2")
Chart.Axes.Item("NomeDoEixo").ScaleType = 2
' Mostra o ultimo período
Chart.Axes.Item("NomeDoEixo").SetHistoricPeriod now - 1, now
End Sub
4.6.5.3.1.6 SetMinMax
SetMinMax(Min, Max)
Configura os valores mínimo e máximo da escala numérica. O valor mínimo é
determinado pelo parâmetro Min e o máximo por Max. Exemplo:
Sub Circulo1_Click()
Set Chart = Screen.Item("E3Chart2")
Chart.Axes.Item("NomeDoEixo").SetMinMax -10, 500
End Sub
Visualização 303
4.6.5.3.1.7 SetRealTimePeriod
SetRealTimePeriod(Times, TimeUnit)
Ajusta o intervalo de tempo na unidade definida pelo parâmetro TimeUnit. As
opções disponíveis neste parâmetro estão descritas no método GetRealTimePeriod.
O parâmetro Times determina o intervalo de tempo e a unidade da escala é
especificado por TimeUnit. O Eixo fica sempre sendo atualizado neste modo (tempo
real). Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart5")
' tuSeconds = 0, tuMinutes =1, tuHours = 2, tuDays = 3,
' tuWeeks = 4, tuMonths = 5, tuYears = 6
' 2 minutos
Chart.Axes.Item("NomeDoEixo").SetRealTimePeriod 2, 1
Chart.Axes.Item("NomeDoEixo").SetTickSpacing 30, 0
End Sub
4.6.5.3.1.8 SetTickSpacing
SetTickSpacing(TickSpacing, TimeUnit)
Configura o espaçamento entre os ticks (subdivisões da escala) usando a unidade.
O espaçamento entre os ticks é determinado pelo parâmetro TickSpacing. O
parâmetro TimeUnit determina a unidade. Caso a escala seja numérica, a unidade
não é considerada. As opções disponíveis no parâmetro TimeUnit estão descritas no
método GetRealTimePeriod. Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
' 10 (caso seja a escala numérica,
' o valor da unidade não é considerado)
Chart.Axes.Item("NomeDoEixo").SetTickSpacing 10, 0
Chart.Axes.Item("NomeDoEixo").SetTickSpacing 20, 0
End Sub
4.6.5.3.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Eixo.
NOTA: HorAxis e VerAxis s ã o propri eda des da Col eçã o de Ei xos que a ces s a m os Ei xos
pa drã o hori zonta l e verti ca l , res pecti va mente. Por exempl o, a o i nvés de uti l i za r
"Cha rt.Axes .Item('Ei xoHori zonta l ')", pode-s e uti l i za r "Cha rt.Axes .HorAxi s ". Dema i s
Ei xos cri a dos pel o us uá ri o têm nomes própri os , es col hi dos ca s o a ca s o.
4.6.5.3.2.1 Color
304 Visualização
4.6.5.3.2.2 EnableTextColor
Esta propriedade, quando habilitada, especifica que o texto do Eixo tem a mesma
cor da escala configurada na propriedade Color. O valor padrão desta propriedade
é Falso.
4.6.5.3.2.3 Format
4.6.5.3.2.4 GridColor
Visualização 305
4.6.5.3.2.5 GridStyle
Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
' Solid 0, dash 1, dot 2, dashdot 3,
' dashdotdot 4, invisible 5
For i = 0 To 5
MsgBox "Clique para mudar o estilo da linha no grid."
Chart.Axes.Item("NomeDoEixo").GridStyle = i
Next
End Sub
4.6.5.3.2.6 Inverse
4.6.5.3.2.7 MinorTicks
4.6.5.3.2.8 Mirror
4.6.5.3.2.9 Name
4.6.5.3.2.10 Position
Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Set newAxis = Chart.Axes.AddAxis("")
For i = 0 To 3
MsgBox "Clique OK para mudar a posição do eixo."
newAxis.Position = i
Next
MsgBox "Remover o eixo."
Chart.Axes.Remove(newAxis.Name)
End Sub
Visualização 307
4.6.5.3.2.11 ScaleType
Determina o tipo de escala mostrada pelo Eixo. As opções disponíveis neste item
estão descritas na tabela a seguir.
Opções disponíveis para ScaleType
OPÇÃO DESCRIÇÃO
0 - atNumberScale Es ca l a numéri ca
1 - atLastPeriod Mos tra úl ti mo período (Tempo Rea l )
2 - atPeriod Interva l o de tempo (Hi s tóri ca )
Exemplo:
Sub CommandButton1_Click()
Set Chart = Screen.Item("E3Chart1")
Set newAxis = Chart.Axes.AddAxis("")
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
4.6.5.3.2.13 Title
308 Visualização
4.6.5.3.2.14 Visible
4.6.6.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Consultas.
4.6.6.1.1 AddQuery
AddQuery(QueryName[, IsInternal])
Adiciona uma Consulta na Coleção de Consultas do E3Chart. Este método possui os
parâmetros QueryName, que determina o nome da Consulta que está sendo
adicionada, e IsInternal, que é opcional, obsoleto e não deve ser informado.
4.6.6.1.2 Item
Item(Index)
O método Item retorna um objeto Consulta da Coleção de Consultas, especificado
pelo índice. Este método possui o parâmetro Index, que pode ser do tipo numérico
(se corresponder ao índice da Consulta) ou texto (se corresponder ao nome da
Consulta).
4.6.6.1.3 Remove
Remove(Index)
Remove o objeto Consulta especificado pelo nome ou pelo índice da Coleção de
Consultas. Este método possui o parâmetro Index, que pode ser do tipo numérico
(se corresponder ao índice da Consulta) ou texto (se corresponder ao nome da
Consulta).
Visualização 309
4.6.6.1.4 UpdateData
UpdateData()
Atualiza os dados de todas as Consultas. Exemplo:
Sub Texto1_Click()
Set E3Chart1 = Screen.Item("E3Chart1")
E3Chart1.Queries.UpdateData()
End Sub
4.6.6.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de
Consultas.
4.6.6.2.1 Count
Contém o número total de Consultas do E3Chart. Esta propriedade é somente de
leitura.
4.6.7 Legenda
Esta seção contém informações sobre métodos e propriedades do objeto Legenda.
Este objeto não possui eventos associados.
4.6.7.1 Métodos
Na Legenda, podem ser selecionadas várias colunas. Cada coluna mostra um tipo
de informação e possui um nome e um valor correspondente. A seguir, tem-se a
tabela da descrição das colunas possíveis na Legenda.
Opções disponíveis para identificação das colunas
OPÇÃO VALOR NOME DESCRIÇÃO
Cor da Pena 6 Color Mos tra a cor da
Pena .
Descrição da Pena 5 Description Mos tra a
propri eda de
DocString da Pena .
DifX 15 DiffX Mos tra a di ferença
entre os curs ores
i ni ci a l e fi na l .
DifY 16 DiffY Mos tra a di ferença
entre os pontos
i nterpol a dos i ni ci a l
e fi na l no Ei xo Y.
310 Visualização
OPÇÃO VALOR NOME DESCRIÇÃO
EscalaX 8 ScaleX Mos tra o nome da
es ca l a a s s oci a da a o
Ta g X.
EscalaY 9 ScaleY Mos tra o nome da
es ca l a a s s oci a da a o
Ta g Y.
Estado 7 Status Mos tra o s ta tus da
Pena .
FimX 14 XEnd Mos tra a pos i çã o
fi na l do curs or.
FimY 18 YEnd Mos tra o ponto
i nterpol a do onde o
curs or fi na l cruza a
Pena .
InícioX 13 XBegin Mos tra a pos i çã o
i ni ci a l do curs or.
InícioY 17 YBegin Mos tra o ponto
i nterpol a do onde o
curs or i ni ci a l cruza a
Pena .
MáximoY 12 MaxY Mos tra o va l or
má xi mo da Pena no
i nterva l o.
MédiaY 10 AverageY Mos tra o va l or
médi o da Pena no
i nterva l o.
MínimoY 11 MinY Mos tra o va l or
míni mo da Pena no
i nterva l o.
Nome da pena 0 Name Mos tra o nome da
Pena .
Nome do tag X 1 TagX Mos tra o nome do
Ta g X a s s oci a do à
Pena .
Nome do tag Y 2 TagY Mos tra o nome do
Ta g Y a s s oci a do à
Pena .
Unidade 19 EU Mos tra a uni da de
a s s oci a da à Pena .
Valor do tag X 3 TagXValue Mos tra o va l or do
Ta g X a s s oci a do à
Pena . Es te va l or é
mos tra do qua ndo o
grá fi co es tá no
modo de Pes qui s a .
Visualização 311
OPÇÃO VALOR NOME DESCRIÇÃO
Valor do tag Y 4 TagYValue Mos tra o va l or do
Ta g Y a s s oci a do à
Pena . Es te va l or é
mos tra do qua ndo o
grá fi co es tá no
modo de Pes qui s a .
4.6.7.1.1 ChangeColumnPos
ChangeColumnPos(Source, Dest)
Troca a posição entre duas colunas. Possui os seguintes parâmetros:
Source: Índice da coluna a ser movida para Dest
Dest: Índice da coluna a ser movida para Source
Exemplo:
Sub CommandButton1_Click()
Screen.Item("E3Chart1").Legend.ChangeColumnPos 1, 2
End Sub
4.6.7.1.2 Count
Count()
Retorna o número de colunas da Legenda.
4.6.7.1.3 InsertColumn
InsertColumn(Col, Index)
Insere uma nova coluna na Legenda. Este método possui os seguintes parâmetros:
Col: Identifica a coluna a ser inserida (ver a tabela Opções disponíveis para
identificação das colunas, no início do tópico Métodos da Legenda).
Index: Determina a posição em que a coluna vai ser inserida.
Exemplo:
Sub CommandButton1_Click()
'Mostra o nome da Pena
Screen.Item("E3Chart1").Legend.InsertColumn 0, 0
End Sub
Sub CommandButton1_Click()
'Mostra a cor da Pena
Screen.Item("E3Chart1").Legend.InsertColumn "Color", 0
312 Visualização
End Sub
4.6.7.1.4 Item
Item(Col)
Retorna uma coluna da Legenda pelo nome ou pelo índice. O parâmetro Col
determina o índice ou o nome da coluna (ver a tabela Opções disponíveis para
identificação das colunas, no início do tópico Métodos da Legenda).
4.6.7.1.5 RemoveColumn
RemoveColumn(Col)
Remove uma coluna. Este método possui o parâmetro Col, que determina a coluna a
ser removida (ver a tabela Opções disponíveis para identificação das colunas, no
início do tópico Métodos da Legenda).
4.6.7.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Legenda.
4.6.7.2.1 BackColor
Configura ou retorna a cor de fundo da Legenda. O valor padrão desta
propriedade é branco (RGB(255, 255, 255)).
4.6.7.2.2 EnableTextColor
Esta propriedade, quando habilitada, especifica que o texto da Legenda tem a
mesma cor da Pena, configurada na propriedade Color. O valor padrão desta
propriedade é Falso.
4.6.7.2.3 LegendPos
Visualização 313
4.6.7.2.4 ShowAllPens
4.6.7.2.5 ShowHeader
Determina a visibilidade do título da Legenda (cabeçalho). Se a propriedade for
configurada para Verdadeiro, o título da Legenda é mostrado. Caso contrário, o
título permanece invisível.
4.6.7.2.6 Size
4.6.7.2.7 Visible
Determina a visibilidade da Legenda. Se a opção estiver configurada como
Verdadeiro, a Legenda é visível no E3Chart. Caso contrário, permanece invisível.
4.6.7.3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Colunas da
Legenda.
4.6.7.3.1.1 Caption
4.6.7.3.1.2 Column
314 Visualização
4.6.7.3.1.3 Format
4.6.7.3.1.4 Index
4.6.7.3.1.5 Name
Determina o nome da Coluna. O nome das Colunas pode ser visto na Tabela de
Identificação das Colunas, no início do tópico Métodos da Legenda.
4.6.7.3.1.6 TextAlign
OPÇÃO DESCRIÇÃO
0 - taLeft Al i nha mento à es querda
1 - taRight Al i nha mento à di rei ta
2 - taCenter Al i nha mento centra l i za do
4.6.7.3.1.7 Width
4.7 E3Playback
Esta seção contém informações sobre métodos e propriedades do objeto
E3Playback. Este objeto não possui eventos associados.
4.7.1 Métodos
Esta seção contém informações sobre os métodos do objeto E3Playback.
4.7.1.1 Pause
Pause()
Congela o relógio de playback no tempo atual.
Visualização 315
4.7.1.2 Play
Play()
Inicia a reprodução dos dados no horário atual de playback, avançando o relógio
de acordo com a velocidade de reprodução atual.
4.7.1.3 Stop
Stop()
Interrompe o playback, dados de Tags e alarmes são removidos das Telas e
nenhuma nova consulta é feita ao Banco de Dados.
4.7.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto E3Playback.
4.7.2.1 CurrentTime
Mostra a data e a hora atual do objeto E3Playback. Esta propriedade está
disponível somente em tempo de execução.
4.7.2.2 DBServer
Indica o nome do objeto Banco de Dados que contém os dados históricos do
aplicativo.
4.7.2.3 InitialScreen
Indica a Tela que é mostrada inicialmente no E3Playback. Se esta propriedade for
deixada em branco, é utilizada a Tela ou Quadro configurado na propriedade
InitialScreen do objeto Viewer.
4.7.2.4 PlaybackState
Informa o estado atual do objeto E3Playback. Esta propriedade está disponível
somente em tempo de execução e suas opções estão descritas na tabela a seguir.
Opções da propriedade PlaybackState
OPÇÃO DESCRIÇÃO
0 - Parado O rel ógi o de playback es tá pa ra do.
1 - Reproduzindo O rel ógi o de playback es tá s e movendo.
2 - Pausado O rel ógi o de playback es tá pa us a do.
316 Visualização
4.8 Relatórios
Esta seção contém informações sobre eventos, métodos e propriedades do objeto
Relatório.
4.8.1 Eventos
Esta seção contém informações sobre os eventos do objeto Relatório.
4.8.1.1 OnAfterPrint
OnAfterPrint()
Disparado após uma Seção ter sido montada no Relatório. Pode-se utilizar este
evento para atualizar qualquer contador cuja utilização seja necessária depois do
Relatório ser completado.
4.8.1.2 OnBeforePrint
OnBeforePrint()
Disparado antes da Seção ter sido montada no Relatório. Pode-se utilizar este
evento para modificar o valor de um objeto no Relatório antes que este seja
impresso. Recomenda-se que os campos da Consulta do Relatório não sejam
acessados quando este evento estiver em uso.
4.8.1.3 OnDataInitialize
OnDataInitialize()
Disparado antes do evento OnReportStart. Este evento permite acrescentar e
configurar campos à coleção Fields de um Relatório, antes de sua geração. Exemplo:
Sub OnDataInitialize()
Fields.Add "Nome"
Fields.Add "Setor"
Fields.Add "Código"
End Sub
4.8.1.4 OnError
OnError(Number, Description, SCode, Source, HelpFile, HelpContext, CancelDisplay)
Disparado por um erro interno no Relatório. Se este evento não for tratado, o Elipse
Power mostra uma mensagem de erro genérica.
Variáveis do evento OnError
NOME DESCRIÇÃO
Number Número i ntei ro i denti fi ca dor do erro
Visualização 317
NOME DESCRIÇÃO
Description String com a des cri çã o do erro
SCode Intei ro com o códi go de erro do
s ubs i s tema OLE (nã o uti l i za do)
Source String com o objeto ori gem do erro
HelpFile String com o nome e ca mi nho do a rqui vo
de a juda
HelpContext Número de contexto do tópi co de a juda
referente a o erro (i ntei ro)
CancelDisplay Bool ea no que i ndi ca s e o erro deve s er
mos tra do em uma ca i xa de mens a gem
4.8.1.5 OnFetchData
OnFetchData(eof)
Disparado toda vez que um novo registro é processado. Este evento é utilizado para
executar um script que modifique os valores dos campos que foram adicionados ao
Relatório em um script associado ao evento OnDataInitialize. A variável eof tem o
valor padrão Verdadeiro e indica que após o script o processamento do registro
atual do Relatório foi encerrado.
4.8.1.6 OnFormat
OnFormat()
Disparado depois que os dados são lidos e carregados no Relatório, mas antes da
Seção ser preparada para impressão. Este evento pode ser utilizado para modificar
o layout da Seção do Relatório ou de qualquer outro objeto.
4.8.1.7 OnHyperlink
OnHyperlink(Button, Link)
Disparado ao clicar em um link no Relatório. Pode-se utilizar este evento para
executar um script que redirecione um link ou para configurar um link no Relatório.
A variável Button indica qual botão foi clicado (normalmente 1) e a variável Link
determina qual o endereço de destino do link.
4.8.1.8 OnNoData
OnNoData()
Disparado quando não há dados a imprimir no Relatório. Pode-se utilizar este
evento para executar um script que mostre uma mensagem de erro na tela,
acusando a falta de dados para imprimir e cancelando o Relatório.
318 Visualização
4.8.1.9 OnPageEnd
OnPageEnd()
Disparado ao final da impressão de cada página do Relatório.
4.8.1.10 OnPageStart
OnPageStart()
Disparado no início da impressão de cada página do Relatório.
4.8.1.11 OnPrintProgress
OnPrintProgress(PageNumber)
Disparado enquanto uma página do Relatório está sendo impressa. A variável
PageNumber indica o número da página atual.
4.8.1.12 OnReportEnd
OnReportEnd()
Disparado no final da geração do Relatório, após finalizar a impressão.
4.8.1.13 OnReportStart
OnReportStart()
Disparado no início da geração do Relatório, antes de começar a impressão.
4.8.2 Métodos
Esta seção contém informações sobre os métodos do objeto Relatório.
4.8.2.1 Export
Export([ExportFilter[, ExportFileName]])
Imprime um Relatório de acordo com o formato especificado no arquivo. Este
método possui o parâmetro ExportFilter, que determina o filtro para o Relatório,
indicando o formato para a exportação. Pode assumir as seguintes opções:
PDF: Exporta os dados para o formato PDF (Portable Document Format)
Excel: Exporta os dados para o formato de uma planilha do Excel
HTML: Exporta os dados para o formato HTML (Hyper Text Markup Language)
TEXT: Exporta os dados para o formato texto
Visualização 319
RTF: Exporta os dados para o formato RTF (Rich Text Format)
TIFF: Exporta os dados para o formato TIFF (Tag Image File Format)
4.8.2.2 GetExportFilter
GetExportFilter(FilterName)
Retorna um objeto que especifica a customização dos parâmetros de exportação.
Este método possui o parâmetro FilterName, que determina o filtro para o Relatório,
indicando o tipo de formato para a exportação. Pode assumir as seguintes opções:
PDF: Exporta os dados para o formato PDF (Portable Document Format)
Excel: Exporta os dados para o formato de planilha do Excel
320 Visualização
HTML: Exporta os dados para o formato HTML (Hyper Text Markup Language)
TEXT: Exporta os dados para o formato texto
RTF: Exporta os dados para o formato RTF (Rich Text Format)
TIFF: Exporta os dados para o formato TIFF (Tag Image File Format)
4.8.2.3 Print
Print()
Imprime um Relatório.
4.8.2.4 PrintPreview
PrintPreview([Left, ][Top, ][Width, ][Height])
Gera uma prévia de impressão de Relatório na tela. Se o Relatório for mostrado
corretamente na tela, retorna Verdadeiro. Caso o usuário clique em Cancel ou
aconteça algum erro, retorna Falso. Os parâmetros Left e Top indicam a posição da
prévia de impressão, em pixels, a partir do canto superior esquerdo da tela. Os
parâmetros Width e Height indicam o tamanho da prévia de impressão na tela, em
pixels ou em Himetric. Todos os parâmetros são opcionais. Exemplo:
322 Visualização
Sub CommandButton1_Click()
Set report = Application.LoadReport("[Relatório1]")
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
NOTAS:
Es te método nã o es tá di s ponível pa ra Rel a tóri os ca rrega dos us a ndo o método
LoadReport do Servi dor.
Es te método corres ponde a o Pi ck Imprimir Relatório.
Se os pa râ metros Left e Top nã o forem defi ni dos , a prévi a de i mpres s ã o é
mos tra da na pos i çã o (0, 0).
Se os pa râ metros Width e Height nã o forem defi ni dos , a prévi a de i mpres s ã o é
cri a da com o ta ma nho de 500 x 500 pi xel s e a ja nel a é a berta ma xi mi za da . Se
a pena s um dos pa râ metros for defi ni do, o outro pa râ metro é confi gura do pa ra
500 pi xel s e a ja nel a nã o é a berta ma xi mi za da .
Os va l ores de ta ma nho nes te método podem s er i nforma dos como números ou
Strings. No ca s o de números , s ã o cons i dera dos em pi xel s . No ca s o de Strings, s e
vi erem a compa nha dos da uni da de "hm", s ã o i nterpreta dos como Hi metri c.
Qua l quer outro ca s o é cons i dera do em pi xel s .
4.8.2.5 Query
Query()
Retorna o objeto Consulta atualmente selecionado no Relatório. Para maiores
informações a respeito deste objeto, veja o capítulo Consultas. Exemplo:
Sub Rect_Click()
Set Query = Application.LoadReport("[Relatório3]").Query()
Query.SetVariableValue("Chave1", "XYZ")
End Sub
4.8.3 Propriedades
Para criar um script no Relatório, utiliza-se o Editor de Scripts do Relatório, aberto
ao clicar em Editor de Scripts e, para visualizar o Relatório, clique em Gerar
Relatório, Ambas opções estão localizadas na barra de ferramentas Relatórios.
Os scripts do Relatório utilizam alguns procedimentos, dependendo do objeto ou
da Seção onde se deseja incluir o código. Por exemplo:
Report.Sections("PageHeader").Controls("E3Chart1")._
GridBkColor= RGB(255, 0, 255).
Onde:
PageHeader: Nome da Seção onde o objeto está incluído no Relatório
Visualização 323
E3Chart1: Nome do objeto que está dentro da Seção especificada, neste caso
PageHeader
GridBkColor: Nome da propriedade do objeto, neste caso E3Chart1
RGB(255, 0, 255): Parâmetro ou ação da propriedade. Neste caso, mudar a
cor de fundo do gráfico para rosa
NOTA: O objeto Rel a tóri o enca ps ul a um objeto Acti veReports (ou AR), que é o
Rel a tóri o propri a mente di to.
4.8.3.1 Caption
Contém o título do Relatório que aparece na barra de título da janela de
visualização (preview). O valor padrão desta propriedade é uma String vazia.
4.8.4 Layout
Esta seção contém informações sobre propriedades do objeto Layout do Relatório.
Este objeto não possui eventos nem métodos associados.
4.8.4.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Layout do
Relatório.
NOTA: As propri eda des a qui des cri ta s s ã o pa rte do objeto Acti veReport (ou AR) que
é enca ps ul a do no objeto Rel a tóri o. Es ta s propri eda des s ã o vá l i da s a pena s dentro
do es copo do AR e nã o podem s er a ces s a da s fora des te objeto.
4.8.4.1.1 _PageBottomMargin
Determina a margem inferior do Relatório, em twips (1 twip = 1/1440 polegada). O
valor padrão desta propriedade é 1440 (uma polegada ou 2,54 cm).
4.8.4.1.2 _PageLeftMargin
324 Visualização
4.8.4.1.3 _PageRightMargin
4.8.4.1.4 _PageTopMargin
Determina a margem superior do Relatório, em twips (1 twip = 1/1440 polegada).
O valor padrão desta propriedade é 1440 (uma polegada ou 2,54 cm).
4.8.4.1.5 AllowSplitters
Permite que a tela de visualização do Relatório seja dividida em duas partes.
Esta propriedade só está disponível em tempo de execução. Se a propriedade estiver
configurada para Falso (valor padrão), a barra para divisão não aparece na tela.
4.8.4.1.6 documentName
Determina o nome do documento para o Relatório. Este nome aparece no
gerenciador de impressão e pode ser usado para identificar mais facilmente o
Relatório. O valor padrão desta propriedade é "ActiveReports Document".
4.8.4.1.7 MaxPages
Estabelece o número máximo de páginas para o Relatório. Quando este número é
alcançado, o Elipse Power para de processar o documento. O valor padrão desta
propriedade é 10.
4.8.4.1.8 ParentReport
Esta propriedade é uma variável de uso interno e contém uma referência para o
objeto Relatório. A propriedade é somente de leitura, e válida apenas para os
eventos OnDataInitialize e OnReportEnd.
4.8.4.1.9 PrintWidth
Visualização 325
4.8.4.1.10 RulerVisible
Quando configurado como Verdadeiro, indica que são mostradas uma régua
vertical e outra horizontal na janela de visualização do Relatório. Do contrário, as
réguas permanecem invisíveis.
4.8.4.1.11 ScriptDebuggerEnabled
4.8.4.1.12 ScriptLanguage
Indica a linguagem usada para interpretar os scripts associados a um Relatório.
A linguagem padrão é o VBScript, mas JScript também pode ser utilizada.
4.8.4.1.13 ShowParameterUI
4.8.4.1.14 Status
Retorna o status do Relatório. As opções disponíveis para esta propriedades
estão descritas na tabela a seguir.
Opções disponíveis para a propriedade Status
OPÇÃO DESCRIÇÃO
0 - DDStatIdle Indi ca que o Rel a tóri o es tá fecha do
1 - DDStartRunning Indi ca que o Rel a tóri o es tá em execuçã o
2 - DDStartCompleted Indi ca que o Rel a tóri o es tá compl eto
3 - DDStartCanceled Indi ca que o Rel a tóri o foi ca ncel a do
4.8.4.1.15 TOCEnabled
Habilita ou desabilita o sumário do Relatório. Se a propriedade estiver
configurada para Verdadeiro, o sumário do Relatório é habilitado. Do contrário, o
Relatório não tem sumário. O valor padrão desta propriedade é Verdadeiro.
326 Visualização
4.8.4.1.16 TOCVisible
4.8.4.1.17 ToolbarVisible
4.8.4.1.18 UserData
Configura ou retorna as informações específicas do usuário. Esta propriedade é
similar à propriedade Tag do Visual Basic, mas é exportada e salva em um arquivo
.rpx. Pode ser usada para salvar e carregar qualquer informação personalizada
necessária ao desenho do Relatório.
4.8.4.1.19 Version
Retorna o número da versão do produto.
4.8.4.1.20 WaterMark
Visualização 327
Exemplo de marca d'água
O valor padrão desta propriedade é vazio (sem texto ou imagem).
4.8.4.1.21 WaterMarkAlignment
Determina o alinhamento da marca d'água no Relatório. As opções disponíveis
para esta propriedade estão descritas na tabela a seguir.
Opções disponíveis para a propriedade WaterMarkAlignment
OPÇÃO DESCRIÇÃO
0 - ddPATopLeft Al i nha a i ma gem a o topo e à es querda
1 - ddPATopRight Al i nha a i ma gem a o topo e à di rei ta
2 - ddPACenter Al i nha a i ma gem a o centro (pa drã o)
3 - ddPABottomLeft Al i nha a i ma gem à ba s e e à es querda
4 - ddPABottonRight Al i nha a i ma gem à ba s e e à di rei ta
4.8.4.1.22 WaterMarkPrintOnPages
Indica o número das páginas do Relatório que recebem a marca d'água. A sintaxe
utilizada pode incluir uma única página, uma extensão de páginas ou mesmo uma
combinação de ambos. Exemplo: 1, 5-8, 9, 10-15.
328 Visualização
4.8.4.1.23 WaterMarkSizeMode
4.8.5 Seção
Esta seção contém informações sobre propriedades comuns do objeto Seção do
Relatório. Este objeto não possui eventos nem métodos associados.
4.8.5.1.1 BackColor
Especifica a cor de fundo da Seção do Relatório. O efeito desta propriedade só é
visível se a propriedade BackStyle estiver habilitada para a opção 1 - ddBKNormal.
O valor padrão desta propriedade é branco (RGB(255, 255, 255)).
4.8.5.1.2 BackStyle
Especifica o estilo de fundo da Seção do Relatório. As opções disponíveis para
esta propriedade são as seguintes:
0 - ddBKTransparent: Fundo transparente
1 - ddBKNormal: Fundo normal
4.8.5.1.3 CanGrow
Determina a aplicação de stretch ao texto da página do Relatório. Caso a largura
ou a altura da página sejam aumentadas, o texto acompanha esta variação. Se a
propriedade estiver configurada para Verdadeiro, o texto acompanha as variações
de altura e de largura do objeto. Caso contrário, este permanece com as
configurações iniciais. O valor padrão desta propriedade é Verdadeiro.
Visualização 329
4.8.5.1.4 CanShrink
4.8.5.1.5 height
Determina a altura da Seção da página do Relatório. O valor padrão desta
propriedade é 360.
4.8.5.1.6 IsRepeating
Determina a repetição da Seção na última página do Relatório. Se esta
propriedade estiver configurada para Verdadeiro, a Seção é repetida na última
página. Caso contrário, não há esta repetição.
4.8.5.1.7 Name
Indica o nome da Seção no Relatório.
4.8.5.1.8 Type
Retorna o tipo da Seção. As opções disponíveis para esta propriedade estão
descritas na tabela a seguir.
Opções disponíveis para a propriedade Type
OPÇÃO DESCRIÇÃO
0 - ReportHeader Seçã o do ti po ReportHeader (Ca beça l ho
de Rel a tóri o)
1 - ReportFooter Seçã o do ti po ReportFooter (Roda pé de
Rel a tóri o)
2 - PageHeader Seçã o do ti po PageHeader (Ca beça l ho de
pá gi na )
3 - PageFooter Seçã o do ti po PageFooter (Roda pé de
pá gi na )
4 - GroupHeader Seçã o do ti po GroupHeader (Ca beça l ho de
grupo)
5 - GroupFooter Seçã o do ti po GroupFooter (Roda pé de
grupo)
6 - Detail Seçã o do ti po Detail (Área pa ra o
conteúdo do Rel a tóri o)
330 Visualização
4.8.5.1.9 Visible
4.8.5.2.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Group Header do
Relatório.
4.8.5.2.1.1 ColumnLayout
4.8.5.2.1.2 DataField
4.8.5.2.1.3 GrpKeepTogether
Visualização 331
OPÇÃO DESCRIÇÃO
2 - GrpAll O GroupHeader, Detail e Footer de grupo
s ã o i mpres s os juntos na mes ma pá gi na
do Rel a tóri o
4.8.5.2.1.4 KeepTogether
OPÇÃO DESCRIÇÃO
0 - ddGrpNone Há uma quebra de pá gi na depoi s do
Rel a tóri o
1 - ddGrpFirstDetail O Rel a tóri o i mpri me a Seçã o Detail na
mes ma pá gi na ou col una
4.8.5.2.1.5 NewColumn
4.8.5.2.1.6 NewPage
332 Visualização
Opções disponíveis para a propriedade NewPage
OPÇÃO DESCRIÇÃO
0 - ddNPNone Nã o há quebra de pá gi na na Seçã o
(pa drã o)
1 - ddNBefore Ini ci a a i mpres s ã o em uma nova pá gi na
2 - ddNPAfter Ini ci a uma nova pá gi na depoi s da
i mpres s ã o da Seçã o
3 - ddNPBeforeAfter Ini ci a a i mpres s ã o em uma nova pá gi na
e i ni ci a uma nova pá gi na depoi s de
i mpri mi r a Seçã o
4.8.5.2.1.7 Repeat
OPÇÃO DESCRIÇÃO
0 - ddRepeatNone Nã o há rei mpres s ã o do grupo de
ca beça l ho (pa drã o)
1 - ddRepeatOnPage Impri me o grupo de ca beça l hos no topo
da pá gi na conforme a s es peci fi ca ções da
Seçã o Detail
2 - ddRepeatOnColumn Impri me o grupo de ca beça l hos no topo
da col una da pá gi na do Rel a tóri o
conforme a s es peci fi ca ções da Seçã o
Detail
3 - ddRepeatAll Impri me o grupo de ca beça l hos e os
dema i s objetos no topo da pá gi na do
Rel a tóri o conforme a s es peci fi ca ções da
Seçã o Detail
4.8.5.2.1.8 UnderlayNext
4.8.5.3 Detail
Esta seção contém informações sobre propriedades do objeto Detail do Relatório.
Este objeto não possui eventos nem métodos associados.
Visualização 333
4.8.5.3.1 Propriedades
4.8.5.3.1.1 ColumnCount
4.8.5.3.1.2 ColumnDirection
OPÇÃO DESCRIÇÃO
0 - ddCDDownAcross Impri me ca da col una da Seçã o Detail de
ci ma pa ra ba i xo e depoi s pa s s a pa ra a
próxi ma col una à di rei ta
1 - ddCDAcrossDown Impri me ca da col una da Seçã o Detail da
di rei ta pa ra a es querda e a s s i m por
di a nte
334 Visualização
Opção ddCDDownAccross
Opção ddCDAccrossDown
Visualização 335
4.8.5.3.1.3 ColumnSpacing
4.8.5.3.1.4 KeepTogether
4.8.5.3.1.5 NewColumn
4.8.5.3.1.6 NewPage
336 Visualização
OPÇÃO DESCRIÇÃO
3 - ddNPBeforeAfter Ini ci a a i mpres s ã o em uma nova pá gi na
e i ni ci a uma nova pá gi na depoi s de
i mpri mi r a Seçã o
4.8.5.4.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Group Footer do
Relatório.
4.8.5.4.1.1 ColumnLayout
4.8.5.4.1.2 KeepTogether
4.8.5.4.1.3 NewColumn
OPÇÃO DESCRIÇÃO
0 - ddNPNone Nã o há quebra de pá gi na na Seçã o
Visualização 337
OPÇÃO DESCRIÇÃO
1 - ddNBefore Ini ci a a i mpres s ã o da Seçã o em uma
nova pá gi na
2 - ddNPAfter Ini ci a uma nova pá gi na depoi s de
i mpri mi r a Seçã o
3 - ddNPBeforeAfter Ini ci a a i mpres s ã o em uma nova pá gi na
e uma nova pá gi na depoi s de i mpri mi r a
Seçã o
4.8.5.4.1.4 NewPage
4.8.5.4.1.5 PrintAtBottom
4.8.6 Objetos
Esta seção contém informações sobre propriedades dos Objetos do Relatório. Estes
objetos não possuem eventos nem métodos associados.
338 Visualização
4.8.6.1.1 BackColor
4.8.6.1.2 BackStyle
Especifica o estilo do fundo dos objetos do Relatório. As opções disponíveis
para esta propriedade são as seguintes:
0 - ddBKTransparent: Transparente (mostra a cor definida pela propriedade
BackColor da Seção)
1 - ddBKNormal: Normal (mostra a cor definida pela propriedade BackColor
do objeto)
4.8.6.1.3 height
Esta propriedade determina a altura de um objeto no Relatório.
4.8.6.1.4 left
Retorna o valor do posicionamento esquerdo de um objeto no Relatório.
4.8.6.1.5 Name
Determina o nome de um objeto. O valor padrão desta propriedade é uma String
vazia.
4.8.6.1.6 Tag
Retorna o tipo do Tag associado a um objeto, isto é, Boolean, String, Integer, etc.
Visualização 339
4.8.6.1.7 Top
4.8.6.1.8 Visible
4.8.6.1.9 Width
Esta propriedade determina a largura de um objeto no Relatório.
4.8.6.2.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Código de Barras
do Relatório.
4.8.6.2.1.1 Alignment
4.8.6.2.1.2 BarWidth
340 Visualização
maior o número configurado na propriedade, maior a largura da barra do código
de barras. O valor padrão desta propriedade é 1 (um).
4.8.6.2.1.3 Caption
4.8.6.2.1.4 CaptionPosition
4.8.6.2.1.5 DataField
4.8.6.2.1.6 Direction
OPÇÃO DESCRIÇÃO
0 - ddbcLeftToRight O Códi go de Ba rra s é di reci ona do da
es querda pa ra a di rei ta
1 - ddbcRightToLeft O Códi go de Ba rra s é di reci ona do da
di rei ta pa ra a es querda
Visualização 341
OPÇÃO DESCRIÇÃO
2 - ddbcTopToBottom O Códi go de Ba rra s é di reci ona do de
ci ma pa ra ba i xo
3 - ddbcBottomToTop O Códi go de Ba rra s é di reci ona do de
ba i xo pa ra ci ma
4.8.6.2.1.7 EnableCheckSum
4.8.6.2.1.8 Font
4.8.6.2.1.9 Forecolor
4.8.6.2.1.10 Style
342 Visualização
OPÇÃO DESCRIÇÃO
4 - ddbcCode25intlv Es ti l o de códi go de ba rra s i nterca l a do 2
de 5. Uti l i ze s omente números
5 - ddbcCode25mat Es ti l o de códi go de ba rra s Ma tri z 25
6 - ddbcCode39 Es ti l o de códi go de ba rra s Códi go 39,
uti l i ze l etra s , números , -,*, $, /, +, %, etc.
7 - ddbcCode39x Es ti l o de códi go de ba rra s Códi go 39
es tendi do. Uti l i ze ca ra cteres compl etos
ASCII
8 - ddbcCode_128_a Es ti l o de códi go de ba rra s 128 A. Uti l i ze
números , pontua ções , ou l etra s
9 - ddbcCode_128_b Es ti l o de códi go de ba rra s 128 B. Uti l i ze
s tri ngs , números , pontua ções , ou l etra s
10 - ddbcCode_128_c Es ti l o de códi go de ba rra s 128 C. Uti l i ze
s omente números
11 - ddbcCode_128auto Es ti l o de códi go de ba rra s 128
Automá ti co. Uti l i ze ca ra cteres compl etos
ASCII. Sel eci ona a utoma ti ca mente
códi gos entre 128 A, B e C pa ra confi gura r
no códi go de ba rra s o va l or menor
12 - ddbcCode_93 Es ti l o de códi go de ba rra s Códi go 93.
Uti l i ze l etra s , números , -,*,$, /,+,%, etc.
13 - ddbcCode_93x Es ti l o de códi go de ba rra s Códi go 93
es tendi do. Uti l i ze ca ra cteres compl etos
ASCII
14 - ddbcMSI Es ti l o de códi go de ba rra s Códi go MSI.
Uti l i ze s omente números
15 - ddbcPostNet Es ti l o de códi go de ba rra s Pos tNet.
Uti l i ze s omente números com uma
veri fi ca çã o di gi ta l
16 - ddbcCodabar Es ti l o de códi go de ba rra s . Uti l i ze A, B, C,
D, +, -, :, /, ou números
17 - ddbcEAN_8 Es ti l o de códi go de ba rra s EAN-8. Uti l i ze
s omente números (7 números e
veri fi ca çã o di gi ta l )
18 - ddbcEAN_13 Es ti l o de códi go de ba rra s EAN-13. Uti l i ze
s omente números (12 números e
veri fi ca çã o di gi ta l )
19 - ddbcUPC_A Es ti l o de códi go de ba rra s UPC-A. Uti l i ze
s omente números (11 números e
veri fi ca çã o di gi ta l )
Visualização 343
OPÇÃO DESCRIÇÃO
20 - ddbcUPC_EO Es ti l o de códi go de ba rra s UPC-E1. Uti l i ze
s omente números . Us a do pa ra s ímbol os
de compres s ã o-zero UPC. Na
propri eda de Caption, pode-s e di gi ta r 6
dígi tos do códi go UPC-E ou 11 dígi tos . Se
um códi go com 11 dígi tos é i ns eri do, o
códi go de ba rra s converte pa ra 6 dígi tos
UPC-E, s e pos s ível . Senã o, converte-s e de
11 pa ra 6 dígi tos UPC-E e na da é
mos tra do
21 - ddbcUPC_E1 Es ti l o de códi go de ba rra s UPC-E1. Uti l i ze
s omente números . A l a rgura da entra da
de da dos do UPC E1 é de 6 ca ra cteres
numéri cos
22 - ddbcRM4SCC Es ti l o de códi go de ba rra s Roya l Ma i l
RM4SCC. Uti l i ze s omente l etra s e
números (com veri fi ca çã o di gi ta l ). Es te
códi go de ba rra s é uti l i za do no Rei no
Uni do
23 - ddbcUCCEAN128 Es ti l o de códi go de ba rra s UCC/EAN_128.
Uti l i ze ca ra cteres compl etos ASCII. A
vers ã o es peci a l do códi go 128 é us a do
na a pl i ca çã o HIBC
4.8.6.3.1 Propriedades
Esta seção contém informações sobre as propriedades dos objetos Elipse,
Retângulo e Retângulo Arredondado do Relatório.
4.8.6.3.1.1 LineColor
4.8.6.3.1.2 LineStyle
344 Visualização
Opções disponíveis para a propriedade LineStyle
OPÇÃO DESCRIÇÃO
0 - ddLSTransparent A l i nha do objeto perma nece
tra ns pa rente
1 - ddLSSolid A l i nha do objeto a pa rece s ól i da
2 - ddLSDash A l i nha do objeto a pa rece tra ceja da
3 - ddLSDot A l i nha do objeto a pa rece ponti l ha da
4 - ddLSDashDot A l i nha do objeto a pa rece tra ceja da
5 - ddLSDashDotDot A l i nha do objeto a pa rece ponti l ha da ,
tra ceja da e ponti l ha da
4.8.6.3.1.3 LineWeight
4.8.6.3.1.4 Shape
4.8.6.4 Figura
Esta seção contém informações sobre propriedades do objeto Figura do Relatório.
Este objeto não possui eventos nem métodos associados.
4.8.6.4.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Figura do
Relatório.
Visualização 345
4.8.6.4.1.1 DataField
4.8.6.4.1.2 Forecolor
4.8.6.4.1.3 hyperLink
Especifica um link atribuído ao texto. Para utilizar este recurso, use o evento
OnHyperLink. O valor padrão desta propriedade é uma String vazia.
4.8.6.4.1.4 LineColor
4.8.6.4.1.5 LineStyle
346 Visualização
O valor padrão desta propriedade é 1 - ddLSSolid.
4.8.6.4.1.6 LineWeight
4.8.6.4.1.7 Picture
4.8.6.4.1.8 PictureAlignment
4.8.6.4.1.9 SizeMode
Visualização 347
OPÇÃO DESCRIÇÃO
2 - ddsMZoom Ajus ta a a l tura ou a l a rgura da i ma gem
do objeto Fi gura dentro da á rea
es peci fi ca da , s em di s torcê-l a
4.8.6.5 SetPoint
Esta seção contém informações sobre propriedades do objeto SetPoint do Relatório.
Este objeto não possui eventos nem métodos associados.
4.8.6.5.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto SetPoint do
Relatório.
4.8.6.5.1.1 Alignment
4.8.6.5.1.2 CanGrow
4.8.6.5.1.3 CanShrink
4.8.6.5.1.4 ClassName
348 Visualização
4.8.6.5.1.5 DataField
4.8.6.5.1.6 Font
4.8.6.5.1.7 ForeColor
4.8.6.5.1.8 hyperLink
4.8.6.5.1.9 Multiline
4.8.6.5.1.10 OutputFormat
4.8.6.5.1.11 Style
Visualização 349
4.8.6.5.1.12 SummaryDistinctField
4.8.6.5.1.13 SummaryFunc
OPÇÃO DESCRIÇÃO
0 - Sum Ca l cul a a s oma de todos os va l ores
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
1 - Avg Ca l cul a a médi a de todos os va l ores
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
2 - Count Conta o número de va l ores dentro do
i nterva l o de tota i s es peci fi ca do (grupo,
pá gi na ou Rel a tóri o)
3 - Min Mos tra o menor va l or (va l or míni mo)
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
4 - Max Mos tra o ma i or va l or (va l or má xi mo)
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
5 - Var Ca l cul a a va ri â nci a dos va l ores dentro do
i nterva l o de tota i s es peci fi ca do (grupo,
pá gi na ou Rel a tóri o)
6 - VarP Ca l cul a a va ri â nci a popul a ci ona l dos
va l ores dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
7 - Dev Ca l cul a o des vi o pa drã o dos va l ores
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
350 Visualização
OPÇÃO DESCRIÇÃO
8 - DevP Ca l cul a o des vi o pa drã o popul a ci ona l
dos va l ores dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
9 - DSum Ca l cul a a s oma de todos os va l ores
di s ti ntos dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
10 - DAvg Ca l cul a a médi a ba s ea da nos va l ores
di s ti ntos dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou rel a tóri o)
11 - DCount Conta o número dos va l ores di s ti ntos
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
12 - DVar Ca l cul a a va ri â nci a dos va l ores di s ti ntos
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
13 - DVarP Ca l cul a a va ri â nci a popul a ci ona l dos
va l ores di s ti ntos dentro do i nterva l o de
tota i s es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
14 - DDev Ca l cul a o des vi o pa drã o dos va l ores
dentro do i nterva l o de tota i s
es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
15 - DDevP Ca l cul a o des vi o pa drã o popul a ci ona l
dos va l ores di s ti ntos dentro do i nterva l o
de tota i s es peci fi ca do (grupo, pá gi na ou
Rel a tóri o)
4.8.6.5.1.14 SummaryGroup
NOTA: Qua ndo es ta propri eda de é uti l i za da , a s propri eda des CanShrink e CanGrow
perma necem des a bi l i ta da s .
4.8.6.5.1.15 SummaryRunning
4.8.6.5.1.16 SummaryType
4.8.6.5.1.17 Text
4.8.6.5.1.18 VerticalAlignment
4.8.6.5.1.19 WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto SetPoint. Para que esta
propriedade funcione, a propriedade Multiline deve ser obrigatoriamente igual a
Verdadeiro. Se for igual a Falso, a configuração white-space:nowrap aparece na
propriedade Style.
352 Visualização
4.8.6.6 Texto
Esta seção contém informações sobre propriedades do objeto Texto do Relatório.
Este objeto não possui eventos nem métodos associados.
4.8.6.6.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Texto do Relatório.
4.8.6.6.1.1 Alignment
4.8.6.6.1.2 Angle
4.8.6.6.1.3 Caption
4.8.6.6.1.4 ClassName
4.8.6.6.1.5 Font
Esta propriedade indica o nome da fonte (tipo das letras) do texto. O valor
padrão desta propriedade é uma String vazia (o Elipse Power usar o padrão do
sistema operacional).
Visualização 353
NOTA: Es ta propri eda de nã o pode s er uti l i za da em s cri pts ou As s oci a ções , é
confi gura da s omente vi a Studi o e s ó pode s er modi fi ca da em tempo de
confi gura çã o.
4.8.6.6.1.6 ForeColor
4.8.6.6.1.7 hyperLink
4.8.6.6.1.8 Multiline
4.8.6.6.1.9 Style
A propriedade Style permite especificar um estilo CSS (Cascading Style Sheet) para
o texto, em substituição ao estilo global. O valor da propriedade deve ser uma
String CSS válida, caso contrário a propriedade é ignorada. O valor padrão desta
propriedade é uma String vazia (o Elipse Power usa o padrão do sistema
operacional). Exemplo:
Sub Report1_OnBeforePrint
Label1.Style = "font-family: Times; font-weight: bold;_
text-align: center; color: RGB(255, 255, 0)"
End Sub
4.8.6.6.1.10 VerticalAlignment
354 Visualização
4.8.6.6.1.11 WordWrap
Habilita ou desabilita uma quebra de linha no texto, caso a área disponível para
o texto ultrapasse os limites determinados no objeto. Para que esta propriedade
funcione, a propriedade Multiline deve ser obrigatoriamente igual a Verdadeiro.
4.8.6.7 Linha
Esta seção contém informações sobre propriedades do objeto Linha do Relatório.
Este objeto não possui eventos nem métodos associados.
4.8.6.7.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Linha do
Relatório.
4.8.6.7.1.1 LineColor
4.8.6.7.1.2 LineStyle
4.8.6.7.1.3 LineWeight
4.8.6.7.1.5 X2
4.8.6.7.1.6 Y1
4.8.6.7.1.7 Y2
4.8.6.8.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Quebra de Página
do Relatório.
4.8.6.8.1.1 Enabled
4.8.6.9 Tabela
Esta seção contém informações sobre propriedades do objeto Tabela do Relatório.
Este objeto não possui eventos nem métodos associados.
4.8.6.9.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tabela do
Relatório.
356 Visualização
4.8.6.9.1.1 CanGrow
4.8.6.9.1.2 CanShrink
4.8.6.9.1.3 CloseBorder
4.8.6.9.1.4 left
4.8.6.10 E3Chart
Esta seção contém informações sobre propriedades do objeto E3Chart do Relatório.
4.8.6.10.1 Propriedades
Exemplo de utilização das propriedades do E3Chart em um Relatório
Os scripts a seguir devem ser criados na Seção PageHeader do Relatório, utilizando
o evento OnBeforePrint. Exemplos:
Sub OnBeforePrint
' Usando um E3Chart em um Relatório
Set chart = _
Report.Sections("PageHeader").Controls("E3Chart1")
chart.LoadData()
chart.FitAll
End Sub
Sub OnBeforePrint
' Este script copia as configurações do objeto
' E3Chart chartfrom para o E3Chart chart
Visualização 357
' que é utilizado no Relatório.
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 des cri çã o da s propri eda des do E3Cha rt no Rel a tóri o s ã o a s mes ma s
expl i ca da s no tópi co Visualização - E3Chart - Propriedades.
4.9 PowerExplorer
Esta seção contém informações sobre métodos e propriedades do objeto
PowerExplorer. Este objeto não possui eventos associados.
4.9.1 Métodos
Esta seção contém informações sobre os métodos do objeto PowerExplorer.
4.9.1.1 CenterWindow
CenterWindow()
Informa que a janela do PowerExplorer deve ser centralizada. Se a janela já estiver
aberta, ela é centralizada imediatamente. Veja o método SetWindowPlacement
para maiores informações sobre o posicionamento da janela do objeto
PowerExplorer.
4.9.1.2 Close
Close()
Fecha a janela do PowerExplorer.
4.9.1.3 GetScreenTabFrame
GetScreenTabFrame(TabName)
Quando uma aba contendo uma Tela ou Quadro é criada no PowerExplorer (ver o
método InsertScreenTab), é criado antes um Quadro para conter esta Tela, a
exemplo do que ocorre no objeto Viewer.
O método GetScreenTabFrame retorna o Quadro da aba indicada pelo parâmetro
TabName, ou retorna erro de script se a aba não existe ou não tem Quadro (caso
das abas padrão).
358 Visualização
Este Quadro só é efetivamente criado no momento da primeira ativação da aba.
Logo, se a aba é criada mas nunca ativada, o método retorna um erro de script.
Sub
' script para alterar a Tela de uma aba do PowerExplorer
Set PEFrame = PE.GetScreenTabFrame("AbaGrafico")
PEFrame.OpenScreen("TelaChart2", 0)
End Sub
4.9.1.4 InsertScreenTab
InsertScreenTab(TabName, TabTitle, ScreenPath[, Arg])
Insere uma aba na janela do objeto PowerExplorer, com o nome indicado pelo
parâmetro TabName, contendo uma Tela indicada pelo parâmetro ScreenPath. O
título da aba é indicado no parâmetro TabTitle. Se este parâmetro estiver vazio, é
mostrado o valor informado no parâmetro TabName. Se a aba não existir, ela é
criada e, se já existir, altera a Tela. No caso de sobrescrever a Tela, caso o título
seja informado, este é substituído. Se o valor passado neste parâmetro for uma
String vazia, permanece o valor já configurado. Caso o usuário informe apenas o
título e a aba já exista, é aceito apenas trocar o título da aba.
Este método retorna Verdadeiro se uma nova aba foi criada, ou Falso se uma aba
existente foi sobrescrita. O método gera um erro de script se o nome da aba for
uma String vazia ou um nome padrão (Analogs, Discretes, Commands ou
Protections).
A aba é inserida sempre na última posição, e não é ativada no momento da
inserção. Ao clicar na aba para ativá-la, o evento OnPreShow da Tela é executado,
recebendo então o valor passado no parâmetro Arg. Exemplo:
Sub
Visualização 359
Set PE = Application.GetPowerExplorer("Sub1.Breaker1")
PE.InsertScreenTab "AbaGrafico", "Gráfico", "TelaChart", 0
PE.Show()
End Sub
4.9.1.5 RemoveScreenTab
RemoveScreenTab(TabName)
Remove a aba indicada pelo parâmetro TabName. Retorna Verdadeiro se a remoção
foi bem sucedida, ou Falso se a aba não foi removida por não existir. Este método
gera um erro de script se o parâmetro TabName for um nome de aba padrão
(Analogs, Discretes, Commands ou Protections) ou uma String vazia. Exemplo:
Sub
Set PE = Application.GetPowerExplorer("Sub1.Breaker1")
PE.RemoveScreenTab "AbaGrafico"
End Sub
4.9.1.6 SetWindowPlacement
SetWindowPlacement([PosX, PosY][, , SizeX, SizeY])
Informa a posição e o tamanho da janela do PowerExplorer. Se nenhuma posição
ou tamanho for especificado, o posicionamento desta janela obedece o modo
automático:
O tamanho inicial é o mínimo e, nas vezes subsequentes em que a janela for
aberta, este tamanho inicial é armazenado e reutilizado
A posição inicial é centralizada e, nas vezes subsequentes em que a janela
for aberta, esta posição inicial é armazenada e reutilizada
360 Visualização
Resumo do comportamento da janela PowerExplorer
MODO AUTOMÁTICO POSIÇÃO NÃO TAMANHO NÃO
ESPECIFICADA ESPECIFICADO
Tamanho Míni mo ou úl ti mo -- Míni mo
a rma zena do
Posição Centra l i za da ou Centra l i za da --
úl ti ma a rma zena da
4.9.1.7 Show
Show()
Mostra a janela do PowerExplorer, se ela não estiver visível. Se a janela já existir,
ela apenas recebe o foco.
4.9.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto PowerExplorer.
4.9.2.1 ActiveTab
Retorna ou seleciona a aba ativa na janela PowerExplorer. Caso o nome
configurado nesta propriedade seja inválido (uma String vazia ou o nome de uma
aba inexistente), é gerado um erro de script. Esta propriedade é atualizada sempre
que uma nova aba é selecionada na janela PowerExplorer. Da mesma forma, se a
aba ativa for removida, utilizando o método RemoveScreenTab, esta propriedade
também é atualizada para refletir a aba ativa.
4.9.2.2 AnalogInputMode
Indica qual o comportamento a ser adotado para validar a entrada de dados de
uma Medida Analógica. Os valores possíveis para esta propriedade são os
seguintes:
0 - aimGuessType (padrão): Independente do tipo de dado configurado na
fonte Operator da Medida, o operador pode digitar qualquer tipo de dado e
o PowerExplorer tenta converter este dado em um valor válido, dando
preferência para a conversão para o tipo atualmente em uso
1 - aimKeepType: Aceita a escrita de valores somente do tipo de dado
configurado na fonte Operator da Medida. Se o tipo da fonte for igual a Null
ou Empty, o PowerExplorer verifica qual o tipo de dado válido e, a partir
deste ponto, aceita somente valores deste tipo
Visualização 361
4.9.2.3 CommandConfirm
Indica se um Comando pede confirmação ou não. Os valores possíveis para esta
propriedade são os seguintes:
-1 - ccNever: Executa o Comando sem pedir confirmação ao usuário
0 - ccAlways: Sempre pede confirmação antes de executar o Comando
(comportamento padrão)
362 Visualização
4.9.2.4 CommandInterlockMode
Indica qual o comportamento a ser adotado quando uma Unidade de Comando
estiver intertravada. Os valores possíveis para esta propriedade são os seguintes:
0 - cimDoNothing: Não envia o Comando, não mostra o aviso de
intertravamento e nem desabilita o botão Operar da aba Comandos do
PowerExplorer
1 - cimWarning: Avisa o usuário que aquela Unidade de Comando está
intertravada. A mensagem é mostrada junto com a mensagem que pede
confirmação para o envio do Comando
2 - cimBlockCommand: Bloqueia o envio do Comando, desabilitando os
botões mesmo que existam scripts configurados. A exceção é o botão
Cancelar, que nunca é desabilitado
4.9.2.5 DisplayBkColor
Indica a cor de fundo dos Displays que mostram os valores das Medidas nas
abas Analógicas, Discretas e Proteções. O valor padrão desta propriedade é o valor
configurado para a cor de fundo do Windows (varia conforme o tema selecionado).
4.9.2.6 IsOpened
Informa se existe uma janela do PowerExplorer aberta ou não. Esta propriedade é
somente de leitura.
4.9.2.7 ReadOnly
Quando configurada para Verdadeiro, não permite modificar as Medidas ou
enviar Comandos (os botões Selecionar, Operar e Cancelar do Comando selecionado
na aba Comandos permanecem desabilitados). O valor padrão desta propriedade é
Falso.
4.9.2.8 ScreenObject
Indica a qual objeto de Tela o PowerExplorer está associado. O valor padrão
desta propriedade é nulo (não está associado a nenhum objeto de Tela). Exemplo de
uso:
Sub CommandButton_Click()
Set PE = Application.GetPowerExplorer("SE1.Bay1.Breaker1")
Visualização 363
Set PE.ScreenObject = Screen.Item("Breaker")
End Sub
4.9.2.9 SelectionColor
Retorna ou seleciona a cor de fundo da célula do objeto PowerExplorer, quando
ela estiver selecionada. Se nenhuma cor estiver selecionada, ou se esta
propriedade estiver configurada com o valor -1 (menos um), usa a cor padrão do
Windows. Exemplo de utilização, incluindo a propriedade SelectionColorInactive:
Set PE = Application.GetPowerExplorer("SE1.SYSTEM.[5201]")
PE.SelectionColor = RGB(255, 0, 0)
PE.SelectionColorInactive = RGB(0, 0, 255)
PE.Show
4.9.2.10 SelectionColorInactive
Retorna ou seleciona a cor de fundo da célula do objeto PowerExplorer, quando
ela estiver selecionada e a janela do PowerExplorer estiver inativa. Se nenhuma cor
estiver selecionada, ou se esta propriedade estiver configurada com o valor -1
(menos um), usa a cor padrão do Windows. Para um exemplo de utilização, veja a
propriedade SelectionColor.
4.9.2.11 ShowMeasurementTimestamp
Quando esta propriedade estiver em Verdadeiro, mostra uma coluna a mais na
janela do PowerExplorer, com o timestamp da Medida. Esta configuração se aplica
às três abas que mostram Medidas (Analógicas, Discretas e Proteções).
As configurações de cor desta coluna são as mesmas da coluna que mostra os
valores das Medidas (propriedade DisplayBkColor e as cores definidas para a
qualidade). O valor padrão desta propriedade é Falso.
4.9.2.12 SortMode
Esta propriedade indica o modo de ordenação de Medidas, Comandos e
Proteções na janela PowerExplorer. Os valores possíveis para esta propriedade são
os seguintes:
-1 - smNoSort: Sem ordenação, ou seja, os objetos são mostrados na ordem
em que são retornados pelo servidor
0 - smAlphabetic: Ordenação alfabética (padrão)
1 - smTypeSorting: A ordenação dos objetos é realizada com base nos
valores informados na coluna Ordenação, presente nas abas Analógicas,
Discretas, Comandos e Proteções do objeto Configurador do Power
364 Visualização
4.9.2.13 TabsEnabled
Permite configurar quais abas estão visíveis na janela do PowerExplorer. Se a
janela já estiver aberta, as abas são atualizadas imediatamente. A propriedade
aceita uma combinação dos seguintes valores:
1: Mostra apenas a aba Analógicas
2: Mostra apenas a aba Discretas
4: Mostra apenas a aba Comandos
8: Mostra apenas a aba Proteções
4.9.2.14 Title
Retorna ou modifica o título da janela do objeto PowerExplorer. Se nenhum valor
for especificado, o título da janela é composto pelo caminho do objeto associado
mais a expressão " - PowerExplorer".
Visualização 365
CAPÍTULO
Objetos de Servidor
5
Esta seção contém informações sobre as propriedades comuns aos objetos de
Servidor. Estes objetos não possuem eventos nem métodos comuns. Os objetos que
compartilham propriedades de Servidor são os seguintes:
Configurador do Power
Processador Topológico
Fluxo de Potência
Estudo de Descarte de Cargas
Comandos
Equipamentos
Medidas e Fontes de Medida
Proteções
Objetos em Tempo de Execução do Servidor
Objetos em Tempo de Configuração
Drivers
Servidor de Dados
Banco de Dados
Históricos
Storage
Fórmulas
Alarmes
5.1.1 IsAlarmArea
Habilita ou desabilita a funcionalidade de Área de Alarme para os objetos de
Servidor. Esta propriedade não está disponível nos objetos Área de Alarme, Fonte de
Alarme e Servidor de Alarmes. O valor padrão desta propriedade é Falso (no caso
366 Objetos de Servidor
de Equipamentos, o valor padrão é Verdadeiro). Ao habilitar esta propriedade, o
objeto passará a contar com as mesmas propriedades de uma Área de Alarme.
5.1.2.1 ActiveAlarms
Determina o número de alarmes ativos dentro do objeto. Esta propriedade é
somente de leitura.
5.1.2.2 ActiveHighAlarms
Indica o número de alarmes ativos com severidade alta. Esta propriedade é
somente de leitura.
5.1.2.3 ActiveHighNACKAlarms
Indica o número de alarmes não reconhecidos com severidade alta. Esta
propriedade é somente de leitura.
5.1.2.4 ActiveLowAlarms
Indica o número de alarmes ativos com severidade baixa. Esta propriedade é
somente de leitura.
5.1.2.5 ActiveLowNACKAlarms
Indica o número de alarmes não reconhecidos com severidade baixa. Esta
propriedade é somente de leitura.
5.1.2.6 ActiveMedAlarms
Indica o número de alarmes ativos com severidade média. Esta propriedade é
somente de leitura.
5.1.2.7 ActiveMedNACKAlarms
Indica o número de alarmes não reconhecidos com severidade média. Esta
propriedade é somente de leitura.
5.1.2.9 Alarm
Estabelece a existência de alarmes ativos dentro do objeto. Se a opção estiver em
True, existe pelo menos um alarme ativo dentro do objeto, e a propriedade
ActiveAlarms fará a leitura no servidor, indicando a quantidade de alarme ativos.
Caso contrário, a propriedade ActiveNACKAlarms fará a leitura dos alarmes sem
reconhecimento. Esta propriedade é somente de leitura.
5.1.2.10 AlarmVerify
Habilita a verificação de todos os alarmes dentro do objeto. Depois de habilitada
esta verificação (True), se a propriedade ActiveAlarms possuir valor maior que 0
(zero), o servidor verifica tanto os alarmes ativos quanto os sem reconhecimento,
listando estes últimos pela propriedade ActiveNACKAlarms. Esta propriedade é útil
para evitar-se o efeito de avalanche de alguns sistemas, onde o acontecimento de
um evento gera uma grande quantidade de alarmes correlacionados.
5.1.2.11 InactiveHighNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade alta.
Esta propriedade é somente de leitura.
5.1.2.12 InactiveLowNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade baixa.
Esta propriedade é somente de leitura.
5.1.2.13 InactiveMedNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade média.
Esta propriedade é somente de leitura.
5.1.2.14 InactiveNACKAlarms
Determina o número total de alarmes inativos e não reconhecidos. Esta
propriedade é somente de leitura.
5.1.2.15 UserFields
Retorna um objeto que é uma coleção de Campos de Usuário de Alarmes de um
objeto de Servidor. Veja o item Coleção de Campos de Usuário de Alarmes para
368 Objetos de Servidor
maiores informações sobre a coleção de objetos retornados por esta propriedade.
5.2.1 Configuração
Esta seção contém informações sobre os objetos de Configuração do Elipse Power.
5.2.1.1.1 Eventos
Esta seção contém informações sobre os eventos do objeto Configurador do Power
(PowerConfig).
5.2.1.1.1.1 OnCommand
5.2.1.1.1.2 OnCommandEx
OnCommandEx(CommandInfo)
Este evento sempre é disparado quando qualquer Comando é executado, da mesma
forma que o evento OnCommand. O parâmetro CommandInfo é um objeto do tipo
PowerCommandInfo, que contém as propriedades descritas na tabela a seguir,
todas do tipo Somente Leitura.
Propriedades do objeto PowerCommandInfo
PROPRIEDADE DESCRIÇÃO
CommandInfo.ActorID Nome do us uá ri o que envi ou o Coma ndo.
Pode s er o l ogon do us uá ri o do Vi ewer,
"Anonymous " s e nã o há us uá ri o l oga do
ou "Sys tem" s e a cha ma da do método s e
ori gi nou no s ervi dor.
CommandInfo.CommandAction Um i ntei ro que i ndi ca o ti po de Coma ndo
envi a do (1: Operate, 2: Select ou 3: Cancel).
CommandInfo.CommandUnit Objeto Uni da de de Coma ndo que es tá
recebendo o coma ndo.
CommandInfo.FeedbackValue Indi ca o va l or de retorno confi gura do no
Templ a te, referente à opera çã o de
coma ndo envi a da (Operate, Select ou
Cancel).
CommandInfo.WriteValue Indi ca o va l or de es cri ta referente à
opera çã o de coma ndo que es tá s endo
envi a da (Operate, Select ou Cancel).
5.2.1.1.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Configurador do
Power (PowerConfig).
5.2.1.1.2.1 MeasurementColors
5.2.1.1.2.2 ModelDriver
5.2.1.1.2.3 ModelFile
Caminho do arquivo de modelo elétrico (no formato XPD ou EDB). Este caminho,
se relativo, considera o caminho do projeto que contém o objeto Configurador do
Power. Esta propriedade não pode ser modificada em tempo de execução.
5.2.1.1.3.1 Propriedades
5.2.1.2.1 Autorrecuperação
Esta seção contém informações sobre as propriedades do Estudo Elétrico de tipo
Autorrecuperação (SelfHealingStudy). Este objeto não possui eventos nem métodos
associados.
BackupDiscardTimeUnit
A propriedade BackupDiscardTimeUnit indica a unidade de tempo em que os
dados de backup permanecem armazenados até serem descartados. As opções
disponíveis são:
0 - dtHour: Horas
1 - dtDay: Dias
2 - dtMonth: Meses (padrão)
3 - dtMinute: Minutos
5.2.1.2.2.1 Propriedades
5.2.1.2.3.1 Propriedades
5.2.1.2.4.1 Propriedades
5.2.1.2.5.1 Propriedades
5.2.1.2.6.1 Propriedades
5.2.1.2.7.1 Propriedades
5.2.2 Comandos
Esta seção contém informações sobre os objetos do tipo Comando do Elipse Power.
5.2.2.1.1 Propriedades
5.2.2.1.1.1 Caption
5.2.2.1.1.2 CommandType
5.2.2.1.1.3 Conversion
Configura qual a conversão utilizada pelo Comando. Este valor deve ser uma das
conversões criadas para o tipo selecionado. Cada conversão define como o
Comando é executado, com diferentes valores de escrita e scripts. Esta propriedade
não pode ser alterada em tempo de execução.
5.2.2.1.1.4 Enabled
5.2.2.1.1.5 EnablePowerConfigEvent
5.2.2.2.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Comando de
Passo (PowerStepCommand).
5.2.2.2.1.1 Caption
5.2.2.2.1.2 CommandType
Configura qual a conversão utilizada pelo Comando. Este valor deve ser uma das
conversões criadas para o tipo selecionado. Cada conversão define como o
Comando é executado, com diferentes valores de escrita e scripts. Esta propriedade
não pode ser modificada em tempo de execução.
5.2.2.2.1.4 Enabled
5.2.2.2.1.5 EnablePowerConfigEvent
5.2.2.2.1.6 HighPosition
5.2.2.2.1.7 LowPosition
5.2.2.3.1 Propriedades
5.2.2.3.1.1 Interlocked
5.2.2.4.1 Eventos
Esta seção contém informações sobre os eventos do objeto Unidade de Comando
(PowerCommandUnit).
5.2.2.4.1.1 OnCancel
5.2.2.4.1.2 OnCancelFinished
5.2.2.4.1.3 OnOperate
5.2.2.4.1.4 OnOperateFinished
NOME DESCRIÇÃO
ActorID Informa pa ra o s cri pt o nome do us uá ri o
pa s s a do no pa râ metro ActorID do
método Operate na Uni da de de Coma ndo.
Se omi ti do na cha ma da do método,
a s s ume o l ogon do us uá ri o do Vi ewer,
"Anonymous " s e nã o há us uá ri o l oga do
ou "Sys tem" s e a cha ma da do método foi
ori gi na da no s ervi dor.
Failed Qua ndo em Verda dei ro s i na l i za que a
Açã o do Coma ndo fa l hou e i s to foi
i nforma do pel o pa râ metro Failed do
s cri pt do evento OnOperate.
Canceled Qua ndo es ti ver em Verda dei ro, i ndi ca
que o método Operate termi nou
prema tura mente.
FeedbackError Qua ndo em Verda dei ro s i na l i za que a
Açã o do Coma ndo fa l hou porque o va l or
de retorno nã o pôde s er l i do dentro do
tempo l i mi te. Is to pode ocorrer porque o
Ta g de retorno nã o exi s te (um erro de
confi gura çã o), ou o va l or es tá com
qua l i da de rui m. No ca s o do Ta g ma l
confi gura do (por exempl o, um erro de
s i nta xe) é pos s ível que o pa râ metro
FeedbackError s eja i medi a to (s em tempo
de es pera ).
ScriptError Qua ndo em Verda dei ro s i na l i za que a
Açã o do Coma ndo fa l hou porque o s cri pt
teve um erro de execuçã o em a l gum
ponto.
5.2.2.4.1.5 OnSelect
5.2.2.4.1.6 OnSelectFinished
NOME DESCRIÇÃO
ActorID Informa pa ra o s cri pt o nome do us uá ri o
pa s s a do no pa râ metro ActorID do
método Select na Uni da de de Coma ndo.
Se omi ti do na cha ma da do método,
a s s ume o l ogon do us uá ri o do Vi ewer,
"Anonymous " s e nã o há us uá ri o l oga do
ou "Sys tem" s e a cha ma da do método foi
ori gi na da no s ervi dor.
Failed Qua ndo em Verda dei ro s i na l i za que a
Açã o do Coma ndo fa l hou e i s to foi
i nforma do pel o pa râ metro Failed do
s cri pt do evento OnSelect.
Canceled Qua ndo es ti ver em Verda dei ro, i ndi ca
que o método Select termi nou
prema tura mente.
FeedbackError Qua ndo em Verda dei ro s i na l i za que a
Açã o do Coma ndo fa l hou porque o va l or
de retorno nã o pôde s er l i do dentro do
tempo l i mi te. Is to pode ocorrer porque o
Ta g de retorno nã o exi s te (um erro de
confi gura çã o), ou o va l or es tá com
qua l i da de rui m. No ca s o do Ta g ma l
confi gura do (por exempl o, um erro de
s i nta xe) é pos s ível que o pa râ metro
FeedbackError s eja i medi a to (s em tempo
de es pera ).
ScriptError Qua ndo em Verda dei ro s i na l i za que a
Açã o do Coma ndo fa l hou porque o s cri pt
teve um erro de execuçã o em a l gum
ponto.
5.2.2.4.2 Métodos
Esta seção contém informações sobre os métodos do objeto Unidade de Comando
(PowerCommandUnit).
5.2.2.4.2.1 Abort
Abort([ActorID])
Cancela imediatamente uma ação pendente. Este método é chamado
automaticamente se a Unidade de Comando é desativada. O parâmetro ActorID é o
nome do usuário. Se omitido, assume o logon do usuário do Viewer, "Anonymous"
se não há usuário logado ou "System" se a chamada do método foi originada no
servidor. Exemplo de utilização:
Sub CommandButton1_Click()
Set CMDUnit = Application.GetObject(_
"Substation1.Breaker1.Commands.cmdPosicaoDisjuntor.Abrir")
CMDUnit.Abort()
End Sub
5.2.2.4.2.2 Cancel
Cancel([ActorID])
Executa a ação de Cancel, onde o parâmetro ActorID é o nome do usuário. Se
omitido, assume o logon do usuário do Viewer, "Anonymous" se não há usuário
logado ou "System" se a chamada do método foi originada no servidor. Caso haja
uma ação Operate ou Select pendente (em espera), estas ações são canceladas e o
evento OnOperateFinished ou OnSelectFinished é imediatamente disparado,
executando o script associado a ele e cancelando esta ocorrência. Para que esta
ação ocorra, algumas condições são necessárias:
O Comando pai da Unidade deve estar com a propriedade Enabled
configurada para Verdadeiro
Não deve existir nenhum comando Cancel pendente na Unidade de Comando,
ou seja, a propriedade ActionInProgress deve ser igual a 0 (zero, Nenhum), 1
(um, Operate) ou 2 (dois, Select)
Este comando espera pelo valor de retorno até o tempo limite especificado se todas
as seguintes condições forem atendidas:
O script foi executado com sucesso
O script não foi cancelado
O tempo limite de retorno da Conversão não é 0 (zero)
O caminho do Tag de retorno não é vazio
Caso o valor de retorno não seja utilizado pelo Tag dentro do tempo limite, ou se o
caminho do Tag é inválido (mas não é vazio), este comando é considerado como
falho. Exemplo de utilização:
Sub CommandButton1_Click()
Set CMDUnit = Application.GetObject(_
"Substation1.Breaker1.Commands.cmdPosicaoDisjuntor.Abrir")
CMDUnit.Cancel()
End Sub
5.2.2.4.2.3 Operate
Operate([ActorID])
Executa a ação de Operate, onde o parâmetro ActorID é o nome do usuário. Se
omitido, assume o logon do usuário do Viewer, "Anonymous" se não há usuário
logado ou "System" se a chamada do método foi originada no servidor. Para que
esta ação ocorra, algumas condições são necessárias:
O Comando pai da Unidade deve ter a sua propriedade Enabled ajustada
para Verdadeiro
Não deve haver nenhum comando pendente em operação na Unidade de
Comando, ou seja, a propriedade ActionInProgress deve ser igual a 0 (zero,
Nenhum)
O script do evento OnOperate deve estar definido no tipo de Conversão do
comando configurado
Caso o valor de retorno não seja usado pelo Tag dentro do tempo limite, ou se o
caminho do Tag é inválido (mas não vazio), o comando é considerado como falho.
Exemplo de utilização:
Sub CommandButton1_Click()
Set CMDUnit = Application.GetObject(_
"Substation1.Breaker1.Commands.cmdPosicaoDisjuntor.Abrir")
If CMDUnit.Interlocked = True Then
MsgBox "A Unidade de Comando está intertravada!"
Else
CMDUnit.Operate()
End If
End Sub
5.2.2.4.2.4 Select
Select([ActorID])
Executa a ação de Select, onde o parâmetro ActorID é o nome do usuário. Se
omitido, assume o logon do usuário do Viewer, "Anonymous" se não há usuário
logado ou "System" se a chamada do método foi originada no servidor. Para que
esta ação ocorra, algumas condições devem ser satisfeitas:
O Comando pai da Unidade deve ter a propriedade Enabled configurada
como Verdadeiro
Não deve haver nenhum comando operando na Unidade de Comando, ou
seja, a propriedade ActionInProgress deve ser igual a 0 (zero, Nenhum)
O script do evento OnSelect deve estar definido no tipo de Conversão do
comando configurado
Este método aguarda pelo valor de retorno até o tempo limite especificado se todas
as seguintes condições forem satisfeitas:
Caso o valor de retorno não seja usado pelo Tag dentro do tempo limite ou se o
caminho do Tag é inválido (mas não vazio), o comando é considerado como falho.
Exemplo de utilização:
Sub CommandButton1_Click()
Set CMDUnit = Application.GetObject(_
"Substation1.Breaker1.Commands.cmdPosicaoDisjuntor.Abrir")
If CMDUnit.Interlocked = True Then
MsgBox "A Unidade de Comando está intertravada!"
Else
CMDUnit.Select()
End If
End Sub
5.2.2.4.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Unidade de
Comando (PowerCommandUnit).
5.2.2.4.3.1 ActionInProgress
Caminho do Tag que recebe o valor de retorno quando uma ação Cancel é
enviada. Se o valor é uma String vazia, cancela o tempo de espera pelo retorno
desta ação.
5.2.2.4.3.3 CancelWriteTag
5.2.2.4.3.4 Caption
5.2.2.4.3.5 CommandName
Configura qual a Unidade de Comando utilizada. Este nome deve existir no tipo de
Comando configurado.
5.2.2.4.3.6 CurrentRetry
5.2.2.4.3.7 Interlocked
5.2.2.4.3.8 OperateFeedbackTag
Caminho do Tag que recebe o valor de retorno quando uma ação Operate é
enviada. Se o valor é uma String vazia, cancela o tempo de espera para o retorno
desta ação.
5.2.2.4.3.10 SelectFeedbackTag
Caminho do Tag que recebe o valor de retorno quando uma ação de Select é
enviada. Se o valor é uma String vazia, cancela o tempo de espera para o retorno
desta ação.
5.2.2.4.3.11 SelectWriteTag
5.2.2.4.3.12 StatusMessage
5.2.2.5.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Unidade de
Intertravamento (PowerInterlockUnit).
5.2.2.5.1.1 ComparisonOperator
5.2.2.5.1.3 ComparisonValueCaption
5.2.2.5.1.4 Interlocked
5.2.2.5.1.5 Measurement
5.2.3 Equipamentos
Esta seção contém informações sobre os objetos do tipo Equipamento do Elipse
Power.
5.2.3.1.1 GetMeasurement
GetMeasurement(Terminal, Type)
Retorna o objeto de Medida de tipo Type instanciado no Terminal do equipamento.
Se esta Medida não existir, retorna um erro. O parâmetro Terminal deve ser um dos
seguintes valores:
0: Nenhum - no Grupo de Medidas
1: Terminal 1
2: Terminal 2
3: Terminal 3
5.2.3.2.1 BaseVoltage
Tensão de base do equipamento, em kV (Quilovolts). Este valor não pode ser zero
ou negativo, e geralmente é importado do modelo elétrico.
5.2.3.2.2 Config
Retorna o objeto Configurador do Power ativo. Esta propriedade só está
disponível em tempo de execução.
5.2.3.2.3 ID
Identificador único do equipamento no modelo elétrico. Este valor geralmente é
importado do modelo elétrico, e não pode ser modificado em tempo de execução.
No Modelador Elétrico esta propriedade é automaticamente atribuída pelo sistema,
e é uma propriedade somente de leitura.
NOTA: Pa ra a rqui vos de model o el étri co no forma to XPD, o va l or des ta propri eda de
é um Inteiro Longo. Já pa ra a rqui vos de model o el étri co em forma to EDB, o va l or
des ta propri eda de é uma String GUID (como por exempl o "{6B29FC40-CA47-1067-
B31D-00DD010662DA}"). Pa ra equi pa mentos que nã o fa zem pa rte do model o
el étri co, o va l or des ta propri eda de é 0 (zero) no forma to XPD e "{00000000-0000-
0000-0000-000000000000}" no forma to EDB.
5.2.3.2.4 Note
Nota de operação que pode ser definida livremente pelo usuário.
5.2.3.2.5 ShortName
Nome alternativo para o equipamento. Em tempo de execução, caso esta
propriedade não esteja preenchida, retorna o conteúdo da propriedade Name.
Geralmente é importado do modelo elétrico.
5.2.3.2.6 StrokeColor
5.2.3.3 Alimentador
O objeto Alimentador (PowerFeeder) não tem eventos, métodos ou propriedades
específicos associados, somente métodos e propriedades gerais. Estes podem ser
visualizados nas seções Métodos Comuns e Propriedades Comuns.
5.2.3.4 Barramento
O objeto Barramento (PowerBusBar) não tem eventos, métodos ou propriedades
específicos associados, somente métodos e propriedades gerais. Estes podem ser
visualizados nas seções Métodos Comuns e Propriedades Comuns.
5.2.3.5 Bay
O objeto Bay (PowerBay) não tem eventos nem métodos ou propriedades específicos
associados, somente métodos e propriedades gerais. Estes podem ser visualizados
nas seções Métodos Comuns e Propriedades Comuns.
5.2.3.6 Capacitor
Esta seção contém informações sobre as propriedades do objeto Capacitor
(PowerCapacitor). Este objeto não tem eventos nem métodos associados.
5.2.3.6.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Capacitor
(PowerCapacitor).
5.2.3.6.1.1 NominalReactivePower
5.2.3.7 Carga
Esta seção contém informações sobre as propriedades do objeto Carga
(PowerLoad). Este objeto não tem eventos nem métodos associados.
5.2.3.7.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Carga
(PowerLoad).
5.2.3.7.1.2 NominalPowerFactor
5.2.3.7.2.1 Propriedades
5.2.3.8.1 Propriedades
5.2.3.8.1.2 NominalPowerFactor
Fator de potência nominal do equipamento. Este valor deve estar entre 0 (zero) e 1
(um), e geralmente é importado do modelo elétrico.
5.2.3.9 Chave
Esta seção contém informações sobre as propriedades do objeto Chave
(PowerSwitch). Este objeto não tem eventos nem métodos associados.
5.2.3.9.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Chave
(PowerSwitch).
5.2.3.9.1.1 NormalState
5.2.3.9.1.2 StateColor
5.2.3.9.1.3 SwitchPosition
5.2.3.10.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Chave Fusível
(PowerSwitchFuse).
5.2.3.10.1.1 NormalState
5.2.3.10.1.2 StateColor
5.2.3.10.1.3 SwitchPosition
5.2.3.11 Disjuntor
Esta seção contém informações sobre as propriedades do objeto Disjuntor
(PowerBreaker). Este objeto não tem eventos nem métodos associados.
5.2.3.11.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Disjuntor
(PowerBreaker).
5.2.3.11.1.1 BreakerPosition
5.2.3.11.1.2 NormalState
5.2.3.11.1.3 StateColor
5.2.3.11.2.1 Propriedades
5.2.3.12.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Gerador
(PowerGenerator).
5.2.3.12.1.1 NominalApparentPower
5.2.3.14 Reator
Esta seção contém informações sobre as propriedades do objeto Reator
(PowerReactor). Este objeto não tem eventos nem métodos associados.
5.2.3.14.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Reator
(PowerReactor).
5.2.3.14.1.1 NominalReactivePower
5.2.3.15.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Regulador de
Tensão (PowerVoltageReg).
Objetos de Servidor 403
5.2.3.15.1.1 LoadTerminal
Especifica o lado onde a carga está conectada. Os valores possíveis para esta
propriedade são os seguintes:
1: A carga está conectada ao terminal 1
2: A carga está conectada ao terminal 2
5.2.3.15.1.2 NominalApparentPower
5.2.3.15.1.3 TapHighPosition
5.2.3.15.1.4 TapLowPosition
5.2.3.15.1.5 TapNeutralPosition
5.2.3.15.1.6 TapStepVoltageIncrement
5.2.3.16 Religador
Esta seção contém informações sobre as propriedades do objeto Religador
(PowerRecloser). Este objeto não tem eventos nem métodos associados.
5.2.3.16.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Religador
(PowerRecloser).
5.2.3.16.1.2 NormalState
5.2.3.16.1.3 StateColor
5.2.3.19 Terminal
Esta seção contém informações sobre as propriedades do objeto Terminal
(PowerTerminal). Este objeto não tem eventos nem métodos associados.
5.2.3.19.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Terminal
(PowerTerminal).
5.2.3.19.1.1 PositiveFlowIn
5.2.3.19.1.2 TerminalState
5.2.3.19.1.3 VoltageColor
Fornece a cor relativa ao nível de tensão do equipamento. A cor para cada tensão
é configurada no objeto Configurador do Power. Esta cor pode ter mais ou menos
brilho, dependendo do estado do Terminal (energizado or desenergizado). Esta
propriedade é usada para facilitar a construção de objetos de Tela que apontam
para este objeto. Esta propriedade só está disponível em tempo de execução.
5.2.3.20.1 Propriedades
5.2.3.20.1.1 BaseVoltage1
5.2.3.20.1.2 BaseVoltage2
5.2.3.20.1.3 ConnectionType1
5.2.3.20.1.4 ConnectionType2
5.2.3.20.1.6 TapHighPosition
5.2.3.20.1.7 TapLowPosition
5.2.3.20.1.8 TapNeutralPosition
5.2.3.20.1.9 TapPosition
5.2.3.20.1.10 TapStepVoltageIncrement
5.2.3.20.1.11 TapTerminal
Para modificar a posição do tap, deve-se utilizar o menu contextual do objeto. Este
valor geralmente é importado do modelo elétrico e é somente de leitura.
5.2.3.21.1 Propriedades
5.2.3.21.1.1 BaseVoltage1
5.2.3.21.1.2 BaseVoltage2
5.2.3.21.1.3 ConnectionType1
5.2.3.21.1.4 ConnectionType2
5.2.3.21.1.6 TapHighPosition
5.2.3.21.1.7 TapLowPosition
5.2.3.21.1.8 TapNeutralPosition
5.2.3.21.1.9 TapPosition
5.2.3.21.1.10 TapStepVoltageIncrement
5.2.3.21.1.11 TapTerminal
Para modificar a posição do tap, deve-se utilizar o menu contextual do objeto. Este
valor geralmente é importado do modelo elétrico e é somente de leitura.
5.2.3.22.1 Propriedades
5.2.3.22.1.1 BaseVoltage1
5.2.3.22.1.2 BaseVoltage2
5.2.3.22.1.3 BaseVoltage3
5.2.3.22.1.4 ConnectionType1
5.2.3.22.1.5 ConnectionType2
5.2.3.22.1.6 ConnectionType3
5.2.3.22.1.7 NominalApparentPower1
5.2.3.22.1.8 NominalApparentPower2
5.2.3.22.1.9 NominalApparentPower3
5.2.3.23 Trecho
Esta seção contém informações sobre as propriedades do objeto Trecho
(PowerBranch). Este objeto não tem eventos nem métodos associados.
5.2.3.23.1 Propriedades
5.2.4.1.1 Métodos
Esta seção contém informações sobre os métodos do objeto Fonte de Medida
Analógica (PowerAnalogSource).
5.2.4.1.1.1 WriteEx
5.2.4.1.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte de Medida
Analógica (PowerAnalogSource).
5.2.4.1.2.1 MeasurementColor
5.2.4.1.2.2 Quality
5.2.4.1.2.3 Tag
5.2.4.1.2.4 TimeStamp
5.2.4.1.2.5 Value
5.2.4.2.1 Métodos
Esta seção contém informações sobre os métodos do objeto Fonte de Medida
Discreta (PowerDiscreteSource).
5.2.4.2.1.1 WriteEx
5.2.4.2.2.1 Conversion
5.2.4.2.2.2 MeasurementColor
5.2.4.2.2.3 Quality
5.2.4.2.2.4 Tag
5.2.4.2.2.5 TimeStamp
5.2.4.2.2.6 Value
5.2.4.2.2.7 ValueCaption
5.2.4.3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Medida Analógica
(PowerAnalogMeasurement).
5.2.4.3.1.1 ActiveSource
Fonte de Medida usada como ativa pelo objeto. Os valores possíveis para esta
propriedade são os seguintes:
1: SCADA
2: Operador
3: Centro de Controle
4: Faturamento
5: Calculada
6: Banco de Dados
100: Processador Topológico
101: Fluxo de Potência
102: Estimador de Estados
103: Descarte de Cargas
104: Modelagem de Cargas para Distribuição
105: Autorrecuperação
106: Leitor Externo
O tipo de Fonte selecionado deve existir na Medida, para que possa ser
5.2.4.3.1.2 Caption
5.2.4.3.1.3 MeasurementColor
5.2.4.3.1.4 MeasurementType
5.2.4.3.1.5 Quality
5.2.4.3.1.6 StudyInputSource
O tipo de fonte selecionado deve existir na Medida para que seja configurado como
uma entrada do Estudo Elétrico. Se esta propriedade está configurada como 0
(Fonte Ativa), segue a configuração feita na propriedade ActiveSource. Não é
possível selecionar o tipo 0 (Fonte Ativa) se a propriedade ActiveSource está
configurada como 100, 101, 102, 103, 104, 105 ou 106 (saídas de estudos
elétricos). Caso a fonte selecionada seja apagada, esta propriedade assume o
valor -1 (Nenhuma).
5.2.4.3.1.7 TimeStamp
5.2.4.3.1.8 Unit
5.2.4.3.1.9 UnitPrefix
5.2.4.3.1.10 Value
5.2.4.4.1 Propriedades
5.2.4.4.1.1 ActiveSource
Fonte de Medida usada como ativa pelo objeto. Os valores possíveis para esta
propriedade são os seguintes:
1: SCADA
2: Operador
3: Centro de Controle
4: Faturamento
5: Calculada
6: Banco de Dados
100: Processador Topológico
101: Fluxo de Potência
102: Estimador de Estados
103: Descarte de Cargas
104: Modelagem de Cargas para Distribuição
105: Autorrecuperação
106: Leitor Externo
O tipo de Fonte selecionado deve existir na Medida, para que possa ser
configurado como ativo. Não é possível selecionar os tipos 100, 101, 102, 103, 104,
105 ou 106 (saídas de estudos elétricos) se a propriedade StudyInputSource está
configurada como 0 (Fonte Ativa). Caso a Fonte selecionada seja apagada, esta
propriedade assume o valor 2 (Operador).
5.2.4.4.1.3 MeasurementColor
5.2.4.4.1.4 MeasurementType
5.2.4.4.1.5 Quality
5.2.4.4.1.6 StudyInputSource
5.2.4.4.1.7 TimeStamp
5.2.4.4.1.8 Value
5.2.4.4.1.9 ValueCaption
5.2.5 Proteções
Esta seção contém informações sobre os métodos e as propriedades do objeto
Proteção (PowerProtectionDevice). Este objeto não tem eventos associados.
5.2.5.1 Métodos
Esta seção contém informações sobre os métodos do objeto Proteção
(PowerProtectionDevice).
5.2.5.1.1 GetMeasurement
GetMeasurement(Terminal, Type)
Retorna o objeto de Medida de tipo Type instanciado na Proteção. Se esta Medida
não existir, retorna um erro. O parâmetro Terminal deve ser sempre igual a 0 (zero).
5.2.5.2.1 Acronym
Retorna a sigla configurada para a Proteção, levando em consideração o tipo de
Proteção que foi configurado na propriedade ProtectionType. Esta propriedade visa
facilitar a criação de scripts, objetos de Tela ou gravações em bancos de dados que
necessitem de uma sigla (seja ANSI, 61870 ou outra definida pelo usuário) que
especifica o tipo de Proteção.
5.2.5.2.2 Caption
Retorna a descrição configurada para a Proteção, levando em consideração o
tipo de Proteção que foi configurado na propriedade ProtectionType. Esta
propriedade permite expressões, conforme descrito no tópico Propriedades do Tipo
Texto com Associações, no Manual do Usuário do Elipse Power.
5.2.5.2.3 Config
Retorna o objeto Configurador do Power ativo. Esta propriedade é somente de
leitura e só está disponível em tempo de execução.
5.2.5.2.4 ElectricalPhase
Fase elétrica à qual a Proteção está se referindo. Diferente dos Comandos e
Medidas, que possuem configuração de fase diretamente no Template (padrão), nas
Proteções a fase está atrelada à instância do objeto, em parte porque isto diminui
o número de Proteções necessárias (não há necessidade de criar uma Proteção por
fase) e também porque muitas Proteções são do equipamento como um todo.
5.2.5.2.5 ProtectionMode
Recebe o valor inteiro vindo da Medida de tipo *ProtectionMode, como se fosse
um atalho para o valor da Medida. Esta propriedade informa qual modo de
Proteção está configurado:
0: Excluída
1: Incluída
2: Bloqueada
3: Teste
4: Teste e Bloqueada
422 Objetos de Servidor
Esta propriedade facilita a criação de objetos (sejam de Tela ou de dados) que
precisam da informação do modo de Proteção, bastando que esta propriedade seja
lida, ao invés de buscar por um objeto filho da Proteção.
5.2.5.2.6 ProtectionOperate
Recebe o valor inteiro vindo da Medida de tipo *ProtectionOperate, como se
fosse um atalho para o valor da Medida. Esta propriedade informa qual a atuação
da Proteção corrente:
0: Normal
1: Atuada
5.2.5.2.7 ProtectionType
Tipo de Proteção que está sendo utilizado no objeto Proteção. Nesta propriedade
é configurado o padrão de Proteção criado no objeto Configuração do Power. O
valor desta propriedade pode ser configurado tanto na Lista de Propriedades
quanto na coluna Tipo da aba Design dos objetos Subestação, Alimentador e Linha
de Transmissão. Esta propriedade não pode ser alterada em tempo de execução e
não pode ser uma String vazia.
5.2.6.1.1 DisplayX
Coordenada horizontal do Display que apresenta o nome do objeto na tela do
Modelador Elétrico.
5.2.6.1.2 DisplayY
5.2.6.1.4 ExternalId
ID do objeto no banco de dados externo do Modelador Elétrico.
5.2.6.1.5 Rotation
Ângulo de rotação do objeto.
5.2.6.1.6 Size
Tamanho do objeto na tela do Modelador Elétrico (este valor deve ser positivo).
5.2.6.2.1 Bay
O objeto Bay (EDBBAY) não tem eventos, métodos ou propriedades específicos
associados, somente propriedades gerais. Estas podem ser visualizadas no tópico
Propriedades Comuns.
5.2.6.2.3 Sistema
Esta seção contém informações sobre as propriedades do objeto Sistema (EDBSYS).
Este objeto não tem eventos nem métodos associados.
NOTA: A i ma gem s empre preenche toda a á rea de model a gem. Porta nto, é
recomenda do que a á rea da i ma gem e a de model a gem tenha m a mes ma
proporçã o (aspect ratio).
CanvasBottom
Coordenada mínima do eixo vertical da área de modelagem do Sistema.
CanvasLeft
Coordenada mínima do eixo horizontal da área de modelagem do Sistema.
CanvasRight
Coordenada máxima do eixo horizontal da área de modelagem do Sistema.
CanvasTop
Coordenada máxima do eixo vertical da área de modelagem do Sistema.
FlowInitMethod
Método de inicialização do algoritmo de fluxo de potência (quando habilitado).
Os valores possíveis para esta propriedade são os seguintes:
1: Caso Base
2: Flat Start
3: Desacoplado Rápido
4: Linear
FlowMaxIterations
Número máximo de iterações do algoritmo de fluxo de potência. Um número muito
pequeno de iterações pode fazer com que o sistema não convirja. Este valor deve
estar entre 1 (um) e 100.
FlowTolerance
Tolerância do algoritmo de fluxo de potência, em MVA (Megavolt Ampère).
Corresponde ao máximo erro permitido no fluxo de potência. Quanto menor o
valor, mais longo o tempo para encontrar uma resposta. Este valor deve estar entre
0,001 e 100,0.
FontSize
Tamanho da fonte dos textos mostrados na área de modelagem (este valor deve
ser positivo).
GridSize
Distância entre as linhas da grade do desenho (este valor deve ser positivo).
StrokeThickness
Espessura das linhas do Sistema (este valor deve ser positivo).
Xmax
Coordenada máxima do eixo horizontal da área de modelagem do Sistema.
Xmin
Coordenada mínima do eixo horizontal da área de modelagem do Sistema.
Ymax
Coordenada máxima do eixo vertical da área de modelagem do Sistema.
Ymin
Coordenada mínima do eixo vertical da área de modelagem do Sistema.
5.2.6.2.4 Subestação
5.2.6.2.4.1 Propriedades
CanvasLeft
Coordenada mínima do eixo horizontal da área de modelagem da Subestação.
CanvasRight
Coordenada máxima do eixo horizontal da área de modelagem da Subestação.
CanvasTop
Coordenada máxima do eixo vertical da área de modelagem da Subestação.
FontSize
Tamanho da fonte dos textos mostrados na área de modelagem (este valor deve
ser positivo).
GridSize
Distância entre as linhas da grade do desenho (este valor deve ser positivo).
IsMobile
Indica que esta é uma Subestação móvel. O valor padrão desta propriedade é
Falso.
StrokeThickness
Espessura das linhas da Subestação (este valor deve ser positivo).
Xmax
Coordenada máxima do eixo horizontal da área de modelagem da Subestação.
Xmin
Coordenada mínima do eixo horizontal da área de modelagem da Subestação.
Ymax
Coordenada máxima do eixo vertical da área de modelagem da Subestação.
Ymin
Coordenada mínima do eixo vertical da área de modelagem da Subestação.
5.2.6.3 Equipamentos
Esta seção contém informações sobre os objetos do tipo Equipamento do Modelo
Elétrico.
5.2.6.3.1 Alimentador
Esta seção contém informações sobre as propriedades do objeto Alimentador
(EDBFEEDER). Este objeto não tem eventos nem métodos associados.
5.2.6.3.1.1 Propriedades
NOTA: A i ma gem s empre preenche toda a á rea do Al i menta dor. Porta nto, é
recomenda do que a á rea da i ma gem e a do Al i menta dor tenha m a mes ma
proporçã o (aspect ratio).
CanvasBottom
Coordenada mínima do eixo vertical da área de modelagem do Alimentador.
CanvasLeft
Coordenada mínima do eixo horizontal da área de modelagem do Alimentador.
CanvasRight
Coordenada máxima do eixo horizontal da área de modelagem do Alimentador.
CanvasTop
Coordenada máxima do eixo vertical da área de modelagem do Alimentador.
FontSize
Tamanho da fonte dos textos mostrados na área de modelagem (este valor deve
ser positivo).
GridSize
Distância entre as linhas da grade do desenho (este valor deve ser positivo).
Xmin
Coordenada mínima do eixo horizontal da área de modelagem do Alimentador.
Ymax
Coordenada máxima do eixo vertical da área de modelagem do Alimentador.
Ymin
Coordenada mínima do eixo vertical da área de modelagem do Alimentador.
5.2.6.3.2 Barramento
5.2.6.3.3 Capacitor
Esta seção contém informações sobre as propriedades do objeto Capacitor
(EDBCAP). Este objeto não tem eventos nem métodos associados.
5.2.6.3.4 Carga
5.2.6.3.4.1 Propriedades
5.2.6.3.5.1 Propriedades
5.2.6.3.6 Chave
Esta seção contém informações sobre as propriedades do objeto Chave
(EDBSWITCH). Este objeto não tem eventos nem métodos associados.
5.2.6.3.6.1 Propriedades
5.2.6.3.7.1 Propriedades
5.2.6.3.8 Disjuntor
Esta seção contém informações sobre as propriedades do objeto Disjuntor
(EDBBREAKER). Este objeto não tem eventos nem métodos associados.
5.2.6.3.9 Gerador
Esta seção contém informações sobre as propriedades do objeto Gerador (EDBGEN).
Este objeto não tem eventos nem métodos associados.
5.2.6.3.9.1 Propriedades
5.2.6.3.10 Reator
5.2.6.3.10.1 Propriedades
5.2.6.3.12 Religador
Esta seção contém informações sobre as propriedades do objeto Religador
(EDBRECLOSER). Este objeto não tem eventos nem métodos associados.
5.2.6.3.12.1 Propriedades
5.2.6.3.13.1 Propriedades
5.2.6.3.14.1 Propriedades
5.2.6.3.15.1 Propriedades
5.2.6.4 Conexões
Esta seção contém informações sobre os objetos do tipo Conexão do Modelo
Elétrico.
5.2.6.4.1 Conector
Esta seção contém informações sobre as propriedades do objeto Conector
(EDBJUMPER). Este objeto não tem eventos nem métodos associados.
5.2.6.4.1.1 Propriedades
5.2.6.4.2 Nó
O objeto Nó (EDBNODE) não tem eventos nem métodos ou propriedades específicos
associados, somente propriedades gerais. Estas podem ser visualizadas na seção
Propriedades Comuns.
5.2.6.4.3 Nó Externo
O objeto Nó Externo (EDBLINKNODE) não tem eventos nem métodos ou propriedades
específicos associados, somente propriedades gerais. Estas podem ser visualizadas
na seção Propriedades Comuns.
5.2.6.4.4.1 Propriedades
5.2.6.4.5 Terminal
Esta seção contém informações sobre as propriedades do objeto Terminal
(EDBTERMINAL). Este objeto não tem eventos nem métodos associados.
448 Objetos de Servidor
5.2.6.4.5.1 Propriedades
5.2.6.4.6.1 Propriedades
5.2.6.4.7 Trecho
Esta seção contém informações sobre as propriedades do objeto Trecho
(EDBBRANCH). Este objeto não tem eventos nem métodos associados.
5.2.6.4.7.1 Propriedades
5.2.6.4.8.1 Propriedades
5.2.6.5.1 Equipamentos
Esta seção contém informações sobre os objetos do tipo Equipamento em
Visualizações Esquemáticas.
5.2.6.5.1.1 Barramento
5.2.6.5.1.2 Capacitor
5.2.6.5.1.3 Carga
5.2.6.5.1.5 Chave
5.2.6.5.1.7 Disjuntor
5.2.6.5.1.8 Gerador
5.2.6.5.1.9 Reator
5.2.6.5.2 Conexões
Esta seção contém informações sobre os objetos do tipo Conexão em Visualizações
Esquemáticas.
5.2.6.5.2.1 Conector
5.2.6.5.2.2 Nó
5.2.6.5.2.3 Nó de Fronteira
5.2.6.5.2.4 Nó Externo
5.3.2.1 Count
Retorna o número de objetos filhos (itens) de uma coleção de Campos de Usuário
de Alarmes. Se a Coleção não contém objetos filhos, esta propriedade retorna o
valor 0 (zero).
5.3.3.1 Propriedades
Esta seção contém informações sobre as propriedades dos objetos do tipo Campo
de Usuário de Alarmes contidos na coleção de Campos de Usuário de Alarmes.
5.3.3.1.1 Index
Retorna o índice deste objeto na Coleção de Campos de Usuário de Alarmes. Este
valor pode ser utilizado como parâmetro para o método Item da Coleção.
5.3.3.1.2 Link
5.3.3.1.3 Name
Retorna o nome deste objeto na Coleção de Campos de Usuário de Alarmes. Este
valor pode ser utilizado como parâmetro para o método Item da Coleção.
5.3.3.1.4 Value
5.3.3.1.5 ValueSource
Especifica a fonte da propriedade Value deste Campo de Usuário de Alarmes. Os
valores possíveis para esta propriedade são os seguintes:
0 - evsInherited: A propriedade Value é herdada do Servidor de Alarmes ou
da Área superior (valor padrão)
1 - evsLink: A propriedade Value é fornecida pela propriedade Link
2 - evsForcedValue: A propriedade Value é fornecida pelo usuário
Esta propriedade aceita escritas tanto com o objeto ativo como inativo. Em ambos
458 Objetos de Servidor
os casos, não é possível escrever o valor evsLink. Para trocar a propriedade
ValueSource para o valor evsLink, deve-se escrever diretamente na propriedade Link
(desativando o objeto se estiver em tempo de execução).
5.4.1 Servidor
Esta seção contém informações sobre métodos específicos do objeto Server
(Application). Este objeto possui os métodos gerais Item e Save, além das
propriedades Name e Count, descritos na seção Eventos, Métodos e Propriedades
Gerais dos Objetos. O objeto não possui eventos associados.
5.4.1.1 Métodos
Esta seção contém informações sobre os métodos específicos do objeto Servidor.
NOTA: Os métodos a qui des cri tos s ó podem s er uti l i za dos em tempo de execuçã o,
nã o es ta ndo di s ponívei s no Studi o.
5.4.1.1.1 ClearFailure
ClearFailure(FailureName)
Este método deve ser chamado para indicar que uma falha reportada por
ReportFailure não está mais ativa. O parâmetro FailureName contém o nome da
falha (definido pelo usuário) e deve ser passado para o método ReportFailure,
quando de sua chamada.
5.4.1.1.2 E3GetActor
E3GetActor()
Este método retorna o nome de logon do usuário que iniciou a requisição atual no
E3Run. Se o E3Run não estiver atualmente tratando uma operação gerada por outro
processo, retorna a String "System". Se não houver nenhum usuário logado no
processo que gerou a requisição atual, retorna a String "Anonymous".
LoadReport(ReportName)
Carrega um modelo de Relatório. Veja o método LoadReport do objeto Viewer para
um exemplo de uso.
5.4.1.1.4 ReportFailure
ReportFailure(FailureName, FailureDescription, FailureWeight)
Este método permite que o aplicativo reporte falhas para o Servidor, que podem ser
visualizadas clicando com o botão direito do mouse no ícone do Elipse Power na
Área de Notificação. Quando o método é usado, o ícone do Elipse Power na Área de
Notificação começa a piscar em vermelho, indicando a ocorrência da falha. As
falhas reportadas são normalmente condições que impedem que o aplicativo
funcione parcialmente (problema de comunicação em uma porta serial, link de rede
inativo, banco de dados sem conexão, etc.), e que normalmente não podem ser
detectadas pelo Servidor. Este método tem duas finalidades:
Avisar o operador do sistema a respeito de problemas em um servidor
Auxiliar o gerenciador automático de Hot-Standby a decidir qual servidor
está mais apto para executar o aplicativo
Exemplo:
Sub TagEstadoSerial_OnValueChanged()
If Value then
' O valor do tag é TRUE, indica que está em falha
Application.ReportFailure "FALHA_COM1", "Falha de "_
& "comunicação 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.4.1.1.5 Trace
Trace(MessageText[, LogTimeStamp[, BreakLine]])
Este método permite registrar mensagens em um arquivo texto. As mensagens são
gravadas em um arquivo com o mesmo nome e caminho do arquivo de Domínio,
com a extensão .txt. Por exemplo, se a aplicação de Domínio for c:\teste.dom, as
mensagens serão registradas no arquivo c:\teste.txt. Cada nova mensagem é
adicionada sempre no final do arquivo. Caso haja falha no registro no arquivo
(como por exemplo, direito de acesso negado, falta de espaço em disco, etc.),
ocorrerá um erro de script.
Este método pode ser usado, por exemplo, para registrar mensagens de depuração
de scripts que não sejam executados no Viewer (haja vista que neste caso não é
possível utilizar o método MsgBox).
Parâmetros do método Trace
NOME DESCRIÇÃO
MessageText Mens a gem de texto defi ni da pel o
us uá ri o.
LogTimeStamp (Opci ona l ) Bool ea no que i ndi ca s e ca da
regi s tro deve ter a da ta e a hora
(timestamp). Se omi ti do, a s s ume True.
5.4.1.1.6 TrackEvent
TrackEvent(EventMessage, Comment, TimeStamp)
O método TrackEvent permite gerar eventos via script manualmente. Veja o método
TrackEvent do objeto Viewer para mais informações.
5.5.1 E3StudioApplication
Esta seção contém informações sobre métodos específicos do objeto
E3StudioApplication. Este objeto não possui eventos nem propriedades específicos.
5.5.1.1 Métodos
Esta seção contém informações sobre os métodos específicos do objeto
E3StudioApplication.
5.5.1.1.1 CreateFile
CreateFile(ProjectName, ClassName[, FileName, FolderName, RunWizard,
OpenView])
Cria um novo objeto em um arquivo de projeto (.prj). Os parâmetros deste método
são os seguintes:
ProjectName: O nome do arquivo de projeto onde o objeto é inserido. Este
parâmetro não pode ser vazio, e o arquivo de projeto deve estar carregado
no Studio. Pode ser o caminho completo do arquivo de projeto ou o caminho
relativo ao arquivo de Domínio. Não há necessidade de adicionar a extensão
.prj
ClassName: O nome da classe do objeto que é criado. Veja a tabela a seguir
para os valores permitidos neste parâmetro
FileName: O nome do objeto inserido. Se este parâmetro for omitido, é
utilizado o nome padrão para a criação do objeto de tipo indicado em
ClassName. O tamanho máximo permitido para este parâmetro é de 32
caracteres e, se já existir, é automaticamente incrementado
FolderName: O nome da Pasta onde o objeto é criado. Se este parâmetro for
omitido, o objeto é criado na raiz do arquivo de projeto. O nome da Pasta
deve obedecer às mesmas regras da seção de Notas do método
RenameFolder
RunWizard: Booleano que indica se o assistente de configuração da classe
indicada por ClassName é aberto após a execução deste método. O valor
padrão deste parâmetro é Verdadeiro
OpenView: Booleano que indica se o Editor do objeto inserido é aberto após
a execução deste método. O valor padrão deste parâmetro é Verdadeiro
5.5.1.1.2 CreateFolder
CreateFolder(ProjectName, FolderName[, ParentFolder])
Cria uma nova Pasta com o nome definido em FolderName, dentro do arquivo de
projeto (.prj) ProjectName, e cujo objeto pai é indicado por ParentFolder. As
seguintes restrições se aplicam a este método:
O arquivo de projeto indicado no parâmetro ProjectName deve existir, e estar
aberto no Studio
Se o parâmetro FolderName for vazio, é utilizado o nome padrão para
criação de Pastas. Por exemplo, "Pasta1"
O tamanho máximo permitido para o parâmetro FolderName é de 32
caracteres
Se o nome indicado no parâmetro FolderName já existir, o nome é
automaticamente incrementado
O nome da Pasta em FolderNome deve obedecer às mesmas regras da seção
de Notas do método RenameFolder
A Pasta indicada no parâmetro ParentFolder deve existir. Se o parâmetro for
omitido, a nova Pasta é criada na raiz do arquivo de projeto
5.5.1.1.3 CreatePRJ
CreatePRJ(Filename)
Cria um novo arquivo de projeto (.prj) com o nome Filename, e o adiciona ao
Domínio corrente, se existir. Se o parâmetro Filename não for um caminho absoluto,
é utilizado um caminho relativo ao Domínio, ou o caminho padrão para arquivos
de projeto (salvo no Registro do Windows). A extensão .prj é adicionada
automaticamente, se necessário.
ListFiles([ClassName], [DomainName])
Retorna uma coleção de objetos de uma determinada classe em um Domínio. Os
parâmetros deste método são os seguintes:
ClassName: Uma String, opcional, com o nome da classe do objeto desejado.
Se o nome da classe não existir, este método retorna um erro de script. Se
este parâmetro for omitido, este método retorna uma coleção com todos os
objetos do Domínio especificado. Se o Domínio especificado não contiver
nenhum objeto da classe informada, este método retorna uma coleção vazia
(com zero itens). O valor padrão deste parâmetro é vazio.
DomainName: Uma String, opcional, com o nome de um Domínio remoto ou
vazio para especificar o Domínio local. Se o Domínio remoto não existir, este
método retorna um erro de script. O valor padrão deste parâmetro é vazio.
A coleção retornada por este método contém a propriedade Count, que indica o
total de objetos existentes, e o método Item, que permite acessar um item específico
da coleção. Esta coleção também pode ser utilizada em comandos For Each do
VBScript.
NOTA: O método Item da col eçã o retorna da por es te método permi te o a ces s o
s omente pel o índi ce numéri co (i ni ci a ndo em um).
5.5.1.1.5 RenameFolder
RenameFolder(OldName, NewName)
Permite renomear uma Pasta em um arquivo de projeto aberto no Studio,
pertencente ou não ao Domínio. O parâmetro OldName é o caminho completo da
Pasta que se deseja renomear, e o parâmetro NewName é o novo nome, sem o
caminho.
NOTAS:
Se o ca mi nho compl eto da Pa s ta no pa râ metro OldName ou o novo nome no
pa râ metro NewName começa com um ca ra ctere que nã o s eja uma l etra (s em
a centos nem "ç"), ou s e pos s ui um ca ra ctere qua l quer que nã o s eja uma l etra
(s em a centos nem "ç"), um a l ga ri s mo (0-9) ou s ubl i nha do, é obri ga tóri o o us o de
col chetes no nome
Se o pa râ metro NewName é i nvá l i do, s e o pa râ metro OldName contém um erro de
s i nta xe, ou a i nda s e o ca mi nho i ndi ca do em OldName nã o foi encontra do em
nenhum a rqui vo de projeto a berto, ocorre um erro de s cri pt
Arqui vos de projeto protegi dos por s enha devem s er des bl oquea dos a ntes da
uti l i za çã o des te método
5.6.1.1 Eventos
Es ta s eçã o contém i nforma ções s obre os eventos do objeto Dri ver de Comuni ca çã o.
5.6.1.1.1 AfterStart
AfterStart()
Ocorre depois que o Driver de Comunicação iniciou a comunicação. É comum criar
um script para este evento utilizando o método Write para executar configurações
em equipamentos. Exemplo:
Sub Driver1_AfterStart()
' Após iniciada a comunicação, escreve valores
' no equipamento ou dispositivo
Write 0, 2, 55, 2, 33.4
Write 0, 3, 55, 20, "Metal"
End Sub
5.6.1.1.2 AfterStop
AfterStop()
Ocorre depois que o Driver finalizou a comunicação. Utilize o evento AfterStop
para executar alguma ação que seja necessária após terminada a comunicação do
Driver.
5.6.1.1.3 BeforeStart
BeforeStart()
Ocorre quando o Driver está prestes a iniciar a comunicação. Utilize o evento
BeforeStart para executar alguma ação que seja necessária antes de iniciar a
comunicação, como por exemplo a configuração de parâmetros do Driver. Exemplo:
Sub Driver1_BeforeStart()
' Executa a inicialização dos parâmetros do Driver
5.6.1.1.4 BeforeStop
BeforeStop()
Ocorre quando o Driver está prestes a finalizar a comunicação. Utilize o evento
BeforeStop para executar alguma ação que seja necessária antes que a
comunicação seja terminada, como por exemplo escrever ou ler valores do
equipamento ou dispositivo, antes que a comunicação não esteja mais disponível.
5.6.1.1.5 OnCommError
OnCommError(EvtType, Size, Element, N1, N2, N3, N4)
Ocorre quando algum erro de escrita ou leitura é detectado pelo Driver de
Comunicação. Utilize o evento OnCommError para saber quando ocorreu uma falha
de escrita ou leitura no Driver. As variáveis de evento recebem informações sobre o
erro ocorrido. Com estes valores, é possível rastrear quais Tags estão apresentando
problemas de comunicação.
Variáveis do evento OnCommError
NOME DESCRIÇÃO
EvtType Informa qua l o ti po de opera çã o o Dri ver
es ta va efetua ndo qua ndo ocorreu o erro,
conforme a s opções a s egui r:
0: Erro de l ei tura de um s ó El emento (Size
= 1). Param1 é N1, Param2 é N2, Param3 é
N3 e Param4 é N4
1: Erro de es cri ta de um s ó El emento (Size
= 1). Param1 é N1, Param2 é N2, Param3 é
N3 e Param4 é N4
2: Erro de l ei tura de um Bl oco (Bl oco de
Comuni ca çã o). Size é determi na do pel o
número de El ementos do Bl oco. Param1 é
N1, Param2 é N2, Param3 é N3 e Param4 é
N4
3: Erro de es cri ta de um Bl oco (Bl oco de
Comuni ca çã o). Size é determi na do pel o
número de El ementos do Bl oco. Param1 é
N1, Param2 é N2, Param3 é N3 e Param4 é
N4
Size Qua nti da de de va l ores s endo es cri tos ou
l i dos .
Exemplo:
Sub Driver1_OnCommError(Type, Size, Element, N1, N2, N3, N4)
Application.GetObject("Dados.TagInterno1").Value = _
Application.GetObject("Dados.TagInterno1").Value + 1
Application.GetObject("Dados.EvtType").Value = EvtType
Application.GetObject("Dados.Size").Value = Size
Application.GetObject("Dados.Element").Value = Element
Application.GetObject("Dados.N1").Value = N1
Application.GetObject("Dados.N2").Value = N2
Application.GetObject("Dados.N3").Value = N3
Application.GetObject("Dados.N4").Value = N4
End Sub
5.6.1.1.6 OnCommErrorEx
OnCommErrorEx(ErrorInfo)
Ocorre logo após a execução do método OnCommError.
Informações do parâmetro ErrorInfo
NOME DESCRIÇÃO
ErrorInfo.EvtType Indi ca o ti po de opera çã o que ca us ou o
erro:
0: Lei tura de Ta g
1: Es cri ta em Ta g
2: Lei tura de Bl oco
3: Es cri ta em Bl oco
ErrorInfo.Size Ta ma nho do Bl oco que oca s i onou o erro
(s e for um Ta g, Size é i gua l a 1).
ErrorInfo.Element Índi ce do El emento de Bl oco que ca us ou o
erro.
ErrorInfo.Nx Pa râ metros Nx ou Bx (x = 1, 2, 3 ou 4) da
opera çã o que ca us ou o erro.
ErrorInfo.ParamDevice Pa râ metro ParamDevice (String) da opera çã o
que ca us ou o erro.
5.6.1.1.7 OnTagRead
OnTagRead(Tag)
Ocorre na leitura de um Tag, sempre que um novo valor ou um erro for retornado
pelo Driver de Comunicação. Ou seja, se o valor ou a qualidade do Tag não
mudarem, o evento não é disparado. Para que o evento funcione, a propriedade
EnableDriverEvent deve obrigatoriamente estar habilitada. Além disto, a
propriedade PercentDeadband também pode exercer influência sobre a ocorrência
do evento, caso a propriedade EnableDeadband esteja habilitada. Exemplo:
Sub Tags_OnTagRead(Tag)
Set Obj = Application.GetObject("Dados1.TagName")
Obj.Value = Tag.Name
Set Obj = Application.GetObject("Dados1.TagRead")
Obj.Value = True
Set Obj = Application.GetObject("Dados1.TagType")
Obj.Value = TypeName(Tag)
End Sub
5.6.1.1.8 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escrita for disparada em qualquer Tag do Driver.
Variáveis do evento OnTagWrite
NOME DESCRIÇÃO
Tag Uma referênci a pa ra o objeto do Ta g que
es tá s ofrendo a es cri ta . Por exempl o,
pode-s e a ces s a r a propri eda de do Ta g
com a s i nta xe Tag.DocString.
Succeeded Um va l or Bool ea no que i ndi ca o s uces s o
da es cri ta (Verda dei ro = s uces s o, Fa l s o =
fa l ha ).
User Pa râ metro que recebe o us uá ri o que
rea l i zou a es cri ta . O va l or pa drã o des te
pa râ metro é "Sys tem". Se nã o houver
nenhum us uá ri o l oga do no Vi ewer que
gerou o evento, es te pa râ metro contém o
va l or "Anonymous ".
5.6.1.2 Métodos
Esta seção contém informações sobre os métodos do objeto Driver de
Comunicação.
Objetos de Servidor 469
5.6.1.2.1 Write
5.6.1.2.2 WriteEx
WriteEx(N1, N2, N3, N4, Value[, Timestamp[, Quality[, WriteStatus[,
WriteSyncMode]]]])
Executa a escrita de um dado no equipamento. Este método retorna um Booleano
que indica o sucesso ou não da operação.
Os parâmetros N1 a N4 correspondem aos parâmetros N do Driver. O parâmetro
Value define o valor a ser escrito no Driver. Para maiores detalhes sobre estes
parâmetros, consulte a documentação do Driver.
Os parâmetros Timestamp, Quality e WriteStatus são opcionais. Se omitidos, o
comportamento do método é o mesmo do método Write. Timestamp especifica a
data e hora a ser escrita no Tag, se suportada pelo equipamento. Se omitido,
assume a data e hora do momento da operação de escrita. Quality indica a
qualidade, de 0 a 255. Se omitido, assume a qualidade Boa (192). WriteStatus
recebe um valor retornado pelo Driver, que indica o status da escrita (se suportado
pelo Driver, de acordo com sua documentação própria). O parâmetro
WriteSyncMode permite utilizar o modo de escrita diferente do utilizado no Driver.
As opções disponíveis para este parâmetro são:
0: Usa o modo de escrita configurado no Driver
1: Executa uma escrita síncrona
2: Executa uma escrita assíncrona (sem confirmação)
5.6.1.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Driver de
Comunicação.
5.6.1.3.1 DisableIOServerPool
Força o Driver a não participar do Pool de processos do IOServer, ou seja, o
Driver executa em um IOServer exclusivo. O valor padrão desta propriedade é
Falso.
5.6.1.3.2 DriverLocation
Define qual é o driver utilizado pelo objeto Driver de Comunicação para efetuar a
comunicação com o equipamento ou dispositivo. Esta propriedade aceita uma
String com o caminho completo do driver, caso ele não esteja no mesmo diretório
do Domínio, ou o caminho relativo se ele estiver no mesmo diretório do Domínio.
Caso não haja um Domínio aberto no Studio, o caminho relativo é considerado a
partir da pasta onde se encontra o projeto ou biblioteca contendo o objeto Driver
de Comunicação. Após isto, a propriedade DriverName muda para a descrição do
driver. Esta propriedade não pode ser modificada após iniciada a comunicação. O
valor padrão desta propriedade é uma String vazia.
5.6.1.3.3 DriverName
A propriedade DriverName contém uma String que descreve o driver associado
ao objeto Driver de Comunicação. Para isto, deve-se antes configurar a
propriedade DriverLocation. Esta propriedade é somente de leitura e não está
disponível em tempo de execução.
5.6.1.3.5 P1
5.6.1.3.6 P2
Utilize a propriedade P2 para configurar o driver. Consulte a documentação do
driver para sua correta parametrização. Esta propriedade não pode ser modificada
após iniciada a comunicação. O valor padrão desta propriedade é 0 (zero).
Exemplo:
Sub Driver1_BeforeStart()
' Driver1 é um objeto do tipo Driver de Comunicação
DriverLocation = "c:\driver\plc.dll"
P1 = 2
P2 = 1
P3 = 9600
End Sub
5.6.1.3.7 P3
Utilize a propriedade P3 para configurar o driver. Consulte a documentação do
driver para sua correta parametrização. Esta propriedade não pode ser modificada
após iniciada a comunicação. Exemplo:
Sub Driver1_BeforeStart()
' Driver1 é um objeto do tipo Driver de Comunicação
DriverLocation = "c:\driver\plc.dll"
P1 = 2
P2 = 1
P3 = 9600
End Sub
5.6.1.3.9 ParamDevice
Define o endereço do equipamento acessado pelo driver. Esta propriedade é
herdada pelos Tags filhos do driver, que podem sobrescrever este valor, se
necessário.
5.6.1.3.10 ReadRetries
Indica o número de re-tentativas de leitura do driver em caso de erro. Se for
configurada para 2, por exemplo, indica que o driver vai tentar duas vezes mais
uma comunicação falhada, sem contar a tentativa original.
5.6.1.3.11 ShareMaximum
A propriedade ShareMaximum define o número máximo de Drivers de
Comunicação que são agrupados em um I/O Server compartilhado. Esta
propriedade só é utilizada se a propriedade ShareServer estiver habilitada.
Exemplo:
' Este driver não será compartilhado
ShareServer = False
ShareMaximum = <qualquer valor>
' Todos os drivers serão agrupados no mesmo IOServer
' Não define um limite
ShareServer = True
ShareMaximum = 0
' Agrupa cada 5 drivers em um IOServer
ShareServer = True
ShareMaximum = 5
5.6.1.3.12 ShareServer
Se a propriedade ShareServer estiver configurada para Verdadeiro, isto significa
que este driver compartilha sua execução entre os demais objetos Driver de
5.6.1.3.13 WriteFeedbackMode
Esta propriedade permite controlar a confirmação (ou feedback) das escritas em
Tags. É aplicável somente a Tags que possam ser lidos, ou seja, possuam a
propriedade AllowRead em Verdadeiro. Através desta propriedade, é possível tornar
mais imediata a leitura de Tags que recebem escritas. Esta propriedade possui as
opções de configuração descritas na tabela a seguir.
Opções disponíveis para a propriedade WriteFeedbackMode
OPÇÃO DESCRIÇÃO
0 - wfWaitNextRead A l ei tura do Ta g é rea l i za da
norma l mente no próxi mo scan
1 - wfImmediateReadAfterWrite Após ca da es cri ta , uma l ei tura de
confi rma çã o é rea l i za da o ma i s cedo
pos s ível
2 - wfTrustWriteSuccess Se o Dri ver i ndi ca r s uces s o na es cri ta , o
va l or es cri to é a s s umi do di reta mente
pel o Ta g, s em l ê-l o do PLC
5.6.1.3.14 WriteRetries
Indica o número de re-tentativas de escrita do driver em caso de erro. Se for igual
a 2, indica que o driver vai tentar duas vezes mais uma comunicação falhada, sem
contar a tentativa original.
5.6.1.3.15 WriteSyncMode
Determina como as escritas são enviadas para o I/O Server (modo síncrono ou
assíncrono). Esta propriedade possui as opções de configuração descritas na
tabela a seguir.
Opções disponíveis para a propriedade WriteSyncMode
OPÇÃO DESCRIÇÃO
0 - wsmDefault Modo s íncrono (pa drã o).
1 - wsmSync Modo s íncrono. Sempre que um va l or é
es cri to em a l gum Ta g, o E3Run envi a a
es cri ta pa ra o I/O Server e a gua rda o
retorno da es cri ta .
2 - wsmAsyncUnconfirmed Modo a s s íncrono s em confi rma çã o.
Toda s a s es cri ta s s ã o envi a da s pa ra o I/
O Server s em a gua rda r o retorno, e
a s s ume-s e s empre que a es cri ta
funci onou. Qua ndo em modo a s s íncrono,
os métodos de es cri ta dos Ta gs (Write,
WriteEx) s empre retorna m Verda dei ro
i medi a ta mente, e o s ta tus da es cri ta
(nos métodos que retorna m es te s ta tus )
fi ca s empre va zi o (Empty). O evento
OnTagWrite do dri ver é executa do a s s i m
que a es cri ta é envi a da pa ra o I/O Server,
e o pa râ metro Succeeded perma nece
s empre em Verda dei ro.
As escritas assíncronas são executadas pelo I/O Server assim que o driver estiver
disponível (quando a leitura atual terminar). Se várias escritas assíncronas forem
enviadas para o I/O Server, o driver só retoma as leituras depois que todas as
Objetos de Servidor 475
escritas assíncronas forem executadas.
5.6.1.4.1 Eventos
5.6.1.4.1.1 OnRead
OnRead()
Ocorre quando uma leitura do Bloco de Comunicação é efetuada pelo driver. Utilize
o evento OnRead quando for necessário efetuar alguma operação logo após algum
dado ter sido modificado no objeto Bloco de Comunicação, como por exemplo as
propriedades Quality, TimeStamp ou ainda a propriedade Value de algum Elemento
do Bloco. Exemplo:
Sub IOBloco1_OnRead()
' Ao ler o bloco, atribui ao tag InternalTag1
' o valor do elemento de bloco elm1
Set obj = Application.GetObject("DataServer1.InternalTag1")
Set elm = Application.GetObject("Driver1.IOBloco1.elm1")
obj.Value = elm.Value
End Sub
5.6.1.4.2 Métodos
Esta seção contém informações sobre os métodos do objeto Bloco de Comunicação.
5.6.1.4.2.1 Write
Write([WriteSyncMode])
Executa a escrita do valor corrente do Bloco de Comunicação no equipamento.
Normalmente, este comando de script só é usado quando a propriedade AllowWrite
deste objeto for Falso.
O parâmetro WriteSyncMode permite utilizar o modo de escrita diferente do
utilizado no driver. As opções disponíveis para este parâmetro são as seguintes:
0: Usa o modo de escrita configurado no driver
1: Executa uma escrita síncrona
2: Executa uma escrita assíncrona (sem confirmação)
5.6.1.4.2.2 WriteEx
5.6.1.4.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Bloco de
Comunicação.
5.6.1.4.3.1 AdviseType
5.6.1.4.3.2 AllowRead
Define se este Bloco deve ou não ser lido pelo Driver de Comunicação. Caso a
propriedade AllowRead esteja habilitada, então o Driver automaticamente atualiza
os Elementos de comunicação inseridos neste Bloco, em intervalos de tempo
definidos pela propriedade Scan. Caso contrário, este Bloco de Comunicação não é
lido ou atualizado. Esta propriedade pode ser modificada em tempo de execução. O
valor padrão desta propriedade é Verdadeiro. Exemplo:
Sub Botao1_Click()
' Faz com que seja parada a leitura do bloco
Set obj = Application.GetObject("Driver1.bloco1")
obj.AllowRead = False
End Sub
5.6.1.4.3.3 AllowWrite
Define se este Bloco deve ou não ser escrito quando for modificada a
propriedade Value de seus Elementos do Bloco de Comunicação. Se esta
propriedade estiver configurada para Verdadeiro, as modificações são enviadas
para o equipamento ou dispositivo associado ao Driver de Comunicação. Caso
contrário as modificações são ignoradas. Os Elementos de comunicação não
aceitam valores caso esta propriedade esteja configurada para Falso, a não ser
que a propriedade AllowRead também esteja configurada para Falso. Exemplo:
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do bloco
Set obj = Application.GetObject("Driver1.bloco1")
obj.AllowWrite = False
End Sub
5.6.1.4.3.5 B2
5.6.1.4.3.6 B3
5.6.1.4.3.7 B4
NOTAS:
Ca s o ha ja ma i s de um El emento de Bl oco ma pea do pa ra o mes mo índi ce, a
confi gura çã o de ba nda morta uti l i za da é a quel a que res ul te no menor va l or
a bs ol uto de ba nda morta .
Se a l gum índi ce do Bl oco pos s ui r um El emento nã o ma pea do, a ba nda morta
nes te índi ce é i gua l a 0 (zero), ou s eja , qua l quer va ri a çã o no va l or do El emento
vi ol a a ba nda morta .
Se a propri eda de EnableDeadBand es ti ver ha bi l i ta da , o úl ti mo va l or envi a do a o
Bl oco é compa ra do com o va l or l i do no momento, El emento por El emento. Se
qua l quer um dos El ementos do Bl oco vi ol a r s ua ba nda morta , o Bl oco i ntei ro é
a tua l i za do.
5.6.1.4.3.9 EnableDriverEvent
5.6.1.4.3.10 ParamDevice
5.6.1.4.3.11 ParamItem
NOTA: Pa ra ma i ores i nforma ções s obre qua l i da de, cons ul te o tópi co Qualidade no
Manual do Usuário do Elipse Power.
5.6.1.4.3.13 Scan
5.6.1.4.3.14 Size
5.6.1.4.3.15 TimeStamp
5.6.1.4.4.1 Métodos
5.6.1.4.4.2 Propriedades
NOTA: Os va l ores dos bi ts (a s propri eda des Bit00 até Bit31) nã o s ã o a feta dos pel o
a jus te na es ca l a , ou s eja , repres enta m os bi ts dos va l ores l i dos pel o equi pa mento
a ntes da convers ã o.
DeviceLow
A propriedade DeviceLow define qual o valor mínimo atingido por este Elemento
no equipamento ou no dispositivo. Esta propriedade é utilizada no cálculo do valor
da propriedade PercentDeadBand, e também para realizar o ajuste de escala do
valor proveniente do equipamento ou do dispositivo antes de ser atribuído à
propriedade Value. Da mesma forma, no momento da escrita, é feita a operação
Objetos de Servidor 483
inversa antes de enviar o valor para o Driver. Esta conversão só ocorre quando a
propriedade EnableScaling está configurada para Verdadeiro. O valor padrão desta
propriedade é 0 (zero).
NOTA: Os va l ores dos bi ts (a s propri eda des Bit00 até Bit31) nã o s ã o a feta dos pel o
a jus te na es ca l a , ou s eja , repres enta m os bi ts dos va l ores l i dos pel o equi pa mento
a ntes da convers ã o.
EnableDriverEvent
Esta propriedade é utilizada para controlar a geração do evento OnTagRead, que
ocorre no Driver de Comunicação que contém o Bloco. Se a propriedade
EnableDriverEvent do Tag estiver configurada para Verdadeiro, é habilitada a
geração do evento OnTagRead por este Tag. Caso contrário, não ocorre. Os três
tipos de Elementos de Comunicação (Tag de Comunicação, Bloco de Comunicação e
Elemento de Bloco) podem gerar este evento. O evento ocorre no driver e não no
Bloco.
EnableScaling
A propriedade EnableScaling habilita ou desabilita a escala de valor para o valor
enviado e recebido do equipamento ou do dispositivo. Se esta propriedade estiver
configurada para Verdadeiro, todo valor proveniente do equipamento ou do
dispositivo sofre ajuste de escala conforme as propriedades DeviceHigh,
DeviceLow, EUHigh e EULow antes de ser atribuído à propriedade Value. Caso
contrário, nenhum ajuste de escala é efetuado em nenhum dos dois sentidos
(escrita e leitura). O valor padrão desta propriedade é Falso. Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala de um elemento temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prática de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EU
Esta propriedade é utilizada para identificar qual unidade de engenharia seu
valor representa, como por exemplo graus, metros, KW/h, etc. Exemplo:
Sub ElementodeBloco1_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prática de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
484 Objetos de Servidor
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EUHigh
Define qual o valor máximo que deve ser atribuído à propriedade Value,
ajustando a escala ao valor do equipamento ou do dispositivo antes desta
atribuição. Da mesma forma, no momento da escrita é feita a operação inversa
antes de enviar o valor para o driver. Esta conversão só ocorre quando a
propriedade EnableScaling está configurada para Verdadeiro. O valor padrão desta
propriedade é 1000. Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala de um elemento temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prática de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
EULow
Define qual o valor mínimo que deve ser atribuído à propriedade Value, ajustando
a escala ao valor do equipamento ou do dispositivo antes desta atribuição. Da
mesma forma, no momento da escrita, é feita a operação inversa antes de enviar o
valor para o driver. Esta conversão só ocorre quando a propriedade EnableScaling
está configurada para Verdadeiro. O valor padrão desta propriedade é 0 (zero).
Exemplo:
Sub Elemento_OnStartRunning()
' Faz o ajuste de escala de um elemento temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prática de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EULow = 100
EULow = 0
End Sub
Index
Especifica a posição que o Elemento de Bloco ocupa entre os Elementos
configurados pela propriedade Size do Bloco de Comunicação no qual ele está
inserido. Esta propriedade aceita valores entre 0 (zero) e um número menor do que
o valor definido em Size. Por exemplo, configurando um Bloco de Comunicação
NOTA: Pa ra ma i ores i nforma ções s obre qua l i da de, cons ul te o tópi co Qualidade no
Manual do Usuário do Elipse Power.
RawValue
Acessa o valor original do Elemento anterior à escala, ou seja, independente da
configuração da propriedade EnableScaling. Portanto, se esta propriedade for igual
a Falso, as propriedades Value e RawValue apresentam o mesmo comportamento.
UseBitFields
Se esta propriedade estiver configurada para Verdadeiro, toda vez que o valor da
propriedade Value for modificada, ele atualiza os bits referentes às propriedades
Bit00 até Bit31. Da mesma forma, atualiza o valor de Value toda vez que alguma das
propriedades Bit00 até Bit31 mudar de valor e posteriormente envia para o
equipamento ou para o dispositivo se a propriedade AllowWrite do Bloco de
Comunicação estiver configurada para Verdadeiro. Caso contrário, os bits não
sofrem nem acarretam qualquer mudança. Esta propriedade pode ser atualizada
após ter sido iniciada a comunicação. O valor padrão desta propriedade é Falso.
5.6.1.5 Pasta
Esta seção contém informações sobre as propriedades do objeto Pasta do Driver de
Comunicação. Este objeto não possui eventos nem métodos associados.
5.6.1.5.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Pasta do Driver de
Comunicação.
5.6.1.5.1.1 ParamDevice
5.6.1.6.1 Eventos
Esta seção contém informações sobre os eventos do objeto Tag de Comunicação.
5.6.1.6.1.1 OnRead
OnRead()
Ocorre quando é efetuada uma leitura do Tag pelo driver. Utilize o evento OnRead
quando for necessário efetuar alguma operação logo após algum dado ser
modificado no Tag, como por exemplo, as propriedades Value, Quality ou
TimeStamp. Este evento é gerado por uma leitura em background. Exemplo:
Sub CommTag1_OnRead()
' 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.6.1.6.2 Métodos
Esta seção contém informações sobre os métodos do objeto Tag de Comunicação.
5.6.1.6.2.1 Write
Write([WriteSyncMode])
Executa a escrita do valor corrente do Tag de Comunicação no equipamento.
Normalmente, este comando de script só é usado quando a propriedade AllowWrite
deste objeto for Falso.
O parâmetro WriteSyncMode permite utilizar o modo de escrita diferente do
utilizado no driver. As opções disponíveis para este parâmetro são as seguintes:
0: Usa o modo de escrita configurado no driver
1: Executa uma escrita síncrona
2: Executa uma escrita assíncrona (sem confirmação)
5.6.1.6.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag de
Comunicação.
5.6.1.6.3.1 AdviseType
OPÇÃO DESCRIÇÃO
0 - AlwaysInAdvise O Ta g é ma nti do a tua l i za do s e a
propri eda de AllowRead for Verda dei ra .
Exemplo:
Sub CommandButton3_Click()
MsgBox Application._
Application.GetObject("Driver1.Tag1").AdviseType
End Sub
5.6.1.6.3.2 AllowRead
Configure esta propriedade para definir se este Tag deve ou não ser lido pelo
Driver de Comunicação. Se esta propriedade estiver configurada para Verdadeiro, o
driver automaticamente atualiza as propriedades Value e Bits (de Bit00 até Bit31)
deste objeto em intervalos de tempo definidos pela propriedade Scan. Caso
contrário, este Tag de Comunicação não é lido. Esta propriedade pode ser
modificada em tempo de execução. O valor padrão desta propriedade é Verdadeiro.
Exemplo:
Sub Botao1_Click()
' Faz com que seja parada a leitura do tag
Set obj = Application.GetObject("Driver1.tag")
obj.AllowRead = False
End Sub
5.6.1.6.3.3 AllowWrite
Configure esta propriedade para definir se este Tag deve ou não ser escrito
automaticamente quando for modificada a propriedade Value ou qualquer
propriedade Bit (de Bit00 até Bit31). Se esta propriedade estiver configurada para
Verdadeiro, as modificações são enviadas para o equipamento ou dispositivo
associado ao Driver de Comunicação. Caso contrário, as modificações são
ignoradas. O valor padrão desta propriedade é Verdadeiro. Exemplo:
Sub Botao1_Click()
' Faz com que seja desabilitada a escrita do tag
Set obj = Application.GetObject("Driver1.tag")
obj.AllowWrite = False
End Sub
5.6.1.6.3.5 DeviceHigh
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a té Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
5.6.1.6.3.6 DeviceLow
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a té Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
5.6.1.6.3.7 EnableDeadBand
5.6.1.6.3.8 EnableDriverEvent
5.6.1.6.3.9 EnableScaling
5.6.1.6.3.10 EU
5.6.1.6.3.11 EUHigh
Define qual o valor máximo que deve ser atribuído à propriedade Value,
ajustando a escala ao valor do equipamento ou do dispositivo antes desta
atribuição. Da mesma forma, no momento da escrita é feita a operação inversa
antes de enviar o valor para o Driver. Esta conversão só ocorre quando a
propriedade EnableScaling está configurada para Verdadeiro. O valor padrão desta
propriedade é 1000. Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prática de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a té Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
Define qual o valor mínimo que deve ser atribuído à propriedade Value, ajustando
a escala ao valor do equipamento ou do dispositivo antes desta atribuição. Da
mesma forma, no momento da escrita, é feita a operação inversa antes de enviar o
valor para o Driver. Esta conversão só ocorre quando a propriedade EnableScaling
está configurada para Verdadeiro. O valor padrão desta propriedade é 0 (zero).
Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prática de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EULow = 100
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 a té Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
5.6.1.6.3.13 N1
5.6.1.6.3.14 N2
5.6.1.6.3.15 N3
5.6.1.6.3.16 N4
5.6.1.6.3.17 ParamDevice
5.6.1.6.3.18 ParamItem
5.6.1.6.3.19 PercentDeadBand
5.6.1.6.3.20 Quality
5.6.1.6.3.21 RawValue
5.6.1.6.3.22 Scan
5.6.1.6.3.23 TimeStamp
5.6.1.6.3.24 UseBitFields
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a té Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
NOTA: Os va l ores dos bi ts (Propri eda des Bit00 a té Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
5.6.2.1 Eventos
Esta seção contém informações sobre os eventos do objeto Driver de Comunicação
OPC.
OnTagRead(Tag)
Ocorre na leitura de um Tag, sempre que um novo valor ou erro for retornado pelo
Servidor OPC. Ou seja, se o valor ou a qualidade do Tag não mudarem, o evento não
é disparado. Para que este evento ocorra, a propriedade EnableDriverEvent do Tag
deve obrigatoriamente estar habilitada.
5.6.2.1.2 OnTagWrite
OnTagWrite(Tag, Succeeded, User)
Ocorre quando uma escrita for disparada em qualquer Tag do Driver de
Comunicação OPC. Para que o evento ocorra, a propriedade EnableDriverEvent do
Tag deve obrigatoriamente estar habilitada. Se a escrita for assíncrona, o evento
OnTagWrite é gerado apenas quando o servidor enviar a resposta indicando o
efetivo sucesso ou não da escrita.
Parâmetros do evento OnTagWrite
NOME DESCRIÇÃO
Tag Uma referênci a pa ra o objeto Ta g que
es tá s ofrendo a es cri ta . Por exempl o,
pode-s e a ces s a r a propri eda de do Ta g
us a ndo a s i nta xe Tag.DocString.
Succeeded Um va l or Bool ea no que i ndi ca s uces s o
ou fa l ha na es cri ta .
User Pa râ metro que recebe o us uá ri o que
executou a es cri ta . O va l or pa drã o des te
pa râ metro é "Sys tem". Se nã o houver
nenhum us uá ri o l oga do no Vi ewer que
gerou o evento, es te pa râ metro contém o
va l or "Anonymous ". Se a es cri ta for
a s s íncrona ou s e ocorreu uma fa l ha
reporta da de forma a s s íncrona , es te
pa râ metro s empre contém o va l or
"Sys tem".
5.6.2.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Driver de
Comunicação OPC.
5.6.2.2.1 CallTimeout
Especifica o tempo limite para a resposta de qualquer chamada ou acesso a um
servidor OPC, como por exemplo escritas, criação de Grupos OPC, criação, remoção
e browsing de Tags, mudança no modo Advise dos Tags, etc. Caso este tempo seja
498 Objetos de Servidor
excedido, o Elipse Power considera o servidor como travado (indisponível) e inicia
o processo de reconexão. O valor desta propriedade não pode ser negativo.
Configurar esta propriedade com o valor 0 (zero) desabilita este tempo limite,
fazendo com que acessos ao servidor OPC possam demorar um tempo indefinido,
eventualmente travando todo o aplicativo caso este acesso seja síncrono. O valor
padrão desta propriedade é 10000 (10 segundos). Aplicações criadas em versões
anteriores, ao serem carregadas na versão atual, assumem o valor 0 (zero) por
questões de compatibilidade. Este valor deve ser ajustado com cuidado, para que
não tranque a aplicação e nem force uma desconexão sem necessidade, caso o
servidor OPC realmente demore para responder determinadas requisições.
5.6.2.2.2 Compatibility
Permite controlar o uso das interfaces padrão OPC pelo Cliente OPC do Elipse
Power. As opções disponíveis são as seguintes:
0 - AnyVersion: Funcionamento normal (recomendado), o Driver de
Comunicação OPC comunica com servidores DA 2.0x e 1.0a (dando
preferência ao uso de interfaces 2.0x)
1 - Version10A: Permite forçar a comunicação no padrão DA 1.0a para
servidores que suportam DA 2.0x e 1.0a
2 - Version20: Permite forçar a comunicação apenas no padrão OPC DA 2.0
Esta propriedade não pode ser modificada quando a comunicação do cliente OPC
estiver habilitada (tanto no Studio quanto em tempo de execução).
5.6.2.2.3 ConnectionTimeout
Especifica o tempo máximo para estabelecer uma conexão com um servidor OPC,
incluindo todos os passos da conexão, mesmo os passos antes do acesso ao
servidor em si, como acesso ao serviço OPCENUM ou ao Registro do Windows. O
valor desta propriedade não pode ser negativo. Configurar esta propriedade com o
valor 0 (zero) desabilita este tempo, fazendo com que o limite seja o efetivo tempo
de retorno de erro pelos serviços necessários para acessar o servidor OPC. O valor
padrão é 10000 (10 segundos). Aplicações criadas em versões anteriores, ao serem
carregadas na versão atual, assumem o valor 0 (zero) por questões de
compatibilidade.
5.6.2.2.5 ServerId
Determina o servidor ao qual o Driver de Comunicação OPC deve se conectar.
Apesar de o valor padrão da propriedade ser vazio, se este valor estiver vazio o
Driver de Comunicação OPC não vai se conectar. Esta propriedade só pode ser
modificada quando o Driver de Comunicação OPC não está conectado. Exemplo:
Sub CommandButton1_Click()
Set Opc = Application.GetObject("DriverOPC1")
Opc.Deactivate
Opc.ServerId = "ElipseSCADA.OPCSvr.1"
Opc.ServerMachine = "\\server2"
Opc.Activate
End Sub
5.6.2.2.6 ServerMachine
Esta propriedade determina o endereço da estação onde está executando o
servidor OPC. Para aplicações que estão executando localmente, esta propriedade
pode ficar em branco (padrão). Caso contrário, é necessário especificar o caminho
(por exemplo, "\\NomeServidor"). Esta propriedade só pode ser modificada quando
o Driver de Comunicação OPC estiver desconectado. Exemplo:
Sub CommandButton1_Click()
Set Opc = Application.GetObject("DriverOPC1")
Opc.Deactivate
Opc.ServerId = "ElipseSCADA.OPCSvr.1"
Opc.ServerMachine = "\\server2"
Opc.Activate
End Sub
5.6.2.2.7 ServerName
Esta propriedade retorna o nome ou a descrição do servidor OPC. Esta
propriedade é diferente da propriedade ServerID, que é um código. Exemplo:
5.6.2.2.8 ServerStatus
Determina o estado da conexão com o servidor OPC. As opções disponíveis
estão descritas na tabela a seguir.
Opções disponíveis para ServerStatus
OPÇÃO DESCRIÇÃO
-1 - ServerStatus_Unknown O Dri ver de Comuni ca çã o OPC es tá
conecta do a o s ervi dor OPC ma s o es ta do
nã o é i nforma do ou o cl i ente OPC pos s ui
a propri eda de ReconnectPeriod em 0
(zero).
0 - ServerStatus_NotConnected O Dri ver de Comuni ca çã o OPC nã o es tá
conecta do a o s ervi dor OPC. Is to a contece
qua ndo, por exempl o, o Dri ver de
Comuni ca çã o OPC nã o es tá a ti vo, ou a
conexã o nã o foi es ta bel eci da por a l gum
probl ema qua l quer.
Exemplo:
Sub CommandButton1_Click()
Dim status
Objetos de Servidor 501
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 não foi informado."
Case 0
MsgBox "O DriverOPC não está conectado ao servidor OPC"
Case 1
MsgBox "O servidor está rodando normalmente"
Case 2
MsgBox "O servidor não está rodando"
Case 3
MsgBox "O servidor está rodando mas sem_
informações de configuração"
Case 4
MsgBox "O servidor foi suspenso temporariamente"
Case 5
MsgBox "O servidor está em Modo de Testes"
End Select
End Sub
NOTA: Pa ra obter o comporta mento equi va l ente a uma propri eda de Bool ea na , o
recomenda do é us a r ServerStatus di ferente de 0 (zero). Is to ba s i ca mente di ferenci a
a pena s entre ha ver a conexã o ou nã o, des cons i dera ndo es ta dos ma i s es pecífi cos
do s ervi dor. Al ém di s to, a expres s ã o i ndepende do us o da propri eda de
ReconnectPeriod di ferente de 0 (zero).
5.6.2.2.9 WriteFeedbackMode
Esta propriedade permite controlar a confirmação (ou feedback) das escritas em
Tags. As opções de configuracão desta propriedade estão descritas na tabela a
seguir.
Opções disponíveis para a propriedade WriteFeedbackMode
OPÇÃO DESCRIÇÃO
0 - wfWaitNextRead Após a es cri ta , a gua rda norma l mente a
próxi ma l ei tura .
1 - wfImmediateReadAfterWrite Força uma l ei tura a s s íncrona de
di s pos i ti vo l ogo a pós ca da es cri ta .
2 - wfTrustWriteSuccess O va l or es cri to é a s s umi do pel o Ta g
i medi a ta mente, ca s o a es cri ta tenha
funci ona do.
5.6.2.3.1 Métodos
Esta seção contém informações sobre os métodos do objeto Grupo OPC.
5.6.2.3.1.1 Refresh
Refresh(Source)
Força o servidor a reenviar os valores de todos os Tags do Grupo OPC que estejam
com a leitura habilitada, tenham eles mudado de valor ou não. O parâmetro Source
determina o argumento da fonte de dados do Driver de Comunicação OPC. Se o
valor informado for 1 (RefreshFromCache), os valores enviados são os valores do
cache do servidor. Do contrário, se o valor informado for 2 (RefreshFromDevice), os
valores enviados são atualizados no cache do servidor antes de serem enviados.
Para que este método funcione, a propriedade Enable do Grupo OPC, bem como a
leitura de pelo menos um Tag do Grupo OPC, deve estar habilitada. Para maiores
informações sobre o mecanismo de habilitação de leitura (modo Advise), veja as
propriedades AllowRead e AdviseType do Tag.
5.6.2.3.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Grupo OPC.
5.6.2.3.2.1 BlockMode
5.6.2.3.2.2 DeadBand
Esta propriedade permite ajustar o nível mínimo de variação de um Tag OPC, para
que este seja atualizado. Essa propriedade só se aplica para os Tags do Grupo OPC
que forem considerados do tipo analógico pelo servidor OPC ao qual o Driver de
Comunicação OPC está conectado. O intervalo válido para esta propriedade é entre
0 e 100%. Um valor de 0 (zero) para esta propriedade significa que qualquer
variação do valor de um Tag do Grupo OPC implica na atualização do Grupo OPC.
Este valor percentual é aplicado para cada Tag em relação aos seus limites de
engenharia (que estão definidos no servidor OPC). Para que um Tag seja atualizado,
a seguinte expressão deve ser verdadeira (isto é avaliado no servidor OPC):
Abs(Valor_guardado_anteriormente – Valor_corrente) >
(DeadBand / 100) * Abs(Limite_Superior – Limite_Inferior)
5.6.2.3.2.3 Enable
5.6.2.3.2.4 RealScan
5.6.2.3.3.1 Eventos
5.6.2.3.3.2 Métodos
5.6.2.3.3.3 Propriedades
EnableDriverEvent
Esta propriedade é utilizada para controlar a geração do evento OnTagRead, que
ocorre no Driver de Comunicação OPC que contém o Bloco de Comunicação OPC. Se
a propriedade EnableDriverEvent do Bloco de Comunicação OPC estiver
configurada para Verdadeiro, a cada leitura vinda do servidor OPC, seja com erro
ou não, é gerado o evento OnTagRead no objeto Driver de Comunicação OPC que
contém este Bloco de Comunicação OPC. Caso contrário, o evento não ocorre.
Também quando a propriedade EnableDriverEvent tiver o valor Verdadeiro, a cada
escrita que seja enviada para o servidor OPC é gerado o evento OnTagWrite no
Objetos de Servidor 509
objeto Driver de Comunicação OPC que contém o Bloco de Comunicação OPC. Se a
escrita for assíncrona, o evento OnTagWrite é gerado apenas quando o servidor
enviar a resposta indicando o efetivo sucesso ou não da escrita. Neste caso, o
evento é gerado apenas se a propriedade EnableDriverEvent for Verdadeira neste
momento, e não no momento do envio da escrita. O valor padrão desta propriedade
é Falso.
ItemID
Esta propriedade determina o caminho que identifica o Bloco de Comunicação
OPC no servidor ao qual o Driver de Comunicação OPC se conecta. A definição
deste caminho é flexível e depende do servidor específico. Normalmente, os
servidores especificam um espaço de ID com itens hierárquicos, do tipo
ItemPai.ItemFilho.Tag1. A propriedade ItemID funciona como uma chave única para
os dados, considerando o onde ou o quê permite ao servidor OPC se conectar à
fonte dos dados. Apesar de o valor padrão ser vazio, é necessário especificar algum
valor para que o Bloco de Comunicação OPC seja válido.
Quality
Esta propriedade informa qual a qualidade do valor contido na propriedade
Value. Cada vez que o Driver de Comunicação OPC atribui um novo valor para o
Bloco de Comunicação OPC, ele também configura a qualidade daquele dado. Esta
propriedade é somente para leitura. O valor padrão desta propriedade é 0 (zero,
qualidade ruim).
NOTA: Pa ra ma i ores i nforma ções s obre qua l i da de, cons ul te o tópi co Qualidade no
Manual do Usuário do Elipse Power.
Size
Define o tamanho do conjunto de valores do Bloco de Comunicação OPC. Consulte
a documentação do Driver utilizado para conhecer qual o limite para esta
propriedade, de acordo com os parâmetros B1 até B4. Criando os Elementos para o
Bloco de Comunicação OPC, possibilita-se acessar os valores lidos e também
permite a escrita de valores para o equipamento ou dispositivo. Esta propriedade
não pode ser modificada após iniciada a comunicação. O valor padrão desta
propriedade é 0 (zero). Exemplo:
Sub BlocoOPC1_OnStartRunning()
Size = 12
End Sub
SyncWrite
Esta propriedade determina o tipo de escrita usada por um Bloco de
Comunicação OPC. Se a propriedade estiver configurada para Verdadeiro, a escrita
é síncrona, isto é, o Driver de Comunicação OPC espera o resultado da escrita do
servidor. Caso contrário, a escrita é assíncrona, isto é, o valor do Tag de
Comunicação OPC é enviado e o processamento do Driver de Comunicação OPC
TimeStamp
Esta propriedade é atualizada sempre que ocorrer alguma mudança de valor ou
de estado nas propriedades Value ou Quality. Esta propriedade informa qual a data
e hora associada tanto ao valor quanto à qualidade do Bloco de Comunicação OPC.
Esta é uma propriedade somente para leitura. O valor padrão desta propriedade é
"00:00:00".
NOTA: Pa ra ma i ores i nforma ções s obre qua l i da de, cons ul te o tópi co Qualidade no
Manual do Usuário do Elipse Power.
RawValue
Acessa o valor original do Elemento de Bloco de Comunicação OPC anterior à
escala, ou seja, independente da configuração da propriedade EnableScaling. Então,
se esta propriedade for Falsa, as propriedades Value e RawValue apresentam o
mesmo comportamento.
UseBitFields
Caso esta propriedade tenha o valor Verdadeiro, toda vez que o valor da
propriedade Value for modificado, ela atualiza os bits referentes às propriedades
Bit00 até Bit31. Da mesma forma, atualiza o valor de Value toda vez que alguma
das propriedades Bit00 até Bit31 mudar de valor e posteriormente envia para o
equipamento ou dispositivo se a propriedade AllowWrite do Bloco de Comunicação
OPC estiver configurada para Verdadeiro. Caso contrário, se esta propriedade
estiver configurada para Falso, os bits não sofrem nem acarretam qualquer
mudança. Esta propriedade pode ser atualizada após ter sido iniciada a
comunicação. O valor padrão desta propriedade é Falso.
Value
Atualizada sempre que um novo valor é lido no servidor OPC, de acordo com a
especificação da propriedade ItemID do Bloco de Comunicação OPC onde este
objeto está inserido, e considerando a propriedade Index, que especifica a posição
do Elemento no vetor do Bloco de Comunicação OPC. O tipo desta propriedade
(número inteiro, ponto flutuante, texto, etc.) depende do Driver ao qual ele está
associado e da sua configuração.
Esta propriedade somente é atualizada desta forma se a propriedade AllowRead do
objeto Bloco de Comunicação OPC ao qual o Elemento de Bloco de Comunicação
OPC pertence estiver configurada para Verdadeiro, e de acordo com o tempo de
varredura definido na propriedade Scan do Grupo OPC que contêm o Bloco de
Comunicação OPC. Se a propriedade AllowWrite do objeto Bloco de Comunicação
OPC estiver configurada em Verdadeiro, pode-se escrever valores no equipamento
ou no dispositivo simplesmente atribuindo um novo valor para a propriedade
Value.
Esta também é a propriedade padrão do objeto Elemento de Bloco OPC. Sendo
assim, uma referência por valor a um objeto Elemento de Bloco OPC não necessita
obrigatoriamente explicitar a propriedade Value para acessar o valor. Caso esta
propriedade não esteja sendo atualizada, verifique se a propriedade Index está
corretamente configurada (seu valor deve ser entre zero e o tamanho do Bloco de
Comunicação OPC menos um). Exemplo:
Sub Botao1_Click()
' Acessa um elemento e mostra o valor atual
Objetos de Servidor 515
' elm1 é um objeto do tipo Elemento de Bloco OPC
Set obj = Application.GetObject_
("OPCDriver1.Grupo1.BlocoOPC1.elm1")
MsgBox "Valor atual de elm1: " & obj.Value
' Isto também pode ser feito de outra forma,
' sem mostrar a propriedade Value, que é padrão
MsgBox "Valor atual de elm1: " & obj
End Sub
5.6.2.3.4.1 Eventos
5.6.2.3.4.2 Métodos
5.6.2.3.4.3 Propriedades
OPÇÃO DESCRIÇÃO
0 - AlwaysInAdvise O Ta g de Comuni ca çã o OPC é ma nti do
a tua l i za do s e a propri eda de AllowRead
for Verda dei ra e a propri eda de Enable do
Grupo OPC ta mbém for Verda dei ra .
1 - AdviseWhenLinked O Ta g de Comuni ca çã o OPC s ó é
a tua l i za do s e a propri eda de AllowRead e
a propri eda de Enable do Grupo OPC forem
Verda dei ra s , e o Ta g es ti ver a s s oci a do a
a l gum objeto a ti vo, como por exempl o
um Di s pl a y de uma Tel a a berta ou um
Al a rme ha bi l i ta do, entre outros . A
a s s oci a çã o do Ta g pa ra es te propós i to
pode s er fei ta na s s egui ntes
propri eda des : Value, RawValue,
TimeStamp, Quality e Bit00 até Bit31 de
Ta gs de Comuni ca çã o OPC.
Exemplo:
Sub CommandButton3_Click()
MsgBox Application._
GetObject("DriverOPC.GrupoOPC.TagOPC1").AdviseType
End Sub
AllowRead
Define se este Tag de Comunicação OPC deve ou não ser lido pelo Driver de
NOTA: Os va l ores dos bi ts (propri eda des Bit00 a té Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
DataType
Propriedade somente de leitura. Determina o tipo de dado associado ao Tag de
Comunicação OPC. Veja a tabela Opções disponíveis para a propriedade DataType
na propriedade DataType do objeto Bloco de Comunicação OPC para os valores
possíveis desta propriedade.
DeviceHigh
Esta propriedade define o valor máximo atingido por um Tag de Comunicação
OPC no equipamento ou no dispositivo. Esta propriedade é utilizada para executar
o ajuste de escala do valor proveniente do equipamento ou do dispositivo antes de
NOTA: Os va l ores dos bi ts (propri eda des Bit00 até Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
DeviceLow
Esta propriedade define o valor mínimo atingido por um Tag de Comunicação
OPC no equipamento ou no dispositivo. Esta propriedade é utilizada para executar
o ajuste de escala do valor proveniente do equipamento ou do dispositivo antes de
ser atribuído à propriedade Value. Da mesma forma, no momento da escrita é
executada a operação inversa antes de enviar o valor para o Driver. Esta conversão
só ocorre quando a propriedade EnableScaling está configurada para Verdadeiro,
senão as configurações permanecem as mesmas. O valor padrão desta propriedade
é 0 (zero). Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prática de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 até Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
NOTA: Os va l ores dos bi ts (propri eda des Bit00 até Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
EULow
Define qual o valor mínimo que deve ser atribuído à propriedade Value, ajustando
a escala ao valor do equipamento ou do dispositivo antes desta atribuição. Da
mesma forma, no momento da escrita, é executada a operação inversa antes de
enviar o valor para o Driver. Esta conversão só ocorre quando a propriedade
EnableScaling está configurada para Verdadeiro. O valor padrão desta propriedade
é 0 (zero). Exemplo:
Sub Tag_OnStartRunning()
' Faz o ajuste de escala de um tag de temperatura
' que varia de 0 a 255 no PLC, mas significam na
' prática de 0 a 100 graus Celsius
EU = "Graus Celsius"
EnableScaling = True
DeviceHigh = 255
DeviceLow = 0
EUHigh = 100
EULow = 0
End Sub
NOTA: Os va l ores dos bi ts (propri eda des Bit00 até Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
NOTA: Pa ra ma i ores i nforma ções s obre qua l i da de, cons ul te o tópi co Qualidade no
Manual do Usuário do Elipse Power.
RawValue
Acessa o valor original do Tag de Comunicação OPC anterior à escala, ou seja,
independente da configuração da propriedade EnableScaling. Portanto, se esta
propriedade for Falsa, as propriedades Value e RawValue apresentam o mesmo
comportamento.
SyncWrite
Esta propriedade determina o tipo de escrita usada por um Tag de Comunicação
OPC. Se a propriedade estiver configurada para Verdadeiro, a escrita é síncrona,
isto é, o Driver de Comunicação OPC espera o resultado da escrita do servidor.
Caso contrário, a escrita é assíncrona, isto é, o valor do Tag de Comunicação OPC é
enviado e o processamento do Driver de Comunicação OPC continua
imediatamente. O valor padrão desta propriedade é Falso.
NOTA: No modo a s s íncrono (propri eda de confi gura da pa ra Fa l s o), a performa nce da
comuni ca çã o tende a s er mel hor, porém no modo s íncrono (propri eda de
confi gura da pa ra Verda dei ro), o s uces s o da opera çã o de es cri ta é veri fi ca do e
i nforma do.
TimeStamp
Esta propriedade é atualizada sempre que ocorrer alguma mudança de valor ou
de estado nas propriedades Value ou Quality. Esta propriedade informa qual a data
e hora associada tanto ao valor quanto à qualidade do Tag de Comunicação OPC.
Esta é uma propriedade somente para leitura. O valor padrão desta propriedade é
NOTA: Os va l ores dos bi ts (propri eda des Bit00 até Bit31) nã o s ã o a feta dos pel o
a jus te de es ca l a , i s to é, repres enta m os bi ts do va l or l i do do equi pa mento a ntes
da convers ã o.
Value
Esta propriedade é atualizada quando é executada uma nova leitura válida de um
valor do equipamento ou do dispositivo utilizando sua configuração, porém o tipo
desta variável (número inteiro, ponto flutuante ou texto) depende do Driver de
Comunicação OPC ao qual ele está associado e da sua configuração. Esta
propriedade somente é atualizada desta forma se a propriedade AllowRead estiver
configurada para Verdadeiro e quando não houver erros de comunicação (neste
caso somente as propriedades Quality e TimeStamp são atualizadas), mas de
acordo com o tempo de varredura definido no Grupo OPC ao qual o Tag de
Comunicação OPC pertence. Outra forma de utilizar esta propriedade é escrever
valores no equipamento ou dispositivo. Basta que se atribua um novo valor para a
propriedade Value ou algum dos bits Bit00 até Bit31, desde que a propriedade
AllowWrite esteja configurado para Verdadeiro. Esta propriedade também é a
propriedade padrão do objeto Tag de Comunicação OPC. Sendo assim, uma
referência por valor a um objeto Tag de Comunicação OPC não necessita
obrigatoriamente explicitar a propriedade Value para acessar o valor. O valor
padrão desta propriedade é vazio. Exemplo:
Sub Botao1_Click()
' Acessa um tag e mostra o valor atual
' tag1 é um objeto tipo OPCTag
Set obj = Application._
GetObject("Driverde_ Comunicacao1.tag1")
MsgBox "Valor atual de tag1: " & obj.Value
' Sem mostrar a propriedade Value, que é padrão
MsgBox "Valor atual de tag1: " & obj
End Sub
5.6.3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Driver de
Comunicação OPC UA.
5.6.3.1.1 EndPointURL
Propriedade de leitura e escrita que especifica o caminho (ponto de conexão) do
servidor OPC UA ao qual o cliente se conecta. Esta propriedade não pode ser
alterada com a comunicação ativa.
5.6.3.1.2 Password
Propriedade de leitura e escrita que especifica a senha do usuário que é usado
na conexão com o servidor OPC UA. Esta propriedade é usada em conjunto com a
propriedade UserName, e seu valor padrão é uma String vazia.
5.6.3.1.3 SecurityMode
Propriedade de leitura e escrita que especifica o modo de segurança que é
usado na conexão com o servidor OPC UA. Esta propriedade não pode ser alterada
com a comunicação ativa. Os valores possíveis para esta propriedade são os
seguintes:
1 - usmNone: Não utiliza nenhum modo de segurança na conexão
2 - usmSign: Utiliza autenticação na conexão
3 - usmSignAndEncrypt: Utiliza autenticação e criptografia na conexão
5.6.3.1.5 TimeoutCall
NOTA: No pa drã o OPC UA, vá ri a s cha ma da s permi tem conti nua r a comuni ca çã o, com
múl ti pl a s res pos ta s do s ervi dor. Des ta forma , es te tempo a ca ba por s er o tempo
l i mi te de res pos ta do s ervi dor OPC UA.
5.6.3.1.6 TimeoutConnection
Propriedade de leitura e escrita que especifica o tempo limite da conexão, em
milissegundos. O valor padrão desta propriedade é 10000 (10 segundos) e seu
valor deve ser maior que 0 (zero). Esta propriedade não pode ser alterada com a
comunicação ativa.
5.6.3.1.7 TimeoutSession
Propriedade de leitura e escrita que especifica o tempo limite para a renovação
da sessão de comunicação do cliente E3 com o servidor OPC UA, em milissegundos.
O valor padrão desta propriedade é 600000 (10 minutos) e este valor deve ser
maior que 0 (zero). Esta propriedade não pode ser alterada com a comunicação
ativa.
5.7.1 Consulta
Esta seção contém informações sobre eventos, métodos e propriedades do objeto
Consulta.
5.7.1.1 Eventos
Esta seção contém informações sobre os eventos do objeto Consulta.
5.7.1.1.1 OnAsyncQueryFinish
OnAsyncQueryFinish(Recordset, Error)
Ocorre no retorno do método GetAsyncADORecordset. O parâmetro Recordset é o
ADO Recordset gerado pela Consulta, e o parâmetro Error é um Booleano que,
quando verdadeiro, mostra que o objeto não conseguiu ser gerado. Exemplo:
Sub Consulta1_OnAsyncQueryFinish(Recordset, Error)
MsgBox "Retornou " + CStr(Recordset.RecordCount) + "
registros"
End Sub
5.7.1.2 Métodos
Esta seção contém informações sobre os métodos do objeto Consulta.
5.7.1.2.1 AddField
AddField(Name[, Table])
O método AddField adiciona um novo campo da tabela na Consulta. O parâmetro
Name determina o nome do novo campo que é adicionado à Consulta. O parâmetro
Table determina o nome da tabela a que o campo pertence. Este método foi
526 Objetos de Servidor
desenvolvido apenas para manter a compatibilidade com o antigo objeto Consulta
do E3Chart. Exemplo:
Sub Botao1_Click()
Screen.Item("E3Browser").Item("Consulta").AddField "Campo1"
End Sub
5.7.1.2.2 AddStorageTag
AddStorageTag(Name, FieldType)
Adiciona um Tag pertencente ao Storage à Consulta. O parâmetro Name recebe o
nome do Tag a ser adicionado. O parâmetro FieldType indica o tipo deste Tag (0:
Double, 1: Bit, 2: String, 3: Integer). Retorna um Booleano indicando o sucesso (ou
não) da operação.
5.7.1.2.3 AddTable
AddTable(Name)
Adiciona uma tabela do banco de dados na Consulta. O parâmetro Table determina
o nome da tabela a ser adicionada.
5.7.1.2.4 AddUaField
AddUaField(Name[, Alias[, Function]])
Este método adiciona, em tempo de execução, um campo a uma consulta
configurada para o tipo OPC UA. O método retorna Verdadeiro se for bem sucedido
e Falso se houver falha. Os parâmetros deste método são os seguintes:
Name: Uma String com o caminho (Coluna) do campo
Alias: Uma String com o título do campo. Se este parâmetro for omitido assume
uma String vazia
Function: Uma String com o tipo de função de agregação do campo, caso seja
usada uma consulta do tipo Dados Processados. Se este parâmetro for omitido,
assume o valor Interpolative
5.7.1.2.5 Execute
Execute(ImmediateExecute)
O método Execute executa um comando SQL que não tenha retorno (como DELETE,
UPDATE ou INSERT), configurado na propriedade SQL da Consulta. O parâmetro
ImmediateExecute indica se a operação passará pelas filas de operações (arquivos
.e3i e .e3o) antes de chegar ao Banco de Dados (caso esteja configurada como
Falso), ou se será enviada diretamente para o Banco de Dados (caso esteja
configurada como Verdadeiro). A vantagem de se utilizar a Consulta para executar
comandos é a utilização de variáveis, como em uma consulta simples. Exemplo de
comandos SQL:
DELETE FROM teste WHERE cod > 10
UPDATE teste SET cod = 10 WHERE cod > 10
INSERT INTO teste(cod) VALUES(10)
Exemplo:
Sub CommandButton1_Click()
Screen.Item("Consulta1").Execute
End Sub
5.7.1.2.6 GetADORecordSet
GetADORecordSet()
O método GetADORecordSet retorna um Recordset do tipo ADO (ActiveX Data
Object), resultante da execução da Consulta configurada. Exemplo:
Sub Botao1_Click()
Set rec = Screen.Item("Consulta1").GetADORecordset()
strDatas = " "
i = 0
5.7.1.2.7 GetAsyncADORecordSet
GetAsyncADORecordSet()
Cria uma Consulta e, quando ela estiver finalizada, gera o evento
OnAsyncQueryFinish do próprio objeto, passando para este evento o resultado
(Recordset) gerado pela Consulta.
5.7.1.2.8 GetE3QueryFields
GetE3QueryFields()
O método GetE3QueryFields retorna a Coleção de Campos (colunas) de uma
Consulta. Cada item desta Coleção possui propriedades que podem ser
modificadas, conforme descrito no tópico Campo da Consulta. Exemplo:
Sub Botao1_Click()
' Percorre a coleção de Campos,
' mostrando-os em uma caixa de mensagem
' e ajustando-os como visíveis
' na configuração da Consulta.
5.7.1.2.9 RemoveField
RemoveField(FieldName[, Table])
O método RemoveField remove um campo previamente incluído em uma Consulta.
O parâmetro FieldName determina o nome do campo que será removido. O
parâmetro Table determina o nome da tabela a qual o campo pertence. Este método,
Objetos de Servidor 529
a exemplo do método AddField, foi incluído para manter a compatibilidade com as
versões antigas da Consulta do E3Chart. Exemplo:
Sub CommandButton1_Click()
Screen.Item("E3Browser").Item("Consulta")._
RemoveField "Campo1"
End Sub
5.7.1.2.10 RemoveStorageTag
RemoveStorageTag(Name)
Remove um Tag previamente configurado na Consulta. O parâmetro Name indica o
nome do Tag. Retorna um Booleano indicando o sucesso ou não da operação.
5.7.1.2.11 RemoveTable
RemoveTable(TableName)
Remove uma tabela da Consulta. O parâmetro TableName determina o nome da
tabela a ser removida.
5.7.1.2.12 RemoveUaField
RemoveUaField(Name)
Este método remove o campo com o nome especificado, se existir. O parâmetro
Name é uma String com o nome (Coluna) do campo. O método retorna Verdadeiro se
for bem sucedido e Falso se houver falha. Este método só tem efeito se a
propriedade QueryType estiver configurada para OPC UA (valor igual a 2:
qtOpcUa). Do contrário, retorna Falso.
5.7.1.2.13 SetVariableValue
SetVariableValue(VarName, Value)
O método SetVariableValue ajusta o valor de uma variável configurada na
Consulta, de forma que este valor possa ser informado como um filtro ou
parâmetro antes de a Consulta ser realizada. Deve ser definido o nome da variável
(VarName) e seu valor (Value), que pode ser um número, texto ou data e hora.
Exemplo:
Sub CommandButton_Click()
Set cons = Screen.Item("E3Browser1").Item("Consulta1")
530 Objetos de Servidor
DataInicial = now - 1
DataFinal = now
cons.SetVariableValue "DataIni", DataInicial
cons.SetVariableValue "DataFim", DataFinal
End Sub
5.7.1.3 Propriedades
Esta seção contém informações sobre as propriedades do objeto Consulta.
NOTA: Nã o é recomendá vel o a ces s o di reto des ta s propri eda des vi a s cri pts . O i dea l
é a ces s a r o objeto Cons ul ta , pa s s a ndo pa râ metros a tra vés do método
SetVariableValue e modi fi ca ndo fi l tros ou ca mpos a tra vés da col eçã o retorna da com
o método GetE3QueryFields.
5.7.1.3.1 CursorLocation
Define o local onde a Consulta é gerada e manipulada, sob o ponto de vista do
SGBD (Sistema Gerenciador do Banco de Dados). As opções disponíveis são:
0 - clServer: A Consulta é gerada no SGBD (servidor)
1 - clClient: A Consulta é gerada no Servidor (cliente)
5.7.1.3.2 CursorType
Define o tipo de Consulta de acordo com a visualização dos dados. O valor
padrão desta propriedade é 0 - ctKeyset. Todas as opções disponíveis estão na
tabela a seguir.
Opções disponíveis para CursorType
OPÇÃO DESCRIÇÃO
0 - ctKeyset Qua l quer muda nça nos regi s tros
i ni ci a l mente retorna dos pel a Cons ul ta
s erá vi s ível (Pa drã o).
5.7.1.3.3 DataSource
Indica o objeto Banco de Dados, Storage ou Driver de Comunicação OPC UA que
será usado na Consulta. Esta propriedade é somente de leitura, mas pode ser
modificada em tempo de execução.
5.7.1.3.4 Fields
Texto com os campos a serem visualizados na Consulta, separados por vírgula.
Corresponde ao argumento da cláusula SELECT do código SQL da Consulta. Em
branco (vazio), determina que a Consulta deve mostrar todos os campos da tabela.
Esta propriedade é somente de leitura, mas pode ser modificada em tempo de
execução.
5.7.1.3.5 FunctionSubType
Especifica o subtipo da função indicada por FunctionType. Apenas as opções 1 -
ftArchivedValue, 2 - ftTagAttribute e 6 - ftCalculatedData possuem subtipos. Para as
outras funções, FunctionSubType assume o valor -1 - fsNoSubType. A tabela a seguir
mostra os possíveis valores da propriedade, de acordo com a função escolhida na
propriedade FunctionType:
Subtipos para função ArchivedValue (FunctionType = 1)
SUBTIPO DESCRIÇÃO
0 - fsPreviousArchivedValue Va l or a rma zena do i medi a ta mente
a nteri or a o timestamp forneci do.
1 - fsInterpolatedArchivedValue Va l or ca l cul a do a pa rti r do va l or a nteri or
e pos teri or.
2 - fsNextArchivedValue Va l or a rma zena do i medi a ta mente
pos teri or a o timestamp.
3 - fsExactArchivedValue Se for encontra do um va l or a rma zena do
no exa to i ns ta nte que foi forneci do pel o
timestamp.
SUBTIPO DESCRIÇÃO
0 - fsTagAttributeDescription Si gni fi ca do ou des cri çã o do Ta g.
1 - fsTagAttributeSource Ca mi nho do Ta g que es tá s endo
a rma zena do.
2 - fsTagAttributeType Ti po de da do: Double, Boolean ou String.
3 - fsTagAttributeEU Uni da de de engenha ri a .
4 - fsTagAttributeLowEng Li mi te i nferi or.
5 - fsTagAttributeHighEng Li mi te s uperi or.
6 - fsTagAttributeDeadBand Ba nda morta pa ra gra va çã o.
7 - fsTagAttributeDeadBandUnit Uni da de da ba nda morta (va l or a bs ol uto
ou porcenta gem).
8 - fsTagAttributeMinRecTime Tempo míni mo pa ra gra va çã o (va ri a ções
menores que es s e i nterva l o s ã o
des preza da s ).
9 - fsTagAttributeMaxRecTime Tempo má xi mo pa ra gra va çã o (a
a us ênci a de va ri a çã o nes s es i nterva l os
força uma gra va çã o).
5.7.1.3.6 FunctionType
Esta propriedade é válida quando um objeto Storage é fonte da Consulta (isto é
indicado pela propriedade DataSource). Ela especifica a função que define os
dados gerados pela Consulta. Algumas funções possuem subfunções, que podem
ser indicadas na propriedade FunctionSubType. A propriedade FunctionType pode
assumir os valores descritos na tabela a seguir.
5.7.1.3.7 GroupBy
Texto correspondente ao argumento da cláusula GROUP BY do código SQL da
Consulta. Esta propriedade é somente de leitura, mas pode ser modificada em
tempo de execução.
5.7.1.3.9 IgnoreQuality
5.7.1.3.10 OrderBy
Texto correspondente ao argumento da cláusula ORDER BY do código SQL da
Consulta. Esta propriedade é somente de leitura, mas pode ser modificada em
tempo de execução.
5.7.1.3.11 QueryType
Indica o tipo de consulta a ser realizada. Os valores possíveis para esta
propriedade são os seguintes:
-1 - qtUndefined: O objeto Consulta inicialmente tentará executar a consulta em
um objeto Banco de Dados. Se falhar, tentará executá-la em um objeto Storage.
Este é o valor padrão para Consultas criadas no Studio ou em tempo de execução
0 - qtDBServer: O objeto Consulta tentará executar a consulta somente em um
objeto Banco de Dados
1 - qtStorage: O objeto Consulta tentará executar a consulta somente em um
objeto Storage
2 - qtOpcUa: O objeto Consulta tentará executar a consulta somente em um
objeto Driver de Comunicação OPC UA
5.7.1.3.12 SQL
5.7.1.3.13 Table
A propriedade Table contém as tabelas que serão consultadas (por exemplo,
Alarms é a tabela de alarmes ou eventos). Corresponde ao argumento da cláusula
FROM do código SQL da Consulta. Esta propriedade é somente de leitura, mas pode
ser modificada em tempo de execução.
5.7.1.3.14 UaNamespaceArray
Esta propriedade retorna um objeto que é uma Coleção de Namespaces OPC UA,
usada pelos campos configurados na Consulta. Esta propriedade é somente de
leitura.
5.7.1.3.15 UaQueryType
Esta é uma propriedade de leitura e escrita que permite determinar se a
Consulta é do tipo Dados Brutos (0: uqtRaw) ou do tipo Dados Processados (1:
uqtProcessed, valor padrão). No Studio esta propriedade é somente de leitura. Em
tempo de execução ela permite configurar o tipo da consulta OPC UA, mas só aceita
escritas se a propriedade QueryType estiver configurada para OPC UA (valor igual
a 2: qtOpcUa).
5.7.1.4.1 Métodos
Esta seção contém informações sobre os métodos do objeto Coleção de Campos da
Consulta.
5.7.1.4.1.1 Add
Add(NewItem)
Adiciona um novo objeto Campo da Consulta na Coleção de Campos de uma
Consulta, indicado pelo parâmetro NewItem.
5.7.1.4.1.2 Item
Item(Index)
Retorna um objeto Campo da Consulta da Coleção de Campos. O parâmetro Index
pode ser o índice númerico deste Campo ou seu nome.
5.7.1.4.1.3 RefreshUaNodeIds
RefreshUaNodeIds()
Atualiza todos os Campos da Consulta, buscando os Identificadores de Nós OPC UA
(NodeIds) no servidor e atualizando a propriedade UaNodeId dos Campos da
Consulta. Para que este método funcione, as seguintes condições devem ser
atendidas:
A propriedade QueryType da Consulta deve estar configurada para 2: qtOpcUa
A Consulta deve apontar para um Driver de Comunicação OPC UA válido
O Driver de Comunicação OPC UA configurado na Consulta deve estar ativo e
conectado
Remove(Index)
Remove um objeto Campo da Consulta da Coleção de Campos de uma Consulta. O
parâmetro Index pode ser tanto uma String com o nome do Campo da Consulta
quanto o índice deste objeto na Coleção de Campos.
5.7.1.4.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de
Campos da Consulta.
5.7.1.4.2.1 Count
5.7.1.4.3.1 Propriedades
5.7.1.5.1 Métodos
5.7.1.5.1.1 Add
Add(Item)
Adiciona um identificador de Namespace, sempre ao final da Coleção. O parâmetro
Item é uma String que define o Namespace. Este parâmetro não pode ser vazio.
5.7.1.5.1.2 Item
Item(Index)
Retorna o identificador de Namespace do índice especificado. O parâmetro Index
5.7.1.5.1.3 Remove
Remove(Index)
Remove o Namespace do índice especificado. Note que isto implica em mudar os
índices dos Namespaces de índice superior ao removido. Não é possível remover os
índices 0 (zero) e 1 (um). O parâmetro Index é um valor (LONG) que identifica o
Namespace que se deseja remover da Coleção, variando entre 2 (dois) e Count
menos 1 (um).
5.7.1.5.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Coleção de
Namespaces OPC UA.
5.7.1.5.2.1 Count
5.7.1.5.3.1 Propriedades
5.7.2.1.1 GetEventByIndex
GetEventByIndex(Index)
Retorna um objeto Evento de uma Coleção de Eventos, especificado pelo parâmetro
Index, que corresponde ao índice do objeto na Coleção. Para mais informações
sobre as propriedades do objeto retornado por este método, consulte o tópico
Evento - Propriedades. Exemplo de script para este método:
Sub CommandButton_Click()
For i = 0 To Screen.Item("FiltroAlarmes1").AlarmCount - 1
str = ""
set evt = Screen.Item("FiltroAlarmes1").GetEventByIndex(i)
str = str & "AlarmSourceName = " &_
evt.AlarmSourceName & Chr(13)
str = str & "FullAlarmSourceName = " &_
evt.FullAlarmSourceName & Chr(13)
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 & "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 = " &_
5.7.2.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Filtro de Alarmes.
5.7.2.2.1 ActiveAlarms
Determina o número de alarmes ativos no Filtro de Alarmes. Esta propriedade é
somente de leitura.
5.7.2.2.2 ActiveHighAlarms
Indica o número de alarmes ativos com severidade Alta. Esta propriedade é
somente de leitura.
5.7.2.2.3 ActiveHighNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Alta. Esta
propriedade é somente de leitura.
5.7.2.2.5 ActiveLowNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Baixa. Esta
propriedade é somente de leitura.
5.7.2.2.6 ActiveMedAlarms
Indica o número de alarmes ativos com severidade Média. Esta propriedade é
somente de leitura.
5.7.2.2.7 ActiveMedNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Média. Esta
propriedade é somente de leitura.
5.7.2.2.8 ActiveNACKAlarms
Indica o número de alarmes que estão sem reconhecimento dentro do Filtro de
Alarmes. Esta propriedade é somente de leitura.
5.7.2.2.9 AlarmCount
Determina o número de alarmes no Filtro de Alarmes. Esta propriedade é somente
de leitura.
5.7.2.2.10 AlarmServer
5.7.2.2.11 AreaFilter
Controla as áreas de alarmes visíveis no Filtro de Alarmes. Se seu valor não for
uma String vazia, são apresentados eventos cujo nome das Áreas comecem com o
texto indicado. Por exemplo, se AreaFilter é igual a "Ana", são mostrados os
alarmes de Áreas como "Analogicos.Producao" ou "Analise", mas não
"Digitais.Analise" ou "Digitais.Producao". Quando a propriedade SimpleAreaFilter
estiver configurada como Falso, a Área de Alarme também permite o uso de
coringas para a filtragem (* ou ?), e permite múltiplos filtros de Área, separados
por dois pontos. Os coringas permitidos são:
"*": Aceita nenhum ou qualquer quantidade de caracteres
O padrão desta propriedade é uma String vazia, ou seja, sem filtragem por área
(veja também as propriedades CustomFilter, SimpleAreaFilter, ShowHighPriority,
ShowMediumPriority e ShowLowPriority).
5.7.2.2.12 Connections
Retorna uma coleção de Conexões no Filtro de Alarmes. Para mais informações
sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de
Conexões.
5.7.2.2.13 CustomFilter
Permite informar um filtro personalizado para os alarmes, na forma de uma
expressão. Os seguintes campos estão disponíveis para utilização na expressão do
filtro:
Acked (Booleano): Indica se esta mensagem já foi reconhecida
AckRequired (Booleano): Indica se é necessário reconhecer esta mensagem
AckTime (Data): Data e hora em que a condição de alarme foi reconhecida
(ou zero se não foi reconhecida)
ActiveSource (Inteiro): -1 - None, 0 - ActiveSource, 1 - Scada, 2 - Operator, 3 -
CCLink, 4 - Billing, 5 - Calculated, 6 - Database, 100 - TopologyProcessor, 101 -
PowerFlow, 102 - StateEstimator, 103 - LoadShedding, 104 -
DistLoadModelling, 105 - SelfHealing ou 106 - ExternalReader
ActorID (String): Login do usuário que reconheceu a mensagem (ou uma
String vazia se a mensagem ainda não foi reconhecida)
AlarmSourceName (String): Nome do objeto Fonte de Alarme (apenas o nome,
não o caminho completo)
Area (String): Área deste alarme
ChangeMask (Inteiro): Campo não utilizado pelo Elipse Power atualmente,
sempre em 0 (zero)
Objetos de Servidor 545
ConditionActive (Booleano): Indica se a condição de alarme está ativa
ConditionName (String): Nome da última condição de alarme ativa
Cookie (Inteiro): Identifica uma Fonte de Alarme durante uma sessão de
execução
CurrentValue (Double): Valor da Fonte no momento em que a condição de
alarme ficou ativa
Enabled (Booleano): Indica se a verificação de alarmes na Fonte de Alarme
está habilitada
EventCategory (String): Nome da categoria do alarme (por exemplo, "Nível",
"Taxa de Variação", "Banda Morta", "Digital" ou "Discreto")
EventTime (Data): Data e hora da última atualização do evento
EventTimeUTC (Data): Data e hora da última atualização do evento
EventType (String): "Event" (evento) ou "Condition" (alarme)
FormattedValue (String): Contém o valor (formatado) da Fonte no momento
em que a condição de alarme ficou ativa
FullAlarmSourceName (String): Nome completo do objeto Fonte de Alarme
InTime (Data): Data e hora em que a condição de alarme ficou ativa
Message (String): Mensagem do alarme
OutTime (Data): Data e hora em que a condição saiu de alarme (ou zero se
ainda está ativa)
Quality (String): "Boa (xxx)", "Ruim (xxx)" ou "Incerta (xxx)"
Severity (Inteiro): 0 - Alta, 1 - Média ou 2 - Baixa
Source (String): Link da Fonte de Alarme
SubConditionName (String): Nome da sub-condição de alarme (por exemplo,
"LOLO", "LO", "HI", "HIHI", "DIG", etc.)
5.7.2.2.14 Events
Retorna uma coleção de Eventos no Filtro de Alarmes. Para mais informações
sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Eventos.
Exemplo de uso desta propriedade:
Sub CommandButton1_Click()
For Each evt In Screen.Item("FiltroAlarmes1").Events
str = ""
str = str & "AlarmSourceName = " &_
evt.AlarmSourceName & Chr(13)
str = str & "FullAlarmSourceName = " &_
evt.FullAlarmSourceName & Chr(13)
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 & "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 = " &_
Objetos de Servidor 547
evt.SubConditionName & Chr(13)
str = str & "FormattedValue = " &_
evt.FormattedValue & Chr(13)
str = str & "UserField(1) = " &_
evt.UserField(1) & Chr(13)
str = str & "UserField(2) = " &_
evt.UserField(2) & Chr(13)
str = str & "UserField(3) = " &_
evt.UserField(3) & Chr(13)
str = str & "UserField(4) = " &_
evt.UserField(4) & Chr(13)
str = str & "Severity = " &_
evt.Severity & Chr(13)
str = str & "Acked = " &_
evt.Acked & Chr(13)
str = str & "AckRequired = " &_
evt.AckRequired & Chr(13)
str = str & "ConditionActive = " &_
evt.ConditionActive & Chr(13)
str = str & "Enabled = " &_
evt.Enabled & Chr(13)
str = str & "EventCLSID = " &_
evt.EventCLSID & Chr(13)
MsgBox str
Next
End Sub
5.7.2.2.15 Filters
Retorna uma coleção de Filtros no Filtro de Alarmes. Para mais informações
sobre a coleção retornada nesta propriedade, consulte o tópico Coleção de Filtros.
5.7.2.2.16 FilterType
Efetua os filtros de alarme. As opções disponíveis são as seguintes:
1 - OnlyAlarms: Mostra apenas alarmes
2 - OnlyEvents: Mostra apenas eventos
3 - AlarmsAndEvents: Mostra tanto alarmes quanto eventos
5.7.2.2.17 FourthSortAscending
Quando esta propriedade estiver configurada para Falso, a ordenação de eventos
pelo campo quaternário é no sentido descendente. Caso contrário, o sentido é
ascendente. O valor padrão desta propriedade é Falso.
5.7.2.2.19 InactiveHighNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Alta.
Esta propriedade é somente de leitura.
5.7.2.2.20 InactiveLowNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Baixa.
Esta propriedade é somente de leitura.
5.7.2.2.21 InactiveMedNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Média.
Esta propriedade é somente de leitura.
5.7.2.2.22 InactiveNACKAlarms
Determina o número total de alarmes inativos e não reconhecidos. Esta
propriedade é somente de leitura.
5.7.2.2.23 PrimarySortAscending
Quando esta propriedade estiver configurada para Falso, a ordenação de eventos
pelo campo primário é no sentido descendente. Caso contrário, o sentido é
ascendente. O valor padrão desta propriedade é Falso.
5.7.2.2.24 PrimarySortField
5.7.2.2.26 SecondarySortField
5.7.2.2.27 ShowHighPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Alta. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Verdadeiro.
5.7.2.2.28 ShowLowPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Baixa. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Verdadeiro.
5.7.2.2.29 ShowMediumPriority
Filtra quais alarmes são mostrados ou não, de acordo com a sua severidade.
Quando estiver em Verdadeiro, são mostrados os alarmes de severidade Média. Do
contrário, estes alarmes não são mostrados. O valor padrão desta propriedade é
Verdadeiro.
5.7.2.2.30 SimpleAreaFilter
Quando esta propriedade for igual a Verdadeiro, o comportamento de filtragem
pelo nome de Área de Alarmes é baseado apenas na coincidência da parte inicial
do nome. Quando for igual a Falso, o comportamento leva em conta todo o nome da
Área, mas permite o uso de caracteres coringa e múltiplos filtros de área, que
devem ser separados por dois pontos. Veja também a propriedade AreaFilter, que
especifica o filtro por nome de área.
5.7.2.2.32 ThirdSortField
5.7.3.1 Métodos
Esta seção contém informações sobre os métodos do objeto Impressora de Linha.
5.7.3.1.1 Write
Write(Value)
Envia a String passada no parâmetro Value para a impressora selecionada no
objeto Impressora de Linha. Caso o valor passado por este método exceda o
número de linhas pendentes configurado na propriedade MaxPendingLines, este
método retorna erro e a String é descartada.
O parâmetro Value é enviado à impressora configurada como dados brutos, ou
seja, sem nenhum tipo de formatação. Para imprimir caracteres especiais, como
nova linha ou tabulação, utilize constantes de String ou o método Chr do VBScript,
que recebe o código ANSI do caractere a ser impresso. A tabela a seguir contém as
constantes mais comuns para impressão em impressoras matriciais. Para maiores
informações sobre caracteres específicos, consulte o manual do usuário da
impressora desejada.
Constantes mais comuns para impressão de caracteres especiais
CONSTANTE VALOR DESCRIÇÃO
vbCr Chr(13) Ca ra ctere de retorno de
ca rro
vbLf Chr(10) Ca ra ctere de nova l i nha
5.7.3.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Impressora de
Linha.
5.7.3.2.1 MaxPendingLines
Número máximo de linhas pendentes a serem impressas. Caso a fila de espera da
impressora atinja este valor e mais linhas sejam enviadas, utilizando o método
Write, é gerado um erro de script e a linha enviada é descartada. O valor padrão
desta propriedade é 1000.
5.7.3.2.2 PrinterName
Nome da impressora utilizada pelo objeto Impressora de Linha. O valor padrão
desta propriedade é uma String vazia, ou seja, o objeto Impressora de Linha utiliza
a impressora padrão do Windows.
NOTAS:
Ca s o es ta propri eda de es teja confi gura da com uma String va zi a e a propri eda de
UseDefaultPrinter es teja confi gura da pa ra Fa l s o, nã o é pos s ível i mpri mi r e a
propri eda de PrinterStatus retorna o va l or 0 (zero, psUnknown).
A i mpres s ora pa drã o do Wi ndows pa ra o us uá ri o a tua l mente l oga do pode s er
di ferente da i mpres s ora pa drã o uti l i za da pel o E3 Server. Es ta i mpres s ora es tá
i denti fi ca da pel o ícone na ja nel a E3 Admin - Impressora (cl i que com o botã o
di rei to do mous e no ícone do E3 Admi n na Área de Noti fi ca ções do Wi ndows e
s el eci one a opçã o Impressora).
5.7.3.2.3 PrinterStatus
Indica o status da impressora selecionada para o objeto Impressora de Linha.
Esta propriedade é somente de leitura e pode apresentar os seguintes valores:
0 - psUnknown: Status desconhecido (padrão)
1 - psOffline: A impressora não está disponível
2 - psError: Houve um erro na impressão
552 Objetos de Servidor
3 - psReady: A impressora está pronta para impressão
5.7.3.2.4 UseDefaultPrinter
Configura o objeto Impressora de Linha para utilizar a impressora padrão do
Windows. O valor padrão desta propriedade é Verdadeiro.
NOTAS:
Ca s o es ta propri eda de es teja confi gura da pa ra Fa l s o e a propri eda de
PrinterName es teja confi gura da com uma String va zi a , nã o é pos s ível i mpri mi r e a
propri eda de PrinterStatus retorna o va l or 0 (zero, psUnknown).
A i mpres s ora pa drã o do Wi ndows pa ra o us uá ri o a tua l mente l oga do pode s er
di ferente da i mpres s ora pa drã o uti l i za da pel o E3 Server. Es ta i mpres s ora es tá
i denti fi ca da pel o ícone na ja nel a E3 Admin - Impressora (cl i que com o botã o
di rei to do mous e no ícone do E3 Admi n na Área de Noti fi ca ções do Wi ndows e
s el eci one a opçã o Impressora).
5.7.5.1 Eventos
Esta seção contém informações sobre os eventos do objeto Tag Contador.
5.7.5.1.1 OnPreset
OnPreset()
Ocorre toda vez que o valor da propriedade Preset é alcançado.
5.7.5.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag Contador.
5.7.5.2.1 AutoRestart
Indica que a contagem deve ser recomeçada do zero após ter sido atingido o
valor estabelecido na propriedade Preset. Esta propriedade somente é válida
5.7.5.2.2 CounterType
5.7.5.2.3 Enabled
Inicia ou para o contador. Em True, a contagem é iniciada; em False, ela é
interrompida.
5.7.5.2.4 Increment
Define o intervalo de atualização da propriedade Value. Caso esta propriedade
tenha seu valor modificado enquanto a contagem estiver em curso, esta
modificação só terá efeito quando o contador for parado e reiniciado.
5.7.5.2.5 Preset
Limite a ser atingido pelo contador, em segundos. Caso o valor de Preset não seja
um múltiplo de Increment, o Tag irá atingir este valor antes do próximo incremento.
5.7.5.2.6 ResetCounterWhenEnabled
Habilita o reinício da contagem (do zero) cada vez que o valor da propriedade
Enabled retorna a True. Quando desabilitada, o contador reinicia a contagem de
onde ela foi interrompida anteriormente.
5.7.5.2.7 Value
5.7.6.1.1 Reset
Reset()
Zera a fase (deslocamento em tempo) da forma de onda do Tag. A fase da onda
somente será zerada quando o Tag estiver habilitado. Este método, quando o Tag
estiver habilitado, não tem efeito nos Tags do tipo CurrentTime e Random, que não
são periódicos. Quando o Tag estiver desabilitado, seu valor é simplesmente
zerado, independentemente do tipo de Tag.
5.7.6.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag Demo.
5.7.6.2.1 Enabled
5.7.6.2.2 Maximum
A propriedade Maximum determina o valor máximo do Tag. O valor padrão desta
propriedade é 100. Exemplo:
Sub CommandButton2_Click()
' Ao clicar no botão, abre uma caixa de mensagens,
' indicando o valor da propriedade Maximum do TagDemo6
MsgBox Application.GetObject("Dados.TagDemo6").Maximum
End Sub
5.7.6.2.3 Minimum
A propriedade Minimum determina o valor mínimo do Tag. O valor padrão desta
propriedade é 0. Exemplo:
Sub CommandButton2_Click()
' Ao clicar no botão, abre um messagebox indicando o valor
' da propriedade Minimum do TagDemo6
MsgBox Application.GetObject("Dados.TagDemo6").Minimum
End Sub
5.7.6.2.5 Scan
A propriedade Scan define o intervalo de tempo, em milissegundos, entre duas
variações da propriedade Value. Utilize esta propriedade se você desejar maior ou
menor quantidade de dados gerados pelo Tag Demo. O valor padrão desta
propriedade é 1000. O valor do scan deve ser maior que 0. Exemplo:
Sub Linha1_Click()
Application.GetObject("Dados.TagDemo2").Scan = 200
End Sub
5.7.6.2.6 TimeStamp
A propriedade TimeStamp é atualizada sempre que ocorrer alguma mudança de
valor ou estado nas propriedades Value ou Quality. Ela informa qual a data e hora
associada tanto ao valor quanto à qualidade do Tag Demo. Esta é uma propriedade
somente para leitura. O valor padrão desta propriedade é 00:00:00.
5.7.6.2.7 Type
Determina o tipo de onda do Tag. Modifique a propriedade conforme a tabela a
seguir. Quando a propriedade Type estiver configurado para 3 (CurrentTime), a
propriedade Value irá conter a data e hora atual do servidor.
Opções disponíveis para Type
VALOR FORMA DE ONDA
0 Ra ndom (a l ea tóri a )
1 Si ne (onda s enói de)
2 Squa re (onda qua dra da )
3 CurrentTi me (da ta e hora )
4 Ra mpUp (borda de s ubi da )
5 Ra mpDown (borda de des ci da )
6 Ra mpUpDown (borda de s ubi da e
des ci da )
Exemplo:
Sub Linha1_Click()
556 Objetos de Servidor
Application.GetObject("Dados.TagDemo2").Type = 2
End Sub
5.7.6.2.8 Value
A propriedade Value varia de acordo com o tipo da forma de onda, estabelecida
na propriedade Type. Esta é uma propriedade apenas de leitura. O valor padrão
desta propriedade é 0. Exemplo:
Sub Figura1_Click()
MsgBox Application.GetObject("Dados.TagDemo2").Value = 10
End Sub
5.7.7.1 Métodos
Esta seção contém informações sobre os métodos do objeto Tag Interno.
5.7.7.1.1 WriteEx
WriteEx([NewValue[, NewTimestamp[, NewQuality]]])
Permite modificar o valor, a data e hora e a qualidade de um Tag Interno em uma
única operação. Este método retorna um Booleano que indica o sucesso ou não da
operação.
O parâmetro NewValue especifica o novo valor do Tag; se omitido, o valor do Tag
não é modificado. O parâmetro NewTimestamp especifica a nova data e hora do
Tag; se omitido, utiliza-se a data e hora do momento da chamada do método. O
parâmetro NewQuality especifica a nova qualidade do Tag; se omitida, será
assumida a qualidade Boa (192). Todos estes parâmetros podem ser omitidos.
Exemplo:
Sub CommandButton12_Click()
Dim Ret
Ret = Application.GetObject("Dados.TagInterno1")._
WriteEx(123.456, "1/1/2001", 193)
If Ret Then
MsgBox "Funcionou!"
Else
MsgBox "Falhou!"
End If
End Sub
5.7.7.2.1 Quality
Informa a qualidade do valor contido na propriedade Value. Esta propriedade é
de leitura e escrita, mas sempre que o valor do Tag Interno for modificado, seja por
script ou por uma Associação, ela é atualizada de acordo. Exemplo:
Sub CommandButton1_Click()
MsgBox Application.GetObject("Dados.TagInterno1").Quality
End Sub
NOTA: Pa ra ma i ores i nforma ções s obre qua l i da de, cons ul te o tópi co Qualidade no
Manual do Usuário do Elipse Power.
5.7.7.2.2 Retentive
A propriedade Retentive determina se o valor do Tag Interno deve ser
armazenado automaticamente, caso o Domínio seja parado. Se esta propriedade
estiver configurada para Verdadeiro, o valor do Tag Interno é armazenado
automaticamente, no caso de troca de servidor do Domínio ativo. Isto garante que o
valor do Tag é sincronizado com um servidor em standby. Assim, quando o servidor
for executado, o valor do Tag é o mesmo do servidor que parou. Caso contrário, o
valor do Tag é ajustado para o valor inicial sempre que o Domínio for executado ou
ocorrer troca do servidor ativo. Esta propriedade não tem efeito se for alterada em
tempo de execução. Exemplo:
Sub CommandButton1_Click()
Dim status
status = Application.GetObject("Dados.TagInterno1").Retentive
MsgBox status
Select Case status
Case True
MsgBox "O valor do tag interno será _
armazenado automaticamente."
Case False
MsgBox "O valor do tag será ajustado para o valor _
inicial sempre que o domínio for executado ou _
ocorrer troca do servidor ativo."
End Select
End Sub
5.7.7.2.4 Value
5.7.8.1 Eventos
Esta seção contém informações sobre os eventos do objeto Tag Timer.
5.7.8.1.1 OnPreset
OnPreset()
Ocorre toda vez que o valor da propriedade NextExecTime é alcançado.
5.7.8.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Tag Timer.
5.7.8.2.1 Enabled
5.7.8.2.3 RepeatInterval
É utilizada sempre que o Tag for do tipo Contínuo. O valor padrão desta
propriedade é 00:00:01.
5.7.8.2.4 StartTime
Data e hora inicial do Timer. Para o tipo Single, é a própria data e hora de
disparo. Para os demais, é o momento a partir do qual o Timer começa a disparar.
O valor padrão é o dia e a hora locais.
5.7.8.2.5 TriggerType
Tipo de disparo do Timer. As opções disponíveis são:
Opções disponíveis para TriggerType
OPÇÃO DESCRIÇÃO
0 - ttSingle Di s pa ro úni co.
1 - ttContinuous Di s pa ro contínuo.
2 - ttDaily Di s pa ro di á ri o.
3 - ttMonthly Di s pa ro mens a l .
5.8.1 Métodos
Esta seção contém informações sobre os métodos do objeto Banco de Dados.
5.8.1.1 SetDBParameters
SetDBParameters(ServerName, UserName, Password, DBName)
String de conexão com o banco de dados nas propriedades do objeto Banco de
Dados. O parâmetro ServerName determina o nome do servidor. O parâmetro
UserName determina o nome do usuário. O parâmetro Password determina a senha
do login para se conectar ao banco de dados. O parâmetro DBName é o nome do
banco de dados utilizado no SQL Server. Para os demais bancos de dados, este
parâmetro não é utilizado.
5.8.2.1 ConnectionActive
Indica se o Elipse Power possui uma conexão ativa com o banco de dados. O
Elipse Power normalmente utiliza duas conexões com este banco de dados, uma
para escritas e outra para leituras. A propriedade ConnectionActive está em
Verdadeiro se pelo menos uma destas duas conexões estiver conectada e
funcionando. Esta propriedade não deve ser utilizada para detectar falhas de
conexão, já que ela pode estar em Falso em diversas situações, como por exemplo:
Quando o banco de dados não está em uso (nenhuma operação de escrita ou
leitura foi executada)
Quando o banco de dados recém foi reconfigurado (quando uma
propriedade de conexão do banco de dados é alterada em tempo de
execução as conexões são fechadas, e só são reconectadas na próxima
operação de escrita ou leitura)
Quando a conexão com o banco de dados caiu (por exemplo, a rede não está
disponível ou o banco de dados foi fechado)
Quando o objeto DBServer está desativado (apesar de que, mesmo com o
objeto DBServer desativado, a conexão pode ser reconectada se o aplicativo
solicitar alguma leitura ou escrita imediata no banco de dados)
5.8.2.2 EnableSynchronization
Indica ao Elipse Power, se habilitada (Verdadeiro), que ele também deve executar
a gravação dos dados em uma segunda base de dados simultaneamente, para
permitir uma maior segurança. Se a propriedade estiver habilitada e houver um
servidor Standby, o Elipse Power executa a sincronização entre os bancos de dados
dos dois servidores. O valor padrão desta propriedade é Falso, ou seja, a sincronia
está desabilitada.
5.8.2.3 NetLibrary
Configura o tipo de biblioteca de rede do Banco de Dados. As opções disponíveis
estão descritas na tabela a seguir.
5.8.2.4 nRetries
Esta propriedade especifica o número de vezes que o Elipse Power tenta executar
uma operação de banco de dados, além da primeira tentativa. O valor padrão desta
propriedade é 5 (cinco). Se o valor desta propriedade for igual a 0 (zero), é
executada apenas uma tentativa por operação. Caso haja uma perda de conexão
com o banco de dados durante qualquer uma das tentativas, a operação é abortada
e as tentativas restantes são desconsideradas.
5.8.2.5 ReconnectDelay
A propriedade ReconnectDelay determina o tempo de espera (em milissegundos)
para que a aplicação execute uma tentativa de restabelecer uma conexão perdida
com o banco de dados. O valor padrão desta propriedade é 2000 (dois segundos).
5.8.2.6 SourceDatabase
Caso o Banco de Dados seja do tipo Access, este é o nome do arquivo .mdb. Caso
o Banco de Dados seja do tipo SQL Server, este é o nome do servidor SQL
concatenado com o banco de dados escolhido, no formato Servidor/Banco de
Dados. Caso o Banco de Dados seja do tipo Oracle, este é o nome da conexão
criada. Esta propriedade é somente para leitura.
5.8.2.7 SourceType
Indica o banco de dados utilizado pelo objeto. As opções disponíveis são as
seguintes:
0 - stAccess: Banco de dados Access
1 - stOracle: Banco de dados Oracle
2 - stSqlServer: Banco de dados SQL Server
5.8.2.9 TimeOutConnection
Contém o tempo de espera para realizar a conexão com o banco de dados, antes
que a aplicação gere um erro por timeout. O valor padrão é 15 segundos.
5.8.2.10 TotalFailedWrites
Indica a quantidade de operações dos arquivos .e3o que falharam e foram
descartadas desde que a conexão com o banco de dados foi ativada. Pode ser
zerada automaticamente em diversas situações, como por exemplo:
Ao desativar o objeto DBServer
Se o processo E3DBEngine for fechado por algum motivo
Se os parâmetros de configuração da conexão do objeto DBServer forem
alterados
5.8.2.11 UserName
Login utilizado para se conectar ao banco de dados. Esta propriedade é somente
para leitura.
5.8.2.12 UseTransaction
Define se o Servidor de Banco de Dados utiliza as transações do banco de dados
ou não. Se a propriedade estiver em Verdadeiro, cada bloco de operações (200
operações) de banco de dados (operações do Histórico, Storage, Formulas e
Alarmes) são executadas de uma vez só, ou seja, em uma única transação.
5.9 Históricos
Esta seção contém informações sobre métodos e propriedades do objeto Histórico.
Este objeto não possui eventos associados.
5.9.1 Métodos
Esta seção contém informações sobre os métodos do objeto Histórico.
5.9.1.2 StopAcquisition
StopAcquisition()
Desabilita a gravação dos registros por período no Histórico, independente do
valor especificado na propriedade ScanTime. A gravação por período permanece
desabilitada até que o método StartAcquisition seja utilizado. O comportamento
padrão do objeto Histórico é iniciar a aplicação com a gravação habilitada.
Exemplo:
Sub Hist1_OnStartRunning()
' Desabilita o Histórico assim que iniciar.
StopAcquisition()
End Sub
5.9.1.3 WriteRecord
WriteRecord()
Insere uma nova linha de informação no banco de dados. Os valores são obtidos a
partir dos valores atuais de cada uma das variáveis especificadas como fontes de
dados dos campos do Histórico. Utiliza-se este método em duas situações:
Para gravar uma nova linha de dados antes do tempo previsto para a
próxima gravação quando o Histórico está habilitado por tempo
Para gravar um novo conjunto de dados quando o Histórico está
desabilitado
Exemplo:
Sub Tag1_OnValueChange()
' Grava uma nova linha em um Histórico
' quando um Tag muda de valor.
Application.GetObject("Hist1").WriteRecord()
End Sub
5.9.2.1 BackupDiscardInterval
Indica o intervalo máximo de tempo (minutos, horas, dias ou meses) dos dados
na tabela de backup até serem descartados, independente do tempo que os dados
permanecem na tabela principal. Por exemplo, para manter os dados por 24 meses
na tabela principal e mais seis meses na tabela de backup, o valor desta
propriedade deve ser de 30 meses. Esta propriedade trabalha em conjunto com a
propriedade BackupDiscardTimeUnit. O valor padrão desta propriedade é 12 (doze
unidades de tempo indicadas em BackupDiscardTimeUnit).
5.9.2.2 BackupDiscardTimeUnit
A propriedade BackupDiscardTimeUnit indica a unidade de tempo em que os
dados de backup permanecem armazenados até serem descartados. As opções
disponíveis são:
0 - dtHour: Horas
1 - dtDay: Dias
2 - dtMonth: Meses (padrão)
3 - dtMinute: Minutos
5.9.2.3 CacheSize
Define o tamanho do bloco de registros que deve ser lido pelo Histórico antes de
ser enviado para o banco de dados. Por exemplo, se CacheSize é igual a 4 (quatro),
são enviados blocos contendo quatro registros cada um para o objeto Banco de
Dados associado. Os valores válidos para esta propriedade devem estar no
intervalo entre 1 (um) e 4 (quatro). O valor padrão desta propriedade é 1 (um).
5.9.2.5 DBServer
Indica o objeto Banco de Dados utilizado no Histórico para criação de tabelas e
registros de dados. O valor padrão desta propriedade é uma String vazia.
5.9.2.6 DeadBand
Esta propriedade trabalha em conjunto com a propriedade CompressedTable.
Indica o valor calculado sobre o último valor gravado (em percentagem) que define
se este novo valor é gravado. Se o valor gravado não for numérico, sua modificação
faz com que todos os valores sejam gravados.
5.9.2.7 DiscardInterval
Esta propriedade trabalha em conjunto com a propriedade DiscardTimeUnit. A
propriedade DiscardInterval indica o intervalo de tempo durante o qual os dados do
Histórico permanecem armazenados na tabela do banco de dados, até serem
descartados. O valor padrão desta propriedade é 1 (uma unidade de tempo
indicada em DiscardTimeUnit). Se esta propriedade for configurada com um valor
menor ou igual ao valor da propriedade BackupDiscardInterval, o Elipse Power
automaticamente ajusta o valor de BackupDiscardInterval como o dobro do valor de
DiscardInterval. Esta propriedade pode ser modificada em tempo de execução.
5.9.2.8 DiscardTimeUnit
Esta propriedade trabalha em conjunto com a propriedade DiscardInterval. A
propriedade DiscardTimeUnit indica a unidade de tempo em que os dados da tabela
permanecem armazenados até serem descartados. As opções disponíveis são:
0 - dtHour: Horas
1 - dtDay: Dias
2 - dtMonth: Meses (padrão)
3 - dtMinute: Minutos
5.9.2.9 EnableBackupTable
Cria uma tabela de backup onde os dados descartados permanecem por
segurança. Se configurada para Verdadeiro, a tabela é criada. Caso contrário, não
há tabela de backup. O valor padrão desta propriedade é Falso.
5.9.2.11 EnableQualityLogs
Quando em Verdadeiro, ao iniciar o Histórico o Elipse Power gera um registro
igual ao primeiro registro coletado, mas com qualidade ruim (0) e estampa de
tempo de um segundo antes.
5.9.2.12 ScanTime
Define a variação de intervalo do tempo, em milissegundos, que o Histórico
espera para executar a aquisição e gravação de um novo registro na tabela. Utilize
esta propriedade se houver necessidade de maior ou menor quantidade de dados
gerados por segundo. O valor padrão desta propriedade é 1000.
5.9.2.13 TableName
Define o nome da tabela utilizada no Histórico.
5.9.2.14 UserTable
Quando esta propriedade está configurada para Verdadeiro, identifica que o
Histórico é do usuário, ou seja, os dados da tabela foram importados do banco de
dados. Caso contrário, é um Histórico normal do Elipse Power. Esta propriedade é
somente de leitura.
5.9.2.15 UseTagQuality
Se esta propriedade estiver configurada para Verdadeiro, o Histórico usa o valor
de qualidade da fonte do Tag. Caso contrário, é utilizado o método antigo de
avaliação (0: Valor duvidoso ou 1: Valor bom).
5.9.2.16 VerificationInterval
Esta propriedade trabalha em conjunto com a propriedade VerificationUnit para
controlar o intervalo de tempo que o Elipse Power verifica a antiguidade dos dados,
para depois descartá-los. O valor padrão desta propriedade é 1 (uma unidade de
tempo indicada na propriedade VerificationUnit).
5.10 Storage
Esta seção contém informações sobre métodos e propriedades do objeto Storage.
Este objeto não possui eventos associados.
5.10.1 Métodos
Esta seção contém informações sobre os métodos do objeto Storage.
5.10.1.1 CreateNewSession
CreateNewSession([DefaultType[, DefaultMinRecTime[, DefaultMaxRecTime[,
DefaultDeadBand[, DefaultDeadBandUnit[, DefaultScanTime]]]]]])
Cria uma Sessão com a capacidade de incluir dados em um Storage, de forma
independente da aquisição normal. Os parâmetros opcionais são utilizados nas
configurações dos Tags da Sessão, caso não informados em sua criação. São eles,
respectivamente:
DefaultType: Tipo de dado (0: Double, 1: Bit, 2: String ou 3: Integer). Se
nenhum valor for informado, é utilizado o valor 0: Double
DefaultMinRecTime: Intervalo mínimo de tempo entre gravações. Se nenhum
valor for informado, é utilizado o valor 0 (zero)
DefaultMaxRecTime: Intervalo máximo de tempo sem gravações. Se nenhum
valor for informado, é utilizado o valor 3600
DefaultDeadBand: Banda morta. Se nenhum valor for informado, é utilizado o
valor 1 (um)
DefaultDeadBandUnit: Unidade da banda morta do Tag (0: Porcentagem ou
1: Absoluta). Se nenhum valor for informado, é utilizado o valor 1: Absoluta
DefaultScanTime: Tempo de varredura. Se nenhum valor for informado, é
utilizado o valor 0 (zero)
5.10.1.2 StartAcquisition
StartAcquisition()
Inicia ou retoma a geração de dados que vão para o Banco de Dados. O Storage
recebe notificações sobre quais Tags cadastrados sofreram modificação e, quando
isto acontece, o Storage verifica se os registros são gravados ou não. Quando este
método é utilizado, a notificação de mudança e a geração de gravações são
iniciadas ou retomadas. Exemplo:
Sub Botao1_Click()
' Ao clicar neste botão, habilita o Storage
Application.GetObject("Storage1").StartAcquisition()
End Sub
5.10.1.3 StopAcquisition
StopAcquisition()
Para a geração de dados que vão para o Banco de Dados. O Storage recebe
notificações sobre quais Tags cadastrados sofreram modificação e, quando isto
acontece, o Storage verifica se os registros são gravados ou não. Quando este
método é utilizado, a notificação de mudança e a geração de gravações são
paralisadas. Exemplo:
Sub Storage1_OnStartRunning()
' Desabilita o Storage após iniciar
StopAcquisition()
End Sub
5.10.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Storage.
5.10.2.1 BackupDiscardInterval
Indica o intervalo máximo de tempo (minutos, horas, dias ou meses) dos dados
na tabela de backup até serem descartados, independente do tempo que os dados
permanecem na tabela principal. Por exemplo, para manter os dados por 24 meses
na tabela principal e mais seis meses na tabela de backup, o valor desta
propriedade deve ser de 30 meses. Esta propriedade trabalha em conjunto com a
propriedade BackupDiscardTimeUnit. O valor padrão desta propriedade é 12 (doze
unidades de tempo indicadas na propriedade BackupDiscardTimeUnit).
5.10.2.3 CacheSize
Define o tamanho do bloco de registros que deve ser lido pelo Storage antes de ser
enviado para o banco de dados. Por exemplo, se CacheSize é igual a 4 (quatro), são
enviados blocos contendo quatro registros cada um para o objeto Banco de Dados
associado. O valor padrão desta propriedade é 10.
5.10.2.4 CompressionRate
Mostra a taxa de compressão de dados obtida até o momento.
5.10.2.5 DBServer
Indica o objeto Banco de Dados utilizado no Storage para criação de tabelas e
registros de dados. O valor padrão desta propriedade é uma String vazia.
5.10.2.6 DiscardInterval
Esta propriedade trabalha em conjunto com a propriedade DiscardTimeUnit. A
propriedade DiscardInterval indica o intervalo de tempo durante o qual os dados do
Histórico permanecem armazenados na tabela do banco de dados até serem
descartados. O valor padrão desta propriedade é 1 (uma unidade de tempo
indicada em DiscardTimeUnit). Se esta propriedade for configurada com um valor
menor ou igual ao valor da propriedade BackupDiscardInterval, o Elipse Power
automaticamente ajusta o valor de BackupDiscardInterval com o dobro do valor de
DiscardInterval. Esta propriedade pode ser modificada em tempo de execução.
5.10.2.8 EnableBackupTable
Cria uma tabela de backup onde os dados descartados permanecem por
segurança. Se configurada para Verdadeiro, a tabela é criada. Caso contrário, não
há tabela de backup. O valor padrão desta propriedade é Falso.
5.10.2.9 EnableDiscard
Habilita o descarte dos dados após um determinado tempo. Se configurada para
Falso, os dados são armazenados indefinidamente na tabela. Caso contrário, são
descartados após determinado tempo. O valor padrão desta propriedade é Falso.
5.10.2.10 Fields
Coleção que aponta para os Campos criados no Storage. Para cada Campo é
possível visualizar as propriedades Name e Link, e modificar as propriedades Type,
MinRecTime, MaxRecTime, DeadBand, ScanTime e DeadBandUnit.
5.10.2.11 StringFieldSize
Esta propriedade especifica o tamanho máximo que os campos do tipo String do
objeto Storage podem ter (é o tamanho utilizado na criação do campo Value da
tabela de Strings).
5.10.2.12 TableName
Define o nome da tabela que é utilizada no Storage.
5.10.2.13 VerificationInterval
Esta propriedade trabalha em conjunto com a propriedade VerificationUnit para
controlar o intervalo de tempo que o Elipse Power verifica a antiguidade dos dados,
para depois descartá-los. O valor padrão desta propriedade é 1 (uma unidade de
5.10.2.14 VerificationUnit
Esta propriedade trabalha em conjunto com a propriedade VerificationInterval.
A propriedade VerificationUnit indica a unidade de tempo em que é realizada a
verificação para descarte dos dados. As opções disponíveis são:
0 - dtHour: Horas
1 - dtDay: Dias
2 - dtMonth: Meses (padrão)
3 - dtMinute: Minutos
5.10.3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Campo do Storage.
5.10.3.1.1 DeadBand
Banda morta utilizada para cálculo do algoritmo do Storage. Indica a precisão
que o usuário está disposto a perder em cada Campo a ser armazenado. Quanto
maior o valor da propriedade DeadBand, mais compacto é o banco de dados
(menos dados são gravados). Este valor pode ser especificado em unidades
absolutas ou como um percentual do valor atual do Tag, conforme configurado na
propriedade DeadBandUnit.
5.10.3.1.2 DeadBandUnit
Unidade da propriedade DeadBand. Este valor pode ser especificado em unidades
absolutas ou como um percentual do valor atual do Tag.
5.10.3.1.3 Link
5.10.3.1.4 MaxRecTime
Diferença máxima, em segundos, entre as estampas de tempo de dois registros
consecutivos armazenados no banco de dados, isto é, o tempo máximo sem que
572 Objetos de Servidor
nenhum dado seja gravado. Por exemplo, se um Tag não estiver variando de valor,
mesmo assim o valor atual deve ser escrito no banco de dados sempre que o
número de segundos configurado em MaxRecTime for atingido. Este comportamento
pode ser desabilitado utilizando-se o valor 0 (zero).
5.10.3.1.5 MinRecTime
Diferença mínima, em milissegundos, entre as estampas de tempo de dois
registros quaisquer de mesma qualidade armazenados no banco de dados, isto é, o
tempo mínimo para que um novo dado seja gravado. Este parâmetro serve para
limitar o número de registros escritos em um banco de dados, no caso de um Tag
sofrer variações bruscas de valor. Este comportamento pode ser desabilitado
utilizando-se o valor 0 (zero).
5.10.3.1.6 Name
Propriedade que retorna o nome configurado para este Campo no objeto Storage.
Através desta propriedade é possível buscar itens na Coleção de Campos do Storage
(propriedade Fields).
5.10.3.1.7 ScanTime
Retorna ou configura o tempo de varredura em milissegundos de um Campo, ou
seja, de quanto em quanto tempo o valor do Tag é realimentado no algoritmo de
compactação de dados, caso não esteja variando. Se o valor desta propriedade for
igual a 0 (zero), o valor da propriedade MaxRecTime é utilizado para este mesmo
propósito.
5.10.3.1.8 Type
Retorna o tipo do objeto no formato do Storage (0: Double, 1: Bit, 2: String ou 3:
Integer). Esta propriedade é de leitura e escrita, mas só aceita mudanças enquanto
a coleta de dados para este Campo ainda não começou.
NOTA: Os ti pos de da dos Bit, String e Integer nã o s ã o s ubmeti dos a o a l gori tmo de
compa cta çã o do Stora ge. Porta nto, s empre que há uma va ri a çã o no va l or ou na
qua l i da de do Ca mpo, o va l or é gra va do no ba nco de da dos . As propri eda des
DeadBand, DeadBandUnit, MaxRecTime e MinRecTime nã o têm efei to nes tes ti pos de
da dos , poi s s ã o excl us i va s do a l gori tmo de compa cta çã o.
5.10.4.1.1 AddField
AddField(FieldName[, Type, MinRecTime, MaxRecTime, DeadBand, DeadBandUnit,
ScanTime])
Este método é responsável pela inserção de Tags temporários na estrutura da
Sessão. Se os parâmetros opcionais não forem preenchidos, são utilizados os
valores definidos na criação da Sessão pelo método CreateNewSession do Storage.
Os parâmetros deste método são descritos na tabela a seguir.
Parâmetros do método AddField
PARÂMETRO DESCRIÇÃO
FieldName Nome do Ta g temporá ri o (obri ga tóri o).
Type Ti po do Ta g (opci ona l ). Os va l ores
pos s ívei s s ã o 0: Double, 1: Bit, 2: String ou
3: Integer. O va l or pa drã o des te
pa râ metro é 0: Double.
MinRecTime Interva l o míni mo de tempo entre a s
gra va ções (opci ona l ). O va l or pa drã o
des te pa râ metro é 0 (zero).
MaxRecTime Interva l o má xi mo de tempo s em
gra va ções (opci ona l ). O va l or pa drã o
des te pa râ metro é 3600.
DeadBand Ba nda morta do Ta g temporá ri o
(opci ona l ). O va l or pa drã o des te
pa râ metro é 1 (um).
DeadBandUnit Uni da de de ba nda morta do Ta g
temporá ri o (opci ona l ). Os va l ores
pos s ívei s s ã o 0: Porcentagem ou 1:
Absoluta. O va l or pa drã o des te pa râ metro
é 1: Absoluta.
ScanTime Tempo de va rredura do Ta g temporá ri o
(opci ona l ). O va l or pa drã o des te
pa râ metro é 0 (zero).
5.10.4.1.2 AddValue
AddValue(FieldName, Timestamp, Quality, Value)
Adiciona um valor a um Tag temporário na Sessão. Os parâmetros deste método
574 Objetos de Servidor
estão descritos na tabela a seguir.
Parâmetros do método AddValue
PARÂMETRO DESCRIÇÃO
FieldName Nome do ca mpo a o qua l o va l or é
a di ci ona do. Es te nome deve exi s ti r na
confi gura çã o ori gi na l do Stora ge, ou
entã o deve ter s i do a di ci ona do
previ a mente pel o método AddField.
Timestamp Es ta mpa de tempo do va l or a s er
a di ci ona do.
Quality Qua l i da de do va l or a s er a di ci ona do.
Value Va l or a s er a di ci ona do.
5.10.4.1.3 Commit
Commit()
Grava todos os dados mantidos em memória pela Sessão no banco de dados do
Storage. Este método retorna Verdadeiro se os dados foram gravados corretamente
e Falso caso contrário.
5.11 Fórmulas
Esta seção contém informações sobre métodos e propriedades do objeto Fórmula.
Este objeto não possui eventos associados.
5.11.1 Métodos
Esta seção contém informações sobre os métodos do objeto Fórmula.
5.11.1.1 CreateUnit
CreateUnit(UnitName)
Cria uma unidade na tabela de fórmulas. Este método possui o parâmetro UnitName
que determina o nome da unidade a ser criada. Retorna True se conseguir realizar a
operação; caso contrário, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botão, cria uma nova Unit
Application.GetObject("Formula1").CreateUnit("Unit2")
End Sub
5.11.1.3 DeleteUnit
DeleteUnit(UnitName)
Apaga uma unidade na tabela de fórmulas. Este método possui o parâmetro
UnitName, que informa o nome da unidade a ser apagada. Retorna True se
conseguir realizar a operação; caso contrário, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botão, apaga a unit
Application.GetObject("Formula1").DeleteUnit("Unit2")
End Sub
5.11.1.4 DeleteValue
DeleteValue(ValueName)
Apaga um conjunto de valores na tabela de fórmulas. Este método possui o
parâmetro ValueName, que informa o conjunto de valores a ser apagado. Retorna
True se conseguir realizar a operação; caso contrário, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botão, apaga um conjunto de valores
Application.GetObject("Formula1").DeleteValue("Modelo5")
End Sub
5.11.1.5 FindUnit
FindUnit(UnitName)
Verifica se uma determinada unidade existe no banco de dados das fórmulas. Este
método possui o parâmetro UnitName, que determina o nome da unidade a ser
encontrada. O método retorna True se conseguir realizar a operação; caso
contrário, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
576 Objetos de Servidor
' Quando clica no botão, aparece uma caixa de mensagem
' (MessageBox) com o resultado
MsgBox(Application.GetObject("Formula1")._
FindUnit("Unit2"))
End Sub
5.11.1.6 FindValue
FindValue(ValueName)
Verifica se um determinado conjunto de valores existe no banco de dados de
fórmulas. Este método possui o parâmetro ValueName, que informa o nome do
conjunto a ser verificado. Retorna True se conseguir realizar a operação; caso
contrário, retorna False. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botão aparece uma caixa de mensagem
' (MessageBox) com o resultado
MsgBox CStr(Application.GetObject("Formula1")._
FindValue("Modelo5"))
End Sub
5.11.1.7 GetUnitData
GetUnitData(UnitName, TemplateName, Val)
Coloca na variável indicada em Val o Tag associado à unidade UnitName do
template TemplateName. Retorna True se a operação foi bem-sucedida, ou False,
caso contrário. Exemplo:
Sub Botao1_Click()
Dim qualTag, qualFormula
Application.GetObject("Formula1").GetUnitData _
"Unidade1", "Template2", var1
End Sub
5.11.1.8 GetValueData
GetValueData(ValueName, TemplateName, Val)
Coloca na variável Val o valor do conjunto de valores ValueName que está
associado ao template TemplateName. Retorna True se a operação foi bem-
sucedida, ou False, caso contrário. Exemplo:
Sub Botao1_Click()
Dim Valor, qualFormula
Application.GetObject("Formula1").GetValueData _
"Valores4", "Template2", var1
End Sub
5.11.1.10 RenameUnit
RenameUnit(UnitName, NewUnitName)
Renomeia uma determinada unidade existente na tabela de fórmulas. Retorna True
se conseguir realizar a operação, ou False, caso contrário. Este método possui os
parâmetros UnitName, que determina o nome da unidade a ser encontrada; e
NewUnitName, que informa o novo nome da unidade. Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botão, renomeia uma unit
Application._
GetObject("Formula1").RenameUnit "Unit2", "Unit3"
End Sub
5.11.1.11 RenameValue
RenameValue(ValueName, NewValueName)
Renomeia um determinado conjunto de valores existente na tabela de fórmulas.
Retorna True se conseguir realizar a operação ou False, caso contrário. Este método
possui os parâmetros ValueName, que informa o nome do conjunto de valores e
NewValueName, que informa o novo nome do conjunto de valores. Exemplo:
Sub Botao1_Click()
Application.GetObject("Formula1").RenameValue "Modelo5",
"ModeloABC"
End Sub
5.11.1.13 SetUnitData
SetUnitData(UnitName, TemplateName, Data)
Carrega para a tabela de fórmulas o Tag identificado para um certo modelo
(template), em uma determinada unidade. Retorna True se conseguir realizar a
operação ou False, caso contrário. Este método possui os parâmetros UnitName,
que informa o nome da unidade, TemplateName, que informa o nome do template do
Tag e Data, que informa o nome da variável que contém o nome do Tag. Exemplo:
Sub Botao1_Click()
Application.GetObject("Formula1").SetUnitData _
"Unidade2", "Template5", 50
End Sub
5.11.1.14 SetValueData
SetValueData(ValueName, TemplateName, Data)
Altera o valor referente a um template definido para um determinado conjunto de
valores. Este método realiza a verificação dos limites, retornando Verdadeiro se
conseguir realizar a operação ou Falso, caso contrário. Este método possui os
parâmetros ValueName, que determina o nome do conjunto de valores,
TemplateName, que determina o nome do template e Data, que determina o nome da
variável que possui o valor. Exemplo:
Sub Botao1_Click()
Application.GetObject("Formula1").SetValueData _
"Unidade2", "Template1", 100
End Sub
NOTA: Pa ra ma i ores i nforma ções s obre o método SetValueData, cons ul te os a rti gos
KB 35, KB 280 e KB 119, do Elipse Knowledgebase.
5.11.2.1 DBServer
Indica o nome do banco de dados onde serão gravadas as informações da
Fórmula, ou seja, as unidades e os conjuntos de valores. O valor padrão desta
propriedade é uma String vazia.
5.11.2.2 ImmediateExecute
Quando habilitada, faz com que a Fórmula escreva seus registros diretamente no
Banco de Dados, sem precisar passar por suas filas de operações (arquivos .e3i e
.e3o). Isso faz com que as operações feitas no Banco de Dados sejam vistas de
forma mais rápida.
5.11.2.3 TableName
Indica o nome das tabelas onde ficarão as informações das Fórmulas. O valor
padrão desta propriedade é uma String vazia.
5.12 Alarmes
Esta seção contém informações sobre eventos, métodos e propriedades dos objetos
Configuração de Alarmes, Áreas de Alarme, Fontes de Alarme e Servidor de Alarmes.
5.12.2.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Área de Alarme.
5.12.2.1.1 ActiveAlarms
Determina o número de alarmes ativos dentro da Área do sistema. Esta
propriedade é somente de leitura.
580 Objetos de Servidor
5.12.2.1.2 ActiveHighAlarms
5.12.2.1.3 ActiveHighNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Alta. Esta
propriedade é somente de leitura.
5.12.2.1.4 ActiveLowAlarms
Indica o número de alarmes ativos com severidade Baixa. Esta propriedade é
somente de leitura.
5.12.2.1.5 ActiveLowNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Baixa. Esta
propriedade é somente de leitura.
5.12.2.1.6 ActiveMedAlarms
Indica o número de alarmes ativos com severidade Média. Esta propriedade é
somente de leitura.
5.12.2.1.7 ActiveMedNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Média. Esta
propriedade é somente de leitura.
5.12.2.1.8 ActiveNACKAlarms
Indica o número de alarmes que estão sem reconhecimento dentro da Área. Esta
propriedade é somente de leitura.
5.12.2.1.9 Alarm
Estabelece a existência de alarmes ativos dentro da Área. Se a opção estiver em
Verdadeiro, o sistema tem pelo menos um alarme ativo dentro da Área, e a
propriedade ActiveAlarms executa a leitura no sistema, indicando a quantidade de
alarme ativos. Caso contrário, a propriedade ActiveNACKAlarms executa a leitura
dos alarmes sem reconhecimento. Esta propriedade é somente de leitura.
5.12.2.1.11 InactiveHighNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Alta.
Esta propriedade é somente de leitura.
5.12.2.1.12 InactiveLowNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Baixa.
Esta propriedade é somente de leitura.
5.12.2.1.13 InactiveMedNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Média.
Esta propriedade é somente de leitura.
5.12.2.1.14 InactiveNACKAlarms
Determina o número total de alarmes inativos e não reconhecidos. Esta
propriedade é somente de leitura.
5.12.2.1.15 UserFields
Retorna um objeto que é uma coleção de Campos de Usuário de Alarmes de uma
Área de Alarme. Veja o item Coleção de Campos de Usuário de Alarmes para maiores
informações sobre a coleção de objetos retornados por esta propriedade.
5.12.3.1.1 Ack
Ack([ActorID])
Executa o reconhecimento de um alarme configurado no objeto Fonte de Alarmes. O
método retorna um Booleano que indica o sucesso ou não da operação. O
parâmetro ActorID informa o nome do usuário responsável pelo reconhecimento
dos alarmes. Este parâmetro é opcional e, se for omitido, assume o logon do
usuário do Viewer, "Anonymous" se não há usuário logado, ou "System" se a
chamada do método foi originada no servidor.
5.12.3.1.2 GetAlarm
GetAlarm()
Retorna um objeto que permite o acesso às configurações específicas de cada tipo
de alarme. Isto permite verificar ou modificar em tempo de execução as
propriedade de um determinado alarme. Dependendo do tipo de alarme, o método
retorna as seguintes propriedades:
Alarme Digital: Responsável pelas configurações de alarme digital
Propriedades do Alarme Digital
ITEM DESCRIÇÃO
DigitalReturnMessageText Mens a gem de retorno do a l a rme di gi ta l
Digital Ha bi l i ta ou des a bi l i ta a veri fi ca çã o do
a l a rme di gi ta l
DigitalLimit Li mi te pa ra o a l a rme di gi ta l
DigitalMessageText Texto da mens a gem do a l a rme di gi ta l
Alarme Lo (Baixo)
ITEM DESCRIÇÃO
Lo Ha bi l i ta ou des a bi l i ta a veri fi ca çã o de
a l a rme Baixo
LoLimit Li mi te pa ra o nível de a l a rme Baixo
LoMessageText Texto da mens a gem de a l a rme Baixo
LoSeverity Importâ nci a do nível de a l a rme Baixo.
Conjunto de va l ores :
0: Al ta
1: Médi a
2: Ba i xa
Alarme Hi (Alto)
ITEM DESCRIÇÃO
Hi Ha bi l i ta ou des a bi l i ta a veri fi ca çã o de
a l a rme Alto
HiLimit Li mi te pa ra o nível de a l a rme Alto
HiMessageText Texto da mens a gem de a l a rme Alto
HiSeverity Importâ nci a do nível de a l a rme Alto.
Conjunto de va l ores :
0: Al ta
1: Médi a
2: Ba i xa
HiAckRequired Neces s i da de de reconheci mento pa ra es te
nível de a l a rme (Alto)
Exemplo:
Sub Botao1_Click()
Dim val
' Quando clica no botao muda o nivel de alarme Lo do
' AlarmSource BatteryLevel
Application.GetObject("ConfigAlarmes1.Area1.BatteryLevel")_
.GetAlarm().LoLimit = 10.2
586 Objetos de Servidor
End Sub
5.12.3.2.1 ActiveNACKAlarm
Se ajustada para Verdadeiro, indica que a Fonte não foi reconhecida desde a
última ativação. Esta propriedade é somente de leitura. O valor padrão desta
propriedade é Falso.
5.12.3.2.2 Alarm
5.12.3.2.3 AlarmVerify
Se ajustada para Verdadeiro, habilita a verificação da Fonte de Alarme, ou seja, a
geração do alarme.
5.12.3.2.4 AreaNameOverride
Determina um nome alternativo para a Área que contém a Fonte de Alarme. O
valor padrão desta propriedade é uma String vazia.
NOTAS:
Qua ndo es ta propri eda de es tá va zi a , o nome da Fonte de Al a rme é compos to dos
nomes dos objetos Área hi era rqui ca mente s uperi ores .
Es ta propri eda de, mes mo qua ndo preenchi da , nã o i nfl uenci a nos conta dores da
Área s de Al a rme hi era rqui ca mente s uperi ores , que conti nua m conta ndo os
a l a rmes des ta Fonte de Al a rme.
Se es ta propri eda de for a l tera da em tempo de execuçã o, o novo va l or s ó entra
em vi gor qua ndo ocorrer o próxi mo a l a rme nes ta Fonte de Al a rme.
5.12.3.2.5 CurrentSeverity
5.12.3.2.6 CurrentSubConditionName
5.12.3.2.7 Delay
Especifica um tempo de atraso para o alarme, em ms, tanto na entrada quanto na
saída da condição. Quando esta propriedade estiver em 0 (zero, que é sempre o
valor padrão), não é aplicado nenhum atraso. Quando for diferente de 0 (zero), o
alarme só é ativado ou desativado se permanecer na mesma condição por um
tempo maior ou igual ao especificado.
5.12.3.2.8 DoubleAckRequired
Quando configurada como Verdadeiro, indica que o alarme pode ser reconhecido
tanto quando está ativo como quando passa a inativo, ou seja, pode ser
reconhecido duplamente. Quando configurada como Falso, indica que o alarme só
pode ser reconhecido uma vez, e ao ser reconhecido sai da lista de alarmes.
Alarmes que não necessitem reconhecimento (propriedade AckRequired) não
possibilitam esta personalização. Aplicações anteriores à versão 2.5 vêm com esta
5.12.3.2.9 Event
5.12.3.2.10 Format
A propriedade Format especifica que tipo de formato é atribuído ao objeto.
Permite mudar a forma como os dados são apresentados sem mudar o valor que
existe por trás deles. Esta propriedade pode ser editada manualmente ou
configurada através da janela de formatação. Seu uso é semelhante aos
formatadores usados nas planilhas de dados, seguindo a mesma sintaxe básica.
São suportados os tipos de dados descritos na tabela a seguir.
Tipos de dados suportados pela propriedade Format
DADOS DESCRIÇÃO
Numérico Sa ída deci ma l , ci entífi ca , hexa deci ma l ,
bi ná ri a e octa l
Texto Textos em gera l
Booleano Va l ores Bool ea nos
Data e Hora Ca l endá ri o Gregori a no
5.12.3.2.11 FormattedValue
Contém o valor do alarme conforme a propriedade Value, formatado de acordo
com a propriedade Format. Esta propriedade é somente de leitura. O valor padrão
desta propriedade é Null.
5.12.3.2.12 RawAlarm
Indica se o alarme deve estar ativo, independente da espera. Quando a espera for
igual a 0 (zero), o valor de RawAlarm é o mesmo da propriedade Alarm. Esta
propriedade é somente de leitura. O valor padrão desta propriedade é Falso.
5.12.3.2.13 Source
Contém a expressão que deve ser avaliada para determinar se o alarme deve
ocorrer ou não.
5.12.3.2.15 Value
Contém o valor do que foi avaliado para determinar se o alarme ocorre ou não. O
valor padrão desta propriedade é Null.
5.12.3.3.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte de Alarme
Analógico.
5.12.3.3.1.1 Hi
5.12.3.3.1.2 HiAckRequired
5.12.3.3.1.3 HiEvent
5.12.3.3.1.4 HiHi
5.12.3.3.1.6 HiHiEvent
5.12.3.3.1.7 HiHiLimit
5.12.3.3.1.8 HiHiMessageText
5.12.3.3.1.9 HiHiSeverity
5.12.3.3.1.10 HiLimit
5.12.3.3.1.11 HiMessageText
5.12.3.3.1.12 HiSeverity
5.12.3.3.1.13 LevelDeadBand
5.12.3.3.1.14 LevelReturnMessageText
5.12.3.3.1.15 Lo
5.12.3.3.1.16 LoAckRequired
5.12.3.3.1.17 LoEvent
5.12.3.3.1.18 LoLimit
5.12.3.3.1.19 LoLo
5.12.3.3.1.20 LoLoAckRequired
5.12.3.3.1.21 LoLoEvent
5.12.3.3.1.23 LoLoMessageText
5.12.3.3.1.24 LoLoSeverity
5.12.3.3.1.25 LoMessageText
5.12.3.3.1.26 LoSeverity
5.12.3.4.1 Propriedades
5.12.3.4.1.1 Digital
5.12.3.4.1.3 DigitalLimit
5.12.3.4.1.4 DigitalMessageText
5.12.3.4.1.5 DigitalReturnMessageText
5.12.3.4.1.6 DigitalSeverity
5.12.3.5.1 Propriedades
5.12.3.5.1.1 DeadBand
5.12.3.5.1.2 DeadBandAckRequired
5.12.3.5.1.4 DeadBandMessageText
5.12.3.5.1.5 DeadBandReturnMessageText
5.12.3.5.1.6 DeadBandSetpoint
Limite de banda morta do alarme. Cada vez que o valor do Tag associado
ultrapassar o valor desta propriedade para mais ou para menos do valor de
DeadBandLimit, o alarme ocorre.
5.12.3.5.1.7 DeadBandSeverity
5.12.3.6.1 Propriedades
5.12.3.6.1.1 ROC
5.12.3.6.1.2 ROCAckRequired
Limite para o alarme de taxa de variação. Para que o alarme ocorra, basta que o
valor do Tag associado ultrapasse este valor em um segundo.
5.12.3.6.1.4 ROCMessageText
5.12.3.6.1.5 ROCReturnMessageText
5.12.3.6.1.6 ROCSeverity
5.12.3.7.1 Propriedades
Esta seção contém informações sobre as propriedades do objeto Fonte de Alarme
Discreto.
5.12.3.7.1.1 DiscreteReturnMessageText
Item
Item(Index)
Retorna uma referência para um objeto Subcondição, indicado por Index. Este
parâmetro pode ser o índice na coleção (iniciando em 1) ou o nome do objeto
(propriedade Name).
RemoveSubCondition
RemoveSubCondition(Index)
Remove o objeto Subcondição, indicado pelo parâmetro Index. Este parâmetro pode
ser o índice na coleção (iniciando em 1) ou o nome do objeto (propriedade Name).
5.12.3.7.2.3 Subcondições
5.12.4.1.1 AckAllAlarms
AckAllAlarms([ActorID])
Executa o reconhecimento de todos os alarmes do servidor, independente da Área.
O método retorna um Booleano que indica o sucesso ou não da operação. O
parâmetro ActorID informa o nome do usuário responsável pelo reconhecimento
dos alarmes. Este parâmetro é opcional e, se for omitido, assume o logon do
usuário do Viewer, "Anonymous" se não há usuário logado ou "System" se a
chamada do método originou-se no servidor. Exemplo:
Sub Botao1_Click()
' Ao clicar neste botão reconhece todos os alarmes
Application.GetObject("ServidorAlarmes1")._
AckAllAlarms(Application.User)
End Sub
5.12.4.1.2 AckArea
AckArea(Area[, ActorID])
Executa o reconhecimento dos alarmes em uma determinada Área. O método
retorna um Booleano que indica o sucesso ou não da operação. O parâmetro Area
especifica o nome da Área ou Áreas cujos alarmes são reconhecidos, através da
comparação entre os trechos iniciais dos nomes. Por exemplo, AckArea("ANA")
reconhece alarmes das Áreas "ANALOGICOS", "ANA.AREA2", etc. Se o valor deste
parâmetro for vazio, o método tem o mesmo comportamento de AckAllAlarms. O
parâmetro ActorID informa o nome do usuário responsável pelo reconhecimento
dos alarmes. Este parâmetro é opcional e, se for omitido, assume o logon do
usuário do Viewer, "Anonymous" se não há usuário logado ou "System" se a
chamada do método originou-se no servidor. Exemplo:
Sub Botao1_Click()
'Ao clicar neste botão reconhece os alarmes da Area1
Application.GetObject("ServidorAlarmes1").AckArea "Area1", _
Application.User
End Sub
5.12.4.1.3 LogTrackingEvent
LogTrackingEvent(Message[, ActorID], Area, Severity, EventTime, Source,
EventCategory, EventType, UserFields, AlarmSourceName, FullAlarmSourceName)
Simula um evento ou alarme e o envia direto para o banco de dados do Servidor de
Alarmes, sem passar pelo E3Alarm. Por isto, este evento não pode ser visto no
E3Alarm, nem tampouco o alarme pode ser reconhecido.
Exemplo:
Sub CommandButton1_Click()
' No parâmetro UserFields, para cada elemento do array,
' é mostrado o valor atribuído a ele.
Application.GetObject("ServidorAlarmes1").LogTrackingEvent_
"Clicou no botão", Application.User, "Operação", 2, , _
"Botão1", , , array(1, 2, "a", "b")
End Sub
5.12.4.2 Propriedades
Esta seção contém informações sobre as propriedades do objeto Servidor de
Alarme.
5.12.4.2.1 ActiveAlarms
Determina o número total de alarmes ativos na aplicação. Esta propriedade é
somente de leitura.
5.12.4.2.3 ActiveHighNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Alta. Esta
propriedade é somente de leitura.
5.12.4.2.4 ActiveLowAlarms
Indica o número de alarmes ativos com severidade Baixa. Esta propriedade é
somente de leitura.
5.12.4.2.5 ActiveLowNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Baixa. Esta
propriedade é somente de leitura.
5.12.4.2.6 ActiveMedAlarms
Indica o número de alarmes ativos com severidade Média. Esta propriedade é
somente de leitura.
5.12.4.2.7 ActiveMedNACKAlarms
Indica o número de alarmes não reconhecidos com severidade Média. Esta
propriedade é somente de leitura.
5.12.4.2.8 ActiveNACKAlarms
5.12.4.2.9 BackupDiscardInterval
Indica o intervalo máximo de tempo (minutos, horas, dias ou meses) dos dados
na tabela de backup até serem descartados, independente do tempo que os dados
permanecem na tabela principal. Por exemplo, para manter os dados por 24 meses
na tabela principal e mais seis meses na tabela de backup, o valor desta
propriedade deve ser de 30 meses. Esta propriedade trabalha em conjunto com a
propriedade BackupDiscardTimeUnit. O valor padrão desta propriedade é 12 (doze
unidades de tempo indicadas em BackupDiscardTimeUnit).
5.12.4.2.10 BackupDiscardTimeUnit
A propriedade BackupDiscardTimeUnit indica a unidade de tempo em que os
dados de backup permanecem armazenados até serem descartados. As opções
disponíveis são as seguintes:
0 - dtHour: Horas
1 - dtDay: Dias
2 - dtMonth: Meses (padrão)
3 - dtMinute: Minutos
5.12.4.2.11 DataSource
Define o objeto Banco de Dados que é utilizado para gravação dos dados dos
alarmes. O valor padrão desta propriedade é uma String vazia, ou seja, não há
nenhum Banco de Dados para armazenar os dados.
5.12.4.2.12 DiscardInterval
Esta propriedade trabalha em conjunto com a propriedade DiscardTimeUnit. A
propriedade DiscardInterval indica o intervalo de tempo durante o qual os dados
dos alarmes permanecem armazenados na tabela do banco de dados, até que
sejam descartados. O valor padrão desta propriedade é 1 (uma unidade de tempo
indicada na propriedade DiscardTimeUnit). Se esta propriedade for configurada
com um valor menor ou igual ao valor da propriedade BackupDiscardInterval, o
Elipse Power automaticamente ajusta o valor de BackupDiscardInterval como o
dobro do valor de DiscardInterval. Esta propriedade pode ser modificada em tempo
de execução.
5.12.4.2.13 DiscardTimeUnit
Esta propriedade trabalha em conjunto com a propriedade DiscardInterval. A
propriedade DiscardTimeUnit indica a unidade de tempo em que os dados da tabela
permanecem armazenados até que sejam descartados. As opções disponíveis são
as seguintes:
0 - dtHour: Horas
1 - dtDay: Dias
5.12.4.2.14 EnableBackupTable
Cria uma tabela de backup onde os dados descartados permanecem por
segurança. Se configurada para Verdadeiro, a tabela é criada. Caso contrário, não
há tabela de backup. O valor padrão desta propriedade é Verdadeiro.
5.12.4.2.15 EnableDiscard
Indica descarte dos dados dos alarmes após um certo tempo. Se configurada
para Falso, os dados são armazenados indefinidamente na tabela. Caso contrário,
são descartados após determinado tempo. O valor padrão desta propriedade é
Falso.
5.12.4.2.16 InactiveHighNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Alta.
Esta propriedade é somente de leitura.
5.12.4.2.17 InactiveLowNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Baixa.
Esta propriedade é somente de leitura.
5.12.4.2.18 InactiveMedNACKAlarms
Indica o número de alarmes inativos e não reconhecidos com severidade Média.
Esta propriedade é somente de leitura.
5.12.4.2.19 InactiveNACKAlarms
5.12.4.2.20 Logging
Cria um registro com informações dos alarmes no banco de dados especificado
pela propriedade DataSource. Se configurada para Falso, o registro não é criado.
Caso contrário, o registro é criado. O valor padrão desta propriedade é Falso.
5.12.4.2.21 TableName
Define um nome para a tabela de alarmes. O valor padrão é "Alarms". Pode ser
modificada em tempo de execução e seu efeito é imediato.
Objetos de Servidor 605
5.12.4.2.22 VerificationInterval
5.12.4.2.23 VerificationUnit
Este código abre uma Tela de nome "Tela1", com o título "Título1", na posição (0, 0),
com 400 pixels de largura e 200 pixels de altura, passa o valor 0 (zero) como
parâmetro para a Tela e habilita a barra de título da janela.
Como criar uma Consulta com filtro por data antes de montar um Relatório?
Para isto, é necessário configurar o objeto Consulta (veja o capítulo Consulta) que
acompanha o Relatório e criar as variáveis necessárias na coluna Filtro. No evento
de chamada de Relatório, use um script semelhante a este:
Set relatorio = Application.LoadReport("[Relatório1]")
Set consulta = Relatorio.Query()
Consulta.SetVariableValue "Variavel1", Valor1
Consulta.SetVariableValue "Variavel2", Valor2
Relatorio.PrintPreview()
Onde:
[Relatório1] é o nome do Relatório a ser chamado
Variavel1 e Variavel2 são as variáveis criadas no filtro do campo
E3TimeStamp
Valor1 e Valor2 são as datas a serem consultadas
Filial PR Filial MG
Av. Sete de Setembro, 4698/1705 Rua Antônio de Albuquerque, 156
80240-000 Curitiba - PR 7º andar Sala 705
Fone: (+55 41) 4062-5824 30112-010 Belo Horizonte - MG
E-mail: elipse-pr@elipse.com.br Fone: (+55 31) 4062-5824
E-mail: elipse-mg@elipse.com.br
Filial RJ Taiwan
Praia de Botafogo, 300/525 9F., No.12, Beiping 2nd St., Sanmin Dist.
22250-044 Rio de Janeiro - RJ 807 Kaohsiung City - Taiwan
Fone: (+55 21) 2158-1015 Fone: (+886 7) 323-8468
Fax: (+55 21) 2158-1099 Fax: (+886 7) 323-9656
E-mail: elipse-rj@elipse.com.br E-mail: evan@elipse.com.br